3e462a6e38f472e623ab4ea887e257f05c257177
[wimlib] / src / dentry.c
1 /*
2  * dentry.c
3  *
4  * In the WIM file format, the dentries are stored in the "metadata resource"
5  * section right after the security data.  Each image in the WIM file has its
6  * own metadata resource with its own security data and dentry tree.  Dentries
7  * in different images may share file resources by referring to the same lookup
8  * table entries.
9  */
10
11 /*
12  * Copyright (C) 2012, 2013, 2014 Eric Biggers
13  *
14  * This file is part of wimlib, a library for working with WIM files.
15  *
16  * wimlib is free software; you can redistribute it and/or modify it under the
17  * terms of the GNU General Public License as published by the Free Software
18  * Foundation; either version 3 of the License, or (at your option) any later
19  * version.
20  *
21  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23  * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License along with
26  * wimlib; if not, see http://www.gnu.org/licenses/.
27  */
28
29 #ifdef HAVE_CONFIG_H
30 #  include "config.h"
31 #endif
32
33 #include "wimlib.h"
34 #include "wimlib/case.h"
35 #include "wimlib/dentry.h"
36 #include "wimlib/encoding.h"
37 #include "wimlib/endianness.h"
38 #include "wimlib/error.h"
39 #include "wimlib/lookup_table.h"
40 #include "wimlib/metadata.h"
41 #include "wimlib/paths.h"
42 #include "wimlib/resource.h"
43 #include "wimlib/security.h"
44 #include "wimlib/sha1.h"
45 #include "wimlib/timestamp.h"
46
47 #include <errno.h>
48
49 /* On-disk format of a WIM dentry (directory entry), located in the metadata
50  * resource for a WIM image.  */
51 struct wim_dentry_on_disk {
52
53         /* Length of this directory entry in bytes, not including any alternate
54          * data stream entries.  Should be a multiple of 8 so that the following
55          * dentry or alternate data stream entry is aligned on an 8-byte
56          * boundary.  (If not, wimlib will round it up.)  It must be at least as
57          * long as the fixed-length fields of the dentry (WIM_DENTRY_DISK_SIZE),
58          * plus the lengths of the file name and/or short name if present.
59          *
60          * It is also possible for this field to be 0.  This situation, which is
61          * undocumented, indicates the end of a list of sibling nodes in a
62          * directory.  It also means the real length is 8, because the dentry
63          * included only the length field, but that takes up 8 bytes.  */
64         le64 length;
65
66         /* Attributes of the file or directory.  This is a bitwise OR of the
67          * FILE_ATTRIBUTE_* constants and should correspond to the value
68          * retrieved by GetFileAttributes() on Windows. */
69         le32 attributes;
70
71         /* A value that specifies the security descriptor for this file or
72          * directory.  If -1, the file or directory has no security descriptor.
73          * Otherwise, it is a 0-based index into the WIM image's table of
74          * security descriptors (see: `struct wim_security_data') */
75         sle32 security_id;
76
77         /* Offset, in bytes, from the start of the uncompressed metadata
78          * resource of this directory's child directory entries, or 0 if this
79          * directory entry does not correspond to a directory or otherwise does
80          * not have any children. */
81         le64 subdir_offset;
82
83         /* Reserved fields */
84         le64 unused_1;
85         le64 unused_2;
86
87
88         /* Creation time, last access time, and last write time, in
89          * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601.  They
90          * should correspond to the times gotten by calling GetFileTime() on
91          * Windows. */
92         le64 creation_time;
93         le64 last_access_time;
94         le64 last_write_time;
95
96         /* Vaguely, the SHA-1 message digest ("hash") of the file's contents.
97          * More specifically, this is for the "unnamed data stream" rather than
98          * any "alternate data streams".  This hash value is used to look up the
99          * corresponding entry in the WIM's stream lookup table to actually find
100          * the file contents within the WIM.
101          *
102          * If the file has no unnamed data stream (e.g. is a directory), then
103          * this field will be all zeroes.  If the unnamed data stream is empty
104          * (i.e. an "empty file"), then this field is also expected to be all
105          * zeroes.  (It will be if wimlib created the WIM image, at least;
106          * otherwise it can't be ruled out that the SHA-1 message digest of 0
107          * bytes of data is given explicitly.)
108          *
109          * If the file has reparse data, then this field will instead specify
110          * the SHA-1 message digest of the reparse data.  If it is somehow
111          * possible for a file to have both an unnamed data stream and reparse
112          * data, then this is not handled by wimlib.
113          *
114          * As a further special case, if this field is all zeroes but there is
115          * an alternate data stream entry with no name and a nonzero SHA-1
116          * message digest field, then that hash must be used instead of this
117          * one.  In fact, when named data streams are present, some versions of
118          * Windows PE contain a bug where they only look in the alternate data
119          * stream entries for the unnamed data stream, not here.
120          */
121         u8 unnamed_stream_hash[SHA1_HASH_SIZE];
122
123         /* The format of the following data is not yet completely known and they
124          * do not correspond to Microsoft's documentation.
125          *
126          * If this directory entry is for a reparse point (has
127          * FILE_ATTRIBUTE_REPARSE_POINT set in the attributes field), then the
128          * version of the following fields containing the reparse tag is valid.
129          * Furthermore, the field notated as not_rpfixed, as far as I can tell,
130          * is supposed to be set to 1 if reparse point fixups (a.k.a. fixing the
131          * targets of absolute symbolic links) were *not* done, and otherwise 0.
132          *
133          * If this directory entry is not for a reparse point, then the version
134          * of the following fields containing the hard_link_group_id is valid.
135          * All MS says about this field is that "If this file is part of a hard
136          * link set, all the directory entries in the set will share the same
137          * value in this field.".  However, more specifically I have observed
138          * the following:
139          *    - If the file is part of a hard link set of size 1, then the
140          *    hard_link_group_id should be set to either 0, which is treated
141          *    specially as indicating "not hardlinked", or any unique value.
142          *    - The specific nonzero values used to identity hard link sets do
143          *    not matter, as long as they are unique.
144          *    - However, due to bugs in Microsoft's software, it is actually NOT
145          *    guaranteed that directory entries that share the same hard link
146          *    group ID are actually hard linked to each either.  We have to
147          *    handle this by using special code to use distinguishing features
148          *    (which is possible because some information about the underlying
149          *    inode is repeated in each dentry) to split up these fake hard link
150          *    groups into what they actually are supposed to be.
151          */
152         union {
153                 struct {
154                         le32 rp_unknown_1;
155                         le32 reparse_tag;
156                         le16 rp_unknown_2;
157                         le16 not_rpfixed;
158                 } _packed_attribute reparse;
159                 struct {
160                         le32 rp_unknown_1;
161                         le64 hard_link_group_id;
162                 } _packed_attribute nonreparse;
163         };
164
165         /* Number of alternate data stream entries that directly follow this
166          * dentry on-disk. */
167         le16 num_alternate_data_streams;
168
169         /* Length of this file's UTF-16LE encoded short name (8.3 DOS-compatible
170          * name), if present, in bytes, excluding the null terminator.  If this
171          * file has no short name, then this field should be 0.  */
172         le16 short_name_nbytes;
173
174         /* Length of this file's UTF-16LE encoded "long" name, excluding the
175          * null terminator.  If this file has no short name, then this field
176          * should be 0.  It's expected that only the root dentry has this field
177          * set to 0.  */
178         le16 file_name_nbytes;
179
180         /* Followed by variable length file name, in UTF16-LE, if
181          * file_name_nbytes != 0.  Includes null terminator. */
182         /*utf16lechar file_name[];*/
183
184         /* Followed by variable length short name, in UTF16-LE, if
185          * short_name_nbytes != 0.  Includes null terminator. */
186         /*utf16lechar short_name[];*/
187 } _packed_attribute;
188
189 /* Calculates the unaligned length, in bytes, of an on-disk WIM dentry that has
190  * a file name and short name that take the specified numbers of bytes.  This
191  * excludes any alternate data stream entries that may follow the dentry. */
192 static u64
193 dentry_correct_length_unaligned(u16 file_name_nbytes, u16 short_name_nbytes)
194 {
195         u64 length = sizeof(struct wim_dentry_on_disk);
196         if (file_name_nbytes)
197                 length += file_name_nbytes + 2;
198         if (short_name_nbytes)
199                 length += short_name_nbytes + 2;
200         return length;
201 }
202
203 /* Calculates the unaligned length, in bytes, of an on-disk WIM dentry, based on
204  * the file name length and short name length.  Note that dentry->length is
205  * ignored; also, this excludes any alternate data stream entries that may
206  * follow the dentry. */
207 static u64
208 dentry_correct_length_aligned(const struct wim_dentry *dentry)
209 {
210         u64 len;
211
212         len = dentry_correct_length_unaligned(dentry->file_name_nbytes,
213                                               dentry->short_name_nbytes);
214         return (len + 7) & ~7;
215 }
216
217 static int
218 dentry_clear_short_name(struct wim_dentry *dentry)
219 {
220         if (dentry_has_short_name(dentry)) {
221                 FREE(dentry->short_name);
222                 dentry->short_name = NULL;
223                 dentry->short_name_nbytes = 0;
224         }
225         return 0;
226 }
227
228 /* Sets the name of a WIM dentry from a multibyte string.
229  * Only use this on dentries not inserted into the tree.  Use rename_wim_path()
230  * to do a real rename.  */
231 int
232 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name)
233 {
234         int ret;
235
236         ret = get_utf16le_string(new_name, &dentry->file_name,
237                                  &dentry->file_name_nbytes);
238         if (ret)
239                 return ret;
240
241         return dentry_clear_short_name(dentry);
242 }
243
244 /* Sets the name of a WIM dentry from a UTF-16LE string.
245  * Only use this on dentries not inserted into the tree.  Use rename_wim_path()
246  * to do a real rename.  */
247 int
248 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name)
249 {
250         utf16lechar *name = NULL;
251         size_t name_nbytes = 0;
252
253         if (new_name && *new_name) {
254                 const utf16lechar *tmp;
255
256                 tmp = new_name;
257                 do {
258                         name_nbytes += sizeof(utf16lechar);
259                 } while (*++tmp);
260
261                 name = memdup(new_name, name_nbytes + sizeof(utf16lechar));
262                 if (!name)
263                         return WIMLIB_ERR_NOMEM;
264         }
265
266         FREE(dentry->file_name);
267         dentry->file_name = name;
268         dentry->file_name_nbytes = name_nbytes;
269
270         return dentry_clear_short_name(dentry);
271 }
272
273 /* Returns the total length of a WIM alternate data stream entry on-disk,
274  * including the stream name, the null terminator, AND the padding after the
275  * entry to align the next ADS entry or dentry on an 8-byte boundary. */
276 static u64
277 ads_entry_total_length(const struct wim_ads_entry *entry)
278 {
279         u64 len = sizeof(struct wim_ads_entry_on_disk);
280         if (entry->stream_name_nbytes)
281                 len += entry->stream_name_nbytes + 2;
282         return (len + 7) & ~7;
283 }
284
285 /*
286  * Determine whether to include a "dummy" stream when writing a WIM dentry:
287  *
288  * Some versions of Microsoft's WIM software (the boot driver(s) in WinPE 3.0,
289  * for example) contain a bug where they assume the first alternate data stream
290  * (ADS) entry of a dentry with a nonzero ADS count specifies the unnamed
291  * stream, even if it has a name and the unnamed stream is already specified in
292  * the hash field of the dentry itself.
293  *
294  * wimlib has to work around this behavior by carefully emulating the behavior
295  * of (most versions of) ImageX/WIMGAPI, which move the unnamed stream reference
296  * into the alternate stream entries whenever there are named data streams, even
297  * though there is already a field in the dentry itself for the unnamed stream
298  * reference, which then goes to waste.
299  */
300 static inline bool
301 inode_needs_dummy_stream(const struct wim_inode *inode)
302 {
303         return (inode->i_num_ads > 0 &&
304                 inode->i_num_ads < 0xffff && /* overflow check */
305                 inode->i_canonical_streams); /* assume the dentry is okay if it
306                                                 already had an unnamed ADS entry
307                                                 when it was read in  */
308 }
309
310 /* Calculate the total number of bytes that will be consumed when a WIM dentry
311  * is written.  This includes base dentry and name fields as well as all
312  * alternate data stream entries and alignment bytes.  */
313 u64
314 dentry_out_total_length(const struct wim_dentry *dentry)
315 {
316         u64 length = dentry_correct_length_aligned(dentry);
317         const struct wim_inode *inode = dentry->d_inode;
318
319         if (inode_needs_dummy_stream(inode))
320                 length += ads_entry_total_length(&(struct wim_ads_entry){});
321
322         for (u16 i = 0; i < inode->i_num_ads; i++)
323                 length += ads_entry_total_length(&inode->i_ads_entries[i]);
324
325         return length;
326 }
327
328 /* Calculate the aligned, total length of a dentry, including all alternate data
329  * stream entries.  Uses dentry->length.  */
330 static u64
331 dentry_in_total_length(const struct wim_dentry *dentry)
332 {
333         u64 length = dentry->length;
334         const struct wim_inode *inode = dentry->d_inode;
335         for (u16 i = 0; i < inode->i_num_ads; i++)
336                 length += ads_entry_total_length(&inode->i_ads_entries[i]);
337         return (length + 7) & ~7;
338 }
339
340 static int
341 do_for_dentry_in_tree(struct wim_dentry *dentry,
342                       int (*visitor)(struct wim_dentry *, void *), void *arg)
343 {
344         int ret;
345         struct wim_dentry *child;
346
347         ret = (*visitor)(dentry, arg);
348         if (unlikely(ret))
349                 return ret;
350
351         for_dentry_child(child, dentry) {
352                 ret = do_for_dentry_in_tree(child, visitor, arg);
353                 if (unlikely(ret))
354                         return ret;
355         }
356         return 0;
357 }
358
359
360 static int
361 do_for_dentry_in_tree_depth(struct wim_dentry *dentry,
362                             int (*visitor)(struct wim_dentry *, void *), void *arg)
363 {
364         int ret;
365         struct wim_dentry *child;
366
367         for_dentry_child_postorder(child, dentry) {
368                 ret = do_for_dentry_in_tree_depth(child, visitor, arg);
369                 if (unlikely(ret))
370                         return ret;
371         }
372         return unlikely((*visitor)(dentry, arg));
373 }
374
375 /* Calls a function on all directory entries in a WIM dentry tree.  Logically,
376  * this is a pre-order traversal (the function is called on a parent dentry
377  * before its children), but sibling dentries will be visited in order as well.
378  * */
379 int
380 for_dentry_in_tree(struct wim_dentry *root,
381                    int (*visitor)(struct wim_dentry *, void *), void *arg)
382 {
383         if (unlikely(!root))
384                 return 0;
385         return do_for_dentry_in_tree(root, visitor, arg);
386 }
387
388 /* Like for_dentry_in_tree(), but the visitor function is always called on a
389  * dentry's children before on itself. */
390 int
391 for_dentry_in_tree_depth(struct wim_dentry *root,
392                          int (*visitor)(struct wim_dentry *, void *), void *arg)
393 {
394         if (unlikely(!root))
395                 return 0;
396         return do_for_dentry_in_tree_depth(root, visitor, arg);
397 }
398
399 /* Calculate the full path of @dentry.  */
400 int
401 calculate_dentry_full_path(struct wim_dentry *dentry)
402 {
403         tchar *full_path;
404         u32 full_path_nbytes;
405         int ret;
406
407         if (dentry->_full_path)
408                 return 0;
409
410         if (dentry_is_root(dentry)) {
411                 static const tchar _root_path[] = {WIM_PATH_SEPARATOR, T('\0')};
412                 full_path = TSTRDUP(_root_path);
413                 if (full_path == NULL)
414                         return WIMLIB_ERR_NOMEM;
415                 full_path_nbytes = 1 * sizeof(tchar);
416         } else {
417                 struct wim_dentry *parent;
418                 tchar *parent_full_path;
419                 u32 parent_full_path_nbytes;
420                 size_t filename_nbytes;
421
422                 parent = dentry->parent;
423                 if (dentry_is_root(parent)) {
424                         parent_full_path = T("");
425                         parent_full_path_nbytes = 0;
426                 } else {
427                         if (parent->_full_path == NULL) {
428                                 ret = calculate_dentry_full_path(parent);
429                                 if (ret)
430                                         return ret;
431                         }
432                         parent_full_path = parent->_full_path;
433                         parent_full_path_nbytes = parent->full_path_nbytes;
434                 }
435
436                 /* Append this dentry's name as a tchar string to the full path
437                  * of the parent followed by the path separator */
438         #if TCHAR_IS_UTF16LE
439                 filename_nbytes = dentry->file_name_nbytes;
440         #else
441                 {
442                         int ret = utf16le_to_tstr_nbytes(dentry->file_name,
443                                                          dentry->file_name_nbytes,
444                                                          &filename_nbytes);
445                         if (ret)
446                                 return ret;
447                 }
448         #endif
449
450                 full_path_nbytes = parent_full_path_nbytes + sizeof(tchar) +
451                                    filename_nbytes;
452                 full_path = MALLOC(full_path_nbytes + sizeof(tchar));
453                 if (full_path == NULL)
454                         return WIMLIB_ERR_NOMEM;
455                 memcpy(full_path, parent_full_path, parent_full_path_nbytes);
456                 full_path[parent_full_path_nbytes / sizeof(tchar)] = WIM_PATH_SEPARATOR;
457         #if TCHAR_IS_UTF16LE
458                 memcpy(&full_path[parent_full_path_nbytes / sizeof(tchar) + 1],
459                        dentry->file_name,
460                        filename_nbytes + sizeof(tchar));
461         #else
462                 utf16le_to_tstr_buf(dentry->file_name,
463                                     dentry->file_name_nbytes,
464                                     &full_path[parent_full_path_nbytes /
465                                                sizeof(tchar) + 1]);
466         #endif
467         }
468         dentry->_full_path = full_path;
469         dentry->full_path_nbytes= full_path_nbytes;
470         return 0;
471 }
472
473 tchar *
474 dentry_full_path(struct wim_dentry *dentry)
475 {
476         calculate_dentry_full_path(dentry);
477         return dentry->_full_path;
478 }
479
480 static int
481 dentry_calculate_subdir_offset(struct wim_dentry *dentry, void *_subdir_offset_p)
482 {
483
484         if (dentry_is_directory(dentry)) {
485                 u64 *subdir_offset_p = _subdir_offset_p;
486                 struct wim_dentry *child;
487
488                 /* Set offset of directory's child dentries  */
489                 dentry->subdir_offset = *subdir_offset_p;
490
491                 /* Account for child dentries  */
492                 for_dentry_child(child, dentry)
493                         *subdir_offset_p += dentry_out_total_length(child);
494
495                 /* Account for end-of-directory entry  */
496                 *subdir_offset_p += 8;
497         } else {
498                 /* Not a directory; set subdir_offset to 0  */
499                 dentry->subdir_offset = 0;
500         }
501         return 0;
502 }
503
504 /*
505  * Calculates the subdir offsets for a directory tree.
506  */
507 void
508 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p)
509 {
510         for_dentry_in_tree(root, dentry_calculate_subdir_offset, subdir_offset_p);
511 }
512
513 /* Compare the UTF-16LE long filenames of two dentries case insensitively.  */
514 static int
515 dentry_compare_names_case_insensitive(const struct wim_dentry *d1,
516                                       const struct wim_dentry *d2)
517 {
518         return cmp_utf16le_strings(d1->file_name,
519                                    d1->file_name_nbytes / 2,
520                                    d2->file_name,
521                                    d2->file_name_nbytes / 2,
522                                    true);
523 }
524
525 /* Compare the UTF-16LE long filenames of two dentries case sensitively.  */
526 static int
527 dentry_compare_names_case_sensitive(const struct wim_dentry *d1,
528                                     const struct wim_dentry *d2)
529 {
530         return cmp_utf16le_strings(d1->file_name,
531                                    d1->file_name_nbytes / 2,
532                                    d2->file_name,
533                                    d2->file_name_nbytes / 2,
534                                    false);
535 }
536
537 static int
538 _avl_dentry_compare_names_ci(const struct avl_tree_node *n1,
539                              const struct avl_tree_node *n2)
540 {
541         const struct wim_dentry *d1, *d2;
542
543         d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node_ci);
544         d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node_ci);
545         return dentry_compare_names_case_insensitive(d1, d2);
546 }
547
548 static int
549 _avl_dentry_compare_names(const struct avl_tree_node *n1,
550                           const struct avl_tree_node *n2)
551 {
552         const struct wim_dentry *d1, *d2;
553
554         d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node);
555         d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node);
556         return dentry_compare_names_case_sensitive(d1, d2);
557 }
558
559 /* Default case sensitivity behavior for searches with
560  * WIMLIB_CASE_PLATFORM_DEFAULT specified.  This can be modified by
561  * wimlib_global_init().  */
562 bool default_ignore_case =
563 #ifdef __WIN32__
564         true
565 #else
566         false
567 #endif
568 ;
569
570 /* Case-sensitive dentry lookup.  Only @file_name and @file_name_nbytes of
571  * @dummy must be valid.  */
572 static struct wim_dentry *
573 dir_lookup(const struct wim_inode *dir, const struct wim_dentry *dummy)
574 {
575         struct avl_tree_node *node;
576
577         node = avl_tree_lookup_node(dir->i_children,
578                                     &dummy->d_index_node,
579                                     _avl_dentry_compare_names);
580         if (!node)
581                 return NULL;
582         return avl_tree_entry(node, struct wim_dentry, d_index_node);
583 }
584
585 /* Case-insensitive dentry lookup.  Only @file_name and @file_name_nbytes of
586  * @dummy must be valid.  */
587 static struct wim_dentry *
588 dir_lookup_ci(const struct wim_inode *dir, const struct wim_dentry *dummy)
589 {
590         struct avl_tree_node *node;
591
592         node = avl_tree_lookup_node(dir->i_children_ci,
593                                     &dummy->d_index_node_ci,
594                                     _avl_dentry_compare_names_ci);
595         if (!node)
596                 return NULL;
597         return avl_tree_entry(node, struct wim_dentry, d_index_node_ci);
598 }
599
600 /* Given a UTF-16LE filename and a directory, look up the dentry for the file.
601  * Return it if found, otherwise NULL.  This is case-sensitive on UNIX and
602  * case-insensitive on Windows. */
603 struct wim_dentry *
604 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
605                                    const utf16lechar *name,
606                                    size_t name_nbytes,
607                                    CASE_SENSITIVITY_TYPE case_ctype)
608 {
609         const struct wim_inode *dir = dentry->d_inode;
610         bool ignore_case = will_ignore_case(case_ctype);
611         struct wim_dentry dummy;
612         struct wim_dentry *child;
613
614         dummy.file_name = (utf16lechar*)name;
615         dummy.file_name_nbytes = name_nbytes;
616
617         if (!ignore_case)
618                 /* Case-sensitive lookup.  */
619                 return dir_lookup(dir, &dummy);
620
621         /* Case-insensitive lookup.  */
622
623         child = dir_lookup_ci(dir, &dummy);
624         if (!child)
625                 return NULL;
626
627         if (likely(list_empty(&child->d_ci_conflict_list)))
628                 /* Only one dentry has this case-insensitive name; return it */
629                 return child;
630
631         /* Multiple dentries have the same case-insensitive name.  Choose the
632          * dentry with the same case-sensitive name, if one exists; otherwise
633          * print a warning and choose one of the possible dentries arbitrarily.
634          */
635         struct wim_dentry *alt = child;
636         size_t num_alts = 0;
637
638         do {
639                 num_alts++;
640                 if (!dentry_compare_names_case_sensitive(&dummy, alt))
641                         return alt;
642                 alt = list_entry(alt->d_ci_conflict_list.next,
643                                  struct wim_dentry, d_ci_conflict_list);
644         } while (alt != child);
645
646         WARNING("Result of case-insensitive lookup is ambiguous\n"
647                 "          (returning \"%"TS"\" of %zu "
648                 "possible files, including \"%"TS"\")",
649                 dentry_full_path(child),
650                 num_alts,
651                 dentry_full_path(list_entry(child->d_ci_conflict_list.next,
652                                             struct wim_dentry,
653                                             d_ci_conflict_list)));
654         return child;
655 }
656
657 /* Returns the child of @dentry that has the file name @name.  Returns NULL if
658  * no child has the name. */
659 struct wim_dentry *
660 get_dentry_child_with_name(const struct wim_dentry *dentry, const tchar *name,
661                            CASE_SENSITIVITY_TYPE case_type)
662 {
663 #if TCHAR_IS_UTF16LE
664         return get_dentry_child_with_utf16le_name(dentry, name,
665                                                   tstrlen(name) * sizeof(tchar),
666                                                   case_type);
667 #else
668         utf16lechar *utf16le_name;
669         size_t utf16le_name_nbytes;
670         int ret;
671         struct wim_dentry *child;
672
673         ret = tstr_to_utf16le(name, tstrlen(name) * sizeof(tchar),
674                               &utf16le_name, &utf16le_name_nbytes);
675         if (ret) {
676                 child = NULL;
677         } else {
678                 child = get_dentry_child_with_utf16le_name(dentry,
679                                                            utf16le_name,
680                                                            utf16le_name_nbytes,
681                                                            case_type);
682                 FREE(utf16le_name);
683         }
684         return child;
685 #endif
686 }
687
688 static struct wim_dentry *
689 get_dentry_utf16le(WIMStruct *wim, const utf16lechar *path,
690                    CASE_SENSITIVITY_TYPE case_type)
691 {
692         struct wim_dentry *cur_dentry;
693         const utf16lechar *name_start, *name_end;
694
695         /* Start with the root directory of the image.  Note: this will be NULL
696          * if an image has been added directly with wimlib_add_empty_image() but
697          * no files have been added yet; in that case we fail with ENOENT.  */
698         cur_dentry = wim_root_dentry(wim);
699
700         name_start = path;
701         for (;;) {
702                 if (cur_dentry == NULL) {
703                         errno = ENOENT;
704                         return NULL;
705                 }
706
707                 if (*name_start && !dentry_is_directory(cur_dentry)) {
708                         errno = ENOTDIR;
709                         return NULL;
710                 }
711
712                 while (*name_start == cpu_to_le16(WIM_PATH_SEPARATOR))
713                         name_start++;
714
715                 if (!*name_start)
716                         return cur_dentry;
717
718                 name_end = name_start;
719                 do {
720                         ++name_end;
721                 } while (*name_end != cpu_to_le16(WIM_PATH_SEPARATOR) && *name_end);
722
723                 cur_dentry = get_dentry_child_with_utf16le_name(cur_dentry,
724                                                                 name_start,
725                                                                 (u8*)name_end - (u8*)name_start,
726                                                                 case_type);
727                 name_start = name_end;
728         }
729 }
730
731 /*
732  * WIM path lookup: translate a path in the currently selected WIM image to the
733  * corresponding dentry, if it exists.
734  *
735  * @wim
736  *      The WIMStruct for the WIM.  The search takes place in the currently
737  *      selected image.
738  *
739  * @path
740  *      The path to look up, given relative to the root of the WIM image.
741  *      Characters with value WIM_PATH_SEPARATOR are taken to be path
742  *      separators.  Leading path separators are ignored, whereas one or more
743  *      trailing path separators cause the path to only match a directory.
744  *
745  * @case_type
746  *      The case-sensitivity behavior of this function, as one of the following
747  *      constants:
748  *
749  *    - WIMLIB_CASE_SENSITIVE:  Perform the search case sensitively.  This means
750  *      that names must match exactly.
751  *
752  *    - WIMLIB_CASE_INSENSITIVE:  Perform the search case insensitively.  This
753  *      means that names are considered to match if they are equal when
754  *      transformed to upper case.  If a path component matches multiple names
755  *      case-insensitively, the name that matches the path component
756  *      case-sensitively is chosen, if existent; otherwise one
757  *      case-insensitively matching name is chosen arbitrarily.
758  *
759  *    - WIMLIB_CASE_PLATFORM_DEFAULT:  Perform either case-sensitive or
760  *      case-insensitive search, depending on the value of the global variable
761  *      default_ignore_case.
762  *
763  *    In any case, no Unicode normalization is done before comparing strings.
764  *
765  * Returns a pointer to the dentry that is the result of the lookup, or NULL if
766  * no such dentry exists.  If NULL is returned, errno is set to one of the
767  * following values:
768  *
769  *      ENOTDIR if one of the path components used as a directory existed but
770  *      was not, in fact, a directory.
771  *
772  *      ENOENT otherwise.
773  *
774  * Additional notes:
775  *
776  *    - This function does not consider a reparse point to be a directory, even
777  *      if it has FILE_ATTRIBUTE_DIRECTORY set.
778  *
779  *    - This function does not dereference symbolic links or junction points
780  *      when performing the search.
781  *
782  *    - Since this function ignores leading slashes, the empty path is valid and
783  *      names the root directory of the WIM image.
784  *
785  *    - An image added with wimlib_add_empty_image() does not have a root
786  *      directory yet, and this function will fail with ENOENT for any path on
787  *      such an image.
788  */
789 struct wim_dentry *
790 get_dentry(WIMStruct *wim, const tchar *path, CASE_SENSITIVITY_TYPE case_type)
791 {
792 #if TCHAR_IS_UTF16LE
793         return get_dentry_utf16le(wim, path, case_type);
794 #else
795         utf16lechar *path_utf16le;
796         size_t path_utf16le_nbytes;
797         int ret;
798         struct wim_dentry *dentry;
799
800         ret = tstr_to_utf16le(path, tstrlen(path) * sizeof(tchar),
801                               &path_utf16le, &path_utf16le_nbytes);
802         if (ret)
803                 return NULL;
804         dentry = get_dentry_utf16le(wim, path_utf16le, case_type);
805         FREE(path_utf16le);
806         return dentry;
807 #endif
808 }
809
810 /* Takes in a path of length @len in @buf, and transforms it into a string for
811  * the path of its parent directory. */
812 static void
813 to_parent_name(tchar *buf, size_t len)
814 {
815         ssize_t i = (ssize_t)len - 1;
816         while (i >= 0 && buf[i] == WIM_PATH_SEPARATOR)
817                 i--;
818         while (i >= 0 && buf[i] != WIM_PATH_SEPARATOR)
819                 i--;
820         while (i >= 0 && buf[i] == WIM_PATH_SEPARATOR)
821                 i--;
822         buf[i + 1] = T('\0');
823 }
824
825 /* Similar to get_dentry(), but returns the dentry named by @path with the last
826  * component stripped off.
827  *
828  * Note: The returned dentry is NOT guaranteed to be a directory.  */
829 struct wim_dentry *
830 get_parent_dentry(WIMStruct *wim, const tchar *path,
831                   CASE_SENSITIVITY_TYPE case_type)
832 {
833         size_t path_len = tstrlen(path);
834         tchar buf[path_len + 1];
835
836         tmemcpy(buf, path, path_len + 1);
837         to_parent_name(buf, path_len);
838         return get_dentry(wim, buf, case_type);
839 }
840
841 #ifdef WITH_FUSE
842 /* Finds the dentry, lookup table entry, and stream index for a WIM file stream,
843  * given a path name.
844  *
845  * Currently, lookups of this type are only needed if FUSE is enabled.  */
846 int
847 wim_pathname_to_stream(WIMStruct *wim,
848                        const tchar *path,
849                        int lookup_flags,
850                        struct wim_dentry **dentry_ret,
851                        struct wim_lookup_table_entry **lte_ret,
852                        u16 *stream_idx_ret)
853 {
854         struct wim_dentry *dentry;
855         struct wim_lookup_table_entry *lte;
856         u16 stream_idx;
857         const tchar *stream_name = NULL;
858         struct wim_inode *inode;
859         tchar *p = NULL;
860
861         if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
862                 stream_name = path_stream_name(path);
863                 if (stream_name) {
864                         p = (tchar*)stream_name - 1;
865                         *p = T('\0');
866                 }
867         }
868
869         dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
870         if (p)
871                 *p = T(':');
872         if (!dentry)
873                 return -errno;
874
875         inode = dentry->d_inode;
876
877         if (!inode->i_resolved)
878                 if (inode_resolve_streams(inode, wim->lookup_table, false))
879                         return -EIO;
880
881         if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
882               && inode_is_directory(inode))
883                 return -EISDIR;
884
885         if (stream_name) {
886                 struct wim_ads_entry *ads_entry;
887                 u16 ads_idx;
888                 ads_entry = inode_get_ads_entry(inode, stream_name,
889                                                 &ads_idx);
890                 if (ads_entry) {
891                         stream_idx = ads_idx + 1;
892                         lte = ads_entry->lte;
893                 } else {
894                         return -ENOENT;
895                 }
896         } else {
897                 lte = inode_unnamed_stream_resolved(inode, &stream_idx);
898         }
899         if (dentry_ret)
900                 *dentry_ret = dentry;
901         if (lte_ret)
902                 *lte_ret = lte;
903         if (stream_idx_ret)
904                 *stream_idx_ret = stream_idx;
905         return 0;
906 }
907 #endif /* WITH_FUSE  */
908
909 /* Creates an unlinked directory entry. */
910 int
911 new_dentry(const tchar *name, struct wim_dentry **dentry_ret)
912 {
913         struct wim_dentry *dentry;
914         int ret;
915
916         dentry = CALLOC(1, sizeof(struct wim_dentry));
917         if (!dentry)
918                 return WIMLIB_ERR_NOMEM;
919
920         if (*name) {
921                 ret = dentry_set_name(dentry, name);
922                 if (ret) {
923                         FREE(dentry);
924                         ERROR("Failed to set name on new dentry with name \"%"TS"\"",
925                               name);
926                         return ret;
927                 }
928         }
929         dentry->parent = dentry;
930         *dentry_ret = dentry;
931         return 0;
932 }
933
934 static int
935 _new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret,
936                         bool timeless)
937 {
938         struct wim_dentry *dentry;
939         int ret;
940
941         ret = new_dentry(name, &dentry);
942         if (ret)
943                 return ret;
944
945         if (timeless)
946                 dentry->d_inode = new_timeless_inode();
947         else
948                 dentry->d_inode = new_inode();
949         if (dentry->d_inode == NULL) {
950                 free_dentry(dentry);
951                 return WIMLIB_ERR_NOMEM;
952         }
953
954         inode_add_dentry(dentry, dentry->d_inode);
955         *dentry_ret = dentry;
956         return 0;
957 }
958
959 int
960 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret)
961 {
962         return _new_dentry_with_inode(name, dentry_ret, true);
963 }
964
965 int
966 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret)
967 {
968         return _new_dentry_with_inode(name, dentry_ret, false);
969 }
970
971 int
972 new_filler_directory(struct wim_dentry **dentry_ret)
973 {
974         int ret;
975         struct wim_dentry *dentry;
976
977         ret = new_dentry_with_inode(T(""), &dentry);
978         if (ret)
979                 return ret;
980         /* Leave the inode number as 0; this is allowed for non
981          * hard-linked files. */
982         dentry->d_inode->i_resolved = 1;
983         dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
984         *dentry_ret = dentry;
985         return 0;
986 }
987
988 static int
989 dentry_clear_inode_visited(struct wim_dentry *dentry, void *_ignore)
990 {
991         dentry->d_inode->i_visited = 0;
992         return 0;
993 }
994
995 void
996 dentry_tree_clear_inode_visited(struct wim_dentry *root)
997 {
998         for_dentry_in_tree(root, dentry_clear_inode_visited, NULL);
999 }
1000
1001 /*
1002  * Free a WIM dentry.
1003  *
1004  * In addition to freeing the dentry itself, this decrements the link count of
1005  * the corresponding inode (if any).  If the inode's link count reaches 0, the
1006  * inode is freed as well.
1007  */
1008 void
1009 free_dentry(struct wim_dentry *dentry)
1010 {
1011         if (dentry) {
1012                 FREE(dentry->file_name);
1013                 FREE(dentry->short_name);
1014                 FREE(dentry->_full_path);
1015                 if (dentry->d_inode)
1016                         put_inode(dentry->d_inode);
1017                 FREE(dentry);
1018         }
1019 }
1020
1021 static int
1022 do_free_dentry(struct wim_dentry *dentry, void *_ignore)
1023 {
1024         free_dentry(dentry);
1025         return 0;
1026 }
1027
1028 static int
1029 do_free_dentry_and_unref_streams(struct wim_dentry *dentry, void *lookup_table)
1030 {
1031         inode_unref_streams(dentry->d_inode, lookup_table);
1032         free_dentry(dentry);
1033         return 0;
1034 }
1035
1036 /*
1037  * Recursively frees all directory entries in the specified tree.
1038  *
1039  * @root:
1040  *      The root of the tree.
1041  *
1042  * @lookup_table:
1043  *      The lookup table for dentries.  If non-NULL, the reference counts in the
1044  *      lookup table for the lookup table entries corresponding to the dentries
1045  *      will be decremented.
1046  *
1047  * This also puts references to the corresponding inodes.
1048  *
1049  * This does *not* unlink @root from its parent directory (if it has one).
1050  */
1051 void
1052 free_dentry_tree(struct wim_dentry *root, struct wim_lookup_table *lookup_table)
1053 {
1054         int (*f)(struct wim_dentry *, void *);
1055
1056         if (lookup_table)
1057                 f = do_free_dentry_and_unref_streams;
1058         else
1059                 f = do_free_dentry;
1060
1061         for_dentry_in_tree_depth(root, f, lookup_table);
1062 }
1063
1064 /* Insert the @child dentry into the case sensitive index of the @dir directory.
1065  * Return NULL if successfully inserted, otherwise a pointer to the
1066  * already-inserted duplicate.  */
1067 static struct wim_dentry *
1068 dir_index_child(struct wim_inode *dir, struct wim_dentry *child)
1069 {
1070         struct avl_tree_node *duplicate;
1071
1072         duplicate = avl_tree_insert(&dir->i_children,
1073                                     &child->d_index_node,
1074                                     _avl_dentry_compare_names);
1075         if (!duplicate)
1076                 return NULL;
1077         return avl_tree_entry(duplicate, struct wim_dentry, d_index_node);
1078 }
1079
1080 /* Insert the @child dentry into the case insensitive index of the @dir
1081  * directory.  Return NULL if successfully inserted, otherwise a pointer to the
1082  * already-inserted duplicate.  */
1083 static struct wim_dentry *
1084 dir_index_child_ci(struct wim_inode *dir, struct wim_dentry *child)
1085 {
1086         struct avl_tree_node *duplicate;
1087
1088         duplicate = avl_tree_insert(&dir->i_children_ci,
1089                                     &child->d_index_node_ci,
1090                                     _avl_dentry_compare_names_ci);
1091         if (!duplicate)
1092                 return NULL;
1093         return avl_tree_entry(duplicate, struct wim_dentry, d_index_node_ci);
1094 }
1095
1096 /* Removes the specified dentry from its directory's case-sensitive index.  */
1097 static void
1098 dir_unindex_child(struct wim_inode *dir, struct wim_dentry *child)
1099 {
1100         avl_tree_remove(&dir->i_children, &child->d_index_node);
1101 }
1102
1103 /* Removes the specified dentry from its directory's case-insensitive index.  */
1104 static void
1105 dir_unindex_child_ci(struct wim_inode *dir, struct wim_dentry *child)
1106 {
1107         avl_tree_remove(&dir->i_children_ci, &child->d_index_node_ci);
1108 }
1109
1110 /* Returns true iff the specified dentry is in its parent directory's
1111  * case-insensitive index.  */
1112 static bool
1113 dentry_in_ci_index(const struct wim_dentry *dentry)
1114 {
1115         return !avl_tree_node_is_unlinked(&dentry->d_index_node_ci);
1116 }
1117
1118 /*
1119  * Links a dentry into the directory tree.
1120  *
1121  * @parent: The dentry that will be the parent of @child.
1122  * @child: The dentry to link.
1123  *
1124  * Returns NULL if successful.  If @parent already contains a dentry with the
1125  * same case-sensitive name as @child, returns a pointer to this duplicate
1126  * dentry.
1127  */
1128 struct wim_dentry *
1129 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child)
1130 {
1131         struct wim_dentry *duplicate;
1132         struct wim_inode *dir;
1133
1134         wimlib_assert(parent != child);
1135
1136         dir = parent->d_inode;
1137
1138         wimlib_assert(inode_is_directory(dir));
1139
1140         duplicate = dir_index_child(dir, child);
1141         if (duplicate)
1142                 return duplicate;
1143
1144         duplicate = dir_index_child_ci(dir, child);
1145         if (duplicate) {
1146                 list_add(&child->d_ci_conflict_list, &duplicate->d_ci_conflict_list);
1147                 avl_tree_node_set_unlinked(&child->d_index_node_ci);
1148         } else {
1149                 INIT_LIST_HEAD(&child->d_ci_conflict_list);
1150         }
1151         child->parent = parent;
1152         return NULL;
1153 }
1154
1155 /* Unlink a WIM dentry from the directory entry tree.  */
1156 void
1157 unlink_dentry(struct wim_dentry *dentry)
1158 {
1159         struct wim_inode *dir;
1160
1161         if (dentry_is_root(dentry))
1162                 return;
1163
1164         dir = dentry->parent->d_inode;
1165
1166         dir_unindex_child(dir, dentry);
1167
1168         if (dentry_in_ci_index(dentry)) {
1169
1170                 dir_unindex_child_ci(dir, dentry);
1171
1172                 if (!list_empty(&dentry->d_ci_conflict_list)) {
1173                         /* Make a different case-insensitively-the-same dentry
1174                          * be the "representative" in the search index. */
1175                         struct list_head *next;
1176                         struct wim_dentry *other;
1177                         struct wim_dentry *existing;
1178
1179                         next = dentry->d_ci_conflict_list.next;
1180                         other = list_entry(next, struct wim_dentry, d_ci_conflict_list);
1181                         existing = dir_index_child_ci(dir, other);
1182                         wimlib_assert(existing == NULL);
1183                 }
1184         }
1185         list_del(&dentry->d_ci_conflict_list);
1186 }
1187
1188 /* Reads a WIM directory entry, including all alternate data stream entries that
1189  * follow it, from the WIM image's metadata resource.  */
1190 static int
1191 read_dentry(const u8 * restrict buf, size_t buf_len,
1192             u64 offset, struct wim_dentry **dentry_ret)
1193 {
1194         u64 length;
1195         const u8 *p;
1196         const struct wim_dentry_on_disk *disk_dentry;
1197         struct wim_dentry *dentry;
1198         struct wim_inode *inode;
1199         u16 short_name_nbytes;
1200         u16 file_name_nbytes;
1201         u64 calculated_size;
1202         int ret;
1203
1204         BUILD_BUG_ON(sizeof(struct wim_dentry_on_disk) != WIM_DENTRY_DISK_SIZE);
1205
1206         /* Before reading the whole dentry, we need to read just the length.
1207          * This is because a dentry of length 8 (that is, just the length field)
1208          * terminates the list of sibling directory entries. */
1209
1210         /* Check for buffer overrun.  */
1211         if (unlikely(offset + sizeof(u64) > buf_len ||
1212                      offset + sizeof(u64) < offset))
1213         {
1214                 ERROR("Directory entry starting at %"PRIu64" ends past the "
1215                       "end of the metadata resource (size %zu)",
1216                       offset, buf_len);
1217                 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1218         }
1219
1220         /* Get pointer to the dentry data.  */
1221         p = &buf[offset];
1222         disk_dentry = (const struct wim_dentry_on_disk*)p;
1223
1224         /* Get dentry length.  */
1225         length = le64_to_cpu(disk_dentry->length);
1226
1227         /* Check for end-of-directory.  */
1228         if (length <= 8) {
1229                 *dentry_ret = NULL;
1230                 return 0;
1231         }
1232
1233         /* Validate dentry length.  */
1234         if (unlikely(length < sizeof(struct wim_dentry_on_disk))) {
1235                 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
1236                       length);
1237                 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1238         }
1239
1240         /* Check for buffer overrun.  */
1241         if (unlikely(offset + length > buf_len ||
1242                      offset + length < offset))
1243         {
1244                 ERROR("Directory entry at offset %"PRIu64" and with size "
1245                       "%"PRIu64" ends past the end of the metadata resource "
1246                       "(size %zu)", offset, length, buf_len);
1247                 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1248         }
1249
1250         /* Allocate new dentry structure, along with a preliminary inode.  */
1251         ret = new_dentry_with_timeless_inode(T(""), &dentry);
1252         if (ret)
1253                 return ret;
1254
1255         dentry->length = length;
1256         inode = dentry->d_inode;
1257
1258         /* Read more fields: some into the dentry, and some into the inode.  */
1259         inode->i_attributes = le32_to_cpu(disk_dentry->attributes);
1260         inode->i_security_id = le32_to_cpu(disk_dentry->security_id);
1261         dentry->subdir_offset = le64_to_cpu(disk_dentry->subdir_offset);
1262         inode->i_creation_time = le64_to_cpu(disk_dentry->creation_time);
1263         inode->i_last_access_time = le64_to_cpu(disk_dentry->last_access_time);
1264         inode->i_last_write_time = le64_to_cpu(disk_dentry->last_write_time);
1265         copy_hash(inode->i_hash, disk_dentry->unnamed_stream_hash);
1266
1267         /* I don't know what's going on here.  It seems like M$ screwed up the
1268          * reparse points, then put the fields in the same place and didn't
1269          * document it.  So we have some fields we read for reparse points, and
1270          * some fields in the same place for non-reparse-points.  */
1271         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1272                 inode->i_rp_unknown_1 = le32_to_cpu(disk_dentry->reparse.rp_unknown_1);
1273                 inode->i_reparse_tag = le32_to_cpu(disk_dentry->reparse.reparse_tag);
1274                 inode->i_rp_unknown_2 = le16_to_cpu(disk_dentry->reparse.rp_unknown_2);
1275                 inode->i_not_rpfixed = le16_to_cpu(disk_dentry->reparse.not_rpfixed);
1276                 /* Leave inode->i_ino at 0.  Note that this means the WIM file
1277                  * cannot archive hard-linked reparse points.  Such a thing
1278                  * doesn't really make sense anyway, although I believe it's
1279                  * theoretically possible to have them on NTFS.  */
1280         } else {
1281                 inode->i_rp_unknown_1 = le32_to_cpu(disk_dentry->nonreparse.rp_unknown_1);
1282                 inode->i_ino = le64_to_cpu(disk_dentry->nonreparse.hard_link_group_id);
1283         }
1284         inode->i_num_ads = le16_to_cpu(disk_dentry->num_alternate_data_streams);
1285
1286         /* Now onto reading the names.  There are two of them: the (long) file
1287          * name, and the short name.  */
1288
1289         short_name_nbytes = le16_to_cpu(disk_dentry->short_name_nbytes);
1290         file_name_nbytes = le16_to_cpu(disk_dentry->file_name_nbytes);
1291
1292         if (unlikely((short_name_nbytes & 1) | (file_name_nbytes & 1))) {
1293                 ERROR("Dentry name is not valid UTF-16 (odd number of bytes)!");
1294                 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1295                 goto err_free_dentry;
1296         }
1297
1298         /* We now know the length of the file name and short name.  Make sure
1299          * the length of the dentry is large enough to actually hold them.
1300          *
1301          * The calculated length here is unaligned to allow for the possibility
1302          * that the dentry->length names an unaligned length, although this
1303          * would be unexpected.  */
1304         calculated_size = dentry_correct_length_unaligned(file_name_nbytes,
1305                                                           short_name_nbytes);
1306
1307         if (unlikely(dentry->length < calculated_size)) {
1308                 ERROR("Unexpected end of directory entry! (Expected "
1309                       "at least %"PRIu64" bytes, got %"PRIu64" bytes.)",
1310                       calculated_size, dentry->length);
1311                 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1312                 goto err_free_dentry;
1313         }
1314
1315         /* Advance p to point past the base dentry, to the first name.  */
1316         p += sizeof(struct wim_dentry_on_disk);
1317
1318         /* Read the filename if present.  Note: if the filename is empty, there
1319          * is no null terminator following it.  */
1320         if (file_name_nbytes) {
1321                 dentry->file_name = MALLOC(file_name_nbytes + 2);
1322                 if (dentry->file_name == NULL) {
1323                         ret = WIMLIB_ERR_NOMEM;
1324                         goto err_free_dentry;
1325                 }
1326                 dentry->file_name_nbytes = file_name_nbytes;
1327                 memcpy(dentry->file_name, p, file_name_nbytes);
1328                 p += file_name_nbytes + 2;
1329                 dentry->file_name[file_name_nbytes / 2] = cpu_to_le16(0);
1330         }
1331
1332         /* Read the short filename if present.  Note: if there is no short
1333          * filename, there is no null terminator following it. */
1334         if (short_name_nbytes) {
1335                 dentry->short_name = MALLOC(short_name_nbytes + 2);
1336                 if (dentry->short_name == NULL) {
1337                         ret = WIMLIB_ERR_NOMEM;
1338                         goto err_free_dentry;
1339                 }
1340                 dentry->short_name_nbytes = short_name_nbytes;
1341                 memcpy(dentry->short_name, p, short_name_nbytes);
1342                 p += short_name_nbytes + 2;
1343                 dentry->short_name[short_name_nbytes / 2] = cpu_to_le16(0);
1344         }
1345
1346         /* Align the dentry length.  */
1347         dentry->length = (dentry->length + 7) & ~7;
1348
1349         /* Read the alternate data streams, if present.  inode->i_num_ads tells
1350          * us how many they are, and they will directly follow the dentry in the
1351          * metadata resource buffer.
1352          *
1353          * Note that each alternate data stream entry begins on an 8-byte
1354          * aligned boundary, and the alternate data stream entries seem to NOT
1355          * be included in the dentry->length field for some reason.  */
1356         if (unlikely(inode->i_num_ads != 0)) {
1357                 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1358                 if (offset + dentry->length > buf_len ||
1359                     (ret = read_ads_entries(&buf[offset + dentry->length],
1360                                             inode,
1361                                             buf_len - offset - dentry->length)))
1362                 {
1363                         ERROR("Failed to read alternate data stream "
1364                               "entries of WIM dentry \"%"WS"\"",
1365                               dentry->file_name);
1366                         goto err_free_dentry;
1367                 }
1368         }
1369
1370         *dentry_ret = dentry;
1371         return 0;
1372
1373 err_free_dentry:
1374         free_dentry(dentry);
1375         return ret;
1376 }
1377
1378 static bool
1379 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
1380 {
1381         if (dentry->file_name_nbytes <= 4) {
1382                 if (dentry->file_name_nbytes == 4) {
1383                         if (dentry->file_name[0] == cpu_to_le16('.') &&
1384                             dentry->file_name[1] == cpu_to_le16('.'))
1385                                 return true;
1386                 } else if (dentry->file_name_nbytes == 2) {
1387                         if (dentry->file_name[0] == cpu_to_le16('.'))
1388                                 return true;
1389                 }
1390         }
1391         return false;
1392 }
1393
1394 static int
1395 read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len,
1396                            struct wim_dentry * restrict dir)
1397 {
1398         u64 cur_offset = dir->subdir_offset;
1399
1400         /* Check for cyclic directory structure, which would cause infinite
1401          * recursion if not handled.  */
1402         for (struct wim_dentry *d = dir->parent;
1403              !dentry_is_root(d); d = d->parent)
1404         {
1405                 if (unlikely(d->subdir_offset == cur_offset)) {
1406                         ERROR("Cyclic directory structure detected: children "
1407                               "of \"%"TS"\" coincide with children of \"%"TS"\"",
1408                               dentry_full_path(dir), dentry_full_path(d));
1409                         return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1410                 }
1411         }
1412
1413         for (;;) {
1414                 struct wim_dentry *child;
1415                 struct wim_dentry *duplicate;
1416                 int ret;
1417
1418                 /* Read next child of @dir.  */
1419                 ret = read_dentry(buf, buf_len, cur_offset, &child);
1420                 if (ret)
1421                         return ret;
1422
1423                 /* Check for end of directory.  */
1424                 if (child == NULL)
1425                         return 0;
1426
1427                 /* Advance to the offset of the next child.  Note: We need to
1428                  * advance by the TOTAL length of the dentry, not by the length
1429                  * child->length, which although it does take into account the
1430                  * padding, it DOES NOT take into account alternate stream
1431                  * entries.  */
1432                 cur_offset += dentry_in_total_length(child);
1433
1434                 /* All dentries except the root should be named.  */
1435                 if (unlikely(!dentry_has_long_name(child))) {
1436                         WARNING("Ignoring unnamed dentry in "
1437                                 "directory \"%"TS"\"", dentry_full_path(dir));
1438                         free_dentry(child);
1439                         continue;
1440                 }
1441
1442                 /* Don't allow files named "." or "..".  */
1443                 if (unlikely(dentry_is_dot_or_dotdot(child))) {
1444                         WARNING("Ignoring file named \".\" or \"..\"; "
1445                                 "potentially malicious archive!!!");
1446                         free_dentry(child);
1447                         continue;
1448                 }
1449
1450                 /* Link the child into the directory.  */
1451                 duplicate = dentry_add_child(dir, child);
1452                 if (unlikely(duplicate)) {
1453                         /* We already found a dentry with this same
1454                          * case-sensitive long name.  Only keep the first one.
1455                          */
1456                         WARNING("Ignoring duplicate file \"%"TS"\" "
1457                                 "(the WIM image already contains a file "
1458                                 "at that path with the exact same name)",
1459                                 dentry_full_path(duplicate));
1460                         free_dentry(child);
1461                         continue;
1462                 }
1463
1464                 /* If this child is a directory that itself has children, call
1465                  * this procedure recursively.  */
1466                 if (child->subdir_offset != 0) {
1467                         if (likely(dentry_is_directory(child))) {
1468                                 ret = read_dentry_tree_recursive(buf,
1469                                                                  buf_len,
1470                                                                  child);
1471                                 if (ret)
1472                                         return ret;
1473                         } else {
1474                                 WARNING("Ignoring children of "
1475                                         "non-directory file \"%"TS"\"",
1476                                         dentry_full_path(child));
1477                         }
1478                 }
1479         }
1480 }
1481
1482 /*
1483  * Read a tree of dentries (directory entries) from a WIM metadata resource.
1484  *
1485  * @buf:
1486  *      Buffer containing an uncompressed WIM metadata resource.
1487  *
1488  * @buf_len:
1489  *      Length of the uncompressed metadata resource, in bytes.
1490  *
1491  * @root_offset
1492  *      Offset in the metadata resource of the root of the dentry tree.
1493  *
1494  * @root_ret:
1495  *      On success, either NULL or a pointer to the root dentry is written to
1496  *      this location.  The former case only occurs in the unexpected case that
1497  *      the tree began with an end-of-directory entry.
1498  *
1499  * Return values:
1500  *      WIMLIB_ERR_SUCCESS (0)
1501  *      WIMLIB_ERR_INVALID_METADATA_RESOURCE
1502  *      WIMLIB_ERR_NOMEM
1503  */
1504 int
1505 read_dentry_tree(const u8 *buf, size_t buf_len,
1506                  u64 root_offset, struct wim_dentry **root_ret)
1507 {
1508         int ret;
1509         struct wim_dentry *root;
1510
1511         DEBUG("Reading dentry tree (root_offset=%"PRIu64")", root_offset);
1512
1513         ret = read_dentry(buf, buf_len, root_offset, &root);
1514         if (ret)
1515                 return ret;
1516
1517         if (likely(root != NULL)) {
1518                 if (unlikely(dentry_has_long_name(root) ||
1519                              dentry_has_short_name(root)))
1520                 {
1521                         WARNING("The root directory has a nonempty name; "
1522                                 "removing it.");
1523                         FREE(root->file_name);
1524                         FREE(root->short_name);
1525                         root->file_name = NULL;
1526                         root->short_name = NULL;
1527                         root->file_name_nbytes = 0;
1528                         root->short_name_nbytes = 0;
1529                 }
1530
1531                 if (unlikely(!dentry_is_directory(root))) {
1532                         ERROR("The root of the WIM image is not a directory!");
1533                         ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1534                         goto err_free_dentry_tree;
1535                 }
1536
1537                 if (likely(root->subdir_offset != 0)) {
1538                         ret = read_dentry_tree_recursive(buf, buf_len, root);
1539                         if (ret)
1540                                 goto err_free_dentry_tree;
1541                 }
1542         } else {
1543                 WARNING("The metadata resource has no directory entries; "
1544                         "treating as an empty image.");
1545         }
1546         *root_ret = root;
1547         return 0;
1548
1549 err_free_dentry_tree:
1550         free_dentry_tree(root, NULL);
1551         return ret;
1552 }
1553
1554 /*
1555  * Writes a WIM alternate data stream (ADS) entry to an output buffer.
1556  *
1557  * @ads_entry:  The ADS entry structure.
1558  * @hash:       The hash field to use (instead of the one in the ADS entry).
1559  * @p:          The memory location to write the data to.
1560  *
1561  * Returns a pointer to the byte after the last byte written.
1562  */
1563 static u8 *
1564 write_ads_entry(const struct wim_ads_entry *ads_entry,
1565                 const u8 *hash, u8 * restrict p)
1566 {
1567         struct wim_ads_entry_on_disk *disk_ads_entry =
1568                         (struct wim_ads_entry_on_disk*)p;
1569         u8 *orig_p = p;
1570
1571         disk_ads_entry->reserved = cpu_to_le64(ads_entry->reserved);
1572         copy_hash(disk_ads_entry->hash, hash);
1573         disk_ads_entry->stream_name_nbytes = cpu_to_le16(ads_entry->stream_name_nbytes);
1574         p += sizeof(struct wim_ads_entry_on_disk);
1575         if (ads_entry->stream_name_nbytes) {
1576                 p = mempcpy(p, ads_entry->stream_name,
1577                             ads_entry->stream_name_nbytes + 2);
1578         }
1579         /* Align to 8-byte boundary */
1580         while ((uintptr_t)p & 7)
1581                 *p++ = 0;
1582         disk_ads_entry->length = cpu_to_le64(p - orig_p);
1583         return p;
1584 }
1585
1586 /*
1587  * Writes a WIM dentry to an output buffer.
1588  *
1589  * @dentry:  The dentry structure.
1590  * @p:       The memory location to write the data to.
1591  *
1592  * Returns the pointer to the byte after the last byte we wrote as part of the
1593  * dentry, including any alternate data stream entries.
1594  */
1595 static u8 *
1596 write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p)
1597 {
1598         const struct wim_inode *inode;
1599         struct wim_dentry_on_disk *disk_dentry;
1600         const u8 *orig_p;
1601         const u8 *hash;
1602         bool use_dummy_stream;
1603         u16 num_ads;
1604
1605         wimlib_assert(((uintptr_t)p & 7) == 0); /* 8 byte aligned */
1606         orig_p = p;
1607
1608         inode = dentry->d_inode;
1609         use_dummy_stream = inode_needs_dummy_stream(inode);
1610         disk_dentry = (struct wim_dentry_on_disk*)p;
1611
1612         disk_dentry->attributes = cpu_to_le32(inode->i_attributes);
1613         disk_dentry->security_id = cpu_to_le32(inode->i_security_id);
1614         disk_dentry->subdir_offset = cpu_to_le64(dentry->subdir_offset);
1615         disk_dentry->unused_1 = cpu_to_le64(0);
1616         disk_dentry->unused_2 = cpu_to_le64(0);
1617         disk_dentry->creation_time = cpu_to_le64(inode->i_creation_time);
1618         disk_dentry->last_access_time = cpu_to_le64(inode->i_last_access_time);
1619         disk_dentry->last_write_time = cpu_to_le64(inode->i_last_write_time);
1620         if (use_dummy_stream)
1621                 hash = zero_hash;
1622         else
1623                 hash = inode_stream_hash(inode, 0);
1624         copy_hash(disk_dentry->unnamed_stream_hash, hash);
1625         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1626                 disk_dentry->reparse.rp_unknown_1 = cpu_to_le32(inode->i_rp_unknown_1);
1627                 disk_dentry->reparse.reparse_tag = cpu_to_le32(inode->i_reparse_tag);
1628                 disk_dentry->reparse.rp_unknown_2 = cpu_to_le16(inode->i_rp_unknown_2);
1629                 disk_dentry->reparse.not_rpfixed = cpu_to_le16(inode->i_not_rpfixed);
1630         } else {
1631                 disk_dentry->nonreparse.rp_unknown_1 = cpu_to_le32(inode->i_rp_unknown_1);
1632                 disk_dentry->nonreparse.hard_link_group_id =
1633                         cpu_to_le64((inode->i_nlink == 1) ? 0 : inode->i_ino);
1634         }
1635         num_ads = inode->i_num_ads;
1636         if (use_dummy_stream)
1637                 num_ads++;
1638         disk_dentry->num_alternate_data_streams = cpu_to_le16(num_ads);
1639         disk_dentry->short_name_nbytes = cpu_to_le16(dentry->short_name_nbytes);
1640         disk_dentry->file_name_nbytes = cpu_to_le16(dentry->file_name_nbytes);
1641         p += sizeof(struct wim_dentry_on_disk);
1642
1643         wimlib_assert(dentry_is_root(dentry) != dentry_has_long_name(dentry));
1644
1645         if (dentry_has_long_name(dentry))
1646                 p = mempcpy(p, dentry->file_name, dentry->file_name_nbytes + 2);
1647
1648         if (dentry_has_short_name(dentry))
1649                 p = mempcpy(p, dentry->short_name, dentry->short_name_nbytes + 2);
1650
1651         /* Align to 8-byte boundary */
1652         while ((uintptr_t)p & 7)
1653                 *p++ = 0;
1654
1655         disk_dentry->length = cpu_to_le64(p - orig_p);
1656
1657         if (use_dummy_stream) {
1658                 hash = inode_unnamed_stream_hash(inode);
1659                 p = write_ads_entry(&(struct wim_ads_entry){}, hash, p);
1660         }
1661
1662         /* Write the alternate data streams entries, if any. */
1663         for (u16 i = 0; i < inode->i_num_ads; i++) {
1664                 hash = inode_stream_hash(inode, i + 1);
1665                 p = write_ads_entry(&inode->i_ads_entries[i], hash, p);
1666         }
1667
1668         return p;
1669 }
1670
1671 static int
1672 write_dir_dentries(struct wim_dentry *dir, void *_pp)
1673 {
1674         if (dir->subdir_offset != 0) {
1675                 u8 **pp = _pp;
1676                 u8 *p = *pp;
1677                 struct wim_dentry *child;
1678
1679                 /* write child dentries */
1680                 for_dentry_child(child, dir)
1681                         p = write_dentry(child, p);
1682
1683                 /* write end of directory entry */
1684                 *(u64*)p = 0;
1685                 p += 8;
1686                 *pp = p;
1687         }
1688         return 0;
1689 }
1690
1691 /* Writes a directory tree to the metadata resource.
1692  *
1693  * @root:       Root of the dentry tree.
1694  * @p:          Pointer to a buffer with enough space for the dentry tree.
1695  *
1696  * Returns pointer to the byte after the last byte we wrote.
1697  */
1698 u8 *
1699 write_dentry_tree(struct wim_dentry *root, u8 *p)
1700 {
1701         DEBUG("Writing dentry tree.");
1702         wimlib_assert(dentry_is_root(root));
1703
1704         /* write root dentry and end-of-directory entry following it */
1705         p = write_dentry(root, p);
1706         *(u64*)p = 0;
1707         p += 8;
1708
1709         /* write the rest of the dentry tree */
1710         for_dentry_in_tree(root, write_dir_dentries, &p);
1711
1712         return p;
1713 }