]> wimlib.net Git - wimlib/blobdiff - src/win32_capture.c
Refactor some of the dentry, inode, and lookup table code
[wimlib] / src / win32_capture.c
index c7d2b20c637e2be12ac78672a67d733857eb5d4c..cf5c65c9498225b5c5c23211a213a0698cf75636 100644 (file)
@@ -30,6 +30,7 @@
 #include "wimlib/win32_common.h"
 
 #include "wimlib/capture.h"
+#include "wimlib/dentry.h"
 #include "wimlib/endianness.h"
 #include "wimlib/error.h"
 #include "wimlib/lookup_table.h"
@@ -58,12 +59,11 @@ int
 read_win32_file_prefix(const struct wim_lookup_table_entry *lte,
                       u64 size,
                       consume_data_callback_t cb,
-                      void *ctx_or_buf,
-                      int _ignored_flags)
+                      void *cb_ctx)
 {
        int ret = 0;
-       void *out_buf;
        u64 bytes_remaining;
+       u8 buf[BUFFER_SIZE];
 
        HANDLE hFile = win32_open_existing_file(lte->file_on_disk,
                                                FILE_READ_DATA);
@@ -73,17 +73,12 @@ read_win32_file_prefix(const struct wim_lookup_table_entry *lte,
                return WIMLIB_ERR_OPEN;
        }
 
-       if (cb)
-               out_buf = alloca(WIM_CHUNK_SIZE);
-       else
-               out_buf = ctx_or_buf;
-
        bytes_remaining = size;
        while (bytes_remaining) {
                DWORD bytesToRead, bytesRead;
 
-               bytesToRead = min(WIM_CHUNK_SIZE, bytes_remaining);
-               if (!ReadFile(hFile, out_buf, bytesToRead, &bytesRead, NULL) ||
+               bytesToRead = min(sizeof(buf), bytes_remaining);
+               if (!ReadFile(hFile, buf, bytesToRead, &bytesRead, NULL) ||
                    bytesRead != bytesToRead)
                {
                        set_errno_from_GetLastError();
@@ -93,74 +88,40 @@ read_win32_file_prefix(const struct wim_lookup_table_entry *lte,
                        break;
                }
                bytes_remaining -= bytesRead;
-               if (cb) {
-                       ret = (*cb)(out_buf, bytesRead, ctx_or_buf);
-                       if (ret)
-                               break;
-               } else {
-                       out_buf += bytesRead;
-               }
+               ret = (*cb)(buf, bytesRead, cb_ctx);
+               if (ret)
+                       break;
        }
+out_close_handle:
        CloseHandle(hFile);
        return ret;
 }
 
 struct win32_encrypted_read_ctx {
        consume_data_callback_t read_prefix_cb;
-       void *read_prefix_ctx_or_buf;
+       void *read_prefix_ctx;
        int wimlib_err_code;
-       void *buf;
-       size_t buf_filled;
        u64 bytes_remaining;
 };
 
 static DWORD WINAPI
-win32_encrypted_export_cb(unsigned char *_data, void *_ctx, unsigned long len)
+win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len)
 {
-       const void *data = _data;
        struct win32_encrypted_read_ctx *ctx = _ctx;
        int ret;
+       size_t bytes_to_consume = min(len, ctx->bytes_remaining);
 
-       DEBUG("len = %lu", len);
-       if (ctx->read_prefix_cb) {
-               /* The length of the buffer passed to the ReadEncryptedFileRaw()
-                * export callback is undocumented, so we assume it may be of
-                * arbitrary size. */
-               size_t bytes_to_buffer = min(ctx->bytes_remaining - ctx->buf_filled,
-                                            len);
-               while (bytes_to_buffer) {
-                       size_t bytes_to_copy_to_buf =
-                               min(bytes_to_buffer, WIM_CHUNK_SIZE - ctx->buf_filled);
-
-                       memcpy(ctx->buf + ctx->buf_filled, data,
-                              bytes_to_copy_to_buf);
-                       ctx->buf_filled += bytes_to_copy_to_buf;
-                       data += bytes_to_copy_to_buf;
-                       bytes_to_buffer -= bytes_to_copy_to_buf;
-
-                       if (ctx->buf_filled == WIM_CHUNK_SIZE ||
-                           ctx->buf_filled == ctx->bytes_remaining)
-                       {
-                               ret = (*ctx->read_prefix_cb)(ctx->buf,
-                                                            ctx->buf_filled,
-                                                            ctx->read_prefix_ctx_or_buf);
-                               if (ret) {
-                                       ctx->wimlib_err_code = ret;
-                                       /* Shouldn't matter what error code is returned
-                                        * here, as long as it isn't ERROR_SUCCESS. */
-                                       return ERROR_READ_FAULT;
-                               }
-                               ctx->bytes_remaining -= ctx->buf_filled;
-                               ctx->buf_filled = 0;
-                       }
-               }
-       } else {
-               size_t len_to_copy = min(len, ctx->bytes_remaining);
-               ctx->read_prefix_ctx_or_buf = mempcpy(ctx->read_prefix_ctx_or_buf,
-                                                     data,
-                                                     len_to_copy);
-               ctx->bytes_remaining -= len_to_copy;
+       if (bytes_to_consume == 0)
+               return ERROR_SUCCESS;
+
+       ret = (*ctx->read_prefix_cb)(data, bytes_to_consume, ctx->read_prefix_ctx);
+       if (ret) {
+               ctx->wimlib_err_code = ret;
+               /* Shouldn't matter what error code is returned here, as long as
+                * it isn't ERROR_SUCCESS.  */
+               return ERROR_READ_FAULT;
        }
+       ctx->bytes_remaining -= bytes_to_consume;
        return ERROR_SUCCESS;
 }
 
@@ -168,8 +129,7 @@ int
 read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
                                 u64 size,
                                 consume_data_callback_t cb,
-                                void *ctx_or_buf,
-                                int _ignored_flags)
+                                void *cb_ctx)
 {
        struct win32_encrypted_read_ctx export_ctx;
        DWORD err;
@@ -180,16 +140,8 @@ read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
              size, lte->file_on_disk);
 
        export_ctx.read_prefix_cb = cb;
