]> wimlib.net Git - wimlib/blobdiff - src/win32.c
win32: handle excluded reparse points correctly
[wimlib] / src / win32.c
index 0db8c3bf72583dcbe6e9c4091996dd5eac7745ce..40a41e422bab5b7a5bab8cf4632c794b4ca4aca4 100644 (file)
@@ -618,14 +618,47 @@ win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret)
        return ret;
 }
 
+/* Reparse point fixup status code */
 enum rp_status {
+       /* Reparse point corresponded to an absolute symbolic link or junction
+        * point that pointed outside the directory tree being captured, and
+        * therefore was excluded. */
        RP_EXCLUDED       = 0x0,
+
+       /* Reparse point was not fixed as it was either a relative symbolic
+        * link, a mount point, or something else we could not understand. */
        RP_NOT_FIXED      = 0x1,
+
+       /* Reparse point corresponded to an absolute symbolic link or junction
+        * point that pointed inside the directory tree being captured, where
+        * the target was specified by a "full" \??\ prefixed path, and
+        * therefore was fixed to be relative to the root of the directory tree
+        * being captured. */
        RP_FIXED_FULLPATH = 0x2,
+
+       /* Same as RP_FIXED_FULLPATH, except the absolute link target did not
+        * have the \??\ prefix.  It may have begun with a drive letter though.
+        * */
        RP_FIXED_ABSPATH  = 0x4,
+
+       /* Either RP_FIXED_FULLPATH or RP_FIXED_ABSPATH. */
        RP_FIXED          = RP_FIXED_FULLPATH | RP_FIXED_ABSPATH,
 };
 
+/* Given the "substitute name" target of a Windows reparse point, try doing a
+ * fixup where we change it to be absolute relative to the root of the directory
+ * tree being captured.
+ *
+ * Note that this is only executed when WIMLIB_ADD_IMAGE_FLAG_RPFIX has been
+ * set.
+ *
+ * @capture_root_ino and @capture_root_dev indicate the inode number and device
+ * of the root of the directory tree being captured.  They are meant to identify
+ * this directory (as an alternative to its actual path, which could potentially
+ * be reached via multiple destinations due to other symbolic links).  This may
+ * not work properly on FAT, which doesn't seem to supply proper inode numbers
+ * or file IDs.  However, FAT doesn't support reparse points so this function
+ * wouldn't even be called anyway.  */
 static enum rp_status
 win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
                         u64 capture_root_ino, u64 capture_root_dev)
@@ -635,11 +668,12 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
        wchar_t *orig_target;
 
        if (target_nchars == 0)
+               /* Invalid reparse point (empty target) */
                return RP_NOT_FIXED;
 
        if (target[0] == L'\\') {
                if (target_nchars >= 2 && target[1] == L'\\') {
-                       /* Probaby a volume.  Can't do anything with it. */
+                       /* Probably a volume.  Can't do anything with it. */
                        DEBUG("Not fixing target (probably a volume)");
                        return RP_NOT_FIXED;
                } else if (target_nchars >= 7 &&
@@ -653,7 +687,7 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
                        DEBUG("Full style path");
                        /* Full \??\x:\ style path (may be junction or symlink)
                         * */
-                       stripped_chars = 4;
+                       stripped_chars = 6;
                } else {
                        DEBUG("Absolute target without drive letter");
                        /* Absolute target, without drive letter */
@@ -666,7 +700,7 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
        {
                DEBUG("Absolute target with drive letter");
                /* Absolute target, with drive letter */
-               stripped_chars = 0;
+               stripped_chars = 2;
        } else {
                DEBUG("Relative symlink or other link");
                /* Relative symlink or other unexpected format */
@@ -675,20 +709,21 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
        target[target_nchars] = L'\0';
        orig_target = target;
        target = fixup_symlink(target + stripped_chars, capture_root_ino, capture_root_dev);
-       if (target) {
-               target_nchars = wcslen(target);
-               wmemmove(orig_target + stripped_chars, target, target_nchars + 1);
-               *target_nchars_p = target_nchars + stripped_chars;
-               DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target);
-               return stripped_chars ? RP_FIXED_FULLPATH : RP_FIXED_ABSPATH;
-       } else {
+       if (!target)
                return RP_EXCLUDED;
-       }
+       target_nchars = wcslen(target);
+       wmemmove(orig_target + stripped_chars, target, target_nchars + 1);
+       *target_nchars_p = target_nchars + stripped_chars;
+       DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target);
+       if (stripped_chars == 6)
+               return RP_FIXED_FULLPATH;
+       else
+               return RP_FIXED_ABSPATH;
 }
 
 static enum rp_status
