win32_apply: Support multiple source WIM files for WIMBoot extraction

diff --git a/NEWS b/NEWS
index 0cf5b2df7d6d53edd2218bb54e792e712ce24dcb..01827df4c43d9955fad0b5f385aeb7569a982db8 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -17,6 +17,9 @@ Version 1.8.1-BETA:
        On Windows, named data streams are now correctly extracted to existing
        "readonly" directories.  Before, an error would be reported.
 
        On Windows, named data streams are now correctly extracted to existing
        "readonly" directories.  Before, an error would be reported.
 

+       On Windows, it is now possible to do a "WIMBoot mode" extraction with
+       non-standalone WIMs such as delta WIMs.
+

        On Windows, when doing an extraction in "WIMBoot mode", files larger
        than 4 gigabytes are now never extracted as externally backed.  This
        works around a bug in Microsoft's "WOF" driver.
        On Windows, when doing an extraction in "WIMBoot mode", files larger
        than 4 gigabytes are now never extracted as externally backed.  This
        works around a bug in Microsoft's "WOF" driver.

diff --git a/doc/man1/wimlib-imagex-apply.1 b/doc/man1/wimlib-imagex-apply.1
index 78861770239ad890c1d138a69457bf9f841384ea..619c8fc6658d4cb6a55c2b55283f533d87937f2b 100644 (file)
--- a/doc/man1/wimlib-imagex-apply.1
+++ b/doc/man1/wimlib-imagex-apply.1
@@ -347,9 +347,9 @@ form.
 .TP
 \fB--wimboot\fR
 Windows only: Instead of extracting the files themselves, extract "pointer
 .TP
 \fB--wimboot\fR
 Windows only: Instead of extracting the files themselves, extract "pointer

-files" back to the WIM archive.  This can result in significant space savings.
+files" back to the WIM archive(s).  This can result in significant space savings.

 However, it comes at several potential costs, such as not being able to delete
 However, it comes at several potential costs, such as not being able to delete

-the WIM archive and possibly having slower access to files.  See Microsoft's
+the WIM archive(s) and possibly having slower access to files.  See Microsoft's

 documentation for "WIMBoot" for more information.
 .IP ""
 If it exists, the [PrepopulateList] section of the file
 documentation for "WIMBoot" for more information.
 .IP ""
 If it exists, the [PrepopulateList] section of the file

diff --git a/include/wimlib.h b/include/wimlib.h
index ee0bb9bb459a5aa5eaa834d1355cad49d228f4a0..a9fb8cc97882c30824a048581a24c09e659abe2e 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -2833,7 +2833,8 @@ wimlib_export_image(WIMStruct *src_wim, int src_image,
  *     ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
  * @retval ::WIMLIB_ERR_WIMBOOT
  *     ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
  *     ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
  * @retval ::WIMLIB_ERR_WIMBOOT
  *     ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but

- *     there was a problem creating WIMBoot pointer files.
+ *     there was a problem creating WIMBoot pointer files or registering a
+ *     source WIM file with the Windows Overlay Filesystem (WOF) driver.

  * @retval ::WIMLIB_ERR_WRITE
  *     Failed to write data to a file being extracted.
  *
  * @retval ::WIMLIB_ERR_WRITE
  *     Failed to write data to a file being extracted.
  *

diff --git a/src/win32_apply.c b/src/win32_apply.c
index ffcd3a1fc7a4c675216194b1ab5c270963cdf184..df7d720e5d1f9f46b1cf119e9449e4c8ba8bc6bc 100644 (file)
--- a/src/win32_apply.c
+++ b/src/win32_apply.c
@@ -50,10 +50,17 @@ struct win32_apply_ctx {
        /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
         * was provided  */
        struct {
        /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
         * was provided  */
        struct {

-               u64 data_source_id;
+               /* This array contains the WIM files registered with WOF on the
+                * target volume for this extraction operation.  All WIMStructs
+                * in this array are distinct and have ->filename != NULL.  */
+               struct wimboot_wim {
+                       WIMStruct *wim;
+                       u64 data_source_id;
+                       u8 blob_table_hash[SHA1_HASH_SIZE];
+               } *wims;
+               size_t num_wims;

                struct string_set *prepopulate_pats;
                void *mem_prepopulate_pats;
                struct string_set *prepopulate_pats;
                void *mem_prepopulate_pats;

-               u8 blob_table_hash[SHA1_HASH_SIZE];

                bool wof_running;
                bool tried_to_load_prepopulate_list;
        } wimboot;
                bool wof_running;
                bool tried_to_load_prepopulate_list;
        } wimboot;


@@ -449,11 +456,25 @@ win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
        return will_externally_back_inode(dentry->d_inode, ctx, NULL);
 }
 
        return will_externally_back_inode(dentry->d_inode, ctx, NULL);
 }
 