-       export_ctx.read_prefix_ctx_or_buf = ctx_or_buf;
+       export_ctx.read_prefix_ctx = cb_ctx;
        export_ctx.wimlib_err_code = 0;
-       if (cb) {
-               export_ctx.buf = MALLOC(WIM_CHUNK_SIZE);
-               if (!export_ctx.buf)
-                       return WIMLIB_ERR_NOMEM;
-       } else {
-               export_ctx.buf = NULL;
-       }
-       export_ctx.buf_filled = 0;
        export_ctx.bytes_remaining = size;
 
        err = OpenEncryptedFileRaw(lte->file_on_disk, 0, &file_ctx);
@@ -197,8 +149,7 @@ read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
                set_errno_from_win32_error(err);
                ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
                                 "for raw read", lte->file_on_disk);
-               ret = WIMLIB_ERR_OPEN;
-               goto out_free_buf;
+               return WIMLIB_ERR_OPEN;
        }
        err = ReadEncryptedFileRaw(win32_encrypted_export_cb,
                                   &export_ctx, file_ctx);
@@ -219,8 +170,6 @@ read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
                ret = 0;
        }
        CloseEncryptedFileRaw(file_ctx);
-out_free_buf:
-       FREE(export_ctx.buf);
        return ret;
 }
 
@@ -402,7 +351,7 @@ win32_get_security_descriptor(HANDLE hFile,
                default:
                fail:
                        set_errno_from_win32_error(err);
-                       ERROR("Failed to read security descriptor of \"%ls\"", path);
+                       ERROR_WITH_ERRNO("Failed to read security descriptor of \"%ls\"", path);
                        ret = WIMLIB_ERR_READ;
                        goto out_free_buf;
                }
