]> wimlib.net Git - wimlib/blobdiff - src/ntfs-3g_capture.c
Refactor some of the dentry, inode, and lookup table code
[wimlib] / src / ntfs-3g_capture.c
index d81248ebf8354ba6f6fa268f844386630c063b60..11cbc9ddb9c288f28f59ad0f81b132a1d01d4b92 100644 (file)
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
-
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
 
 #ifdef WITH_NTFS_3G
 
+#include <errno.h>
+#include <stdlib.h>
+
 #ifdef HAVE_ALLOCA_H
 #  include <alloca.h>
-
 #endif
-#include <errno.h>
-#include <stdlib.h>
-#include <time.h> /* NTFS-3g headers are missing <time.h> include */
-#include <unistd.h>
 
 #include <ntfs-3g/attrib.h>
-#include <ntfs-3g/endians.h>
-#include <ntfs-3g/layout.h>
-#include <ntfs-3g/misc.h>
 #include <ntfs-3g/reparse.h>
-#include <ntfs-3g/security.h> /* ntfs-3g/security.h before ntfs-3g/xattrs.h */
-#include <ntfs-3g/types.h>
+#include <ntfs-3g/security.h>
 #include <ntfs-3g/volume.h>
-#include <ntfs-3g/xattrs.h>
-
-#include <ntfs-3g/acls.h> /* This should be included last as it requires
-                            definitions from above not included by itself */
 
 #include "wimlib/capture.h"
 #include "wimlib/dentry.h"
@@ -86,11 +75,8 @@ open_ntfs_attr(ntfs_inode *ni, struct ntfs_location *loc)
 }
 
 int
