4 * Support for writing WIM files; write a WIM file, overwrite a WIM file, write
5 * compressed file resources, etc.
9 * Copyright (C) 2012, 2013 Eric Biggers
11 * This file is part of wimlib, a library for working with WIM files.
13 * wimlib is free software; you can redistribute it and/or modify it under the
14 * terms of the GNU General Public License as published by the Free
15 * Software Foundation; either version 3 of the License, or (at your option)
18 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20 * A PARTICULAR PURPOSE. See the GNU General Public License for more
23 * You should have received a copy of the GNU General Public License
24 * along with wimlib; if not, see http://www.gnu.org/licenses/.
31 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
32 /* On BSD, this should be included before "wimlib/list.h" so that "wimlib/list.h" can
33 * overwrite the LIST_HEAD macro. */
34 # include <sys/file.h>
37 #include "wimlib/chunk_compressor.h"
38 #include "wimlib/endianness.h"
39 #include "wimlib/error.h"
40 #include "wimlib/file_io.h"
41 #include "wimlib/header.h"
42 #include "wimlib/integrity.h"
43 #include "wimlib/lookup_table.h"
44 #include "wimlib/metadata.h"
45 #include "wimlib/resource.h"
47 # include "wimlib/win32.h" /* win32_rename_replacement() */
49 #include "wimlib/write.h"
50 #include "wimlib/xml.h"
61 /* wimlib internal flags used when writing resources. */
62 #define WRITE_RESOURCE_FLAG_RECOMPRESS 0x00000001
63 #define WRITE_RESOURCE_FLAG_PIPABLE 0x00000002
64 #define WRITE_RESOURCE_FLAG_PACK_STREAMS 0x00000004
67 write_flags_to_resource_flags(int write_flags)
69 int write_resource_flags = 0;
71 if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
72 write_resource_flags |= WRITE_RESOURCE_FLAG_RECOMPRESS;
73 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
74 write_resource_flags |= WRITE_RESOURCE_FLAG_PIPABLE;
75 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
76 write_resource_flags |= WRITE_RESOURCE_FLAG_PACK_STREAMS;
77 return write_resource_flags;
80 struct filter_context {
85 /* Determine specified stream should be filtered out from the write.
89 * < 0 : The stream should be hard-filtered; that is, not included in the
91 * 0 : The stream should not be filtered out.
92 * > 0 : The stream should be soft-filtered; that is, it already exists in the
93 * WIM file and may not need to be written again.
96 stream_filtered(const struct wim_lookup_table_entry *lte,
97 const struct filter_context *ctx)
99 int write_flags = ctx->write_flags;
100 WIMStruct *wim = ctx->wim;
105 if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE &&
106 lte->resource_location == RESOURCE_IN_WIM &&
107 lte->rspec->wim == wim)
110 if (write_flags & WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS &&
111 lte->resource_location == RESOURCE_IN_WIM &&
112 lte->rspec->wim != wim)
119 stream_hard_filtered(const struct wim_lookup_table_entry *lte,
120 struct filter_context *ctx)
122 return stream_filtered(lte, ctx) < 0;
126 may_soft_filter_streams(const struct filter_context *ctx)
130 return ctx->write_flags & WIMLIB_WRITE_FLAG_OVERWRITE;
134 may_hard_filter_streams(const struct filter_context *ctx)
138 return ctx->write_flags & WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
142 may_filter_streams(const struct filter_context *ctx)
144 return (may_soft_filter_streams(ctx) ||
145 may_hard_filter_streams(ctx));
149 /* Return true if the specified resource is compressed and the compressed data
150 * can be reused with the specified output parameters. */
152 can_raw_copy(const struct wim_lookup_table_entry *lte,
153 int write_resource_flags, int out_ctype, u32 out_chunk_size)
155 const struct wim_resource_spec *rspec;
157 if (write_resource_flags & WRITE_RESOURCE_FLAG_RECOMPRESS)
160 if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE)
163 if (lte->resource_location != RESOURCE_IN_WIM)
168 if (rspec->is_pipable != !!(write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE))
172 if (rspec->flags & WIM_RESHDR_FLAG_COMPRESSED) {
173 /* Normal compressed resource: Must use same compression type
175 return (rspec->wim->compression_type == out_ctype &&
176 rspec->wim->chunk_size == out_chunk_size);
179 /* XXX: For compatibility, we can't allow multiple packed resources per
182 if ((rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS) &&
183 (write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS))
185 /* Packed resource: Such resources may contain multiple streams,
186 * and in general only a subset of them need to be written. As
187 * a heuristic, re-use the raw data if at least half the
188 * uncompressed size is being written. */
190 /* Note: packed resources contain a header that specifies the
191 * compression type and chunk size; therefore we don't need to
192 * check if they are compatible with @out_ctype and
193 * @out_chunk_size. */
195 struct wim_lookup_table_entry *res_stream;
198 list_for_each_entry(res_stream, &rspec->stream_list, rspec_node)
199 if (res_stream->will_be_in_output_wim)
200 write_size += res_stream->size;
202 return (write_size > rspec->uncompressed_size / 2);
210 filter_resource_flags(u8 flags)
212 return (flags & ~(WIM_RESHDR_FLAG_PACKED_STREAMS |
213 WIM_RESHDR_FLAG_COMPRESSED |
214 WIM_RESHDR_FLAG_SPANNED |
215 WIM_RESHDR_FLAG_FREE));
219 stream_set_out_reshdr_for_reuse(struct wim_lookup_table_entry *lte)
221 const struct wim_resource_spec *rspec;
223 wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
226 if (rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
228 wimlib_assert(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS);
230 lte->out_reshdr.offset_in_wim = lte->offset_in_res;
231 lte->out_reshdr.uncompressed_size = 0;
232 lte->out_reshdr.size_in_wim = lte->size;
234 lte->out_res_offset_in_wim = rspec->offset_in_wim;
235 lte->out_res_size_in_wim = rspec->size_in_wim;
236 /*lte->out_res_uncompressed_size = rspec->uncompressed_size;*/
238 wimlib_assert(!(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS));
240 lte->out_reshdr.offset_in_wim = rspec->offset_in_wim;
241 lte->out_reshdr.uncompressed_size = rspec->uncompressed_size;
242 lte->out_reshdr.size_in_wim = rspec->size_in_wim;
244 lte->out_reshdr.flags = lte->flags;
248 /* Write the header for a stream in a pipable WIM. */
250 write_pwm_stream_header(const struct wim_lookup_table_entry *lte,
251 struct filedes *out_fd,
252 int additional_reshdr_flags)
254 struct pwm_stream_hdr stream_hdr;
258 stream_hdr.magic = cpu_to_le64(PWM_STREAM_MAGIC);
259 stream_hdr.uncompressed_size = cpu_to_le64(lte->size);
260 if (additional_reshdr_flags & PWM_RESHDR_FLAG_UNHASHED) {
261 zero_out_hash(stream_hdr.hash);
263 wimlib_assert(!lte->unhashed);
264 copy_hash(stream_hdr.hash, lte->hash);
267 reshdr_flags = filter_resource_flags(lte->flags);
268 reshdr_flags |= additional_reshdr_flags;
269 stream_hdr.flags = cpu_to_le32(reshdr_flags);
270 ret = full_write(out_fd, &stream_hdr, sizeof(stream_hdr));
272 ERROR_WITH_ERRNO("Write error");
276 struct write_streams_progress_data {
277 wimlib_progress_func_t progress_func;
278 union wimlib_progress_info progress;
279 uint64_t next_progress;
280 WIMStruct *prev_wim_part;
284 do_write_streams_progress(struct write_streams_progress_data *progress_data,
287 struct wim_lookup_table_entry *cur_stream)
289 union wimlib_progress_info *progress = &progress_data->progress;
293 progress->write_streams.total_bytes -= size;
294 if (progress_data->next_progress != ~(uint64_t)0 &&
295 progress_data->next_progress > progress->write_streams.total_bytes)
297 progress_data->next_progress = progress->write_streams.total_bytes;
300 progress->write_streams.completed_bytes += size;
302 new_wim_part = false;
303 if (cur_stream->resource_location == RESOURCE_IN_WIM &&
304 cur_stream->rspec->wim != progress_data->prev_wim_part)
306 if (progress_data->prev_wim_part) {
308 progress->write_streams.completed_parts++;
310 progress_data->prev_wim_part = cur_stream->rspec->wim;
312 progress->write_streams.completed_streams++;
313 if (progress_data->progress_func
314 && (progress->write_streams.completed_bytes >= progress_data->next_progress
317 progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
319 if (progress_data->next_progress == progress->write_streams.total_bytes) {
320 progress_data->next_progress = ~(uint64_t)0;
322 progress_data->next_progress =
323 min(progress->write_streams.total_bytes,
324 progress->write_streams.completed_bytes +
325 progress->write_streams.total_bytes / 100);
330 struct write_streams_ctx {
331 /* File descriptor the streams are being written to. */
332 struct filedes *out_fd;
334 /* Lookup table for the WIMStruct on whose behalf the streams are being
336 struct wim_lookup_table *lookup_table;
338 /* Compression format to use. */
341 /* Maximum uncompressed chunk size in compressed resources to use. */
344 /* Flags that affect how the streams will be written. */
345 int write_resource_flags;
347 /* Data used for issuing WRITE_STREAMS progress. */
348 struct write_streams_progress_data progress_data;
350 struct filter_context *filter_ctx;
352 /* Upper bound on the total number of bytes that need to be compressed.
354 u64 num_bytes_to_compress;
356 /* Pointer to the chunk_compressor implementation being used for
357 * compressing chunks of data, or NULL if chunks are being written
359 struct chunk_compressor *compressor;
361 /* Buffer for dividing the read data into chunks of size
362 * @out_chunk_size. */
365 /* Number of bytes in @chunk_buf that are currently filled. */
366 size_t chunk_buf_filled;
368 /* List of streams that currently have chunks being compressed. */
369 struct list_head pending_streams;
371 /* Set to true if the stream currently being read was a duplicate, and
372 * therefore the corresponding stream entry needs to be freed once the
373 * read finishes. (In this case we add the duplicate entry to
374 * pending_streams rather than the entry being read.) */
375 bool stream_was_duplicate;
377 /* Current uncompressed offset in the resource being read. */
378 u64 cur_read_res_offset;
380 /* Uncompressed size of the resource currently being read. */
381 u64 cur_read_res_size;
383 /* Current uncompressed offset in the resource being written. */
384 u64 cur_write_res_offset;
386 /* Uncompressed size of resource currently being written. */
387 u64 cur_write_res_size;
389 /* Array that is filled in with compressed chunk sizes as a resource is
393 /* Index of next entry in @chunk_csizes to fill in. */
396 /* Number of entries in @chunk_csizes currently allocated. */
397 size_t num_alloc_chunks;
399 /* Offset in the output file of the start of the chunks of the resource
400 * currently being written. */
401 u64 chunks_start_offset;
405 get_chunk_entry_size(u64 res_size, int write_resource_flags)
407 if (res_size <= UINT32_MAX ||
408 (write_resource_flags & WIM_RESHDR_FLAG_PACKED_STREAMS))
414 /* Reserve space for the chunk table and prepare to accumulate the chunk table
417 begin_chunk_table(struct write_streams_ctx *ctx, u64 res_expected_size)
419 u64 expected_num_chunks;
420 u64 expected_num_chunk_entries;
424 /* Calculate the number of chunks and chunk entries that should be
425 * needed for the resource. These normally will be the final values,
426 * but in PACKED_STREAMS mode some of the streams we're planning to
427 * write into the resource may be duplicates, and therefore discarded,
428 * potentially decreasing the number of chunk entries needed. */
429 expected_num_chunks = DIV_ROUND_UP(res_expected_size, ctx->out_chunk_size);
430 expected_num_chunk_entries = expected_num_chunks;
431 if (!(ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS))
432 expected_num_chunk_entries--;
434 /* Make sure the chunk_csizes array is long enough to store the
435 * compressed size of each chunk. */
436 if (expected_num_chunks > ctx->num_alloc_chunks) {
437 u64 new_length = expected_num_chunks + 50;
439 if ((size_t)new_length != new_length) {
440 ERROR("Resource size too large (%"PRIu64" bytes!",
442 return WIMLIB_ERR_NOMEM;
445 FREE(ctx->chunk_csizes);
446 ctx->chunk_csizes = MALLOC(new_length * sizeof(ctx->chunk_csizes[0]));
447 if (ctx->chunk_csizes == NULL) {
448 ctx->num_alloc_chunks = 0;
449 return WIMLIB_ERR_NOMEM;
451 ctx->num_alloc_chunks = new_length;
454 ctx->chunk_index = 0;
456 if (!(ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE)) {
457 /* Reserve space for the chunk table in the output file. In the
458 * case of packed resources this reserves the upper bound for
459 * the needed space, not necessarily the exact space which will
460 * prove to be needed. At this point, we just use @chunk_csizes
461 * for a buffer of 0's because the actual compressed chunk sizes
463 reserve_size = expected_num_chunk_entries *
464 get_chunk_entry_size(res_expected_size,
465 ctx->write_resource_flags);
466 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS)
467 reserve_size += sizeof(struct alt_chunk_table_header_disk);
468 memset(ctx->chunk_csizes, 0, reserve_size);
469 ret = full_write(ctx->out_fd, ctx->chunk_csizes, reserve_size);
477 begin_write_resource(struct write_streams_ctx *ctx, u64 res_expected_size)
481 wimlib_assert(res_expected_size != 0);
483 if (ctx->compressor != NULL) {
484 ret = begin_chunk_table(ctx, res_expected_size);
489 /* Output file descriptor is now positioned at the offset at which to
490 * write the first chunk of the resource. */
491 ctx->chunks_start_offset = ctx->out_fd->offset;
492 ctx->cur_write_res_offset = 0;
493 ctx->cur_write_res_size = res_expected_size;
498 end_chunk_table(struct write_streams_ctx *ctx, u64 res_actual_size,
499 u64 *res_start_offset_ret, u64 *res_store_size_ret)
501 size_t actual_num_chunks;
502 size_t actual_num_chunk_entries;
503 size_t chunk_entry_size;
506 actual_num_chunks = ctx->chunk_index;
507 actual_num_chunk_entries = actual_num_chunks;
508 if (!(ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS))
509 actual_num_chunk_entries--;
511 chunk_entry_size = get_chunk_entry_size(res_actual_size,
512 ctx->write_resource_flags);
514 typedef le64 __attribute__((may_alias)) aliased_le64_t;
515 typedef le32 __attribute__((may_alias)) aliased_le32_t;
517 if (chunk_entry_size == 4) {
518 aliased_le32_t *entries = (aliased_le32_t*)ctx->chunk_csizes;
520 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
521 for (size_t i = 0; i < actual_num_chunk_entries; i++)
522 entries[i] = cpu_to_le32(ctx->chunk_csizes[i]);
524 u32 offset = ctx->chunk_csizes[0];
525 for (size_t i = 0; i < actual_num_chunk_entries; i++) {
526 u32 next_size = ctx->chunk_csizes[i + 1];
527 entries[i] = cpu_to_le32(offset);
532 aliased_le64_t *entries = (aliased_le64_t*)ctx->chunk_csizes;
534 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
535 for (size_t i = 0; i < actual_num_chunk_entries; i++)
536 entries[i] = cpu_to_le64(ctx->chunk_csizes[i]);
538 u64 offset = ctx->chunk_csizes[0];
539 for (size_t i = 0; i < actual_num_chunk_entries; i++) {
540 u64 next_size = ctx->chunk_csizes[i + 1];
541 entries[i] = cpu_to_le64(offset);
547 size_t chunk_table_size = actual_num_chunk_entries * chunk_entry_size;
548 u64 res_start_offset;
551 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE) {
552 ret = full_write(ctx->out_fd, ctx->chunk_csizes, chunk_table_size);
555 res_end_offset = ctx->out_fd->offset;
556 res_start_offset = ctx->chunks_start_offset;
558 res_end_offset = ctx->out_fd->offset;
560 u64 chunk_table_offset;
562 chunk_table_offset = ctx->chunks_start_offset - chunk_table_size;
564 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
565 struct alt_chunk_table_header_disk hdr;
567 hdr.res_usize = cpu_to_le64(res_actual_size);
568 hdr.chunk_size = cpu_to_le32(ctx->out_chunk_size);
569 hdr.compression_format = cpu_to_le32(ctx->out_ctype);
571 BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_LZX != 1);
572 BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_XPRESS != 2);
573 BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_LZMS != 3);
575 ret = full_pwrite(ctx->out_fd, &hdr, sizeof(hdr),
576 chunk_table_offset - sizeof(hdr));
579 res_start_offset = chunk_table_offset - sizeof(hdr);
581 res_start_offset = chunk_table_offset;
584 ret = full_pwrite(ctx->out_fd, ctx->chunk_csizes,
585 chunk_table_size, chunk_table_offset);
590 *res_start_offset_ret = res_start_offset;
591 *res_store_size_ret = res_end_offset - res_start_offset;
596 ERROR_WITH_ERRNO("Write error");
600 /* Finish writing a WIM resource by writing or updating the chunk table (if not
601 * writing the data uncompressed) and loading its metadata into @out_reshdr. */
603 end_write_resource(struct write_streams_ctx *ctx, struct wim_reshdr *out_reshdr)
607 u64 res_uncompressed_size;
608 u64 res_offset_in_wim;
610 wimlib_assert(ctx->cur_write_res_size == ctx->cur_write_res_offset);
611 res_uncompressed_size = ctx->cur_write_res_size;
613 if (ctx->compressor) {
614 ret = end_chunk_table(ctx, res_uncompressed_size,
615 &res_offset_in_wim, &res_size_in_wim);
619 res_offset_in_wim = ctx->chunks_start_offset;
620 res_size_in_wim = ctx->out_fd->offset - res_offset_in_wim;
622 out_reshdr->uncompressed_size = res_uncompressed_size;
623 out_reshdr->size_in_wim = res_size_in_wim;
624 out_reshdr->offset_in_wim = res_offset_in_wim;
625 DEBUG("Finished writing resource: %"PRIu64" => %"PRIu64" @ %"PRIu64"",
626 res_uncompressed_size, res_size_in_wim, res_offset_in_wim);
630 /* Begin processing a stream for writing. */
632 write_stream_begin_read(struct wim_lookup_table_entry *lte,
633 bool is_partial_res, void *_ctx)
635 struct write_streams_ctx *ctx = _ctx;
638 wimlib_assert(lte->size > 0);
640 ctx->cur_read_res_offset = 0;
641 ctx->cur_read_res_size = lte->size;
643 /* As an optimization, we allow some streams to be "unhashed", meaning
644 * their SHA1 message digests are unknown. This is the case with
645 * streams that are added by scanning a directry tree with
646 * wimlib_add_image(), for example. Since WIM uses single-instance
647 * streams, we don't know whether such each such stream really need to
648 * written until it is actually checksummed, unless it has a unique
649 * size. In such cases we read and checksum the stream in this
650 * function, thereby advancing ahead of read_stream_list(), which will
651 * still provide the data again to write_stream_process_chunk(). This
652 * is okay because an unhashed stream cannot be in a WIM resource, which
653 * might be costly to decompress. */
654 ctx->stream_was_duplicate = false;
655 if (ctx->lookup_table != NULL && lte->unhashed && !lte->unique_size) {
657 wimlib_assert(!is_partial_res);
659 struct wim_lookup_table_entry *lte_new;
661 ret = hash_unhashed_stream(lte, ctx->lookup_table, <e_new);
664 if (lte_new != lte) {
665 /* Duplicate stream detected. */
667 if (lte_new->will_be_in_output_wim ||
668 stream_filtered(lte_new, ctx->filter_ctx))
670 /* The duplicate stream is already being
671 * included in the output WIM, or it would be
672 * filtered out if it had been. Skip writing
673 * this stream (and reading it again) entirely,
674 * passing its output reference count to the
675 * duplicate stream in the former case. */
676 DEBUG("Discarding duplicate stream of "
677 "length %"PRIu64, lte->size);
678 do_write_streams_progress(&ctx->progress_data,
679 lte->size, true, lte);
680 list_del(<e->write_streams_list);
681 list_del(<e->lookup_table_list);
682 if (lte_new->will_be_in_output_wim)
683 lte_new->out_refcnt += lte->out_refcnt;
684 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS)
685 ctx->cur_write_res_size -= lte->size;
686 free_lookup_table_entry(lte);
687 return BEGIN_STREAM_STATUS_SKIP_STREAM;
689 /* The duplicate stream can validly be written,
690 * but was not marked as such. Discard the
691 * current stream entry and use the duplicate,
692 * but actually freeing the current entry must
693 * wait until read_stream_list() has finished
694 * reading its data. */
695 DEBUG("Stream duplicate, but not already "
696 "selected for writing.");
697 list_replace(<e->write_streams_list,
698 <e_new->write_streams_list);
699 list_replace(<e->lookup_table_list,
700 <e_new->lookup_table_list);
701 lte_new->out_refcnt = lte->out_refcnt;
702 lte_new->will_be_in_output_wim = 1;
703 ctx->stream_was_duplicate = true;
708 list_move_tail(<e->write_streams_list, &ctx->pending_streams);
712 /* Rewrite a stream that was just written compressed as uncompressed instead.
713 * This function is optional, but if a stream did not compress to less than its
714 * original size, it might as well be written uncompressed. */
716 write_stream_uncompressed(struct wim_lookup_table_entry *lte,
717 struct filedes *out_fd)
720 u64 begin_offset = lte->out_reshdr.offset_in_wim;
721 u64 end_offset = out_fd->offset;
723 if (filedes_seek(out_fd, begin_offset) == -1)
726 ret = extract_stream_to_fd(lte, out_fd, lte->size);
728 /* Error reading the uncompressed data. */
729 if (out_fd->offset == begin_offset &&
730 filedes_seek(out_fd, end_offset) != -1)
732 /* Nothing was actually written yet, and we successfully
733 * seeked to the end of the compressed resource, so
734 * don't issue a hard error; just keep the compressed
735 * resource instead. */
736 WARNING("Recovered compressed stream of "
737 "size %"PRIu64", continuing on.",
744 wimlib_assert(out_fd->offset - begin_offset == lte->size);
746 if (out_fd->offset < end_offset &&
747 0 != ftruncate(out_fd->fd, out_fd->offset))
749 ERROR_WITH_ERRNO("Can't truncate output file to "
750 "offset %"PRIu64, out_fd->offset);
751 return WIMLIB_ERR_WRITE;
754 lte->out_reshdr.size_in_wim = lte->size;
755 lte->out_reshdr.flags &= ~(WIM_RESHDR_FLAG_COMPRESSED |
756 WIM_RESHDR_FLAG_PACKED_STREAMS);
760 /* Write the next chunk of (typically compressed) data to the output WIM,
761 * handling the writing of the chunk table. */
763 write_chunk(struct write_streams_ctx *ctx, const void *cchunk,
764 size_t csize, size_t usize)
768 struct wim_lookup_table_entry *lte;
770 lte = list_entry(ctx->pending_streams.next,
771 struct wim_lookup_table_entry, write_streams_list);
773 if (ctx->cur_write_res_offset == 0 &&
774 !(ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS))
776 /* Starting to write a new stream in non-packed mode. */
778 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE) {
779 int additional_reshdr_flags = 0;
780 if (ctx->compressor != NULL)
781 additional_reshdr_flags |= WIM_RESHDR_FLAG_COMPRESSED;
783 DEBUG("Writing pipable WIM stream header "
784 "(offset=%"PRIu64")", ctx->out_fd->offset);
786 ret = write_pwm_stream_header(lte, ctx->out_fd,
787 additional_reshdr_flags);
792 ret = begin_write_resource(ctx, lte->size);
797 if (ctx->compressor != NULL) {
798 /* Record the compresed chunk size. */
799 wimlib_assert(ctx->chunk_index < ctx->num_alloc_chunks);
800 ctx->chunk_csizes[ctx->chunk_index++] = csize;
802 /* If writing a pipable WIM, before the chunk data write a chunk
803 * header that provides the compressed chunk size. */
804 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE) {
805 struct pwm_chunk_hdr chunk_hdr = {
806 .compressed_size = cpu_to_le32(csize),
808 ret = full_write(ctx->out_fd, &chunk_hdr,
815 /* Write the chunk data. */
816 ret = full_write(ctx->out_fd, cchunk, csize);
820 ctx->cur_write_res_offset += usize;
822 do_write_streams_progress(&ctx->progress_data,
825 if (ctx->cur_write_res_offset == ctx->cur_write_res_size &&
826 !(ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS))
828 wimlib_assert(ctx->cur_write_res_offset == lte->size);
830 /* Finished writing a stream in non-packed mode. */
832 ret = end_write_resource(ctx, <e->out_reshdr);
836 lte->out_reshdr.flags = filter_resource_flags(lte->flags);
837 if (ctx->compressor != NULL)
838 lte->out_reshdr.flags |= WIM_RESHDR_FLAG_COMPRESSED;
840 if (ctx->compressor != NULL &&
841 lte->out_reshdr.size_in_wim >= lte->out_reshdr.uncompressed_size &&
842 !(ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE) &&
843 !(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS))
845 /* Stream did not compress to less than its original
846 * size. If we're not writing a pipable WIM (which
847 * could mean the output file descriptor is
848 * non-seekable), and the stream isn't located in a
849 * resource pack (which would make reading it again
850 * costly), truncate the file to the start of the stream
851 * and write it uncompressed instead. */
852 DEBUG("Stream of size %"PRIu64" did not compress to "
853 "less than original size; writing uncompressed.",
855 ret = write_stream_uncompressed(lte, ctx->out_fd);
860 wimlib_assert(lte->out_reshdr.uncompressed_size == lte->size);
862 list_del(<e->write_streams_list);
863 ctx->cur_write_res_offset = 0;
869 ERROR_WITH_ERRNO("Write error");
874 submit_chunk_for_compression(struct write_streams_ctx *ctx,
875 const void *chunk, size_t size)
877 /* While we are unable to submit the chunk for compression (due to too
878 * many chunks already outstanding), retrieve and write the next
879 * compressed chunk. */
880 while (!ctx->compressor->submit_chunk(ctx->compressor, chunk, size)) {
887 bret = ctx->compressor->get_chunk(ctx->compressor,
888 &cchunk, &csize, &usize);
892 ret = write_chunk(ctx, cchunk, csize, usize);
899 /* Process the next chunk of data to be written to a WIM resource. */
901 write_stream_process_chunk(const void *chunk, size_t size, void *_ctx)
903 struct write_streams_ctx *ctx = _ctx;
905 const u8 *chunkptr, *chunkend;
907 wimlib_assert(size != 0);
909 if (ctx->compressor == NULL) {
910 /* Write chunk uncompressed. */
911 ret = write_chunk(ctx, chunk, size, size);
914 ctx->cur_read_res_offset += size;
918 /* Submit the chunk for compression, but take into account that the
919 * @size the chunk was provided in may not correspond to the
920 * @out_chunk_size being used for compression. */
922 chunkend = chunkptr + size;
924 const u8 *resized_chunk;
925 size_t needed_chunk_size;
927 if (ctx->write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
928 needed_chunk_size = ctx->out_chunk_size;
930 u64 res_bytes_remaining;
932 res_bytes_remaining = ctx->cur_read_res_size -
933 ctx->cur_read_res_offset;
934 needed_chunk_size = min(ctx->out_chunk_size,
935 ctx->chunk_buf_filled +
936 res_bytes_remaining);
939 if (ctx->chunk_buf_filled == 0 &&
940 chunkend - chunkptr >= needed_chunk_size)
942 /* No intermediate buffering needed. */
943 resized_chunk = chunkptr;
944 chunkptr += needed_chunk_size;
945 ctx->cur_read_res_offset += needed_chunk_size;
947 /* Intermediate buffering needed. */
948 size_t bytes_consumed;
950 bytes_consumed = min(chunkend - chunkptr,
951 needed_chunk_size - ctx->chunk_buf_filled);
953 memcpy(&ctx->chunk_buf[ctx->chunk_buf_filled],
954 chunkptr, bytes_consumed);
956 resized_chunk = ctx->chunk_buf;
958 chunkptr += bytes_consumed;
959 ctx->cur_read_res_offset += bytes_consumed;
960 ctx->chunk_buf_filled += bytes_consumed;
961 if (ctx->chunk_buf_filled == needed_chunk_size) {
962 resized_chunk = ctx->chunk_buf;
963 ctx->chunk_buf_filled = 0;
970 ret = submit_chunk_for_compression(ctx, resized_chunk,
975 } while (chunkptr != chunkend);
979 /* Finish processing a stream for writing. It may not have been completely
980 * written yet, as the chunk_compressor implementation may still have chunks
981 * buffered or being compressed. */
983 write_stream_end_read(struct wim_lookup_table_entry *lte, int status, void *_ctx)
985 struct write_streams_ctx *ctx = _ctx;
987 wimlib_assert(ctx->cur_read_res_offset == ctx->cur_read_res_size);
988 if (ctx->stream_was_duplicate) {
989 free_lookup_table_entry(lte);
990 } else if (lte->unhashed && ctx->lookup_table != NULL) {
991 list_del(<e->unhashed_list);
992 lookup_table_insert(ctx->lookup_table, lte);
998 /* Compute statistics about a list of streams that will be written.
1000 * Assumes the streams are sorted such that all streams located in each distinct
1001 * WIM (specified by WIMStruct) are together. */
1003 compute_stream_list_stats(struct list_head *stream_list,
1004 struct write_streams_ctx *ctx)
1006 struct wim_lookup_table_entry *lte;
1007 u64 total_bytes = 0;
1008 u64 num_streams = 0;
1009 u64 total_parts = 0;
1010 WIMStruct *prev_wim_part = NULL;
1012 list_for_each_entry(lte, stream_list, write_streams_list) {
1014 total_bytes += lte->size;
1015 if (lte->resource_location == RESOURCE_IN_WIM) {
1016 if (prev_wim_part != lte->rspec->wim) {
1017 prev_wim_part = lte->rspec->wim;
1022 ctx->progress_data.progress.write_streams.total_bytes = total_bytes;
1023 ctx->progress_data.progress.write_streams.total_streams = num_streams;
1024 ctx->progress_data.progress.write_streams.completed_bytes = 0;
1025 ctx->progress_data.progress.write_streams.completed_streams = 0;
1026 ctx->progress_data.progress.write_streams.compression_type = ctx->out_ctype;
1027 ctx->progress_data.progress.write_streams.total_parts = total_parts;
1028 ctx->progress_data.progress.write_streams.completed_parts = 0;
1029 ctx->progress_data.next_progress = 0;
1030 ctx->progress_data.prev_wim_part = NULL;
1033 /* Find streams in @stream_list that can be copied to the output WIM in raw form
1034 * rather than compressed. Delete these streams from @stream_list, and move one
1035 * per resource to @raw_copy_resources. Return the total uncompressed size of
1036 * the streams that need to be compressed. */
1038 find_raw_copy_resources(struct list_head *stream_list,
1039 int write_resource_flags,
1042 struct list_head *raw_copy_resources)
1044 struct wim_lookup_table_entry *lte, *tmp;
1045 u64 num_bytes_to_compress = 0;
1047 INIT_LIST_HEAD(raw_copy_resources);
1049 /* Initialize temporary raw_copy_ok flag. */
1050 list_for_each_entry(lte, stream_list, write_streams_list)
1051 if (lte->resource_location == RESOURCE_IN_WIM)
1052 lte->rspec->raw_copy_ok = 0;
1054 list_for_each_entry_safe(lte, tmp, stream_list, write_streams_list) {
1055 if (lte->resource_location == RESOURCE_IN_WIM &&
1056 lte->rspec->raw_copy_ok)
1058 list_del(<e->write_streams_list);
1059 } else if (can_raw_copy(lte, write_resource_flags,
1060 out_ctype, out_chunk_size))
1062 lte->rspec->raw_copy_ok = 1;
1063 list_move_tail(<e->write_streams_list,
1064 raw_copy_resources);
1066 num_bytes_to_compress += lte->size;
1070 return num_bytes_to_compress;
1073 /* Copy a raw compressed resource located in another WIM file to the WIM file
1076 write_raw_copy_resource(struct wim_resource_spec *in_rspec,
1077 struct filedes *out_fd)
1079 u64 cur_read_offset;
1080 u64 end_read_offset;
1081 u8 buf[BUFFER_SIZE];
1082 size_t bytes_to_read;
1084 struct filedes *in_fd;
1085 struct wim_lookup_table_entry *lte;
1086 u64 out_offset_in_wim;
1088 DEBUG("Copying raw compressed data (size_in_wim=%"PRIu64", "
1089 "uncompressed_size=%"PRIu64")",
1090 in_rspec->size_in_wim, in_rspec->uncompressed_size);
1092 /* Copy the raw data. */
1093 cur_read_offset = in_rspec->offset_in_wim;
1094 end_read_offset = cur_read_offset + in_rspec->size_in_wim;
1096 out_offset_in_wim = out_fd->offset;
1098 if (in_rspec->is_pipable) {
1099 if (cur_read_offset < sizeof(struct pwm_stream_hdr))
1100 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1101 cur_read_offset -= sizeof(struct pwm_stream_hdr);
1102 out_offset_in_wim += sizeof(struct pwm_stream_hdr);
1104 in_fd = &in_rspec->wim->in_fd;
1105 wimlib_assert(cur_read_offset != end_read_offset);
1108 bytes_to_read = min(sizeof(buf), end_read_offset - cur_read_offset);
1110 ret = full_pread(in_fd, buf, bytes_to_read, cur_read_offset);
1114 ret = full_write(out_fd, buf, bytes_to_read);
1118 cur_read_offset += bytes_to_read;
1120 } while (cur_read_offset != end_read_offset);
1122 list_for_each_entry(lte, &in_rspec->stream_list, rspec_node) {
1123 if (lte->will_be_in_output_wim) {
1124 stream_set_out_reshdr_for_reuse(lte);
1125 if (in_rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS)
1126 lte->out_res_offset_in_wim = out_offset_in_wim;
1128 lte->out_reshdr.offset_in_wim = out_offset_in_wim;
1135 /* Copy a list of raw compressed resources located other WIM file(s) to the WIM
1136 * file being written. */
1138 write_raw_copy_resources(struct list_head *raw_copy_resources,
1139 struct filedes *out_fd,
1140 struct write_streams_progress_data *progress_data)
1142 struct wim_lookup_table_entry *lte;
1145 list_for_each_entry(lte, raw_copy_resources, write_streams_list) {
1146 ret = write_raw_copy_resource(lte->rspec, out_fd);
1149 do_write_streams_progress(progress_data, lte->size, false, lte);
1154 /* Wait for and write all chunks pending in the compressor. */
1156 finish_remaining_chunks(struct write_streams_ctx *ctx)
1163 if (ctx->compressor == NULL)
1166 if (ctx->chunk_buf_filled != 0) {
1167 ret = submit_chunk_for_compression(ctx, ctx->chunk_buf,
1168 ctx->chunk_buf_filled);
1173 while (ctx->compressor->get_chunk(ctx->compressor, &cdata, &csize, &usize)) {
1174 ret = write_chunk(ctx, cdata, csize, usize);
1182 remove_zero_length_streams(struct list_head *stream_list)
1184 struct wim_lookup_table_entry *lte, *tmp;
1186 list_for_each_entry_safe(lte, tmp, stream_list, write_streams_list) {
1187 wimlib_assert(lte->will_be_in_output_wim);
1188 if (lte->size == 0) {
1189 list_del(<e->write_streams_list);
1190 lte->out_reshdr.offset_in_wim = 0;
1191 lte->out_reshdr.size_in_wim = 0;
1192 lte->out_reshdr.uncompressed_size = 0;
1193 lte->out_reshdr.flags = filter_resource_flags(lte->flags);
1199 * Write a list of streams to the output WIM file.
1202 * The list of streams to write, specifies a list of `struct
1203 * wim_lookup_table_entry's linked by the 'write_streams_list' member.
1206 * The file descriptor, opened for writing, to which to write the streams.
1208 * @write_resource_flags
1209 * Flags to modify how the streams are written:
1211 * WRITE_RESOURCE_FLAG_RECOMPRESS:
1212 * Force compression of all resources, even if they could otherwise
1213 * be re-used by caping the raw data, due to being located in a WIM
1214 * file with compatible compression parameters.
1216 * WRITE_RESOURCE_FLAG_PIPABLE:
1217 * Write the resources in the wimlib-specific pipable format, and
1218 * furthermore do so in such a way that no seeking backwards in
1219 * @out_fd will be performed (so it may be a pipe, contrary to the
1220 * default behavior).
1222 * WRITE_RESOURCE_FLAG_PACK_STREAMS:
1223 * Pack all the streams into a single resource rather than writing
1224 * them in separate resources. This format is only valid if the
1225 * WIM version number is WIM_VERSION_PACKED_STREAMS. This flag
1226 * currently may not be combined with WRITE_RESOURCE_FLAG_PIPABLE.
1229 * Compression format to use to write the output streams, specified as one
1230 * of the WIMLIB_COMPRESSION_TYPE_* constants, excepting
1231 * WIMLIB_COMPRESSION_TYPE_INVALID but including
1232 * WIMLIB_COMPRESSION_TYPE_NONE.
1235 * Chunk size to use to write the streams. It must be a valid chunk size
1236 * for the specified compression format @out_ctype, unless @out_ctype is
1237 * WIMLIB_COMPRESSION_TYPE_NONE, in which case this parameter is ignored.
1240 * Number of threads to use to compress data. If 0, a default number of
1241 * threads will be chosen. The number of threads still may be decreased
1242 * from the specified value if insufficient memory is detected.
1245 * If on-the-fly deduplication of unhashed streams is desired, this
1246 * parameter must be pointer to the lookup table for the WIMStruct on whose
1247 * behalf the streams are being written. Otherwise, this parameter can be
1251 * If on-the-fly deduplication of unhashed streams is desired, this
1252 * parameter can be a pointer to a context for stream filtering used to
1253 * detect whether the duplicate stream has been hard-filtered or not. If
1254 * no streams are hard-filtered or no streams are unhashed, this parameter
1258 * If non-NULL, a progress function that will be called periodically with
1259 * WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages. Note that on-the-fly
1260 * deduplication of unhashed streams may result in the total bytes provided
1261 * in the progress data to decrease from one message to the next.
1263 * This function will write the streams in @stream_list to resources in
1264 * consecutive positions in the output WIM file, or to a single packed resource
1265 * if WRITE_RESOURCE_FLAG_PACK_STREAMS was specified in @write_resource_flags.
1266 * In both cases, the @out_reshdr of the `struct wim_lookup_table_entry' for
1267 * each stream written will be updated to specify its location, size, and flags
1268 * in the output WIM. In the packed resource case,
1269 * WIM_RESHDR_FLAG_PACKED_STREAMS shall be set in the @flags field of the
1270 * @out_reshdr, and @out_res_offset_in_wim and @out_res_size_in_wim will also
1271 * be set to the offset and size, respectively, in the output WIM of the full
1272 * packed resource containing the corresponding stream.
1274 * Each of the streams to write may be in any location supported by the
1275 * resource-handling code (specifically, read_stream_list()), such as the
1276 * contents of external file that has been logically added to the output WIM, or
1277 * a stream in another WIM file that has been imported, or even stream in the
1278 * "same" WIM file of which a modified copy is being written. In the case that
1279 * a stream is already in a WIM file and uses compatible compression parameters,
1280 * by default this function will re-use the raw data instead of decompressing
1281 * it, then recompressing it; however, with WRITE_RESOURCE_FLAG_RECOMPRESS
1282 * specified in @write_resource_flags, this is not done.
1284 * As a further requirement, this function requires that the
1285 * @will_be_in_output_wim member be set on all streams in @stream_list as well
1286 * as any other streams not in @stream_list that will be in the output WIM file,
1287 * but not on any other streams in the output WIM's lookup table or sharing a
1288 * packed resource with a stream in @stream_list. Still furthermore, if
1289 * on-the-fly deduplication of streams is possible, then all streams in
1290 * @stream_list must also be linked by @lookup_table_list along with any other
1291 * streams that have @will_be_in_output_wim set.
1293 * This function handles on-the-fly deduplication of streams for which SHA1
1294 * message digests have not yet been calculated and it is therefore known
1295 * whether such streams are already in @stream_list or in the WIM's lookup table
1296 * at all. If @lookup_table is non-NULL, then each stream in @stream_list that
1297 * has @unhashed set but not @unique_size set is checksummed immediately before
1298 * it would otherwise be read for writing in order to determine if it is
1299 * identical to another stream already being written or one that would be
1300 * filtered out of the output WIM using stream_filtered() with the context
1301 * @filter_ctx. Each such duplicate stream will be removed from @stream_list, its
1302 * reference count transfered to the pre-existing duplicate stream, its memory
1303 * freed, and will not be written. Alternatively, if a stream in @stream_list
1304 * is a duplicate with any stream in @lookup_table that has not been marked for
1305 * writing or would not be hard-filtered, it is freed and the pre-existing
1306 * duplicate is written instead, taking ownership of the reference count and
1307 * slot in the @lookup_table_list.
1309 * Returns 0 if all streams were written successfully (or did not need to be
1310 * written); otherwise a non-zero error code.
1313 write_stream_list(struct list_head *stream_list,
1314 struct filedes *out_fd,
1315 int write_resource_flags,
1318 unsigned num_threads,
1319 struct wim_lookup_table *lookup_table,
1320 struct filter_context *filter_ctx,
1321 wimlib_progress_func_t progress_func)
1324 struct write_streams_ctx ctx;
1325 struct list_head raw_copy_resources;
1327 wimlib_assert((write_resource_flags &
1328 (WRITE_RESOURCE_FLAG_PACK_STREAMS |
1329 WRITE_RESOURCE_FLAG_PIPABLE)) !=
1330 (WRITE_RESOURCE_FLAG_PACK_STREAMS |
1331 WRITE_RESOURCE_FLAG_PIPABLE));
1333 remove_zero_length_streams(stream_list);
1335 if (list_empty(stream_list)) {
1336 DEBUG("No streams to write.");
1340 memset(&ctx, 0, sizeof(ctx));
1342 /* Pre-sorting the streams is required for compute_stream_list_stats().
1343 * Afterwards, read_stream_list() need not sort them again. */
1344 ret = sort_stream_list_by_sequential_order(stream_list,
1345 offsetof(struct wim_lookup_table_entry,
1346 write_streams_list));
1350 ctx.out_fd = out_fd;
1351 ctx.lookup_table = lookup_table;
1352 ctx.out_ctype = out_ctype;
1353 ctx.out_chunk_size = out_chunk_size;
1354 ctx.write_resource_flags = write_resource_flags;
1355 ctx.filter_ctx = filter_ctx;
1357 if (out_chunk_size != 0) {
1358 if (out_chunk_size <= STACK_MAX) {
1359 ctx.chunk_buf = alloca(out_chunk_size);
1361 ctx.chunk_buf = MALLOC(out_chunk_size);
1362 if (ctx.chunk_buf == NULL) {
1363 ret = WIMLIB_ERR_NOMEM;
1364 goto out_destroy_context;
1368 ctx.chunk_buf_filled = 0;
1370 compute_stream_list_stats(stream_list, &ctx);
1372 ctx.progress_data.progress_func = progress_func;
1374 ctx.num_bytes_to_compress = find_raw_copy_resources(stream_list,
1375 write_resource_flags,
1378 &raw_copy_resources);
1380 DEBUG("Writing stream list "
1381 "(offset = %"PRIu64", write_resource_flags=0x%08x, "
1382 "out_ctype=%d, out_chunk_size=%u, num_threads=%u, "
1383 "total_bytes=%"PRIu64", num_bytes_to_compress=%"PRIu64")",
1384 out_fd->offset, write_resource_flags,
1385 out_ctype, out_chunk_size, num_threads,
1386 ctx.progress_data.progress.write_streams.total_bytes,
1387 ctx.num_bytes_to_compress);
1389 if (ctx.num_bytes_to_compress == 0) {
1390 DEBUG("No compression needed; skipping to raw copy!");
1391 goto out_write_raw_copy_resources;
1394 /* Unless uncompressed output was required, allocate a chunk_compressor
1395 * to do compression. There are serial and parallel implementations of
1396 * the chunk_compressor interface. We default to parallel using the
1397 * specified number of threads, unless the upper bound on the number
1398 * bytes needing to be compressed is less 2000000 (heuristic value). */
1399 if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
1401 #ifdef ENABLE_MULTITHREADED_COMPRESSION
1402 if (ctx.num_bytes_to_compress >= 2000000) {
1403 ret = new_parallel_chunk_compressor(out_ctype,
1408 DEBUG("Couldn't create parallel chunk compressor "
1409 "(status %d)", ret);
1414 if (ctx.compressor == NULL) {
1415 ret = new_serial_chunk_compressor(out_ctype, out_chunk_size,
1418 goto out_destroy_context;
1423 ctx.progress_data.progress.write_streams.num_threads = ctx.compressor->num_threads;
1425 ctx.progress_data.progress.write_streams.num_threads = 1;
1427 DEBUG("Actually using %u threads",
1428 ctx.progress_data.progress.write_streams.num_threads);
1430 INIT_LIST_HEAD(&ctx.pending_streams);
1432 if (ctx.progress_data.progress_func) {
1433 (*ctx.progress_data.progress_func)(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
1434 &ctx.progress_data.progress);
1437 if (write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
1438 ret = begin_write_resource(&ctx, ctx.num_bytes_to_compress);
1440 goto out_destroy_context;
1443 /* Read the list of streams needing to be compressed, using the
1444 * specified callbacks to execute processing of the data. */
1446 struct read_stream_list_callbacks cbs = {
1447 .begin_stream = write_stream_begin_read,
1448 .begin_stream_ctx = &ctx,
1449 .consume_chunk = write_stream_process_chunk,
1450 .consume_chunk_ctx = &ctx,
1451 .end_stream = write_stream_end_read,
1452 .end_stream_ctx = &ctx,
1455 ret = read_stream_list(stream_list,
1456 offsetof(struct wim_lookup_table_entry, write_streams_list),
1458 STREAM_LIST_ALREADY_SORTED |
1459 VERIFY_STREAM_HASHES |
1460 COMPUTE_MISSING_STREAM_HASHES);
1463 goto out_destroy_context;
1465 ret = finish_remaining_chunks(&ctx);
1467 goto out_destroy_context;
1469 if (write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
1470 struct wim_reshdr reshdr;
1471 struct wim_lookup_table_entry *lte;
1474 ret = end_write_resource(&ctx, &reshdr);
1476 goto out_destroy_context;
1478 DEBUG("Ending packed resource: %lu %lu %lu.",
1479 reshdr.offset_in_wim,
1481 reshdr.uncompressed_size);
1484 list_for_each_entry(lte, &ctx.pending_streams, write_streams_list) {
1485 lte->out_reshdr.size_in_wim = lte->size;
1486 lte->out_reshdr.flags = filter_resource_flags(lte->flags);
1487 lte->out_reshdr.flags |= WIM_RESHDR_FLAG_PACKED_STREAMS;
1488 lte->out_reshdr.uncompressed_size = 0;
1489 lte->out_reshdr.offset_in_wim = offset_in_res;
1490 lte->out_res_offset_in_wim = reshdr.offset_in_wim;
1491 lte->out_res_size_in_wim = reshdr.size_in_wim;
1492 /*lte->out_res_uncompressed_size = reshdr.uncompressed_size;*/
1493 offset_in_res += lte->size;
1495 wimlib_assert(offset_in_res == reshdr.uncompressed_size);
1498 out_write_raw_copy_resources:
1499 /* Copy any compressed resources for which the raw data can be reused
1500 * without decompression. */
1501 ret = write_raw_copy_resources(&raw_copy_resources, ctx.out_fd,
1502 &ctx.progress_data);
1504 out_destroy_context:
1505 if (out_chunk_size > STACK_MAX)
1506 FREE(ctx.chunk_buf);
1507 FREE(ctx.chunk_csizes);
1509 ctx.compressor->destroy(ctx.compressor);
1510 DEBUG("Done (ret=%d)", ret);
1515 wim_write_stream_list(WIMStruct *wim,
1516 struct list_head *stream_list,
1518 unsigned num_threads,
1519 struct filter_context *filter_ctx,
1520 wimlib_progress_func_t progress_func)
1524 int write_resource_flags;
1526 write_resource_flags = write_flags_to_resource_flags(write_flags);
1528 if (write_resource_flags & WRITE_RESOURCE_FLAG_PACK_STREAMS) {
1529 out_chunk_size = wim->out_pack_chunk_size;
1530 out_ctype = wim->out_pack_compression_type;
1532 out_chunk_size = wim->out_chunk_size;
1533 out_ctype = wim->out_compression_type;
1536 return write_stream_list(stream_list,
1538 write_resource_flags,
1548 write_wim_resource(struct wim_lookup_table_entry *lte,
1549 struct filedes *out_fd,
1552 int write_resource_flags)
1554 LIST_HEAD(stream_list);
1555 list_add(<e->write_streams_list, &stream_list);
1556 lte->will_be_in_output_wim = 1;
1557 return write_stream_list(&stream_list,
1559 write_resource_flags & ~WRITE_RESOURCE_FLAG_PACK_STREAMS,
1569 write_wim_resource_from_buffer(const void *buf, size_t buf_size,
1570 int reshdr_flags, struct filedes *out_fd,
1573 struct wim_reshdr *out_reshdr,
1575 int write_resource_flags)
1578 struct wim_lookup_table_entry *lte;
1580 /* Set up a temporary lookup table entry to provide to
1581 * write_wim_resource(). */
1583 lte = new_lookup_table_entry();
1585 return WIMLIB_ERR_NOMEM;
1587 lte->resource_location = RESOURCE_IN_ATTACHED_BUFFER;
1588 lte->attached_buffer = (void*)buf;
1589 lte->size = buf_size;
1590 lte->flags = reshdr_flags;
1592 if (write_resource_flags & WRITE_RESOURCE_FLAG_PIPABLE) {
1593 sha1_buffer(buf, buf_size, lte->hash);
1599 ret = write_wim_resource(lte, out_fd, out_ctype, out_chunk_size,
1600 write_resource_flags);
1604 copy_reshdr(out_reshdr, <e->out_reshdr);
1607 copy_hash(hash, lte->hash);
1610 lte->resource_location = RESOURCE_NONEXISTENT;
1611 free_lookup_table_entry(lte);
1615 struct stream_size_table {
1616 struct hlist_head *array;
1622 init_stream_size_table(struct stream_size_table *tab, size_t capacity)
1624 tab->array = CALLOC(capacity, sizeof(tab->array[0]));
1625 if (tab->array == NULL)
1626 return WIMLIB_ERR_NOMEM;
1627 tab->num_entries = 0;
1628 tab->capacity = capacity;
1633 destroy_stream_size_table(struct stream_size_table *tab)
1639 stream_size_table_insert(struct wim_lookup_table_entry *lte, void *_tab)
1641 struct stream_size_table *tab = _tab;
1643 struct wim_lookup_table_entry *same_size_lte;
1644 struct hlist_node *tmp;
1646 pos = hash_u64(lte->size) % tab->capacity;
1647 lte->unique_size = 1;
1648 hlist_for_each_entry(same_size_lte, tmp, &tab->array[pos], hash_list_2) {
1649 if (same_size_lte->size == lte->size) {
1650 lte->unique_size = 0;
1651 same_size_lte->unique_size = 0;
1656 hlist_add_head(<e->hash_list_2, &tab->array[pos]);
1661 struct find_streams_ctx {
1664 struct list_head stream_list;
1665 struct stream_size_table stream_size_tab;
1669 reference_stream_for_write(struct wim_lookup_table_entry *lte,
1670 struct list_head *stream_list, u32 nref)
1672 if (!lte->will_be_in_output_wim) {
1673 lte->out_refcnt = 0;
1674 list_add_tail(<e->write_streams_list, stream_list);
1675 lte->will_be_in_output_wim = 1;
1677 lte->out_refcnt += nref;
1681 fully_reference_stream_for_write(struct wim_lookup_table_entry *lte,
1684 struct list_head *stream_list = _stream_list;
1685 lte->will_be_in_output_wim = 0;
1686 reference_stream_for_write(lte, stream_list, lte->refcnt);
1691 inode_find_streams_to_reference(const struct wim_inode *inode,
1692 const struct wim_lookup_table *table,
1693 struct list_head *stream_list)
1695 struct wim_lookup_table_entry *lte;
1698 wimlib_assert(inode->i_nlink > 0);
1700 for (i = 0; i <= inode->i_num_ads; i++) {
1701 lte = inode_stream_lte(inode, i, table);
1703 reference_stream_for_write(lte, stream_list,
1705 else if (!is_zero_hash(inode_stream_hash(inode, i)))
1706 return WIMLIB_ERR_RESOURCE_NOT_FOUND;
1712 do_stream_set_not_in_output_wim(struct wim_lookup_table_entry *lte, void *_ignore)
1714 lte->will_be_in_output_wim = 0;
1719 image_find_streams_to_reference(WIMStruct *wim)
1721 struct wim_image_metadata *imd;
1722 struct wim_inode *inode;
1723 struct wim_lookup_table_entry *lte;
1724 struct list_head *stream_list;
1727 imd = wim_get_current_image_metadata(wim);
1729 image_for_each_unhashed_stream(lte, imd)
1730 lte->will_be_in_output_wim = 0;
1732 stream_list = wim->private;
1733 image_for_each_inode(inode, imd) {
1734 ret = inode_find_streams_to_reference(inode,
1744 prepare_unfiltered_list_of_streams_in_output_wim(WIMStruct *wim,
1747 struct list_head *stream_list_ret)
1751 INIT_LIST_HEAD(stream_list_ret);
1753 if (streams_ok && (image == WIMLIB_ALL_IMAGES ||
1754 (image == 1 && wim->hdr.image_count == 1)))
1756 /* Fast case: Assume that all streams are being written and
1757 * that the reference counts are correct. */
1758 struct wim_lookup_table_entry *lte;
1759 struct wim_image_metadata *imd;
1762 for_lookup_table_entry(wim->lookup_table,
1763 fully_reference_stream_for_write,
1766 for (i = 0; i < wim->hdr.image_count; i++) {
1767 imd = wim->image_metadata[i];
1768 image_for_each_unhashed_stream(lte, imd)
1769 fully_reference_stream_for_write(lte, stream_list_ret);
1772 /* Slow case: Walk through the images being written and
1773 * determine the streams referenced. */
1774 for_lookup_table_entry(wim->lookup_table,
1775 do_stream_set_not_in_output_wim, NULL);
1776 wim->private = stream_list_ret;
1777 ret = for_image(wim, image, image_find_streams_to_reference);
1785 struct insert_other_if_hard_filtered_ctx {
1786 struct stream_size_table *tab;
1787 struct filter_context *filter_ctx;
1791 insert_other_if_hard_filtered(struct wim_lookup_table_entry *lte, void *_ctx)
1793 struct insert_other_if_hard_filtered_ctx *ctx = _ctx;
1795 if (!lte->will_be_in_output_wim &&
1796 stream_hard_filtered(lte, ctx->filter_ctx))
1797 stream_size_table_insert(lte, ctx->tab);
1802 determine_stream_size_uniquity(struct list_head *stream_list,
1803 struct wim_lookup_table *lt,
1804 struct filter_context *filter_ctx)
1807 struct stream_size_table tab;
1808 struct wim_lookup_table_entry *lte;
1810 ret = init_stream_size_table(&tab, lt->capacity);
1814 if (may_hard_filter_streams(filter_ctx)) {
1815 struct insert_other_if_hard_filtered_ctx ctx = {
1817 .filter_ctx = filter_ctx,
1819 for_lookup_table_entry(lt, insert_other_if_hard_filtered, &ctx);
1822 list_for_each_entry(lte, stream_list, write_streams_list)
1823 stream_size_table_insert(lte, &tab);
1825 destroy_stream_size_table(&tab);
1830 filter_stream_list_for_write(struct list_head *stream_list,
1831 struct filter_context *filter_ctx)
1833 struct wim_lookup_table_entry *lte, *tmp;
1835 list_for_each_entry_safe(lte, tmp,
1836 stream_list, write_streams_list)
1838 int status = stream_filtered(lte, filter_ctx);
1845 /* Soft filtered. */
1847 /* Hard filtered. */
1848 lte->will_be_in_output_wim = 0;
1849 list_del(<e->lookup_table_list);
1851 list_del(<e->write_streams_list);
1857 * prepare_stream_list_for_write() -
1859 * Prepare the list of streams to write for writing a WIM containing the
1860 * specified image(s) with the specified write flags.
1863 * The WIMStruct on whose behalf the write is occurring.
1866 * Image(s) from the WIM to write; may be WIMLIB_ALL_IMAGES.
1869 * WIMLIB_WRITE_FLAG_* flags for the write operation:
1871 * STREAMS_OK: For writes of all images, assume that all streams in the
1872 * lookup table of @wim and the per-image lists of unhashed streams should
1873 * be taken as-is, and image metadata should not be searched for
1874 * references. This does not exclude filtering with OVERWRITE and
1875 * SKIP_EXTERNAL_WIMS, below.
1877 * OVERWRITE: Streams already present in @wim shall not be returned in
1880 * SKIP_EXTERNAL_WIMS: Streams already present in a WIM file, but not
1881 * @wim, shall be be returned in neither @stream_list_ret nor
1882 * @lookup_table_list_ret.
1885 * List of streams, linked by write_streams_list, that need to be written
1886 * will be returned here.
1888 * Note that this function assumes that unhashed streams will be written;
1889 * it does not take into account that they may become duplicates when
1892 * @lookup_table_list_ret
1893 * List of streams, linked by lookup_table_list, that need to be included
1894 * in the WIM's lookup table will be returned here. This will be a
1895 * superset of the streams in @stream_list_ret.
1897 * This list will be a proper superset of @stream_list_ret if and only if
1898 * WIMLIB_WRITE_FLAG_OVERWRITE was specified in @write_flags and some of
1899 * the streams that would otherwise need to be written were already located
1902 * All streams in this list will have @out_refcnt set to the number of
1903 * references to the stream in the output WIM. If
1904 * WIMLIB_WRITE_FLAG_STREAMS_OK was specified in @write_flags, @out_refcnt
1905 * may be as low as 0.
1908 * A context for queries of stream filter status with stream_filtered() is
1909 * returned in this location.
1911 * In addition, @will_be_in_output_wim will be set to 1 in all stream entries
1912 * inserted into @lookup_table_list_ret and to 0 in all stream entries in the
1913 * lookup table of @wim not inserted into @lookup_table_list_ret.
1915 * Still furthermore, @unique_size will be set to 1 on all stream entries in
1916 * @stream_list_ret that have unique size among all stream entries in
1917 * @stream_list_ret and among all stream entries in the lookup table of @wim
1918 * that are ineligible for being written due to filtering.
1920 * Returns 0 on success; nonzero on read error, memory allocation error, or
1924 prepare_stream_list_for_write(WIMStruct *wim, int image,
1926 struct list_head *stream_list_ret,
1927 struct list_head *lookup_table_list_ret,
1928 struct filter_context *filter_ctx_ret)
1931 struct wim_lookup_table_entry *lte;
1933 filter_ctx_ret->write_flags = write_flags;
1934 filter_ctx_ret->wim = wim;
1936 ret = prepare_unfiltered_list_of_streams_in_output_wim(
1939 write_flags & WIMLIB_WRITE_FLAG_STREAMS_OK,
1944 INIT_LIST_HEAD(lookup_table_list_ret);
1945 list_for_each_entry(lte, stream_list_ret, write_streams_list)
1946 list_add_tail(<e->lookup_table_list, lookup_table_list_ret);
1948 ret = determine_stream_size_uniquity(stream_list_ret, wim->lookup_table,
1953 if (may_filter_streams(filter_ctx_ret))
1954 filter_stream_list_for_write(stream_list_ret, filter_ctx_ret);
1960 write_wim_streams(WIMStruct *wim, int image, int write_flags,
1961 unsigned num_threads,
1962 wimlib_progress_func_t progress_func,
1963 struct list_head *stream_list_override,
1964 struct list_head *lookup_table_list_ret)
1967 struct list_head _stream_list;
1968 struct list_head *stream_list;
1969 struct wim_lookup_table_entry *lte;
1970 struct filter_context _filter_ctx;
1971 struct filter_context *filter_ctx;
1973 if (stream_list_override == NULL) {
1974 /* Normal case: prepare stream list from image(s) being written.
1976 stream_list = &_stream_list;
1977 filter_ctx = &_filter_ctx;
1978 ret = prepare_stream_list_for_write(wim, image, write_flags,
1980 lookup_table_list_ret,
1985 /* Currently only as a result of wimlib_split() being called:
1986 * use stream list already explicitly provided. Use existing
1987 * reference counts. */
1988 stream_list = stream_list_override;
1990 INIT_LIST_HEAD(lookup_table_list_ret);
1991 list_for_each_entry(lte, stream_list, write_streams_list) {
1992 lte->out_refcnt = lte->refcnt;
1993 lte->will_be_in_output_wim = 1;
1994 lte->unique_size = 0;
1995 list_add_tail(<e->lookup_table_list, lookup_table_list_ret);
1999 return wim_write_stream_list(wim,
2008 write_wim_metadata_resources(WIMStruct *wim, int image, int write_flags,
2009 wimlib_progress_func_t progress_func)
2014 int write_resource_flags;
2016 if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA) {
2017 DEBUG("Not writing any metadata resources.");
2021 write_resource_flags = write_flags_to_resource_flags(write_flags);
2023 write_resource_flags &= ~WRITE_RESOURCE_FLAG_PACK_STREAMS;
2025 DEBUG("Writing metadata resources (offset=%"PRIu64")",
2026 wim->out_fd.offset);
2029 progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, NULL);
2031 if (image == WIMLIB_ALL_IMAGES) {
2033 end_image = wim->hdr.image_count;
2035 start_image = image;
2039 for (int i = start_image; i <= end_image; i++) {
2040 struct wim_image_metadata *imd;
2042 imd = wim->image_metadata[i - 1];
2043 /* Build a new metadata resource only if image was modified from
2044 * the original (or was newly added). Otherwise just copy the
2046 if (imd->modified) {
2047 DEBUG("Image %u was modified; building and writing new "
2048 "metadata resource", i);
2049 ret = write_metadata_resource(wim, i,
2050 write_resource_flags);
2051 } else if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE) {
2052 DEBUG("Image %u was not modified; re-using existing "
2053 "metadata resource.", i);
2054 stream_set_out_reshdr_for_reuse(imd->metadata_lte);
2057 DEBUG("Image %u was not modified; copying existing "
2058 "metadata resource.", i);
2059 ret = write_wim_resource(imd->metadata_lte,
2061 wim->out_compression_type,
2062 wim->out_chunk_size,
2063 write_resource_flags);
2069 progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, NULL);
2074 open_wim_writable(WIMStruct *wim, const tchar *path, int open_flags)
2077 DEBUG("Opening \"%"TS"\" for writing.", path);
2079 raw_fd = topen(path, open_flags | O_BINARY, 0644);
2081 ERROR_WITH_ERRNO("Failed to open \"%"TS"\" for writing", path);
2082 return WIMLIB_ERR_OPEN;
2084 filedes_init(&wim->out_fd, raw_fd);
2089 close_wim_writable(WIMStruct *wim, int write_flags)
2093 if (!(write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)) {
2094 DEBUG("Closing WIM file.");
2095 if (filedes_valid(&wim->out_fd))
2096 if (filedes_close(&wim->out_fd))
2097 ret = WIMLIB_ERR_WRITE;
2099 filedes_invalidate(&wim->out_fd);
2104 cmp_streams_by_out_rspec(const void *p1, const void *p2)
2106 const struct wim_lookup_table_entry *lte1, *lte2;
2108 lte1 = *(const struct wim_lookup_table_entry**)p1;
2109 lte2 = *(const struct wim_lookup_table_entry**)p2;
2111 if (lte1->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
2112 if (lte2->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
2113 if (lte1->out_res_offset_in_wim != lte2->out_res_offset_in_wim)
2114 return cmp_u64(lte1->out_res_offset_in_wim,
2115 lte2->out_res_offset_in_wim);
2120 if (lte2->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS)
2123 return cmp_u64(lte1->out_reshdr.offset_in_wim,
2124 lte2->out_reshdr.offset_in_wim);
2128 write_wim_lookup_table(WIMStruct *wim, int image, int write_flags,
2129 struct wim_reshdr *out_reshdr,
2130 struct list_head *lookup_table_list)
2134 /* Set output resource metadata for streams already present in WIM. */
2135 if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE) {
2136 struct wim_lookup_table_entry *lte;
2137 list_for_each_entry(lte, lookup_table_list, lookup_table_list)
2139 if (lte->resource_location == RESOURCE_IN_WIM &&
2140 lte->rspec->wim == wim)
2142 stream_set_out_reshdr_for_reuse(lte);
2147 ret = sort_stream_list(lookup_table_list,
2148 offsetof(struct wim_lookup_table_entry, lookup_table_list),
2149 cmp_streams_by_out_rspec);
2153 /* Add entries for metadata resources. */
2154 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_METADATA)) {
2158 if (image == WIMLIB_ALL_IMAGES) {
2160 end_image = wim->hdr.image_count;
2162 start_image = image;
2166 /* Push metadata resource lookup table entries onto the front of
2167 * the list in reverse order, so that they're written in order.
2169 for (int i = end_image; i >= start_image; i--) {
2170 struct wim_lookup_table_entry *metadata_lte;
2172 metadata_lte = wim->image_metadata[i - 1]->metadata_lte;
2173 wimlib_assert(metadata_lte->out_reshdr.flags & WIM_RESHDR_FLAG_METADATA);
2174 metadata_lte->out_refcnt = 1;
2175 list_add(&metadata_lte->lookup_table_list, lookup_table_list);
2179 return write_wim_lookup_table_from_stream_list(lookup_table_list,
2181 wim->hdr.part_number,
2183 write_flags_to_resource_flags(write_flags));
2189 * Finish writing a WIM file: write the lookup table, xml data, and integrity
2190 * table, then overwrite the WIM header. By default, closes the WIM file
2191 * descriptor (@wim->out_fd) if successful.
2193 * write_flags is a bitwise OR of the following:
2195 * (public) WIMLIB_WRITE_FLAG_CHECK_INTEGRITY:
2196 * Include an integrity table.
2198 * (public) WIMLIB_WRITE_FLAG_FSYNC:
2199 * fsync() the output file before closing it.
2201 * (public) WIMLIB_WRITE_FLAG_PIPABLE:
2202 * Writing a pipable WIM, possibly to a pipe; include pipable WIM
2203 * stream headers before the lookup table and XML data, and also
2204 * write the WIM header at the end instead of seeking to the
2205 * beginning. Can't be combined with
2206 * WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.
2208 * (private) WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE:
2209 * Don't write the lookup table.
2211 * (private) WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE:
2212 * When (if) writing the integrity table, re-use entries from the
2213 * existing integrity table, if possible.
2215 * (private) WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML:
2216 * After writing the XML data but before writing the integrity
2217 * table, write a temporary WIM header and flush the stream so that
2218 * the WIM is less likely to become corrupted upon abrupt program
2220 * (private) WIMLIB_WRITE_FLAG_HEADER_AT_END:
2221 * Instead of overwriting the WIM header at the beginning of the
2222 * file, simply append it to the end of the file. (Used when
2224 * (private) WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR:
2225 * Do not close the file descriptor @wim->out_fd on either success
2227 * (private) WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES:
2228 * Use the existing <TOTALBYTES> stored in the in-memory XML
2229 * information, rather than setting it to the offset of the XML
2230 * data being written.
2233 finish_write(WIMStruct *wim, int image, int write_flags,
2234 wimlib_progress_func_t progress_func,
2235 struct list_head *lookup_table_list)
2239 int write_resource_flags;
2240 off_t old_lookup_table_end;
2241 off_t new_lookup_table_end;
2244 DEBUG("image=%d, write_flags=%08x", image, write_flags);
2246 write_resource_flags = write_flags_to_resource_flags(write_flags);
2248 /* In the WIM header, there is room for the resource entry for a
2249 * metadata resource labeled as the "boot metadata". This entry should
2250 * be zeroed out if there is no bootable image (boot_idx 0). Otherwise,
2251 * it should be a copy of the resource entry for the image that is
2252 * marked as bootable. This is not well documented... */
2253 if (wim->hdr.boot_idx == 0) {
2254 zero_reshdr(&wim->hdr.boot_metadata_reshdr);
2256 copy_reshdr(&wim->hdr.boot_metadata_reshdr,
2257 &wim->image_metadata[
2258 wim->hdr.boot_idx - 1]->metadata_lte->out_reshdr);
2261 /* Write lookup table. (Save old position first.) */
2262 old_lookup_table_end = wim->hdr.lookup_table_reshdr.offset_in_wim +
2263 wim->hdr.lookup_table_reshdr.size_in_wim;
2264 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
2265 ret = write_wim_lookup_table(wim, image, write_flags,
2266 &wim->hdr.lookup_table_reshdr,
2272 /* Write XML data. */
2273 xml_totalbytes = wim->out_fd.offset;
2274 if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
2275 xml_totalbytes = WIM_TOTALBYTES_USE_EXISTING;
2276 ret = write_wim_xml_data(wim, image, xml_totalbytes,
2277 &wim->hdr.xml_data_reshdr,
2278 write_resource_flags);
2282 /* Write integrity table (optional). */
2283 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
2284 if (write_flags & WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) {
2285 struct wim_header checkpoint_hdr;
2286 memcpy(&checkpoint_hdr, &wim->hdr, sizeof(struct wim_header));
2287 zero_reshdr(&checkpoint_hdr.integrity_table_reshdr);
2288 checkpoint_hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2289 ret = write_wim_header_at_offset(&checkpoint_hdr,
2295 if (!(write_flags & WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE))
2296 old_lookup_table_end = 0;
2298 new_lookup_table_end = wim->hdr.lookup_table_reshdr.offset_in_wim +
2299 wim->hdr.lookup_table_reshdr.size_in_wim;
2301 ret = write_integrity_table(wim,
2302 new_lookup_table_end,
2303 old_lookup_table_end,
2308 /* No integrity table. */
2309 zero_reshdr(&wim->hdr.integrity_table_reshdr);
2312 /* Now that all information in the WIM header has been determined, the
2313 * preliminary header written earlier can be overwritten, the header of
2314 * the existing WIM file can be overwritten, or the final header can be
2315 * written to the end of the pipable WIM. */
2316 wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2318 if (write_flags & WIMLIB_WRITE_FLAG_HEADER_AT_END)
2319 hdr_offset = wim->out_fd.offset;
2320 DEBUG("Writing new header @ %"PRIu64".", hdr_offset);
2321 ret = write_wim_header_at_offset(&wim->hdr, &wim->out_fd, hdr_offset);
2325 /* Possibly sync file data to disk before closing. On POSIX systems, it
2326 * is necessary to do this before using rename() to overwrite an
2327 * existing file with a new file. Otherwise, data loss would occur if
2328 * the system is abruptly terminated when the metadata for the rename
2329 * operation has been written to disk, but the new file data has not.
2331 if (write_flags & WIMLIB_WRITE_FLAG_FSYNC) {
2332 DEBUG("Syncing WIM file.");
2333 if (fsync(wim->out_fd.fd)) {
2334 ERROR_WITH_ERRNO("Error syncing data to WIM file");
2335 return WIMLIB_ERR_WRITE;
2339 if (close_wim_writable(wim, write_flags)) {
2340 ERROR_WITH_ERRNO("Failed to close the output WIM file");
2341 return WIMLIB_ERR_WRITE;
2347 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
2349 lock_wim(WIMStruct *wim, int fd)
2352 if (fd != -1 && !wim->wim_locked) {
2353 ret = flock(fd, LOCK_EX | LOCK_NB);
2355 if (errno == EWOULDBLOCK) {
2356 ERROR("`%"TS"' is already being modified or has been "
2357 "mounted read-write\n"
2358 " by another process!", wim->filename);
2359 ret = WIMLIB_ERR_ALREADY_LOCKED;
2361 WARNING_WITH_ERRNO("Failed to lock `%"TS"'",
2366 wim->wim_locked = 1;
2374 * write_pipable_wim():
2376 * Perform the intermediate stages of creating a "pipable" WIM (i.e. a WIM
2377 * capable of being applied from a pipe).
2379 * Pipable WIMs are a wimlib-specific modification of the WIM format such that
2380 * images can be applied from them sequentially when the file data is sent over
2381 * a pipe. In addition, a pipable WIM can be written sequentially to a pipe.
2382 * The modifications made to the WIM format for pipable WIMs are:
2384 * - Magic characters in header are "WLPWM\0\0\0" (wimlib pipable WIM) instead
2385 * of "MSWIM\0\0\0". This lets wimlib know that the WIM is pipable and also
2386 * stops other software from trying to read the file as a normal WIM.
2388 * - The header at the beginning of the file does not contain all the normal
2389 * information; in particular it will have all 0's for the lookup table and
2390 * XML data resource entries. This is because this information cannot be
2391 * determined until the lookup table and XML data have been written.
2392 * Consequently, wimlib will write the full header at the very end of the
2393 * file. The header at the end, however, is only used when reading the WIM
2394 * from a seekable file (not a pipe).
2396 * - An extra copy of the XML data is placed directly after the header. This
2397 * allows image names and sizes to be determined at an appropriate time when
2398 * reading the WIM from a pipe. This copy of the XML data is ignored if the
2399 * WIM is read from a seekable file (not a pipe).
2401 * - The format of resources, or streams, has been modified to allow them to be
2402 * used before the "lookup table" has been read. Each stream is prefixed with
2403 * a `struct pwm_stream_hdr' that is basically an abbreviated form of `struct
2404 * wim_lookup_table_entry_disk' that only contains the SHA1 message digest,
2405 * uncompressed stream size, and flags that indicate whether the stream is
2406 * compressed. The data of uncompressed streams then follows literally, while
2407 * the data of compressed streams follows in a modified format. Compressed
2408 * streams do not begin with a chunk table, since the chunk table cannot be
2409 * written until all chunks have been compressed. Instead, each compressed
2410 * chunk is prefixed by a `struct pwm_chunk_hdr' that gives its size.
2411 * Furthermore, the chunk table is written at the end of the resource instead
2412 * of the start. Note: chunk offsets are given in the chunk table as if the
2413 * `struct pwm_chunk_hdr's were not present; also, the chunk table is only
2414 * used if the WIM is being read from a seekable file (not a pipe).
2416 * - Metadata resources always come before other file resources (streams).
2417 * (This does not by itself constitute an incompatibility with normal WIMs,
2418 * since this is valid in normal WIMs.)
2420 * - At least up to the end of the file resources, all components must be packed
2421 * as tightly as possible; there cannot be any "holes" in the WIM. (This does
2422 * not by itself consititute an incompatibility with normal WIMs, since this
2423 * is valid in normal WIMs.)
2425 * Note: the lookup table, XML data, and header at the end are not used when
2426 * applying from a pipe. They exist to support functionality such as image
2427 * application and export when the WIM is *not* read from a pipe.
2429 * Layout of pipable WIM:
2431 * ---------+----------+--------------------+----------------+--------------+-----------+--------+
2432 * | Header | XML data | Metadata resources | File resources | Lookup table | XML data | Header |
2433 * ---------+----------+--------------------+----------------+--------------+-----------+--------+
2435 * Layout of normal WIM:
2437 * +--------+-----------------------------+-------------------------+
2438 * | Header | File and metadata resources | Lookup table | XML data |
2439 * +--------+-----------------------------+-------------------------+
2441 * An optional integrity table can follow the final XML data in both normal and
2442 * pipable WIMs. However, due to implementation details, wimlib currently can
2443 * only include an integrity table in a pipable WIM when writing it to a
2444 * seekable file (not a pipe).
2446 * Do note that since pipable WIMs are not supported by Microsoft's software,
2447 * wimlib does not create them unless explicitly requested (with
2448 * WIMLIB_WRITE_FLAG_PIPABLE) and as stated above they use different magic
2449 * characters to identify the file.
2452 write_pipable_wim(WIMStruct *wim, int image, int write_flags,
2453 unsigned num_threads, wimlib_progress_func_t progress_func,
2454 struct list_head *stream_list_override,
2455 struct list_head *lookup_table_list_ret)
2458 struct wim_reshdr xml_reshdr;
2460 WARNING("Creating a pipable WIM, which will "
2462 " with Microsoft's software (wimgapi/imagex/Dism).");
2464 /* At this point, the header at the beginning of the file has already
2467 /* For efficiency, when wimlib adds an image to the WIM with
2468 * wimlib_add_image(), the SHA1 message digests of files is not
2469 * calculated; instead, they are calculated while the files are being
2470 * written. However, this does not work when writing a pipable WIM,
2471 * since when writing a stream to a pipable WIM, its SHA1 message digest
2472 * needs to be known before the stream data is written. Therefore,
2473 * before getting much farther, we need to pre-calculate the SHA1
2474 * message digests of all streams that will be written. */
2475 ret = wim_checksum_unhashed_streams(wim);
2479 /* Write extra copy of the XML data. */
2480 ret = write_wim_xml_data(wim, image, WIM_TOTALBYTES_OMIT,
2482 WRITE_RESOURCE_FLAG_PIPABLE);
2486 /* Write metadata resources for the image(s) being included in the
2488 ret = write_wim_metadata_resources(wim, image, write_flags,
2493 /* Write streams needed for the image(s) being included in the output
2494 * WIM, or streams needed for the split WIM part. */
2495 return write_wim_streams(wim, image, write_flags, num_threads,
2496 progress_func, stream_list_override,
2497 lookup_table_list_ret);
2499 /* The lookup table, XML data, and header at end are handled by
2500 * finish_write(). */
2503 /* Write a standalone WIM or split WIM (SWM) part to a new file or to a file
2506 write_wim_part(WIMStruct *wim,
2507 const void *path_or_fd,
2510 unsigned num_threads,
2511 wimlib_progress_func_t progress_func,
2512 unsigned part_number,
2513 unsigned total_parts,
2514 struct list_head *stream_list_override,
2518 struct wim_header hdr_save;
2519 struct list_head lookup_table_list;
2521 if (total_parts == 1)
2522 DEBUG("Writing standalone WIM.");
2524 DEBUG("Writing split WIM part %u/%u", part_number, total_parts);
2525 if (image == WIMLIB_ALL_IMAGES)
2526 DEBUG("Including all images.");
2528 DEBUG("Including image %d only.", image);
2529 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2530 DEBUG("File descriptor: %d", *(const int*)path_or_fd);
2532 DEBUG("Path: \"%"TS"\"", (const tchar*)path_or_fd);
2533 DEBUG("Write flags: 0x%08x", write_flags);
2535 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY)
2536 DEBUG("\tCHECK_INTEGRITY");
2538 if (write_flags & WIMLIB_WRITE_FLAG_REBUILD)
2541 if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
2542 DEBUG("\tRECOMPRESS");
2544 if (write_flags & WIMLIB_WRITE_FLAG_FSYNC)
2547 if (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE)
2550 if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
2551 DEBUG("\tIGNORE_READONLY_FLAG");
2553 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
2556 if (write_flags & WIMLIB_WRITE_FLAG_NOT_PIPABLE)
2557 DEBUG("\tNOT_PIPABLE");
2559 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
2560 DEBUG("\tPACK_STREAMS");
2562 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2563 DEBUG("\tFILE_DESCRIPTOR");
2565 if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA)
2566 DEBUG("\tNO_METADATA");
2568 if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
2569 DEBUG("\tUSE_EXISTING_TOTALBYTES");
2571 if (num_threads == 0)
2572 DEBUG("Number of threads: autodetect");
2574 DEBUG("Number of threads: %u", num_threads);
2575 DEBUG("Progress function: %s", (progress_func ? "yes" : "no"));
2576 DEBUG("Stream list: %s", (stream_list_override ? "specified" : "autodetect"));
2577 DEBUG("GUID: %s", ((guid || wim->guid_set_explicitly) ?
2578 "specified" : "generate new"));
2580 /* Internally, this is always called with a valid part number and total
2582 wimlib_assert(total_parts >= 1);
2583 wimlib_assert(part_number >= 1 && part_number <= total_parts);
2585 /* A valid image (or all images) must be specified. */
2586 if (image != WIMLIB_ALL_IMAGES &&
2587 (image < 1 || image > wim->hdr.image_count))
2588 return WIMLIB_ERR_INVALID_IMAGE;
2590 /* If we need to write metadata resources, make sure the ::WIMStruct has
2591 * the needed information attached (e.g. is not a resource-only WIM,
2592 * such as a non-first part of a split WIM). */
2593 if (!wim_has_metadata(wim) &&
2594 !(write_flags & WIMLIB_WRITE_FLAG_NO_METADATA))
2595 return WIMLIB_ERR_METADATA_NOT_FOUND;
2597 /* Check for contradictory flags. */
2598 if ((write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2599 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
2600 == (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2601 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
2602 return WIMLIB_ERR_INVALID_PARAM;
2604 if ((write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2605 WIMLIB_WRITE_FLAG_NOT_PIPABLE))
2606 == (WIMLIB_WRITE_FLAG_PIPABLE |
2607 WIMLIB_WRITE_FLAG_NOT_PIPABLE))
2608 return WIMLIB_ERR_INVALID_PARAM;
2610 /* Save previous header, then start initializing the new one. */
2611 memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
2613 /* Set default integrity, pipable, and packed stream flags. */
2614 if (!(write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2615 WIMLIB_WRITE_FLAG_NOT_PIPABLE)))
2616 if (wim_is_pipable(wim)) {
2617 DEBUG("WIM is pipable; default to PIPABLE.");
2618 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2621 if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2622 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
2623 if (wim_has_integrity_table(wim)) {
2624 DEBUG("Integrity table present; default to CHECK_INTEGRITY.");
2625 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2628 if ((write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2629 WIMLIB_WRITE_FLAG_PACK_STREAMS))
2630 == (WIMLIB_WRITE_FLAG_PIPABLE |
2631 WIMLIB_WRITE_FLAG_PACK_STREAMS))
2633 ERROR("Cannot specify both PIPABLE and PACK_STREAMS!");
2634 return WIMLIB_ERR_INVALID_PARAM;
2637 /* Set appropriate magic number. */
2638 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
2639 wim->hdr.magic = PWM_MAGIC;
2641 wim->hdr.magic = WIM_MAGIC;
2643 /* Set appropriate version number. */
2644 if ((write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS) ||
2645 wim->out_compression_type == WIMLIB_COMPRESSION_TYPE_LZMS)
2646 wim->hdr.wim_version = WIM_VERSION_PACKED_STREAMS;
2648 wim->hdr.wim_version = WIM_VERSION_DEFAULT;
2650 /* Clear header flags that will be set automatically. */
2651 wim->hdr.flags &= ~(WIM_HDR_FLAG_METADATA_ONLY |
2652 WIM_HDR_FLAG_RESOURCE_ONLY |
2653 WIM_HDR_FLAG_SPANNED |
2654 WIM_HDR_FLAG_WRITE_IN_PROGRESS);
2656 /* Set SPANNED header flag if writing part of a split WIM. */
2657 if (total_parts != 1)
2658 wim->hdr.flags |= WIM_HDR_FLAG_SPANNED;
2660 /* Set part number and total parts of split WIM. This will be 1 and 1
2661 * if the WIM is standalone. */
2662 wim->hdr.part_number = part_number;
2663 wim->hdr.total_parts = total_parts;
2665 /* Set compression type if different. */
2666 if (wim->compression_type != wim->out_compression_type) {
2667 ret = set_wim_hdr_cflags(wim->out_compression_type, &wim->hdr);
2668 wimlib_assert(ret == 0);
2671 /* Set chunk size if different. */
2672 wim->hdr.chunk_size = wim->out_chunk_size;
2674 /* Use GUID if specified; otherwise generate a new one. */
2676 memcpy(wim->hdr.guid, guid, WIMLIB_GUID_LEN);
2677 else if (!wim->guid_set_explicitly)
2678 randomize_byte_array(wim->hdr.guid, WIMLIB_GUID_LEN);
2680 /* Clear references to resources that have not been written yet. */
2681 zero_reshdr(&wim->hdr.lookup_table_reshdr);
2682 zero_reshdr(&wim->hdr.xml_data_reshdr);
2683 zero_reshdr(&wim->hdr.boot_metadata_reshdr);
2684 zero_reshdr(&wim->hdr.integrity_table_reshdr);
2686 /* Set image count and boot index correctly for single image writes. */
2687 if (image != WIMLIB_ALL_IMAGES) {
2688 wim->hdr.image_count = 1;
2689 if (wim->hdr.boot_idx == image)
2690 wim->hdr.boot_idx = 1;
2692 wim->hdr.boot_idx = 0;
2695 /* Split WIMs can't be bootable. */
2696 if (total_parts != 1)
2697 wim->hdr.boot_idx = 0;
2699 /* Initialize output file descriptor. */
2700 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR) {
2701 /* File descriptor was explicitly provided. Return error if
2702 * file descriptor is not seekable, unless writing a pipable WIM
2704 wim->out_fd.fd = *(const int*)path_or_fd;
2705 wim->out_fd.offset = 0;
2706 if (!filedes_is_seekable(&wim->out_fd)) {
2707 ret = WIMLIB_ERR_INVALID_PARAM;
2708 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2709 goto out_restore_hdr;
2710 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
2711 ERROR("Can't include integrity check when "
2712 "writing pipable WIM to pipe!");
2713 goto out_restore_hdr;
2718 /* Filename of WIM to write was provided; open file descriptor
2720 ret = open_wim_writable(wim, (const tchar*)path_or_fd,
2721 O_TRUNC | O_CREAT | O_RDWR);
2723 goto out_restore_hdr;
2726 /* Write initial header. This is merely a "dummy" header since it
2727 * doesn't have all the information yet, so it will be overwritten later
2728 * (unless writing a pipable WIM). */
2729 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2730 wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2731 ret = write_wim_header(&wim->hdr, &wim->out_fd);
2732 wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2734 goto out_restore_hdr;
2736 /* Write metadata resources and streams. */
2737 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2738 /* Default case: create a normal (non-pipable) WIM. */
2739 ret = write_wim_streams(wim, image, write_flags, num_threads,
2740 progress_func, stream_list_override,
2741 &lookup_table_list);
2743 goto out_restore_hdr;
2745 ret = write_wim_metadata_resources(wim, image, write_flags,
2748 goto out_restore_hdr;
2750 /* Non-default case: create pipable WIM. */
2751 ret = write_pipable_wim(wim, image, write_flags, num_threads,
2752 progress_func, stream_list_override,
2753 &lookup_table_list);
2755 goto out_restore_hdr;
2756 write_flags |= WIMLIB_WRITE_FLAG_HEADER_AT_END;
2760 /* Write lookup table, XML data, and (optional) integrity table. */
2761 ret = finish_write(wim, image, write_flags, progress_func,
2762 &lookup_table_list);
2764 memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
2765 (void)close_wim_writable(wim, write_flags);
2766 DEBUG("ret=%d", ret);
2770 /* Write a standalone WIM to a file or file descriptor. */
2772 write_standalone_wim(WIMStruct *wim, const void *path_or_fd,
2773 int image, int write_flags, unsigned num_threads,
2774 wimlib_progress_func_t progress_func)
2776 return write_wim_part(wim, path_or_fd, image, write_flags,
2777 num_threads, progress_func, 1, 1, NULL, NULL);
2780 /* API function documented in wimlib.h */
2782 wimlib_write(WIMStruct *wim, const tchar *path,
2783 int image, int write_flags, unsigned num_threads,
2784 wimlib_progress_func_t progress_func)
2787 return WIMLIB_ERR_INVALID_PARAM;
2789 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2791 return write_standalone_wim(wim, path, image, write_flags,
2792 num_threads, progress_func);
2795 /* API function documented in wimlib.h */
2797 wimlib_write_to_fd(WIMStruct *wim, int fd,
2798 int image, int write_flags, unsigned num_threads,
2799 wimlib_progress_func_t progress_func)
2802 return WIMLIB_ERR_INVALID_PARAM;
2804 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2805 write_flags |= WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR;
2807 return write_standalone_wim(wim, &fd, image, write_flags,
2808 num_threads, progress_func);
2812 any_images_modified(WIMStruct *wim)
2814 for (int i = 0; i < wim->hdr.image_count; i++)
2815 if (wim->image_metadata[i]->modified)
2821 check_resource_offset(struct wim_lookup_table_entry *lte, void *_wim)
2823 const WIMStruct *wim = _wim;
2824 off_t end_offset = *(const off_t*)wim->private;
2826 if (lte->resource_location == RESOURCE_IN_WIM && lte->rspec->wim == wim &&
2827 lte->rspec->offset_in_wim + lte->rspec->size_in_wim > end_offset)
2828 return WIMLIB_ERR_RESOURCE_ORDER;
2832 /* Make sure no file or metadata resources are located after the XML data (or
2833 * integrity table if present)--- otherwise we can't safely overwrite the WIM in
2834 * place and we return WIMLIB_ERR_RESOURCE_ORDER. */
2836 check_resource_offsets(WIMStruct *wim, off_t end_offset)
2841 wim->private = &end_offset;
2842 ret = for_lookup_table_entry(wim->lookup_table, check_resource_offset, wim);
2846 for (i = 0; i < wim->hdr.image_count; i++) {
2847 ret = check_resource_offset(wim->image_metadata[i]->metadata_lte, wim);
2855 * Overwrite a WIM, possibly appending streams to it.
2857 * A WIM looks like (or is supposed to look like) the following:
2859 * Header (212 bytes)
2860 * Streams and metadata resources (variable size)
2861 * Lookup table (variable size)
2862 * XML data (variable size)
2863 * Integrity table (optional) (variable size)
2865 * If we are not adding any streams or metadata resources, the lookup table is
2866 * unchanged--- so we only need to overwrite the XML data, integrity table, and
2867 * header. This operation is potentially unsafe if the program is abruptly
2868 * terminated while the XML data or integrity table are being overwritten, but
2869 * before the new header has been written. To partially alleviate this problem,
2870 * a special flag (WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) is passed to
2871 * finish_write() to cause a temporary WIM header to be written after the XML
2872 * data has been written. This may prevent the WIM from becoming corrupted if
2873 * the program is terminated while the integrity table is being calculated (but
2874 * no guarantees, due to write re-ordering...).
2876 * If we are adding new streams or images (metadata resources), the lookup table
2877 * needs to be changed, and those streams need to be written. In this case, we
2878 * try to perform a safe update of the WIM file by writing the streams *after*
2879 * the end of the previous WIM, then writing the new lookup table, XML data, and
2880 * (optionally) integrity table following the new streams. This will produce a
2881 * layout like the following:
2883 * Header (212 bytes)
2884 * (OLD) Streams and metadata resources (variable size)
2885 * (OLD) Lookup table (variable size)
2886 * (OLD) XML data (variable size)
2887 * (OLD) Integrity table (optional) (variable size)
2888 * (NEW) Streams and metadata resources (variable size)
2889 * (NEW) Lookup table (variable size)
2890 * (NEW) XML data (variable size)
2891 * (NEW) Integrity table (optional) (variable size)
2893 * At all points, the WIM is valid as nothing points to the new data yet. Then,
2894 * the header is overwritten to point to the new lookup table, XML data, and
2895 * integrity table, to produce the following layout:
2897 * Header (212 bytes)
2898 * Streams and metadata resources (variable size)
2899 * Nothing (variable size)
2900 * More Streams and metadata resources (variable size)
2901 * Lookup table (variable size)
2902 * XML data (variable size)
2903 * Integrity table (optional) (variable size)
2905 * This method allows an image to be appended to a large WIM very quickly, and
2906 * is is crash-safe except in the case of write re-ordering, but the
2907 * disadvantage is that a small hole is left in the WIM where the old lookup
2908 * table, xml data, and integrity table were. (These usually only take up a
2909 * small amount of space compared to the streams, however.)
2912 overwrite_wim_inplace(WIMStruct *wim, int write_flags,
2913 unsigned num_threads,
2914 wimlib_progress_func_t progress_func)
2918 u64 old_lookup_table_end, old_xml_begin, old_xml_end;
2919 struct wim_header hdr_save;
2920 struct list_head stream_list;
2921 struct list_head lookup_table_list;
2922 struct filter_context filter_ctx;
2924 DEBUG("Overwriting `%"TS"' in-place", wim->filename);
2926 /* Save original header so it can be restored in case of error */
2927 memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
2929 /* Set default integrity flag. */
2930 if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2931 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
2932 if (wim_has_integrity_table(wim))
2933 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2935 /* Set WIM version if adding packed streams. */
2936 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
2937 wim->hdr.wim_version = WIM_VERSION_PACKED_STREAMS;
2939 /* Set additional flags for overwrite. */
2940 write_flags |= WIMLIB_WRITE_FLAG_OVERWRITE |
2941 WIMLIB_WRITE_FLAG_STREAMS_OK;
2943 /* Make sure that the integrity table (if present) is after the XML
2944 * data, and that there are no stream resources, metadata resources, or
2945 * lookup tables after the XML data. Otherwise, these data would be
2947 old_xml_begin = wim->hdr.xml_data_reshdr.offset_in_wim;
2948 old_xml_end = old_xml_begin + wim->hdr.xml_data_reshdr.size_in_wim;
2949 old_lookup_table_end = wim->hdr.lookup_table_reshdr.offset_in_wim +
2950 wim->hdr.lookup_table_reshdr.size_in_wim;
2951 if (wim->hdr.integrity_table_reshdr.offset_in_wim != 0 &&
2952 wim->hdr.integrity_table_reshdr.offset_in_wim < old_xml_end) {
2953 WARNING("Didn't expect the integrity table to be before the XML data");
2954 ret = WIMLIB_ERR_RESOURCE_ORDER;
2955 goto out_restore_memory_hdr;
2958 if (old_lookup_table_end > old_xml_begin) {
2959 WARNING("Didn't expect the lookup table to be after the XML data");
2960 ret = WIMLIB_ERR_RESOURCE_ORDER;
2961 goto out_restore_memory_hdr;
2964 /* Set @old_wim_end, which indicates the point beyond which we don't
2965 * allow any file and metadata resources to appear without returning
2966 * WIMLIB_ERR_RESOURCE_ORDER (due to the fact that we would otherwise
2967 * overwrite these resources). */
2968 if (!wim->deletion_occurred && !any_images_modified(wim)) {
2969 /* If no images have been modified and no images have been
2970 * deleted, a new lookup table does not need to be written. We
2971 * shall write the new XML data and optional integrity table
2972 * immediately after the lookup table. Note that this may
2973 * overwrite an existing integrity table. */
2974 DEBUG("Skipping writing lookup table "
2975 "(no images modified or deleted)");
2976 old_wim_end = old_lookup_table_end;
2977 write_flags |= WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE |
2978 WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML;
2979 } else if (wim->hdr.integrity_table_reshdr.offset_in_wim != 0) {
2980 /* Old WIM has an integrity table; begin writing new streams
2982 old_wim_end = wim->hdr.integrity_table_reshdr.offset_in_wim +
2983 wim->hdr.integrity_table_reshdr.size_in_wim;
2985 /* No existing integrity table; begin writing new streams after
2986 * the old XML data. */
2987 old_wim_end = old_xml_end;
2990 ret = check_resource_offsets(wim, old_wim_end);
2992 goto out_restore_memory_hdr;
2994 ret = prepare_stream_list_for_write(wim, WIMLIB_ALL_IMAGES, write_flags,
2995 &stream_list, &lookup_table_list,
2998 goto out_restore_memory_hdr;
3000 ret = open_wim_writable(wim, wim->filename, O_RDWR);
3002 goto out_restore_memory_hdr;
3004 ret = lock_wim(wim, wim->out_fd.fd);
3008 /* Set WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in header. */
3009 wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
3010 ret = write_wim_header_flags(wim->hdr.flags, &wim->out_fd);
3012 ERROR_WITH_ERRNO("Error updating WIM header flags");
3013 goto out_unlock_wim;
3016 if (filedes_seek(&wim->out_fd, old_wim_end) == -1) {
3017 ERROR_WITH_ERRNO("Can't seek to end of WIM");
3018 ret = WIMLIB_ERR_WRITE;
3019 goto out_restore_physical_hdr;
3022 ret = wim_write_stream_list(wim,
3031 ret = write_wim_metadata_resources(wim, WIMLIB_ALL_IMAGES,
3032 write_flags, progress_func);
3036 write_flags |= WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE;
3037 ret = finish_write(wim, WIMLIB_ALL_IMAGES, write_flags,
3038 progress_func, &lookup_table_list);
3042 wim->wim_locked = 0;
3046 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
3047 WARNING("Truncating `%"TS"' to its original size (%"PRIu64" bytes)",
3048 wim->filename, old_wim_end);
3049 /* Return value of ftruncate() is ignored because this is
3050 * already an error path. */
3051 (void)ftruncate(wim->out_fd.fd, old_wim_end);
3053 out_restore_physical_hdr:
3054 (void)write_wim_header_flags(hdr_save.flags, &wim->out_fd);
3056 wim->wim_locked = 0;
3058 (void)close_wim_writable(wim, write_flags);
3059 out_restore_memory_hdr:
3060 memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
3065 overwrite_wim_via_tmpfile(WIMStruct *wim, int write_flags,
3066 unsigned num_threads,
3067 wimlib_progress_func_t progress_func)
3069 size_t wim_name_len;
3072 DEBUG("Overwriting `%"TS"' via a temporary file", wim->filename);
3074 /* Write the WIM to a temporary file in the same directory as the
3076 wim_name_len = tstrlen(wim->filename);
3077 tchar tmpfile[wim_name_len + 10];
3078 tmemcpy(tmpfile, wim->filename, wim_name_len);
3079 randomize_char_array_with_alnum(tmpfile + wim_name_len, 9);
3080 tmpfile[wim_name_len + 9] = T('\0');
3082 ret = wimlib_write(wim, tmpfile, WIMLIB_ALL_IMAGES,
3083 write_flags | WIMLIB_WRITE_FLAG_FSYNC,
3084 num_threads, progress_func);
3092 /* Rename the new WIM file to the original WIM file. Note: on Windows
3093 * this actually calls win32_rename_replacement(), not _wrename(), so
3094 * that removing the existing destination file can be handled. */
3095 DEBUG("Renaming `%"TS"' to `%"TS"'", tmpfile, wim->filename);
3096 ret = trename(tmpfile, wim->filename);
3098 ERROR_WITH_ERRNO("Failed to rename `%"TS"' to `%"TS"'",
3099 tmpfile, wim->filename);
3106 return WIMLIB_ERR_RENAME;
3109 if (progress_func) {
3110 union wimlib_progress_info progress;
3111 progress.rename.from = tmpfile;
3112 progress.rename.to = wim->filename;
3113 progress_func(WIMLIB_PROGRESS_MSG_RENAME, &progress);
3118 /* Determine if the specified WIM file may be updated by appending in-place
3119 * rather than writing and replacing it with an entirely new file. */
3121 can_overwrite_wim_inplace(const WIMStruct *wim, int write_flags)
3123 /* REBUILD flag forces full rebuild. */
3124 if (write_flags & WIMLIB_WRITE_FLAG_REBUILD)
3127 /* Deletions cause full rebuild by default. */
3128 if (wim->deletion_occurred && !(write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE))
3131 /* Pipable WIMs cannot be updated in place, nor can a non-pipable WIM be
3132 * turned into a pipable WIM in-place. */
3133 if (wim_is_pipable(wim) || (write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
3136 /* wimlib allows multiple packs in a single WIM, but they don't seem to
3137 * be compatible with WIMGAPI, so force all streams to be repacked if
3138 * the WIM already may have contained a pack and PACK_STREAMS was
3140 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS &&
3141 wim->hdr.wim_version == WIM_VERSION_PACKED_STREAMS)
3144 /* The default compression type and compression chunk size selected for
3145 * the output WIM must be the same as those currently used for the WIM.
3147 if (wim->compression_type != wim->out_compression_type)
3149 if (wim->chunk_size != wim->out_chunk_size)
3155 /* API function documented in wimlib.h */
3157 wimlib_overwrite(WIMStruct *wim, int write_flags,
3158 unsigned num_threads,
3159 wimlib_progress_func_t progress_func)
3164 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
3166 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
3167 return WIMLIB_ERR_INVALID_PARAM;
3170 return WIMLIB_ERR_NO_FILENAME;
3172 orig_hdr_flags = wim->hdr.flags;
3173 if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
3174 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
3175 ret = can_modify_wim(wim);
3176 wim->hdr.flags = orig_hdr_flags;
3180 if (can_overwrite_wim_inplace(wim, write_flags)) {
3181 ret = overwrite_wim_inplace(wim, write_flags, num_threads,
3183 if (ret != WIMLIB_ERR_RESOURCE_ORDER)
3185 WARNING("Falling back to re-building entire WIM");
3187 return overwrite_wim_via_tmpfile(wim, write_flags, num_threads,