-win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
-                      u64 capture_root_ino, u64 capture_root_dev)
+win32_try_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
+                       u64 capture_root_ino, u64 capture_root_dev)
 {
        const char *p_get;
        char *p_put;
@@ -700,21 +735,22 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
        u32 rptag;
        DWORD rpbuflen = *rpbuflen_p;
 
-       if (rpbuflen < 16)
-               return RP_EXCLUDED;
+       if (rpbuflen < 16) /* Invalid reparse point (length too small) */
+               return RP_NOT_FIXED;
        p_get = get_u32(rpbuf, &rptag);
        p_get += 4;
        p_get = get_u16(p_get, &substitute_name_offset);
        p_get = get_u16(p_get, &substitute_name_len);
        p_get += 4;
-       if ((size_t)substitute_name_offset + substitute_name_len > rpbuflen)
-               return RP_EXCLUDED;
        if (rptag == WIM_IO_REPARSE_TAG_SYMLINK) {
-               if (rpbuflen < 20)
-                       return RP_EXCLUDED;
+               if (rpbuflen < 20) /* Invalid reparse point (length too small) */
+                       return RP_NOT_FIXED;
                p_get += 4;
        }
-
+       if ((DWORD)substitute_name_offset +
+           substitute_name_len + (p_get - rpbuf) > rpbuflen)
+               /* Invalid reparse point (length too small) */
+               return RP_NOT_FIXED;
 
        target = (wchar_t*)&p_get[substitute_name_offset];
        target_nchars = substitute_name_len / 2;
@@ -729,6 +765,9 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
                wchar_t *print_name = target_copy;
 
                if (status == RP_FIXED_FULLPATH) {
+                       /* "full path", meaning \??\ prefixed.  We should not
+                        * include this prefix in the print name, as it is
+                        * apparently meant for the filesystem driver only. */
                        print_nbytes -= 8;
                        print_name += 4;
                }
@@ -744,6 +783,9 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
                p_put = put_u16(p_put, 0);
                p_put = put_bytes(p_put, print_nbytes, print_name);
                p_put = put_u16(p_put, 0);
+
+               /* Wrote the end of the reparse data.  Recalculate the length,
+                * set the length field correctly, and return it. */
                rpbuflen = p_put - rpbuf;
                put_u16(rpbuf + 4, rpbuflen - 8);
                *rpbuflen_p = rpbuflen;
@@ -751,69 +793,51 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
        return status;
 }
 
-/* Load a reparse point into a WIM inode.  It is just stored in memory.
- *
- * @hFile is the open handle to a reparse point, with permission to read the
- * reparse data.
- *
- * @inode is the WIM inode for the reparse point.
- */
 static int
-win32_capture_reparse_point(struct wim_dentry **root_p,
-                           HANDLE hFile,
-                           struct wim_inode *inode,
-                           const wchar_t *path,
-                           struct add_image_params *params)
+win32_get_reparse_data(HANDLE hFile, const wchar_t *path,
+                      struct add_image_params *params,
+                      void *reparse_data, size_t *reparse_data_len_ret)
 {
-       DEBUG("Capturing reparse point \"%ls\"", path);
-
-       /* "Reparse point data, including the tag and optional GUID,
-        * cannot exceed 16 kilobytes." - MSDN  */
-       char reparse_point_buf[REPARSE_POINT_MAX_SIZE];
        DWORD bytesReturned;
-       char *fixed_buf;
-       DWORD fixed_len;
+       u32 reparse_tag;
+       enum rp_status status;
 
+       DEBUG("Loading reparse data from \"%ls\"", path);
        if (!DeviceIoControl(hFile, FSCTL_GET_REPARSE_POINT,
                             NULL, /* "Not used with this operation; set to NULL" */
                             0, /* "Not used with this operation; set to 0" */
-                            reparse_point_buf, /* "A pointer to a buffer that
+                            reparse_data, /* "A pointer to a buffer that
                                                   receives the reparse point data */
-                            sizeof(reparse_point_buf), /* "The size of the output
-                                                          buffer, in bytes */
+                            REPARSE_POINT_MAX_SIZE, /* "The size of the output
+                                                       buffer, in bytes */
                             &bytesReturned,
                             NULL))
        {
                DWORD err = GetLastError();
                ERROR("Failed to get reparse data of \"%ls\"", path);
                win32_error(err);
-               return WIMLIB_ERR_READ;
+               return -WIMLIB_ERR_READ;
        }
        if (bytesReturned < 8) {
                ERROR("Reparse data on \"%ls\" is invalid", path);
-               return WIMLIB_ERR_READ;
+               return -WIMLIB_ERR_READ;
        }
-       inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_point_buf);
 
+       reparse_tag = le32_to_cpu(*(u32*)reparse_data);
        if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX &&
