X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwrite.c;h=773de0b7b6553e61ead5ef8b726e00f218b54f6a;hp=e48d3c91a8dc95692abc106661c1e56d89eddee9;hb=7c83ef53090441de11cc78d8d26dc337cd7ac475;hpb=e6227e4978dd41e0726ef1b54713089d343b57de diff --git a/src/write.c b/src/write.c index e48d3c91..773de0b7 100644 --- a/src/write.c +++ b/src/write.c @@ -37,9 +37,10 @@ #ifdef ENABLE_MULTITHREADED_COMPRESSION #include #include -#include #endif +#include + #ifdef WITH_NTFS_3G #include #include @@ -54,6 +55,11 @@ #include #endif +#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK) +#include +#endif + + static int do_fflush(FILE *fp) { int ret = fflush(fp); @@ -158,7 +164,7 @@ typedef int (*compress_func_t)(const void *, unsigned, void *, unsigned *); compress_func_t get_compress_func(int out_ctype) { - if (out_ctype == WIM_COMPRESSION_TYPE_LZX) + if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX) return lzx_compress; else return xpress_compress; @@ -358,7 +364,7 @@ int write_wim_resource(struct lookup_table_entry *lte, struct chunk_table *chunk_tab = NULL; bool raw; off_t file_offset; - compress_func_t compress; + compress_func_t compress = NULL; #ifdef WITH_NTFS_3G ntfs_inode *ni = NULL; #endif @@ -382,7 +388,8 @@ int write_wim_resource(struct lookup_table_entry *lte, /* Are the compression types the same? If so, do a raw copy (copy * without decompressing and recompressing the data). */ raw = (wim_resource_compression_type(lte) == out_ctype - && out_ctype != WIM_COMPRESSION_TYPE_NONE); + && out_ctype != WIMLIB_COMPRESSION_TYPE_NONE + && !(flags & WIMLIB_RESOURCE_FLAG_RECOMPRESS)); if (raw) { flags |= WIMLIB_RESOURCE_FLAG_RAW; @@ -401,7 +408,7 @@ int write_wim_resource(struct lookup_table_entry *lte, /* If we are writing a compressed resource and not doing a raw copy, we * need to initialize the chunk table */ - if (out_ctype != WIM_COMPRESSION_TYPE_NONE && !raw) { + if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE && !raw) { ret = begin_wim_resource_chunk_tab(lte, out_fp, file_offset, &chunk_tab); if (ret != 0) @@ -451,7 +458,7 @@ int write_wim_resource(struct lookup_table_entry *lte, /* Raw copy: The new compressed size is the same as the old compressed * size * - * Using WIM_COMPRESSION_TYPE_NONE: The new compressed size is the + * Using WIMLIB_COMPRESSION_TYPE_NONE: The new compressed size is the * original size * * Using a different compression type: Call @@ -461,7 +468,7 @@ int write_wim_resource(struct lookup_table_entry *lte, if (raw) { new_compressed_size = old_compressed_size; } else { - if (out_ctype == WIM_COMPRESSION_TYPE_NONE) + if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE) new_compressed_size = original_size; else { ret = finish_wim_resource_chunk_tab(chunk_tab, out_fp, @@ -493,7 +500,7 @@ int write_wim_resource(struct lookup_table_entry *lte, } if (!raw && new_compressed_size >= original_size && - out_ctype != WIM_COMPRESSION_TYPE_NONE) + out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) { /* Oops! We compressed the resource to larger than the original * size. Write the resource uncompressed instead. */ @@ -503,7 +510,7 @@ int write_wim_resource(struct lookup_table_entry *lte, ret = WIMLIB_ERR_WRITE; goto out_fclose; } - ret = write_wim_resource(lte, out_fp, WIM_COMPRESSION_TYPE_NONE, + ret = write_wim_resource(lte, out_fp, WIMLIB_COMPRESSION_TYPE_NONE, out_res_entry, flags); if (ret != 0) goto out_fclose; @@ -518,7 +525,7 @@ int write_wim_resource(struct lookup_table_entry *lte, out_res_entry->offset = file_offset; out_res_entry->flags = lte->resource_entry.flags & ~WIM_RESHDR_FLAG_COMPRESSED; - if (out_ctype != WIM_COMPRESSION_TYPE_NONE) + if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) out_res_entry->flags |= WIM_RESHDR_FLAG_COMPRESSED; } } @@ -646,62 +653,61 @@ static void *compressor_thread_proc(void *arg) shared_queue_put(compressed_res_queue, msg); } DEBUG("Compressor thread terminating"); + return NULL; } #endif -static void show_stream_write_progress(u64 *cur_size, u64 *next_size, - u64 total_size, u64 one_percent, - unsigned *cur_percent, - const struct lookup_table_entry *cur_lte) -{ - if (*cur_size >= *next_size) { - printf("\r%"PRIu64" MiB of %"PRIu64" MiB " - "(uncompressed) written (%u%% done)", - *cur_size >> 20, - total_size >> 20, *cur_percent); - fflush(stdout); - *next_size += one_percent; - (*cur_percent)++; - } - *cur_size += wim_resource_size(cur_lte); -} - -static void finish_stream_write_progress(u64 total_size) -{ - printf("\r%"PRIu64" MiB of %"PRIu64" MiB " - "(uncompressed) written (100%% done)\n", - total_size >> 20, total_size >> 20); - fflush(stdout); -} - -static int write_stream_list_serial(struct list_head *stream_list, - FILE *out_fp, int out_ctype, - int write_flags, u64 total_size) +static int do_write_stream_list(struct list_head *my_resources, + FILE *out_fp, + int out_ctype, + wimlib_progress_func_t progress_func, + union wimlib_progress_info *progress, + int write_resource_flags) { - struct lookup_table_entry *lte; int ret; - - u64 one_percent = total_size / 100; - u64 cur_size = 0; - u64 next_size = 0; - unsigned cur_percent = 0; - - list_for_each_entry(lte, stream_list, staging_list) { - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) { - show_stream_write_progress(&cur_size, &next_size, - total_size, one_percent, - &cur_percent, lte); - } - ret = write_wim_resource(lte, out_fp, out_ctype, - <e->output_resource_entry, 0); + struct lookup_table_entry *lte, *tmp; + + list_for_each_entry_safe(lte, tmp, my_resources, staging_list) { + ret = write_wim_resource(lte, + out_fp, + out_ctype, + <e->output_resource_entry, + write_resource_flags); if (ret != 0) return ret; + list_del(<e->staging_list); + progress->write_streams.completed_bytes += + wim_resource_size(lte); + progress->write_streams.completed_streams++; + if (progress_func) { + progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS, + progress); + } } - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) - finish_stream_write_progress(total_size); return 0; } +static int write_stream_list_serial(struct list_head *stream_list, + FILE *out_fp, + int out_ctype, + int write_flags, + wimlib_progress_func_t progress_func, + union wimlib_progress_info *progress) +{ + int write_resource_flags; + + if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS) + write_resource_flags = WIMLIB_RESOURCE_FLAG_RECOMPRESS; + else + write_resource_flags = 0; + progress->write_streams.num_threads = 1; + if (progress_func) + progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS, progress); + return do_write_stream_list(stream_list, out_fp, + out_ctype, progress_func, + progress, write_resource_flags); +} + #ifdef ENABLE_MULTITHREADED_COMPRESSION static int write_wim_chunks(struct message *msg, FILE *out_fp, struct chunk_table *chunk_tab) @@ -744,11 +750,11 @@ static int main_writer_thread_proc(struct list_head *stream_list, struct shared_queue *compressed_res_queue, size_t queue_size, int write_flags, - u64 total_size) + wimlib_progress_func_t progress_func, + union wimlib_progress_info *progress) { int ret; - struct message msgs[queue_size]; ZERO_ARRAY(msgs); @@ -794,14 +800,8 @@ static int main_writer_thread_proc(struct list_head *stream_list, struct lookup_table_entry *cur_lte = next_lte; struct chunk_table *cur_chunk_tab = NULL; - struct lookup_table_entry *lte; struct message *msg; - u64 one_percent = total_size / 100; - u64 cur_size = 0; - u64 next_size = 0; - unsigned cur_percent = 0; - #ifdef WITH_NTFS_3G ntfs_inode *ni = NULL; #endif @@ -942,8 +942,9 @@ static int main_writer_thread_proc(struct list_head *stream_list, struct lookup_table_entry, staging_list); next_resource = next_resource->next; - if ((next_lte->resource_location == RESOURCE_IN_WIM - && wimlib_get_compression_type(next_lte->wim) == out_ctype) + if ((!(write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS) + && next_lte->resource_location == RESOURCE_IN_WIM + && wimlib_get_compression_type(next_lte->wim) == out_ctype) || wim_resource_size(next_lte) == 0) { list_add_tail(&next_lte->staging_list, @@ -1003,14 +1004,6 @@ static int main_writer_thread_proc(struct list_head *stream_list, DEBUG2("Complete msg (begin_chunk=%"PRIu64")", msg->begin_chunk); if (msg->begin_chunk == 0) { DEBUG2("Begin chunk tab"); - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) { - show_stream_write_progress(&cur_size, - &next_size, - total_size, - one_percent, - &cur_percent, - cur_lte); - } // This is the first set of chunks. Leave space // for the chunk table in the output file. @@ -1051,6 +1044,14 @@ static int main_writer_thread_proc(struct list_head *stream_list, if (ret != 0) goto out; + progress->write_streams.completed_bytes += + wim_resource_size(cur_lte); + progress->write_streams.completed_streams++; + + if (progress_func) { + progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS, + progress); + } cur_lte->output_resource_entry.size = res_csize; @@ -1088,30 +1089,14 @@ static int main_writer_thread_proc(struct list_head *stream_list, // to be compressed because the desired // compression type is the same as the previous // compression type). - struct lookup_table_entry *tmp; - list_for_each_entry_safe(lte, - tmp, - &my_resources, - staging_list) - { - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) { - show_stream_write_progress(&cur_size, - &next_size, - total_size, - one_percent, - &cur_percent, - lte); - } - - ret = write_wim_resource(lte, - out_fp, - out_ctype, - <e->output_resource_entry, - 0); - list_del(<e->staging_list); - if (ret != 0) - goto out; - } + ret = do_write_stream_list(&my_resources, + out_fp, + out_ctype, + progress_func, + progress, + 0); + if (ret != 0) + goto out; } } } @@ -1123,24 +1108,9 @@ out: end_wim_resource_read(cur_lte); #endif if (ret == 0) { - list_for_each_entry(lte, &my_resources, staging_list) { - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) { - show_stream_write_progress(&cur_size, - &next_size, - total_size, - one_percent, - &cur_percent, - lte); - } - ret = write_wim_resource(lte, out_fp, - out_ctype, - <e->output_resource_entry, - 0); - if (ret != 0) - break; - } - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) - finish_stream_write_progress(total_size); + ret = do_write_stream_list(&my_resources, out_fp, + out_ctype, progress_func, + progress, 0); } else { size_t num_available_msgs = 0; struct list_head *cur; @@ -1155,8 +1125,6 @@ out: } } - DEBUG("Freeing messages"); - for (size_t i = 0; i < ARRAY_LEN(msgs); i++) { for (size_t j = 0; j < MAX_CHUNKS_PER_MSG; j++) { FREE(msgs[i].compressed_chunks[j]); @@ -1170,22 +1138,13 @@ out: } -static const char *get_data_type(int ctype) -{ - switch (ctype) { - case WIM_COMPRESSION_TYPE_NONE: - return "uncompressed"; - case WIM_COMPRESSION_TYPE_LZX: - return "LZX-compressed"; - case WIM_COMPRESSION_TYPE_XPRESS: - return "XPRESS-compressed"; - } -} - static int write_stream_list_parallel(struct list_head *stream_list, - FILE *out_fp, int out_ctype, - int write_flags, u64 total_size, - unsigned num_threads) + FILE *out_fp, + int out_ctype, + int write_flags, + unsigned num_threads, + wimlib_progress_func_t progress_func, + union wimlib_progress_info *progress) { int ret; struct shared_queue res_to_compress_queue; @@ -1202,6 +1161,7 @@ static int write_stream_list_parallel(struct list_head *stream_list, } } + progress->write_streams.num_threads = num_threads; wimlib_assert(stream_list->next != stream_list); static const double MESSAGES_PER_THREAD = 2.0; @@ -1237,10 +1197,8 @@ static int write_stream_list_parallel(struct list_head *stream_list, } } - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) { - printf("Writing %s compressed data using %u threads...\n", - get_data_type(out_ctype), num_threads); - } + if (progress_func) + progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS, progress); ret = main_writer_thread_proc(stream_list, out_fp, @@ -1249,8 +1207,8 @@ static int write_stream_list_parallel(struct list_head *stream_list, &compressed_res_queue, queue_size, write_flags, - total_size); - + progress_func, + progress); out_join: for (unsigned i = 0; i < num_threads; i++) shared_queue_put(&res_to_compress_queue, NULL); @@ -1269,8 +1227,13 @@ out_destroy_res_to_compress_queue: return ret; out_serial: WARNING("Falling back to single-threaded compression"); - return write_stream_list_serial(stream_list, out_fp, - out_ctype, write_flags, total_size); + return write_stream_list_serial(stream_list, + out_fp, + out_ctype, + write_flags, + progress_func, + progress); + } #endif @@ -1280,53 +1243,62 @@ out_serial: */ static int write_stream_list(struct list_head *stream_list, FILE *out_fp, int out_ctype, int write_flags, - unsigned num_threads) + unsigned num_threads, + wimlib_progress_func_t progress_func) { struct lookup_table_entry *lte; size_t num_streams = 0; - u64 total_size = 0; + u64 total_bytes = 0; bool compression_needed = false; + union wimlib_progress_info progress; + int ret; list_for_each_entry(lte, stream_list, staging_list) { num_streams++; - total_size += wim_resource_size(lte); + total_bytes += wim_resource_size(lte); if (!compression_needed - && out_ctype != WIM_COMPRESSION_TYPE_NONE - && (lte->resource_location != RESOURCE_IN_WIM - || wimlib_get_compression_type(lte->wim) != out_ctype) + && + (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE + && (lte->resource_location != RESOURCE_IN_WIM + || wimlib_get_compression_type(lte->wim) != out_ctype + || (write_flags & WIMLIB_WRITE_FLAG_REBUILD))) && wim_resource_size(lte) != 0) compression_needed = true; } - - if (write_flags & WIMLIB_WRITE_FLAG_VERBOSE) { - printf("Preparing to write %zu streams " - "(%"PRIu64" total bytes uncompressed)\n", - num_streams, total_size); - printf("Using compression type %s\n", - wimlib_get_compression_type_string(out_ctype)); + progress.write_streams.total_bytes = total_bytes; + progress.write_streams.total_streams = num_streams; + progress.write_streams.completed_bytes = 0; + progress.write_streams.completed_streams = 0; + progress.write_streams.num_threads = num_threads; + progress.write_streams.compression_type = out_ctype; + + if (num_streams == 0) { + ret = 0; + goto out; } #ifdef ENABLE_MULTITHREADED_COMPRESSION - if (compression_needed && total_size >= 1000000 && num_threads != 1) { - return write_stream_list_parallel(stream_list, out_fp, - out_ctype, write_flags, - total_size, num_threads); + if (compression_needed && total_bytes >= 1000000 && num_threads != 1) { + ret = write_stream_list_parallel(stream_list, + out_fp, + out_ctype, + write_flags, + num_threads, + progress_func, + &progress); } else #endif { - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) { - const char *reason = ""; - if (!compression_needed) - reason = " (no compression needed)"; - printf("Writing %s data using 1 thread%s\n", - get_data_type(out_ctype), reason); - } - - return write_stream_list_serial(stream_list, out_fp, - out_ctype, write_flags, - total_size); + ret = write_stream_list_serial(stream_list, + out_fp, + out_ctype, + write_flags, + progress_func, + &progress); } +out: + return ret; } @@ -1351,7 +1323,8 @@ static int find_streams_to_write(WIMStruct *w) } static int write_wim_streams(WIMStruct *w, int image, int write_flags, - unsigned num_threads) + unsigned num_threads, + wimlib_progress_func_t progress_func) { for_lookup_table_entry(w->lookup_table, lte_zero_out_refcnt, NULL); @@ -1360,22 +1333,41 @@ static int write_wim_streams(WIMStruct *w, int image, int write_flags, for_image(w, image, find_streams_to_write); return write_stream_list(&stream_list, w->out_fp, wimlib_get_compression_type(w), write_flags, - num_threads); + num_threads, progress_func); } /* - * Write the lookup table, xml data, and integrity table, then overwrite the WIM - * header. + * Finish writing a WIM file: write the lookup table, xml data, and integrity + * table (optional), then overwrite the WIM header. + * + * write_flags is a bitwise OR of the following: + * + * (public) WIMLIB_WRITE_FLAG_CHECK_INTEGRITY: + * Include an integrity table. + * + * (public) WIMLIB_WRITE_FLAG_SHOW_PROGRESS: + * Show progress information when (if) writing the integrity table. + * + * (private) WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE: + * Don't write the lookup table. + * + * (private) WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE: + * When (if) writing the integrity table, re-use entries from the + * existing integrity table, if possible. + * + * (private) WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML: + * After writing the XML data but before writing the integrity + * table, write a temporary WIM header and flush the stream so that + * the WIM is less likely to become corrupted upon abrupt program + * termination. + * + * (private) WIMLIB_WRITE_FLAG_FSYNC: + * fsync() the output file before closing it. + * */ -int finish_write(WIMStruct *w, int image, int write_flags) +int finish_write(WIMStruct *w, int image, int write_flags, + wimlib_progress_func_t progress_func) { - off_t lookup_table_offset; - off_t xml_data_offset; - off_t lookup_table_size; - off_t integrity_offset; - off_t xml_data_size; - off_t end_offset; - off_t integrity_size; int ret; struct wim_header hdr; FILE *out = w->out_fp; @@ -1400,11 +1392,46 @@ int finish_write(WIMStruct *w, int image, int write_flags) goto out; if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) { + if (write_flags & WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) { + struct wim_header checkpoint_hdr; + memcpy(&checkpoint_hdr, &hdr, sizeof(struct wim_header)); + memset(&checkpoint_hdr.integrity, 0, sizeof(struct resource_entry)); + if (fseeko(out, 0, SEEK_SET) != 0) { + ret = WIMLIB_ERR_WRITE; + goto out; + } + ret = write_header(&checkpoint_hdr, out); + if (ret != 0) + goto out; + + if (fflush(out) != 0) { + ERROR_WITH_ERRNO("Can't write data to WIM"); + ret = WIMLIB_ERR_WRITE; + goto out; + } + + if (fseeko(out, 0, SEEK_END) != 0) { + ret = WIMLIB_ERR_WRITE; + goto out; + } + } + + off_t old_lookup_table_end; + off_t new_lookup_table_end; + if (write_flags & WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE) { + old_lookup_table_end = w->hdr.lookup_table_res_entry.offset + + w->hdr.lookup_table_res_entry.size; + } else { + old_lookup_table_end = 0; + } + new_lookup_table_end = hdr.lookup_table_res_entry.offset + + hdr.lookup_table_res_entry.size; + ret = write_integrity_table(out, - WIM_HEADER_DISK_SIZE, - hdr.xml_res_entry.offset, - write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS, - &hdr.integrity); + &hdr.integrity, + new_lookup_table_end, + old_lookup_table_end, + progress_func); if (ret != 0) goto out; } else { @@ -1419,7 +1446,7 @@ int finish_write(WIMStruct *w, int image, int write_flags) * marked as bootable. This is not well documented... */ if (hdr.boot_idx == 0 || !w->image_metadata - || (image != WIM_ALL_IMAGES && image != hdr.boot_idx)) { + || (image != WIMLIB_ALL_IMAGES && image != hdr.boot_idx)) { memset(&hdr.boot_metadata_res_entry, 0, sizeof(struct resource_entry)); } else { @@ -1430,7 +1457,7 @@ int finish_write(WIMStruct *w, int image, int write_flags) } /* Set image count and boot index correctly for single image writes */ - if (image != WIM_ALL_IMAGES) { + if (image != WIMLIB_ALL_IMAGES) { hdr.image_count = 1; if (hdr.boot_idx == image) hdr.boot_idx = 1; @@ -1440,8 +1467,6 @@ int finish_write(WIMStruct *w, int image, int write_flags) if (fseeko(out, 0, SEEK_SET) != 0) { ret = WIMLIB_ERR_WRITE; - ERROR_WITH_ERRNO("Failed to seek to beginning of WIM " - "to overwrite header"); goto out; } @@ -1455,10 +1480,8 @@ int finish_write(WIMStruct *w, int image, int write_flags) { ERROR_WITH_ERRNO("Error flushing data to WIM file"); ret = WIMLIB_ERR_WRITE; - goto out; } } - out: if (fclose(out) != 0) { ERROR_WITH_ERRNO("Failed to close the WIM file"); @@ -1469,6 +1492,49 @@ out: return ret; } +static int open_wim_writable(WIMStruct *w, const char *path, + bool trunc, bool readable) +{ + const char *mode; + int ret = 0; + if (trunc) + if (readable) + mode = "w+b"; + else + mode = "wb"; + else + mode = "r+b"; + + DEBUG("Opening `%s' read-write", path); + wimlib_assert(w->out_fp == NULL); + wimlib_assert(path != NULL); + w->out_fp = fopen(path, mode); + if (!w->out_fp) { + ERROR_WITH_ERRNO("Failed to open `%s' for writing", path); + return WIMLIB_ERR_OPEN; + } +#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK) + if (!trunc) { + ret = flock(fileno(w->out_fp), LOCK_EX | LOCK_NB); + if (ret != 0) { + if (errno == EWOULDBLOCK) { + ERROR("`%s' is already being modified " + "by another process", path); + ret = WIMLIB_ERR_ALREADY_LOCKED; + fclose(w->out_fp); + w->out_fp = NULL; + } else { + WARNING("Failed to lock `%s': %s", + path, strerror(errno)); + ret = 0; + } + } + } +#endif + return ret; +} + + static void close_wim_writable(WIMStruct *w) { if (w->out_fp) { @@ -1484,7 +1550,12 @@ static void close_wim_writable(WIMStruct *w) int begin_write(WIMStruct *w, const char *path, int write_flags) { int ret; - ret = open_wim_writable(w, path); + bool need_readable = false; + bool trunc = true; + if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) + need_readable = true; + + ret = open_wim_writable(w, path, trunc, need_readable); if (ret != 0) return ret; /* Write dummy header. It will be overwritten later. */ @@ -1493,16 +1564,17 @@ int begin_write(WIMStruct *w, const char *path, int write_flags) /* Writes a stand-alone WIM to a file. */ WIMLIBAPI int wimlib_write(WIMStruct *w, const char *path, - int image, int write_flags, unsigned num_threads) + int image, int write_flags, unsigned num_threads, + wimlib_progress_func_t progress_func) { int ret; if (!w || !path) return WIMLIB_ERR_INVALID_PARAM; - write_flags &= ~WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE; + write_flags &= WIMLIB_WRITE_MASK_PUBLIC; - if (image != WIM_ALL_IMAGES && + if (image != WIMLIB_ALL_IMAGES && (image < 1 || image > w->hdr.image_count)) return WIMLIB_ERR_INVALID_IMAGE; @@ -1511,29 +1583,26 @@ WIMLIBAPI int wimlib_write(WIMStruct *w, const char *path, return WIMLIB_ERR_SPLIT_UNSUPPORTED; } - if (image == WIM_ALL_IMAGES) - DEBUG("Writing all images to `%s'.", path); - else - DEBUG("Writing image %d to `%s'.", image, path); - ret = begin_write(w, path, write_flags); if (ret != 0) goto out; - ret = write_wim_streams(w, image, write_flags, num_threads); + ret = write_wim_streams(w, image, write_flags, num_threads, + progress_func); if (ret != 0) goto out; - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) - printf("Writing image metadata...\n"); + if (progress_func) + progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, NULL); ret = for_image(w, image, write_metadata_resource); if (ret != 0) goto out; - ret = finish_write(w, image, write_flags); - if (ret == 0 && (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS)) - printf("Successfully wrote `%s'\n", path); + if (progress_func) + progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, NULL); + + ret = finish_write(w, image, write_flags, progress_func); out: close_wim_writable(w); return ret; @@ -1550,11 +1619,11 @@ static int lte_overwrite_prepare(struct lookup_table_entry *lte, static int check_resource_offset(struct lookup_table_entry *lte, void *arg) { - u64 xml_data_offset = *(u64*)arg; + off_t end_offset = *(u64*)arg; wimlib_assert(lte->out_refcnt <= lte->refcnt); if (lte->out_refcnt < lte->refcnt) { - if (lte->resource_entry.offset > xml_data_offset) { + if (lte->resource_entry.offset + lte->resource_entry.size > end_offset) { ERROR("The following resource is after the XML data:"); print_lookup_table_entry(lte); return WIMLIB_ERR_RESOURCE_ORDER; @@ -1565,7 +1634,6 @@ static int check_resource_offset(struct lookup_table_entry *lte, void *arg) static int find_new_streams(struct lookup_table_entry *lte, void *arg) { - wimlib_assert(lte->out_refcnt <= lte->refcnt); if (lte->out_refcnt == lte->refcnt) list_add(<e->staging_list, (struct list_head*)arg); else @@ -1573,8 +1641,66 @@ static int find_new_streams(struct lookup_table_entry *lte, void *arg) return 0; } +/* + * Overwrite a WIM, possibly appending streams to it. + * + * A WIM looks like (or is supposed to look like) the following: + * + * Header (212 bytes) + * Streams and metadata resources (variable size) + * Lookup table (variable size) + * XML data (variable size) + * Integrity table (optional) (variable size) + * + * If we are not adding any streams or metadata resources, the lookup table is + * unchanged--- so we only need to overwrite the XML data, integrity table, and + * header. This operation is potentially unsafe if the program is abruptly + * terminated while the XML data or integrity table are being overwritten, but + * before the new header has been written. To partially alleviate this problem, + * a special flag (WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) is passed to + * finish_write() to cause a temporary WIM header to be written after the XML + * data has been written. This may prevent the WIM from becoming corrupted if + * the program is terminated while the integrity table is being calculated (but + * no guarantees, due to write re-ordering...). + * + * If we are adding new streams or images (metadata resources), the lookup table + * needs to be changed, and those streams need to be written. In this case, we + * try to perform a safe update of the WIM file by writing the streams *after* + * the end of the previous WIM, then writing the new lookup table, XML data, and + * (optionally) integrity table following the new streams. This will produce a + * layout like the following: + * + * Header (212 bytes) + * (OLD) Streams and metadata resources (variable size) + * (OLD) Lookup table (variable size) + * (OLD) XML data (variable size) + * (OLD) Integrity table (optional) (variable size) + * (NEW) Streams and metadata resources (variable size) + * (NEW) Lookup table (variable size) + * (NEW) XML data (variable size) + * (NEW) Integrity table (optional) (variable size) + * + * At all points, the WIM is valid as nothing points to the new data yet. Then, + * the header is overwritten to point to the new lookup table, XML data, and + * integrity table, to produce the following layout: + * + * Header (212 bytes) + * Streams and metadata resources (variable size) + * Nothing (variable size) + * More Streams and metadata resources (variable size) + * Lookup table (variable size) + * XML data (variable size) + * Integrity table (optional) (variable size) + * + * This method allows an image to be appended to a large WIM very quickly, and + * is is crash-safe except in the case of write re-ordering, but the + * disadvantage is that a small hole is left in the WIM where the old lookup + * table, xml data, and integrity table were. (These usually only take up a + * small amount of space compared to the streams, however. + */ static int overwrite_wim_inplace(WIMStruct *w, int write_flags, unsigned num_threads, + wimlib_progress_func_t progress_func, int modified_image_idx) { int ret; @@ -1606,26 +1732,38 @@ static int overwrite_wim_inplace(WIMStruct *w, int write_flags, wimlib_assert(w->image_metadata[i].modified); wimlib_assert(!w->image_metadata[i].has_been_mounted_rw); wimlib_assert(w->image_metadata[i].root_dentry != NULL); + wimlib_assert(w->image_metadata[i].metadata_lte != NULL); w->private = &stream_list; for_dentry_in_tree(w->image_metadata[i].root_dentry, dentry_find_streams_to_write, w); } + if (w->hdr.integrity.offset) + old_wim_end = w->hdr.integrity.offset + w->hdr.integrity.size; + else + old_wim_end = w->hdr.xml_res_entry.offset + w->hdr.xml_res_entry.size; + ret = for_lookup_table_entry(w->lookup_table, check_resource_offset, - &w->hdr.xml_res_entry.offset); + &old_wim_end); if (ret != 0) return ret; + if (modified_image_idx == w->hdr.image_count && !w->deletion_occurred) { + /* If no images have been modified and no images have been + * deleted, a new lookup table does not need to be written. */ + wimlib_assert(list_empty(&stream_list)); + old_wim_end = w->hdr.lookup_table_res_entry.offset + + w->hdr.lookup_table_res_entry.size; + write_flags |= WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE | + WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML; + } + INIT_LIST_HEAD(&stream_list); for_lookup_table_entry(w->lookup_table, find_new_streams, &stream_list); - if (w->hdr.integrity.offset) - old_wim_end = w->hdr.integrity.offset + w->hdr.integrity.size; - else - old_wim_end = w->hdr.xml_res_entry.offset + w->hdr.xml_res_entry.size; - - ret = open_wim_writable(w, w->filename); + ret = open_wim_writable(w, w->filename, false, + (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) != 0); if (ret != 0) return ret; @@ -1639,7 +1777,8 @@ static int overwrite_wim_inplace(WIMStruct *w, int write_flags, old_wim_end); ret = write_stream_list(&stream_list, w->out_fp, wimlib_get_compression_type(w), - write_flags, num_threads); + write_flags, num_threads, + progress_func); if (ret != 0) goto out_ftruncate; } else { @@ -1647,17 +1786,14 @@ static int overwrite_wim_inplace(WIMStruct *w, int write_flags, } for (int i = modified_image_idx; i < w->hdr.image_count; i++) { - wimlib_assert(w->image_metadata[i].modified); - wimlib_assert(!w->image_metadata[i].has_been_mounted_rw); - wimlib_assert(w->image_metadata[i].root_dentry != NULL); - wimlib_assert(w->image_metadata[i].metadata_lte != NULL); - ret = select_wim_image(w, i + 1); - wimlib_assert(ret == 0); + select_wim_image(w, i + 1); ret = write_metadata_resource(w); if (ret != 0) goto out_ftruncate; } - ret = finish_write(w, WIM_ALL_IMAGES, write_flags); + write_flags |= WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE; + ret = finish_write(w, WIMLIB_ALL_IMAGES, write_flags, + progress_func); out_ftruncate: close_wim_writable(w); if (ret != 0) { @@ -1669,12 +1805,13 @@ out_ftruncate: } static int overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags, - unsigned num_threads) + unsigned num_threads, + wimlib_progress_func_t progress_func) { size_t wim_name_len; int ret; - DEBUG("Overwrining `%s' via a temporary file", w->filename); + DEBUG("Overwriting `%s' via a temporary file", w->filename); /* Write the WIM to a temporary file in the same directory as the * original WIM. */ @@ -1684,9 +1821,9 @@ static int overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags, randomize_char_array_with_alnum(tmpfile + wim_name_len, 9); tmpfile[wim_name_len + 9] = '\0'; - ret = wimlib_write(w, tmpfile, WIM_ALL_IMAGES, + ret = wimlib_write(w, tmpfile, WIMLIB_ALL_IMAGES, write_flags | WIMLIB_WRITE_FLAG_FSYNC, - num_threads); + num_threads, progress_func); if (ret != 0) { ERROR("Failed to write the WIM file `%s'", tmpfile); goto err; @@ -1708,8 +1845,12 @@ static int overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags, goto err; } - if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) - printf("Successfully renamed `%s' to `%s'\n", tmpfile, w->filename); + if (progress_func) { + union wimlib_progress_info progress; + progress.rename.from = tmpfile; + progress.rename.to = w->filename; + progress_func(WIMLIB_PROGRESS_MSG_RENAME, &progress); + } /* Re-open the WIM read-only. */ w->fp = fopen(w->filename, "rb"); @@ -1730,14 +1871,14 @@ err: * Writes a WIM file to the original file that it was read from, overwriting it. */ WIMLIBAPI int wimlib_overwrite(WIMStruct *w, int write_flags, - unsigned num_threads) + unsigned num_threads, + wimlib_progress_func_t progress_func) { - int ret; - if (!w) return WIMLIB_ERR_INVALID_PARAM; - write_flags &= ~WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE; + write_flags &= WIMLIB_WRITE_MASK_PUBLIC; + if (!w->filename) return WIMLIB_ERR_NO_FILENAME; @@ -1746,7 +1887,9 @@ WIMLIBAPI int wimlib_overwrite(WIMStruct *w, int write_flags, return WIMLIB_ERR_SPLIT_UNSUPPORTED; } - if (!w->deletion_occurred && !(write_flags & WIMLIB_WRITE_FLAG_REBUILD)) { + if ((!w->deletion_occurred || (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE)) + && !(write_flags & WIMLIB_WRITE_FLAG_REBUILD)) + { int i, modified_image_idx; for (i = 0; i < w->hdr.image_count && !w->image_metadata[i].modified; i++) ; @@ -1754,17 +1897,12 @@ WIMLIBAPI int wimlib_overwrite(WIMStruct *w, int write_flags, for (; i < w->hdr.image_count && w->image_metadata[i].modified && !w->image_metadata[i].has_been_mounted_rw; i++) ; - // XXX - /*if (i == w->hdr.image_count) {*/ - /*return overwrite_wim_inplace(w, write_flags, num_threads,*/ - /*modified_image_idx);*/ - /*}*/ + if (i == w->hdr.image_count) { + return overwrite_wim_inplace(w, write_flags, num_threads, + progress_func, + modified_image_idx); + } } - return overwrite_wim_via_tmpfile(w, write_flags, num_threads); -} - -/* Deprecated */ -WIMLIBAPI int wimlib_overwrite_xml_and_header(WIMStruct *wim, int write_flags) -{ - return wimlib_overwrite(wim, write_flags, 1); + return overwrite_wim_via_tmpfile(w, write_flags, num_threads, + progress_func); }