]> wimlib.net Git - wimlib/blobdiff - src/write.c
overwrite_wim_inplace(): Only write new metadata resources for modified images
[wimlib] / src / write.c
index bd5b05ef1f33e6f34e3325d9b787319d0f26d24d..d985aafee2494b43eca7791cd72e8dd8b6ce9188 100644 (file)
@@ -33,7 +33,7 @@
 #endif
 
 #ifdef __WIN32__
-#  include <win32.h>
+#  include "win32.h"
 #endif
 
 #include "list.h"
@@ -45,6 +45,7 @@
 #include "lzx.h"
 #include "xpress.h"
 
+
 #ifdef ENABLE_MULTITHREADED_COMPRESSION
 #  include <pthread.h>
 #endif
 
 #include <limits.h>
 
+#if defined(__WIN32__) && !defined(INVALID_HANDLE_VALUE)
+#  define INVALID_HANDLE_VALUE ((HANDLE)(-1))
+#endif
+
 static int
 fflush_and_ftruncate(FILE *fp, off_t size)
 {
@@ -146,21 +151,29 @@ out:
 }
 
 /*
- * Pointer to function to compresses a chunk of a WIM resource.
+ * compress_func_t- Pointer to a function to compresses a chunk
+ *                  of a WIM resource.  This may be either xpress_compress()
+ *                  (xpress-compress.c) or lzx_compress() (lzx-compress.c).
+ *
+ * @chunk:       Uncompressed data of the chunk.
+ * @chunk_size:          Size of the uncompressed chunk, in bytes.
+ * @out:         Pointer to output buffer of size at least (@chunk_size - 1) bytes.
  *
- * @chunk:             Uncompressed data of the chunk.
- * @chunk_size:                Size of the uncompressed chunk in bytes.
- * @compressed_chunk:  Pointer to output buffer of size at least
- *                             (@chunk_size - 1) bytes.
- * @compressed_chunk_len_ret:  Pointer to an unsigned int into which the size
- *                                     of the compressed chunk will be
- *                                     returned.
+ * Returns the size of the compressed data written to @out in bytes, or 0 if the
+ * data could not be compressed to (@chunk_size - 1) bytes or fewer.
  *
- * Returns zero if compressed succeeded, and nonzero if the chunk could not be
- * compressed to any smaller than @chunk_size.  This function cannot fail for
- * any other reasons.
+ * As a special requirement, the compression code is optimized for the WIM
+ * format and therefore requires (@chunk_size <= 32768).
+ *
+ * As another special requirement, the compression code will read up to 8 bytes
+ * off the end of the @chunk array for performance reasons.  The values of these
+ * bytes will not affect the output of the compression, but the calling code
+ * must make sure that the buffer holding the uncompressed chunk is actually at
+ * least (@chunk_size + 8) bytes, or at least that these extra bytes are in
+ * mapped memory that will not cause a memory access violation if accessed.
  */
-typedef int (*compress_func_t)(const void *, unsigned, void *, unsigned *);
+typedef unsigned (*compress_func_t)(const void *chunk, unsigned chunk_size,
+                                   void *out);
 
 compress_func_t
 get_compress_func(int out_ctype)