@@ -673,7 +622,7 @@ win32_capture_maybe_rpfix_target(wchar_t *target, u16 *target_nbytes_p,
 static int
 win32_capture_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p,
                        u64 capture_root_ino, u64 capture_root_dev,
-                       const wchar_t *path)
+                       const wchar_t *path, struct add_image_params *params)
 {
        struct reparse_data rpdata;
        int ret;
@@ -710,17 +659,18 @@ win32_capture_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p,
                        ret = -ret;
        } else {
                if (rp_status == RP_EXCLUDED) {
+                       /* Ignoring absolute symbolic link or junction point
+                        * that points out of the tree to be captured.  */
                        size_t print_name_nchars = rpdata.print_name_nbytes / 2;
                        wchar_t print_name0[print_name_nchars + 1];
                        print_name0[print_name_nchars] = L'\0';
                        wmemcpy(print_name0, rpdata.print_name, print_name_nchars);
-                       WARNING("Ignoring %ls pointing out of capture directory:\n"
-                               "          \"%ls\" -> \"%ls\"\n"
-                               "          (Use --norpfix to capture all symbolic links "
-                               "and junction points as-is)",
-                               (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK) ?
-                                       L"absolute symbolic link" : L"junction point",
-                               path, print_name0);
+
+                       params->progress.scan.cur_path = path;
+                       params->progress.scan.symlink_target = print_name0;
+                       do_capture_progress(params,
+                                           WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK,
+                                           NULL);
                }
                ret = rp_status;
        }
@@ -789,7 +739,8 @@ win32_get_reparse_data(HANDLE hFile, const wchar_t *path,
                                              &rpbuflen,
                                              params->capture_root_ino,
                                              params->capture_root_dev,
-                                             path);
+                                             path,
+                                             params);
        } else {
                ret = RP_NOT_FIXED;
        }
@@ -845,7 +796,8 @@ win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret)
  *
  * @inode:              WIM inode to save the stream into.
  *