+/* Find the WOF registration information for the specified WIM file.  */
+static struct wimboot_wim *
+find_wimboot_wim(WIMStruct *wim_to_find, struct win32_apply_ctx *ctx)
+{
+       for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
+               if (wim_to_find == ctx->wimboot.wims[i].wim)
+                       return &ctx->wimboot.wims[i];
+
+       wimlib_assert(0);
+       return NULL;
+}
+

 static int
 set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
 {
        int ret;
        const struct wim_dentry *excluded_dentry;
 static int
 set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
 {
        int ret;
        const struct wim_dentry *excluded_dentry;

+       const struct blob_descriptor *blob;
+       const struct wimboot_wim *wimboot_wim;

 
        ret = will_externally_back_inode(inode, ctx, &excluded_dentry);
        if (ret > 0) /* Error.  */
 
        ret = will_externally_back_inode(inode, ctx, &excluded_dentry);
        if (ret > 0) /* Error.  */


@@ -474,23 +495,27 @@ set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *
                return call_progress(ctx->common.progfunc,
                                     WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
                                     &info, ctx->common.progctx);
                return call_progress(ctx->common.progfunc,
                                     WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
                                     &info, ctx->common.progctx);

-       } else {
-               /* Externally backing.  */
-               if (unlikely(!wimboot_set_pointer(h,
-                                                 inode_get_blob_for_unnamed_data_stream_resolved(inode),
-                                                 ctx->wimboot.data_source_id,
-                                                 ctx->wimboot.blob_table_hash,
-                                                 ctx->wimboot.wof_running)))
-               {
-                       const DWORD err = GetLastError();
+       }

 
 

-                       build_extraction_path(inode_first_extraction_dentry(inode), ctx);
-                       win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
-                                   current_path(ctx));
-                       return WIMLIB_ERR_WIMBOOT;
-               }
-               return 0;
+       /* Externally backing.  */
+
+       blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
+       wimboot_wim = find_wimboot_wim(blob->rdesc->wim, ctx);
+
+       if (unlikely(!wimboot_set_pointer(h,
+                                         blob,
+                                         wimboot_wim->data_source_id,
+                                         wimboot_wim->blob_table_hash,
+                                         ctx->wimboot.wof_running)))
+       {
+               const DWORD err = GetLastError();
+
+               build_extraction_path(inode_first_extraction_dentry(inode), ctx);
+               win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
+                           current_path(ctx));
+               return WIMLIB_ERR_WIMBOOT;

        }
        }

+       return 0;

 }
 
 /* Calculates the SHA-1 message digest of the WIM's blob table.  */
 }
 
 /* Calculates the SHA-1 message digest of the WIM's blob table.  */


@@ -500,32 +525,77 @@ hash_blob_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
        return wim_reshdr_to_hash(&wim->hdr.blob_table_reshdr, wim, hash);
 }
 
        return wim_reshdr_to_hash(&wim->hdr.blob_table_reshdr, wim, hash);
 }
 

