Initial support for resuming extraction from split pipable WIMs
authorEric Biggers <ebiggers3@gmail.com>
Fri, 16 Aug 2013 00:23:02 +0000 (19:23 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Fri, 16 Aug 2013 00:23:02 +0000 (19:23 -0500)
doc/imagex-apply.1.in
include/wimlib.h
programs/imagex.c
src/extract.c

index b7b87a2..2190762 100644 (file)
@@ -367,6 +367,9 @@ default, invalid names will be ignored, and if there are multiple names
 differing only in case, one will be chosen to extract arbitrarily; however, with
 \fB--include-invalid-names\fR, all names will be sanitized and extracted in some
 form.
+.TP
+\fB--resume\fR
+TODO
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ apply\fR calculates the SHA1 message digest of every file
 stream it extracts and verifies that it is the same as the SHA1 message digest
index 6ab50ce..0c14941 100644 (file)
@@ -1048,6 +1048,9 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour
  * create symbolic links.  */
 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS             0x00008000
 
+/** TODO */
+#define WIMLIB_EXTRACT_FLAG_RESUME                     0x00010000
+
 
 /******************************
  * WIMLIB_MOUNT_FLAG_*
index 767b672..977f21b 100644 (file)
@@ -146,6 +146,7 @@ enum {
        IMAGEX_RECOMPRESS_OPTION,
        IMAGEX_RECURSIVE_OPTION,
        IMAGEX_REF_OPTION,
+       IMAGEX_RESUME_OPTION,
        IMAGEX_RPFIX_OPTION,
        IMAGEX_SOFT_OPTION,
        IMAGEX_SOURCE_LIST_OPTION,
@@ -173,6 +174,7 @@ static const struct option apply_options[] = {
        {T("rpfix"),       no_argument,       NULL, IMAGEX_RPFIX_OPTION},
        {T("norpfix"),     no_argument,       NULL, IMAGEX_NORPFIX_OPTION},
        {T("include-invalid-names"), no_argument,       NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
+       {T("resume"),      no_argument,       NULL, IMAGEX_RESUME_OPTION},
        {NULL, 0, NULL, 0},
 };
 
@@ -1496,6 +1498,9 @@ imagex_apply(int argc, tchar **argv, int cmd)
                        extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
                        extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
                        break;
+               case IMAGEX_RESUME_OPTION:
+                       extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
+                       break;
                default:
                        goto out_usage;
                }
@@ -3449,7 +3454,7 @@ T(
 "                    (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
 "                    [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
 "                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
-"                    [--include-invalid-names]\n"
+"                    [--include-invalid-names] [--resume]\n"
 ),
 [CMD_CAPTURE] =
 T(
index ce72b78..51684f0 100644 (file)
@@ -1265,10 +1265,13 @@ extract_stream_list(struct apply_ctx *ctx)
        return 0;
 }
 
+#define PWM_ALLOW_WIM_HDR 0x00001
+#define PWM_SILENT_EOF   0x00002
+
 /* Read the header from a stream in a pipable WIM.  */
 static int
 read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
-                      bool allow_header)
+                      int flags)
 {
        struct pwm_stream_hdr stream_hdr;
        int ret;
@@ -1277,7 +1280,7 @@ read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
        if (ret)
                goto read_error;
 
-       if (allow_header && stream_hdr.magic == PWM_MAGIC) {
+       if ((flags & PWM_ALLOW_WIM_HDR) && stream_hdr.magic == PWM_MAGIC) {
                u8 buf[WIM_HEADER_DISK_SIZE - sizeof(stream_hdr)];
                ret = full_read(&pwm->in_fd, buf, sizeof(buf));
                if (ret)
@@ -1308,7 +1311,8 @@ read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
        return 0;
 
 read_error:
-       ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
+       if (ret != WIMLIB_ERR_UNEXPECTED_END_OF_FILE || !(flags & PWM_SILENT_EOF))
+               ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
        return ret;
 }
 
@@ -1329,6 +1333,7 @@ extract_streams_from_pipe(struct apply_ctx *ctx)
        struct wim_lookup_table_entry *needed_lte;
        struct wim_lookup_table *lookup_table;
        int ret;
+       int pwm_flags;
 
        ret = WIMLIB_ERR_NOMEM;
        found_lte = new_lookup_table_entry();
@@ -1336,11 +1341,19 @@ extract_streams_from_pipe(struct apply_ctx *ctx)
                goto out;
 
        lookup_table = ctx->wim->lookup_table;
-
+       pwm_flags = PWM_ALLOW_WIM_HDR;
+       if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
+               pwm_flags |= PWM_SILENT_EOF;
        while (ctx->num_streams_remaining) {
-               ret = read_pwm_stream_header(ctx->wim, found_lte, true);
-               if (ret)
+               ret = read_pwm_stream_header(ctx->wim, found_lte, pwm_flags);
+               if (ret) {
+                       if (ret == WIMLIB_ERR_UNEXPECTED_END_OF_FILE &&
+                           (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
+                       {
+                               goto resume_done;
+                       }
                        goto out_free_found_lte;
+               }
 
                if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
                    && !(found_lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA)
@@ -1369,6 +1382,10 @@ out_free_found_lte:
        free_lookup_table_entry(found_lte);
 out:
        return ret;
+
+resume_done:
+       /* TODO */
+       return 0;
 }
 
 /* Finish extracting a file, directory, or symbolic link by setting file
@@ -2128,9 +2145,12 @@ extract_tree(WIMStruct *wim, const tchar *wim_source_path, const tchar *target,
                if (progress_func)
                        progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
                                      &ctx.progress);
-               ret = for_dentry_in_tree(root, dentry_extract_skeleton, &ctx);
-               if (ret)
-                       goto out_free_realtarget;
+
+               if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
+                       ret = for_dentry_in_tree(root, dentry_extract_skeleton, &ctx);
+                       if (ret)
+                               goto out_free_realtarget;
+               }
                if (progress_func)
                        progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
                                      &ctx.progress);
@@ -2245,6 +2265,11 @@ check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags)
                                                WIMLIB_EXTRACT_FLAG_NORPFIX))
                return WIMLIB_ERR_INVALID_PARAM;
 
+       if ((extract_flags &
+            (WIMLIB_EXTRACT_FLAG_RESUME |
+             WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
+               return WIMLIB_ERR_INVALID_PARAM;
+
        if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
 #ifndef WITH_NTFS_3G
                ERROR("wimlib was compiled without support for NTFS-3g, so\n"
@@ -2630,7 +2655,7 @@ wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
         * WIMs.)  */
        {
                struct wim_lookup_table_entry xml_lte;
-               ret = read_pwm_stream_header(pwm, &xml_lte, false);
+               ret = read_pwm_stream_header(pwm, &xml_lte, 0);
                if (ret)
                        goto out_wimlib_free;
 
@@ -2690,7 +2715,7 @@ wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
                        goto out_wimlib_free;
                }
 
-               ret = read_pwm_stream_header(pwm, metadata_lte, false);
+               ret = read_pwm_stream_header(pwm, metadata_lte, 0);
                imd = pwm->image_metadata[i - 1];
                imd->metadata_lte = metadata_lte;
                if (ret)