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