+static int
+register_wim_with_wof(WIMStruct *wim, struct win32_apply_ctx *ctx)
+{
+       struct wimboot_wim *p;
+       int ret;
+
+       /* Check if already registered  */
+       for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
+               if (wim == ctx->wimboot.wims[i].wim)
+                       return 0;
+
+       /* Not yet registered  */
+
+       p = REALLOC(ctx->wimboot.wims,
+                   (ctx->wimboot.num_wims + 1) * sizeof(ctx->wimboot.wims[0]));
+       if (!p)
+               return WIMLIB_ERR_NOMEM;
+       ctx->wimboot.wims = p;
+
+       ctx->wimboot.wims[ctx->wimboot.num_wims].wim = wim;
+
+       ret = hash_blob_table(wim, ctx->wimboot.wims[ctx->wimboot.num_wims].blob_table_hash);
+       if (ret)
+               return ret;
+
+       ret = wimboot_alloc_data_source_id(wim->filename,
+                                          wim->hdr.guid,
+                                          ctx->common.wim->current_image,
+                                          ctx->common.target,
+                                          &ctx->wimboot.wims[ctx->wimboot.num_wims].data_source_id,
+                                          &ctx->wimboot.wof_running);
+       if (ret)
+               return ret;
+
+       ctx->wimboot.num_wims++;
+       return 0;
+}
+

 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
 /* Prepare for doing a "WIMBoot" extraction by loading patterns from

- * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
- * on the target volume.  */
+ * [PrepopulateList] of WimBootCompress.ini and registering each source WIM file
+ * with WOF on the target volume.  */

 static int
 static int

-start_wimboot_extraction(struct win32_apply_ctx *ctx)
+start_wimboot_extraction(struct list_head *dentry_list, struct win32_apply_ctx *ctx)

 {
        int ret;
 {
        int ret;

-       WIMStruct *wim = ctx->common.wim;
+       struct wim_dentry *dentry;

 
        if (!ctx->wimboot.tried_to_load_prepopulate_list)
                if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
                        return WIMLIB_ERR_NOMEM;
 
 
        if (!ctx->wimboot.tried_to_load_prepopulate_list)
                if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
                        return WIMLIB_ERR_NOMEM;
 

-       if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
+       if (!wim_info_get_wimboot(ctx->common.wim->wim_info,
+                                 ctx->common.wim->current_image))

                WARNING("Image is not marked as WIMBoot compatible!");
 
                WARNING("Image is not marked as WIMBoot compatible!");
 

-       ret = hash_blob_table(ctx->common.wim, ctx->wimboot.blob_table_hash);
-       if (ret)
-               return ret;
+       list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
+               struct blob_descriptor *blob;
+
+               ret = win32_will_externally_back(dentry, &ctx->common);
+               if (ret > 0) /* Error */
+                       return ret;
+               if (ret < 0) /* Won't externally back */
+                       continue;
+
+               blob = inode_get_blob_for_unnamed_data_stream_resolved(dentry->d_inode);
+               ret = register_wim_with_wof(blob->rdesc->wim, ctx);
+               if (ret)
+                       return ret;
+       }

 
 

-       return wimboot_alloc_data_source_id(wim->filename,
-                                           wim->hdr.guid,
-                                           wim->current_image,
-                                           ctx->common.target,
-                                           &ctx->wimboot.data_source_id,
-                                           &ctx->wimboot.wof_running);
+       return 0;

 }
 
 static void
 }
 
 static void


@@ -2490,7 +2560,7 @@ win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
                goto out;
 
        if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
                goto out;
 
        if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {

-               ret = start_wimboot_extraction(ctx);
+               ret = start_wimboot_extraction(dentry_list, ctx);

                if (ret)
                        goto out;
        }
                if (ret)
                        goto out;
        }


@@ -2550,6 +2620,7 @@ out:
                HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
        FREE(ctx->pathbuf.Buffer);
        FREE(ctx->print_buffer);
                HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
        FREE(ctx->pathbuf.Buffer);
        FREE(ctx->print_buffer);

+       FREE(ctx->wimboot.wims);

        if (ctx->wimboot.prepopulate_pats) {
                FREE(ctx->wimboot.prepopulate_pats->strings);
                FREE(ctx->wimboot.prepopulate_pats);
        if (ctx->wimboot.prepopulate_pats) {
                FREE(ctx->wimboot.prepopulate_pats->strings);
                FREE(ctx->wimboot.prepopulate_pats);