ntfs-3g_capture.c: Allow multiple empty unnamed streams
[wimlib] / 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                                 if (lte) {
271                                         ERROR("Found two un-named data streams for \"%s\" "
272                                               "(sizes = %"PRIu64", %"PRIu64")",
273                                               path, wim_resource_size(inode->i_lte),
274                                               wim_resource_size(lte));
275                                         ret = WIMLIB_ERR_NTFS_3G;
276                                         goto out_free_lte;
277                                 }
278                         } else {
279                                 stream_id = 0;
280                                 inode->i_lte = lte;
281                         }
282                 } else {
283                         /* Named data stream.  Put the reference to it in the
284                          * alternate data stream entries */
285                         struct wim_ads_entry *new_ads_entry;
286
287                         new_ads_entry = inode_add_ads_utf16le(inode,
288                                                               attr_record_name(actx->attr),
289                                                               name_length * 2);
290                         if (!new_ads_entry) {
291                                 ret = WIMLIB_ERR_NOMEM;
292                                 goto out_free_lte;
293                         }
294                         wimlib_assert(new_ads_entry->stream_name_nbytes == name_length * 2);
295                         stream_id = new_ads_entry->stream_id;
296                         new_ads_entry->lte = lte;
297                 }
298                 if (lte) {
299                         lookup_table_insert_unhashed(lookup_table, lte,
300                                                      inode, stream_id);
301                 }
302         }
303         if (errno == ENOENT) {
304                 ret = 0;
305         } else {
306                 ERROR_WITH_ERRNO("Error listing NTFS attributes of \"%s\"", path);
307                 ret = WIMLIB_ERR_NTFS_3G;
308         }
309         goto out_put_actx;
310 out_free_lte:
311         free_lookup_table_entry(lte);
312 out_free_ntfs_loc:
313         if (ntfs_loc) {
314                 FREE(ntfs_loc->path);
315                 FREE(ntfs_loc->stream_name);
316                 FREE(ntfs_loc);
317         }
318 out_put_actx:
319         ntfs_attr_put_search_ctx(actx);
320         if (ret == 0)
321                 DEBUG2("Successfully captured NTFS streams from \"%s\"", path);
322         else
323                 ERROR("Failed to capture NTFS streams from \"%s\"", path);
324         return ret;
325 }
326
327 /* Red-black tree that maps NTFS inode numbers to DOS names */
328 struct dos_name_map {
329         struct rb_root rb_root;
330 };
331
332 struct dos_name_node {
333         struct rb_node rb_node;
334         char dos_name[24];
335         int name_nbytes;
336         u64 ntfs_ino;
337 };
338
339 /* Inserts a new DOS name into the map */
340 static int
341 insert_dos_name(struct dos_name_map *map, const ntfschar *dos_name,
342                 size_t name_nbytes, u64 ntfs_ino)
343 {
344         struct dos_name_node *new_node;
345         struct rb_node **p;
346         struct rb_root *root;
347         struct rb_node *rb_parent;
348
349         DEBUG("DOS name_len = %zu", name_nbytes);
350         new_node = MALLOC(sizeof(struct dos_name_node));
351         if (!new_node)
352                 return -1;
353
354         /* DOS names are supposed to be 12 characters max (that's 24 bytes,
355          * assuming 2-byte ntfs characters) */
356         wimlib_assert(name_nbytes <= sizeof(new_node->dos_name));
357
358         /* Initialize the DOS name, DOS name length, and NTFS inode number of
359          * the red-black tree node */
360         memcpy(new_node->dos_name, dos_name, name_nbytes);
361         new_node->name_nbytes = name_nbytes;
362         new_node->ntfs_ino = ntfs_ino;
363
364         /* Insert the red-black tree node */
365         root = &map->rb_root;
366         p = &root->rb_node;
367         rb_parent = NULL;
368         while (*p) {
369                 struct dos_name_node *this;
370
371                 this = container_of(*p, struct dos_name_node, rb_node);
372                 rb_parent = *p;
373                 if (new_node->ntfs_ino < this->ntfs_ino)
374                         p = &((*p)->rb_left);
375                 else if (new_node->ntfs_ino > this->ntfs_ino)
376                         p = &((*p)->rb_right);
377                 else {
378                         /* This should be impossible since a NTFS inode cannot
379                          * have multiple DOS names, and we only should get each
380                          * DOS name entry once from the ntfs_readdir() calls. */
381                         ERROR("NTFS inode %"PRIu64" has multiple DOS names",
382                               ntfs_ino);
383                         return -1;
384                 }
385         }
386         rb_link_node(&new_node->rb_node, rb_parent, p);
387         rb_insert_color(&new_node->rb_node, root);
388         DEBUG("Inserted DOS name for inode %"PRIu64, ntfs_ino);
389         return 0;
390 }
391
392 /* Returns a structure that contains the DOS name and its length for a NTFS
393  * inode, or NULL if the inode has no DOS name. */
394 static struct dos_name_node *
395 lookup_dos_name(const struct dos_name_map *map, u64 ntfs_ino)
396 {
397         struct rb_node *node = map->rb_root.rb_node;
398         while (node) {
399                 struct dos_name_node *this;
400                 this = container_of(node, struct dos_name_node, rb_node);
401                 if (ntfs_ino < this->ntfs_ino)
402                         node = node->rb_left;
403                 else if (ntfs_ino > this->ntfs_ino)
404                         node = node->rb_right;
405                 else
406                         return this;
407         }
408         return NULL;
409 }
410
411 static int
412 set_dentry_dos_name(struct wim_dentry *dentry, void *arg)
413 {
414         const struct dos_name_map *map = arg;
415         const struct dos_name_node *node;
416
417         if (dentry->is_win32_name) {
418                 node = lookup_dos_name(map, dentry->d_inode->i_ino);
419                 if (node) {
420                         dentry->short_name = MALLOC(node->name_nbytes + 2);
421                         if (!dentry->short_name)
422                                 return WIMLIB_ERR_NOMEM;
423                         memcpy(dentry->short_name, node->dos_name,
424                                node->name_nbytes);
425                         dentry->short_name[node->name_nbytes / 2] = 0;
426                         dentry->short_name_nbytes = node->name_nbytes;
427                         DEBUG("Assigned DOS name to ino %"PRIu64,
428                               dentry->d_inode->i_ino);
429                 } else {
430                         WARNING("NTFS inode %"PRIu64" has Win32 name with no "
431                                 "corresponding DOS name",
432                                 dentry->d_inode->i_ino);
433                 }
434         }
435         return 0;
436 }
437
438 static void
439 free_dos_name_tree(struct rb_node *node) {
440         if (node) {
441                 free_dos_name_tree(node->rb_left);
442                 free_dos_name_tree(node->rb_right);
443                 FREE(container_of(node, struct dos_name_node, rb_node));
444         }
445 }
446
447 static void
448 destroy_dos_name_map(struct dos_name_map *map)
449 {
450         free_dos_name_tree(map->rb_root.rb_node);
451 }
452
453 struct readdir_ctx {
454         struct wim_dentry *parent;
455         ntfs_inode *dir_ni;
456         char *path;
457         size_t path_len;
458         struct dos_name_map *dos_name_map;
459         ntfs_volume *vol;
460         struct add_image_params *params;
461 };
462
463 static int
464 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_p,
465                                  ntfs_inode *dir_ni,
466                                  ntfs_inode *ni,
467                                  char *path,
468                                  size_t path_len,
469                                  int name_type,
470                                  ntfs_volume *ntfs_vol,
471                                  struct add_image_params *params);
472
473 static int
474 wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
475                          const int name_nchars, const int name_type,
476                          const s64 pos, const MFT_REF mref,
477                          const unsigned dt_type)
478 {
479         struct readdir_ctx *ctx;
480         size_t mbs_name_nbytes;
481         char *mbs_name;
482         struct wim_dentry *child;
483         int ret;
484         size_t path_len;
485         size_t name_nbytes = name_nchars * sizeof(ntfschar);
486
487         ctx = dirent;
488         if (name_type & FILE_NAME_DOS) {
489                 /* If this is the entry for a DOS name, store it for later. */
490                 ret = insert_dos_name(ctx->dos_name_map, name,
491                                       name_nbytes, mref & MFT_REF_MASK_CPU);
492
493                 /* Return now if an error occurred or if this is just a DOS name
494                  * and not a Win32+DOS name. */
495                 if (ret != 0 || name_type == FILE_NAME_DOS)
496                         goto out;
497         }
498         ret = utf16le_to_tstr(name, name_nbytes,
499                               &mbs_name, &mbs_name_nbytes);
500         if (ret)
501                 goto out;
502
503         if (mbs_name[0] == '.' &&
504              (mbs_name[1] == '\0' ||
505               (mbs_name[1] == '.' && mbs_name[2] == '\0'))) {
506                 /* . or .. entries
507                  *
508                  * note: name_type is POSIX for these, so DOS names will not
509                  * have been inserted for them.  */
510                 ret = 0;
511                 goto out_free_mbs_name;
512         }
513
514         /* Open the inode for this directory entry and recursively capture the
515          * directory tree rooted at it */
516         ntfs_inode *ni = ntfs_inode_open(ctx->dir_ni->vol, mref);
517         if (!ni) {
518                 ERROR_WITH_ERRNO("Failed to open NTFS inode");
519                 ret = -1;
520                 goto out_free_mbs_name;
521         }
522         path_len = ctx->path_len;
523         if (path_len != 1)
524                 ctx->path[path_len++] = '/';
525         memcpy(ctx->path + path_len, mbs_name, mbs_name_nbytes + 1);
526         path_len += mbs_name_nbytes;
527         child = NULL;
528         ret = build_dentry_tree_ntfs_recursive(&child, ctx->dir_ni,
529                                                ni, ctx->path, path_len, name_type,
530                                                ctx->vol, ctx->params);
531         path_len -= mbs_name_nbytes + 1;
532         if (child)
533                 dentry_add_child(ctx->parent, child);
534         ntfs_inode_close(ni);
535 out_free_mbs_name:
536         FREE(mbs_name);
537 out:
538         ctx->path[ctx->path_len] = '\0';
539         return ret;
540 }
541
542 /* Recursively build a WIM dentry tree corresponding to a NTFS volume.
543  * At the same time, update the WIM lookup table with lookup table entries for
544  * the NTFS streams, and build an array of security descriptors.
545  */
546 static int
547 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
548                                  ntfs_inode *dir_ni,
549                                  ntfs_inode *ni,
550                                  char *path,
551                                  size_t path_len,
552                                  int name_type,
553                                  ntfs_volume *vol,
554                                  struct add_image_params *params)
555 {
556         le32 attributes;
557         int ret;
558         struct wim_dentry *root;
559         struct wim_inode *inode;
560         ATTR_TYPES stream_type;
561
562         if (exclude_path(path, path_len, params->config, false)) {
563                 /* Exclude a file or directory tree based on the capture
564                  * configuration file */
565                 if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
566                     && params->progress_func)
567                 {
568                         union wimlib_progress_info info;
569                         info.scan.cur_path = path;
570                         info.scan.excluded = true;
571                         params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
572                 }
573                 root = NULL;
574                 ret = 0;
575                 goto out;
576         }
577
578         /* Get file attributes */
579         struct SECURITY_CONTEXT ctx;
580         memset(&ctx, 0, sizeof(ctx));
581         ctx.vol = vol;
582         ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ATTRIB,
583                                          ni, dir_ni, (char *)&attributes,
584                                          sizeof(attributes));
585         if (ret != sizeof(attributes)) {
586                 ERROR_WITH_ERRNO("Failed to get NTFS attributes from \"%s\"", path);
587                 return WIMLIB_ERR_NTFS_3G;
588         }
589
590         if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
591             && params->progress_func)
592         {
593                 union wimlib_progress_info info;
594                 info.scan.cur_path = path;
595                 info.scan.excluded = false;
596                 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
597         }
598
599         /* Create a WIM dentry with an associated inode, which may be shared */
600         ret = inode_table_new_dentry(&params->inode_table,
601                                      path_basename_with_len(path, path_len),
602                                      ni->mft_no, 0, false, &root);
603         if (ret)
604                 return ret;
605
606         inode = root->d_inode;
607
608         if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
609                 goto out;
610
611         if (name_type & FILE_NAME_WIN32) /* Win32 or Win32+DOS name (rather than POSIX) */
612                 root->is_win32_name = 1;
613         inode->i_creation_time    = le64_to_cpu(ni->creation_time);
614         inode->i_last_write_time  = le64_to_cpu(ni->last_data_change_time);
615         inode->i_last_access_time = le64_to_cpu(ni->last_access_time);
616         inode->i_attributes       = le32_to_cpu(attributes);
617         inode->i_resolved         = 1;
618
619         if (attributes & FILE_ATTR_REPARSE_POINT)
620                 stream_type = AT_REPARSE_POINT;
621         else
622                 stream_type = AT_DATA;
623
624         /* Capture the file's streams; more specifically, this is supposed to:
625          *
626          * - Regular files: capture unnamed data stream and any named data
627          *   streams
628          * - Directories: capture any named data streams
629          * - Reparse points: capture reparse data only
630          */
631         ret = capture_ntfs_streams(inode, ni, path, path_len,
632                                    params->lookup_table, vol, stream_type);
633         if (ret)
634                 goto out;
635
636         if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) {
637
638                 /* Recurse to directory children */
639                 s64 pos = 0;
640                 struct dos_name_map dos_name_map = { .rb_root = {.rb_node = NULL} };
641                 struct readdir_ctx ctx = {
642                         .parent          = root,
643                         .dir_ni          = ni,
644                         .path            = path,
645                         .path_len        = path_len,
646                         .dos_name_map    = &dos_name_map,
647                         .vol             = vol,
648                         .params          = params,
649                 };
650                 ret = ntfs_readdir(ni, &pos, &ctx, wim_ntfs_capture_filldir);
651                 if (ret) {
652                         ERROR_WITH_ERRNO("Error reading directory \"%s\"", path);
653                         ret = WIMLIB_ERR_NTFS_3G;
654                 } else {
655                         ret = for_dentry_child(root, set_dentry_dos_name,
656                                                &dos_name_map);
657                 }
658                 destroy_dos_name_map(&dos_name_map);
659                 if (ret)
660                         goto out;
661         }
662
663         /* Reparse-point fixups are a no-op because in NTFS-3g capture mode we
664          * only allow capturing an entire volume. */
665         if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
666             inode_is_symlink(inode))
667                 inode->i_not_rpfixed = 0;
668
669         if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)) {
670                 /* Get security descriptor */
671                 char _sd[1];
672                 char *sd = _sd;
673                 errno = 0;
674                 ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
675                                                  ni, dir_ni, sd,
676                                                  sizeof(sd));
677                 if (ret > sizeof(sd)) {
678                         sd = alloca(ret);
679                         ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
680                                                          ni, dir_ni, sd, ret);
681                 }
682                 if (ret > 0) {
683                         inode->i_security_id = sd_set_add_sd(&params->sd_set,
684                                                              sd, ret);
685                         if (inode->i_security_id == -1) {
686                                 ERROR("Out of memory");
687                                 ret = WIMLIB_ERR_NOMEM;
688                                 goto out;
689                         }
690                         DEBUG("Added security ID = %u for `%s'",
691                               inode->i_security_id, path);
692                         ret = 0;
693                 } else if (ret < 0) {
694                         ERROR_WITH_ERRNO("Failed to get security information from "
695                                          "`%s'", path);
696                         ret = WIMLIB_ERR_NTFS_3G;
697                 } else {
698                         inode->i_security_id = -1;
699                         DEBUG("No security ID for `%s'", path);
700                 }
701         }
702 out:
703         if (ret == 0)
704                 *root_ret = root;
705         else
706                 free_dentry_tree(root, params->lookup_table);
707         return ret;
708 }
709
710
711 int
712 do_ntfs_umount(struct _ntfs_volume *vol)
713 {
714         DEBUG("Unmounting NTFS volume");
715         if (ntfs_umount(vol, FALSE))
716                 return WIMLIB_ERR_NTFS_3G;
717         else
718                 return 0;
719 }
720
721 int
722 build_dentry_tree_ntfs(struct wim_dentry **root_p,
723                        const char *device,
724                        struct add_image_params *params)
725 {
726         ntfs_volume *vol;
727         ntfs_inode *root_ni;
728         int ret;
729
730         DEBUG("Mounting NTFS volume `%s' read-only", device);
731
732 /* NTFS-3g 2013 renamed the "read-only" mount flag from MS_RDONLY to
733  * NTFS_MNT_RDONLY.
734  *
735  * Unfortunately we can't check for defined(NTFS_MNT_RDONLY) because
736  * NTFS_MNT_RDONLY is an enumerated constant.  Also, the NTFS-3g headers don't
737  * seem to contain any explicit version information.  So we have to rely on a
738  * test done at configure time to detect whether NTFS_MNT_RDONLY should be used.
739  * */
740 #ifdef HAVE_NTFS_MNT_RDONLY
741         /* NTFS-3g 2013 */
742         vol = ntfs_mount(device, NTFS_MNT_RDONLY);
743 #elif defined(MS_RDONLY)
744         /* NTFS-3g 2011, 2012 */
745         vol = ntfs_mount(device, MS_RDONLY);
746 #else
747   #error "Can't find NTFS_MNT_RDONLY or MS_RDONLY flags"
748 #endif
749         if (!vol) {
750                 ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s' read-only",
751                                  device);
752                 return WIMLIB_ERR_NTFS_3G;
753         }
754         ntfs_open_secure(vol);
755
756         /* We don't want to capture the special NTFS files such as $Bitmap.  Not
757          * to be confused with "hidden" or "system" files which are real files
758          * that we do need to capture.  */
759         NVolClearShowSysFiles(vol);
760
761         DEBUG("Opening root NTFS dentry");
762         root_ni = ntfs_inode_open(vol, FILE_root);
763         if (!root_ni) {
764                 ERROR_WITH_ERRNO("Failed to open root inode of NTFS volume "
765                                  "`%s'", device);
766                 ret = WIMLIB_ERR_NTFS_3G;
767                 goto out;
768         }
769
770         /* Currently we assume that all the paths fit into this length and there
771          * is no check for overflow. */
772         char *path = MALLOC(32768);
773         if (!path) {
774                 ERROR("Could not allocate memory for NTFS pathname");
775                 ret = WIMLIB_ERR_NOMEM;
776                 goto out_cleanup;
777         }
778
779         path[0] = '/';
780         path[1] = '\0';
781         ret = build_dentry_tree_ntfs_recursive(root_p, NULL, root_ni, path, 1,
782                                                FILE_NAME_POSIX, vol, params);
783 out_cleanup:
784         FREE(path);
785         ntfs_inode_close(root_ni);
786 out:
787         ntfs_index_ctx_put(vol->secure_xsii);
788         ntfs_index_ctx_put(vol->secure_xsdh);
789         ntfs_inode_close(vol->secure_ni);
790
791         if (ret) {
792                 if (do_ntfs_umount(vol)) {
793                         ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'",
794                                          device);
795                         if (ret == 0)
796                                 ret = WIMLIB_ERR_NTFS_3G;
797                 }
798         } else {
799                 /* We need to leave the NTFS volume mounted so that we can read
800                  * the NTFS files again when we are actually writing the WIM */
801                 *(ntfs_volume**)params->extra_arg = vol;
802         }
803         return ret;
804 }
805 #endif /* WITH_NTFS_3G */