-read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
-                     u64 size,
-                     consume_data_callback_t cb,
-                     void *ctx_or_buf,
-                     int _ignored_flags)
+read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte, u64 size,
+                     consume_data_callback_t cb, void *cb_ctx)
 {
        struct ntfs_location *loc = lte->ntfs_loc;
        ntfs_volume *vol = loc->ntfs_vol;
@@ -98,10 +84,10 @@ read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
        ntfs_attr *na;
        s64 pos;
        s64 bytes_remaining;
-       void *out_buf;
        int ret;
+       u8 buf[BUFFER_SIZE];
 
-       ni = ntfs_pathname_to_inode(vol, NULL, loc->path);
+       ni = ntfs_pathname_to_inode(vol, NULL, loc->path);
        if (!ni) {
                ERROR_WITH_ERRNO("Can't find NTFS inode for \"%"TS"\"", loc->path);
                ret = WIMLIB_ERR_NTFS_3G;
@@ -114,28 +100,20 @@ read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
                goto out_close_ntfs_inode;
        }
 
-       if (cb)
-               out_buf = alloca(WIM_CHUNK_SIZE);
-       else
-               out_buf = ctx_or_buf;
        pos = (loc->is_reparse_point) ? 8 : 0;
        bytes_remaining = size;
        while (bytes_remaining) {
-               s64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
-               if (ntfs_attr_pread(na, pos, to_read, out_buf) != to_read) {
+               s64 to_read = min(bytes_remaining, sizeof(buf));
+               if (ntfs_attr_pread(na, pos, to_read, buf) != to_read) {
                        ERROR_WITH_ERRNO("Error reading \"%"TS"\"", loc->path);
                        ret = WIMLIB_ERR_NTFS_3G;
                        goto out_close_ntfs_attr;
                }
                pos += to_read;
                bytes_remaining -= to_read;
-               if (cb) {
-                       ret = cb(out_buf, to_read, ctx_or_buf);
-                       if (ret)
-                               goto out_close_ntfs_attr;
-               } else {
-                       out_buf += to_read;
-               }
+               ret = cb(buf, to_read, cb_ctx);
+               if (ret)
+                       goto out_close_ntfs_attr;
        }
        ret = 0;
 out_close_ntfs_attr:
@@ -177,14 +155,13 @@ out:
 
 }
 
-/* Load the streams from a file or reparse point in the NTFS volume into the WIM
- * lookup table */
+/* Load the streams from a file or reparse point in the NTFS volume  */
 static int
 capture_ntfs_streams(struct wim_inode *inode,
                     ntfs_inode *ni,
                     char *path,
                     size_t path_len,
-                    struct wim_lookup_table *lookup_table,
+                    struct list_head *unhashed_streams,
                     ntfs_volume *vol,
                     ATTR_TYPES type)
 {
@@ -193,13 +170,13 @@ capture_ntfs_streams(struct wim_inode *inode,
        int ret;
        struct wim_lookup_table_entry *lte;
 
-       DEBUG2("Capturing NTFS data streams from `%s'", path);
+       DEBUG("Capturing NTFS data streams from `%s'", path);
 
        /* Get context to search the streams of the NTFS file. */
        actx = ntfs_attr_get_search_ctx(ni, NULL);
        if (!actx) {
                ERROR_WITH_ERRNO("Cannot get NTFS attribute search "
-                                "context");
+                                "context for \"%s\"", path);
                return WIMLIB_ERR_NTFS_3G;
        }
 
@@ -247,33 +224,38 @@ capture_ntfs_streams(struct wim_inode *inode,
                        ntfs_loc = NULL;
                        if (type == AT_REPARSE_POINT) {
                                if (data_size < 8) {
-                                       ERROR("Invalid reparse data (only %u bytes)!",
-                                             (unsigned)data_size);
+                                       ERROR("Invalid reparse data on \"%s\" "
+                                             "(only %u bytes)!", path, (unsigned)data_size);
                                        ret = WIMLIB_ERR_NTFS_3G;
                                        goto out_free_lte;
                                }
                                lte->ntfs_loc->is_reparse_point = true;
-                               lte->resource_entry.original_size = data_size - 8;
+                               lte->size = data_size - 8;
                                ret = read_reparse_tag(ni, lte->ntfs_loc,
                                                       &inode->i_reparse_tag);
                                if (ret)
                                        goto out_free_lte;
                        } else {
                                lte->ntfs_loc->is_reparse_point = false;
-                               lte->resource_entry.original_size = data_size;
+                               lte->size = data_size;
                        }
                }
                if (name_length == 0) {
                        /* Unnamed data stream.  Put the reference to it in the
                         * dentry's inode. */
                        if (inode->i_lte) {
-                               ERROR("Found two un-named data streams for `%s'",
-                                     path);
-                               ret = WIMLIB_ERR_NTFS_3G;
-                               goto out_free_lte;
+                               if (lte) {
+                                       ERROR("Found two un-named data streams for \"%s\" "
+                                             "(sizes = %"PRIu64", %"PRIu64")",
+                                             path, inode->i_lte->size,
+                                             lte->size);
+                                       ret = WIMLIB_ERR_NTFS_3G;
+                                       goto out_free_lte;
+                               }
+                       } else {
+                               stream_id = 0;
+                               inode->i_lte = lte;
                        }
-                       stream_id = 0;
-                       inode->i_lte = lte;
                } else {
                        /* Named data stream.  Put the reference to it in the
                         * alternate data stream entries */
@@ -291,15 +273,14 @@ capture_ntfs_streams(struct wim_inode *inode,
                        new_ads_entry->lte = lte;
                }
                if (lte) {
-                       lookup_table_insert_unhashed(lookup_table, lte,
-                                                    inode, stream_id);
+                       add_unhashed_stream(lte, inode,
+                                           stream_id, unhashed_streams);
                }
        }
        if (errno == ENOENT) {
                ret = 0;
        } else {
-               ERROR_WITH_ERRNO("Error listing NTFS attributes from `%s'",
-                                path);
+               ERROR_WITH_ERRNO("Error listing NTFS attributes of \"%s\"", path);
                ret = WIMLIB_ERR_NTFS_3G;
        }
        goto out_put_actx;
@@ -314,9 +295,9 @@ out_free_ntfs_loc:
 out_put_actx:
        ntfs_attr_put_search_ctx(actx);
        if (ret == 0)
-               DEBUG2("Successfully captured NTFS streams from `%s'", path);
+               DEBUG("Successfully captured NTFS streams from \"%s\"", path);
        else
-               ERROR("Failed to capture NTFS streams from `%s'", path);
+               ERROR("Failed to capture NTFS streams from \"%s\"", path);
        return ret;
 }
 
@@ -329,13 +310,13 @@ struct dos_name_node {
        struct rb_node rb_node;
        char dos_name[24];
        int name_nbytes;
-       u64 ntfs_ino;
+       le64 ntfs_ino;
 };
 
 /* Inserts a new DOS name into the map */
 static int
 insert_dos_name(struct dos_name_map *map, const ntfschar *dos_name,
-               size_t name_nbytes, u64 ntfs_ino)
+               size_t name_nbytes, le64 ntfs_ino)
 {
        struct dos_name_node *new_node;
        struct rb_node **p;
@@ -375,13 +356,13 @@ insert_dos_name(struct dos_name_map *map, const ntfschar *dos_name,
                         * have multiple DOS names, and we only should get each
                         * DOS name entry once from the ntfs_readdir() calls. */
                        ERROR("NTFS inode %"PRIu64" has multiple DOS names",
-                             ntfs_ino);
+                               le64_to_cpu(ntfs_ino));
                        return -1;
                }
        }
        rb_link_node(&new_node->rb_node, rb_parent, p);
        rb_insert_color(&new_node->rb_node, root);
