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