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