4 * In the WIM file format, the dentries are stored in the "metadata resource"
5 * section right after the security data. Each image in the WIM file has its
6 * own metadata resource with its own security data and dentry tree. Dentries
7 * in different images may share file resources by referring to the same lookup
12 * Copyright (C) 2012, 2013, 2014 Eric Biggers
14 * This file is part of wimlib, a library for working with WIM files.
16 * wimlib is free software; you can redistribute it and/or modify it under the
17 * terms of the GNU General Public License as published by the Free Software
18 * Foundation; either version 3 of the License, or (at your option) any later
21 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License along with
26 * wimlib; if not, see http://www.gnu.org/licenses/.
34 #include "wimlib/case.h"
35 #include "wimlib/dentry.h"
36 #include "wimlib/encoding.h"
37 #include "wimlib/endianness.h"
38 #include "wimlib/error.h"
39 #include "wimlib/lookup_table.h"
40 #include "wimlib/metadata.h"
41 #include "wimlib/paths.h"
42 #include "wimlib/resource.h"
43 #include "wimlib/security.h"
44 #include "wimlib/sha1.h"
45 #include "wimlib/timestamp.h"
49 /* On-disk format of a WIM dentry (directory entry), located in the metadata
50 * resource for a WIM image. */
51 struct wim_dentry_on_disk {
53 /* Length of this directory entry in bytes, not including any alternate
54 * data stream entries. Should be a multiple of 8 so that the following
55 * dentry or alternate data stream entry is aligned on an 8-byte
56 * boundary. (If not, wimlib will round it up.) It must be at least as
57 * long as the fixed-length fields of the dentry (WIM_DENTRY_DISK_SIZE),
58 * plus the lengths of the file name and/or short name if present.
60 * It is also possible for this field to be 0. This situation, which is
61 * undocumented, indicates the end of a list of sibling nodes in a
62 * directory. It also means the real length is 8, because the dentry
63 * included only the length field, but that takes up 8 bytes. */
66 /* Attributes of the file or directory. This is a bitwise OR of the
67 * FILE_ATTRIBUTE_* constants and should correspond to the value
68 * retrieved by GetFileAttributes() on Windows. */
71 /* A value that specifies the security descriptor for this file or
72 * directory. If -1, the file or directory has no security descriptor.
73 * Otherwise, it is a 0-based index into the WIM image's table of
74 * security descriptors (see: `struct wim_security_data') */
77 /* Offset, in bytes, from the start of the uncompressed metadata
78 * resource of this directory's child directory entries, or 0 if this
79 * directory entry does not correspond to a directory or otherwise does
80 * not have any children. */
87 /* Creation time, last access time, and last write time, in
88 * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601. They
89 * should correspond to the times gotten by calling GetFileTime() on
92 le64 last_access_time;
95 /* Vaguely, the SHA-1 message digest ("hash") of the file's contents.
96 * More specifically, this is for the "unnamed data stream" rather than
97 * any "alternate data streams". This hash value is used to look up the
98 * corresponding entry in the WIM's stream lookup table to actually find
99 * the file contents within the WIM.
101 * If the file has no unnamed data stream (e.g. is a directory), then
102 * this field will be all zeroes. If the unnamed data stream is empty
103 * (i.e. an "empty file"), then this field is also expected to be all
104 * zeroes. (It will be if wimlib created the WIM image, at least;
105 * otherwise it can't be ruled out that the SHA-1 message digest of 0
106 * bytes of data is given explicitly.)
108 * If the file has reparse data, then this field will instead specify
109 * the SHA-1 message digest of the reparse data. If it is somehow
110 * possible for a file to have both an unnamed data stream and reparse
111 * data, then this is not handled by wimlib.
113 * As a further special case, if this field is all zeroes but there is
114 * an alternate data stream entry with no name and a nonzero SHA-1
115 * message digest field, then that hash must be used instead of this
116 * one. In fact, when named data streams are present, some versions of
117 * Windows PE contain a bug where they only look in the alternate data
118 * stream entries for the unnamed data stream, not here.
120 u8 unnamed_stream_hash[SHA1_HASH_SIZE];
122 /* The format of the following data is not yet completely known and they
123 * do not correspond to Microsoft's documentation.
125 * If this directory entry is for a reparse point (has
126 * FILE_ATTRIBUTE_REPARSE_POINT set in the attributes field), then the
127 * version of the following fields containing the reparse tag is valid.
128 * Furthermore, the field notated as not_rpfixed, as far as I can tell,
129 * is supposed to be set to 1 if reparse point fixups (a.k.a. fixing the
130 * targets of absolute symbolic links) were *not* done, and otherwise 0.
132 * If this directory entry is not for a reparse point, then the version
133 * of the following fields containing the hard_link_group_id is valid.
134 * All MS says about this field is that "If this file is part of a hard
135 * link set, all the directory entries in the set will share the same
136 * value in this field.". However, more specifically I have observed
138 * - If the file is part of a hard link set of size 1, then the
139 * hard_link_group_id should be set to either 0, which is treated
140 * specially as indicating "not hardlinked", or any unique value.
141 * - The specific nonzero values used to identity hard link sets do
142 * not matter, as long as they are unique.
143 * - However, due to bugs in Microsoft's software, it is actually NOT
144 * guaranteed that directory entries that share the same hard link
145 * group ID are actually hard linked to each either. We have to
146 * handle this by using special code to use distinguishing features
147 * (which is possible because some information about the underlying
148 * inode is repeated in each dentry) to split up these fake hard link
149 * groups into what they actually are supposed to be.
157 } _packed_attribute reparse;
160 le64 hard_link_group_id;
161 } _packed_attribute nonreparse;
164 /* Number of alternate data stream entries that directly follow this
166 le16 num_alternate_data_streams;
168 /* Length of this file's UTF-16LE encoded short name (8.3 DOS-compatible
169 * name), if present, in bytes, excluding the null terminator. If this
170 * file has no short name, then this field should be 0. */
171 le16 short_name_nbytes;
173 /* Length of this file's UTF-16LE encoded "long" name, excluding the
174 * null terminator. If this file has no short name, then this field
175 * should be 0. It's expected that only the root dentry has this field
177 le16 file_name_nbytes;
179 /* Followed by variable length file name, in UTF16-LE, if
180 * file_name_nbytes != 0. Includes null terminator. */
181 /*utf16lechar file_name[];*/
183 /* Followed by variable length short name, in UTF16-LE, if
184 * short_name_nbytes != 0. Includes null terminator. */
185 /*utf16lechar short_name[];*/
187 /* And optionally followed by a variable-length series of tagged items;
188 * see tagged_items.c. */
191 /* Calculates the unaligned length, in bytes, of an on-disk WIM dentry that has
192 * a file name and short name that take the specified numbers of bytes. This
193 * excludes any alternate data stream entries that may follow the dentry. */
195 dentry_correct_length_unaligned(u16 file_name_nbytes, u16 short_name_nbytes)
197 u64 length = sizeof(struct wim_dentry_on_disk);
198 if (file_name_nbytes)
199 length += file_name_nbytes + 2;
200 if (short_name_nbytes)
201 length += short_name_nbytes + 2;
205 /* Calculates the unaligned length, in bytes, of an on-disk WIM dentry, based on
206 * the file name length, short name length, and optional tagged items. Note
207 * that dentry->length is ignored; also, this excludes any alternate data stream
208 * entries that may follow the dentry. */
210 dentry_correct_length_aligned(const struct wim_dentry *dentry)
214 len = dentry_correct_length_unaligned(dentry->file_name_nbytes,
215 dentry->short_name_nbytes);
217 if (dentry->d_inode->i_extra_size) {
218 len = (len + 7) & ~7;
219 len += dentry->d_inode->i_extra_size;
222 return (len + 7) & ~7;
226 do_dentry_set_name(struct wim_dentry *dentry, utf16lechar *file_name,
227 size_t file_name_nbytes)
229 FREE(dentry->file_name);
230 dentry->file_name = file_name;
231 dentry->file_name_nbytes = file_name_nbytes;
233 if (dentry_has_short_name(dentry)) {
234 FREE(dentry->short_name);
235 dentry->short_name = NULL;
236 dentry->short_name_nbytes = 0;
240 /* Sets the name of a WIM dentry from a UTF-16LE string.
241 * Only use this on dentries not inserted into the tree. Use rename_wim_path()
242 * to do a real rename. */
244 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *name,
247 utf16lechar *dup = NULL;
250 dup = utf16le_dupz(name, name_nbytes);
252 return WIMLIB_ERR_NOMEM;
254 do_dentry_set_name(dentry, dup, name_nbytes);
259 /* Sets the name of a WIM dentry from a multibyte string.
260 * Only use this on dentries not inserted into the tree. Use rename_wim_path()
261 * to do a real rename. */
263 dentry_set_name(struct wim_dentry *dentry, const tchar *name)
265 utf16lechar *name_utf16le = NULL;
266 size_t name_utf16le_nbytes = 0;
270 ret = tstr_to_utf16le(name, tstrlen(name) * sizeof(tchar),
271 &name_utf16le, &name_utf16le_nbytes);
276 do_dentry_set_name(dentry, name_utf16le, name_utf16le_nbytes);
280 /* Returns the total length of a WIM alternate data stream entry on-disk,
281 * including the stream name, the null terminator, AND the padding after the
282 * entry to align the next ADS entry or dentry on an 8-byte boundary. */
284 ads_entry_total_length(const struct wim_ads_entry *entry)
286 u64 len = sizeof(struct wim_ads_entry_on_disk);
287 if (entry->stream_name_nbytes)
288 len += entry->stream_name_nbytes + 2;
289 return (len + 7) & ~7;
293 * Determine whether to include a "dummy" stream when writing a WIM dentry:
295 * Some versions of Microsoft's WIM software (the boot driver(s) in WinPE 3.0,
296 * for example) contain a bug where they assume the first alternate data stream
297 * (ADS) entry of a dentry with a nonzero ADS count specifies the unnamed
298 * stream, even if it has a name and the unnamed stream is already specified in
299 * the hash field of the dentry itself.
301 * wimlib has to work around this behavior by carefully emulating the behavior
302 * of (most versions of) ImageX/WIMGAPI, which move the unnamed stream reference
303 * into the alternate stream entries whenever there are named data streams, even
304 * though there is already a field in the dentry itself for the unnamed stream
305 * reference, which then goes to waste.
308 inode_needs_dummy_stream(const struct wim_inode *inode)
310 return (inode->i_num_ads > 0 &&
311 inode->i_num_ads < 0xffff && /* overflow check */
312 inode->i_canonical_streams); /* assume the dentry is okay if it
313 already had an unnamed ADS entry
314 when it was read in */
317 /* Calculate the total number of bytes that will be consumed when a WIM dentry
318 * is written. This includes base dentry and name fields as well as all
319 * alternate data stream entries and alignment bytes. */
321 dentry_out_total_length(const struct wim_dentry *dentry)
323 u64 length = dentry_correct_length_aligned(dentry);
324 const struct wim_inode *inode = dentry->d_inode;
326 if (inode_needs_dummy_stream(inode))
327 length += ads_entry_total_length(&(struct wim_ads_entry){});
329 for (u16 i = 0; i < inode->i_num_ads; i++)
330 length += ads_entry_total_length(&inode->i_ads_entries[i]);
335 /* Calculate the aligned, total length of a dentry, including all alternate data
336 * stream entries. Uses dentry->length. */
338 dentry_in_total_length(const struct wim_dentry *dentry)
340 u64 length = dentry->length;
341 const struct wim_inode *inode = dentry->d_inode;
342 for (u16 i = 0; i < inode->i_num_ads; i++)
343 length += ads_entry_total_length(&inode->i_ads_entries[i]);
344 return (length + 7) & ~7;
348 do_for_dentry_in_tree(struct wim_dentry *dentry,
349 int (*visitor)(struct wim_dentry *, void *), void *arg)
352 struct wim_dentry *child;
354 ret = (*visitor)(dentry, arg);
358 for_dentry_child(child, dentry) {
359 ret = do_for_dentry_in_tree(child, visitor, arg);
368 do_for_dentry_in_tree_depth(struct wim_dentry *dentry,
369 int (*visitor)(struct wim_dentry *, void *), void *arg)
372 struct wim_dentry *child;
374 for_dentry_child_postorder(child, dentry) {
375 ret = do_for_dentry_in_tree_depth(child, visitor, arg);
379 return unlikely((*visitor)(dentry, arg));
382 /* Calls a function on all directory entries in a WIM dentry tree. Logically,
383 * this is a pre-order traversal (the function is called on a parent dentry
384 * before its children), but sibling dentries will be visited in order as well.
387 for_dentry_in_tree(struct wim_dentry *root,
388 int (*visitor)(struct wim_dentry *, void *), void *arg)
392 return do_for_dentry_in_tree(root, visitor, arg);
395 /* Like for_dentry_in_tree(), but the visitor function is always called on a
396 * dentry's children before on itself. */
398 for_dentry_in_tree_depth(struct wim_dentry *root,
399 int (*visitor)(struct wim_dentry *, void *), void *arg)
403 return do_for_dentry_in_tree_depth(root, visitor, arg);
406 /* Calculate the full path of @dentry. */
408 calculate_dentry_full_path(struct wim_dentry *dentry)
412 const struct wim_dentry *d;
414 if (dentry->_full_path)
420 ulen += d->file_name_nbytes / sizeof(utf16lechar);
422 d = d->parent; /* assumes d == d->parent for root */
423 } while (!dentry_is_root(d));
425 utf16lechar ubuf[ulen];
426 utf16lechar *p = &ubuf[ulen];
430 p -= d->file_name_nbytes / sizeof(utf16lechar);
431 memcpy(p, d->file_name, d->file_name_nbytes);
432 *--p = cpu_to_le16(WIM_PATH_SEPARATOR);
433 d = d->parent; /* assumes d == d->parent for root */
434 } while (!dentry_is_root(d));
436 wimlib_assert(p == ubuf);
438 return utf16le_to_tstr(ubuf, ulen * sizeof(utf16lechar),
439 &dentry->_full_path, &dummy);
443 dentry_full_path(struct wim_dentry *dentry)
445 calculate_dentry_full_path(dentry);
446 return dentry->_full_path;
450 dentry_calculate_subdir_offset(struct wim_dentry *dentry, void *_subdir_offset_p)
453 if (dentry_is_directory(dentry)) {
454 u64 *subdir_offset_p = _subdir_offset_p;
455 struct wim_dentry *child;
457 /* Set offset of directory's child dentries */
458 dentry->subdir_offset = *subdir_offset_p;
460 /* Account for child dentries */
461 for_dentry_child(child, dentry)
462 *subdir_offset_p += dentry_out_total_length(child);
464 /* Account for end-of-directory entry */
465 *subdir_offset_p += 8;
467 /* Not a directory; set subdir_offset to 0 */
468 dentry->subdir_offset = 0;
474 * Calculates the subdir offsets for a directory tree.
477 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p)
479 for_dentry_in_tree(root, dentry_calculate_subdir_offset, subdir_offset_p);
482 /* Compare the UTF-16LE long filenames of two dentries case insensitively. */
484 dentry_compare_names_case_insensitive(const struct wim_dentry *d1,
485 const struct wim_dentry *d2)
487 return cmp_utf16le_strings(d1->file_name,
488 d1->file_name_nbytes / 2,
490 d2->file_name_nbytes / 2,
494 /* Compare the UTF-16LE long filenames of two dentries case sensitively. */
496 dentry_compare_names_case_sensitive(const struct wim_dentry *d1,
497 const struct wim_dentry *d2)
499 return cmp_utf16le_strings(d1->file_name,
500 d1->file_name_nbytes / 2,
502 d2->file_name_nbytes / 2,
507 _avl_dentry_compare_names_ci(const struct avl_tree_node *n1,
508 const struct avl_tree_node *n2)
510 const struct wim_dentry *d1, *d2;
512 d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node_ci);
513 d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node_ci);
514 return dentry_compare_names_case_insensitive(d1, d2);
518 _avl_dentry_compare_names(const struct avl_tree_node *n1,
519 const struct avl_tree_node *n2)
521 const struct wim_dentry *d1, *d2;
523 d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node);
524 d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node);
525 return dentry_compare_names_case_sensitive(d1, d2);
528 /* Default case sensitivity behavior for searches with
529 * WIMLIB_CASE_PLATFORM_DEFAULT specified. This can be modified by
530 * wimlib_global_init(). */
531 bool default_ignore_case =
539 /* Case-sensitive dentry lookup. Only @file_name and @file_name_nbytes of
540 * @dummy must be valid. */
541 static struct wim_dentry *
542 dir_lookup(const struct wim_inode *dir, const struct wim_dentry *dummy)
544 struct avl_tree_node *node;
546 node = avl_tree_lookup_node(dir->i_children,
547 &dummy->d_index_node,
548 _avl_dentry_compare_names);
551 return avl_tree_entry(node, struct wim_dentry, d_index_node);
554 /* Case-insensitive dentry lookup. Only @file_name and @file_name_nbytes of
555 * @dummy must be valid. */
556 static struct wim_dentry *
557 dir_lookup_ci(const struct wim_inode *dir, const struct wim_dentry *dummy)
559 struct avl_tree_node *node;
561 node = avl_tree_lookup_node(dir->i_children_ci,
562 &dummy->d_index_node_ci,
563 _avl_dentry_compare_names_ci);
566 return avl_tree_entry(node, struct wim_dentry, d_index_node_ci);
569 /* Given a UTF-16LE filename and a directory, look up the dentry for the file.
570 * Return it if found, otherwise NULL. This has configurable case sensitivity,
571 * and @name need not be null-terminated. */
573 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
574 const utf16lechar *name,
576 CASE_SENSITIVITY_TYPE case_ctype)
578 const struct wim_inode *dir = dentry->d_inode;
579 bool ignore_case = will_ignore_case(case_ctype);
580 struct wim_dentry dummy;
581 struct wim_dentry *child;
583 dummy.file_name = (utf16lechar*)name;
584 dummy.file_name_nbytes = name_nbytes;
587 /* Case-sensitive lookup. */
588 return dir_lookup(dir, &dummy);
590 /* Case-insensitive lookup. */
592 child = dir_lookup_ci(dir, &dummy);
596 if (likely(list_empty(&child->d_ci_conflict_list)))
597 /* Only one dentry has this case-insensitive name; return it */
600 /* Multiple dentries have the same case-insensitive name. Choose the
601 * dentry with the same case-sensitive name, if one exists; otherwise
602 * print a warning and choose one of the possible dentries arbitrarily.
604 struct wim_dentry *alt = child;
609 if (!dentry_compare_names_case_sensitive(&dummy, alt))
611 alt = list_entry(alt->d_ci_conflict_list.next,
612 struct wim_dentry, d_ci_conflict_list);
613 } while (alt != child);
615 WARNING("Result of case-insensitive lookup is ambiguous\n"
616 " (returning \"%"TS"\" of %zu "
617 "possible files, including \"%"TS"\")",
618 dentry_full_path(child),
620 dentry_full_path(list_entry(child->d_ci_conflict_list.next,
622 d_ci_conflict_list)));
626 /* Returns the child of @dentry that has the file name @name. Returns NULL if
627 * no child has the name. */
629 get_dentry_child_with_name(const struct wim_dentry *dentry, const tchar *name,
630 CASE_SENSITIVITY_TYPE case_type)
633 const utf16lechar *name_utf16le;
634 size_t name_utf16le_nbytes;
635 struct wim_dentry *child;
637 ret = tstr_get_utf16le_and_len(name, &name_utf16le,
638 &name_utf16le_nbytes);
642 child = get_dentry_child_with_utf16le_name(dentry,
646 tstr_put_utf16le(name_utf16le);
650 static struct wim_dentry *
651 get_dentry_utf16le(WIMStruct *wim, const utf16lechar *path,
652 CASE_SENSITIVITY_TYPE case_type)
654 struct wim_dentry *cur_dentry;
655 const utf16lechar *name_start, *name_end;
657 /* Start with the root directory of the image. Note: this will be NULL
658 * if an image has been added directly with wimlib_add_empty_image() but
659 * no files have been added yet; in that case we fail with ENOENT. */
660 cur_dentry = wim_get_current_root_dentry(wim);
664 if (cur_dentry == NULL) {
669 if (*name_start && !dentry_is_directory(cur_dentry)) {
674 while (*name_start == cpu_to_le16(WIM_PATH_SEPARATOR))
680 name_end = name_start;
683 } while (*name_end != cpu_to_le16(WIM_PATH_SEPARATOR) && *name_end);
685 cur_dentry = get_dentry_child_with_utf16le_name(cur_dentry,
687 (u8*)name_end - (u8*)name_start,
689 name_start = name_end;
694 * WIM path lookup: translate a path in the currently selected WIM image to the
695 * corresponding dentry, if it exists.
698 * The WIMStruct for the WIM. The search takes place in the currently
702 * The path to look up, given relative to the root of the WIM image.
703 * Characters with value WIM_PATH_SEPARATOR are taken to be path
704 * separators. Leading path separators are ignored, whereas one or more
705 * trailing path separators cause the path to only match a directory.
708 * The case-sensitivity behavior of this function, as one of the following
711 * - WIMLIB_CASE_SENSITIVE: Perform the search case sensitively. This means
712 * that names must match exactly.
714 * - WIMLIB_CASE_INSENSITIVE: Perform the search case insensitively. This
715 * means that names are considered to match if they are equal when
716 * transformed to upper case. If a path component matches multiple names
717 * case-insensitively, the name that matches the path component
718 * case-sensitively is chosen, if existent; otherwise one
719 * case-insensitively matching name is chosen arbitrarily.
721 * - WIMLIB_CASE_PLATFORM_DEFAULT: Perform either case-sensitive or
722 * case-insensitive search, depending on the value of the global variable
723 * default_ignore_case.
725 * In any case, no Unicode normalization is done before comparing strings.
727 * Returns a pointer to the dentry that is the result of the lookup, or NULL if
728 * no such dentry exists. If NULL is returned, errno is set to one of the
731 * ENOTDIR if one of the path components used as a directory existed but
732 * was not, in fact, a directory.
738 * - This function does not consider a reparse point to be a directory, even
739 * if it has FILE_ATTRIBUTE_DIRECTORY set.
741 * - This function does not dereference symbolic links or junction points
742 * when performing the search.
744 * - Since this function ignores leading slashes, the empty path is valid and
745 * names the root directory of the WIM image.
747 * - An image added with wimlib_add_empty_image() does not have a root
748 * directory yet, and this function will fail with ENOENT for any path on
752 get_dentry(WIMStruct *wim, const tchar *path, CASE_SENSITIVITY_TYPE case_type)
755 const utf16lechar *path_utf16le;
756 struct wim_dentry *dentry;
758 ret = tstr_get_utf16le(path, &path_utf16le);
761 dentry = get_dentry_utf16le(wim, path_utf16le, case_type);
762 tstr_put_utf16le(path_utf16le);
766 /* Takes in a path of length @len in @buf, and transforms it into a string for
767 * the path of its parent directory. */
769 to_parent_name(tchar *buf, size_t len)
771 ssize_t i = (ssize_t)len - 1;
772 while (i >= 0 && buf[i] == WIM_PATH_SEPARATOR)
774 while (i >= 0 && buf[i] != WIM_PATH_SEPARATOR)
776 while (i >= 0 && buf[i] == WIM_PATH_SEPARATOR)
778 buf[i + 1] = T('\0');
781 /* Similar to get_dentry(), but returns the dentry named by @path with the last
782 * component stripped off.
784 * Note: The returned dentry is NOT guaranteed to be a directory. */
786 get_parent_dentry(WIMStruct *wim, const tchar *path,
787 CASE_SENSITIVITY_TYPE case_type)
789 size_t path_len = tstrlen(path);
790 tchar buf[path_len + 1];
792 tmemcpy(buf, path, path_len + 1);
793 to_parent_name(buf, path_len);
794 return get_dentry(wim, buf, case_type);
798 /* Finds the dentry, lookup table entry, and stream index for a WIM file stream,
801 * Currently, lookups of this type are only needed if FUSE is enabled. */
803 wim_pathname_to_stream(WIMStruct *wim,
806 struct wim_dentry **dentry_ret,
807 struct wim_lookup_table_entry **lte_ret,
810 struct wim_dentry *dentry;
811 struct wim_lookup_table_entry *lte;
813 const tchar *stream_name = NULL;
814 struct wim_inode *inode;
817 if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
818 stream_name = path_stream_name(path);
820 p = (tchar*)stream_name - 1;
825 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
831 inode = dentry->d_inode;
833 if (!inode->i_resolved)
834 if (inode_resolve_streams(inode, wim->lookup_table, false))
837 if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
838 && inode_is_directory(inode))
842 struct wim_ads_entry *ads_entry;
844 ads_entry = inode_get_ads_entry(inode, stream_name);
848 stream_idx = ads_entry - inode->i_ads_entries + 1;
849 lte = ads_entry->lte;
851 lte = inode_unnamed_stream_resolved(inode, &stream_idx);
854 *dentry_ret = dentry;
858 *stream_idx_ret = stream_idx;
861 #endif /* WITH_FUSE */
863 /* Creates an unlinked directory entry. */
865 new_dentry(const tchar *name, struct wim_dentry **dentry_ret)
867 struct wim_dentry *dentry;
870 dentry = CALLOC(1, sizeof(struct wim_dentry));
872 return WIMLIB_ERR_NOMEM;
875 ret = dentry_set_name(dentry, name);
878 ERROR("Failed to set name on new dentry with name \"%"TS"\"",
883 dentry->parent = dentry;
884 *dentry_ret = dentry;
889 _new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret,
892 struct wim_dentry *dentry;
895 ret = new_dentry(name, &dentry);
900 dentry->d_inode = new_timeless_inode();
902 dentry->d_inode = new_inode();
903 if (dentry->d_inode == NULL) {
905 return WIMLIB_ERR_NOMEM;
908 inode_add_dentry(dentry, dentry->d_inode);
909 *dentry_ret = dentry;
914 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret)
916 return _new_dentry_with_inode(name, dentry_ret, true);
920 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret)
922 return _new_dentry_with_inode(name, dentry_ret, false);
926 new_filler_directory(struct wim_dentry **dentry_ret)
929 struct wim_dentry *dentry;
931 ret = new_dentry_with_inode(T(""), &dentry);
934 /* Leave the inode number as 0; this is allowed for non
935 * hard-linked files. */
936 dentry->d_inode->i_resolved = 1;
937 dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
938 *dentry_ret = dentry;
943 dentry_clear_inode_visited(struct wim_dentry *dentry, void *_ignore)
945 dentry->d_inode->i_visited = 0;
950 dentry_tree_clear_inode_visited(struct wim_dentry *root)
952 for_dentry_in_tree(root, dentry_clear_inode_visited, NULL);
958 * In addition to freeing the dentry itself, this decrements the link count of
959 * the corresponding inode (if any). If the inode's link count reaches 0, the
960 * inode is freed as well.
963 free_dentry(struct wim_dentry *dentry)
966 FREE(dentry->file_name);
967 FREE(dentry->short_name);
968 FREE(dentry->_full_path);
970 put_inode(dentry->d_inode);
976 do_free_dentry(struct wim_dentry *dentry, void *_ignore)
983 do_free_dentry_and_unref_streams(struct wim_dentry *dentry, void *lookup_table)
985 inode_unref_streams(dentry->d_inode, lookup_table);
991 * Recursively frees all directory entries in the specified tree.
994 * The root of the tree.
997 * The lookup table for dentries. If non-NULL, the reference counts in the
998 * lookup table for the lookup table entries corresponding to the dentries
999 * will be decremented.
1001 * This also puts references to the corresponding inodes.
1003 * This does *not* unlink @root from its parent directory (if it has one).
1006 free_dentry_tree(struct wim_dentry *root, struct wim_lookup_table *lookup_table)
1008 int (*f)(struct wim_dentry *, void *);
1011 f = do_free_dentry_and_unref_streams;
1015 for_dentry_in_tree_depth(root, f, lookup_table);
1018 /* Insert the @child dentry into the case sensitive index of the @dir directory.
1019 * Return NULL if successfully inserted, otherwise a pointer to the
1020 * already-inserted duplicate. */
1021 static struct wim_dentry *
1022 dir_index_child(struct wim_inode *dir, struct wim_dentry *child)
1024 struct avl_tree_node *duplicate;
1026 duplicate = avl_tree_insert(&dir->i_children,
1027 &child->d_index_node,
1028 _avl_dentry_compare_names);
1031 return avl_tree_entry(duplicate, struct wim_dentry, d_index_node);
1034 /* Insert the @child dentry into the case insensitive index of the @dir
1035 * directory. Return NULL if successfully inserted, otherwise a pointer to the
1036 * already-inserted duplicate. */
1037 static struct wim_dentry *
1038 dir_index_child_ci(struct wim_inode *dir, struct wim_dentry *child)
1040 struct avl_tree_node *duplicate;
1042 duplicate = avl_tree_insert(&dir->i_children_ci,
1043 &child->d_index_node_ci,
1044 _avl_dentry_compare_names_ci);
1047 return avl_tree_entry(duplicate, struct wim_dentry, d_index_node_ci);
1050 /* Removes the specified dentry from its directory's case-sensitive index. */
1052 dir_unindex_child(struct wim_inode *dir, struct wim_dentry *child)
1054 avl_tree_remove(&dir->i_children, &child->d_index_node);
1057 /* Removes the specified dentry from its directory's case-insensitive index. */
1059 dir_unindex_child_ci(struct wim_inode *dir, struct wim_dentry *child)
1061 avl_tree_remove(&dir->i_children_ci, &child->d_index_node_ci);
1064 /* Returns true iff the specified dentry is in its parent directory's
1065 * case-insensitive index. */
1067 dentry_in_ci_index(const struct wim_dentry *dentry)
1069 return !avl_tree_node_is_unlinked(&dentry->d_index_node_ci);
1073 * Links a dentry into the directory tree.
1075 * @parent: The dentry that will be the parent of @child.
1076 * @child: The dentry to link.
1078 * Returns NULL if successful. If @parent already contains a dentry with the
1079 * same case-sensitive name as @child, returns a pointer to this duplicate
1083 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child)
1085 struct wim_dentry *duplicate;
1086 struct wim_inode *dir;
1088 wimlib_assert(parent != child);
1090 dir = parent->d_inode;
1092 wimlib_assert(inode_is_directory(dir));
1094 duplicate = dir_index_child(dir, child);
1098 duplicate = dir_index_child_ci(dir, child);
1100 list_add(&child->d_ci_conflict_list, &duplicate->d_ci_conflict_list);
1101 avl_tree_node_set_unlinked(&child->d_index_node_ci);
1103 INIT_LIST_HEAD(&child->d_ci_conflict_list);
1105 child->parent = parent;
1109 /* Unlink a WIM dentry from the directory entry tree. */
1111 unlink_dentry(struct wim_dentry *dentry)
1113 struct wim_inode *dir;
1115 if (dentry_is_root(dentry))
1118 dir = dentry->parent->d_inode;
1120 dir_unindex_child(dir, dentry);
1122 if (dentry_in_ci_index(dentry)) {
1124 dir_unindex_child_ci(dir, dentry);
1126 if (!list_empty(&dentry->d_ci_conflict_list)) {
1127 /* Make a different case-insensitively-the-same dentry
1128 * be the "representative" in the search index. */
1129 struct list_head *next;
1130 struct wim_dentry *other;
1131 struct wim_dentry *existing;
1133 next = dentry->d_ci_conflict_list.next;
1134 other = list_entry(next, struct wim_dentry, d_ci_conflict_list);
1135 existing = dir_index_child_ci(dir, other);
1136 wimlib_assert(existing == NULL);
1139 list_del(&dentry->d_ci_conflict_list);
1143 read_extra_data(const u8 *p, const u8 *end, struct wim_inode *inode)
1145 while (((uintptr_t)p & 7) && p < end)
1148 if (unlikely(p < end)) {
1149 inode->i_extra = memdup(p, end - p);
1150 if (!inode->i_extra)
1151 return WIMLIB_ERR_NOMEM;
1152 inode->i_extra_size = end - p;
1157 /* Reads a WIM directory entry, including all alternate data stream entries that
1158 * follow it, from the WIM image's metadata resource. */
1160 read_dentry(const u8 * restrict buf, size_t buf_len,
1161 u64 offset, struct wim_dentry **dentry_ret)
1165 const struct wim_dentry_on_disk *disk_dentry;
1166 struct wim_dentry *dentry;
1167 struct wim_inode *inode;
1168 u16 short_name_nbytes;
1169 u16 file_name_nbytes;
1170 u64 calculated_size;
1173 BUILD_BUG_ON(sizeof(struct wim_dentry_on_disk) != WIM_DENTRY_DISK_SIZE);
1175 /* Before reading the whole dentry, we need to read just the length.
1176 * This is because a dentry of length 8 (that is, just the length field)
1177 * terminates the list of sibling directory entries. */
1179 /* Check for buffer overrun. */
1180 if (unlikely(offset + sizeof(u64) > buf_len ||
1181 offset + sizeof(u64) < offset))
1183 ERROR("Directory entry starting at %"PRIu64" ends past the "
1184 "end of the metadata resource (size %zu)",
1186 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1189 /* Get pointer to the dentry data. */
1191 disk_dentry = (const struct wim_dentry_on_disk*)p;
1193 /* Get dentry length. */
1194 length = le64_to_cpu(disk_dentry->length);
1196 /* Check for end-of-directory. */
1202 /* Validate dentry length. */
1203 if (unlikely(length < sizeof(struct wim_dentry_on_disk))) {
1204 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
1206 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1209 /* Check for buffer overrun. */
1210 if (unlikely(offset + length > buf_len ||
1211 offset + length < offset))
1213 ERROR("Directory entry at offset %"PRIu64" and with size "
1214 "%"PRIu64" ends past the end of the metadata resource "
1215 "(size %zu)", offset, length, buf_len);
1216 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1219 /* Allocate new dentry structure, along with a preliminary inode. */
1220 ret = new_dentry_with_timeless_inode(T(""), &dentry);
1224 dentry->length = length;
1225 inode = dentry->d_inode;
1227 /* Read more fields: some into the dentry, and some into the inode. */
1228 inode->i_attributes = le32_to_cpu(disk_dentry->attributes);
1229 inode->i_security_id = le32_to_cpu(disk_dentry->security_id);
1230 dentry->subdir_offset = le64_to_cpu(disk_dentry->subdir_offset);
1231 inode->i_creation_time = le64_to_cpu(disk_dentry->creation_time);
1232 inode->i_last_access_time = le64_to_cpu(disk_dentry->last_access_time);
1233 inode->i_last_write_time = le64_to_cpu(disk_dentry->last_write_time);
1234 copy_hash(inode->i_hash, disk_dentry->unnamed_stream_hash);
1236 /* I don't know what's going on here. It seems like M$ screwed up the
1237 * reparse points, then put the fields in the same place and didn't
1238 * document it. So we have some fields we read for reparse points, and
1239 * some fields in the same place for non-reparse-points. */
1240 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1241 inode->i_rp_unknown_1 = le32_to_cpu(disk_dentry->reparse.rp_unknown_1);
1242 inode->i_reparse_tag = le32_to_cpu(disk_dentry->reparse.reparse_tag);
1243 inode->i_rp_unknown_2 = le16_to_cpu(disk_dentry->reparse.rp_unknown_2);
1244 inode->i_not_rpfixed = le16_to_cpu(disk_dentry->reparse.not_rpfixed);
1245 /* Leave inode->i_ino at 0. Note that this means the WIM file
1246 * cannot archive hard-linked reparse points. Such a thing
1247 * doesn't really make sense anyway, although I believe it's
1248 * theoretically possible to have them on NTFS. */
1250 inode->i_rp_unknown_1 = le32_to_cpu(disk_dentry->nonreparse.rp_unknown_1);
1251 inode->i_ino = le64_to_cpu(disk_dentry->nonreparse.hard_link_group_id);
1253 inode->i_num_ads = le16_to_cpu(disk_dentry->num_alternate_data_streams);
1255 /* Now onto reading the names. There are two of them: the (long) file
1256 * name, and the short name. */
1258 short_name_nbytes = le16_to_cpu(disk_dentry->short_name_nbytes);
1259 file_name_nbytes = le16_to_cpu(disk_dentry->file_name_nbytes);
1261 if (unlikely((short_name_nbytes & 1) | (file_name_nbytes & 1))) {
1262 ERROR("Dentry name is not valid UTF-16 (odd number of bytes)!");
1263 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1264 goto err_free_dentry;
1267 /* We now know the length of the file name and short name. Make sure
1268 * the length of the dentry is large enough to actually hold them.
1270 * The calculated length here is unaligned to allow for the possibility
1271 * that the dentry->length names an unaligned length, although this
1272 * would be unexpected. */
1273 calculated_size = dentry_correct_length_unaligned(file_name_nbytes,
1276 if (unlikely(dentry->length < calculated_size)) {
1277 ERROR("Unexpected end of directory entry! (Expected "
1278 "at least %"PRIu64" bytes, got %"PRIu64" bytes.)",
1279 calculated_size, dentry->length);
1280 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1281 goto err_free_dentry;
1284 /* Advance p to point past the base dentry, to the first name. */
1285 p += sizeof(struct wim_dentry_on_disk);
1287 /* Read the filename if present. Note: if the filename is empty, there
1288 * is no null terminator following it. */
1289 if (file_name_nbytes) {
1290 dentry->file_name = utf16le_dupz((const utf16lechar *)p,
1292 if (dentry->file_name == NULL) {
1293 ret = WIMLIB_ERR_NOMEM;
1294 goto err_free_dentry;
1296 dentry->file_name_nbytes = file_name_nbytes;
1297 p += file_name_nbytes + 2;
1300 /* Read the short filename if present. Note: if there is no short
1301 * filename, there is no null terminator following it. */
1302 if (short_name_nbytes) {
1303 dentry->short_name = utf16le_dupz((const utf16lechar *)p,
1305 if (dentry->short_name == NULL) {
1306 ret = WIMLIB_ERR_NOMEM;
1307 goto err_free_dentry;
1309 dentry->short_name_nbytes = short_name_nbytes;
1310 p += short_name_nbytes + 2;
1313 /* Read extra data at end of dentry (but before alternate data stream
1314 * entries). This may contain tagged items. */
1315 ret = read_extra_data(p, &buf[offset + dentry->length], inode);
1317 goto err_free_dentry;
1319 /* Align the dentry length. */
1320 dentry->length = (dentry->length + 7) & ~7;
1322 /* Read the alternate data streams, if present. inode->i_num_ads tells
1323 * us how many they are, and they will directly follow the dentry in the
1324 * metadata resource buffer.
1326 * Note that each alternate data stream entry begins on an 8-byte
1327 * aligned boundary, and the alternate data stream entries seem to NOT
1328 * be included in the dentry->length field for some reason. */
1329 if (unlikely(inode->i_num_ads != 0)) {
1330 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1331 if (offset + dentry->length > buf_len ||
1332 (ret = read_ads_entries(&buf[offset + dentry->length],
1334 buf_len - offset - dentry->length)))
1336 goto err_free_dentry;
1340 *dentry_ret = dentry;
1344 free_dentry(dentry);
1349 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
1351 if (dentry->file_name_nbytes <= 4) {
1352 if (dentry->file_name_nbytes == 4) {
1353 if (dentry->file_name[0] == cpu_to_le16('.') &&
1354 dentry->file_name[1] == cpu_to_le16('.'))
1356 } else if (dentry->file_name_nbytes == 2) {
1357 if (dentry->file_name[0] == cpu_to_le16('.'))
1365 read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len,
1366 struct wim_dentry * restrict dir)
1368 u64 cur_offset = dir->subdir_offset;
1370 /* Check for cyclic directory structure, which would cause infinite
1371 * recursion if not handled. */
1372 for (struct wim_dentry *d = dir->parent;
1373 !dentry_is_root(d); d = d->parent)
1375 if (unlikely(d->subdir_offset == cur_offset)) {
1376 ERROR("Cyclic directory structure detected: children "
1377 "of \"%"TS"\" coincide with children of \"%"TS"\"",
1378 dentry_full_path(dir), dentry_full_path(d));
1379 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1384 struct wim_dentry *child;
1385 struct wim_dentry *duplicate;
1388 /* Read next child of @dir. */
1389 ret = read_dentry(buf, buf_len, cur_offset, &child);
1393 /* Check for end of directory. */
1397 /* Advance to the offset of the next child. Note: We need to
1398 * advance by the TOTAL length of the dentry, not by the length
1399 * child->length, which although it does take into account the
1400 * padding, it DOES NOT take into account alternate stream
1402 cur_offset += dentry_in_total_length(child);
1404 /* All dentries except the root should be named. */
1405 if (unlikely(!dentry_has_long_name(child))) {
1406 WARNING("Ignoring unnamed dentry in "
1407 "directory \"%"TS"\"", dentry_full_path(dir));
1412 /* Don't allow files named "." or "..". */
1413 if (unlikely(dentry_is_dot_or_dotdot(child))) {
1414 WARNING("Ignoring file named \".\" or \"..\"; "
1415 "potentially malicious archive!!!");
1420 /* Link the child into the directory. */
1421 duplicate = dentry_add_child(dir, child);
1422 if (unlikely(duplicate)) {
1423 /* We already found a dentry with this same
1424 * case-sensitive long name. Only keep the first one.
1426 WARNING("Ignoring duplicate file \"%"TS"\" "
1427 "(the WIM image already contains a file "
1428 "at that path with the exact same name)",
1429 dentry_full_path(duplicate));
1434 /* If this child is a directory that itself has children, call
1435 * this procedure recursively. */
1436 if (child->subdir_offset != 0) {
1437 if (likely(dentry_is_directory(child))) {
1438 ret = read_dentry_tree_recursive(buf,
1444 WARNING("Ignoring children of "
1445 "non-directory file \"%"TS"\"",
1446 dentry_full_path(child));
1453 * Read a tree of dentries (directory entries) from a WIM metadata resource.
1456 * Buffer containing an uncompressed WIM metadata resource.
1459 * Length of the uncompressed metadata resource, in bytes.
1462 * Offset in the metadata resource of the root of the dentry tree.
1465 * On success, either NULL or a pointer to the root dentry is written to
1466 * this location. The former case only occurs in the unexpected case that
1467 * the tree began with an end-of-directory entry.
1470 * WIMLIB_ERR_SUCCESS (0)
1471 * WIMLIB_ERR_INVALID_METADATA_RESOURCE
1475 read_dentry_tree(const u8 *buf, size_t buf_len,
1476 u64 root_offset, struct wim_dentry **root_ret)
1479 struct wim_dentry *root;
1481 DEBUG("Reading dentry tree (root_offset=%"PRIu64")", root_offset);
1483 ret = read_dentry(buf, buf_len, root_offset, &root);
1487 if (likely(root != NULL)) {
1488 if (unlikely(dentry_has_long_name(root) ||
1489 dentry_has_short_name(root)))
1491 WARNING("The root directory has a nonempty name; "
1493 FREE(root->file_name);
1494 FREE(root->short_name);
1495 root->file_name = NULL;
1496 root->short_name = NULL;
1497 root->file_name_nbytes = 0;
1498 root->short_name_nbytes = 0;
1501 if (unlikely(!dentry_is_directory(root))) {
1502 ERROR("The root of the WIM image is not a directory!");
1503 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1504 goto err_free_dentry_tree;
1507 if (likely(root->subdir_offset != 0)) {
1508 ret = read_dentry_tree_recursive(buf, buf_len, root);
1510 goto err_free_dentry_tree;
1513 WARNING("The metadata resource has no directory entries; "
1514 "treating as an empty image.");
1519 err_free_dentry_tree:
1520 free_dentry_tree(root, NULL);
1525 * Writes a WIM alternate data stream (ADS) entry to an output buffer.
1527 * @ads_entry: The ADS entry structure.
1528 * @hash: The hash field to use (instead of the one in the ADS entry).
1529 * @p: The memory location to write the data to.
1531 * Returns a pointer to the byte after the last byte written.
1534 write_ads_entry(const struct wim_ads_entry *ads_entry,
1535 const u8 *hash, u8 * restrict p)
1537 struct wim_ads_entry_on_disk *disk_ads_entry =
1538 (struct wim_ads_entry_on_disk*)p;
1541 disk_ads_entry->reserved = cpu_to_le64(ads_entry->reserved);
1542 copy_hash(disk_ads_entry->hash, hash);
1543 disk_ads_entry->stream_name_nbytes = cpu_to_le16(ads_entry->stream_name_nbytes);
1544 p += sizeof(struct wim_ads_entry_on_disk);
1545 if (ads_entry->stream_name_nbytes) {
1546 p = mempcpy(p, ads_entry->stream_name,
1547 ads_entry->stream_name_nbytes + 2);
1549 /* Align to 8-byte boundary */
1550 while ((uintptr_t)p & 7)
1552 disk_ads_entry->length = cpu_to_le64(p - orig_p);
1557 * Writes a WIM dentry to an output buffer.
1559 * @dentry: The dentry structure.
1560 * @p: The memory location to write the data to.
1562 * Returns the pointer to the byte after the last byte we wrote as part of the
1563 * dentry, including any alternate data stream entries.
1566 write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p)
1568 const struct wim_inode *inode;
1569 struct wim_dentry_on_disk *disk_dentry;
1572 bool use_dummy_stream;
1575 wimlib_assert(((uintptr_t)p & 7) == 0); /* 8 byte aligned */
1578 inode = dentry->d_inode;
1579 use_dummy_stream = inode_needs_dummy_stream(inode);
1580 disk_dentry = (struct wim_dentry_on_disk*)p;
1582 disk_dentry->attributes = cpu_to_le32(inode->i_attributes);
1583 disk_dentry->security_id = cpu_to_le32(inode->i_security_id);
1584 disk_dentry->subdir_offset = cpu_to_le64(dentry->subdir_offset);
1586 /* UNIX data uses the two 8-byte reserved fields. So if no UNIX data
1587 * exists, they get set to 0, just as we would do anyway. */
1588 disk_dentry->unused_1 = cpu_to_le64(0);
1589 disk_dentry->unused_2 = cpu_to_le64(0);
1591 disk_dentry->creation_time = cpu_to_le64(inode->i_creation_time);
1592 disk_dentry->last_access_time = cpu_to_le64(inode->i_last_access_time);
1593 disk_dentry->last_write_time = cpu_to_le64(inode->i_last_write_time);
1594 if (use_dummy_stream)
1597 hash = inode_stream_hash(inode, 0);
1598 copy_hash(disk_dentry->unnamed_stream_hash, hash);
1599 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1600 disk_dentry->reparse.rp_unknown_1 = cpu_to_le32(inode->i_rp_unknown_1);
1601 disk_dentry->reparse.reparse_tag = cpu_to_le32(inode->i_reparse_tag);
1602 disk_dentry->reparse.rp_unknown_2 = cpu_to_le16(inode->i_rp_unknown_2);
1603 disk_dentry->reparse.not_rpfixed = cpu_to_le16(inode->i_not_rpfixed);
1605 disk_dentry->nonreparse.rp_unknown_1 = cpu_to_le32(inode->i_rp_unknown_1);
1606 disk_dentry->nonreparse.hard_link_group_id =
1607 cpu_to_le64((inode->i_nlink == 1) ? 0 : inode->i_ino);
1609 num_ads = inode->i_num_ads;
1610 if (use_dummy_stream)
1612 disk_dentry->num_alternate_data_streams = cpu_to_le16(num_ads);
1613 disk_dentry->short_name_nbytes = cpu_to_le16(dentry->short_name_nbytes);
1614 disk_dentry->file_name_nbytes = cpu_to_le16(dentry->file_name_nbytes);
1615 p += sizeof(struct wim_dentry_on_disk);
1617 wimlib_assert(dentry_is_root(dentry) != dentry_has_long_name(dentry));
1619 if (dentry_has_long_name(dentry))
1620 p = mempcpy(p, dentry->file_name, dentry->file_name_nbytes + 2);
1622 if (dentry_has_short_name(dentry))
1623 p = mempcpy(p, dentry->short_name, dentry->short_name_nbytes + 2);
1625 /* Align to 8-byte boundary */
1626 while ((uintptr_t)p & 7)
1629 if (inode->i_extra_size) {
1630 /* Extra tagged items --- not usually present. */
1631 p = mempcpy(p, inode->i_extra, inode->i_extra_size);
1632 while ((uintptr_t)p & 7)
1636 disk_dentry->length = cpu_to_le64(p - orig_p);
1638 if (use_dummy_stream) {
1639 hash = inode_unnamed_stream_hash(inode);
1640 p = write_ads_entry(&(struct wim_ads_entry){}, hash, p);
1643 /* Write the alternate data streams entries, if any. */
1644 for (u16 i = 0; i < inode->i_num_ads; i++) {
1645 hash = inode_stream_hash(inode, i + 1);
1646 p = write_ads_entry(&inode->i_ads_entries[i], hash, p);
1653 write_dir_dentries(struct wim_dentry *dir, void *_pp)
1655 if (dir->subdir_offset != 0) {
1658 struct wim_dentry *child;
1660 /* write child dentries */
1661 for_dentry_child(child, dir)
1662 p = write_dentry(child, p);
1664 /* write end of directory entry */
1672 /* Writes a directory tree to the metadata resource.
1674 * @root: Root of the dentry tree.
1675 * @p: Pointer to a buffer with enough space for the dentry tree.
1677 * Returns pointer to the byte after the last byte we wrote.
1680 write_dentry_tree(struct wim_dentry *root, u8 *p)
1682 DEBUG("Writing dentry tree.");
1683 wimlib_assert(dentry_is_root(root));
1685 /* write root dentry and end-of-directory entry following it */
1686 p = write_dentry(root, p);
1690 /* write the rest of the dentry tree */
1691 for_dentry_in_tree(root, write_dir_dentries, &p);