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/compress_chunks.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"
62 write_flags_to_resource_flags(int write_flags)
64 int write_resource_flags = 0;
66 if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
67 write_resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS;
68 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
69 write_resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE;
70 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
71 write_resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS;
72 return write_resource_flags;
75 struct filter_context {
80 /* Determine specified stream should be filtered out from the write.
84 * < 0 : The stream should be hard-filtered; that is, not included in the
86 * 0 : The stream should not be filtered out.
87 * > 0 : The stream should be soft-filtered; that is, it already exists in the
88 * WIM file and may not need to be written again.
91 stream_filtered(const struct wim_lookup_table_entry *lte,
92 const struct filter_context *ctx)
94 int write_flags = ctx->write_flags;
95 WIMStruct *wim = ctx->wim;
100 if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE &&
101 lte->resource_location == RESOURCE_IN_WIM &&
102 lte->rspec->wim == wim)
105 if (write_flags & WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS &&
106 lte->resource_location == RESOURCE_IN_WIM &&
107 lte->rspec->wim != wim)
114 stream_hard_filtered(const struct wim_lookup_table_entry *lte,
115 struct filter_context *ctx)
117 return stream_filtered(lte, ctx) < 0;
121 may_soft_filter_streams(const struct filter_context *ctx)
125 return ctx->write_flags & WIMLIB_WRITE_FLAG_OVERWRITE;
129 may_hard_filter_streams(const struct filter_context *ctx)
133 return ctx->write_flags & WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
137 may_filter_streams(const struct filter_context *ctx)
139 return (may_soft_filter_streams(ctx) ||
140 may_hard_filter_streams(ctx));
144 /* Return true if the specified resource is compressed and the compressed data
145 * can be reused with the specified output parameters. */
147 can_raw_copy(const struct wim_lookup_table_entry *lte,
148 int write_resource_flags, int out_ctype, u32 out_chunk_size)
150 const struct wim_resource_spec *rspec;
152 if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS)
155 if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE)
158 if (lte->resource_location != RESOURCE_IN_WIM)
163 if (rspec->is_pipable != !!(write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE))
167 if (rspec->flags & WIM_RESHDR_FLAG_COMPRESSED) {
168 /* Normal compressed resource: Must use same compression type
170 return (rspec->wim->compression_type == out_ctype &&
171 rspec->wim->chunk_size == out_chunk_size);
174 if ((rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS) &&
175 (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS))
177 /* Packed resource: Such resources may contain multiple streams,
178 * and in general only a subset of them need to be written. As
179 * a heuristic, re-use the raw data if at least half the
180 * uncompressed size is being written. */
182 /* Note: packed resources contain a header that specifies the
183 * compression type and chunk size; therefore we don't need to
184 * check if they are compatible with @out_ctype and
185 * @out_chunk_size. */
187 struct wim_lookup_table_entry *res_stream;
190 list_for_each_entry(res_stream, &rspec->stream_list, rspec_node)
191 if (res_stream->will_be_in_output_wim)
192 write_size += res_stream->size;
194 return (write_size > rspec->uncompressed_size / 2);
200 filter_resource_flags(u8 flags)
202 return (flags & ~(WIM_RESHDR_FLAG_PACKED_STREAMS |
203 WIM_RESHDR_FLAG_COMPRESSED |
204 WIM_RESHDR_FLAG_SPANNED |
205 WIM_RESHDR_FLAG_FREE));
209 stream_set_out_reshdr_for_reuse(struct wim_lookup_table_entry *lte)
211 const struct wim_resource_spec *rspec;
213 wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
216 if (rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
218 wimlib_assert(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS);
220 lte->out_reshdr.offset_in_wim = lte->offset_in_res;
221 lte->out_reshdr.uncompressed_size = 0;
222 lte->out_reshdr.size_in_wim = lte->size;
224 lte->out_res_offset_in_wim = rspec->offset_in_wim;
225 lte->out_res_size_in_wim = rspec->size_in_wim;
226 /*lte->out_res_uncompressed_size = rspec->uncompressed_size;*/
228 wimlib_assert(!(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS));
230 lte->out_reshdr.offset_in_wim = rspec->offset_in_wim;
231 lte->out_reshdr.uncompressed_size = rspec->uncompressed_size;
232 lte->out_reshdr.size_in_wim = rspec->size_in_wim;
234 lte->out_reshdr.flags = lte->flags;
238 /* Write the header for a stream in a pipable WIM. */
240 write_pwm_stream_header(const struct wim_lookup_table_entry *lte,
241 struct filedes *out_fd,
242 int additional_reshdr_flags)
244 struct pwm_stream_hdr stream_hdr;
248 stream_hdr.magic = cpu_to_le64(PWM_STREAM_MAGIC);
249 stream_hdr.uncompressed_size = cpu_to_le64(lte->size);
250 if (additional_reshdr_flags & PWM_RESHDR_FLAG_UNHASHED) {
251 zero_out_hash(stream_hdr.hash);
253 wimlib_assert(!lte->unhashed);
254 copy_hash(stream_hdr.hash, lte->hash);
257 reshdr_flags = filter_resource_flags(lte->flags);
258 reshdr_flags |= additional_reshdr_flags;
259 stream_hdr.flags = cpu_to_le32(reshdr_flags);
260 ret = full_write(out_fd, &stream_hdr, sizeof(stream_hdr));
262 ERROR_WITH_ERRNO("Write error");
268 seek_and_truncate(struct filedes *out_fd, off_t offset)
270 if (filedes_seek(out_fd, offset) == -1 ||
271 ftruncate(out_fd->fd, offset))
273 ERROR_WITH_ERRNO("Failed to truncate output WIM file");
274 return WIMLIB_ERR_WRITE;
280 struct write_streams_progress_data {
281 wimlib_progress_func_t progress_func;
282 union wimlib_progress_info progress;
283 uint64_t next_progress;
284 WIMStruct *prev_wim_part;
288 do_write_streams_progress(struct write_streams_progress_data *progress_data,
289 struct wim_lookup_table_entry *lte,
290 bool stream_discarded)
292 union wimlib_progress_info *progress = &progress_data->progress;
295 if (stream_discarded) {
296 progress->write_streams.total_bytes -= lte->size;
297 if (progress_data->next_progress != ~(uint64_t)0 &&
298 progress_data->next_progress > progress->write_streams.total_bytes)
300 progress_data->next_progress = progress->write_streams.total_bytes;
303 progress->write_streams.completed_bytes += lte->size;
305 new_wim_part = false;
306 if (lte->resource_location == RESOURCE_IN_WIM &&
307 lte->rspec->wim != progress_data->prev_wim_part)
309 if (progress_data->prev_wim_part) {
311 progress->write_streams.completed_parts++;
313 progress_data->prev_wim_part = lte->rspec->wim;
315 progress->write_streams.completed_streams++;
316 if (progress_data->progress_func
317 && (progress->write_streams.completed_bytes >= progress_data->next_progress
320 progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
322 if (progress_data->next_progress == progress->write_streams.total_bytes) {
323 progress_data->next_progress = ~(uint64_t)0;
325 progress_data->next_progress =
326 min(progress->write_streams.total_bytes,
327 progress->write_streams.completed_bytes +
328 progress->write_streams.total_bytes / 100);
333 struct write_streams_ctx {
334 /* File descriptor the streams are being written to. */
335 struct filedes *out_fd;
337 /* Lookup table for the WIMStruct on whose behalf the streams are being
339 struct wim_lookup_table *lookup_table;
341 /* Compression format to use. */
344 /* Maximum uncompressed chunk size in compressed resources to use. */
347 /* Flags that affect how the streams will be written. */
348 int write_resource_flags;
350 /* Data used for issuing WRITE_STREAMS progress. */
351 struct write_streams_progress_data progress_data;
353 struct filter_context *filter_ctx;
355 /* Upper bound on the total number of bytes that need to be compressed.
357 u64 num_bytes_to_compress;
359 /* Pointer to the chunk_compressor implementation being used for
360 * compressing chunks of data, or NULL if chunks are being written
362 struct chunk_compressor *compressor;
364 /* Buffer for dividing the read data into chunks of size
365 * @out_chunk_size. */
368 /* Number of bytes in @chunk_buf that are currently filled. */
369 size_t chunk_buf_filled;
371 /* List of streams that currently have chunks being compressed. */
372 struct list_head pending_streams;
374 /* Set to true if the stream currently being read was a duplicate, and
375 * therefore the corresponding stream entry needs to be freed once the
376 * read finishes. (In this case we add the duplicate entry to
377 * pending_streams rather than the entry being read.) */
378 bool stream_was_duplicate;
380 /* Current uncompressed offset in the resource being read. */
381 u64 cur_read_res_offset;
383 /* Uncompressed size of the resource currently being read. */
384 u64 cur_read_res_size;
386 /* Current uncompressed offset in the resource being written. */
387 u64 cur_write_res_offset;
389 /* Uncompressed size of resource currently being written. */
390 u64 cur_write_res_size;
392 /* Array that is filled in with compressed chunk sizes as a resource is
396 /* Index of next entry in @chunk_csizes to fill in. */
399 /* Number of entries in @chunk_csizes currently allocated. */
400 size_t num_alloc_chunks;
402 /* Offset in the output file of the start of the chunks of the resource
403 * currently being written. */
404 u64 chunks_start_offset;
408 get_chunk_entry_size(u64 res_size, int write_resource_flags)
410 if (res_size <= UINT32_MAX ||
411 (write_resource_flags & WIM_RESHDR_FLAG_PACKED_STREAMS))
417 /* Reserve space for the chunk table and prepare to accumulate the chunk table
420 begin_chunk_table(struct write_streams_ctx *ctx, u64 res_expected_size)
422 u64 expected_num_chunks;
423 u64 expected_num_chunk_entries;
427 /* Calculate the number of chunks and chunk entries that should be
428 * needed for the resource. These normally will be the final values,
429 * but in PACKED_STREAMS mode some of the streams we're planning to
430 * write into the resource may be duplicates, and therefore discarded,
431 * potentially decreasing the number of chunk entries needed. */
432 expected_num_chunks = DIV_ROUND_UP(res_expected_size, ctx->out_chunk_size);
433 expected_num_chunk_entries = expected_num_chunks;
434 if (!(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS))
435 expected_num_chunk_entries--;
437 /* Make sure the chunk_csizes array is long enough to store the
438 * compressed size of each chunk. */
439 if (expected_num_chunks > ctx->num_alloc_chunks) {
440 u64 new_length = expected_num_chunks + 50;
442 if ((size_t)new_length != new_length) {
443 ERROR("Resource size too large (%"PRIu64" bytes!",
445 return WIMLIB_ERR_NOMEM;
448 FREE(ctx->chunk_csizes);
449 ctx->chunk_csizes = MALLOC(new_length * sizeof(ctx->chunk_csizes[0]));
450 if (ctx->chunk_csizes == NULL) {
451 ctx->num_alloc_chunks = 0;
452 return WIMLIB_ERR_NOMEM;
454 ctx->num_alloc_chunks = new_length;
457 ctx->chunk_index = 0;
459 if (!(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)) {
460 /* Reserve space for the chunk table in the output file. In the
461 * case of packed resources this reserves the upper bound for
462 * the needed space, not necessarily the exact space which will
463 * prove to be needed. At this point, we just use @chunk_csizes
464 * for a buffer of 0's because the actual compressed chunk sizes
466 reserve_size = expected_num_chunk_entries *
467 get_chunk_entry_size(res_expected_size,
468 ctx->write_resource_flags);
469 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS)
470 reserve_size += sizeof(struct alt_chunk_table_header_disk);
471 memset(ctx->chunk_csizes, 0, reserve_size);
472 ret = full_write(ctx->out_fd, ctx->chunk_csizes, reserve_size);
480 begin_write_resource(struct write_streams_ctx *ctx, u64 res_expected_size)
484 wimlib_assert(res_expected_size != 0);
486 if (ctx->compressor != NULL) {
487 ret = begin_chunk_table(ctx, res_expected_size);
492 /* Output file descriptor is now positioned at the offset at which to
493 * write the first chunk of the resource. */
494 ctx->chunks_start_offset = ctx->out_fd->offset;
495 ctx->cur_write_res_offset = 0;
496 ctx->cur_write_res_size = res_expected_size;
501 end_chunk_table(struct write_streams_ctx *ctx, u64 res_actual_size,
502 u64 *res_start_offset_ret, u64 *res_store_size_ret)
504 size_t actual_num_chunks;
505 size_t actual_num_chunk_entries;
506 size_t chunk_entry_size;
509 actual_num_chunks = ctx->chunk_index;
510 actual_num_chunk_entries = actual_num_chunks;
511 if (!(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS))
512 actual_num_chunk_entries--;
514 chunk_entry_size = get_chunk_entry_size(res_actual_size,
515 ctx->write_resource_flags);
517 typedef le64 __attribute__((may_alias)) aliased_le64_t;
518 typedef le32 __attribute__((may_alias)) aliased_le32_t;
520 if (chunk_entry_size == 4) {
521 aliased_le32_t *entries = (aliased_le32_t*)ctx->chunk_csizes;
523 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS) {
524 for (size_t i = 0; i < actual_num_chunk_entries; i++)
525 entries[i] = cpu_to_le32(ctx->chunk_csizes[i]);
527 u32 offset = ctx->chunk_csizes[0];
528 for (size_t i = 0; i < actual_num_chunk_entries; i++) {
529 u32 next_size = ctx->chunk_csizes[i + 1];
530 entries[i] = cpu_to_le32(offset);
535 aliased_le64_t *entries = (aliased_le64_t*)ctx->chunk_csizes;
537 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS) {
538 for (size_t i = 0; i < actual_num_chunk_entries; i++)
539 entries[i] = cpu_to_le64(ctx->chunk_csizes[i]);
541 u64 offset = ctx->chunk_csizes[0];
542 for (size_t i = 0; i < actual_num_chunk_entries; i++) {
543 u64 next_size = ctx->chunk_csizes[i + 1];
544 entries[i] = cpu_to_le64(offset);
550 size_t chunk_table_size = actual_num_chunk_entries * chunk_entry_size;
551 u64 res_start_offset;
552 u64 res_end_offset = ctx->out_fd->offset;
554 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
555 ret = full_write(ctx->out_fd, ctx->chunk_csizes, chunk_table_size);
558 res_end_offset = ctx->out_fd->offset;
559 res_start_offset = ctx->chunks_start_offset;
561 res_end_offset = ctx->out_fd->offset;
563 u64 chunk_table_offset;
565 chunk_table_offset = ctx->chunks_start_offset - chunk_table_size;
567 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS) {
568 struct alt_chunk_table_header_disk hdr;
570 hdr.res_usize = cpu_to_le64(res_actual_size);
571 hdr.chunk_size = cpu_to_le32(ctx->out_chunk_size);
572 hdr.compression_format = cpu_to_le32(ctx->out_ctype);
574 BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_LZX != 1);
575 BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_XPRESS != 2);
576 BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_LZMS != 3);
578 ret = full_pwrite(ctx->out_fd, &hdr, sizeof(hdr),
579 chunk_table_offset - sizeof(hdr));
582 res_start_offset = chunk_table_offset - sizeof(hdr);
584 res_start_offset = chunk_table_offset;
587 ret = full_pwrite(ctx->out_fd, ctx->chunk_csizes,
588 chunk_table_size, chunk_table_offset);
593 *res_start_offset_ret = res_start_offset;
594 *res_store_size_ret = res_end_offset - res_start_offset;
599 ERROR_WITH_ERRNO("Write error");
603 /* Finish writing a WIM resource by writing or updating the chunk table (if not
604 * writing the data uncompressed) and loading its metadata into @out_reshdr. */
606 end_write_resource(struct write_streams_ctx *ctx, struct wim_reshdr *out_reshdr)
610 u64 res_uncompressed_size;
611 u64 res_offset_in_wim;
613 wimlib_assert(ctx->cur_write_res_size == ctx->cur_write_res_offset);
614 res_uncompressed_size = ctx->cur_write_res_size;
616 if (ctx->compressor) {
617 ret = end_chunk_table(ctx, res_uncompressed_size,
618 &res_offset_in_wim, &res_size_in_wim);
622 res_offset_in_wim = ctx->chunks_start_offset;
623 res_size_in_wim = ctx->out_fd->offset - res_offset_in_wim;
625 out_reshdr->uncompressed_size = res_uncompressed_size;
626 out_reshdr->size_in_wim = res_size_in_wim;
627 out_reshdr->offset_in_wim = res_offset_in_wim;
628 DEBUG("Finished writing resource: %"PRIu64" => %"PRIu64" @ %"PRIu64"",
629 res_uncompressed_size, res_size_in_wim, res_offset_in_wim);
633 /* Begin processing a stream for writing. */
635 write_stream_begin_read(struct wim_lookup_table_entry *lte,
636 bool is_partial_res, void *_ctx)
638 struct write_streams_ctx *ctx = _ctx;
641 wimlib_assert(lte->size > 0);
643 ctx->cur_read_res_offset = 0;
644 ctx->cur_read_res_size = lte->size;
646 /* As an optimization, we allow some streams to be "unhashed", meaning
647 * their SHA1 message digests are unknown. This is the case with
648 * streams that are added by scanning a directry tree with
649 * wimlib_add_image(), for example. Since WIM uses single-instance
650 * streams, we don't know whether such each such stream really need to
651 * written until it is actually checksummed, unless it has a unique
652 * size. In such cases we read and checksum the stream in this
653 * function, thereby advancing ahead of read_stream_list(), which will
654 * still provide the data again to write_stream_process_chunk(). This
655 * is okay because an unhashed stream cannot be in a WIM resource, which
656 * might be costly to decompress. */
657 ctx->stream_was_duplicate = false;
658 if (ctx->lookup_table != NULL && lte->unhashed && !lte->unique_size) {
660 wimlib_assert(!is_partial_res);
661 wimlib_assert(ctx->lookup_table != NULL);
663 struct wim_lookup_table_entry *lte_new;
665 ret = hash_unhashed_stream(lte, ctx->lookup_table, <e_new);
668 if (lte_new != lte) {
669 /* Duplicate stream detected. */
671 if (lte_new->will_be_in_output_wim ||
672 stream_filtered(lte_new, ctx->filter_ctx))
674 /* The duplicate stream is already being
675 * included in the output WIM, or it would be
676 * filtered out if it had been. Skip writing
677 * this stream (and reading it again) entirely,
678 * passing its output reference count to the
679 * duplicate stream in the former case. */
680 DEBUG("Discarding duplicate stream of "
681 "length %"PRIu64, lte->size);
682 do_write_streams_progress(&ctx->progress_data,
684 list_del(<e->write_streams_list);
685 list_del(<e->lookup_table_list);
686 if (lte_new->will_be_in_output_wim)
687 lte_new->out_refcnt += lte->out_refcnt;
688 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS)
689 ctx->cur_write_res_size -= lte->size;
690 free_lookup_table_entry(lte);
691 return BEGIN_STREAM_STATUS_SKIP_STREAM;
693 /* The duplicate stream can validly be written,
694 * but was not marked as such. Discard the
695 * current stream entry and use the duplicate,
696 * but actually freeing the current entry must
697 * wait until read_stream_list() has finished
698 * reading its data. */
699 DEBUG("Stream duplicate, but not already "
700 "selected for writing.");
701 list_replace(<e->write_streams_list,
702 <e_new->write_streams_list);
703 list_replace(<e->lookup_table_list,
704 <e_new->lookup_table_list);
705 lte_new->out_refcnt = lte->out_refcnt;
706 lte_new->will_be_in_output_wim = 1;
707 ctx->stream_was_duplicate = true;
712 list_move_tail(<e->write_streams_list, &ctx->pending_streams);
716 /* Write the next chunk of (typically compressed) data to the output WIM,
717 * handling the writing of the chunk table. */
719 write_chunk(struct write_streams_ctx *ctx, const void *cchunk,
720 size_t csize, size_t usize)
724 if (ctx->cur_write_res_offset == 0 &&
725 !(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS))
727 /* Starting to write a new stream in non-packed mode. */
729 struct wim_lookup_table_entry *lte;
731 lte = list_entry(ctx->pending_streams.next,
732 struct wim_lookup_table_entry, write_streams_list);
734 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
735 int additional_reshdr_flags = 0;
736 if (ctx->compressor != NULL)
737 additional_reshdr_flags |= WIM_RESHDR_FLAG_COMPRESSED;
739 DEBUG("Writing pipable WIM stream header "
740 "(offset=%"PRIu64")", ctx->out_fd->offset);
742 ret = write_pwm_stream_header(lte, ctx->out_fd,
743 additional_reshdr_flags);
748 ret = begin_write_resource(ctx, lte->size);
753 if (ctx->compressor != NULL) {
754 /* Record the compresed chunk size. */
755 wimlib_assert(ctx->chunk_index < ctx->num_alloc_chunks);
756 ctx->chunk_csizes[ctx->chunk_index++] = csize;
758 /* If writing a pipable WIM, before the chunk data write a chunk
759 * header that provides the compressed chunk size. */
760 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
761 struct pwm_chunk_hdr chunk_hdr = {
762 .compressed_size = cpu_to_le32(csize),
764 ret = full_write(ctx->out_fd, &chunk_hdr,
771 /* Write the chunk data. */
772 ret = full_write(ctx->out_fd, cchunk, csize);
776 ctx->cur_write_res_offset += usize;
778 if (ctx->cur_write_res_offset == ctx->cur_write_res_size &&
779 !(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS))
781 struct wim_lookup_table_entry *lte;
783 lte = list_entry(ctx->pending_streams.next,
784 struct wim_lookup_table_entry, write_streams_list);
785 wimlib_assert(ctx->cur_write_res_offset == lte->size);
787 /* Finished writing a stream in non-packed mode. */
789 do_write_streams_progress(&ctx->progress_data, lte, false);
791 ret = end_write_resource(ctx, <e->out_reshdr);
795 wimlib_assert(lte->out_reshdr.uncompressed_size == lte->size);
797 lte->out_reshdr.flags = filter_resource_flags(lte->flags);
798 if (ctx->compressor != NULL)
799 lte->out_reshdr.flags |= WIM_RESHDR_FLAG_COMPRESSED;
801 list_del(<e->write_streams_list);
802 ctx->cur_write_res_offset = 0;
808 ERROR_WITH_ERRNO("Write error");
813 submit_chunk_for_compression(struct write_streams_ctx *ctx,
814 const void *chunk, size_t size)
816 /* While we are unable to submit the chunk for compression (due to too
817 * many chunks already outstanding), retrieve and write the next
818 * compressed chunk. */
819 while (!ctx->compressor->submit_chunk(ctx->compressor, chunk, size)) {
826 bret = ctx->compressor->get_chunk(ctx->compressor,
827 &cchunk, &csize, &usize);
831 ret = write_chunk(ctx, cchunk, csize, usize);
838 /* Process the next chunk of data to be written to a WIM resource. */
840 write_stream_process_chunk(const void *chunk, size_t size, void *_ctx)
842 struct write_streams_ctx *ctx = _ctx;
844 const u8 *chunkptr, *chunkend;
846 wimlib_assert(size != 0);
848 if (ctx->compressor == NULL) {
849 /* Write chunk uncompressed. */
850 ret = write_chunk(ctx, chunk, size, size);
853 ctx->cur_read_res_offset += size;
857 /* Submit the chunk for compression, but take into account that the
858 * @size the chunk was provided in may not correspond to the
859 * @out_chunk_size being used for compression. */
861 chunkend = chunkptr + size;
863 const u8 *resized_chunk;
864 size_t needed_chunk_size;
866 if (ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS) {
867 needed_chunk_size = ctx->out_chunk_size;
869 u64 res_bytes_remaining;
871 res_bytes_remaining = ctx->cur_read_res_size -
872 ctx->cur_read_res_offset;
873 needed_chunk_size = min(ctx->out_chunk_size,
874 ctx->chunk_buf_filled +
875 res_bytes_remaining);
878 if (ctx->chunk_buf_filled == 0 &&
879 chunkend - chunkptr >= needed_chunk_size)
881 /* No intermediate buffering needed. */
882 resized_chunk = chunkptr;
883 chunkptr += needed_chunk_size;
884 ctx->cur_read_res_offset += needed_chunk_size;
886 /* Intermediate buffering needed. */
887 size_t bytes_consumed;
889 bytes_consumed = min(chunkend - chunkptr,
890 needed_chunk_size - ctx->chunk_buf_filled);
892 memcpy(&ctx->chunk_buf[ctx->chunk_buf_filled],
893 chunkptr, bytes_consumed);
895 resized_chunk = ctx->chunk_buf;
897 chunkptr += bytes_consumed;
898 ctx->cur_read_res_offset += bytes_consumed;
899 ctx->chunk_buf_filled += bytes_consumed;
900 if (ctx->chunk_buf_filled == needed_chunk_size) {
901 resized_chunk = ctx->chunk_buf;
902 ctx->chunk_buf_filled = 0;
909 ret = submit_chunk_for_compression(ctx, resized_chunk,
914 } while (chunkptr != chunkend);
918 /* Finish processing a stream for writing. It may not have been completely
919 * written yet, as the chunk_compressor implementation may still have chunks
920 * buffered or being compressed. */
922 write_stream_end_read(struct wim_lookup_table_entry *lte, int status, void *_ctx)
924 struct write_streams_ctx *ctx = _ctx;
926 wimlib_assert(ctx->cur_read_res_offset == ctx->cur_read_res_size);
927 if (ctx->stream_was_duplicate) {
928 free_lookup_table_entry(lte);
929 } else if (lte->unhashed && ctx->lookup_table != NULL) {
930 list_del(<e->unhashed_list);
931 lookup_table_insert(ctx->lookup_table, lte);
937 /* Compute statistics about a list of streams that will be written.
939 * Assumes the streams are sorted such that all streams located in each distinct
940 * WIM (specified by WIMStruct) are together. */
942 compute_stream_list_stats(struct list_head *stream_list,
943 struct write_streams_ctx *ctx)
945 struct wim_lookup_table_entry *lte;
949 WIMStruct *prev_wim_part = NULL;
951 list_for_each_entry(lte, stream_list, write_streams_list) {
953 total_bytes += lte->size;
954 if (lte->resource_location == RESOURCE_IN_WIM) {
955 if (prev_wim_part != lte->rspec->wim) {
956 prev_wim_part = lte->rspec->wim;
961 ctx->progress_data.progress.write_streams.total_bytes = total_bytes;
962 ctx->progress_data.progress.write_streams.total_streams = num_streams;
963 ctx->progress_data.progress.write_streams.completed_bytes = 0;
964 ctx->progress_data.progress.write_streams.completed_streams = 0;
965 ctx->progress_data.progress.write_streams.compression_type = ctx->out_ctype;
966 ctx->progress_data.progress.write_streams.total_parts = total_parts;
967 ctx->progress_data.progress.write_streams.completed_parts = 0;
968 ctx->progress_data.next_progress = 0;
969 ctx->progress_data.prev_wim_part = NULL;
972 /* Find streams in @stream_list that can be copied to the output WIM in raw form
973 * rather than compressed. Delete these streams from @stream_list, and move one
974 * per resource to @raw_copy_resources. Return the total uncompressed size of
975 * the streams that need to be compressed. */
977 find_raw_copy_resources(struct list_head *stream_list,
978 int write_resource_flags,
981 struct list_head *raw_copy_resources)
983 struct wim_lookup_table_entry *lte, *tmp;
984 u64 num_bytes_to_compress = 0;
986 INIT_LIST_HEAD(raw_copy_resources);
988 /* Initialize temporary raw_copy_ok flag. */
989 list_for_each_entry(lte, stream_list, write_streams_list)
990 if (lte->resource_location == RESOURCE_IN_WIM)
991 lte->rspec->raw_copy_ok = 0;
993 list_for_each_entry_safe(lte, tmp, stream_list, write_streams_list) {
994 if (lte->resource_location == RESOURCE_IN_WIM &&
995 lte->rspec->raw_copy_ok)
997 list_del(<e->write_streams_list);
998 } else if (can_raw_copy(lte, write_resource_flags,
999 out_ctype, out_chunk_size))
1001 lte->rspec->raw_copy_ok = 1;
1002 list_move_tail(<e->write_streams_list,
1003 raw_copy_resources);
1005 num_bytes_to_compress += lte->size;
1009 return num_bytes_to_compress;
1012 /* Copy a raw compressed resource located in another WIM file to the WIM file
1015 write_raw_copy_resource(struct wim_resource_spec *in_rspec,
1016 struct filedes *out_fd)
1018 u64 cur_read_offset;
1019 u64 end_read_offset;
1020 u8 buf[BUFFER_SIZE];
1021 size_t bytes_to_read;
1023 struct filedes *in_fd;
1024 struct wim_lookup_table_entry *lte;
1025 u64 out_offset_in_wim;
1027 DEBUG("Copying raw compressed data (size_in_wim=%"PRIu64", "
1028 "uncompressed_size=%"PRIu64")",
1029 in_rspec->size_in_wim, in_rspec->uncompressed_size);
1031 /* Copy the raw data. */
1032 cur_read_offset = in_rspec->offset_in_wim;
1033 end_read_offset = cur_read_offset + in_rspec->size_in_wim;
1035 out_offset_in_wim = out_fd->offset;
1037 if (in_rspec->is_pipable) {
1038 if (cur_read_offset < sizeof(struct pwm_stream_hdr))
1039 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1040 cur_read_offset -= sizeof(struct pwm_stream_hdr);
1041 out_offset_in_wim += sizeof(struct pwm_stream_hdr);
1043 in_fd = &in_rspec->wim->in_fd;
1044 while (cur_read_offset != end_read_offset) {
1046 bytes_to_read = min(sizeof(buf), end_read_offset - cur_read_offset);
1048 ret = full_pread(in_fd, buf, bytes_to_read, cur_read_offset);
1052 ret = full_write(out_fd, buf, bytes_to_read);
1056 cur_read_offset += bytes_to_read;
1059 list_for_each_entry(lte, &in_rspec->stream_list, rspec_node) {
1060 if (lte->will_be_in_output_wim) {
1061 stream_set_out_reshdr_for_reuse(lte);
1062 if (in_rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS)
1063 lte->out_res_offset_in_wim = out_offset_in_wim;
1065 lte->out_reshdr.offset_in_wim = out_offset_in_wim;
1072 /* Copy a list of raw compressed resources located other WIM file(s) to the WIM
1073 * file being written. */
1075 write_raw_copy_resources(struct list_head *raw_copy_resources,
1076 struct filedes *out_fd)
1078 struct wim_lookup_table_entry *lte;
1081 list_for_each_entry(lte, raw_copy_resources, write_streams_list) {
1082 ret = write_raw_copy_resource(lte->rspec, out_fd);
1089 /* Wait for and write all chunks pending in the compressor. */
1091 finish_remaining_chunks(struct write_streams_ctx *ctx)
1098 if (ctx->compressor == NULL)
1101 if (ctx->chunk_buf_filled != 0) {
1102 ret = submit_chunk_for_compression(ctx, ctx->chunk_buf,
1103 ctx->chunk_buf_filled);
1108 while (ctx->compressor->get_chunk(ctx->compressor, &cdata, &csize, &usize)) {
1109 ret = write_chunk(ctx, cdata, csize, usize);
1117 remove_zero_length_streams(struct list_head *stream_list)
1119 struct wim_lookup_table_entry *lte, *tmp;
1121 list_for_each_entry_safe(lte, tmp, stream_list, write_streams_list) {
1122 wimlib_assert(lte->will_be_in_output_wim);
1123 if (lte->size == 0) {
1124 list_del(<e->write_streams_list);
1125 lte->out_reshdr.offset_in_wim = 0;
1126 lte->out_reshdr.size_in_wim = 0;
1127 lte->out_reshdr.uncompressed_size = 0;
1128 lte->out_reshdr.flags = filter_resource_flags(lte->flags);
1134 write_stream_list(struct list_head *stream_list,
1135 struct filedes *out_fd,
1136 int write_resource_flags,
1139 unsigned num_threads,
1140 struct wim_lookup_table *lookup_table,
1141 struct filter_context *filter_ctx,
1142 struct wimlib_lzx_context **comp_ctx,
1143 wimlib_progress_func_t progress_func)
1146 struct write_streams_ctx ctx;
1147 struct list_head raw_copy_resources;
1149 remove_zero_length_streams(stream_list);
1151 if (list_empty(stream_list)) {
1152 DEBUG("No streams to write.");
1156 memset(&ctx, 0, sizeof(ctx));
1158 /* Pre-sorting the streams is required for compute_stream_list_stats().
1159 * Afterwards, read_stream_list() need not sort them again. */
1160 ret = sort_stream_list_by_sequential_order(stream_list,
1161 offsetof(struct wim_lookup_table_entry,
1162 write_streams_list));
1166 ctx.out_fd = out_fd;
1167 ctx.lookup_table = lookup_table;
1168 ctx.out_ctype = out_ctype;
1169 ctx.out_chunk_size = out_chunk_size;
1170 ctx.write_resource_flags = write_resource_flags;
1171 ctx.filter_ctx = filter_ctx;
1173 if (out_chunk_size <= STACK_MAX) {
1174 ctx.chunk_buf = alloca(out_chunk_size);
1176 ctx.chunk_buf = MALLOC(out_chunk_size);
1177 if (ctx.chunk_buf == NULL) {
1178 ret = WIMLIB_ERR_NOMEM;
1179 goto out_destroy_context;
1182 ctx.chunk_buf_filled = 0;
1184 compute_stream_list_stats(stream_list, &ctx);
1186 ctx.progress_data.progress_func = progress_func;
1188 ctx.num_bytes_to_compress = find_raw_copy_resources(stream_list,
1189 write_resource_flags,
1192 &raw_copy_resources);
1194 DEBUG("Writing stream list "
1195 "(offset = %"PRIu64", write_resource_flags=0x%08x, "
1196 "out_ctype=%d, out_chunk_size=%u, num_threads=%u, "
1197 "total_bytes=%"PRIu64", num_bytes_to_compress=%"PRIu64")",
1198 out_fd->offset, write_resource_flags,
1199 out_ctype, out_chunk_size, num_threads,
1200 ctx.progress_data.progress.write_streams.total_bytes,
1201 ctx.num_bytes_to_compress);
1203 if (ctx.num_bytes_to_compress == 0) {
1204 DEBUG("No compression needed; skipping to raw copy!");
1205 goto out_write_raw_copy_resources;
1208 /* Unless uncompressed output was required, allocate a chunk_compressor
1209 * to do compression. There are serial and parallel implementations of
1210 * the chunk_compressor interface. We default to parallel using the
1211 * specified number of threads, unless the upper bound on the number
1212 * bytes needing to be compressed is less 2000000 (heuristic value). */
1213 if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
1215 if (ctx.num_bytes_to_compress >= 2000000) {
1216 ret = new_parallel_chunk_compressor(out_ctype,
1221 DEBUG("Couldn't create parallel chunk compressor "
1222 "(status %d)", ret);
1226 if (ctx.compressor == NULL) {
1227 if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX) {
1228 ret = wimlib_lzx_alloc_context(out_chunk_size,
1232 goto out_destroy_context;
1234 ret = new_serial_chunk_compressor(out_ctype, out_chunk_size,
1235 *comp_ctx, &ctx.compressor);
1237 goto out_destroy_context;
1242 ctx.progress_data.progress.write_streams.num_threads = ctx.compressor->num_threads;
1244 ctx.progress_data.progress.write_streams.num_threads = 1;
1246 DEBUG("Actually using %u threads",
1247 ctx.progress_data.progress.write_streams.num_threads);
1249 INIT_LIST_HEAD(&ctx.pending_streams);
1251 if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS) {
1252 ret = begin_write_resource(&ctx, ctx.num_bytes_to_compress);
1254 goto out_destroy_context;
1257 /* Read the list of streams needing to be compressed, using the
1258 * specified callbacks to execute processing of the data. */
1260 struct read_stream_list_callbacks cbs = {
1261 .begin_stream = write_stream_begin_read,
1262 .begin_stream_ctx = &ctx,
1263 .consume_chunk = write_stream_process_chunk,
1264 .consume_chunk_ctx = &ctx,
1265 .end_stream = write_stream_end_read,
1266 .end_stream_ctx = &ctx,
1269 ret = read_stream_list(stream_list,
1270 offsetof(struct wim_lookup_table_entry, write_streams_list),
1272 STREAM_LIST_ALREADY_SORTED |
1273 VERIFY_STREAM_HASHES |
1274 COMPUTE_MISSING_STREAM_HASHES);
1277 goto out_destroy_context;
1279 ret = finish_remaining_chunks(&ctx);
1281 goto out_destroy_context;
1283 if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS) {
1284 struct wim_reshdr reshdr;
1285 struct wim_lookup_table_entry *lte;
1288 ret = end_write_resource(&ctx, &reshdr);
1290 goto out_destroy_context;
1292 DEBUG("Ending packed resource: %lu %lu %lu.",
1293 reshdr.offset_in_wim,
1295 reshdr.uncompressed_size);
1298 list_for_each_entry(lte, &ctx.pending_streams, write_streams_list) {
1299 lte->out_reshdr.size_in_wim = lte->size;
1300 lte->out_reshdr.flags = filter_resource_flags(lte->flags);
1301 lte->out_reshdr.flags |= WIM_RESHDR_FLAG_PACKED_STREAMS;
1302 lte->out_reshdr.uncompressed_size = 0;
1303 lte->out_reshdr.offset_in_wim = offset_in_res;
1304 lte->out_res_offset_in_wim = reshdr.offset_in_wim;
1305 lte->out_res_size_in_wim = reshdr.size_in_wim;
1306 /*lte->out_res_uncompressed_size = reshdr.uncompressed_size;*/
1307 offset_in_res += lte->size;
1309 wimlib_assert(offset_in_res == reshdr.uncompressed_size);
1312 out_write_raw_copy_resources:
1313 /* Copy any compressed resources for which the raw data can be reused
1314 * without decompression. */
1315 ret = write_raw_copy_resources(&raw_copy_resources, ctx.out_fd);
1317 out_destroy_context:
1318 if (out_chunk_size > STACK_MAX)
1319 FREE(ctx.chunk_buf);
1320 FREE(ctx.chunk_csizes);
1322 ctx.compressor->destroy(ctx.compressor);
1323 DEBUG("Done (ret=%d)", ret);
1328 write_wim_resource(struct wim_lookup_table_entry *lte,
1329 struct filedes *out_fd,
1332 int write_resource_flags,
1333 struct wimlib_lzx_context **comp_ctx)
1335 LIST_HEAD(stream_list);
1336 list_add(<e->write_streams_list, &stream_list);
1337 lte->will_be_in_output_wim = 1;
1338 return write_stream_list(&stream_list,
1340 write_resource_flags & ~WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS,
1351 write_wim_resource_from_buffer(const void *buf, size_t buf_size,
1352 int reshdr_flags, struct filedes *out_fd,
1355 struct wim_reshdr *out_reshdr,
1357 int write_resource_flags,
1358 struct wimlib_lzx_context **comp_ctx)
1361 struct wim_lookup_table_entry *lte;
1363 /* Set up a temporary lookup table entry to provide to
1364 * write_wim_resource(). */
1366 lte = new_lookup_table_entry();
1368 return WIMLIB_ERR_NOMEM;
1370 lte->resource_location = RESOURCE_IN_ATTACHED_BUFFER;
1371 lte->attached_buffer = (void*)buf;
1372 lte->size = buf_size;
1373 lte->flags = reshdr_flags;
1375 if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
1376 sha1_buffer(buf, buf_size, lte->hash);
1382 ret = write_wim_resource(lte, out_fd, out_ctype, out_chunk_size,
1383 write_resource_flags, comp_ctx);
1387 copy_reshdr(out_reshdr, <e->out_reshdr);
1390 copy_hash(hash, lte->hash);
1393 lte->resource_location = RESOURCE_NONEXISTENT;
1394 free_lookup_table_entry(lte);
1398 struct stream_size_table {
1399 struct hlist_head *array;
1405 init_stream_size_table(struct stream_size_table *tab, size_t capacity)
1407 tab->array = CALLOC(capacity, sizeof(tab->array[0]));
1408 if (tab->array == NULL)
1409 return WIMLIB_ERR_NOMEM;
1410 tab->num_entries = 0;
1411 tab->capacity = capacity;
1416 destroy_stream_size_table(struct stream_size_table *tab)
1422 stream_size_table_insert(struct wim_lookup_table_entry *lte, void *_tab)
1424 struct stream_size_table *tab = _tab;
1426 struct wim_lookup_table_entry *same_size_lte;
1427 struct hlist_node *tmp;
1429 pos = hash_u64(lte->size) % tab->capacity;
1430 lte->unique_size = 1;
1431 hlist_for_each_entry(same_size_lte, tmp, &tab->array[pos], hash_list_2) {
1432 if (same_size_lte->size == lte->size) {
1433 lte->unique_size = 0;
1434 same_size_lte->unique_size = 0;
1439 hlist_add_head(<e->hash_list_2, &tab->array[pos]);
1444 struct find_streams_ctx {
1447 struct list_head stream_list;
1448 struct stream_size_table stream_size_tab;
1452 reference_stream_for_write(struct wim_lookup_table_entry *lte,
1453 struct list_head *stream_list, u32 nref)
1455 if (!lte->will_be_in_output_wim) {
1456 lte->out_refcnt = 0;
1457 list_add_tail(<e->write_streams_list, stream_list);
1458 lte->will_be_in_output_wim = 1;
1460 lte->out_refcnt += nref;
1464 fully_reference_stream_for_write(struct wim_lookup_table_entry *lte,
1467 struct list_head *stream_list = _stream_list;
1468 lte->will_be_in_output_wim = 0;
1469 reference_stream_for_write(lte, stream_list, lte->refcnt);
1474 inode_find_streams_to_reference(const struct wim_inode *inode,
1475 const struct wim_lookup_table *table,
1476 struct list_head *stream_list)
1478 struct wim_lookup_table_entry *lte;
1481 wimlib_assert(inode->i_nlink > 0);
1483 for (i = 0; i <= inode->i_num_ads; i++) {
1484 lte = inode_stream_lte(inode, i, table);
1486 reference_stream_for_write(lte, stream_list,
1488 else if (!is_zero_hash(inode_stream_hash(inode, i)))
1489 return WIMLIB_ERR_RESOURCE_NOT_FOUND;
1495 do_stream_set_not_in_output_wim(struct wim_lookup_table_entry *lte, void *_ignore)
1497 lte->will_be_in_output_wim = 0;
1502 image_find_streams_to_reference(WIMStruct *wim)
1504 struct wim_image_metadata *imd;
1505 struct wim_inode *inode;
1506 struct wim_lookup_table_entry *lte;
1507 struct list_head *stream_list;
1510 imd = wim_get_current_image_metadata(wim);
1512 image_for_each_unhashed_stream(lte, imd)
1513 lte->will_be_in_output_wim = 0;
1515 stream_list = wim->private;
1516 image_for_each_inode(inode, imd) {
1517 ret = inode_find_streams_to_reference(inode,
1527 prepare_unfiltered_list_of_streams_in_output_wim(WIMStruct *wim,
1530 struct list_head *stream_list_ret)
1534 INIT_LIST_HEAD(stream_list_ret);
1536 if (streams_ok && (image == WIMLIB_ALL_IMAGES ||
1537 (image == 1 && wim->hdr.image_count == 1)))
1539 /* Fast case: Assume that all streams are being written and
1540 * that the reference counts are correct. */
1541 struct wim_lookup_table_entry *lte;
1542 struct wim_image_metadata *imd;
1545 for_lookup_table_entry(wim->lookup_table,
1546 fully_reference_stream_for_write,
1549 for (i = 0; i < wim->hdr.image_count; i++) {
1550 imd = wim->image_metadata[i];
1551 image_for_each_unhashed_stream(lte, imd)
1552 fully_reference_stream_for_write(lte, stream_list_ret);
1555 /* Slow case: Walk through the images being written and
1556 * determine the streams referenced. */
1557 for_lookup_table_entry(wim->lookup_table,
1558 do_stream_set_not_in_output_wim, NULL);
1559 wim->private = stream_list_ret;
1560 ret = for_image(wim, image, image_find_streams_to_reference);
1568 struct insert_other_if_hard_filtered_ctx {
1569 struct stream_size_table *tab;
1570 struct filter_context *filter_ctx;
1574 insert_other_if_hard_filtered(struct wim_lookup_table_entry *lte, void *_ctx)
1576 struct insert_other_if_hard_filtered_ctx *ctx = _ctx;
1578 if (!lte->will_be_in_output_wim &&
1579 stream_hard_filtered(lte, ctx->filter_ctx))
1580 stream_size_table_insert(lte, ctx->tab);
1585 determine_stream_size_uniquity(struct list_head *stream_list,
1586 struct wim_lookup_table *lt,
1587 struct filter_context *filter_ctx)
1590 struct stream_size_table tab;
1591 struct wim_lookup_table_entry *lte;
1593 ret = init_stream_size_table(&tab, lt->capacity);
1597 if (may_hard_filter_streams(filter_ctx)) {
1598 struct insert_other_if_hard_filtered_ctx ctx = {
1600 .filter_ctx = filter_ctx,
1602 for_lookup_table_entry(lt, insert_other_if_hard_filtered, &ctx);
1605 list_for_each_entry(lte, stream_list, write_streams_list)
1606 stream_size_table_insert(lte, &tab);
1608 destroy_stream_size_table(&tab);
1613 filter_stream_list_for_write(struct list_head *stream_list,
1614 struct filter_context *filter_ctx)
1616 struct wim_lookup_table_entry *lte, *tmp;
1618 list_for_each_entry_safe(lte, tmp,
1619 stream_list, write_streams_list)
1621 int status = stream_filtered(lte, filter_ctx);
1628 /* Soft filtered. */
1630 /* Hard filtered. */
1631 lte->will_be_in_output_wim = 0;
1632 list_del(<e->lookup_table_list);
1634 list_del(<e->write_streams_list);
1640 * prepare_stream_list_for_write() -
1642 * Prepare the list of streams to write for writing a WIM containing the
1643 * specified image(s) with the specified write flags.
1646 * The WIMStruct on whose behalf the write is occurring.
1649 * Image(s) from the WIM to write; may be WIMLIB_ALL_IMAGES.
1652 * WIMLIB_WRITE_FLAG_* flags for the write operation:
1654 * STREAMS_OK: For writes of all images, assume that all streams in the
1655 * lookup table of @wim and the per-image lists of unhashed streams should
1656 * be taken as-is, and image metadata should not be searched for
1657 * references. This does not exclude filtering with OVERWRITE and
1658 * SKIP_EXTERNAL_WIMS, below.
1660 * OVERWRITE: Streams already present in @wim shall not be returned in
1663 * SKIP_EXTERNAL_WIMS: Streams already present in a WIM file, but not
1664 * @wim, shall be be returned in neither @stream_list_ret nor
1665 * @lookup_table_list_ret.
1668 * List of streams, linked by write_streams_list, that need to be written
1669 * will be returned here.
1671 * Note that this function assumes that unhashed streams will be written;
1672 * it does not take into account that they may become duplicates when
1675 * @lookup_table_list_ret
1676 * List of streams, linked by lookup_table_list, that need to be included
1677 * in the WIM's lookup table will be returned here. This will be a
1678 * superset of the streams in @stream_list_ret.
1680 * This list will be a proper superset of @stream_list_ret if and only if
1681 * WIMLIB_WRITE_FLAG_OVERWRITE was specified in @write_flags and some of
1682 * the streams that would otherwise need to be written were already located
1685 * All streams in this list will have @out_refcnt set to the number of
1686 * references to the stream in the output WIM. If
1687 * WIMLIB_WRITE_FLAG_STREAMS_OK was specified in @write_flags, @out_refcnt
1688 * may be as low as 0.
1691 * A context for queries of stream filter status with stream_filtered() is
1692 * returned in this location.
1694 * In addition, @will_be_in_output_wim will be set to 1 in all stream entries
1695 * inserted into @lookup_table_list_ret and to 0 in all stream entries in the
1696 * lookup table of @wim not inserted into @lookup_table_list_ret.
1698 * Still furthermore, @unique_size will be set to 1 on all stream entries in
1699 * @stream_list_ret that have unique size among all stream entries in
1700 * @stream_list_ret and among all stream entries in the lookup table of @wim
1701 * that are ineligible for being written due to filtering.
1703 * Returns 0 on success; nonzero on read error, memory allocation error, or
1707 prepare_stream_list_for_write(WIMStruct *wim, int image,
1709 struct list_head *stream_list_ret,
1710 struct list_head *lookup_table_list_ret,
1711 struct filter_context *filter_ctx_ret)
1714 struct wim_lookup_table_entry *lte;
1716 filter_ctx_ret->write_flags = write_flags;
1717 filter_ctx_ret->wim = wim;
1719 ret = prepare_unfiltered_list_of_streams_in_output_wim(
1722 write_flags & WIMLIB_WRITE_FLAG_STREAMS_OK,
1727 INIT_LIST_HEAD(lookup_table_list_ret);
1728 list_for_each_entry(lte, stream_list_ret, write_streams_list)
1729 list_add_tail(<e->lookup_table_list, lookup_table_list_ret);
1731 ret = determine_stream_size_uniquity(stream_list_ret, wim->lookup_table,
1736 if (may_filter_streams(filter_ctx_ret))
1737 filter_stream_list_for_write(stream_list_ret, filter_ctx_ret);
1743 write_wim_streams(WIMStruct *wim, int image, int write_flags,
1744 unsigned num_threads,
1745 wimlib_progress_func_t progress_func,
1746 struct list_head *stream_list_override,
1747 struct list_head *lookup_table_list_ret)
1750 struct list_head _stream_list;
1751 struct list_head *stream_list;
1752 struct wim_lookup_table_entry *lte;
1753 struct filter_context _filter_ctx;
1754 struct filter_context *filter_ctx;
1756 if (stream_list_override == NULL) {
1757 /* Normal case: prepare stream list from image(s) being written.
1759 stream_list = &_stream_list;
1760 filter_ctx = &_filter_ctx;
1761 ret = prepare_stream_list_for_write(wim, image, write_flags,
1763 lookup_table_list_ret,
1768 /* Currently only as a result of wimlib_split() being called:
1769 * use stream list already explicitly provided. Use existing
1770 * reference counts. */
1771 stream_list = stream_list_override;
1773 INIT_LIST_HEAD(lookup_table_list_ret);
1774 list_for_each_entry(lte, stream_list, write_streams_list) {
1775 lte->out_refcnt = lte->refcnt;
1776 lte->will_be_in_output_wim = 1;
1777 lte->unique_size = 0;
1778 list_add_tail(<e->lookup_table_list, lookup_table_list_ret);
1782 return write_stream_list(stream_list,
1784 write_flags_to_resource_flags(write_flags),
1785 wim->out_compression_type,
1786 wim->out_chunk_size,
1795 write_wim_metadata_resources(WIMStruct *wim, int image, int write_flags,
1796 wimlib_progress_func_t progress_func)
1801 int write_resource_flags;
1803 if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA) {
1804 DEBUG("Not writing any metadata resources.");
1808 write_resource_flags = write_flags_to_resource_flags(write_flags);
1810 write_resource_flags &= ~WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS;
1812 DEBUG("Writing metadata resources (offset=%"PRIu64")",
1813 wim->out_fd.offset);
1816 progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, NULL);
1818 if (image == WIMLIB_ALL_IMAGES) {
1820 end_image = wim->hdr.image_count;
1822 start_image = image;
1826 for (int i = start_image; i <= end_image; i++) {
1827 struct wim_image_metadata *imd;
1829 imd = wim->image_metadata[i - 1];
1830 /* Build a new metadata resource only if image was modified from
1831 * the original (or was newly added). Otherwise just copy the
1833 if (imd->modified) {
1834 DEBUG("Image %u was modified; building and writing new "
1835 "metadata resource", i);
1836 ret = write_metadata_resource(wim, i,
1837 write_resource_flags);
1838 } else if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE) {
1839 DEBUG("Image %u was not modified; re-using existing "
1840 "metadata resource.", i);
1841 stream_set_out_reshdr_for_reuse(imd->metadata_lte);
1844 DEBUG("Image %u was not modified; copying existing "
1845 "metadata resource.", i);
1846 ret = write_wim_resource(imd->metadata_lte,
1848 wim->out_compression_type,
1849 wim->out_chunk_size,
1850 write_resource_flags,
1857 progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, NULL);
1862 open_wim_writable(WIMStruct *wim, const tchar *path, int open_flags)
1865 DEBUG("Opening \"%"TS"\" for writing.", path);
1867 raw_fd = topen(path, open_flags | O_BINARY, 0644);
1869 ERROR_WITH_ERRNO("Failed to open \"%"TS"\" for writing", path);
1870 return WIMLIB_ERR_OPEN;
1872 filedes_init(&wim->out_fd, raw_fd);
1877 close_wim_writable(WIMStruct *wim, int write_flags)
1881 if (!(write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)) {
1882 DEBUG("Closing WIM file.");
1883 if (filedes_valid(&wim->out_fd))
1884 if (filedes_close(&wim->out_fd))
1885 ret = WIMLIB_ERR_WRITE;
1887 filedes_invalidate(&wim->out_fd);
1892 cmp_streams_by_out_rspec(const void *p1, const void *p2)
1894 const struct wim_lookup_table_entry *lte1, *lte2;
1896 lte1 = *(const struct wim_lookup_table_entry**)p1;
1897 lte2 = *(const struct wim_lookup_table_entry**)p2;
1899 if (lte1->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
1900 if (lte2->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
1901 if (lte1->out_res_offset_in_wim != lte2->out_res_offset_in_wim)
1902 return cmp_u64(lte1->out_res_offset_in_wim,
1903 lte2->out_res_offset_in_wim);
1908 if (lte2->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS)
1911 return cmp_u64(lte1->out_reshdr.offset_in_wim,
1912 lte2->out_reshdr.offset_in_wim);
1916 write_wim_lookup_table(WIMStruct *wim, int image, int write_flags,
1917 struct wim_reshdr *out_reshdr,
1918 struct list_head *lookup_table_list)
1922 /* Set output resource metadata for streams already present in WIM. */
1923 if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE) {
1924 struct wim_lookup_table_entry *lte;
1925 list_for_each_entry(lte, lookup_table_list, lookup_table_list)
1927 if (lte->resource_location == RESOURCE_IN_WIM &&
1928 lte->rspec->wim == wim)
1930 stream_set_out_reshdr_for_reuse(lte);
1935 ret = sort_stream_list(lookup_table_list,
1936 offsetof(struct wim_lookup_table_entry, lookup_table_list),
1937 cmp_streams_by_out_rspec);
1941 /* Add entries for metadata resources. */
1942 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_METADATA)) {
1946 if (image == WIMLIB_ALL_IMAGES) {
1948 end_image = wim->hdr.image_count;
1950 start_image = image;
1954 /* Push metadata resource lookup table entries onto the front of
1955 * the list in reverse order, so that they're written in order.
1957 for (int i = end_image; i >= start_image; i--) {
1958 struct wim_lookup_table_entry *metadata_lte;
1960 metadata_lte = wim->image_metadata[i - 1]->metadata_lte;
1961 wimlib_assert(metadata_lte->out_reshdr.flags & WIM_RESHDR_FLAG_METADATA);
1962 metadata_lte->out_refcnt = 1;
1963 list_add(&metadata_lte->lookup_table_list, lookup_table_list);
1967 return write_wim_lookup_table_from_stream_list(lookup_table_list,
1969 wim->hdr.part_number,
1971 write_flags_to_resource_flags(write_flags),
1978 * Finish writing a WIM file: write the lookup table, xml data, and integrity
1979 * table, then overwrite the WIM header. By default, closes the WIM file
1980 * descriptor (@wim->out_fd) if successful.
1982 * write_flags is a bitwise OR of the following:
1984 * (public) WIMLIB_WRITE_FLAG_CHECK_INTEGRITY:
1985 * Include an integrity table.
1987 * (public) WIMLIB_WRITE_FLAG_FSYNC:
1988 * fsync() the output file before closing it.
1990 * (public) WIMLIB_WRITE_FLAG_PIPABLE:
1991 * Writing a pipable WIM, possibly to a pipe; include pipable WIM
1992 * stream headers before the lookup table and XML data, and also
1993 * write the WIM header at the end instead of seeking to the
1994 * beginning. Can't be combined with
1995 * WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.
1997 * (private) WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE:
1998 * Don't write the lookup table.
2000 * (private) WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE:
2001 * When (if) writing the integrity table, re-use entries from the
2002 * existing integrity table, if possible.
2004 * (private) WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML:
2005 * After writing the XML data but before writing the integrity
2006 * table, write a temporary WIM header and flush the stream so that
2007 * the WIM is less likely to become corrupted upon abrupt program
2009 * (private) WIMLIB_WRITE_FLAG_HEADER_AT_END:
2010 * Instead of overwriting the WIM header at the beginning of the
2011 * file, simply append it to the end of the file. (Used when
2013 * (private) WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR:
2014 * Do not close the file descriptor @wim->out_fd on either success
2016 * (private) WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES:
2017 * Use the existing <TOTALBYTES> stored in the in-memory XML
2018 * information, rather than setting it to the offset of the XML
2019 * data being written.
2022 finish_write(WIMStruct *wim, int image, int write_flags,
2023 wimlib_progress_func_t progress_func,
2024 struct list_head *lookup_table_list)
2028 int write_resource_flags;
2029 off_t old_lookup_table_end;
2030 off_t new_lookup_table_end;
2033 DEBUG("image=%d, write_flags=%08x", image, write_flags);
2035 write_resource_flags = write_flags_to_resource_flags(write_flags);
2037 /* In the WIM header, there is room for the resource entry for a
2038 * metadata resource labeled as the "boot metadata". This entry should
2039 * be zeroed out if there is no bootable image (boot_idx 0). Otherwise,
2040 * it should be a copy of the resource entry for the image that is
2041 * marked as bootable. This is not well documented... */
2042 if (wim->hdr.boot_idx == 0) {
2043 zero_reshdr(&wim->hdr.boot_metadata_reshdr);
2045 copy_reshdr(&wim->hdr.boot_metadata_reshdr,
2046 &wim->image_metadata[
2047 wim->hdr.boot_idx - 1]->metadata_lte->out_reshdr);
2050 /* Write lookup table. (Save old position first.) */
2051 old_lookup_table_end = wim->hdr.lookup_table_reshdr.offset_in_wim +
2052 wim->hdr.lookup_table_reshdr.size_in_wim;
2053 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
2054 ret = write_wim_lookup_table(wim, image, write_flags,
2055 &wim->hdr.lookup_table_reshdr,
2061 /* Write XML data. */
2062 xml_totalbytes = wim->out_fd.offset;
2063 if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
2064 xml_totalbytes = WIM_TOTALBYTES_USE_EXISTING;
2065 ret = write_wim_xml_data(wim, image, xml_totalbytes,
2066 &wim->hdr.xml_data_reshdr,
2067 write_resource_flags);
2071 /* Write integrity table (optional). */
2072 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
2073 if (write_flags & WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) {
2074 struct wim_header checkpoint_hdr;
2075 memcpy(&checkpoint_hdr, &wim->hdr, sizeof(struct wim_header));
2076 zero_reshdr(&checkpoint_hdr.integrity_table_reshdr);
2077 checkpoint_hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2078 ret = write_wim_header_at_offset(&checkpoint_hdr,
2084 if (!(write_flags & WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE))
2085 old_lookup_table_end = 0;
2087 new_lookup_table_end = wim->hdr.lookup_table_reshdr.offset_in_wim +
2088 wim->hdr.lookup_table_reshdr.size_in_wim;
2090 ret = write_integrity_table(wim,
2091 new_lookup_table_end,
2092 old_lookup_table_end,
2097 /* No integrity table. */
2098 zero_reshdr(&wim->hdr.integrity_table_reshdr);
2101 /* Now that all information in the WIM header has been determined, the
2102 * preliminary header written earlier can be overwritten, the header of
2103 * the existing WIM file can be overwritten, or the final header can be
2104 * written to the end of the pipable WIM. */
2105 wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2107 if (write_flags & WIMLIB_WRITE_FLAG_HEADER_AT_END)
2108 hdr_offset = wim->out_fd.offset;
2109 DEBUG("Writing new header @ %"PRIu64".", hdr_offset);
2110 ret = write_wim_header_at_offset(&wim->hdr, &wim->out_fd, hdr_offset);
2114 /* Possibly sync file data to disk before closing. On POSIX systems, it
2115 * is necessary to do this before using rename() to overwrite an
2116 * existing file with a new file. Otherwise, data loss would occur if
2117 * the system is abruptly terminated when the metadata for the rename
2118 * operation has been written to disk, but the new file data has not.
2120 if (write_flags & WIMLIB_WRITE_FLAG_FSYNC) {
2121 DEBUG("Syncing WIM file.");
2122 if (fsync(wim->out_fd.fd)) {
2123 ERROR_WITH_ERRNO("Error syncing data to WIM file");
2124 return WIMLIB_ERR_WRITE;
2128 if (close_wim_writable(wim, write_flags)) {
2129 ERROR_WITH_ERRNO("Failed to close the output WIM file");
2130 return WIMLIB_ERR_WRITE;
2136 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
2138 lock_wim(WIMStruct *wim, int fd)
2141 if (fd != -1 && !wim->wim_locked) {
2142 ret = flock(fd, LOCK_EX | LOCK_NB);
2144 if (errno == EWOULDBLOCK) {
2145 ERROR("`%"TS"' is already being modified or has been "
2146 "mounted read-write\n"
2147 " by another process!", wim->filename);
2148 ret = WIMLIB_ERR_ALREADY_LOCKED;
2150 WARNING_WITH_ERRNO("Failed to lock `%"TS"'",
2155 wim->wim_locked = 1;
2163 * write_pipable_wim():
2165 * Perform the intermediate stages of creating a "pipable" WIM (i.e. a WIM
2166 * capable of being applied from a pipe).
2168 * Pipable WIMs are a wimlib-specific modification of the WIM format such that
2169 * images can be applied from them sequentially when the file data is sent over
2170 * a pipe. In addition, a pipable WIM can be written sequentially to a pipe.
2171 * The modifications made to the WIM format for pipable WIMs are:
2173 * - Magic characters in header are "WLPWM\0\0\0" (wimlib pipable WIM) instead
2174 * of "MSWIM\0\0\0". This lets wimlib know that the WIM is pipable and also
2175 * stops other software from trying to read the file as a normal WIM.
2177 * - The header at the beginning of the file does not contain all the normal
2178 * information; in particular it will have all 0's for the lookup table and
2179 * XML data resource entries. This is because this information cannot be
2180 * determined until the lookup table and XML data have been written.
2181 * Consequently, wimlib will write the full header at the very end of the
2182 * file. The header at the end, however, is only used when reading the WIM
2183 * from a seekable file (not a pipe).
2185 * - An extra copy of the XML data is placed directly after the header. This
2186 * allows image names and sizes to be determined at an appropriate time when
2187 * reading the WIM from a pipe. This copy of the XML data is ignored if the
2188 * WIM is read from a seekable file (not a pipe).
2190 * - The format of resources, or streams, has been modified to allow them to be
2191 * used before the "lookup table" has been read. Each stream is prefixed with
2192 * a `struct pwm_stream_hdr' that is basically an abbreviated form of `struct
2193 * wim_lookup_table_entry_disk' that only contains the SHA1 message digest,
2194 * uncompressed stream size, and flags that indicate whether the stream is
2195 * compressed. The data of uncompressed streams then follows literally, while
2196 * the data of compressed streams follows in a modified format. Compressed
2197 * streams do not begin with a chunk table, since the chunk table cannot be
2198 * written until all chunks have been compressed. Instead, each compressed
2199 * chunk is prefixed by a `struct pwm_chunk_hdr' that gives its size.
2200 * Furthermore, the chunk table is written at the end of the resource instead
2201 * of the start. Note: chunk offsets are given in the chunk table as if the
2202 * `struct pwm_chunk_hdr's were not present; also, the chunk table is only
2203 * used if the WIM is being read from a seekable file (not a pipe).
2205 * - Metadata resources always come before other file resources (streams).
2206 * (This does not by itself constitute an incompatibility with normal WIMs,
2207 * since this is valid in normal WIMs.)
2209 * - At least up to the end of the file resources, all components must be packed
2210 * as tightly as possible; there cannot be any "holes" in the WIM. (This does
2211 * not by itself consititute an incompatibility with normal WIMs, since this
2212 * is valid in normal WIMs.)
2214 * Note: the lookup table, XML data, and header at the end are not used when
2215 * applying from a pipe. They exist to support functionality such as image
2216 * application and export when the WIM is *not* read from a pipe.
2218 * Layout of pipable WIM:
2220 * ---------+----------+--------------------+----------------+--------------+-----------+--------+
2221 * | Header | XML data | Metadata resources | File resources | Lookup table | XML data | Header |
2222 * ---------+----------+--------------------+----------------+--------------+-----------+--------+
2224 * Layout of normal WIM:
2226 * +--------+-----------------------------+-------------------------+
2227 * | Header | File and metadata resources | Lookup table | XML data |
2228 * +--------+-----------------------------+-------------------------+
2230 * An optional integrity table can follow the final XML data in both normal and
2231 * pipable WIMs. However, due to implementation details, wimlib currently can
2232 * only include an integrity table in a pipable WIM when writing it to a
2233 * seekable file (not a pipe).
2235 * Do note that since pipable WIMs are not supported by Microsoft's software,
2236 * wimlib does not create them unless explicitly requested (with
2237 * WIMLIB_WRITE_FLAG_PIPABLE) and as stated above they use different magic
2238 * characters to identify the file.
2241 write_pipable_wim(WIMStruct *wim, int image, int write_flags,
2242 unsigned num_threads, wimlib_progress_func_t progress_func,
2243 struct list_head *stream_list_override,
2244 struct list_head *lookup_table_list_ret)
2247 struct wim_reshdr xml_reshdr;
2249 WARNING("Creating a pipable WIM, which will "
2251 " with Microsoft's software (wimgapi/imagex/Dism).");
2253 /* At this point, the header at the beginning of the file has already
2256 /* For efficiency, when wimlib adds an image to the WIM with
2257 * wimlib_add_image(), the SHA1 message digests of files is not
2258 * calculated; instead, they are calculated while the files are being
2259 * written. However, this does not work when writing a pipable WIM,
2260 * since when writing a stream to a pipable WIM, its SHA1 message digest
2261 * needs to be known before the stream data is written. Therefore,
2262 * before getting much farther, we need to pre-calculate the SHA1
2263 * message digests of all streams that will be written. */
2264 ret = wim_checksum_unhashed_streams(wim);
2268 /* Write extra copy of the XML data. */
2269 ret = write_wim_xml_data(wim, image, WIM_TOTALBYTES_OMIT,
2271 WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE);
2275 /* Write metadata resources for the image(s) being included in the
2277 ret = write_wim_metadata_resources(wim, image, write_flags,
2282 /* Write streams needed for the image(s) being included in the output
2283 * WIM, or streams needed for the split WIM part. */
2284 return write_wim_streams(wim, image, write_flags, num_threads,
2285 progress_func, stream_list_override,
2286 lookup_table_list_ret);
2288 /* The lookup table, XML data, and header at end are handled by
2289 * finish_write(). */
2292 /* Write a standalone WIM or split WIM (SWM) part to a new file or to a file
2295 write_wim_part(WIMStruct *wim,
2296 const void *path_or_fd,
2299 unsigned num_threads,
2300 wimlib_progress_func_t progress_func,
2301 unsigned part_number,
2302 unsigned total_parts,
2303 struct list_head *stream_list_override,
2307 struct wim_header hdr_save;
2308 struct list_head lookup_table_list;
2310 if (total_parts == 1)
2311 DEBUG("Writing standalone WIM.");
2313 DEBUG("Writing split WIM part %u/%u", part_number, total_parts);
2314 if (image == WIMLIB_ALL_IMAGES)
2315 DEBUG("Including all images.");
2317 DEBUG("Including image %d only.", image);
2318 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2319 DEBUG("File descriptor: %d", *(const int*)path_or_fd);
2321 DEBUG("Path: \"%"TS"\"", (const tchar*)path_or_fd);
2322 DEBUG("Write flags: 0x%08x", write_flags);
2324 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY)
2325 DEBUG("\tCHECK_INTEGRITY");
2327 if (write_flags & WIMLIB_WRITE_FLAG_REBUILD)
2330 if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
2331 DEBUG("\tRECOMPRESS");
2333 if (write_flags & WIMLIB_WRITE_FLAG_FSYNC)
2336 if (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE)
2339 if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
2340 DEBUG("\tIGNORE_READONLY_FLAG");
2342 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
2345 if (write_flags & WIMLIB_WRITE_FLAG_NOT_PIPABLE)
2346 DEBUG("\tNOT_PIPABLE");
2348 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
2349 DEBUG("\tPACK_STREAMS");
2351 if (write_flags & WIMLIB_WRITE_FLAG_NO_PACK_STREAMS)
2352 DEBUG("\tNO_PACK_STREAMS");
2354 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2355 DEBUG("\tFILE_DESCRIPTOR");
2357 if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA)
2358 DEBUG("\tNO_METADATA");
2360 if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
2361 DEBUG("\tUSE_EXISTING_TOTALBYTES");
2363 if (num_threads == 0)
2364 DEBUG("Number of threads: autodetect");
2366 DEBUG("Number of threads: %u", num_threads);
2367 DEBUG("Progress function: %s", (progress_func ? "yes" : "no"));
2368 DEBUG("Stream list: %s", (stream_list_override ? "specified" : "autodetect"));
2369 DEBUG("GUID: %s", ((guid || wim->guid_set_explicitly) ?
2370 "specified" : "generate new"));
2372 /* Internally, this is always called with a valid part number and total
2374 wimlib_assert(total_parts >= 1);
2375 wimlib_assert(part_number >= 1 && part_number <= total_parts);
2377 /* A valid image (or all images) must be specified. */
2378 if (image != WIMLIB_ALL_IMAGES &&
2379 (image < 1 || image > wim->hdr.image_count))
2380 return WIMLIB_ERR_INVALID_IMAGE;
2382 /* If we need to write metadata resources, make sure the ::WIMStruct has
2383 * the needed information attached (e.g. is not a resource-only WIM,
2384 * such as a non-first part of a split WIM). */
2385 if (!wim_has_metadata(wim) &&
2386 !(write_flags & WIMLIB_WRITE_FLAG_NO_METADATA))
2387 return WIMLIB_ERR_METADATA_NOT_FOUND;
2389 /* Check for contradictory flags. */
2390 if ((write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2391 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
2392 == (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2393 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
2394 return WIMLIB_ERR_INVALID_PARAM;
2396 if ((write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2397 WIMLIB_WRITE_FLAG_NOT_PIPABLE))
2398 == (WIMLIB_WRITE_FLAG_PIPABLE |
2399 WIMLIB_WRITE_FLAG_NOT_PIPABLE))
2400 return WIMLIB_ERR_INVALID_PARAM;
2402 if ((write_flags & (WIMLIB_WRITE_FLAG_PACK_STREAMS |
2403 WIMLIB_WRITE_FLAG_NO_PACK_STREAMS))
2404 == (WIMLIB_WRITE_FLAG_PACK_STREAMS |
2405 WIMLIB_WRITE_FLAG_NO_PACK_STREAMS))
2406 return WIMLIB_ERR_INVALID_PARAM;
2408 /* Save previous header, then start initializing the new one. */
2409 memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
2411 /* Set default integrity, pipable, and packed stream flags. */
2412 if (!(write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2413 WIMLIB_WRITE_FLAG_NOT_PIPABLE)))
2414 if (wim_is_pipable(wim)) {
2415 DEBUG("WIM is pipable; default to PIPABLE.");
2416 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2419 if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2420 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
2421 if (wim_has_integrity_table(wim)) {
2422 DEBUG("Integrity table present; default to CHECK_INTEGRITY.");
2423 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2426 if (!(write_flags & (WIMLIB_WRITE_FLAG_PACK_STREAMS |
2427 WIMLIB_WRITE_FLAG_NO_PACK_STREAMS)))
2428 if (wim->hdr.wim_version == WIM_VERSION_PACKED_STREAMS) {
2429 DEBUG("WIM version 3584; default to PACK_STREAMS.");
2430 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2433 if ((write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2434 WIMLIB_WRITE_FLAG_PACK_STREAMS))
2435 == (WIMLIB_WRITE_FLAG_PIPABLE |
2436 WIMLIB_WRITE_FLAG_PACK_STREAMS))
2437 return WIMLIB_ERR_INVALID_PARAM;
2439 /* Set appropriate magic number. */
2440 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
2441 wim->hdr.magic = PWM_MAGIC;
2443 wim->hdr.magic = WIM_MAGIC;
2445 /* Set appropriate version number. */
2446 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
2447 wim->hdr.wim_version = WIM_VERSION_PACKED_STREAMS;
2449 wim->hdr.wim_version = WIM_VERSION_DEFAULT;
2451 /* Clear header flags that will be set automatically. */
2452 wim->hdr.flags &= ~(WIM_HDR_FLAG_METADATA_ONLY |
2453 WIM_HDR_FLAG_RESOURCE_ONLY |
2454 WIM_HDR_FLAG_SPANNED |
2455 WIM_HDR_FLAG_WRITE_IN_PROGRESS);
2457 /* Set SPANNED header flag if writing part of a split WIM. */
2458 if (total_parts != 1)
2459 wim->hdr.flags |= WIM_HDR_FLAG_SPANNED;
2461 /* Set part number and total parts of split WIM. This will be 1 and 1
2462 * if the WIM is standalone. */
2463 wim->hdr.part_number = part_number;
2464 wim->hdr.total_parts = total_parts;
2466 /* Set compression type if different. */
2467 if (wim->compression_type != wim->out_compression_type) {
2468 ret = set_wim_hdr_cflags(wim->out_compression_type, &wim->hdr);
2469 wimlib_assert(ret == 0);
2472 /* Set chunk size if different. */
2473 wim->hdr.chunk_size = wim->out_chunk_size;
2475 /* Use GUID if specified; otherwise generate a new one. */
2477 memcpy(wim->hdr.guid, guid, WIMLIB_GUID_LEN);
2478 else if (!wim->guid_set_explicitly)
2479 randomize_byte_array(wim->hdr.guid, WIMLIB_GUID_LEN);
2481 /* Clear references to resources that have not been written yet. */
2482 zero_reshdr(&wim->hdr.lookup_table_reshdr);
2483 zero_reshdr(&wim->hdr.xml_data_reshdr);
2484 zero_reshdr(&wim->hdr.boot_metadata_reshdr);
2485 zero_reshdr(&wim->hdr.integrity_table_reshdr);
2487 /* Set image count and boot index correctly for single image writes. */
2488 if (image != WIMLIB_ALL_IMAGES) {
2489 wim->hdr.image_count = 1;
2490 if (wim->hdr.boot_idx == image)
2491 wim->hdr.boot_idx = 1;
2493 wim->hdr.boot_idx = 0;
2496 /* Split WIMs can't be bootable. */
2497 if (total_parts != 1)
2498 wim->hdr.boot_idx = 0;
2500 /* Initialize output file descriptor. */
2501 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR) {
2502 /* File descriptor was explicitly provided. Return error if
2503 * file descriptor is not seekable, unless writing a pipable WIM
2505 wim->out_fd.fd = *(const int*)path_or_fd;
2506 wim->out_fd.offset = 0;
2507 if (!filedes_is_seekable(&wim->out_fd)) {
2508 ret = WIMLIB_ERR_INVALID_PARAM;
2509 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2510 goto out_restore_hdr;
2511 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
2512 ERROR("Can't include integrity check when "
2513 "writing pipable WIM to pipe!");
2514 goto out_restore_hdr;
2519 /* Filename of WIM to write was provided; open file descriptor
2521 ret = open_wim_writable(wim, (const tchar*)path_or_fd,
2522 O_TRUNC | O_CREAT | O_RDWR);
2524 goto out_restore_hdr;
2527 /* Write initial header. This is merely a "dummy" header since it
2528 * doesn't have all the information yet, so it will be overwritten later
2529 * (unless writing a pipable WIM). */
2530 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2531 wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2532 ret = write_wim_header(&wim->hdr, &wim->out_fd);
2533 wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2535 goto out_restore_hdr;
2537 /* Write metadata resources and streams. */
2538 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2539 /* Default case: create a normal (non-pipable) WIM. */
2540 ret = write_wim_streams(wim, image, write_flags, num_threads,
2541 progress_func, stream_list_override,
2542 &lookup_table_list);
2544 goto out_restore_hdr;
2546 ret = write_wim_metadata_resources(wim, image, write_flags,
2549 goto out_restore_hdr;
2551 /* Non-default case: create pipable WIM. */
2552 ret = write_pipable_wim(wim, image, write_flags, num_threads,
2553 progress_func, stream_list_override,
2554 &lookup_table_list);
2556 goto out_restore_hdr;
2557 write_flags |= WIMLIB_WRITE_FLAG_HEADER_AT_END;
2561 /* Write lookup table, XML data, and (optional) integrity table. */
2562 ret = finish_write(wim, image, write_flags, progress_func,
2563 &lookup_table_list);
2565 memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
2566 (void)close_wim_writable(wim, write_flags);
2567 DEBUG("ret=%d", ret);
2571 /* Write a standalone WIM to a file or file descriptor. */
2573 write_standalone_wim(WIMStruct *wim, const void *path_or_fd,
2574 int image, int write_flags, unsigned num_threads,
2575 wimlib_progress_func_t progress_func)
2577 return write_wim_part(wim, path_or_fd, image, write_flags,
2578 num_threads, progress_func, 1, 1, NULL, NULL);
2581 /* API function documented in wimlib.h */
2583 wimlib_write(WIMStruct *wim, const tchar *path,
2584 int image, int write_flags, unsigned num_threads,
2585 wimlib_progress_func_t progress_func)
2588 return WIMLIB_ERR_INVALID_PARAM;
2590 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2592 return write_standalone_wim(wim, path, image, write_flags,
2593 num_threads, progress_func);
2596 /* API function documented in wimlib.h */
2598 wimlib_write_to_fd(WIMStruct *wim, int fd,
2599 int image, int write_flags, unsigned num_threads,
2600 wimlib_progress_func_t progress_func)
2603 return WIMLIB_ERR_INVALID_PARAM;
2605 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2606 write_flags |= WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR;
2608 return write_standalone_wim(wim, &fd, image, write_flags,
2609 num_threads, progress_func);
2613 any_images_modified(WIMStruct *wim)
2615 for (int i = 0; i < wim->hdr.image_count; i++)
2616 if (wim->image_metadata[i]->modified)
2622 check_resource_offset(struct wim_lookup_table_entry *lte, void *_wim)
2624 const WIMStruct *wim = _wim;
2625 off_t end_offset = *(const off_t*)wim->private;
2627 if (lte->resource_location == RESOURCE_IN_WIM && lte->rspec->wim == wim &&
2628 lte->rspec->offset_in_wim + lte->rspec->size_in_wim > end_offset)
2629 return WIMLIB_ERR_RESOURCE_ORDER;
2633 /* Make sure no file or metadata resources are located after the XML data (or
2634 * integrity table if present)--- otherwise we can't safely overwrite the WIM in
2635 * place and we return WIMLIB_ERR_RESOURCE_ORDER. */
2637 check_resource_offsets(WIMStruct *wim, off_t end_offset)
2642 wim->private = &end_offset;
2643 ret = for_lookup_table_entry(wim->lookup_table, check_resource_offset, wim);
2647 for (i = 0; i < wim->hdr.image_count; i++) {
2648 ret = check_resource_offset(wim->image_metadata[i]->metadata_lte, wim);
2656 * Overwrite a WIM, possibly appending streams to it.
2658 * A WIM looks like (or is supposed to look like) the following:
2660 * Header (212 bytes)
2661 * Streams and metadata resources (variable size)
2662 * Lookup table (variable size)
2663 * XML data (variable size)
2664 * Integrity table (optional) (variable size)
2666 * If we are not adding any streams or metadata resources, the lookup table is
2667 * unchanged--- so we only need to overwrite the XML data, integrity table, and
2668 * header. This operation is potentially unsafe if the program is abruptly
2669 * terminated while the XML data or integrity table are being overwritten, but
2670 * before the new header has been written. To partially alleviate this problem,
2671 * a special flag (WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) is passed to
2672 * finish_write() to cause a temporary WIM header to be written after the XML
2673 * data has been written. This may prevent the WIM from becoming corrupted if
2674 * the program is terminated while the integrity table is being calculated (but
2675 * no guarantees, due to write re-ordering...).
2677 * If we are adding new streams or images (metadata resources), the lookup table
2678 * needs to be changed, and those streams need to be written. In this case, we
2679 * try to perform a safe update of the WIM file by writing the streams *after*
2680 * the end of the previous WIM, then writing the new lookup table, XML data, and
2681 * (optionally) integrity table following the new streams. This will produce a
2682 * layout like the following:
2684 * Header (212 bytes)
2685 * (OLD) Streams and metadata resources (variable size)
2686 * (OLD) Lookup table (variable size)
2687 * (OLD) XML data (variable size)
2688 * (OLD) Integrity table (optional) (variable size)
2689 * (NEW) Streams and metadata resources (variable size)
2690 * (NEW) Lookup table (variable size)
2691 * (NEW) XML data (variable size)
2692 * (NEW) Integrity table (optional) (variable size)
2694 * At all points, the WIM is valid as nothing points to the new data yet. Then,
2695 * the header is overwritten to point to the new lookup table, XML data, and
2696 * integrity table, to produce the following layout:
2698 * Header (212 bytes)
2699 * Streams and metadata resources (variable size)
2700 * Nothing (variable size)
2701 * More Streams and metadata resources (variable size)
2702 * Lookup table (variable size)
2703 * XML data (variable size)
2704 * Integrity table (optional) (variable size)
2706 * This method allows an image to be appended to a large WIM very quickly, and
2707 * is is crash-safe except in the case of write re-ordering, but the
2708 * disadvantage is that a small hole is left in the WIM where the old lookup
2709 * table, xml data, and integrity table were. (These usually only take up a
2710 * small amount of space compared to the streams, however.)
2713 overwrite_wim_inplace(WIMStruct *wim, int write_flags,
2714 unsigned num_threads,
2715 wimlib_progress_func_t progress_func)
2719 u64 old_lookup_table_end, old_xml_begin, old_xml_end;
2720 struct wim_header hdr_save;
2721 struct list_head stream_list;
2722 struct list_head lookup_table_list;
2723 struct filter_context filter_ctx;
2725 DEBUG("Overwriting `%"TS"' in-place", wim->filename);
2727 /* Set default integrity flag. */
2728 if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2729 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
2730 if (wim_has_integrity_table(wim))
2731 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2733 /* Set default packed flag. */
2734 if (!(write_flags & (WIMLIB_WRITE_FLAG_PACK_STREAMS |
2735 WIMLIB_WRITE_FLAG_NO_PACK_STREAMS)))
2736 if (wim->hdr.wim_version == WIM_VERSION_PACKED_STREAMS)
2737 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2739 /* Set additional flags for overwrite. */
2740 write_flags |= WIMLIB_WRITE_FLAG_OVERWRITE |
2741 WIMLIB_WRITE_FLAG_STREAMS_OK;
2743 /* Make sure that the integrity table (if present) is after the XML
2744 * data, and that there are no stream resources, metadata resources, or
2745 * lookup tables after the XML data. Otherwise, these data would be
2747 old_xml_begin = wim->hdr.xml_data_reshdr.offset_in_wim;
2748 old_xml_end = old_xml_begin + wim->hdr.xml_data_reshdr.size_in_wim;
2749 old_lookup_table_end = wim->hdr.lookup_table_reshdr.offset_in_wim +
2750 wim->hdr.lookup_table_reshdr.size_in_wim;
2751 if (wim->hdr.integrity_table_reshdr.offset_in_wim != 0 &&
2752 wim->hdr.integrity_table_reshdr.offset_in_wim < old_xml_end) {
2753 WARNING("Didn't expect the integrity table to be before the XML data");
2754 return WIMLIB_ERR_RESOURCE_ORDER;
2757 if (old_lookup_table_end > old_xml_begin) {
2758 WARNING("Didn't expect the lookup table to be after the XML data");
2759 return WIMLIB_ERR_RESOURCE_ORDER;
2762 /* Set @old_wim_end, which indicates the point beyond which we don't
2763 * allow any file and metadata resources to appear without returning
2764 * WIMLIB_ERR_RESOURCE_ORDER (due to the fact that we would otherwise
2765 * overwrite these resources). */
2766 if (!wim->deletion_occurred && !any_images_modified(wim)) {
2767 /* If no images have been modified and no images have been
2768 * deleted, a new lookup table does not need to be written. We
2769 * shall write the new XML data and optional integrity table
2770 * immediately after the lookup table. Note that this may
2771 * overwrite an existing integrity table. */
2772 DEBUG("Skipping writing lookup table "
2773 "(no images modified or deleted)");
2774 old_wim_end = old_lookup_table_end;
2775 write_flags |= WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE |
2776 WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML;
2777 } else if (wim->hdr.integrity_table_reshdr.offset_in_wim != 0) {
2778 /* Old WIM has an integrity table; begin writing new streams
2780 old_wim_end = wim->hdr.integrity_table_reshdr.offset_in_wim +
2781 wim->hdr.integrity_table_reshdr.size_in_wim;
2783 /* No existing integrity table; begin writing new streams after
2784 * the old XML data. */
2785 old_wim_end = old_xml_end;
2788 ret = check_resource_offsets(wim, old_wim_end);
2792 ret = prepare_stream_list_for_write(wim, WIMLIB_ALL_IMAGES, write_flags,
2793 &stream_list, &lookup_table_list,
2798 ret = open_wim_writable(wim, wim->filename, O_RDWR);
2802 ret = lock_wim(wim, wim->out_fd.fd);
2806 /* Save original header so it can be restored in case of error */
2807 memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
2809 /* Set WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in header. */
2810 wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2811 ret = write_wim_header_flags(wim->hdr.flags, &wim->out_fd);
2813 ERROR_WITH_ERRNO("Error updating WIM header flags");
2814 goto out_restore_memory_hdr;
2817 if (filedes_seek(&wim->out_fd, old_wim_end) == -1) {
2818 ERROR_WITH_ERRNO("Can't seek to end of WIM");
2819 ret = WIMLIB_ERR_WRITE;
2820 goto out_restore_physical_hdr;
2823 ret = write_stream_list(&stream_list,
2825 write_flags_to_resource_flags(write_flags),
2826 wim->compression_type,
2836 ret = write_wim_metadata_resources(wim, WIMLIB_ALL_IMAGES,
2837 write_flags, progress_func);
2841 write_flags |= WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE;
2842 ret = finish_write(wim, WIMLIB_ALL_IMAGES, write_flags,
2843 progress_func, &lookup_table_list);
2847 goto out_unlock_wim;
2850 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
2851 WARNING("Truncating `%"TS"' to its original size (%"PRIu64" bytes)",
2852 wim->filename, old_wim_end);
2853 /* Return value of ftruncate() is ignored because this is
2854 * already an error path. */
2855 (void)ftruncate(wim->out_fd.fd, old_wim_end);
2857 out_restore_physical_hdr:
2858 (void)write_wim_header_flags(hdr_save.flags, &wim->out_fd);
2859 out_restore_memory_hdr:
2860 memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
2862 (void)close_wim_writable(wim, write_flags);
2864 wim->wim_locked = 0;
2869 overwrite_wim_via_tmpfile(WIMStruct *wim, int write_flags,
2870 unsigned num_threads,
2871 wimlib_progress_func_t progress_func)
2873 size_t wim_name_len;
2876 DEBUG("Overwriting `%"TS"' via a temporary file", wim->filename);
2878 /* Write the WIM to a temporary file in the same directory as the
2880 wim_name_len = tstrlen(wim->filename);
2881 tchar tmpfile[wim_name_len + 10];
2882 tmemcpy(tmpfile, wim->filename, wim_name_len);
2883 randomize_char_array_with_alnum(tmpfile + wim_name_len, 9);
2884 tmpfile[wim_name_len + 9] = T('\0');
2886 ret = wimlib_write(wim, tmpfile, WIMLIB_ALL_IMAGES,
2887 write_flags | WIMLIB_WRITE_FLAG_FSYNC,
2888 num_threads, progress_func);
2896 /* Rename the new WIM file to the original WIM file. Note: on Windows
2897 * this actually calls win32_rename_replacement(), not _wrename(), so
2898 * that removing the existing destination file can be handled. */
2899 DEBUG("Renaming `%"TS"' to `%"TS"'", tmpfile, wim->filename);
2900 ret = trename(tmpfile, wim->filename);
2902 ERROR_WITH_ERRNO("Failed to rename `%"TS"' to `%"TS"'",
2903 tmpfile, wim->filename);
2910 return WIMLIB_ERR_RENAME;
2913 if (progress_func) {
2914 union wimlib_progress_info progress;
2915 progress.rename.from = tmpfile;
2916 progress.rename.to = wim->filename;
2917 progress_func(WIMLIB_PROGRESS_MSG_RENAME, &progress);
2923 can_overwrite_wim_inplace(const WIMStruct *wim, int write_flags)
2925 if (write_flags & WIMLIB_WRITE_FLAG_REBUILD)
2928 if (wim->deletion_occurred && !(write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE))
2931 if (wim_is_pipable(wim) || (write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2934 if (wim->hdr.wim_version != WIM_VERSION_PACKED_STREAMS) {
2935 if (wim->compression_type != wim->out_compression_type)
2937 if (wim->chunk_size != wim->out_chunk_size)
2940 if (write_flags & WIMLIB_WRITE_FLAG_NO_PACK_STREAMS)
2947 /* API function documented in wimlib.h */
2949 wimlib_overwrite(WIMStruct *wim, int write_flags,
2950 unsigned num_threads,
2951 wimlib_progress_func_t progress_func)
2956 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2958 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2959 return WIMLIB_ERR_INVALID_PARAM;
2962 return WIMLIB_ERR_NO_FILENAME;
2964 orig_hdr_flags = wim->hdr.flags;
2965 if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
2966 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
2967 ret = can_modify_wim(wim);
2968 wim->hdr.flags = orig_hdr_flags;
2972 if (can_overwrite_wim_inplace(wim, write_flags)) {
2973 ret = overwrite_wim_inplace(wim, write_flags, num_threads,
2975 if (ret != WIMLIB_ERR_RESOURCE_ORDER)
2977 WARNING("Falling back to re-building entire WIM");
2979 return overwrite_wim_via_tmpfile(wim, write_flags, num_threads,