- * @lookup_table:       Stream lookup table for the WIM.
+ * @unhashed_streams:   List of unhashed streams that have been added to the WIM
+ *                      image.
  *
  * @dat:                A `WIN32_FIND_STREAM_DATA' structure that specifies the
  *                      stream name.
@@ -856,7 +808,7 @@ static int
 win32_capture_stream(const wchar_t *path,
                     size_t path_num_chars,
                     struct wim_inode *inode,
-                    struct wim_lookup_table *lookup_table,
+                    struct list_head *unhashed_streams,
                     WIN32_FIND_STREAM_DATA *dat)
 {
        struct wim_ads_entry *ads_entry;
@@ -952,10 +904,10 @@ win32_capture_stream(const wchar_t *path,
                ret = win32_get_encrypted_file_size(path, &encrypted_size);
                if (ret)
                        goto out_free_spath;
-               lte->resource_entry.original_size = encrypted_size;
+               lte->size = encrypted_size;
        } else {
                lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
-               lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart;
+               lte->size = (u64)dat->StreamSize.QuadPart;
        }
 
        u32 stream_id;
@@ -966,7 +918,7 @@ win32_capture_stream(const wchar_t *path,
                stream_id = 0;
                inode->i_lte = lte;
        }
-       lookup_table_insert_unhashed(lookup_table, lte, inode, stream_id);
+       add_unhashed_stream(lte, inode, stream_id, unhashed_streams);
        ret = 0;
 out_free_spath:
        FREE(spath);
@@ -996,7 +948,7 @@ win32_capture_streams(HANDLE *hFile_p,
                      const wchar_t *path,
                      size_t path_num_chars,
                      struct wim_inode *inode,
-                     struct wim_lookup_table *lookup_table,
+                     struct list_head *unhashed_streams,
                      u64 file_size,
                      unsigned vol_flags)
 {
@@ -1082,7 +1034,7 @@ win32_capture_streams(HANDLE *hFile_p,
 
                        /* Capture the stream.  */
                        ret = win32_capture_stream(path, path_num_chars, inode,
-                                                  lookup_table, &dat);
+                                                  unhashed_streams, &dat);
                        if (ret)
                                goto out_free_buf;
                }
@@ -1139,7 +1091,7 @@ use_FindFirstStream:
        do {
                ret = win32_capture_stream(path,
                                           path_num_chars,
-                                          inode, lookup_table,
+                                          inode, unhashed_streams,
                                           &dat);
                if (ret)
                        goto out_find_close;
@@ -1166,7 +1118,7 @@ unnamed_only:
        wcscpy(dat.cStreamName, L"::$DATA");
        dat.StreamSize.QuadPart = file_size;
        return win32_capture_stream(path, path_num_chars,
-                                   inode, lookup_table, &dat);
+                                   inode, unhashed_streams, &dat);
 }
 
 static int
@@ -1178,17 +1130,16 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
                                  unsigned vol_flags)
 {
        struct wim_dentry *root = NULL;
-       struct wim_inode *inode;
+       struct wim_inode *inode = NULL;
        DWORD err;
        u64 file_size;
        int ret;
        u8 *rpbuf;
        u16 rpbuflen;
        u16 not_rpfixed;
-       HANDLE hFile;
+       HANDLE hFile = INVALID_HANDLE_VALUE;
        DWORD desiredAccess;
 
-       params->progress.scan.cur_path = path;
 
        if (exclude_path(path, path_num_chars, params->config, true)) {
                if (params->add_flags & WIMLIB_ADD_FLAG_ROOT) {
@@ -1196,9 +1147,8 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
                        ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
                        goto out;
                }
-               do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED);
                ret = 0;
-               goto out;
+               goto out_progress;
        }
 
 #if 0
@@ -1213,8 +1163,6 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
        }
 #endif
 
-       do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK);
-
        desiredAccess = FILE_READ_DATA | FILE_READ_ATTRIBUTES |
                        READ_CONTROL | ACCESS_SYSTEM_SECURITY;
 again:
@@ -1243,7 +1191,7 @@ again:
                ERROR_WITH_ERRNO("Failed to get file information for \"%ls\"",
                                 path);
                ret = WIMLIB_ERR_STAT;
-               goto out_close_handle;
+               goto out;
        }
 
        if (file_info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
@@ -1253,12 +1201,12 @@ again:
                if (ret < 0) {
                        /* WIMLIB_ERR_* (inverted) */
                        ret = -ret;
-                       goto out_close_handle;
+                       goto out;
                } else if (ret & RP_FIXED) {
                        not_rpfixed = 0;
                } else if (ret == RP_EXCLUDED) {
                        ret = 0;
-                       goto out_close_handle;
+                       goto out;
                } else {
                        not_rpfixed = 1;
                }
@@ -1279,16 +1227,18 @@ again:
                                        (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)),
                                     &root);
        if (ret)
-               goto out_close_handle;
+               goto out;
 
        ret = win32_get_short_name(hFile, path, root);
        if (ret)
-               goto out_close_handle;
+               goto out;
 
        inode = root->d_inode;
 
-       if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
-               goto out_close_handle;
+       if (inode->i_nlink > 1) {
+               /* Shared inode; nothing more to do */
+               goto out_progress;
+       }
 
        inode->i_attributes = file_info.dwFileAttributes;
        inode->i_creation_time = FILETIME_to_u64(&file_info.ftCreationTime);
@@ -1305,7 +1255,7 @@ again:
                                                    &params->sd_set, state,
                                                    params->add_flags);
                if (ret)
-                       goto out_close_handle;
+                       goto out;
        }
 
        file_size = ((u64)file_info.nFileSizeHigh << 32) |
@@ -1318,11 +1268,11 @@ again:
                                    path,
                                    path_num_chars,
                                    inode,
-                                   params->lookup_table,
+                                   params->unhashed_streams,
                                    file_size,
                                    vol_flags);
        if (ret)
-               goto out_close_handle;
+               goto out;
 
        if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
                /* Reparse point: set the reparse data (which we read already)
@@ -1343,7 +1293,7 @@ again:
                                ERROR_WITH_ERRNO("Failed to reopen \"%ls\"",
                                                 path);
                                ret = WIMLIB_ERR_OPEN;
-                               goto out_close_handle;
+                               goto out;
                        }
                }
                ret = win32_recurse_directory(hFile,
@@ -1354,9 +1304,19 @@ again:
                                              state,
                                              vol_flags);
        }
-out_close_handle:
-       CloseHandle(hFile);
+       if (ret)
+               goto out;
+
+       path[path_num_chars] = '\0';
+out_progress:
+       params->progress.scan.cur_path = path;
+       if (root == NULL)
+               do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
+       else
+               do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
 out:
+       if (hFile != INVALID_HANDLE_VALUE)
+               CloseHandle(hFile);
        if (ret == 0)
                *root_ret = root;
        else
@@ -1402,7 +1362,6 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
        struct win32_capture_state state;
        unsigned vol_flags;
        DWORD dret;
-       bool need_prefix_free = false;
 
        if (!win32func_FindFirstStreamW
 #ifdef WITH_NTDLL
@@ -1431,8 +1390,8 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
        /* WARNING: There is no check for overflow later when this buffer is
         * being used!  But it's as long as the maximum path length understood
         * by Windows NT (which is NOT the same as MAX_PATH). */
-       path = MALLOC(WINDOWS_NT_MAX_PATH * sizeof(wchar_t));
-       if (!path)
+       path = MALLOC((WINDOWS_NT_MAX_PATH + 1) * sizeof(wchar_t));
+       if (path == NULL)
                return WIMLIB_ERR_NOMEM;
 
        /* Work around defective behavior in Windows where paths longer than 260
@@ -1440,37 +1399,45 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
         * turned into absolute paths and prefixed with "\\?\".  */
 
        if (wcsncmp(root_disk_path, L"\\\\?\\", 4)) {
-               dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 4,
+               dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 3,
                                       &path[4], NULL);
 
-               if (dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 4) {
+               if (dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 3) {
                        WARNING("Can't get full path name for \"%ls\"", root_disk_path);
                        wmemcpy(path, root_disk_path, path_nchars + 1);
                } else {
                        wmemcpy(path, L"\\\\?\\", 4);
                        path_nchars = 4 + dret;
-                       /* Update pattern prefix */
-                       if (params->config != NULL)
-                       {
-                               params->config->_prefix = TSTRDUP(path);
-                               params->config->_prefix_num_tchars = path_nchars;
-                               if (params->config->_prefix == NULL)
-                               {
-                                       ret = WIMLIB_ERR_NOMEM;
-                                       goto out_free_path;
-                               }
-                               need_prefix_free = true;
-                       }
                }
        } else {
                wmemcpy(path, root_disk_path, path_nchars + 1);
        }
 
+       /* Strip trailing slashes.  */
+       while (path_nchars >= 2 &&
+              is_any_path_separator(path[path_nchars - 1]) &&
+              path[path_nchars - 2] != L':')
+       {
+               path[--path_nchars] = L'\0';
+       }
+
+       /* Update pattern prefix.  */
+       if (params->config != NULL)
+       {
+               params->config->_prefix = TSTRDUP(path);
+               params->config->_prefix_num_tchars = path_nchars;
+               if (params->config->_prefix == NULL)
+               {
+                       ret = WIMLIB_ERR_NOMEM;
+                       goto out_free_path;
+               }
+       }
+
        memset(&state, 0, sizeof(state));
        ret = win32_build_dentry_tree_recursive(root_ret, path,
                                                path_nchars, params,
                                                &state, vol_flags);
-       if (need_prefix_free)
+       if (params->config != NULL)
                FREE(params->config->_prefix);
 out_free_path:
        FREE(path);