-       DEBUG("Inserted DOS name for inode %"PRIu64, ntfs_ino);
+       DEBUG("Inserted DOS name for inode %"PRIu64, le64_to_cpu(ntfs_ino));
        return 0;
 }
 
@@ -448,7 +429,6 @@ destroy_dos_name_map(struct dos_name_map *map)
 
 struct readdir_ctx {
        struct wim_dentry *parent;
-       ntfs_inode *dir_ni;
        char *path;
        size_t path_len;
        struct dos_name_map *dos_name_map;
@@ -458,7 +438,6 @@ struct readdir_ctx {
 
 static int
 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_p,
-                                ntfs_inode *dir_ni,
                                 ntfs_inode *ni,
                                 char *path,
                                 size_t path_len,
@@ -509,10 +488,14 @@ wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
 
        /* Open the inode for this directory entry and recursively capture the
         * directory tree rooted at it */
-       ntfs_inode *ni = ntfs_inode_open(ctx->dir_ni->vol, mref);
+       ntfs_inode *ni = ntfs_inode_open(ctx->vol, mref);
        if (!ni) {
-               ERROR_WITH_ERRNO("Failed to open NTFS inode");
-               ret = -1;
+               /* XXX This used to be treated as an error, but NTFS-3g seemed
+                * to be unable to read some inodes on a Windows 8 image for
+                * some reason. */
+               WARNING_WITH_ERRNO("Failed to open NTFS file \"%s/%s\"",
+                                  ctx->path, mbs_name);
+               ret = 0;
                goto out_free_mbs_name;
        }
        path_len = ctx->path_len;
@@ -521,15 +504,17 @@ wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
        memcpy(ctx->path + path_len, mbs_name, mbs_name_nbytes + 1);
        path_len += mbs_name_nbytes;
        child = NULL;
-       ret = build_dentry_tree_ntfs_recursive(&child, ctx->dir_ni,
-                                              ni, ctx->path, path_len, name_type,
+       ret = build_dentry_tree_ntfs_recursive(&child, ni, ctx->path,
+                                              path_len, name_type,
                                               ctx->vol, ctx->params);
+       path_len -= mbs_name_nbytes + 1;
        if (child)
                dentry_add_child(ctx->parent, child);
        ntfs_inode_close(ni);
 out_free_mbs_name:
        FREE(mbs_name);
 out:
+       ctx->path[ctx->path_len] = '\0';
        return ret;
 }
 
@@ -539,7 +524,6 @@ out:
  */
 static int
 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
-                                ntfs_inode *dir_ni,
                                 ntfs_inode *ni,
                                 char *path,
                                 size_t path_len,
@@ -549,46 +533,38 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
 {
        le32 attributes;
        int ret;
-       struct wim_dentry *root;
-       struct wim_inode *inode;
+       struct wim_dentry *root = NULL;
+       struct wim_inode *inode = NULL;
        ATTR_TYPES stream_type;
 
        if (exclude_path(path, path_len, params->config, false)) {
                /* Exclude a file or directory tree based on the capture
-                * configuration file */
-               if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
-                   && params->progress_func)
-               {
-                       union wimlib_progress_info info;
-                       info.scan.cur_path = path;
-                       info.scan.excluded = true;
-                       params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
-               }
-               root = NULL;
+                * configuration file.  */
                ret = 0;
-               goto out;
+               goto out_progress;
        }
 
        /* Get file attributes */
-       struct SECURITY_CONTEXT ctx;
-       memset(&ctx, 0, sizeof(ctx));
-       ctx.vol = vol;
-       ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ATTRIB,
-                                        ni, dir_ni, (char *)&attributes,
-                                        sizeof(attributes));
+       ret = ntfs_get_ntfs_attrib(ni, (char*)&attributes, sizeof(attributes));
        if (ret != sizeof(attributes)) {
-               ERROR_WITH_ERRNO("Failed to get NTFS attributes from `%s'",
-                                path);
-               return WIMLIB_ERR_NTFS_3G;
+               ERROR_WITH_ERRNO("Failed to get NTFS attributes from \"%s\"", path);
+               ret = WIMLIB_ERR_NTFS_3G;
+               goto out;
        }
 
-       if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
-           && params->progress_func)
+       if ((attributes & (FILE_ATTRIBUTE_DIRECTORY |
+                          FILE_ATTRIBUTE_ENCRYPTED)) == FILE_ATTRIBUTE_ENCRYPTED)
        {
-               union wimlib_progress_info info;
-               info.scan.cur_path = path;
-               info.scan.excluded = false;
-               params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
+               if (params->add_flags & WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE)
+               {
+                       ERROR("Can't archive unsupported encrypted file \"%s\"", path);
+                       ret = WIMLIB_ERR_UNSUPPORTED_FILE;
+                       goto out;
+               }
+               params->progress.scan.cur_path = path;
+               do_capture_progress(params, WIMLIB_SCAN_DENTRY_UNSUPPORTED, NULL);
+               ret = 0;
+               goto out;
        }
 
        /* Create a WIM dentry with an associated inode, which may be shared */