-           (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
-            inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
+           (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
+            reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
        {
-               enum rp_status status;
-               status = win32_do_capture_rpfix(reparse_point_buf,
-                                               &bytesReturned,
-                                               params->capture_root_ino,
-                                               params->capture_root_dev);
-               if (status == RP_EXCLUDED) {
-                       free_dentry(*root_p);
-                       *root_p = NULL;
-                       return 0;
-               } else if (status & RP_FIXED) {
-                       inode->i_not_rpfixed = 0;
-               }
+               /* Try doing reparse point fixup */
+               status = win32_try_capture_rpfix(reparse_data,
+                                                &bytesReturned,
+                                                params->capture_root_ino,
+                                                params->capture_root_dev);
+       } else {
+               status = RP_NOT_FIXED;
        }
-       return inode_set_unnamed_stream(inode, reparse_point_buf + 8,
-                                       bytesReturned - 8, params->lookup_table);
+       *reparse_data_len_ret = bytesReturned;
+       return status;
 }
 
 /* Scans an unnamed or named stream of a Win32 file (not a reparse point
@@ -1072,8 +1096,10 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
        struct wim_inode *inode;
        DWORD err;
        u64 file_size;
-       int ret = 0;
-       const wchar_t *basename;
+       int ret;
+       void *reparse_data;
+       size_t reparse_data_len;
+       u16 not_rpfixed;
 
        if (exclude_path(path, path_num_chars, params->config, true)) {
                if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
@@ -1089,6 +1115,7 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
                        info.scan.excluded = true;
                        params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
                }
+               ret = 0;
                goto out;
        }
 
@@ -1121,31 +1148,40 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
                goto out_close_handle;
        }
 
+       if (file_info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+               reparse_data = alloca(REPARSE_POINT_MAX_SIZE);
+               ret = win32_get_reparse_data(hFile, path, params,
+                                            reparse_data, &reparse_data_len);
+               if (ret < 0) {
+                       /* WIMLIB_ERR_* (inverted) */
+                       ret = -ret;
+                       goto out_close_handle;
+               } else if (ret & RP_FIXED) {
+                       not_rpfixed = 0;
+               } else if (ret == RP_EXCLUDED) {
+                       ret = 0;
+                       goto out_close_handle;
+               } else {
+                       not_rpfixed = 1;
+               }
+       }
+
        /* Create a WIM dentry with an associated inode, which may be shared.
         *
         * However, we need to explicitly check for directories and files with
         * only 1 link and refuse to hard link them.  This is because Windows
         * has a bug where it can return duplicate File IDs for files and
         * directories on the FAT filesystem. */
-       basename = path_basename_with_len(path, path_num_chars);
-       if (!(file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
-           && file_info.nNumberOfLinks > 1)
-       {
-               ret = inode_table_new_dentry(params->inode_table,
-                                            basename,
-                                            ((u64)file_info.nFileIndexHigh << 32) |
-                                                (u64)file_info.nFileIndexLow,
-                                            file_info.dwVolumeSerialNumber,
-                                            &root);
-               if (ret)
-                       goto out_close_handle;
-       } else {
-               ret = new_dentry_with_inode(basename, &root);
-               if (ret)
-                       goto out_close_handle;
-               list_add_tail(&root->d_inode->i_list, &params->inode_table->extra_inodes);
-       }
-
+       ret = inode_table_new_dentry(params->inode_table,
+                                    path_basename_with_len(path, path_num_chars),
+                                    ((u64)file_info.nFileIndexHigh << 32) |
+                                        (u64)file_info.nFileIndexLow,
+                                    file_info.dwVolumeSerialNumber,
+                                    (file_info.nNumberOfLinks <= 1 ||
+                                       (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)),
+                                    &root);
+       if (ret)
+               goto out_close_handle;
 
        ret = win32_get_short_name(root, path);
        if (ret)
@@ -1177,39 +1213,33 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
        file_size = ((u64)file_info.nFileSizeHigh << 32) |
                     (u64)file_info.nFileSizeLow;
 
-       if (inode_is_directory(inode)) {
-               /* Directory (not a reparse point) --- recurse to children */
+       /* Capture the unnamed data stream (only should be present for regular
+        * files) and any alternate data streams. */
+       ret = win32_capture_streams(path,
+                                   path_num_chars,
+                                   inode,
+                                   params->lookup_table,
+                                   file_size,
+                                   vol_flags);
+       if (ret)
+               goto out_close_handle;
 
-               /* But first... directories may have alternate data streams that
-                * need to be captured. */
-               ret = win32_capture_streams(path,
-                                           path_num_chars,
-                                           inode,
-                                           params->lookup_table,
-                                           file_size,
-                                           vol_flags);
-               if (ret)
-                       goto out_close_handle;
+       if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+               /* Reparse point: set the reparse data (which we read already)
+                * */
+               inode->i_not_rpfixed = not_rpfixed;
+               inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_data);
+               ret = inode_set_unnamed_stream(inode, reparse_data + 8,
+                                              reparse_data_len - 8,
+                                              params->lookup_table);
+       } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
+               /* Directory (not a reparse point) --- recurse to children */
                ret = win32_recurse_directory(root,
                                              path,
                                              path_num_chars,
                                              params,
                                              state,
                                              vol_flags);
-       } else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
-               /* Reparse point: save the reparse tag and data.  Alternate data
-                * streams are not captured, if it's even possible for a reparse
-                * point to have alternate data streams... */
-               ret = win32_capture_reparse_point(&root, hFile, inode, path, params);
-       } else {
-               /* Not a directory, not a reparse point; capture the default
-                * file contents and any alternate data streams. */
-               ret = win32_capture_streams(path,
-                                           path_num_chars,
-                                           inode,
-                                           params->lookup_table,
-                                           file_size,
-                                           vol_flags);
        }
 out_close_handle:
        CloseHandle(hFile);