wimlib.net Git - wimlib/blob - src/ntfs-3g_capture.c

   1 /*
   2  * ntfs-3g_capture.c
   3  *
   4  * Capture a WIM image directly from a NTFS volume using libntfs-3g.  We capture
   5  * everything we can, including security data and alternate data streams.
   6  */
   7
   8 /*
   9  * Copyright (C) 2012, 2013 Eric Biggers
  10  *
  11  * This file is part of wimlib, a library for working with WIM files.
  12  *
  13  * wimlib is free software; you can redistribute it and/or modify it under the
  14  * terms of the GNU General Public License as published by the Free
  15  * Software Foundation; either version 3 of the License, or (at your option)
  16  * any later version.
  17  *
  18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  25  */
  26
  27
  28 #ifdef HAVE_CONFIG_H
  29 #  include "config.h"
  30 #endif
  31
  32 #ifdef WITH_NTFS_3G
  33
  34 #ifdef HAVE_ALLOCA_H
  35 #  include <alloca.h>
  36
  37 #endif
  38 #include <errno.h>
  39 #include <stdlib.h>
  40 #include <time.h> /* NTFS-3g headers are missing <time.h> include */
  41 #include <unistd.h>
  42
  43 #include <ntfs-3g/attrib.h>
  44 #include <ntfs-3g/endians.h>
  45 #include <ntfs-3g/layout.h>
  46 #include <ntfs-3g/misc.h>
  47 #include <ntfs-3g/reparse.h>
  48 #include <ntfs-3g/security.h> /* ntfs-3g/security.h before ntfs-3g/xattrs.h */
  49 #include <ntfs-3g/types.h>
  50 #include <ntfs-3g/volume.h>
  51 #include <ntfs-3g/xattrs.h>
  52
  53 #include <ntfs-3g/acls.h> /* This should be included last as it requires
  54                              definitions from above not included by itself */
  55
  56 #include "wimlib/capture.h"
  57 #include "wimlib/dentry.h"
  58 #include "wimlib/encoding.h"
  59 #include "wimlib/endianness.h"
  60 #include "wimlib/error.h"
  61 #include "wimlib/lookup_table.h"
  62 #include "wimlib/ntfs_3g.h"
  63 #include "wimlib/paths.h"
  64 #include "wimlib/security.h"
  65
  66 static inline ntfschar *
  67 attr_record_name(ATTR_RECORD *ar)
  68 {
  69         return (ntfschar*)((u8*)ar + le16_to_cpu(ar->name_offset));
  70 }
  71
  72 static ntfs_attr *
  73 open_ntfs_attr(ntfs_inode *ni, struct ntfs_location *loc)
  74 {
  75         ntfs_attr *na;
  76
  77         na = ntfs_attr_open(ni,
  78                             loc->is_reparse_point ? AT_REPARSE_POINT : AT_DATA,
  79                             loc->stream_name,
  80                             loc->stream_name_nchars);
  81         if (!na) {
  82                 ERROR_WITH_ERRNO("Failed to open attribute of \"%"TS"\" in "
  83                                  "NTFS volume", loc->path);
  84         }
  85         return na;
  86 }
  87
  88 int
  89 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
  90                       u64 size,
  91                       consume_data_callback_t cb,
  92                       void *ctx_or_buf,
  93                       int _ignored_flags)
  94 {
  95         struct ntfs_location *loc = lte->ntfs_loc;
  96         ntfs_volume *vol = loc->ntfs_vol;
  97         ntfs_inode *ni;
  98         ntfs_attr *na;
  99         s64 pos;
 100         s64 bytes_remaining;
 101         void *out_buf;
 102         int ret;
 103
 104         ni = ntfs_pathname_to_inode(vol, NULL, loc->path);
 105         if (!ni) {
 106                 ERROR_WITH_ERRNO("Can't find NTFS inode for \"%"TS"\"", loc->path);
 107                 ret = WIMLIB_ERR_NTFS_3G;
 108                 goto out;
 109         }
 110
 111         na = open_ntfs_attr(ni, loc);
 112         if (!na) {
 113                 ret = WIMLIB_ERR_NTFS_3G;
 114                 goto out_close_ntfs_inode;
 115         }
 116
 117         if (cb)
 118                 out_buf = alloca(WIM_CHUNK_SIZE);
 119         else
 120                 out_buf = ctx_or_buf;
 121         pos = (loc->is_reparse_point) ? 8 : 0;
 122         bytes_remaining = size;
 123         while (bytes_remaining) {
 124                 s64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
 125                 if (ntfs_attr_pread(na, pos, to_read, out_buf) != to_read) {
 126                         ERROR_WITH_ERRNO("Error reading \"%"TS"\"", loc->path);
 127                         ret = WIMLIB_ERR_NTFS_3G;
 128                         goto out_close_ntfs_attr;
 129                 }
 130                 pos += to_read;
 131                 bytes_remaining -= to_read;
 132                 if (cb) {
 133                         ret = cb(out_buf, to_read, ctx_or_buf);
 134                         if (ret)
 135                                 goto out_close_ntfs_attr;
 136                 } else {
 137                         out_buf += to_read;
 138                 }
 139         }
 140         ret = 0;
 141 out_close_ntfs_attr:
 142         ntfs_attr_close(na);
 143 out_close_ntfs_inode:
 144         ntfs_inode_close(ni);
 145 out:
 146         return ret;
 147 }
 148
 149 static int
 150 read_reparse_tag(ntfs_inode *ni, struct ntfs_location *loc,
 151                  u32 *reparse_tag_ret)
 152 {
 153         int ret;
 154         le32 reparse_tag;
 155         ntfs_attr *na;
 156
 157         na = open_ntfs_attr(ni, loc);
 158         if (!na) {
 159                 ret = WIMLIB_ERR_NTFS_3G;
 160                 goto out;
 161         }
 162
 163         if (ntfs_attr_pread(na, 0, sizeof(reparse_tag),
 164                             &reparse_tag) != sizeof(reparse_tag))
 165         {
 166                 ERROR_WITH_ERRNO("Error reading reparse data");
 167                 ret = WIMLIB_ERR_NTFS_3G;
 168                 goto out_close_ntfs_attr;
 169         }
 170         *reparse_tag_ret = le32_to_cpu(reparse_tag);
 171         DEBUG("ReparseTag = %#x", *reparse_tag_ret);
 172         ret = 0;
 173 out_close_ntfs_attr:
 174         ntfs_attr_close(na);
 175 out:
 176         return ret;
 177
 178 }
 179
 180 /* Load the streams from a file or reparse point in the NTFS volume into the WIM
 181  * lookup table */
 182 static int
 183 capture_ntfs_streams(struct wim_inode *inode,
 184                      ntfs_inode *ni,
 185                      char *path,
 186                      size_t path_len,
 187                      struct wim_lookup_table *lookup_table,
 188                      ntfs_volume *vol,
 189                      ATTR_TYPES type)
 190 {
 191         ntfs_attr_search_ctx *actx;
 192         struct ntfs_location *ntfs_loc;
 193         int ret;
 194         struct wim_lookup_table_entry *lte;
 195
 196         DEBUG2("Capturing NTFS data streams from `%s'", path);
 197
 198         /* Get context to search the streams of the NTFS file. */
 199         actx = ntfs_attr_get_search_ctx(ni, NULL);
 200         if (!actx) {
 201                 ERROR_WITH_ERRNO("Cannot get NTFS attribute search "
 202                                  "context for \"%s\"", path);
 203                 return WIMLIB_ERR_NTFS_3G;
 204         }
 205
 206         /* Capture each data stream or reparse data stream. */
 207         while (!ntfs_attr_lookup(type, NULL, 0,
 208                                  CASE_SENSITIVE, 0, NULL, 0, actx))
 209         {
 210                 u64 data_size = ntfs_get_attribute_value_length(actx->attr);
 211                 u64 name_length = actx->attr->name_length;
 212                 u32 stream_id;
 213
 214                 if (data_size == 0) {
 215                         /* Empty stream.  No lookup table entry is needed. */
 216                         lte = NULL;
 217                         ntfs_loc = NULL;
 218                 } else {
 219                         ntfs_loc = CALLOC(1, sizeof(*ntfs_loc));
 220                         if (!ntfs_loc) {
 221                                 ret = WIMLIB_ERR_NOMEM;
 222                                 goto out_put_actx;
 223                         }
 224                         ntfs_loc->ntfs_vol = vol;
 225                         ntfs_loc->path = memdup(path, path_len + 1);
 226                         if (!ntfs_loc->path) {
 227                                 ret = WIMLIB_ERR_NOMEM;
 228                                 goto out_free_ntfs_loc;
 229                         }
 230                         if (name_length) {
 231                                 ntfs_loc->stream_name = memdup(attr_record_name(actx->attr),
 232                                                                name_length * 2);
 233                                 if (!ntfs_loc->stream_name) {
 234                                         ret = WIMLIB_ERR_NOMEM;
 235                                         goto out_free_ntfs_loc;
 236                                 }
 237                                 ntfs_loc->stream_name_nchars = name_length;
 238                         }
 239
 240                         lte = new_lookup_table_entry();
 241                         if (!lte) {
 242                                 ret = WIMLIB_ERR_NOMEM;
 243                                 goto out_free_ntfs_loc;
 244                         }
 245                         lte->resource_location = RESOURCE_IN_NTFS_VOLUME;
 246                         lte->ntfs_loc = ntfs_loc;
 247                         ntfs_loc = NULL;
 248                         if (type == AT_REPARSE_POINT) {
 249                                 if (data_size < 8) {
 250                                         ERROR("Invalid reparse data on \"%s\" "
 251                                               "(only %u bytes)!", path, (unsigned)data_size);
 252                                         ret = WIMLIB_ERR_NTFS_3G;
 253                                         goto out_free_lte;
 254                                 }
 255                                 lte->ntfs_loc->is_reparse_point = true;
 256                                 lte->resource_entry.original_size = data_size - 8;
 257                                 ret = read_reparse_tag(ni, lte->ntfs_loc,
 258                                                        &inode->i_reparse_tag);
 259                                 if (ret)
 260                                         goto out_free_lte;
 261                         } else {
 262                                 lte->ntfs_loc->is_reparse_point = false;
 263                                 lte->resource_entry.original_size = data_size;
 264                         }
 265                 }
 266                 if (name_length == 0) {
 267                         /* Unnamed data stream.  Put the reference to it in the
 268                          * dentry's inode. */
 269                         if (inode->i_lte) {
 270                                 ERROR("Found two un-named data streams for `%s'",
 271                                       path);
 272                                 ret = WIMLIB_ERR_NTFS_3G;
 273                                 goto out_free_lte;
 274                         }
 275                         stream_id = 0;
 276                         inode->i_lte = lte;
 277                 } else {
 278                         /* Named data stream.  Put the reference to it in the
 279                          * alternate data stream entries */
 280                         struct wim_ads_entry *new_ads_entry;
 281
 282                         new_ads_entry = inode_add_ads_utf16le(inode,
 283                                                               attr_record_name(actx->attr),
 284                                                               name_length * 2);
 285                         if (!new_ads_entry) {
 286                                 ret = WIMLIB_ERR_NOMEM;
 287                                 goto out_free_lte;
 288                         }
 289                         wimlib_assert(new_ads_entry->stream_name_nbytes == name_length * 2);
 290                         stream_id = new_ads_entry->stream_id;
 291                         new_ads_entry->lte = lte;
 292                 }
 293                 if (lte) {
 294                         lookup_table_insert_unhashed(lookup_table, lte,
 295                                                      inode, stream_id);
 296                 }
 297         }
 298         if (errno == ENOENT) {
 299                 ret = 0;
 300         } else {
 301                 ERROR_WITH_ERRNO("Error listing NTFS attributes of \"%s\"", path);
 302                 ret = WIMLIB_ERR_NTFS_3G;
 303         }
 304         goto out_put_actx;
 305 out_free_lte:
 306         free_lookup_table_entry(lte);
 307 out_free_ntfs_loc:
 308         if (ntfs_loc) {
 309                 FREE(ntfs_loc->path);
 310                 FREE(ntfs_loc->stream_name);
 311                 FREE(ntfs_loc);
 312         }
 313 out_put_actx:
 314         ntfs_attr_put_search_ctx(actx);
 315         if (ret == 0)
 316                 DEBUG2("Successfully captured NTFS streams from \"%s\"", path);
 317         else
 318                 ERROR("Failed to capture NTFS streams from \"%s\"", path);
 319         return ret;
 320 }
 321
 322 /* Red-black tree that maps NTFS inode numbers to DOS names */
 323 struct dos_name_map {
 324         struct rb_root rb_root;
 325 };
 326
 327 struct dos_name_node {
 328         struct rb_node rb_node;
 329         char dos_name[24];
 330         int name_nbytes;
 331         u64 ntfs_ino;
 332 };
 333
 334 /* Inserts a new DOS name into the map */
 335 static int
 336 insert_dos_name(struct dos_name_map *map, const ntfschar *dos_name,
 337                 size_t name_nbytes, u64 ntfs_ino)
 338 {
 339         struct dos_name_node *new_node;
 340         struct rb_node **p;
 341         struct rb_root *root;
 342         struct rb_node *rb_parent;
 343
 344         DEBUG("DOS name_len = %zu", name_nbytes);
 345         new_node = MALLOC(sizeof(struct dos_name_node));
 346         if (!new_node)
 347                 return -1;
 348
 349         /* DOS names are supposed to be 12 characters max (that's 24 bytes,
 350          * assuming 2-byte ntfs characters) */
 351         wimlib_assert(name_nbytes <= sizeof(new_node->dos_name));
 352
 353         /* Initialize the DOS name, DOS name length, and NTFS inode number of
 354          * the red-black tree node */
 355         memcpy(new_node->dos_name, dos_name, name_nbytes);
 356         new_node->name_nbytes = name_nbytes;
 357         new_node->ntfs_ino = ntfs_ino;
 358
 359         /* Insert the red-black tree node */
 360         root = &map->rb_root;
 361         p = &root->rb_node;
 362         rb_parent = NULL;
 363         while (*p) {
 364                 struct dos_name_node *this;
 365
 366                 this = container_of(*p, struct dos_name_node, rb_node);
 367                 rb_parent = *p;
 368                 if (new_node->ntfs_ino < this->ntfs_ino)
 369                         p = &((*p)->rb_left);
 370                 else if (new_node->ntfs_ino > this->ntfs_ino)
 371                         p = &((*p)->rb_right);
 372                 else {
 373                         /* This should be impossible since a NTFS inode cannot
 374                          * have multiple DOS names, and we only should get each
 375                          * DOS name entry once from the ntfs_readdir() calls. */
 376                         ERROR("NTFS inode %"PRIu64" has multiple DOS names",
 377                               ntfs_ino);
 378                         return -1;
 379                 }
 380         }
 381         rb_link_node(&new_node->rb_node, rb_parent, p);
 382         rb_insert_color(&new_node->rb_node, root);
 383         DEBUG("Inserted DOS name for inode %"PRIu64, ntfs_ino);
 384         return 0;
 385 }
 386
 387 /* Returns a structure that contains the DOS name and its length for a NTFS
 388  * inode, or NULL if the inode has no DOS name. */
 389 static struct dos_name_node *
 390 lookup_dos_name(const struct dos_name_map *map, u64 ntfs_ino)
 391 {
 392         struct rb_node *node = map->rb_root.rb_node;
 393         while (node) {
 394                 struct dos_name_node *this;
 395                 this = container_of(node, struct dos_name_node, rb_node);
 396                 if (ntfs_ino < this->ntfs_ino)
 397                         node = node->rb_left;
 398                 else if (ntfs_ino > this->ntfs_ino)
 399                         node = node->rb_right;
 400                 else
 401                         return this;
 402         }
 403         return NULL;
 404 }
 405
 406 static int
 407 set_dentry_dos_name(struct wim_dentry *dentry, void *arg)
 408 {
 409         const struct dos_name_map *map = arg;
 410         const struct dos_name_node *node;
 411
 412         if (dentry->is_win32_name) {
 413                 node = lookup_dos_name(map, dentry->d_inode->i_ino);
 414                 if (node) {
 415                         dentry->short_name = MALLOC(node->name_nbytes + 2);
 416                         if (!dentry->short_name)
 417                                 return WIMLIB_ERR_NOMEM;
 418                         memcpy(dentry->short_name, node->dos_name,
 419                                node->name_nbytes);
 420                         dentry->short_name[node->name_nbytes / 2] = 0;
 421                         dentry->short_name_nbytes = node->name_nbytes;
 422                         DEBUG("Assigned DOS name to ino %"PRIu64,
 423                               dentry->d_inode->i_ino);
 424                 } else {
 425                         WARNING("NTFS inode %"PRIu64" has Win32 name with no "
 426                                 "corresponding DOS name",
 427                                 dentry->d_inode->i_ino);
 428                 }
 429         }
 430         return 0;
 431 }
 432
 433 static void
 434 free_dos_name_tree(struct rb_node *node) {
 435         if (node) {
 436                 free_dos_name_tree(node->rb_left);
 437                 free_dos_name_tree(node->rb_right);
 438                 FREE(container_of(node, struct dos_name_node, rb_node));
 439         }
 440 }
 441
 442 static void
 443 destroy_dos_name_map(struct dos_name_map *map)
 444 {
 445         free_dos_name_tree(map->rb_root.rb_node);
 446 }
 447
 448 struct readdir_ctx {
 449         struct wim_dentry *parent;
 450         ntfs_inode *dir_ni;
 451         char *path;
 452         size_t path_len;
 453         struct dos_name_map *dos_name_map;
 454         ntfs_volume *vol;
 455         struct add_image_params *params;
 456 };
 457
 458 static int
 459 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_p,
 460                                  ntfs_inode *dir_ni,
 461                                  ntfs_inode *ni,
 462                                  char *path,
 463                                  size_t path_len,
 464                                  int name_type,
 465                                  ntfs_volume *ntfs_vol,
 466                                  struct add_image_params *params);
 467
 468 static int
 469 wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
 470                          const int name_nchars, const int name_type,
 471                          const s64 pos, const MFT_REF mref,
 472                          const unsigned dt_type)
 473 {
 474         struct readdir_ctx *ctx;
 475         size_t mbs_name_nbytes;
 476         char *mbs_name;
 477         struct wim_dentry *child;
 478         int ret;
 479         size_t path_len;
 480         size_t name_nbytes = name_nchars * sizeof(ntfschar);
 481
 482         ctx = dirent;
 483         if (name_type & FILE_NAME_DOS) {
 484                 /* If this is the entry for a DOS name, store it for later. */
 485                 ret = insert_dos_name(ctx->dos_name_map, name,
 486                                       name_nbytes, mref & MFT_REF_MASK_CPU);
 487
 488                 /* Return now if an error occurred or if this is just a DOS name
 489                  * and not a Win32+DOS name. */
 490                 if (ret != 0 || name_type == FILE_NAME_DOS)
 491                         goto out;
 492         }
 493         ret = utf16le_to_tstr(name, name_nbytes,
 494                               &mbs_name, &mbs_name_nbytes);
 495         if (ret)
 496                 goto out;
 497
 498         if (mbs_name[0] == '.' &&
 499              (mbs_name[1] == '\0' ||
 500               (mbs_name[1] == '.' && mbs_name[2] == '\0'))) {
 501                 /* . or .. entries
 502                  *
 503                  * note: name_type is POSIX for these, so DOS names will not
 504                  * have been inserted for them.  */
 505                 ret = 0;
 506                 goto out_free_mbs_name;
 507         }
 508
 509         /* Open the inode for this directory entry and recursively capture the
 510          * directory tree rooted at it */
 511         ntfs_inode *ni = ntfs_inode_open(ctx->dir_ni->vol, mref);
 512         if (!ni) {
 513                 ERROR_WITH_ERRNO("Failed to open NTFS inode");
 514                 ret = -1;
 515                 goto out_free_mbs_name;
 516         }
 517         path_len = ctx->path_len;
 518         if (path_len != 1)
 519                 ctx->path[path_len++] = '/';
 520         memcpy(ctx->path + path_len, mbs_name, mbs_name_nbytes + 1);
 521         path_len += mbs_name_nbytes;
 522         child = NULL;
 523         ret = build_dentry_tree_ntfs_recursive(&child, ctx->dir_ni,
 524                                                ni, ctx->path, path_len, name_type,
 525                                                ctx->vol, ctx->params);
 526         path_len -= mbs_name_nbytes + 1;
 527         if (child)
 528                 dentry_add_child(ctx->parent, child);
 529         ntfs_inode_close(ni);
 530 out_free_mbs_name:
 531         FREE(mbs_name);
 532 out:
 533         ctx->path[ctx->path_len] = '\0';
 534         return ret;
 535 }
 536
 537 /* Recursively build a WIM dentry tree corresponding to a NTFS volume.
 538  * At the same time, update the WIM lookup table with lookup table entries for
 539  * the NTFS streams, and build an array of security descriptors.
 540  */
 541 static int
 542 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
 543                                  ntfs_inode *dir_ni,
 544                                  ntfs_inode *ni,
 545                                  char *path,
 546                                  size_t path_len,
 547                                  int name_type,
 548                                  ntfs_volume *vol,
 549                                  struct add_image_params *params)
 550 {
 551         le32 attributes;
 552         int ret;
 553         struct wim_dentry *root;
 554         struct wim_inode *inode;
 555         ATTR_TYPES stream_type;
 556
 557         if (exclude_path(path, path_len, params->config, false)) {
 558                 /* Exclude a file or directory tree based on the capture
 559                  * configuration file */
 560                 if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
 561                     && params->progress_func)
 562                 {
 563                         union wimlib_progress_info info;
 564                         info.scan.cur_path = path;
 565                         info.scan.excluded = true;
 566                         params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
 567                 }
 568                 root = NULL;
 569                 ret = 0;
 570                 goto out;
 571         }
 572
 573         /* Get file attributes */
 574         struct SECURITY_CONTEXT ctx;
 575         memset(&ctx, 0, sizeof(ctx));
 576         ctx.vol = vol;
 577         ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ATTRIB,
 578                                          ni, dir_ni, (char *)&attributes,
 579                                          sizeof(attributes));
 580         if (ret != sizeof(attributes)) {
 581                 ERROR_WITH_ERRNO("Failed to get NTFS attributes from \"%s\"", path);
 582                 return WIMLIB_ERR_NTFS_3G;
 583         }
 584
 585         if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
 586             && params->progress_func)
 587         {
 588                 union wimlib_progress_info info;
 589                 info.scan.cur_path = path;
 590                 info.scan.excluded = false;
 591                 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
 592         }
 593
 594         /* Create a WIM dentry with an associated inode, which may be shared */
 595         ret = inode_table_new_dentry(&params->inode_table,
 596                                      path_basename_with_len(path, path_len),
 597                                      ni->mft_no, 0, false, &root);
 598         if (ret)
 599                 return ret;
 600
 601         inode = root->d_inode;
 602
 603         if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
 604                 goto out;
 605
 606         if (name_type & FILE_NAME_WIN32) /* Win32 or Win32+DOS name (rather than POSIX) */
 607                 root->is_win32_name = 1;
 608         inode->i_creation_time    = le64_to_cpu(ni->creation_time);
 609         inode->i_last_write_time  = le64_to_cpu(ni->last_data_change_time);
 610         inode->i_last_access_time = le64_to_cpu(ni->last_access_time);
 611         inode->i_attributes       = le32_to_cpu(attributes);
 612         inode->i_resolved         = 1;
 613
 614         if (attributes & FILE_ATTR_REPARSE_POINT)
 615                 stream_type = AT_REPARSE_POINT;
 616         else
 617                 stream_type = AT_DATA;
 618
 619         /* Capture the file's streams; more specifically, this is supposed to:
 620          *
 621          * - Regular files: capture unnamed data stream and any named data
 622          *   streams
 623          * - Directories: capture any named data streams
 624          * - Reparse points: capture reparse data only
 625          */
 626         ret = capture_ntfs_streams(inode, ni, path, path_len,
 627                                    params->lookup_table, vol, stream_type);
 628         if (ret)
 629                 goto out;
 630
 631         if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) {
 632
 633                 /* Recurse to directory children */
 634                 s64 pos = 0;
 635                 struct dos_name_map dos_name_map = { .rb_root = {.rb_node = NULL} };
 636                 struct readdir_ctx ctx = {
 637                         .parent          = root,
 638                         .dir_ni          = ni,
 639                         .path            = path,
 640                         .path_len        = path_len,
 641                         .dos_name_map    = &dos_name_map,
 642                         .vol             = vol,
 643                         .params          = params,
 644                 };
 645                 ret = ntfs_readdir(ni, &pos, &ctx, wim_ntfs_capture_filldir);
 646                 if (ret) {
 647                         ERROR_WITH_ERRNO("Error reading directory \"%s\"", path);
 648                         ret = WIMLIB_ERR_NTFS_3G;
 649                 } else {
 650                         ret = for_dentry_child(root, set_dentry_dos_name,
 651                                                &dos_name_map);
 652                 }
 653                 destroy_dos_name_map(&dos_name_map);
 654                 if (ret)
 655                         goto out;
 656         }
 657
 658         /* Reparse-point fixups are a no-op because in NTFS-3g capture mode we
 659          * only allow capturing an entire volume. */
 660         if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
 661             inode_is_symlink(inode))
 662                 inode->i_not_rpfixed = 0;
 663
 664         if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)) {
 665                 /* Get security descriptor */
 666                 char _sd[1];
 667                 char *sd = _sd;
 668                 errno = 0;
 669                 ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
 670                                                  ni, dir_ni, sd,
 671                                                  sizeof(sd));
 672                 if (ret > sizeof(sd)) {
 673                         sd = alloca(ret);
 674                         ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
 675                                                          ni, dir_ni, sd, ret);
 676                 }
 677                 if (ret > 0) {
 678                         inode->i_security_id = sd_set_add_sd(&params->sd_set,
 679                                                              sd, ret);
 680                         if (inode->i_security_id == -1) {
 681                                 ERROR("Out of memory");
 682                                 ret = WIMLIB_ERR_NOMEM;
 683                                 goto out;
 684                         }
 685                         DEBUG("Added security ID = %u for `%s'",
 686                               inode->i_security_id, path);
 687                         ret = 0;
 688                 } else if (ret < 0) {
 689                         ERROR_WITH_ERRNO("Failed to get security information from "
 690                                          "`%s'", path);
 691                         ret = WIMLIB_ERR_NTFS_3G;
 692                 } else {
 693                         inode->i_security_id = -1;
 694                         DEBUG("No security ID for `%s'", path);
 695                 }
 696         }
 697 out:
 698         if (ret == 0)
 699                 *root_ret = root;
 700         else
 701                 free_dentry_tree(root, params->lookup_table);
 702         return ret;
 703 }
 704
 705
 706 int
 707 do_ntfs_umount(struct _ntfs_volume *vol)
 708 {
 709         DEBUG("Unmounting NTFS volume");
 710         if (ntfs_umount(vol, FALSE))
 711                 return WIMLIB_ERR_NTFS_3G;
 712         else
 713                 return 0;
 714 }
 715
 716 int
 717 build_dentry_tree_ntfs(struct wim_dentry **root_p,
 718                        const char *device,
 719                        struct add_image_params *params)
 720 {
 721         ntfs_volume *vol;
 722         ntfs_inode *root_ni;
 723         int ret;
 724
 725         DEBUG("Mounting NTFS volume `%s' read-only", device);
 726
 727 /* NTFS-3g 2013 renamed the "read-only" mount flag from MS_RDONLY to
 728  * NTFS_MNT_RDONLY.
 729  *
 730  * Unfortunately we can't check for defined(NTFS_MNT_RDONLY) because
 731  * NTFS_MNT_RDONLY is an enumerated constant.  Also, the NTFS-3g headers don't
 732  * seem to contain any explicit version information.  So we have to rely on a
 733  * test done at configure time to detect whether NTFS_MNT_RDONLY should be used.
 734  * */
 735 #ifdef HAVE_NTFS_MNT_RDONLY
 736         /* NTFS-3g 2013 */
 737         vol = ntfs_mount(device, NTFS_MNT_RDONLY);
 738 #elif defined(MS_RDONLY)
 739         /* NTFS-3g 2011, 2012 */
 740         vol = ntfs_mount(device, MS_RDONLY);
 741 #else
 742   #error "Can't find NTFS_MNT_RDONLY or MS_RDONLY flags"
 743 #endif
 744         if (!vol) {
 745                 ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s' read-only",
 746                                  device);
 747                 return WIMLIB_ERR_NTFS_3G;
 748         }
 749         ntfs_open_secure(vol);
 750
 751         /* We don't want to capture the special NTFS files such as $Bitmap.  Not
 752          * to be confused with "hidden" or "system" files which are real files
 753          * that we do need to capture.  */
 754         NVolClearShowSysFiles(vol);
 755
 756         DEBUG("Opening root NTFS dentry");
 757         root_ni = ntfs_inode_open(vol, FILE_root);
 758         if (!root_ni) {
 759                 ERROR_WITH_ERRNO("Failed to open root inode of NTFS volume "
 760                                  "`%s'", device);
 761                 ret = WIMLIB_ERR_NTFS_3G;
 762                 goto out;
 763         }
 764
 765         /* Currently we assume that all the paths fit into this length and there
 766          * is no check for overflow. */
 767         char *path = MALLOC(32768);
 768         if (!path) {
 769                 ERROR("Could not allocate memory for NTFS pathname");
 770                 ret = WIMLIB_ERR_NOMEM;
 771                 goto out_cleanup;
 772         }
 773
 774         path[0] = '/';
 775         path[1] = '\0';
 776         ret = build_dentry_tree_ntfs_recursive(root_p, NULL, root_ni, path, 1,
 777                                                FILE_NAME_POSIX, vol, params);
 778 out_cleanup:
 779         FREE(path);
 780         ntfs_inode_close(root_ni);
 781 out:
 782         ntfs_index_ctx_put(vol->secure_xsii);
 783         ntfs_index_ctx_put(vol->secure_xsdh);
 784         ntfs_inode_close(vol->secure_ni);
 785
 786         if (ret) {
 787                 if (do_ntfs_umount(vol)) {
 788                         ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'",
 789                                          device);
 790                         if (ret == 0)
 791                                 ret = WIMLIB_ERR_NTFS_3G;
 792                 }
 793         } else {
 794                 /* We need to leave the NTFS volume mounted so that we can read
 795                  * the NTFS files again when we are actually writing the WIM */
 796                 *(ntfs_volume**)params->extra_arg = vol;
 797         }
 798         return ret;
 799 }
 800 #endif /* WITH_NTFS_3G */