@@ -596,15 +572,19 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
                                     path_basename_with_len(path, path_len),
                                     ni->mft_no, 0, false, &root);
        if (ret)
-               return ret;
-
-       inode = root->d_inode;
-
-       if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
                goto out;
 
        if (name_type & FILE_NAME_WIN32) /* Win32 or Win32+DOS name (rather than POSIX) */
                root->is_win32_name = 1;
+
+       inode = root->d_inode;
+
+       if (inode->i_nlink > 1) {
+               /* Shared inode; nothing more to do */
+               ret = 0;
+               goto out_progress;
+       }
+
        inode->i_creation_time    = le64_to_cpu(ni->creation_time);
        inode->i_last_write_time  = le64_to_cpu(ni->last_data_change_time);
        inode->i_last_access_time = le64_to_cpu(ni->last_access_time);
@@ -624,7 +604,7 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
         * - Reparse points: capture reparse data only
         */
        ret = capture_ntfs_streams(inode, ni, path, path_len,
-                                  params->lookup_table, vol, stream_type);
+                                  params->unhashed_streams, vol, stream_type);
        if (ret)
                goto out;
 
@@ -635,7 +615,6 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
                struct dos_name_map dos_name_map = { .rb_root = {.rb_node = NULL} };
                struct readdir_ctx ctx = {
                        .parent          = root,
-                       .dir_ni          = ni,
                        .path            = path,
                        .path_len        = path_len,
                        .dos_name_map    = &dos_name_map,
@@ -644,7 +623,7 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
                };
                ret = ntfs_readdir(ni, &pos, &ctx, wim_ntfs_capture_filldir);
                if (ret) {
-                       ERROR_WITH_ERRNO("ntfs_readdir()");
+                       ERROR_WITH_ERRNO("Error reading directory \"%s\"", path);
                        ret = WIMLIB_ERR_NTFS_3G;
                } else {
                        ret = for_dentry_child(root, set_dentry_dos_name,
@@ -654,6 +633,7 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
                if (ret)
                        goto out;
        }
+       path[path_len] = '\0';
 
        /* Reparse-point fixups are a no-op because in NTFS-3g capture mode we
         * only allow capturing an entire volume. */
@@ -662,17 +642,20 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
                inode->i_not_rpfixed = 0;
 
        if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)) {
+               struct SECURITY_CONTEXT sec_ctx;
+               char _sd[4096];
+               char *sd;
+
                /* Get security descriptor */
-               char _sd[1];
-               char *sd = _sd;
+               memset(&sec_ctx, 0, sizeof(sec_ctx));
+               sec_ctx.vol = vol;
+
                errno = 0;
-               ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
-                                                ni, dir_ni, sd,
-                                                sizeof(sd));
-               if (ret > sizeof(sd)) {
+               sd = _sd;
+               ret = ntfs_get_ntfs_acl(&sec_ctx, ni, sd, sizeof(_sd));
+               if (ret > sizeof(_sd)) {
                        sd = alloca(ret);
-                       ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
-                                                        ni, dir_ni, sd, ret);
+                       ret = ntfs_get_ntfs_acl(&sec_ctx, ni, sd, ret);
                }
                if (ret > 0) {
                        inode->i_security_id = sd_set_add_sd(&params->sd_set,
@@ -694,6 +677,15 @@ build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
                        DEBUG("No security ID for `%s'", path);
                }
        }
