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/endianness.h"
38 #include "wimlib/error.h"
39 #include "wimlib/file_io.h"
40 #include "wimlib/header.h"
41 #include "wimlib/integrity.h"
42 #include "wimlib/lookup_table.h"
43 #include "wimlib/metadata.h"
44 #include "wimlib/resource.h"
45 #include "wimlib/write.h"
46 #include "wimlib/xml.h"
49 # include "wimlib/win32.h" /* win32_get_number_of_processors() */
52 #ifdef ENABLE_MULTITHREADED_COMPRESSION
68 # include <sys/uio.h> /* for `struct iovec' */
71 /* Return true if the specified resource is compressed and the compressed data
72 * can be reused with the specified output parameters. */
74 can_raw_copy(const struct wim_lookup_table_entry *lte,
75 int write_resource_flags, int out_ctype, u32 out_chunk_size)
77 return (out_ctype == wim_resource_compression_type(lte)
78 && out_chunk_size == wim_resource_chunk_size(lte)
79 && out_ctype != WIMLIB_COMPRESSION_TYPE_NONE);
83 /* Return true if the specified resource must be recompressed when the specified
84 * output parameters are used. */
86 must_compress_stream(const struct wim_lookup_table_entry *lte,
87 int write_resource_flags, int out_ctype, u32 out_chunk_size)
89 return (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE
90 && ((write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS)
91 || !can_raw_copy(lte, write_resource_flags,
92 out_ctype, out_chunk_size)));
96 compress_chunk(const void * uncompressed_data,
97 unsigned uncompressed_len,
98 void *compressed_data,
100 struct wimlib_lzx_context *comp_ctx)
103 case WIMLIB_COMPRESSION_TYPE_XPRESS:
104 return wimlib_xpress_compress(uncompressed_data,
107 case WIMLIB_COMPRESSION_TYPE_LZX:
108 return wimlib_lzx_compress2(uncompressed_data,
118 /* Chunk table that's located at the beginning of each compressed resource in
119 * the WIM. (This is not the on-disk format; the on-disk format just has an
120 * array of offsets.) */
122 u64 original_resource_size;
125 unsigned bytes_per_chunk_entry;
131 /* Beginning of chunk offsets, in either 32-bit or 64-bit little endian
132 * integers, including the first offset of 0, which will not be written.
134 u8 offsets[] _aligned_attribute(8);
137 /* Allocate and initializes a chunk table, then reserve space for it in the
138 * output file unless writing a pipable resource. */
140 begin_wim_resource_chunk_tab(const struct wim_lookup_table_entry *lte,
141 struct filedes *out_fd,
143 struct chunk_table **chunk_tab_ret,
148 unsigned bytes_per_chunk_entry;
150 struct chunk_table *chunk_tab;
153 size = wim_resource_size(lte);
154 num_chunks = DIV_ROUND_UP(size, out_chunk_size);
155 bytes_per_chunk_entry = (size > (1ULL << 32)) ? 8 : 4;
156 alloc_size = sizeof(struct chunk_table) + num_chunks * sizeof(u64);
157 chunk_tab = CALLOC(1, alloc_size);
160 ERROR("Failed to allocate chunk table for %"PRIu64" byte "
162 return WIMLIB_ERR_NOMEM;
164 chunk_tab->num_chunks = num_chunks;
165 chunk_tab->original_resource_size = size;
166 chunk_tab->bytes_per_chunk_entry = bytes_per_chunk_entry;
167 chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry *
169 chunk_tab->cur_offset_p = chunk_tab->offsets;
171 /* We don't know the correct offsets yet; so just write zeroes to
172 * reserve space for the table, so we can go back to it later after
173 * we've written the compressed chunks following it.
175 * Special case: if writing a pipable WIM, compressed resources are in a
176 * modified format (see comment above write_pipable_wim()) and do not
177 * have a chunk table at the beginning, so don't reserve any space for
179 if (!(resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)) {
180 ret = full_write(out_fd, chunk_tab->offsets,
181 chunk_tab->table_disk_size);
183 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
189 *chunk_tab_ret = chunk_tab;
193 /* Add the offset for the next chunk to the chunk table being constructed for a
194 * compressed stream. */
196 chunk_tab_record_chunk(struct chunk_table *chunk_tab, unsigned out_chunk_size)
198 if (chunk_tab->bytes_per_chunk_entry == 4) {
199 *(le32*)chunk_tab->cur_offset_p = cpu_to_le32(chunk_tab->cur_offset_u32);
200 chunk_tab->cur_offset_p = (le32*)chunk_tab->cur_offset_p + 1;
201 chunk_tab->cur_offset_u32 += out_chunk_size;
203 *(le64*)chunk_tab->cur_offset_p = cpu_to_le64(chunk_tab->cur_offset_u64);
204 chunk_tab->cur_offset_p = (le64*)chunk_tab->cur_offset_p + 1;
205 chunk_tab->cur_offset_u64 += out_chunk_size;
209 /* Finishes a WIM chunk table and writes it to the output file at the correct
212 finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab,
213 struct filedes *out_fd,
214 off_t res_start_offset,
215 int write_resource_flags)
219 if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
220 ret = full_write(out_fd,
222 chunk_tab->bytes_per_chunk_entry,
223 chunk_tab->table_disk_size);
225 ret = full_pwrite(out_fd,
227 chunk_tab->bytes_per_chunk_entry,
228 chunk_tab->table_disk_size,
232 ERROR_WITH_ERRNO("Write error");
236 /* Write the header for a stream in a pipable WIM.
239 write_pwm_stream_header(const struct wim_lookup_table_entry *lte,
240 struct filedes *out_fd,
241 int additional_reshdr_flags)
243 struct pwm_stream_hdr stream_hdr;
247 stream_hdr.magic = PWM_STREAM_MAGIC;
248 stream_hdr.uncompressed_size = cpu_to_le64(lte->resource_entry.original_size);
249 if (additional_reshdr_flags & PWM_RESHDR_FLAG_UNHASHED) {
250 zero_out_hash(stream_hdr.hash);
252 wimlib_assert(!lte->unhashed);
253 copy_hash(stream_hdr.hash, lte->hash);
256 reshdr_flags = lte->resource_entry.flags & ~WIM_RESHDR_FLAG_COMPRESSED;
257 reshdr_flags |= additional_reshdr_flags;
258 stream_hdr.flags = cpu_to_le32(reshdr_flags);
259 ret = full_write(out_fd, &stream_hdr, sizeof(stream_hdr));
261 ERROR_WITH_ERRNO("Error writing stream header");
266 seek_and_truncate(struct filedes *out_fd, off_t offset)
268 if (filedes_seek(out_fd, offset) == -1 ||
269 ftruncate(out_fd->fd, offset))
271 ERROR_WITH_ERRNO("Failed to truncate output WIM file");
272 return WIMLIB_ERR_WRITE;
278 finalize_and_check_sha1(SHA_CTX *sha_ctx, struct wim_lookup_table_entry *lte)
280 u8 md[SHA1_HASH_SIZE];
282 sha1_final(md, sha_ctx);
284 copy_hash(lte->hash, md);
285 } else if (!hashes_equal(md, lte->hash)) {
286 ERROR("WIM resource has incorrect hash!");
287 if (lte_filename_valid(lte)) {
288 ERROR("We were reading it from \"%"TS"\"; maybe "
289 "it changed while we were reading it.",
292 return WIMLIB_ERR_INVALID_RESOURCE_HASH;
297 struct write_resource_ctx {
300 struct wimlib_lzx_context *comp_ctx;
301 struct chunk_table *chunk_tab;
302 struct filedes *out_fd;
309 write_resource_cb(const void *chunk, size_t chunk_size, void *_ctx)
311 struct write_resource_ctx *ctx = _ctx;
312 const void *out_chunk;
313 unsigned out_chunk_size;
315 void *compressed_chunk = NULL;
316 unsigned compressed_size;
317 bool compressed_chunk_malloced = false;
318 size_t stack_max = 32768;
321 sha1_update(&ctx->sha_ctx, chunk, chunk_size);
324 out_chunk_size = chunk_size;
325 if (ctx->out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
327 /* Compress the chunk. */
328 if (chunk_size <= stack_max) {
329 compressed_chunk = alloca(chunk_size);
331 compressed_chunk = MALLOC(chunk_size);
332 if (compressed_chunk == NULL)
333 return WIMLIB_ERR_NOMEM;
334 compressed_chunk_malloced = true;
337 compressed_size = compress_chunk(chunk, chunk_size,
341 /* Use compressed data if compression to less than input size
343 if (compressed_size) {
344 out_chunk = compressed_chunk;
345 out_chunk_size = compressed_size;
349 if (ctx->chunk_tab) {
350 /* Update chunk table accounting. */
351 chunk_tab_record_chunk(ctx->chunk_tab, out_chunk_size);
353 /* If writing compressed chunks to a pipable WIM, before the
354 * chunk data write a chunk header that provides the compressed
356 if (ctx->resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
357 struct pwm_chunk_hdr chunk_hdr = {
358 .compressed_size = cpu_to_le32(out_chunk_size),
360 ret = full_write(ctx->out_fd, &chunk_hdr,
367 /* Write the chunk data. */
368 ret = full_write(ctx->out_fd, out_chunk, out_chunk_size);
373 if (compressed_chunk_malloced)
374 FREE(compressed_chunk);
378 ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
379 goto out_free_memory;
383 * write_wim_resource()-
385 * Write a resource to an output WIM.
388 * Lookup table entry for the resource, which could be in another WIM, in
389 * an external file, or in another location.
392 * File descriptor opened to the output WIM.
395 * One of the WIMLIB_COMPRESSION_TYPE_* constants to indicate which
396 * compression algorithm to use.
399 * Compressed chunk size to use.
402 * On success, this is filled in with the offset, flags, compressed size,
403 * and uncompressed size of the resource in the output WIM.
406 * * WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS to force data to be recompressed even
407 * if it could otherwise be copied directly from the input;
408 * * WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE if writing a resource for a pipable WIM
409 * (and the output file descriptor may be a pipe).
412 * Location of LZX compression context pointer, which will be allocated or
413 * updated if needed. (Initialize to NULL.)
415 * Additional notes: The SHA1 message digest of the uncompressed data is
416 * calculated (except when doing a raw copy --- see below). If the @unhashed
417 * flag is set on the lookup table entry, this message digest is simply copied
418 * to it; otherwise, the message digest is compared with the existing one, and
419 * this function will fail if they do not match.
422 write_wim_resource(struct wim_lookup_table_entry *lte,
423 struct filedes *out_fd, int out_ctype,
425 struct resource_entry *out_res_entry,
427 struct wimlib_lzx_context **comp_ctx)
429 struct write_resource_ctx write_ctx;
430 off_t res_start_offset;
435 /* Mask out any irrelevant flags, since this function also uses this
436 * variable to store WIMLIB_READ_RESOURCE flags. */
437 resource_flags &= WIMLIB_WRITE_RESOURCE_MASK;
439 /* Get current position in output WIM. */
440 res_start_offset = out_fd->offset;
442 /* If we are not forcing the data to be recompressed, and the input
443 * resource is located in a WIM with a compression mode compatible with
444 * the output, we can simply copy the compressed data without
445 * recompressing it. This also means we must skip calculating the SHA1,
446 * as we never will see the uncompressed data. */
447 if (can_raw_copy(lte, resource_flags, out_ctype, out_chunk_size)) {
448 /* Normally, for raw copies we can request a RAW_FULL read, but
449 * if we're reading from a pipable resource and writing a
450 * non-pipable resource or vice versa, then a RAW_CHUNKS read
451 * needs to be requested so that the written resource can be
452 * appropriately formatted. However, in neither case is any
453 * actual decompression needed. */
454 if (lte->is_pipable == !!(resource_flags &
455 WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE))
457 resource_flags |= WIMLIB_READ_RESOURCE_FLAG_RAW_FULL;
458 read_size = lte->resource_entry.size;
460 resource_flags |= WIMLIB_READ_RESOURCE_FLAG_RAW_CHUNKS;
461 read_size = lte->resource_entry.original_size;
463 write_ctx.doing_sha = false;
465 write_ctx.doing_sha = true;
466 sha1_init(&write_ctx.sha_ctx);
467 read_size = lte->resource_entry.original_size;
470 /* Set the output compression mode and initialize chunk table if needed.
472 write_ctx.out_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
473 write_ctx.out_chunk_size = out_chunk_size;
474 write_ctx.chunk_tab = NULL;
475 if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
476 wimlib_assert(out_chunk_size > 0);
477 if (!(resource_flags & WIMLIB_READ_RESOURCE_FLAG_RAW)) {
478 /* Compression needed. */
479 write_ctx.out_ctype = out_ctype;
480 if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX) {
481 ret = wimlib_lzx_alloc_context(out_chunk_size,
486 write_ctx.comp_ctx = *comp_ctx;
488 if (!(resource_flags & WIMLIB_READ_RESOURCE_FLAG_RAW_FULL)) {
489 /* Chunk table needed. */
490 ret = begin_wim_resource_chunk_tab(lte, out_fd,
492 &write_ctx.chunk_tab,
499 /* If writing a pipable resource, write the stream header and update
500 * @res_start_offset to be the end of the stream header. */
501 if (resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
502 int reshdr_flags = 0;
503 if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE)
504 reshdr_flags |= WIM_RESHDR_FLAG_COMPRESSED;
505 ret = write_pwm_stream_header(lte, out_fd, reshdr_flags);
507 goto out_free_chunk_tab;
508 res_start_offset = out_fd->offset;
511 /* Write the entire resource by reading the entire resource and feeding
512 * the data through write_resource_cb(). */
513 write_ctx.out_fd = out_fd;
514 write_ctx.resource_flags = resource_flags;
516 if (write_ctx.out_ctype == WIMLIB_COMPRESSION_TYPE_NONE)
517 in_chunk_size = wim_resource_chunk_size(lte);
519 in_chunk_size = out_chunk_size;
520 ret = read_resource_prefix(lte, read_size,
522 in_chunk_size, &write_ctx, resource_flags);
524 goto out_free_chunk_tab;
526 /* Verify SHA1 message digest of the resource, or set the hash for the
528 if (write_ctx.doing_sha) {
529 ret = finalize_and_check_sha1(&write_ctx.sha_ctx, lte);
531 goto out_free_chunk_tab;
534 /* Write chunk table if needed. */
535 if (write_ctx.chunk_tab) {
536 ret = finish_wim_resource_chunk_tab(write_ctx.chunk_tab,
541 goto out_free_chunk_tab;
544 /* Fill in out_res_entry with information about the newly written
546 out_res_entry->size = out_fd->offset - res_start_offset;
547 out_res_entry->flags = lte->resource_entry.flags;
548 if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE)
549 out_res_entry->flags &= ~WIM_RESHDR_FLAG_COMPRESSED;
551 out_res_entry->flags |= WIM_RESHDR_FLAG_COMPRESSED;
552 out_res_entry->offset = res_start_offset;
553 out_res_entry->original_size = wim_resource_size(lte);
555 /* Check for resources compressed to greater than their original size
556 * and write them uncompressed instead. (But never do this if writing
557 * to a pipe, and don't bother if we did a raw copy.) */
558 if (out_res_entry->size > out_res_entry->original_size &&
559 !(resource_flags & (WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE |
560 WIMLIB_READ_RESOURCE_FLAG_RAW)))
562 DEBUG("Compressed %"PRIu64" => %"PRIu64" bytes; "
563 "writing uncompressed instead",
564 out_res_entry->original_size, out_res_entry->size);
565 ret = seek_and_truncate(out_fd, res_start_offset);
567 goto out_free_chunk_tab;
568 out_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
569 FREE(write_ctx.chunk_tab);
570 write_ctx.out_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
571 write_ctx.chunk_tab = NULL;
572 write_ctx.doing_sha = false;
573 goto try_write_again;
575 if (resource_flags & WIMLIB_READ_RESOURCE_FLAG_RAW) {
576 DEBUG("Copied raw compressed data "
577 "(%"PRIu64" => %"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
578 out_res_entry->original_size, out_res_entry->size,
579 out_res_entry->offset, out_res_entry->flags);
580 } else if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
581 DEBUG("Wrote compressed resource "
582 "(%"PRIu64" => %"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
583 out_res_entry->original_size, out_res_entry->size,
584 out_res_entry->offset, out_res_entry->flags);
586 DEBUG("Wrote uncompressed resource "
587 "(%"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
588 out_res_entry->original_size,
589 out_res_entry->offset, out_res_entry->flags);
593 FREE(write_ctx.chunk_tab);
598 /* Like write_wim_resource(), but the resource is specified by a buffer of
599 * uncompressed data rather a lookup table entry. Also writes the SHA1 message
600 * digest of the buffer to @hash_ret if it is non-NULL. */
602 write_wim_resource_from_buffer(const void *buf, size_t buf_size,
603 int reshdr_flags, struct filedes *out_fd,
606 struct resource_entry *out_res_entry,
607 u8 *hash_ret, int write_resource_flags,
608 struct wimlib_lzx_context **comp_ctx)
611 struct wim_lookup_table_entry *lte;
613 /* Set up a temporary lookup table entry to provide to
614 * write_wim_resource(). */
616 lte = new_lookup_table_entry();
618 return WIMLIB_ERR_NOMEM;
620 lte->resource_location = RESOURCE_IN_ATTACHED_BUFFER;
621 lte->attached_buffer = (void*)buf;
622 lte->resource_entry.original_size = buf_size;
623 lte->resource_entry.flags = reshdr_flags;
625 if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
626 sha1_buffer(buf, buf_size, lte->hash);
632 ret = write_wim_resource(lte, out_fd, out_ctype, out_chunk_size,
633 out_res_entry, write_resource_flags, comp_ctx);
637 copy_hash(hash_ret, lte->hash);
640 lte->resource_location = RESOURCE_NONEXISTENT;
641 free_lookup_table_entry(lte);
646 #ifdef ENABLE_MULTITHREADED_COMPRESSION
648 /* Blocking shared queue (solves the producer-consumer problem) */
649 struct shared_queue {
653 unsigned filled_slots;
655 pthread_mutex_t lock;
656 pthread_cond_t msg_avail_cond;
657 pthread_cond_t space_avail_cond;
661 shared_queue_init(struct shared_queue *q, unsigned size)
663 wimlib_assert(size != 0);
664 q->array = CALLOC(sizeof(q->array[0]), size);
671 if (pthread_mutex_init(&q->lock, NULL)) {
672 ERROR_WITH_ERRNO("Failed to initialize mutex");
675 if (pthread_cond_init(&q->msg_avail_cond, NULL)) {
676 ERROR_WITH_ERRNO("Failed to initialize condition variable");
677 goto err_destroy_lock;
679 if (pthread_cond_init(&q->space_avail_cond, NULL)) {
680 ERROR_WITH_ERRNO("Failed to initialize condition variable");
681 goto err_destroy_msg_avail_cond;
684 err_destroy_msg_avail_cond:
685 pthread_cond_destroy(&q->msg_avail_cond);
687 pthread_mutex_destroy(&q->lock);
689 return WIMLIB_ERR_NOMEM;
693 shared_queue_destroy(struct shared_queue *q)
696 pthread_mutex_destroy(&q->lock);
697 pthread_cond_destroy(&q->msg_avail_cond);
698 pthread_cond_destroy(&q->space_avail_cond);
702 shared_queue_put(struct shared_queue *q, void *obj)
704 pthread_mutex_lock(&q->lock);
705 while (q->filled_slots == q->size)
706 pthread_cond_wait(&q->space_avail_cond, &q->lock);
708 q->back = (q->back + 1) % q->size;
709 q->array[q->back] = obj;
712 pthread_cond_broadcast(&q->msg_avail_cond);
713 pthread_mutex_unlock(&q->lock);
717 shared_queue_get(struct shared_queue *q)
721 pthread_mutex_lock(&q->lock);
722 while (q->filled_slots == 0)
723 pthread_cond_wait(&q->msg_avail_cond, &q->lock);
725 obj = q->array[q->front];
726 q->array[q->front] = NULL;
727 q->front = (q->front + 1) % q->size;
730 pthread_cond_broadcast(&q->space_avail_cond);
731 pthread_mutex_unlock(&q->lock);
735 struct compressor_thread_params {
736 struct shared_queue *res_to_compress_queue;
737 struct shared_queue *compressed_res_queue;
739 struct wimlib_lzx_context *comp_ctx;
742 #define MAX_CHUNKS_PER_MSG 2
745 struct wim_lookup_table_entry *lte;
747 u8 *uncompressed_chunks[MAX_CHUNKS_PER_MSG];
748 u8 *compressed_chunks[MAX_CHUNKS_PER_MSG];
749 unsigned uncompressed_chunk_sizes[MAX_CHUNKS_PER_MSG];
750 struct iovec out_chunks[MAX_CHUNKS_PER_MSG];
752 struct list_head list;
758 compress_chunks(struct message *msg, int out_ctype,
759 struct wimlib_lzx_context *comp_ctx)
761 for (unsigned i = 0; i < msg->num_chunks; i++) {
764 len = compress_chunk(msg->uncompressed_chunks[i],
765 msg->uncompressed_chunk_sizes[i],
766 msg->compressed_chunks[i],
773 /* To be written compressed */
774 out_chunk = msg->compressed_chunks[i];
777 /* To be written uncompressed */
778 out_chunk = msg->uncompressed_chunks[i];
779 out_len = msg->uncompressed_chunk_sizes[i];
781 msg->out_chunks[i].iov_base = out_chunk;
782 msg->out_chunks[i].iov_len = out_len;
786 /* Compressor thread routine. This is a lot simpler than the main thread
787 * routine: just repeatedly get a group of chunks from the
788 * res_to_compress_queue, compress them, and put them in the
789 * compressed_res_queue. A NULL pointer indicates that the thread should stop.
792 compressor_thread_proc(void *arg)
794 struct compressor_thread_params *params = arg;
795 struct shared_queue *res_to_compress_queue = params->res_to_compress_queue;
796 struct shared_queue *compressed_res_queue = params->compressed_res_queue;
799 DEBUG("Compressor thread ready");
800 while ((msg = shared_queue_get(res_to_compress_queue)) != NULL) {
801 compress_chunks(msg, params->out_ctype, params->comp_ctx);
802 shared_queue_put(compressed_res_queue, msg);
804 DEBUG("Compressor thread terminating");
807 #endif /* ENABLE_MULTITHREADED_COMPRESSION */
809 struct write_streams_progress_data {
810 wimlib_progress_func_t progress_func;
811 union wimlib_progress_info progress;
812 uint64_t next_progress;
813 WIMStruct *prev_wim_part;
817 do_write_streams_progress(struct write_streams_progress_data *progress_data,
818 struct wim_lookup_table_entry *lte,
819 bool stream_discarded)
821 union wimlib_progress_info *progress = &progress_data->progress;
824 if (stream_discarded) {
825 progress->write_streams.total_bytes -= wim_resource_size(lte);
826 if (progress_data->next_progress != ~(uint64_t)0 &&
827 progress_data->next_progress > progress->write_streams.total_bytes)
829 progress_data->next_progress = progress->write_streams.total_bytes;
832 progress->write_streams.completed_bytes += wim_resource_size(lte);
834 new_wim_part = false;
835 if (lte->resource_location == RESOURCE_IN_WIM &&
836 lte->wim != progress_data->prev_wim_part)
838 if (progress_data->prev_wim_part) {
840 progress->write_streams.completed_parts++;
842 progress_data->prev_wim_part = lte->wim;
844 progress->write_streams.completed_streams++;
845 if (progress_data->progress_func
846 && (progress->write_streams.completed_bytes >= progress_data->next_progress
849 progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
851 if (progress_data->next_progress == progress->write_streams.total_bytes) {
852 progress_data->next_progress = ~(uint64_t)0;
854 progress_data->next_progress =
855 min(progress->write_streams.total_bytes,
856 progress->write_streams.completed_bytes +
857 progress->write_streams.total_bytes / 100);
862 struct serial_write_stream_ctx {
863 struct filedes *out_fd;
866 struct wimlib_lzx_context **comp_ctx;
867 int write_resource_flags;
871 serial_write_stream(struct wim_lookup_table_entry *lte, void *_ctx)
873 struct serial_write_stream_ctx *ctx = _ctx;
874 return write_wim_resource(lte, ctx->out_fd,
877 <e->output_resource_entry,
878 ctx->write_resource_flags,
883 /* Write a list of streams, taking into account that some streams may be
884 * duplicates that are checksummed and discarded on the fly, and also delegating
885 * the actual writing of a stream to a function @write_stream_cb, which is
886 * passed the context @write_stream_ctx. */
888 do_write_stream_list(struct list_head *stream_list,
889 struct wim_lookup_table *lookup_table,
890 int (*write_stream_cb)(struct wim_lookup_table_entry *, void *),
891 void *write_stream_ctx,
892 struct write_streams_progress_data *progress_data)
895 struct wim_lookup_table_entry *lte;
896 bool stream_discarded;
898 /* For each stream in @stream_list ... */
899 while (!list_empty(stream_list)) {
900 stream_discarded = false;
901 lte = container_of(stream_list->next,
902 struct wim_lookup_table_entry,
904 list_del(<e->write_streams_list);
905 if (lte->unhashed && !lte->unique_size) {
906 /* Unhashed stream that shares a size with some other
907 * stream in the WIM we are writing. The stream must be
908 * checksummed to know if we need to write it or not. */
909 struct wim_lookup_table_entry *tmp;
910 u32 orig_out_refcnt = lte->out_refcnt;
912 ret = hash_unhashed_stream(lte, lookup_table, &tmp);
916 /* We found a duplicate stream. 'lte' was
917 * freed, so replace it with the duplicate. */
920 /* 'out_refcnt' was transferred to the
921 * duplicate, and we can detect if the duplicate
922 * stream was already referenced for writing by
923 * checking if its 'out_refcnt' is higher than
924 * that of the original stream. In such cases,
925 * the current stream can be discarded. We can
926 * also discard the current stream if it was
927 * previously marked as filtered (e.g. already
928 * present in the WIM being written). */
929 if (lte->out_refcnt > orig_out_refcnt ||
931 DEBUG("Discarding duplicate stream of "
933 wim_resource_size(lte));
934 lte->no_progress = 0;
935 stream_discarded = true;
936 goto skip_to_progress;
941 /* Here, @lte is either a hashed stream or an unhashed stream
942 * with a unique size. In either case we know that the stream
943 * has to be written. In either case the SHA1 message digest
944 * will be calculated over the stream while writing it; however,
945 * in the former case this is done merely to check the data,
946 * while in the latter case this is done because we do not have
947 * the SHA1 message digest yet. */
948 wimlib_assert(lte->out_refcnt != 0);
950 lte->no_progress = 0;
951 ret = (*write_stream_cb)(lte, write_stream_ctx);
954 /* In parallel mode, some streams are deferred for later,
955 * serialized processing; ignore them here. */
959 list_del(<e->unhashed_list);
960 lookup_table_insert(lookup_table, lte);
964 if (!lte->no_progress) {
965 do_write_streams_progress(progress_data,
966 lte, stream_discarded);
973 do_write_stream_list_serial(struct list_head *stream_list,
974 struct wim_lookup_table *lookup_table,
975 struct filedes *out_fd,
978 struct wimlib_lzx_context **comp_ctx,
979 int write_resource_flags,
980 struct write_streams_progress_data *progress_data)
982 struct serial_write_stream_ctx ctx = {
984 .out_ctype = out_ctype,
985 .out_chunk_size = out_chunk_size,
986 .write_resource_flags = write_resource_flags,
987 .comp_ctx = comp_ctx,
989 return do_write_stream_list(stream_list,
997 write_flags_to_resource_flags(int write_flags)
999 int resource_flags = 0;
1001 if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
1002 resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS;
1003 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
1004 resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE;
1005 return resource_flags;
1009 write_stream_list_serial(struct list_head *stream_list,
1010 struct wim_lookup_table *lookup_table,
1011 struct filedes *out_fd,
1014 struct wimlib_lzx_context **comp_ctx,
1015 int write_resource_flags,
1016 struct write_streams_progress_data *progress_data)
1018 union wimlib_progress_info *progress = &progress_data->progress;
1019 DEBUG("Writing stream list of size %"PRIu64" (serial version)",
1020 progress->write_streams.total_streams);
1021 progress->write_streams.num_threads = 1;
1022 if (progress_data->progress_func) {
1023 progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
1026 return do_write_stream_list_serial(stream_list,
1032 write_resource_flags,
1036 #ifdef ENABLE_MULTITHREADED_COMPRESSION
1038 write_wim_chunks(struct message *msg, struct filedes *out_fd,
1039 struct chunk_table *chunk_tab,
1040 int write_resource_flags)
1043 struct pwm_chunk_hdr *chunk_hdrs;
1047 for (unsigned i = 0; i < msg->num_chunks; i++)
1048 chunk_tab_record_chunk(chunk_tab, msg->out_chunks[i].iov_len);
1050 if (!(write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)) {
1051 nvecs = msg->num_chunks;
1052 vecs = msg->out_chunks;
1054 /* Special case: If writing a compressed resource to a pipable
1055 * WIM, prefix each compressed chunk with a header that gives
1056 * its compressed size. */
1057 nvecs = msg->num_chunks * 2;
1058 vecs = alloca(nvecs * sizeof(vecs[0]));
1059 chunk_hdrs = alloca(msg->num_chunks * sizeof(chunk_hdrs[0]));
1061 for (unsigned i = 0; i < msg->num_chunks; i++) {
1062 chunk_hdrs[i].compressed_size = cpu_to_le32(msg->out_chunks[i].iov_len);
1063 vecs[i * 2].iov_base = &chunk_hdrs[i];
1064 vecs[i * 2].iov_len = sizeof(chunk_hdrs[i]);
1065 vecs[i * 2 + 1].iov_base = msg->out_chunks[i].iov_base;
1066 vecs[i * 2 + 1].iov_len = msg->out_chunks[i].iov_len;
1069 ret = full_writev(out_fd, vecs, nvecs);
1071 ERROR_WITH_ERRNO("Write error");
1075 struct main_writer_thread_ctx {
1076 struct list_head *stream_list;
1077 struct wim_lookup_table *lookup_table;
1078 struct filedes *out_fd;
1079 off_t res_start_offset;
1082 struct wimlib_lzx_context **comp_ctx;
1083 int write_resource_flags;
1084 struct shared_queue *res_to_compress_queue;
1085 struct shared_queue *compressed_res_queue;
1086 size_t num_messages;
1087 struct write_streams_progress_data *progress_data;
1089 struct list_head available_msgs;
1090 struct list_head outstanding_streams;
1091 struct list_head serial_streams;
1092 size_t num_outstanding_messages;
1094 SHA_CTX next_sha_ctx;
1096 u64 next_num_chunks;
1097 struct wim_lookup_table_entry *next_lte;
1099 struct message *msgs;
1100 struct message *next_msg;
1101 struct chunk_table *cur_chunk_tab;
1105 init_message(struct message *msg, u32 out_chunk_size)
1107 msg->out_chunk_size = out_chunk_size;
1108 for (size_t i = 0; i < MAX_CHUNKS_PER_MSG; i++) {
1109 msg->compressed_chunks[i] = MALLOC(out_chunk_size);
1110 msg->uncompressed_chunks[i] = MALLOC(out_chunk_size);
1111 if (msg->compressed_chunks[i] == NULL ||
1112 msg->uncompressed_chunks[i] == NULL)
1113 return WIMLIB_ERR_NOMEM;
1119 destroy_message(struct message *msg)
1121 for (size_t i = 0; i < MAX_CHUNKS_PER_MSG; i++) {
1122 FREE(msg->compressed_chunks[i]);
1123 FREE(msg->uncompressed_chunks[i]);
1128 free_messages(struct message *msgs, size_t num_messages)
1131 for (size_t i = 0; i < num_messages; i++)
1132 destroy_message(&msgs[i]);
1137 static struct message *
1138 allocate_messages(size_t num_messages, u32 out_chunk_size)
1140 struct message *msgs;
1142 msgs = CALLOC(num_messages, sizeof(struct message));
1145 for (size_t i = 0; i < num_messages; i++) {
1146 if (init_message(&msgs[i], out_chunk_size)) {
1147 free_messages(msgs, num_messages);
1155 main_writer_thread_destroy_ctx(struct main_writer_thread_ctx *ctx)
1157 while (ctx->num_outstanding_messages--)
1158 shared_queue_get(ctx->compressed_res_queue);
1159 free_messages(ctx->msgs, ctx->num_messages);
1160 FREE(ctx->cur_chunk_tab);
1164 main_writer_thread_init_ctx(struct main_writer_thread_ctx *ctx)
1166 /* Pre-allocate all the buffers that will be needed to do the chunk
1168 ctx->msgs = allocate_messages(ctx->num_messages, ctx->out_chunk_size);
1169 if (ctx->msgs == NULL)
1170 return WIMLIB_ERR_NOMEM;
1172 /* Initially, all the messages are available to use. */
1173 INIT_LIST_HEAD(&ctx->available_msgs);
1174 for (size_t i = 0; i < ctx->num_messages; i++)
1175 list_add_tail(&ctx->msgs[i].list, &ctx->available_msgs);
1177 /* outstanding_streams is the list of streams that currently have had
1178 * chunks sent off for compression.
1180 * The first stream in outstanding_streams is the stream that is
1181 * currently being written.
1183 * The last stream in outstanding_streams is the stream that is
1184 * currently being read and having chunks fed to the compressor threads.
1186 INIT_LIST_HEAD(&ctx->outstanding_streams);
1187 ctx->num_outstanding_messages = 0;
1189 /* Message currently being prepared. */
1190 ctx->next_msg = NULL;
1192 /* Resources that don't need any chunks compressed are added to this
1193 * list and written directly by the main thread. */
1194 INIT_LIST_HEAD(&ctx->serial_streams);
1196 /* Pointer to chunk table for stream currently being written. */
1197 ctx->cur_chunk_tab = NULL;
1203 receive_compressed_chunks(struct main_writer_thread_ctx *ctx)
1205 struct message *msg;
1206 struct wim_lookup_table_entry *cur_lte;
1209 wimlib_assert(!list_empty(&ctx->outstanding_streams));
1210 wimlib_assert(ctx->num_outstanding_messages != 0);
1212 cur_lte = container_of(ctx->outstanding_streams.next,
1213 struct wim_lookup_table_entry,
1214 being_compressed_list);
1216 /* Get the next message from the queue and process it.
1217 * The message will contain 1 or more data chunks that have been
1219 msg = shared_queue_get(ctx->compressed_res_queue);
1220 msg->complete = true;
1221 --ctx->num_outstanding_messages;
1223 /* Is this the next chunk in the current resource? If it's not (i.e.,
1224 * an earlier chunk in a same or different resource hasn't been
1225 * compressed yet), do nothing, and keep this message around until all
1226 * earlier chunks are received.
1228 * Otherwise, write all the chunks we can. */
1229 while (cur_lte != NULL &&
1230 !list_empty(&cur_lte->msg_list)
1231 && (msg = container_of(cur_lte->msg_list.next,
1235 list_move(&msg->list, &ctx->available_msgs);
1236 if (msg->begin_chunk == 0) {
1237 /* First set of chunks. */
1239 /* Write pipable WIM stream header if needed. */
1240 if (ctx->write_resource_flags &
1241 WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)
1243 ret = write_pwm_stream_header(cur_lte, ctx->out_fd,
1244 WIM_RESHDR_FLAG_COMPRESSED);
1249 /* Save current offset. */
1250 ctx->res_start_offset = ctx->out_fd->offset;
1252 /* Begin building the chunk table, and leave space for
1254 ret = begin_wim_resource_chunk_tab(cur_lte,
1256 ctx->out_chunk_size,
1257 &ctx->cur_chunk_tab,
1258 ctx->write_resource_flags);
1263 /* Write the compressed chunks from the message. */
1264 ret = write_wim_chunks(msg, ctx->out_fd, ctx->cur_chunk_tab,
1265 ctx->write_resource_flags);
1269 /* Was this the last chunk of the stream? If so, finish the
1270 * stream by writing the chunk table. */
1271 if (list_empty(&cur_lte->msg_list) &&
1272 msg->begin_chunk + msg->num_chunks == ctx->cur_chunk_tab->num_chunks)
1276 ret = finish_wim_resource_chunk_tab(ctx->cur_chunk_tab,
1278 ctx->res_start_offset,
1279 ctx->write_resource_flags);
1283 list_del(&cur_lte->being_compressed_list);
1285 res_csize = ctx->out_fd->offset - ctx->res_start_offset;
1287 FREE(ctx->cur_chunk_tab);
1288 ctx->cur_chunk_tab = NULL;
1290 /* Check for resources compressed to greater than or
1291 * equal to their original size and write them
1292 * uncompressed instead. (But never do this if writing
1294 if (res_csize >= wim_resource_size(cur_lte) &&
1295 !(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE))
1297 DEBUG("Compressed %"PRIu64" => %"PRIu64" bytes; "
1298 "writing uncompressed instead",
1299 wim_resource_size(cur_lte), res_csize);
1300 ret = seek_and_truncate(ctx->out_fd, ctx->res_start_offset);
1303 ret = write_wim_resource(cur_lte,
1305 WIMLIB_COMPRESSION_TYPE_NONE,
1307 &cur_lte->output_resource_entry,
1308 ctx->write_resource_flags,
1313 cur_lte->output_resource_entry.size =
1316 cur_lte->output_resource_entry.original_size =
1317 cur_lte->resource_entry.original_size;
1319 cur_lte->output_resource_entry.offset =
1320 ctx->res_start_offset;
1322 cur_lte->output_resource_entry.flags =
1323 cur_lte->resource_entry.flags |
1324 WIM_RESHDR_FLAG_COMPRESSED;
1326 DEBUG("Wrote compressed resource "
1327 "(%"PRIu64" => %"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
1328 cur_lte->output_resource_entry.original_size,
1329 cur_lte->output_resource_entry.size,
1330 cur_lte->output_resource_entry.offset,
1331 cur_lte->output_resource_entry.flags);
1334 do_write_streams_progress(ctx->progress_data,
1337 /* Since we just finished writing a stream, write any
1338 * streams that have been added to the serial_streams
1339 * list for direct writing by the main thread (e.g.
1340 * resources that don't need to be compressed because
1341 * the desired compression type is the same as the
1342 * previous compression type). */
1343 if (!list_empty(&ctx->serial_streams)) {
1344 ret = do_write_stream_list_serial(&ctx->serial_streams,
1348 ctx->out_chunk_size,
1350 ctx->write_resource_flags,
1351 ctx->progress_data);
1356 /* Advance to the next stream to write. */
1357 if (list_empty(&ctx->outstanding_streams)) {
1360 cur_lte = container_of(ctx->outstanding_streams.next,
1361 struct wim_lookup_table_entry,
1362 being_compressed_list);
1369 /* Called when the main thread has read a new chunk of data. */
1371 main_writer_thread_cb(const void *chunk, size_t chunk_size, void *_ctx)
1373 struct main_writer_thread_ctx *ctx = _ctx;
1375 struct message *next_msg;
1376 u64 next_chunk_in_msg;
1378 /* Update SHA1 message digest for the stream currently being read by the
1380 sha1_update(&ctx->next_sha_ctx, chunk, chunk_size);
1382 /* We send chunks of data to the compressor chunks in batches which we
1383 * refer to as "messages". @next_msg is the message that is currently
1384 * being prepared to send off. If it is NULL, that indicates that we
1385 * need to start a new message. */
1386 next_msg = ctx->next_msg;
1388 /* We need to start a new message. First check to see if there
1389 * is a message available in the list of available messages. If
1390 * so, we can just take one. If not, all the messages (there is
1391 * a fixed number of them, proportional to the number of
1392 * threads) have been sent off to the compressor threads, so we
1393 * receive messages from the compressor threads containing
1394 * compressed chunks of data.
1396 * We may need to receive multiple messages before one is
1397 * actually available to use because messages received that are
1398 * *not* for the very next set of chunks to compress must be
1399 * buffered until it's time to write those chunks. */
1400 while (list_empty(&ctx->available_msgs)) {
1401 ret = receive_compressed_chunks(ctx);
1406 next_msg = container_of(ctx->available_msgs.next,
1407 struct message, list);
1408 list_del(&next_msg->list);
1409 next_msg->complete = false;
1410 next_msg->begin_chunk = ctx->next_chunk;
1411 next_msg->num_chunks = min(MAX_CHUNKS_PER_MSG,
1412 ctx->next_num_chunks - ctx->next_chunk);
1413 ctx->next_msg = next_msg;
1416 /* Fill in the next chunk to compress */
1417 next_chunk_in_msg = ctx->next_chunk - next_msg->begin_chunk;
1419 next_msg->uncompressed_chunk_sizes[next_chunk_in_msg] = chunk_size;
1420 memcpy(next_msg->uncompressed_chunks[next_chunk_in_msg],
1423 if (++next_chunk_in_msg == next_msg->num_chunks) {
1424 /* Send off an array of chunks to compress */
1425 list_add_tail(&next_msg->list, &ctx->next_lte->msg_list);
1426 shared_queue_put(ctx->res_to_compress_queue, next_msg);
1427 ++ctx->num_outstanding_messages;
1428 ctx->next_msg = NULL;
1434 main_writer_thread_finish(void *_ctx)
1436 struct main_writer_thread_ctx *ctx = _ctx;
1438 while (ctx->num_outstanding_messages != 0) {
1439 ret = receive_compressed_chunks(ctx);
1443 wimlib_assert(list_empty(&ctx->outstanding_streams));
1444 return do_write_stream_list_serial(&ctx->serial_streams,
1448 ctx->out_chunk_size,
1450 ctx->write_resource_flags,
1451 ctx->progress_data);
1455 submit_stream_for_compression(struct wim_lookup_table_entry *lte,
1456 struct main_writer_thread_ctx *ctx)
1460 /* Read the entire stream @lte, feeding its data chunks to the
1461 * compressor threads. Also SHA1-sum the stream; this is required in
1462 * the case that @lte is unhashed, and a nice additional verification
1463 * when @lte is already hashed. */
1464 sha1_init(&ctx->next_sha_ctx);
1465 ctx->next_chunk = 0;
1466 ctx->next_num_chunks = DIV_ROUND_UP(wim_resource_size(lte),
1467 ctx->out_chunk_size);
1468 ctx->next_lte = lte;
1469 INIT_LIST_HEAD(<e->msg_list);
1470 list_add_tail(<e->being_compressed_list, &ctx->outstanding_streams);
1471 ret = read_resource_prefix(lte, wim_resource_size(lte),
1472 main_writer_thread_cb,
1473 ctx->out_chunk_size, ctx, 0);
1476 wimlib_assert(ctx->next_chunk == ctx->next_num_chunks);
1477 return finalize_and_check_sha1(&ctx->next_sha_ctx, lte);
1481 main_thread_process_next_stream(struct wim_lookup_table_entry *lte, void *_ctx)
1483 struct main_writer_thread_ctx *ctx = _ctx;
1486 if (wim_resource_size(lte) < 1000 ||
1487 !must_compress_stream(lte, ctx->write_resource_flags,
1488 ctx->out_ctype, ctx->out_chunk_size))
1490 /* Stream is too small or isn't being compressed. Process it by
1491 * the main thread when we have a chance. We can't necessarily
1492 * process it right here, as the main thread could be in the
1493 * middle of writing a different stream. */
1494 list_add_tail(<e->write_streams_list, &ctx->serial_streams);
1498 ret = submit_stream_for_compression(lte, ctx);
1500 lte->no_progress = 1;
1505 get_default_num_threads(void)
1508 return win32_get_number_of_processors();
1510 return sysconf(_SC_NPROCESSORS_ONLN);
1514 /* Equivalent to write_stream_list_serial(), except this takes a @num_threads
1515 * parameter and will perform compression using that many threads. Falls
1516 * back to write_stream_list_serial() on certain errors, such as a failure to
1517 * create the number of threads requested.
1519 * High level description of the algorithm for writing compressed streams in
1520 * parallel: We perform compression on chunks rather than on full files. The
1521 * currently executing thread becomes the main thread and is entirely in charge
1522 * of reading the data to compress (which may be in any location understood by
1523 * the resource code--- such as in an external file being captured, or in
1524 * another WIM file from which an image is being exported) and actually writing
1525 * the compressed data to the output file. Additional threads are "compressor
1526 * threads" and all execute the compressor_thread_proc, where they repeatedly
1527 * retrieve buffers of data from the main thread, compress them, and hand them
1528 * back to the main thread.
1530 * Certain streams, such as streams that do not need to be compressed (e.g.
1531 * input compression type same as output compression type) or streams of very
1532 * small size are placed in a list (main_writer_thread_ctx.serial_list) and
1533 * handled entirely by the main thread at an appropriate time.
1535 * At any given point in time, multiple streams may be having chunks compressed
1536 * concurrently. The stream that the main thread is currently *reading* may be
1537 * later in the list that the stream that the main thread is currently
1540 write_stream_list_parallel(struct list_head *stream_list,
1541 struct wim_lookup_table *lookup_table,
1542 struct filedes *out_fd,
1545 struct wimlib_lzx_context **comp_ctx,
1546 int write_resource_flags,
1547 struct write_streams_progress_data *progress_data,
1548 unsigned num_threads)
1551 struct shared_queue res_to_compress_queue;
1552 struct shared_queue compressed_res_queue;
1553 pthread_t *compressor_threads = NULL;
1554 union wimlib_progress_info *progress = &progress_data->progress;
1555 unsigned num_started_threads;
1556 bool can_retry = true;
1558 if (num_threads == 0) {
1559 long nthreads = get_default_num_threads();
1560 if (nthreads < 1 || nthreads > UINT_MAX) {
1561 WARNING("Could not determine number of processors! Assuming 1");
1562 goto out_serial_quiet;
1563 } else if (nthreads == 1) {
1564 goto out_serial_quiet;
1566 num_threads = nthreads;
1570 DEBUG("Writing stream list of size %"PRIu64" "
1571 "(parallel version, num_threads=%u)",
1572 progress->write_streams.total_streams, num_threads);
1574 progress->write_streams.num_threads = num_threads;
1576 static const size_t MESSAGES_PER_THREAD = 2;
1577 size_t queue_size = (size_t)(num_threads * MESSAGES_PER_THREAD);
1579 DEBUG("Initializing shared queues (queue_size=%zu)", queue_size);
1581 ret = shared_queue_init(&res_to_compress_queue, queue_size);
1585 ret = shared_queue_init(&compressed_res_queue, queue_size);
1587 goto out_destroy_res_to_compress_queue;
1589 struct compressor_thread_params *params;
1591 params = CALLOC(num_threads, sizeof(params[0]));
1592 if (params == NULL) {
1593 ret = WIMLIB_ERR_NOMEM;
1594 goto out_destroy_compressed_res_queue;
1597 for (unsigned i = 0; i < num_threads; i++) {
1598 params[i].res_to_compress_queue = &res_to_compress_queue;
1599 params[i].compressed_res_queue = &compressed_res_queue;
1600 params[i].out_ctype = out_ctype;
1601 if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX) {
1602 ret = wimlib_lzx_alloc_context(out_chunk_size,
1603 NULL, ¶ms[i].comp_ctx);
1605 goto out_free_params;
1609 compressor_threads = MALLOC(num_threads * sizeof(pthread_t));
1610 if (compressor_threads == NULL) {
1611 ret = WIMLIB_ERR_NOMEM;
1612 goto out_free_params;
1615 for (unsigned i = 0; i < num_threads; i++) {
1616 DEBUG("pthread_create thread %u of %u", i + 1, num_threads);
1617 ret = pthread_create(&compressor_threads[i], NULL,
1618 compressor_thread_proc, ¶ms[i]);
1622 ERROR_WITH_ERRNO("Failed to create compressor "
1624 i + 1, num_threads);
1625 num_started_threads = i;
1629 num_started_threads = num_threads;
1631 if (progress_data->progress_func) {
1632 progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
1636 struct main_writer_thread_ctx ctx;
1638 memset(&ctx, 0, sizeof(ctx));
1640 ctx.stream_list = stream_list;
1641 ctx.lookup_table = lookup_table;
1642 ctx.out_fd = out_fd;
1643 ctx.out_ctype = out_ctype;
1644 ctx.out_chunk_size = out_chunk_size;
1645 ctx.comp_ctx = comp_ctx;
1646 ctx.res_to_compress_queue = &res_to_compress_queue;
1647 ctx.compressed_res_queue = &compressed_res_queue;
1648 ctx.num_messages = queue_size;
1649 ctx.write_resource_flags = write_resource_flags;
1650 ctx.progress_data = progress_data;
1651 ret = main_writer_thread_init_ctx(&ctx);
1656 ret = do_write_stream_list(stream_list, lookup_table,
1657 main_thread_process_next_stream,
1658 &ctx, progress_data);
1660 goto out_destroy_ctx;
1662 /* The main thread has finished reading all streams that are going to be
1663 * compressed in parallel, and it now needs to wait for all remaining
1664 * chunks to be compressed so that the remaining streams can actually be
1665 * written to the output file. Furthermore, any remaining streams that
1666 * had processing deferred to the main thread need to be handled. These
1667 * tasks are done by the main_writer_thread_finish() function. */
1668 ret = main_writer_thread_finish(&ctx);
1670 main_writer_thread_destroy_ctx(&ctx);
1672 for (unsigned i = 0; i < num_started_threads; i++)
1673 shared_queue_put(&res_to_compress_queue, NULL);
1675 for (unsigned i = 0; i < num_started_threads; i++) {
1676 if (pthread_join(compressor_threads[i], NULL)) {
1677 WARNING_WITH_ERRNO("Failed to join compressor "
1679 i + 1, num_threads);
1682 FREE(compressor_threads);
1684 for (unsigned i = 0; i < num_threads; i++)
1685 wimlib_lzx_free_context(params[i].comp_ctx);
1687 out_destroy_compressed_res_queue:
1688 shared_queue_destroy(&compressed_res_queue);
1689 out_destroy_res_to_compress_queue:
1690 shared_queue_destroy(&res_to_compress_queue);
1691 if (!can_retry || (ret >= 0 && ret != WIMLIB_ERR_NOMEM))
1694 WARNING("Falling back to single-threaded compression");
1696 return write_stream_list_serial(stream_list,
1702 write_resource_flags,
1708 /* Write a list of streams to a WIM (@out_fd) using the compression type
1709 * @out_ctype, chunk size @out_chunk_size, and up to @num_threads compressor
1712 write_stream_list(struct list_head *stream_list,
1713 struct wim_lookup_table *lookup_table,
1714 struct filedes *out_fd, int out_ctype,
1716 struct wimlib_lzx_context **comp_ctx,
1718 unsigned num_threads, wimlib_progress_func_t progress_func)
1721 int write_resource_flags;
1723 u64 total_compression_bytes;
1724 unsigned total_parts;
1725 WIMStruct *prev_wim_part;
1727 struct wim_lookup_table_entry *lte;
1728 struct write_streams_progress_data progress_data;
1730 if (list_empty(stream_list)) {
1731 DEBUG("No streams to write.");
1735 write_resource_flags = write_flags_to_resource_flags(write_flags);
1737 DEBUG("Writing stream list (offset = %"PRIu64", write_resource_flags=0x%08x)",
1738 out_fd->offset, write_resource_flags);
1740 /* Sort the stream list into a good order for reading. */
1741 ret = sort_stream_list_by_sequential_order(stream_list,
1742 offsetof(struct wim_lookup_table_entry,
1743 write_streams_list));
1747 /* Calculate the total size of the streams to be written. Note: this
1748 * will be the uncompressed size, as we may not know the compressed size
1749 * yet, and also this will assume that every unhashed stream will be
1750 * written (which will not necessarily be the case). */
1752 total_compression_bytes = 0;
1755 prev_wim_part = NULL;
1756 list_for_each_entry(lte, stream_list, write_streams_list) {
1758 total_bytes += wim_resource_size(lte);
1759 if (must_compress_stream(lte, write_resource_flags,
1760 out_ctype, out_chunk_size))
1761 total_compression_bytes += wim_resource_size(lte);
1762 if (lte->resource_location == RESOURCE_IN_WIM) {
1763 if (prev_wim_part != lte->wim) {
1764 prev_wim_part = lte->wim;
1770 memset(&progress_data, 0, sizeof(progress_data));
1771 progress_data.progress_func = progress_func;
1773 progress_data.progress.write_streams.total_bytes = total_bytes;
1774 progress_data.progress.write_streams.total_streams = num_streams;
1775 progress_data.progress.write_streams.completed_bytes = 0;
1776 progress_data.progress.write_streams.completed_streams = 0;
1777 progress_data.progress.write_streams.num_threads = num_threads;
1778 progress_data.progress.write_streams.compression_type = out_ctype;
1779 progress_data.progress.write_streams.total_parts = total_parts;
1780 progress_data.progress.write_streams.completed_parts = 0;
1782 progress_data.next_progress = 0;
1783 progress_data.prev_wim_part = NULL;
1785 #ifdef ENABLE_MULTITHREADED_COMPRESSION
1786 if (total_compression_bytes >= 2000000 && num_threads != 1)
1787 ret = write_stream_list_parallel(stream_list,
1793 write_resource_flags,
1798 ret = write_stream_list_serial(stream_list,
1804 write_resource_flags,
1807 DEBUG("Successfully wrote stream list.");
1809 DEBUG("Failed to write stream list (ret=%d).", ret);
1813 struct stream_size_table {
1814 struct hlist_head *array;
1820 init_stream_size_table(struct stream_size_table *tab, size_t capacity)
1822 tab->array = CALLOC(capacity, sizeof(tab->array[0]));
1824 return WIMLIB_ERR_NOMEM;
1825 tab->num_entries = 0;
1826 tab->capacity = capacity;
1831 destroy_stream_size_table(struct stream_size_table *tab)
1837 stream_size_table_insert(struct wim_lookup_table_entry *lte, void *_tab)
1839 struct stream_size_table *tab = _tab;
1841 struct wim_lookup_table_entry *same_size_lte;
1842 struct hlist_node *tmp;
1844 pos = hash_u64(wim_resource_size(lte)) % tab->capacity;
1845 lte->unique_size = 1;
1846 hlist_for_each_entry(same_size_lte, tmp, &tab->array[pos], hash_list_2) {
1847 if (wim_resource_size(same_size_lte) == wim_resource_size(lte)) {
1848 lte->unique_size = 0;
1849 same_size_lte->unique_size = 0;
1854 hlist_add_head(<e->hash_list_2, &tab->array[pos]);
1859 struct find_streams_ctx {
1862 struct list_head stream_list;
1863 struct stream_size_table stream_size_tab;
1867 lte_reference_for_logical_write(struct wim_lookup_table_entry *lte,
1868 struct find_streams_ctx *ctx,
1871 if (lte->out_refcnt == 0) {
1872 stream_size_table_insert(lte, &ctx->stream_size_tab);
1873 list_add_tail(<e->write_streams_list, &ctx->stream_list);
1875 lte->out_refcnt += nref;
1879 do_lte_full_reference_for_logical_write(struct wim_lookup_table_entry *lte,
1882 struct find_streams_ctx *ctx = _ctx;
1883 lte->out_refcnt = 0;
1884 lte_reference_for_logical_write(lte, ctx,
1885 (lte->refcnt ? lte->refcnt : 1));
1890 inode_find_streams_to_write(struct wim_inode *inode,
1891 struct wim_lookup_table *table,
1892 struct find_streams_ctx *ctx)
1894 struct wim_lookup_table_entry *lte;
1897 for (i = 0; i <= inode->i_num_ads; i++) {
1898 lte = inode_stream_lte(inode, i, table);
1900 lte_reference_for_logical_write(lte, ctx, inode->i_nlink);
1901 else if (!is_zero_hash(inode_stream_hash(inode, i)))
1902 return WIMLIB_ERR_RESOURCE_NOT_FOUND;
1908 image_find_streams_to_write(WIMStruct *wim)
1910 struct find_streams_ctx *ctx;
1911 struct wim_image_metadata *imd;
1912 struct wim_inode *inode;
1913 struct wim_lookup_table_entry *lte;
1917 imd = wim_get_current_image_metadata(wim);
1919 image_for_each_unhashed_stream(lte, imd)
1920 lte->out_refcnt = 0;
1922 /* Go through this image's inodes to find any streams that have not been
1924 image_for_each_inode(inode, imd) {
1925 ret = inode_find_streams_to_write(inode, wim->lookup_table, ctx);
1933 * Build a list of streams (via `struct wim_lookup_table_entry's) included in
1934 * the "logical write" of the WIM, meaning all streams that are referenced at
1935 * least once by dentries in the the image(s) being written. 'out_refcnt' on
1936 * each stream being included in the logical write is set to the number of
1937 * references from dentries in the image(s). Furthermore, 'unique_size' on each
1938 * stream being included in the logical write is set to indicate whether that
1939 * stream has a unique size relative to the streams being included in the
1940 * logical write. Still furthermore, 'part_number' on each stream being
1941 * included in the logical write is set to the part number given in the
1942 * in-memory header of @p wim.
1944 * This is considered a "logical write" because it does not take into account
1945 * filtering out streams already present in the WIM (in the case of an in place
1946 * overwrite) or present in other WIMs (in case of creating delta WIM).
1949 prepare_logical_stream_list(WIMStruct *wim, int image, bool streams_ok,
1950 struct find_streams_ctx *ctx)
1953 struct wim_lookup_table_entry *lte;
1955 if (streams_ok && (image == WIMLIB_ALL_IMAGES ||
1956 (image == 1 && wim->hdr.image_count == 1)))
1958 /* Fast case: Assume that all streams are being written and
1959 * that the reference counts are correct. */
1960 struct wim_lookup_table_entry *lte;
1961 struct wim_image_metadata *imd;
1964 for_lookup_table_entry(wim->lookup_table,
1965 do_lte_full_reference_for_logical_write, ctx);
1966 for (i = 0; i < wim->hdr.image_count; i++) {
1967 imd = wim->image_metadata[i];
1968 image_for_each_unhashed_stream(lte, imd)
1969 do_lte_full_reference_for_logical_write(lte, ctx);
1972 /* Slow case: Walk through the images being written and
1973 * determine the streams referenced. */
1974 for_lookup_table_entry(wim->lookup_table, lte_zero_out_refcnt, NULL);
1976 ret = for_image(wim, image, image_find_streams_to_write);
1981 list_for_each_entry(lte, &ctx->stream_list, write_streams_list)
1982 lte->part_number = wim->hdr.part_number;
1987 process_filtered_stream(struct wim_lookup_table_entry *lte, void *_ctx)
1989 struct find_streams_ctx *ctx = _ctx;
1992 /* Calculate and set lte->filtered. */
1993 if (lte->resource_location == RESOURCE_IN_WIM) {
1994 if (lte->wim == ctx->wim &&
1995 (ctx->write_flags & WIMLIB_WRITE_FLAG_OVERWRITE))
1996 filtered |= FILTERED_SAME_WIM;
1997 if (lte->wim != ctx->wim &&
1998 (ctx->write_flags & WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS))
1999 filtered |= FILTERED_EXTERNAL_WIM;
2001 lte->filtered = filtered;
2003 /* Filtered streams get inserted into the stream size table too, unless
2004 * they already were. This is because streams that are checksummed
2005 * on-the-fly during the write should not be written if they are
2006 * duplicates of filtered stream. */
2007 if (lte->filtered && lte->out_refcnt == 0)
2008 stream_size_table_insert(lte, &ctx->stream_size_tab);
2013 mark_stream_not_filtered(struct wim_lookup_table_entry *lte, void *_ignore)
2019 /* Given the list of streams to include in a logical write of a WIM, handle
2020 * filtering out streams already present in the WIM or already present in
2021 * external WIMs, depending on the write flags provided. */
2023 handle_stream_filtering(struct find_streams_ctx *ctx)
2025 struct wim_lookup_table_entry *lte, *tmp;
2027 if (!(ctx->write_flags & (WIMLIB_WRITE_FLAG_OVERWRITE |
2028 WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS)))
2030 for_lookup_table_entry(ctx->wim->lookup_table,
2031 mark_stream_not_filtered, ctx);
2035 for_lookup_table_entry(ctx->wim->lookup_table,
2036 process_filtered_stream, ctx);
2038 /* Streams in logical write list that were filtered can be removed. */
2039 list_for_each_entry_safe(lte, tmp, &ctx->stream_list,
2042 list_del(<e->write_streams_list);
2045 /* Prepares list of streams to write for the specified WIM image(s). This wraps
2046 * around prepare_logical_stream_list() to handle filtering out streams already
2047 * present in the WIM or already present in external WIMs, depending on the
2048 * write flags provided.
2050 * Note: some additional data is stored in each `struct wim_lookup_table_entry':
2052 * - 'out_refcnt' is set to the number of references found for the logical write.
2053 * This will be nonzero on all streams in the list returned by this function,
2054 * but will also be nonzero on streams not in the list that were included in
2055 * the logical write list, but filtered out from the returned list.
2056 * - 'filtered' is set to nonzero if the stream was filtered. Filtered streams
2057 * are not included in the list of streams returned by this function.
2058 * - 'unique_size' is set if the stream has a unique size among all streams in
2059 * the logical write plus any filtered streams in the entire WIM that could
2060 * potentially turn out to have the same checksum as a yet-to-be-checksummed
2061 * stream being written.
2064 prepare_stream_list(WIMStruct *wim, int image, int write_flags,
2065 struct list_head *stream_list)
2069 struct find_streams_ctx ctx;
2071 INIT_LIST_HEAD(&ctx.stream_list);
2072 ret = init_stream_size_table(&ctx.stream_size_tab,
2073 wim->lookup_table->capacity);
2076 ctx.write_flags = write_flags;
2079 streams_ok = ((write_flags & WIMLIB_WRITE_FLAG_STREAMS_OK) != 0);
2081 ret = prepare_logical_stream_list(wim, image, streams_ok, &ctx);
2083 goto out_destroy_table;
2085 handle_stream_filtering(&ctx);
2086 list_transfer(&ctx.stream_list, stream_list);
2089 destroy_stream_size_table(&ctx.stream_size_tab);
2094 write_wim_streams(WIMStruct *wim, int image, int write_flags,
2095 unsigned num_threads,
2096 wimlib_progress_func_t progress_func,
2097 struct list_head *stream_list_override)
2100 struct list_head _stream_list;
2101 struct list_head *stream_list;
2102 struct wim_lookup_table_entry *lte;
2104 if (stream_list_override == NULL) {
2105 /* Normal case: prepare stream list from image(s) being written.
2107 stream_list = &_stream_list;
2108 ret = prepare_stream_list(wim, image, write_flags, stream_list);
2112 /* Currently only as a result of wimlib_split() being called:
2113 * use stream list already explicitly provided. Use existing
2114 * reference counts. */
2115 stream_list = stream_list_override;
2116 list_for_each_entry(lte, stream_list, write_streams_list) {
2117 lte->out_refcnt = (lte->refcnt ? lte->refcnt : 1);
2118 lte->part_number = wim->hdr.part_number;
2122 return write_stream_list(stream_list,
2125 wim->out_compression_type,
2126 wim->out_chunk_size,
2134 write_wim_metadata_resources(WIMStruct *wim, int image, int write_flags,
2135 wimlib_progress_func_t progress_func)
2140 int write_resource_flags;
2142 if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA) {
2143 DEBUG("Not writing any metadata resources.");
2147 write_resource_flags = write_flags_to_resource_flags(write_flags);
2149 DEBUG("Writing metadata resources (offset=%"PRIu64")",
2150 wim->out_fd.offset);
2153 progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, NULL);
2155 if (image == WIMLIB_ALL_IMAGES) {
2157 end_image = wim->hdr.image_count;
2159 start_image = image;
2163 for (int i = start_image; i <= end_image; i++) {
2164 struct wim_image_metadata *imd;
2166 imd = wim->image_metadata[i - 1];
2167 /* Build a new metadata resource only if image was modified from
2168 * the original (or was newly added). Otherwise just copy the
2170 if (imd->modified) {
2171 DEBUG("Image %u was modified; building and writing new "
2172 "metadata resource", i);
2173 ret = write_metadata_resource(wim, i,
2174 write_resource_flags);
2175 } else if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE) {
2176 DEBUG("Image %u was not modified; re-using existing "
2177 "metadata resource.", i);
2178 copy_resource_entry(&imd->metadata_lte->output_resource_entry,
2179 &imd->metadata_lte->resource_entry);
2182 DEBUG("Image %u was not modified; copying existing "
2183 "metadata resource.", i);
2184 ret = write_wim_resource(imd->metadata_lte,
2186 wim->out_compression_type,
2187 wim->out_chunk_size,
2188 &imd->metadata_lte->output_resource_entry,
2189 write_resource_flags,
2196 progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, NULL);
2201 open_wim_writable(WIMStruct *wim, const tchar *path, int open_flags)
2204 DEBUG("Opening \"%"TS"\" for writing.", path);
2206 raw_fd = topen(path, open_flags | O_BINARY, 0644);
2208 ERROR_WITH_ERRNO("Failed to open \"%"TS"\" for writing", path);
2209 return WIMLIB_ERR_OPEN;
2211 filedes_init(&wim->out_fd, raw_fd);
2216 close_wim_writable(WIMStruct *wim, int write_flags)
2220 if (!(write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)) {
2221 DEBUG("Closing WIM file.");
2222 if (filedes_valid(&wim->out_fd))
2223 if (filedes_close(&wim->out_fd))
2224 ret = WIMLIB_ERR_WRITE;
2226 filedes_invalidate(&wim->out_fd);
2233 * Finish writing a WIM file: write the lookup table, xml data, and integrity
2234 * table, then overwrite the WIM header. By default, closes the WIM file
2235 * descriptor (@wim->out_fd) if successful.
2237 * write_flags is a bitwise OR of the following:
2239 * (public) WIMLIB_WRITE_FLAG_CHECK_INTEGRITY:
2240 * Include an integrity table.
2242 * (public) WIMLIB_WRITE_FLAG_FSYNC:
2243 * fsync() the output file before closing it.
2245 * (public) WIMLIB_WRITE_FLAG_PIPABLE:
2246 * Writing a pipable WIM, possibly to a pipe; include pipable WIM
2247 * stream headers before the lookup table and XML data, and also
2248 * write the WIM header at the end instead of seeking to the
2249 * beginning. Can't be combined with
2250 * WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.
2252 * (private) WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE:
2253 * Don't write the lookup table.
2255 * (private) WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE:
2256 * When (if) writing the integrity table, re-use entries from the
2257 * existing integrity table, if possible.
2259 * (private) WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML:
2260 * After writing the XML data but before writing the integrity
2261 * table, write a temporary WIM header and flush the stream so that
2262 * the WIM is less likely to become corrupted upon abrupt program
2264 * (private) WIMLIB_WRITE_FLAG_HEADER_AT_END:
2265 * Instead of overwriting the WIM header at the beginning of the
2266 * file, simply append it to the end of the file. (Used when
2268 * (private) WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR:
2269 * Do not close the file descriptor @wim->out_fd on either success
2271 * (private) WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES:
2272 * Use the existing <TOTALBYTES> stored in the in-memory XML
2273 * information, rather than setting it to the offset of the XML
2274 * data being written.
2277 finish_write(WIMStruct *wim, int image, int write_flags,
2278 wimlib_progress_func_t progress_func,
2279 struct list_head *stream_list_override)
2283 int write_resource_flags;
2284 off_t old_lookup_table_end;
2285 off_t new_lookup_table_end;
2288 DEBUG("image=%d, write_flags=%08x", image, write_flags);
2290 write_resource_flags = write_flags_to_resource_flags(write_flags);
2292 /* In the WIM header, there is room for the resource entry for a
2293 * metadata resource labeled as the "boot metadata". This entry should
2294 * be zeroed out if there is no bootable image (boot_idx 0). Otherwise,
2295 * it should be a copy of the resource entry for the image that is
2296 * marked as bootable. This is not well documented... */
2297 if (wim->hdr.boot_idx == 0) {
2298 zero_resource_entry(&wim->hdr.boot_metadata_res_entry);
2300 copy_resource_entry(&wim->hdr.boot_metadata_res_entry,
2301 &wim->image_metadata[wim->hdr.boot_idx- 1
2302 ]->metadata_lte->output_resource_entry);
2305 /* Write lookup table. (Save old position first.) */
2306 old_lookup_table_end = wim->hdr.lookup_table_res_entry.offset +
2307 wim->hdr.lookup_table_res_entry.size;
2308 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
2309 ret = write_wim_lookup_table(wim, image, write_flags,
2310 &wim->hdr.lookup_table_res_entry,
2311 stream_list_override);
2316 /* Write XML data. */
2317 xml_totalbytes = wim->out_fd.offset;
2318 if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
2319 xml_totalbytes = WIM_TOTALBYTES_USE_EXISTING;
2320 ret = write_wim_xml_data(wim, image, xml_totalbytes,
2321 &wim->hdr.xml_res_entry,
2322 write_resource_flags);
2326 /* Write integrity table (optional). */
2327 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
2328 if (write_flags & WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) {
2329 struct wim_header checkpoint_hdr;
2330 memcpy(&checkpoint_hdr, &wim->hdr, sizeof(struct wim_header));
2331 zero_resource_entry(&checkpoint_hdr.integrity);
2332 checkpoint_hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2333 ret = write_wim_header_at_offset(&checkpoint_hdr,
2339 if (!(write_flags & WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE))
2340 old_lookup_table_end = 0;
2342 new_lookup_table_end = wim->hdr.lookup_table_res_entry.offset +
2343 wim->hdr.lookup_table_res_entry.size;
2345 ret = write_integrity_table(wim,
2346 new_lookup_table_end,
2347 old_lookup_table_end,
2352 /* No integrity table. */
2353 zero_resource_entry(&wim->hdr.integrity);
2356 /* Now that all information in the WIM header has been determined, the
2357 * preliminary header written earlier can be overwritten, the header of
2358 * the existing WIM file can be overwritten, or the final header can be
2359 * written to the end of the pipable WIM. */
2360 wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2362 if (write_flags & WIMLIB_WRITE_FLAG_HEADER_AT_END)
2363 hdr_offset = wim->out_fd.offset;
2364 DEBUG("Writing new header @ %"PRIu64".", hdr_offset);
2365 ret = write_wim_header_at_offset(&wim->hdr, &wim->out_fd, hdr_offset);
2369 /* Possibly sync file data to disk before closing. On POSIX systems, it
2370 * is necessary to do this before using rename() to overwrite an
2371 * existing file with a new file. Otherwise, data loss would occur if
2372 * the system is abruptly terminated when the metadata for the rename
2373 * operation has been written to disk, but the new file data has not.
2375 if (write_flags & WIMLIB_WRITE_FLAG_FSYNC) {
2376 DEBUG("Syncing WIM file.");
2377 if (fsync(wim->out_fd.fd)) {
2378 ERROR_WITH_ERRNO("Error syncing data to WIM file");
2379 return WIMLIB_ERR_WRITE;
2383 if (close_wim_writable(wim, write_flags)) {
2384 ERROR_WITH_ERRNO("Failed to close the output WIM file");
2385 return WIMLIB_ERR_WRITE;
2391 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
2393 lock_wim(WIMStruct *wim, int fd)
2396 if (fd != -1 && !wim->wim_locked) {
2397 ret = flock(fd, LOCK_EX | LOCK_NB);
2399 if (errno == EWOULDBLOCK) {
2400 ERROR("`%"TS"' is already being modified or has been "
2401 "mounted read-write\n"
2402 " by another process!", wim->filename);
2403 ret = WIMLIB_ERR_ALREADY_LOCKED;
2405 WARNING_WITH_ERRNO("Failed to lock `%"TS"'",
2410 wim->wim_locked = 1;
2418 * write_pipable_wim():
2420 * Perform the intermediate stages of creating a "pipable" WIM (i.e. a WIM
2421 * capable of being applied from a pipe).
2423 * Pipable WIMs are a wimlib-specific modification of the WIM format such that
2424 * images can be applied from them sequentially when the file data is sent over
2425 * a pipe. In addition, a pipable WIM can be written sequentially to a pipe.
2426 * The modifications made to the WIM format for pipable WIMs are:
2428 * - Magic characters in header are "WLPWM\0\0\0" (wimlib pipable WIM) instead
2429 * of "MSWIM\0\0\0". This lets wimlib know that the WIM is pipable and also
2430 * stops other software from trying to read the file as a normal WIM.
2432 * - The header at the beginning of the file does not contain all the normal
2433 * information; in particular it will have all 0's for the lookup table and
2434 * XML data resource entries. This is because this information cannot be
2435 * determined until the lookup table and XML data have been written.
2436 * Consequently, wimlib will write the full header at the very end of the
2437 * file. The header at the end, however, is only used when reading the WIM
2438 * from a seekable file (not a pipe).
2440 * - An extra copy of the XML data is placed directly after the header. This
2441 * allows image names and sizes to be determined at an appropriate time when
2442 * reading the WIM from a pipe. This copy of the XML data is ignored if the
2443 * WIM is read from a seekable file (not a pipe).
2445 * - The format of resources, or streams, has been modified to allow them to be
2446 * used before the "lookup table" has been read. Each stream is prefixed with
2447 * a `struct pwm_stream_hdr' that is basically an abbreviated form of `struct
2448 * wim_lookup_table_entry_disk' that only contains the SHA1 message digest,
2449 * uncompressed stream size, and flags that indicate whether the stream is
2450 * compressed. The data of uncompressed streams then follows literally, while
2451 * the data of compressed streams follows in a modified format. Compressed
2452 * streams do not begin with a chunk table, since the chunk table cannot be
2453 * written until all chunks have been compressed. Instead, each compressed
2454 * chunk is prefixed by a `struct pwm_chunk_hdr' that gives its size.
2455 * Furthermore, the chunk table is written at the end of the resource instead
2456 * of the start. Note: chunk offsets are given in the chunk table as if the
2457 * `struct pwm_chunk_hdr's were not present; also, the chunk table is only
2458 * used if the WIM is being read from a seekable file (not a pipe).
2460 * - Metadata resources always come before other file resources (streams).
2461 * (This does not by itself constitute an incompatibility with normal WIMs,
2462 * since this is valid in normal WIMs.)
2464 * - At least up to the end of the file resources, all components must be packed
2465 * as tightly as possible; there cannot be any "holes" in the WIM. (This does
2466 * not by itself consititute an incompatibility with normal WIMs, since this
2467 * is valid in normal WIMs.)
2469 * Note: the lookup table, XML data, and header at the end are not used when
2470 * applying from a pipe. They exist to support functionality such as image
2471 * application and export when the WIM is *not* read from a pipe.
2473 * Layout of pipable WIM:
2475 * ---------+----------+--------------------+----------------+--------------+-----------+--------+
2476 * | Header | XML data | Metadata resources | File resources | Lookup table | XML data | Header |
2477 * ---------+----------+--------------------+----------------+--------------+-----------+--------+
2479 * Layout of normal WIM:
2481 * +--------+-----------------------------+-------------------------+
2482 * | Header | File and metadata resources | Lookup table | XML data |
2483 * +--------+-----------------------------+-------------------------+
2485 * An optional integrity table can follow the final XML data in both normal and
2486 * pipable WIMs. However, due to implementation details, wimlib currently can
2487 * only include an integrity table in a pipable WIM when writing it to a
2488 * seekable file (not a pipe).
2490 * Do note that since pipable WIMs are not supported by Microsoft's software,
2491 * wimlib does not create them unless explicitly requested (with
2492 * WIMLIB_WRITE_FLAG_PIPABLE) and as stated above they use different magic
2493 * characters to identify the file.
2496 write_pipable_wim(WIMStruct *wim, int image, int write_flags,
2497 unsigned num_threads, wimlib_progress_func_t progress_func,
2498 struct list_head *stream_list_override)
2501 struct resource_entry xml_res_entry;
2503 WARNING("Creating a pipable WIM, which will "
2505 " with Microsoft's software (wimgapi/imagex/Dism).");
2507 /* At this point, the header at the beginning of the file has already
2510 /* For efficiency, when wimlib adds an image to the WIM with
2511 * wimlib_add_image(), the SHA1 message digests of files is not
2512 * calculated; instead, they are calculated while the files are being
2513 * written. However, this does not work when writing a pipable WIM,
2514 * since when writing a stream to a pipable WIM, its SHA1 message digest
2515 * needs to be known before the stream data is written. Therefore,
2516 * before getting much farther, we need to pre-calculate the SHA1
2517 * message digests of all streams that will be written. */
2518 ret = wim_checksum_unhashed_streams(wim);
2522 /* Write extra copy of the XML data. */
2523 ret = write_wim_xml_data(wim, image, WIM_TOTALBYTES_OMIT,
2525 WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE);
2529 /* Write metadata resources for the image(s) being included in the
2531 ret = write_wim_metadata_resources(wim, image, write_flags,
2536 /* Write streams needed for the image(s) being included in the output
2537 * WIM, or streams needed for the split WIM part. */
2538 return write_wim_streams(wim, image, write_flags, num_threads,
2539 progress_func, stream_list_override);
2541 /* The lookup table, XML data, and header at end are handled by
2542 * finish_write(). */
2545 /* Write a standalone WIM or split WIM (SWM) part to a new file or to a file
2548 write_wim_part(WIMStruct *wim,
2549 const void *path_or_fd,
2552 unsigned num_threads,
2553 wimlib_progress_func_t progress_func,
2554 unsigned part_number,
2555 unsigned total_parts,
2556 struct list_head *stream_list_override,
2560 struct wim_header hdr_save;
2561 struct list_head lt_stream_list_override;
2563 if (total_parts == 1)
2564 DEBUG("Writing standalone WIM.");
2566 DEBUG("Writing split WIM part %u/%u", part_number, total_parts);
2567 if (image == WIMLIB_ALL_IMAGES)
2568 DEBUG("Including all images.");
2570 DEBUG("Including image %d only.", image);
2571 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2572 DEBUG("File descriptor: %d", *(const int*)path_or_fd);
2574 DEBUG("Path: \"%"TS"\"", (const tchar*)path_or_fd);
2575 DEBUG("Write flags: 0x%08x", write_flags);
2576 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY)
2577 DEBUG("\tCHECK_INTEGRITY");
2578 if (write_flags & WIMLIB_WRITE_FLAG_REBUILD)
2580 if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
2581 DEBUG("\tRECOMPRESS");
2582 if (write_flags & WIMLIB_WRITE_FLAG_FSYNC)
2584 if (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE)
2586 if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
2587 DEBUG("\tIGNORE_READONLY_FLAG");
2588 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
2590 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
2591 DEBUG("\tFILE_DESCRIPTOR");
2592 if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA)
2593 DEBUG("\tNO_METADATA");
2594 if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
2595 DEBUG("\tUSE_EXISTING_TOTALBYTES");
2596 if (num_threads == 0)
2597 DEBUG("Number of threads: autodetect");
2599 DEBUG("Number of threads: %u", num_threads);
2600 DEBUG("Progress function: %s", (progress_func ? "yes" : "no"));
2601 DEBUG("Stream list: %s", (stream_list_override ? "specified" : "autodetect"));
2602 DEBUG("GUID: %s", ((guid || wim->guid_set_explicitly) ?
2603 "specified" : "generate new"));
2605 /* Internally, this is always called with a valid part number and total
2607 wimlib_assert(total_parts >= 1);
2608 wimlib_assert(part_number >= 1 && part_number <= total_parts);
2610 /* A valid image (or all images) must be specified. */
2611 if (image != WIMLIB_ALL_IMAGES &&
2612 (image < 1 || image > wim->hdr.image_count))
2613 return WIMLIB_ERR_INVALID_IMAGE;
2615 /* If we need to write metadata resources, make sure the ::WIMStruct has
2616 * the needed information attached (e.g. is not a resource-only WIM,
2617 * such as a non-first part of a split WIM). */
2618 if (!wim_has_metadata(wim) &&
2619 !(write_flags & WIMLIB_WRITE_FLAG_NO_METADATA))
2620 return WIMLIB_ERR_METADATA_NOT_FOUND;
2622 /* Check for contradictory flags. */
2623 if ((write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2624 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
2625 == (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2626 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
2627 return WIMLIB_ERR_INVALID_PARAM;
2629 if ((write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2630 WIMLIB_WRITE_FLAG_NOT_PIPABLE))
2631 == (WIMLIB_WRITE_FLAG_PIPABLE |
2632 WIMLIB_WRITE_FLAG_NOT_PIPABLE))
2633 return WIMLIB_ERR_INVALID_PARAM;
2635 /* Save previous header, then start initializing the new one. */
2636 memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
2638 /* Set default integrity and pipable flags. */
2639 if (!(write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
2640 WIMLIB_WRITE_FLAG_NOT_PIPABLE)))
2641 if (wim_is_pipable(wim))
2642 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2644 if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2645 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
2646 if (wim_has_integrity_table(wim))
2647 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2649 /* Set appropriate magic number. */
2650 if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
2651 wim->hdr.magic = PWM_MAGIC;
2653 wim->hdr.magic = WIM_MAGIC;
2655 /* Clear header flags that will be set automatically. */
2656 wim->hdr.flags &= ~(WIM_HDR_FLAG_METADATA_ONLY |
2657 WIM_HDR_FLAG_RESOURCE_ONLY |
2658 WIM_HDR_FLAG_SPANNED |
2659 WIM_HDR_FLAG_WRITE_IN_PROGRESS);
2661 /* Set SPANNED header flag if writing part of a split WIM. */
2662 if (total_parts != 1)
2663 wim->hdr.flags |= WIM_HDR_FLAG_SPANNED;
2665 /* Set part number and total parts of split WIM. This will be 1 and 1
2666 * if the WIM is standalone. */
2667 wim->hdr.part_number = part_number;
2668 wim->hdr.total_parts = total_parts;
2670 /* Set compression type if different. */
2671 if (wim->compression_type != wim->out_compression_type) {
2672 ret = set_wim_hdr_cflags(wim->out_compression_type, &wim->hdr);
2673 wimlib_assert(ret == 0);
2676 /* Set chunk size if different. */
2677 wim->hdr.chunk_size = wim->out_chunk_size;
2679 /* Use GUID if specified; otherwise generate a new one. */
2681 memcpy(wim->hdr.guid, guid, WIMLIB_GUID_LEN);
2682 else if (!wim->guid_set_explicitly)
2683 randomize_byte_array(wim->hdr.guid, WIMLIB_GUID_LEN);
2685 /* Clear references to resources that have not been written yet. */
2686 zero_resource_entry(&wim->hdr.lookup_table_res_entry);
2687 zero_resource_entry(&wim->hdr.xml_res_entry);
2688 zero_resource_entry(&wim->hdr.boot_metadata_res_entry);
2689 zero_resource_entry(&wim->hdr.integrity);
2691 /* Set image count and boot index correctly for single image writes. */
2692 if (image != WIMLIB_ALL_IMAGES) {
2693 wim->hdr.image_count = 1;
2694 if (wim->hdr.boot_idx == image)
2695 wim->hdr.boot_idx = 1;
2697 wim->hdr.boot_idx = 0;
2700 /* Split WIMs can't be bootable. */
2701 if (total_parts != 1)
2702 wim->hdr.boot_idx = 0;
2704 /* Initialize output file descriptor. */
2705 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR) {
2706 /* File descriptor was explicitly provided. Return error if
2707 * file descriptor is not seekable, unless writing a pipable WIM
2709 wim->out_fd.fd = *(const int*)path_or_fd;
2710 wim->out_fd.offset = 0;
2711 if (!filedes_is_seekable(&wim->out_fd)) {
2712 ret = WIMLIB_ERR_INVALID_PARAM;
2713 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2714 goto out_restore_hdr;
2715 if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
2716 ERROR("Can't include integrity check when "
2717 "writing pipable WIM to pipe!");
2718 goto out_restore_hdr;
2723 /* Filename of WIM to write was provided; open file descriptor
2725 ret = open_wim_writable(wim, (const tchar*)path_or_fd,
2726 O_TRUNC | O_CREAT | O_RDWR);
2728 goto out_restore_hdr;
2731 /* Write initial header. This is merely a "dummy" header since it
2732 * doesn't have all the information yet, so it will be overwritten later
2733 * (unless writing a pipable WIM). */
2734 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
2735 wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2736 ret = write_wim_header(&wim->hdr, &wim->out_fd);
2737 wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
2739 goto out_restore_hdr;
2741 if (stream_list_override) {
2742 struct wim_lookup_table_entry *lte;
2743 INIT_LIST_HEAD(<_stream_list_override);
2744 list_for_each_entry(lte, stream_list_override,
2747 list_add_tail(<e->lookup_table_list,
2748 <_stream_list_override);
2752 /* Write metadata resources and streams. */
2753 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2754 /* Default case: create a normal (non-pipable) WIM. */
2755 ret = write_wim_streams(wim, image, write_flags, num_threads,
2756 progress_func, stream_list_override);
2758 goto out_restore_hdr;
2760 ret = write_wim_metadata_resources(wim, image, write_flags,
2763 goto out_restore_hdr;
2765 /* Non-default case: create pipable WIM. */
2766 ret = write_pipable_wim(wim, image, write_flags, num_threads,
2767 progress_func, stream_list_override);
2769 goto out_restore_hdr;
2770 write_flags |= WIMLIB_WRITE_FLAG_HEADER_AT_END;
2773 if (stream_list_override)
2774 stream_list_override = <_stream_list_override;
2776 /* Write lookup table, XML data, and (optional) integrity table. */
2777 ret = finish_write(wim, image, write_flags, progress_func,
2778 stream_list_override);
2780 memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
2781 (void)close_wim_writable(wim, write_flags);
2782 DEBUG("ret=%d", ret);
2786 /* Write a standalone WIM to a file or file descriptor. */
2788 write_standalone_wim(WIMStruct *wim, const void *path_or_fd,
2789 int image, int write_flags, unsigned num_threads,
2790 wimlib_progress_func_t progress_func)
2792 return write_wim_part(wim, path_or_fd, image, write_flags,
2793 num_threads, progress_func, 1, 1, NULL, NULL);
2796 /* API function documented in wimlib.h */
2798 wimlib_write(WIMStruct *wim, const tchar *path,
2799 int image, int write_flags, unsigned num_threads,
2800 wimlib_progress_func_t progress_func)
2803 return WIMLIB_ERR_INVALID_PARAM;
2805 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2807 return write_standalone_wim(wim, path, image, write_flags,
2808 num_threads, progress_func);
2811 /* API function documented in wimlib.h */
2813 wimlib_write_to_fd(WIMStruct *wim, int fd,
2814 int image, int write_flags, unsigned num_threads,
2815 wimlib_progress_func_t progress_func)
2818 return WIMLIB_ERR_INVALID_PARAM;
2820 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
2821 write_flags |= WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR;
2823 return write_standalone_wim(wim, &fd, image, write_flags,
2824 num_threads, progress_func);
2828 any_images_modified(WIMStruct *wim)
2830 for (int i = 0; i < wim->hdr.image_count; i++)
2831 if (wim->image_metadata[i]->modified)
2837 check_resource_offset(struct wim_lookup_table_entry *lte, void *_wim)
2839 const WIMStruct *wim = _wim;
2840 off_t end_offset = *(const off_t*)wim->private;
2842 if (lte->resource_location == RESOURCE_IN_WIM && lte->wim == wim &&
2843 lte->resource_entry.offset + lte->resource_entry.size > end_offset)
2844 return WIMLIB_ERR_RESOURCE_ORDER;
2848 /* Make sure no file or metadata resources are located after the XML data (or
2849 * integrity table if present)--- otherwise we can't safely overwrite the WIM in
2850 * place and we return WIMLIB_ERR_RESOURCE_ORDER. */
2852 check_resource_offsets(WIMStruct *wim, off_t end_offset)
2857 wim->private = &end_offset;
2858 ret = for_lookup_table_entry(wim->lookup_table, check_resource_offset, wim);
2862 for (i = 0; i < wim->hdr.image_count; i++) {
2863 ret = check_resource_offset(wim->image_metadata[i]->metadata_lte, wim);
2871 * Overwrite a WIM, possibly appending streams to it.
2873 * A WIM looks like (or is supposed to look like) the following:
2875 * Header (212 bytes)
2876 * Streams and metadata resources (variable size)
2877 * Lookup table (variable size)
2878 * XML data (variable size)
2879 * Integrity table (optional) (variable size)
2881 * If we are not adding any streams or metadata resources, the lookup table is
2882 * unchanged--- so we only need to overwrite the XML data, integrity table, and
2883 * header. This operation is potentially unsafe if the program is abruptly
2884 * terminated while the XML data or integrity table are being overwritten, but
2885 * before the new header has been written. To partially alleviate this problem,
2886 * a special flag (WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) is passed to
2887 * finish_write() to cause a temporary WIM header to be written after the XML
2888 * data has been written. This may prevent the WIM from becoming corrupted if
2889 * the program is terminated while the integrity table is being calculated (but
2890 * no guarantees, due to write re-ordering...).
2892 * If we are adding new streams or images (metadata resources), the lookup table
2893 * needs to be changed, and those streams need to be written. In this case, we
2894 * try to perform a safe update of the WIM file by writing the streams *after*
2895 * the end of the previous WIM, then writing the new lookup table, XML data, and
2896 * (optionally) integrity table following the new streams. This will produce a
2897 * layout like the following:
2899 * Header (212 bytes)
2900 * (OLD) Streams and metadata resources (variable size)
2901 * (OLD) Lookup table (variable size)
2902 * (OLD) XML data (variable size)
2903 * (OLD) Integrity table (optional) (variable size)
2904 * (NEW) Streams and metadata resources (variable size)
2905 * (NEW) Lookup table (variable size)
2906 * (NEW) XML data (variable size)
2907 * (NEW) Integrity table (optional) (variable size)
2909 * At all points, the WIM is valid as nothing points to the new data yet. Then,
2910 * the header is overwritten to point to the new lookup table, XML data, and
2911 * integrity table, to produce the following layout:
2913 * Header (212 bytes)
2914 * Streams and metadata resources (variable size)
2915 * Nothing (variable size)
2916 * More Streams and metadata resources (variable size)
2917 * Lookup table (variable size)
2918 * XML data (variable size)
2919 * Integrity table (optional) (variable size)
2921 * This method allows an image to be appended to a large WIM very quickly, and
2922 * is is crash-safe except in the case of write re-ordering, but the
2923 * disadvantage is that a small hole is left in the WIM where the old lookup
2924 * table, xml data, and integrity table were. (These usually only take up a
2925 * small amount of space compared to the streams, however.)
2928 overwrite_wim_inplace(WIMStruct *wim, int write_flags,
2929 unsigned num_threads,
2930 wimlib_progress_func_t progress_func)
2933 struct list_head stream_list;
2935 u64 old_lookup_table_end, old_xml_begin, old_xml_end;
2936 struct wim_header hdr_save;
2938 DEBUG("Overwriting `%"TS"' in-place", wim->filename);
2940 /* Set default integrity flag. */
2941 if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
2942 WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
2943 if (wim_has_integrity_table(wim))
2944 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2946 /* Set additional flags for overwrite. */
2947 write_flags |= WIMLIB_WRITE_FLAG_OVERWRITE |
2948 WIMLIB_WRITE_FLAG_STREAMS_OK;
2950 /* Make sure that the integrity table (if present) is after the XML
2951 * data, and that there are no stream resources, metadata resources, or
2952 * lookup tables after the XML data. Otherwise, these data would be
2954 old_xml_begin = wim->hdr.xml_res_entry.offset;
2955 old_xml_end = old_xml_begin + wim->hdr.xml_res_entry.size;
2956 old_lookup_table_end = wim->hdr.lookup_table_res_entry.offset +
2957 wim->hdr.lookup_table_res_entry.size;
2958 if (wim->hdr.integrity.offset != 0 && wim->hdr.integrity.offset < old_xml_end) {
2959 WARNING("Didn't expect the integrity table to be before the XML data");
2960 return WIMLIB_ERR_RESOURCE_ORDER;
2963 if (old_lookup_table_end > old_xml_begin) {
2964 WARNING("Didn't expect the lookup table to be after the XML data");
2965 return WIMLIB_ERR_RESOURCE_ORDER;
2968 /* Set @old_wim_end, which indicates the point beyond which we don't
2969 * allow any file and metadata resources to appear without returning
2970 * WIMLIB_ERR_RESOURCE_ORDER (due to the fact that we would otherwise
2971 * overwrite these resources). */
2972 if (!wim->deletion_occurred && !any_images_modified(wim)) {
2973 /* If no images have been modified and no images have been
2974 * deleted, a new lookup table does not need to be written. We
2975 * shall write the new XML data and optional integrity table
2976 * immediately after the lookup table. Note that this may
2977 * overwrite an existing integrity table. */
2978 DEBUG("Skipping writing lookup table "
2979 "(no images modified or deleted)");
2980 old_wim_end = old_lookup_table_end;
2981 write_flags |= WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE |
2982 WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML;
2983 } else if (wim->hdr.integrity.offset) {
2984 /* Old WIM has an integrity table; begin writing new streams
2986 old_wim_end = wim->hdr.integrity.offset + wim->hdr.integrity.size;
2988 /* No existing integrity table; begin writing new streams after
2989 * the old XML data. */
2990 old_wim_end = old_xml_end;
2993 ret = check_resource_offsets(wim, old_wim_end);
2997 ret = prepare_stream_list(wim, WIMLIB_ALL_IMAGES, write_flags,
3002 ret = open_wim_writable(wim, wim->filename, O_RDWR);
3006 ret = lock_wim(wim, wim->out_fd.fd);
3010 /* Save original header so it can be restored in case of error */
3011 memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
3013 /* Set WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in header. */
3014 wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
3015 ret = write_wim_header_flags(wim->hdr.flags, &wim->out_fd);
3017 ERROR_WITH_ERRNO("Error updating WIM header flags");
3018 goto out_restore_memory_hdr;
3021 if (filedes_seek(&wim->out_fd, old_wim_end) == -1) {
3022 ERROR_WITH_ERRNO("Can't seek to end of WIM");
3023 ret = WIMLIB_ERR_WRITE;
3024 goto out_restore_physical_hdr;
3027 ret = write_stream_list(&stream_list,
3030 wim->compression_type,
3039 ret = write_wim_metadata_resources(wim, WIMLIB_ALL_IMAGES,
3040 write_flags, progress_func);
3044 write_flags |= WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE;
3045 ret = finish_write(wim, WIMLIB_ALL_IMAGES, write_flags,
3046 progress_func, NULL);
3050 goto out_unlock_wim;
3053 if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
3054 WARNING("Truncating `%"TS"' to its original size (%"PRIu64" bytes)",
3055 wim->filename, old_wim_end);
3056 /* Return value of ftruncate() is ignored because this is
3057 * already an error path. */
3058 (void)ftruncate(wim->out_fd.fd, old_wim_end);
3060 out_restore_physical_hdr:
3061 (void)write_wim_header_flags(hdr_save.flags, &wim->out_fd);
3062 out_restore_memory_hdr:
3063 memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
3065 (void)close_wim_writable(wim, write_flags);
3067 wim->wim_locked = 0;
3072 overwrite_wim_via_tmpfile(WIMStruct *wim, int write_flags,
3073 unsigned num_threads,
3074 wimlib_progress_func_t progress_func)
3076 size_t wim_name_len;
3079 DEBUG("Overwriting `%"TS"' via a temporary file", wim->filename);
3081 /* Write the WIM to a temporary file in the same directory as the
3083 wim_name_len = tstrlen(wim->filename);
3084 tchar tmpfile[wim_name_len + 10];
3085 tmemcpy(tmpfile, wim->filename, wim_name_len);
3086 randomize_char_array_with_alnum(tmpfile + wim_name_len, 9);
3087 tmpfile[wim_name_len + 9] = T('\0');
3089 ret = wimlib_write(wim, tmpfile, WIMLIB_ALL_IMAGES,
3090 write_flags | WIMLIB_WRITE_FLAG_FSYNC,
3091 num_threads, progress_func);
3099 /* Rename the new WIM file to the original WIM file. Note: on Windows
3100 * this actually calls win32_rename_replacement(), not _wrename(), so
3101 * that removing the existing destination file can be handled. */
3102 DEBUG("Renaming `%"TS"' to `%"TS"'", tmpfile, wim->filename);
3103 ret = trename(tmpfile, wim->filename);
3105 ERROR_WITH_ERRNO("Failed to rename `%"TS"' to `%"TS"'",
3106 tmpfile, wim->filename);
3113 return WIMLIB_ERR_RENAME;
3116 if (progress_func) {
3117 union wimlib_progress_info progress;
3118 progress.rename.from = tmpfile;
3119 progress.rename.to = wim->filename;
3120 progress_func(WIMLIB_PROGRESS_MSG_RENAME, &progress);
3125 /* API function documented in wimlib.h */
3127 wimlib_overwrite(WIMStruct *wim, int write_flags,
3128 unsigned num_threads,
3129 wimlib_progress_func_t progress_func)
3134 write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
3136 if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
3137 return WIMLIB_ERR_INVALID_PARAM;
3140 return WIMLIB_ERR_NO_FILENAME;
3142 orig_hdr_flags = wim->hdr.flags;
3143 if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
3144 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
3145 ret = can_modify_wim(wim);
3146 wim->hdr.flags = orig_hdr_flags;
3150 if ((!wim->deletion_occurred || (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE))
3151 && !(write_flags & (WIMLIB_WRITE_FLAG_REBUILD |
3152 WIMLIB_WRITE_FLAG_PIPABLE))
3153 && !(wim_is_pipable(wim))
3154 && wim->compression_type == wim->out_compression_type
3155 && wim->chunk_size == wim->out_chunk_size)
3157 ret = overwrite_wim_inplace(wim, write_flags, num_threads,
3159 if (ret != WIMLIB_ERR_RESOURCE_ORDER)
3161 WARNING("Falling back to re-building entire WIM");
3163 return overwrite_wim_via_tmpfile(wim, write_flags, num_threads,