@@ -193,19 +206,20 @@ write_wim_resource_chunk(const u8 chunk[], unsigned chunk_size,
        unsigned out_chunk_size;
        if (chunk_tab) {
                u8 *compressed_chunk = alloca(chunk_size);
-               int ret;
 
-               ret = compress(chunk, chunk_size, compressed_chunk,
-                              &out_chunk_size);
-               if (ret == 0) {
+               out_chunk_size = compress(chunk, chunk_size, compressed_chunk);
+               if (out_chunk_size) {
+                       /* Write compressed */
                        out_chunk = compressed_chunk;
                } else {
+                       /* Write uncompressed */
                        out_chunk = chunk;
                        out_chunk_size = chunk_size;
                }
                *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
                chunk_tab->cur_offset += out_chunk_size;
        } else {
+               /* Write uncompressed */
                out_chunk = chunk;
                out_chunk_size = chunk_size;
        }
@@ -270,10 +284,10 @@ prepare_resource_for_read(struct wim_lookup_table_entry *lte
        switch (lte->resource_location) {
        case RESOURCE_IN_FILE_ON_DISK:
                if (!lte->file_on_disk_fp) {
-                       lte->file_on_disk_fp = fopen(lte->file_on_disk, "rb");
+                       lte->file_on_disk_fp = tfopen(lte->file_on_disk, T("rb"));
                        if (!lte->file_on_disk_fp) {
                                ERROR_WITH_ERRNO("Failed to open the file "
-                                                "`%s'", lte->file_on_disk);
+                                                "`%"TS"'", lte->file_on_disk);
                                return WIMLIB_ERR_OPEN;
                        }
                }
@@ -286,7 +300,7 @@ prepare_resource_for_read(struct wim_lookup_table_entry *lte
                        wimlib_assert(loc);
                        ni = ntfs_pathname_to_inode(*loc->ntfs_vol_p, NULL, loc->path);
                        if (!ni) {
-                               ERROR_WITH_ERRNO("Failed to open inode `%s' in NTFS "
+                               ERROR_WITH_ERRNO("Failed to open inode `%"TS"' in NTFS "
                                                 "volume", loc->path);
                                return WIMLIB_ERR_NTFS_3G;
                        }
@@ -295,7 +309,7 @@ prepare_resource_for_read(struct wim_lookup_table_entry *lte
                                                   loc->stream_name,
                                                   loc->stream_name_nchars);
                        if (!lte->attr) {
-                               ERROR_WITH_ERRNO("Failed to open attribute of `%s' in "
+                               ERROR_WITH_ERRNO("Failed to open attribute of `%"TS"' in "
                                                 "NTFS volume", loc->path);
                                ntfs_inode_close(ni);
                                return WIMLIB_ERR_NTFS_3G;
@@ -306,10 +320,14 @@ prepare_resource_for_read(struct wim_lookup_table_entry *lte
 #endif
 #ifdef __WIN32__
        case RESOURCE_WIN32:
-               if (!lte->file_on_disk_fp) {
-                       lte->file_on_disk_fp = win32_open_file_readonly(lte->file_on_disk);
-                       if (!lte->file_on_disk_fp)
+               if (lte->win32_file_on_disk_fp == INVALID_HANDLE_VALUE) {
+                       lte->win32_file_on_disk_fp =
+                               win32_open_file_data_only(lte->file_on_disk);
+                       if (lte->win32_file_on_disk_fp == INVALID_HANDLE_VALUE) {
+                               ERROR("Win32 API: Can't open %"TS, lte->file_on_disk);
+                               win32_error_last();
                                return WIMLIB_ERR_OPEN;
+                       }
                }
                break;
 #endif
@@ -321,7 +339,7 @@ prepare_resource_for_read(struct wim_lookup_table_entry *lte
 
 /* Undo prepare_resource_for_read() by closing the cached FILE * or NTFS
  * attribute. */
-static void 
+static void
 end_wim_resource_read(struct wim_lookup_table_entry *lte
                        #ifdef WITH_NTFS_3G
                                , ntfs_inode *ni
@@ -346,10 +364,10 @@ end_wim_resource_read(struct wim_lookup_table_entry *lte
 #endif
 #ifdef __WIN32__
        else if (lte->resource_location == RESOURCE_WIN32
-                && lte->file_on_disk_fp)
+                && lte->win32_file_on_disk_fp != INVALID_HANDLE_VALUE)
        {
-               win32_close_file(lte->file_on_disk_fp);
-               lte->file_on_disk_fp = NULL;
+               win32_close_file(lte->win32_file_on_disk_fp);
+               lte->win32_file_on_disk_fp = INVALID_HANDLE_VALUE;
        }
 #endif
 }
@@ -537,8 +555,8 @@ write_wim_resource(struct wim_lookup_table_entry *lte,
                } else if (!hashes_equal(md, lte->hash)) {
                        ERROR("WIM resource has incorrect hash!");
                        if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK) {
-                               ERROR("We were reading it from `%s'; maybe it changed "
-                                     "while we were reading it.",
+                               ERROR("We were reading it from `%"TS"'; maybe "
+                                     "it changed while we were reading it.",
                                      lte->file_on_disk);
                        }
                        ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
@@ -680,15 +698,18 @@ compress_chunks(struct message *msg, compress_func_t compress)
 {
        for (unsigned i = 0; i < msg->num_chunks; i++) {
                DEBUG2("compress chunk %u of %u", i, msg->num_chunks);
-               int ret = compress(msg->uncompressed_chunks[i],
-                                  msg->uncompressed_chunk_sizes[i],
-                                  msg->compressed_chunks[i],
-                                  &msg->compressed_chunk_sizes[i]);
-               if (ret == 0) {
+               unsigned len = compress(msg->uncompressed_chunks[i],
+                                       msg->uncompressed_chunk_sizes[i],
+                                       msg->compressed_chunks[i]);
+               if (len) {
+                       /* To be written compressed */
                        msg->out_compressed_chunks[i] = msg->compressed_chunks[i];
+                       msg->compressed_chunk_sizes[i] = len;
                } else {
+                       /* To be written uncompressed */
                        msg->out_compressed_chunks[i] = msg->uncompressed_chunks[i];
                        msg->compressed_chunk_sizes[i] = msg->uncompressed_chunk_sizes[i];
+
                }
        }
 }
@@ -717,6 +738,29 @@ compressor_thread_proc(void *arg)
 }
 #endif /* ENABLE_MULTITHREADED_COMPRESSION */
 
+static void
+do_write_streams_progress(union wimlib_progress_info *progress,
+                         wimlib_progress_func_t progress_func,
+                         uint64_t size_added)
+{
+       progress->write_streams.completed_bytes += size_added;
+       progress->write_streams.completed_streams++;
+       if (progress_func &&
+           progress->write_streams.completed_bytes >= progress->write_streams._private)
+       {
+               progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
+                             progress);
+               if (progress->write_streams._private == progress->write_streams.total_bytes) {
+                       progress->write_streams._private = ~0;
+               } else {
+                       progress->write_streams._private =
+                               min(progress->write_streams.total_bytes,
+                                   progress->write_streams.completed_bytes +
+                                       progress->write_streams.total_bytes / 100);
+               }
+       }
+}
+
 static int
 do_write_stream_list(struct list_head *my_resources,
                     FILE *out_fp,
@@ -737,13 +781,10 @@ do_write_stream_list(struct list_head *my_resources,
                if (ret != 0)
                        return ret;
                list_del(&lte->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);
-               }
+
+               do_write_streams_progress(progress,
+                                         progress_func,
+                                         wim_resource_size(lte));
        }
        return 0;
 }
@@ -927,7 +968,7 @@ main_writer_thread_proc(struct list_head *stream_list,
                                                if (next_lte->resource_location ==
                                                    RESOURCE_IN_FILE_ON_DISK)
                                                {
-                                                       ERROR("We were reading it from `%s'; "
+                                                       ERROR("We were reading it from `%"TS"'; "
                                                              "maybe it changed while we were "
                                                              "reading it.",
                                                              next_lte->file_on_disk);
@@ -1138,14 +1179,8 @@ main_writer_thread_proc(struct list_head *stream_list,
                                                        WIM_RESHDR_FLAG_COMPRESSED;
                                }
 
-                               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);
-                               }
+                               do_write_streams_progress(progress, progress_func,
+                                                         wim_resource_size(cur_lte));
 
                                FREE(cur_chunk_tab);
                                cur_chunk_tab = NULL;
@@ -1374,6 +1409,7 @@ write_stream_list(struct list_head *stream_list, FILE *out_fp,
        progress.write_streams.completed_streams = 0;
        progress.write_streams.num_threads       = num_threads;
        progress.write_streams.compression_type  = out_ctype;
+       progress.write_streams._private          = 0;
 
 #ifdef ENABLE_MULTITHREADED_COMPRESSION
        if (total_compression_bytes >= 1000000 && num_threads != 1)
@@ -1419,24 +1455,29 @@ lte_overwrite_prepare(struct wim_lookup_table_entry *lte, void *arg)
        lte->out_refcnt = lte->refcnt;
        memcpy(&lte->output_resource_entry, &lte->resource_entry,
               sizeof(struct resource_entry));
-       if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA)) {
-               wimlib_assert(lte->resource_location != RESOURCE_NONEXISTENT);
+       if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA))
                if (lte->resource_location != RESOURCE_IN_WIM || lte->wim != args->wim)
                        list_add(&lte->staging_list, args->stream_list);
-       }
        return 0;
 }
 
 static int
-wim_find_new_streams(WIMStruct *wim, off_t end_offset,
-                    struct list_head *stream_list)
+wim_prepare_streams(WIMStruct *wim, off_t end_offset,
+                   struct list_head *stream_list)
 {
        struct lte_overwrite_prepare_args args = {
                .wim         = wim,
                .end_offset  = end_offset,
                .stream_list = stream_list,
        };
+       int ret;
 
+       for (int i = 0; i < wim->hdr.image_count; i++) {
+               ret = lte_overwrite_prepare(wim->image_metadata[i].metadata_lte,
+                                           &args);
+               if (ret)
+                       return ret;
+       }
        return for_lookup_table_entry(wim->lookup_table,
                                      lte_overwrite_prepare, &args);
 }
@@ -1532,7 +1573,7 @@ finish_write(WIMStruct *w, int image, int write_flags,
        memcpy(&hdr, &w->hdr, sizeof(struct wim_header));
 
        if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
-               ret = write_lookup_table(w->lookup_table, out, &hdr.lookup_table_res_entry);
+               ret = write_lookup_table(w, image, &hdr.lookup_table_res_entry);
                if (ret != 0)
                        goto out;
        }
@@ -1660,12 +1701,12 @@ lock_wim(WIMStruct *w, FILE *fp)
                ret = flock(fileno(fp), LOCK_EX | LOCK_NB);
                if (ret != 0) {
                        if (errno == EWOULDBLOCK) {
-                               ERROR("`%s' is already being modified or has been "
+                               ERROR("`%"TS"' is already being modified or has been "
                                      "mounted read-write\n"
                                      "        by another process!", w->filename);
                                ret = WIMLIB_ERR_ALREADY_LOCKED;
                        } else {
-                               WARNING_WITH_ERRNO("Failed to lock `%s'",
+                               WARNING_WITH_ERRNO("Failed to lock `%"TS"'",
                                                   w->filename);
                                ret = 0;
                        }
@@ -1678,24 +1719,24 @@ lock_wim(WIMStruct *w, FILE *fp)
 #endif
 
 static int
-open_wim_writable(WIMStruct *w, const mbchar *path,
-                 bool trunc, bool readable)
+open_wim_writable(WIMStruct *w, const tchar *path,
+                 bool trunc, bool also_readable)
 {
-       const char *mode;
+       const tchar *mode;
        if (trunc)
-               if (readable)
-                       mode = "w+b";
+               if (also_readable)
+                       mode = T("w+b");
                else
-                       mode = "wb";
+                       mode = T("wb");
        else
-               mode = "r+b";
+               mode = T("r+b");
 
        wimlib_assert(w->out_fp == NULL);
-       w->out_fp = fopen(path, mode);
+       w->out_fp = tfopen(path, mode);
        if (w->out_fp) {
                return 0;
        } else {
-               ERROR_WITH_ERRNO("Failed to open `%s' for writing", path);
+               ERROR_WITH_ERRNO("Failed to open `%"TS"' for writing", path);
                return WIMLIB_ERR_OPEN;
        }
 }
@@ -1714,7 +1755,7 @@ close_wim_writable(WIMStruct *w)
 
 /* Open file stream and write dummy header for WIM. */
 int
-begin_write(WIMStruct *w, const mbchar *path, int write_flags)
+begin_write(WIMStruct *w, const tchar *path, int write_flags)
 {
        int ret;
        ret = open_wim_writable(w, path, true,
@@ -1727,7 +1768,7 @@ begin_write(WIMStruct *w, const mbchar *path, int write_flags)
 
 /* Writes a stand-alone WIM to a file.  */
 WIMLIBAPI int
-wimlib_write(WIMStruct *w, const mbchar *path,
+wimlib_write(WIMStruct *w, const tchar *path,
             int image, int write_flags, unsigned num_threads,
             wimlib_progress_func_t progress_func)
 {
@@ -1769,7 +1810,7 @@ wimlib_write(WIMStruct *w, const mbchar *path,
        ret = finish_write(w, image, write_flags, progress_func);
 out:
        close_wim_writable(w);
-       DEBUG("wimlib_write(path=%s) = %d", path, ret);
+       DEBUG("wimlib_write(path=%"TS") = %d", path, ret);
        return ret;
 }
 
@@ -1849,7 +1890,7 @@ overwrite_wim_inplace(WIMStruct *w, int write_flags,
        off_t old_wim_end;
        bool found_modified_image;
 
-       DEBUG("Overwriting `%s' in-place", w->filename);
+       DEBUG("Overwriting `%"TS"' in-place", w->filename);
 
        /* Make sure that the integrity table (if present) is after the XML
         * data, and that there are no stream resources, metadata resources, or
@@ -1881,7 +1922,7 @@ overwrite_wim_inplace(WIMStruct *w, int write_flags,
                               WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML;
        }
        INIT_LIST_HEAD(&stream_list);
-       ret = wim_find_new_streams(w, old_wim_end, &stream_list);
+       ret = wim_prepare_streams(w, old_wim_end, &stream_list);
        if (ret != 0)
                return ret;
 
@@ -1920,9 +1961,7 @@ overwrite_wim_inplace(WIMStruct *w, int write_flags,
 
        found_modified_image = false;
        for (int i = 0; i < w->hdr.image_count; i++) {
-               if (!found_modified_image)
-                       found_modified_image = w->image_metadata[i].modified;
-               if (found_modified_image) {
+               if (w->image_metadata[i].modified) {
                        select_wim_image(w, i + 1);
                        ret = write_metadata_resource(w);
                        if (ret != 0)
@@ -1935,11 +1974,11 @@ overwrite_wim_inplace(WIMStruct *w, int write_flags,
 out_ftruncate:
        close_wim_writable(w);
        if (ret != 0 && !(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
-               WARNING("Truncating `%s' to its original size (%"PRIu64" bytes)",
+               WARNING("Truncating `%"TS"' to its original size (%"PRIu64" bytes)",
                        w->filename, old_wim_end);
                /* Return value of truncate() is ignored because this is already
                 * an error path. */
-               (void)truncate(w->filename, old_wim_end);
+               (void)ttruncate(w->filename, old_wim_end);
        }
        w->wim_locked = 0;
        return ret;
@@ -1953,29 +1992,40 @@ overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags,
        size_t wim_name_len;
        int ret;
 
-       DEBUG("Overwriting `%s' via a temporary file", w->filename);
+       DEBUG("Overwriting `%"TS"' via a temporary file", w->filename);
 
        /* Write the WIM to a temporary file in the same directory as the
         * original WIM. */
-       wim_name_len = strlen(w->filename);
-       mbchar tmpfile[wim_name_len + 10];
-       memcpy(tmpfile, w->filename, wim_name_len);
+       wim_name_len = tstrlen(w->filename);
+       tchar tmpfile[wim_name_len + 10];
+       tmemcpy(tmpfile, w->filename, wim_name_len);
        randomize_char_array_with_alnum(tmpfile + wim_name_len, 9);
-       tmpfile[wim_name_len + 9] = '\0';
+       tmpfile[wim_name_len + 9] = T('\0');
 
        ret = wimlib_write(w, tmpfile, WIMLIB_ALL_IMAGES,
                           write_flags | WIMLIB_WRITE_FLAG_FSYNC,
                           num_threads, progress_func);
        if (ret != 0) {
-               ERROR("Failed to write the WIM file `%s'", tmpfile);
+               ERROR("Failed to write the WIM file `%"TS"'", tmpfile);
                goto err;
        }
 
-       DEBUG("Renaming `%s' to `%s'", tmpfile, w->filename);
+       DEBUG("Renaming `%"TS"' to `%"TS"'", tmpfile, w->filename);
+
+#ifdef __WIN32__
+       /* Windows won't let you delete open files unless FILE_SHARE_DELETE was
+        * specified to CreateFile().  The WIM was opened with fopen(), which
+        * didn't provided this flag to CreateFile, so the handle must be closed
+        * before executing the rename(). */
+       if (w->fp != NULL) {
+               fclose(w->fp);
+               w->fp = NULL;
+       }
+#endif
 
        /* Rename the new file to the old file .*/
-       if (rename(tmpfile, w->filename) != 0) {
-               ERROR_WITH_ERRNO("Failed to rename `%s' to `%s'",
+       if (trename(tmpfile, w->filename) != 0) {
+               ERROR_WITH_ERRNO("Failed to rename `%"TS"' to `%"TS"'",
                                 tmpfile, w->filename);
                ret = WIMLIB_ERR_RENAME;
                goto err;
@@ -1995,10 +2045,10 @@ overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags,
        }
 
        /* Re-open the WIM read-only. */
-       w->fp = fopen(w->filename, "rb");
+       w->fp = tfopen(w->filename, T("rb"));
        if (w->fp == NULL) {
                ret = WIMLIB_ERR_REOPEN;
-               WARNING_WITH_ERRNO("Failed to re-open `%s' read-only",
+               WARNING_WITH_ERRNO("Failed to re-open `%"TS"' read-only",
                                   w->filename);
                FREE(w->filename);
                w->filename = NULL;
@@ -2006,8 +2056,8 @@ overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags,
        return ret;
 err:
        /* Remove temporary file. */
-       if (unlink(tmpfile) != 0)
-               WARNING_WITH_ERRNO("Failed to remove `%s'", tmpfile);
+       if (tunlink(tmpfile) != 0)
+               WARNING_WITH_ERRNO("Failed to remove `%"TS"'", tmpfile);
        return ret;
 }