+       if (ret)
+               goto out;
+
+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 (ret == 0)
                *root_ret = root;
@@ -724,12 +716,22 @@ build_dentry_tree_ntfs(struct wim_dentry **root_p,
 
        DEBUG("Mounting NTFS volume `%s' read-only", device);
 
-#if defined(NTFS_MNT_RDONLY)
+/* NTFS-3g 2013 renamed the "read-only" mount flag from MS_RDONLY to
+ * NTFS_MNT_RDONLY.
+ *
+ * Unfortunately we can't check for defined(NTFS_MNT_RDONLY) because
+ * NTFS_MNT_RDONLY is an enumerated constant.  Also, the NTFS-3g headers don't
+ * seem to contain any explicit version information.  So we have to rely on a
+ * test done at configure time to detect whether NTFS_MNT_RDONLY should be used.
+ * */
+#ifdef HAVE_NTFS_MNT_RDONLY
        /* NTFS-3g 2013 */
        vol = ntfs_mount(device, NTFS_MNT_RDONLY);
 #elif defined(MS_RDONLY)
        /* NTFS-3g 2011, 2012 */
        vol = ntfs_mount(device, MS_RDONLY);
+#else
+  #error "Can't find NTFS_MNT_RDONLY or MS_RDONLY flags"
 #endif
        if (!vol) {
                ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s' read-only",
@@ -763,7 +765,7 @@ build_dentry_tree_ntfs(struct wim_dentry **root_p,
 
        path[0] = '/';
        path[1] = '\0';
-       ret = build_dentry_tree_ntfs_recursive(root_p, NULL, root_ni, path, 1,
+       ret = build_dentry_tree_ntfs_recursive(root_p, root_ni, path, 1,
                                               FILE_NAME_POSIX, vol, params);
 out_cleanup:
        FREE(path);