2 * dentry.c - see description below
6 * Copyright (C) 2012, 2013, 2014 Eric Biggers
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
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
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/.
23 * This file contains logic to deal with WIM directory entries, or "dentries":
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
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.
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!
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.
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).
49 * - wimlib indexes dentries both case-insensitively and case-sensitively,
50 * allowing either behavior to be used for path lookup.
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.
61 #include "wimlib/assert.h"
62 #include "wimlib/dentry.h"
63 #include "wimlib/inode.h"
64 #include "wimlib/encoding.h"
65 #include "wimlib/endianness.h"
66 #include "wimlib/metadata.h"
70 /* On-disk format of a WIM dentry (directory entry), located in the metadata
71 * resource for a WIM image. */
72 struct wim_dentry_on_disk {
74 /* Length of this directory entry in bytes, not including any alternate
75 * data stream entries. Should be a multiple of 8 so that the following
76 * dentry or alternate data stream entry is aligned on an 8-byte
77 * boundary. (If not, wimlib will round it up.) It must be at least as
78 * long as the fixed-length fields of the dentry (WIM_DENTRY_DISK_SIZE),
79 * plus the lengths of the file name and/or short name if present.
81 * It is also possible for this field to be 0. This situation, which is
82 * undocumented, indicates the end of a list of sibling nodes in a
83 * directory. It also means the real length is 8, because the dentry
84 * included only the length field, but that takes up 8 bytes. */
87 /* Attributes of the file or directory. This is a bitwise OR of the
88 * FILE_ATTRIBUTE_* constants and should correspond to the value
89 * retrieved by GetFileAttributes() on Windows. */
92 /* A value that specifies the security descriptor for this file or
93 * directory. If -1, the file or directory has no security descriptor.
94 * Otherwise, it is a 0-based index into the WIM image's table of
95 * security descriptors (see: `struct wim_security_data') */
98 /* Offset, in bytes, from the start of the uncompressed metadata
99 * resource of this directory's child directory entries, or 0 if this
100 * directory entry does not correspond to a directory or otherwise does
101 * not have any children. */
104 /* Reserved fields */
108 /* Creation time, last access time, and last write time, in
109 * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601. They
110 * should correspond to the times gotten by calling GetFileTime() on
113 le64 last_access_time;
114 le64 last_write_time;
116 /* Vaguely, the SHA-1 message digest ("hash") of the file's contents.
117 * More specifically, this is for the "unnamed data stream" rather than
118 * any "alternate data streams". This hash value is used to look up the
119 * corresponding entry in the WIM's stream lookup table to actually find
120 * the file contents within the WIM.
122 * If the file has no unnamed data stream (e.g. is a directory), then
123 * this field will be all zeroes. If the unnamed data stream is empty
124 * (i.e. an "empty file"), then this field is also expected to be all
125 * zeroes. (It will be if wimlib created the WIM image, at least;
126 * otherwise it can't be ruled out that the SHA-1 message digest of 0
127 * bytes of data is given explicitly.)
129 * If the file has reparse data, then this field will instead specify
130 * the SHA-1 message digest of the reparse data. If it is somehow
131 * possible for a file to have both an unnamed data stream and reparse
132 * data, then this is not handled by wimlib.
134 * As a further special case, if this field is all zeroes but there is
135 * an alternate data stream entry with no name and a nonzero SHA-1
136 * message digest field, then that hash must be used instead of this
137 * one. In fact, when named data streams are present, some versions of
138 * Windows PE contain a bug where they only look in the alternate data
139 * stream entries for the unnamed data stream, not here.
141 u8 unnamed_stream_hash[SHA1_HASH_SIZE];
143 /* The format of the following data is not yet completely known and they
144 * do not correspond to Microsoft's documentation.
146 * If this directory entry is for a reparse point (has
147 * FILE_ATTRIBUTE_REPARSE_POINT set in the attributes field), then the
148 * version of the following fields containing the reparse tag is valid.
149 * Furthermore, the field notated as not_rpfixed, as far as I can tell,
150 * is supposed to be set to 1 if reparse point fixups (a.k.a. fixing the
151 * targets of absolute symbolic links) were *not* done, and otherwise 0.
153 * If this directory entry is not for a reparse point, then the version
154 * of the following fields containing the hard_link_group_id is valid.
155 * All MS says about this field is that "If this file is part of a hard
156 * link set, all the directory entries in the set will share the same
157 * value in this field.". However, more specifically I have observed
159 * - If the file is part of a hard link set of size 1, then the
160 * hard_link_group_id should be set to either 0, which is treated
161 * specially as indicating "not hardlinked", or any unique value.
162 * - The specific nonzero values used to identity hard link sets do
163 * not matter, as long as they are unique.
164 * - However, due to bugs in Microsoft's software, it is actually NOT
165 * guaranteed that directory entries that share the same hard link
166 * group ID are actually hard linked to each either. See
167 * inode_fixup.c for the code that handles this.
175 } _packed_attribute reparse;
178 le64 hard_link_group_id;
179 } _packed_attribute nonreparse;
182 /* Number of alternate data stream entries that directly follow this
184 le16 num_alternate_data_streams;
186 /* If nonzero, this is the length, in bytes, of this dentry's UTF-16LE
187 * encoded short name (8.3 DOS-compatible name), excluding the null
188 * terminator. If zero, then the long name of this dentry does not have
189 * a corresponding short name (but this does not exclude the possibility
190 * that another dentry for the same file has a short name). */
191 le16 short_name_nbytes;
193 /* If nonzero, this is the length, in bytes, of this dentry's UTF-16LE
194 * encoded "long" name, excluding the null terminator. If zero, then
195 * this file has no long name. The root dentry should not have a long
196 * name, but all other dentries in the image should have long names. */
197 le16 file_name_nbytes;
199 /* Beginning of optional, variable-length fields */
201 /* If file_name_nbytes != 0, the next field will be the UTF-16LE encoded
202 * long file name. This will be null-terminated, so the size of this
203 * field will really be file_name_nbytes + 2. */
204 /*utf16lechar file_name[];*/
206 /* If short_name_nbytes != 0, the next field will be the UTF-16LE
207 * encoded short name. This will be null-terminated, so the size of
208 * this field will really be short_name_nbytes + 2. */
209 /*utf16lechar short_name[];*/
211 /* If there is still space in the dentry (according to the 'length'
212 * field) after 8-byte alignment, then the remaining space will be a
213 * variable-length list of tagged metadata items. See tagged_items.c
214 * for more information. */
215 /* u8 tagged_items[] _aligned_attribute(8); */
218 /* If num_alternate_data_streams != 0, then there are that many
219 * alternate data stream entries following the dentry, on an 8-byte
220 * aligned boundary. They are not counted in the 'length' field of the
223 /* Calculate the minimum unaligned length, in bytes, of an on-disk WIM dentry
224 * that has names of the specified lengths. (Zero length means the
225 * corresponding name actually does not exist.) The returned value excludes
226 * tagged metadata items as well as any alternate data stream entries that may
227 * need to follow the dentry. */
229 dentry_min_len_with_names(u16 file_name_nbytes, u16 short_name_nbytes)
231 u64 length = sizeof(struct wim_dentry_on_disk);
232 if (file_name_nbytes)
233 length += (u32)file_name_nbytes + 2;
234 if (short_name_nbytes)
235 length += (u32)short_name_nbytes + 2;
240 do_dentry_set_name(struct wim_dentry *dentry, utf16lechar *file_name,
241 size_t file_name_nbytes)
243 FREE(dentry->file_name);
244 dentry->file_name = file_name;
245 dentry->file_name_nbytes = file_name_nbytes;
247 if (dentry_has_short_name(dentry)) {
248 FREE(dentry->short_name);
249 dentry->short_name = NULL;
250 dentry->short_name_nbytes = 0;
255 * Set the name of a WIM dentry from a UTF-16LE string.
257 * This sets the long name of the dentry. The short name will automatically be
258 * removed, since it may not be appropriate for the new long name.
260 * The @name string need not be null-terminated, since its length is specified
263 * If @name_nbytes is 0, both the long and short names of the dentry will be
266 * Only use this function on unlinked dentries, since it doesn't update the name
267 * indices. For dentries that are currently linked into the tree, use
270 * Returns 0 or WIMLIB_ERR_NOMEM.
273 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *name,
276 utf16lechar *dup = NULL;
279 dup = utf16le_dupz(name, name_nbytes);
281 return WIMLIB_ERR_NOMEM;
283 do_dentry_set_name(dentry, dup, name_nbytes);
289 * Set the name of a WIM dentry from a 'tchar' string.
291 * This sets the long name of the dentry. The short name will automatically be
292 * removed, since it may not be appropriate for the new long name.
294 * If @name is NULL or empty, both the long and short names of the dentry will
297 * Only use this function on unlinked dentries, since it doesn't update the name
298 * indices. For dentries that are currently linked into the tree, use
301 * Returns 0 or an error code resulting from a failed string conversion.
304 dentry_set_name(struct wim_dentry *dentry, const tchar *name)
306 utf16lechar *name_utf16le = NULL;
307 size_t name_utf16le_nbytes = 0;
311 ret = tstr_to_utf16le(name, tstrlen(name) * sizeof(tchar),
312 &name_utf16le, &name_utf16le_nbytes);
317 do_dentry_set_name(dentry, name_utf16le, name_utf16le_nbytes);
321 /* Return the length, in bytes, required for the specified alternate data stream
322 * (ADS) entry on-disk. This accounts for the fixed-length portion of the ADS
323 * entry, the {stream name and its null terminator} if present, and the padding
324 * after the entry to align the next ADS entry or dentry on an 8-byte boundary
325 * in the uncompressed metadata resource buffer. */
327 ads_entry_out_total_length(const struct wim_ads_entry *entry)
329 u64 len = sizeof(struct wim_ads_entry_on_disk);
330 if (entry->stream_name_nbytes)
331 len += (u32)entry->stream_name_nbytes + 2;
332 return (len + 7) & ~7;
336 * Determine whether to include a "dummy" stream when writing a WIM dentry.
338 * Some versions of Microsoft's WIM software (the boot driver(s) in WinPE 3.0,
339 * for example) contain a bug where they assume the first alternate data stream
340 * (ADS) entry of a dentry with a nonzero ADS count specifies the unnamed
341 * stream, even if it has a name and the unnamed stream is already specified in
342 * the hash field of the dentry itself.
344 * wimlib has to work around this behavior by carefully emulating the behavior
345 * of (most versions of) ImageX/WIMGAPI, which move the unnamed stream reference
346 * into the alternate stream entries whenever there are named data streams, even
347 * though there is already a field in the dentry itself for the unnamed stream
348 * reference, which then goes to waste.
351 inode_needs_dummy_stream(const struct wim_inode *inode)
353 return (inode->i_num_ads > 0 &&
354 inode->i_num_ads < 0xffff && /* overflow check */
355 inode->i_canonical_streams); /* assume the dentry is okay if it
356 already had an unnamed ADS entry
357 when it was read in */
360 /* Calculate the total number of bytes that will be consumed when a dentry is
361 * written. This includes the fixed-length portion of the dentry, the name
362 * fields, any tagged metadata items, and any alternate data stream entries.
363 * Also includes all alignment bytes. */
365 dentry_out_total_length(const struct wim_dentry *dentry)
367 const struct wim_inode *inode = dentry->d_inode;
370 len = dentry_min_len_with_names(dentry->file_name_nbytes,
371 dentry->short_name_nbytes);
372 len = (len + 7) & ~7;
374 if (inode->i_extra_size) {
375 len += inode->i_extra_size;
376 len = (len + 7) & ~7;
379 if (unlikely(inode->i_num_ads)) {
380 if (inode_needs_dummy_stream(inode))
381 len += ads_entry_out_total_length(&(struct wim_ads_entry){});
383 for (u16 i = 0; i < inode->i_num_ads; i++)
384 len += ads_entry_out_total_length(&inode->i_ads_entries[i]);
390 /* Internal version of for_dentry_in_tree() that omits the NULL check */
392 do_for_dentry_in_tree(struct wim_dentry *dentry,
393 int (*visitor)(struct wim_dentry *, void *), void *arg)
396 struct wim_dentry *child;
398 ret = (*visitor)(dentry, arg);
402 for_dentry_child(child, dentry) {
403 ret = do_for_dentry_in_tree(child, visitor, arg);
410 /* Internal version of for_dentry_in_tree_depth() that omits the NULL check */
412 do_for_dentry_in_tree_depth(struct wim_dentry *dentry,
413 int (*visitor)(struct wim_dentry *, void *), void *arg)
416 struct wim_dentry *child;
418 for_dentry_child_postorder(child, dentry) {
419 ret = do_for_dentry_in_tree_depth(child, visitor, arg);
423 return unlikely((*visitor)(dentry, arg));
427 * Call a function on all dentries in a tree.
429 * @arg will be passed as the second argument to each invocation of @visitor.
431 * This function does a pre-order traversal --- that is, a parent will be
432 * visited before its children. It also will visit siblings in order of
433 * case-sensitive filename. Equivalently, this function visits the entire tree
434 * in the case-sensitive lexicographic order of the full paths.
436 * It is safe to pass NULL for @root, which means that the dentry tree is empty.
437 * In this case, this function does nothing.
439 * @visitor must not modify the structure of the dentry tree during the
442 * The return value will be 0 if all calls to @visitor returned 0. Otherwise,
443 * the return value will be the first nonzero value returned by @visitor.
446 for_dentry_in_tree(struct wim_dentry *root,
447 int (*visitor)(struct wim_dentry *, void *), void *arg)
451 return do_for_dentry_in_tree(root, visitor, arg);
454 /* Like for_dentry_in_tree(), but do a depth-first traversal of the dentry tree.
455 * That is, the visitor function will be called on a dentry's children before
456 * itself. It will be safe to free a dentry when visiting it. */
458 for_dentry_in_tree_depth(struct wim_dentry *root,
459 int (*visitor)(struct wim_dentry *, void *), void *arg)
463 return do_for_dentry_in_tree_depth(root, visitor, arg);
467 * Calculate the full path to @dentry within the WIM image, if not already done.
469 * The full name will be saved in the cached value 'dentry->_full_path'.
471 * Whenever possible, use dentry_full_path() instead of calling this and
472 * accessing _full_path directly.
474 * Returns 0 or an error code resulting from a failed string conversion.
477 calculate_dentry_full_path(struct wim_dentry *dentry)
481 const struct wim_dentry *d;
483 if (dentry->_full_path)
489 ulen += d->file_name_nbytes / sizeof(utf16lechar);
491 d = d->d_parent; /* assumes d == d->d_parent for root */
492 } while (!dentry_is_root(d));
494 utf16lechar ubuf[ulen];
495 utf16lechar *p = &ubuf[ulen];
499 p -= d->file_name_nbytes / sizeof(utf16lechar);
500 memcpy(p, d->file_name, d->file_name_nbytes);
501 *--p = cpu_to_le16(WIM_PATH_SEPARATOR);
502 d = d->d_parent; /* assumes d == d->d_parent for root */
503 } while (!dentry_is_root(d));
505 wimlib_assert(p == ubuf);
507 return utf16le_to_tstr(ubuf, ulen * sizeof(utf16lechar),
508 &dentry->_full_path, &dummy);
512 * Return the full path to the @dentry within the WIM image, or NULL if the full
513 * path could not be determined due to a string conversion error.
515 * The returned memory will be cached in the dentry, so the caller is not
516 * responsible for freeing it.
519 dentry_full_path(struct wim_dentry *dentry)
521 calculate_dentry_full_path(dentry);
522 return dentry->_full_path;
526 dentry_calculate_subdir_offset(struct wim_dentry *dentry, void *_subdir_offset_p)
528 if (dentry_is_directory(dentry)) {
529 u64 *subdir_offset_p = _subdir_offset_p;
530 struct wim_dentry *child;
532 /* Set offset of directory's child dentries */
533 dentry->subdir_offset = *subdir_offset_p;
535 /* Account for child dentries */
536 for_dentry_child(child, dentry)
537 *subdir_offset_p += dentry_out_total_length(child);
539 /* Account for end-of-directory entry */
540 *subdir_offset_p += 8;
542 /* Not a directory; set subdir_offset to 0 */
543 dentry->subdir_offset = 0;
549 * Calculate the subdir offsets for a dentry tree, in preparation of writing
550 * that dentry tree to a metadata resource.
552 * The subdir offset of each dentry is the offset in the uncompressed metadata
553 * resource at which its child dentries begin, or 0 if that dentry has no
556 * The caller must initialize *subdir_offset_p to the first subdir offset that
557 * is available to use after the root dentry is written.
559 * When this function returns, *subdir_offset_p will have been advanced past the
560 * size needed for the dentry tree within the uncompressed metadata resource.
563 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p)
565 for_dentry_in_tree(root, dentry_calculate_subdir_offset, subdir_offset_p);
568 /* Compare the UTF-16LE long filenames of two dentries case insensitively. */
570 dentry_compare_names_case_insensitive(const struct wim_dentry *d1,
571 const struct wim_dentry *d2)
573 return cmp_utf16le_strings(d1->file_name,
574 d1->file_name_nbytes / 2,
576 d2->file_name_nbytes / 2,
580 /* Compare the UTF-16LE long filenames of two dentries case sensitively. */
582 dentry_compare_names_case_sensitive(const struct wim_dentry *d1,
583 const struct wim_dentry *d2)
585 return cmp_utf16le_strings(d1->file_name,
586 d1->file_name_nbytes / 2,
588 d2->file_name_nbytes / 2,
593 _avl_dentry_compare_names_ci(const struct avl_tree_node *n1,
594 const struct avl_tree_node *n2)
596 const struct wim_dentry *d1, *d2;
598 d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node_ci);
599 d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node_ci);
600 return dentry_compare_names_case_insensitive(d1, d2);
604 _avl_dentry_compare_names(const struct avl_tree_node *n1,
605 const struct avl_tree_node *n2)
607 const struct wim_dentry *d1, *d2;
609 d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node);
610 d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node);
611 return dentry_compare_names_case_sensitive(d1, d2);
614 /* Default case sensitivity behavior for searches with
615 * WIMLIB_CASE_PLATFORM_DEFAULT specified. This can be modified by passing
616 * WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE or
617 * WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE to wimlib_global_init(). */
618 bool default_ignore_case =
626 /* Case-sensitive dentry lookup. Only @file_name and @file_name_nbytes of
627 * @dummy must be valid. */
628 static struct wim_dentry *
629 dir_lookup(const struct wim_inode *dir, const struct wim_dentry *dummy)
631 struct avl_tree_node *node;
633 node = avl_tree_lookup_node(dir->i_children,
634 &dummy->d_index_node,
635 _avl_dentry_compare_names);
638 return avl_tree_entry(node, struct wim_dentry, d_index_node);
641 /* Case-insensitive dentry lookup. Only @file_name and @file_name_nbytes of
642 * @dummy must be valid. */
643 static struct wim_dentry *
644 dir_lookup_ci(const struct wim_inode *dir, const struct wim_dentry *dummy)
646 struct avl_tree_node *node;
648 node = avl_tree_lookup_node(dir->i_children_ci,
649 &dummy->d_index_node_ci,
650 _avl_dentry_compare_names_ci);
653 return avl_tree_entry(node, struct wim_dentry, d_index_node_ci);
656 /* Given a UTF-16LE filename and a directory, look up the dentry for the file.
657 * Return it if found, otherwise NULL. This has configurable case sensitivity,
658 * and @name need not be null-terminated. */
660 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
661 const utf16lechar *name,
663 CASE_SENSITIVITY_TYPE case_ctype)
665 const struct wim_inode *dir = dentry->d_inode;
666 bool ignore_case = will_ignore_case(case_ctype);
667 struct wim_dentry dummy;
668 struct wim_dentry *child;
670 dummy.file_name = (utf16lechar*)name;
671 dummy.file_name_nbytes = name_nbytes;
674 /* Case-sensitive lookup. */
675 return dir_lookup(dir, &dummy);
677 /* Case-insensitive lookup. */
679 child = dir_lookup_ci(dir, &dummy);
683 if (likely(list_empty(&child->d_ci_conflict_list)))
684 /* Only one dentry has this case-insensitive name; return it */
687 /* Multiple dentries have the same case-insensitive name. Choose the
688 * dentry with the same case-sensitive name, if one exists; otherwise
689 * print a warning and choose one of the possible dentries arbitrarily.
691 struct wim_dentry *alt = child;
696 if (!dentry_compare_names_case_sensitive(&dummy, alt))
698 alt = list_entry(alt->d_ci_conflict_list.next,
699 struct wim_dentry, d_ci_conflict_list);
700 } while (alt != child);
702 WARNING("Result of case-insensitive lookup is ambiguous\n"
703 " (returning \"%"TS"\" of %zu "
704 "possible files, including \"%"TS"\")",
705 dentry_full_path(child),
707 dentry_full_path(list_entry(child->d_ci_conflict_list.next,
709 d_ci_conflict_list)));
713 /* Given a 'tchar' filename and a directory, look up the dentry for the file.
714 * If the filename was successfully converted to UTF-16LE and the dentry was
715 * found, return it; otherwise return NULL. This has configurable case
718 get_dentry_child_with_name(const struct wim_dentry *dentry, const tchar *name,
719 CASE_SENSITIVITY_TYPE case_type)
722 const utf16lechar *name_utf16le;
723 size_t name_utf16le_nbytes;
724 struct wim_dentry *child;
726 ret = tstr_get_utf16le_and_len(name, &name_utf16le,
727 &name_utf16le_nbytes);
731 child = get_dentry_child_with_utf16le_name(dentry,
735 tstr_put_utf16le(name_utf16le);
739 /* This is the UTF-16LE version of get_dentry(), currently private to this file
740 * because no one needs it besides get_dentry(). */
741 static struct wim_dentry *
742 get_dentry_utf16le(WIMStruct *wim, const utf16lechar *path,
743 CASE_SENSITIVITY_TYPE case_type)
745 struct wim_dentry *cur_dentry;
746 const utf16lechar *name_start, *name_end;
748 /* Start with the root directory of the image. Note: this will be NULL
749 * if an image has been added directly with wimlib_add_empty_image() but
750 * no files have been added yet; in that case we fail with ENOENT. */
751 cur_dentry = wim_get_current_root_dentry(wim);
755 if (cur_dentry == NULL) {
760 if (*name_start && !dentry_is_directory(cur_dentry)) {
765 while (*name_start == cpu_to_le16(WIM_PATH_SEPARATOR))
771 name_end = name_start;
774 } while (*name_end != cpu_to_le16(WIM_PATH_SEPARATOR) && *name_end);
776 cur_dentry = get_dentry_child_with_utf16le_name(cur_dentry,
778 (u8*)name_end - (u8*)name_start,
780 name_start = name_end;
785 * WIM path lookup: translate a path in the currently selected WIM image to the
786 * corresponding dentry, if it exists.
789 * The WIMStruct for the WIM. The search takes place in the currently
793 * The path to look up, given relative to the root of the WIM image.
794 * Characters with value WIM_PATH_SEPARATOR are taken to be path
795 * separators. Leading path separators are ignored, whereas one or more
796 * trailing path separators cause the path to only match a directory.
799 * The case-sensitivity behavior of this function, as one of the following
802 * - WIMLIB_CASE_SENSITIVE: Perform the search case sensitively. This means
803 * that names must match exactly.
805 * - WIMLIB_CASE_INSENSITIVE: Perform the search case insensitively. This
806 * means that names are considered to match if they are equal when
807 * transformed to upper case. If a path component matches multiple names
808 * case-insensitively, the name that matches the path component
809 * case-sensitively is chosen, if existent; otherwise one
810 * case-insensitively matching name is chosen arbitrarily.
812 * - WIMLIB_CASE_PLATFORM_DEFAULT: Perform either case-sensitive or
813 * case-insensitive search, depending on the value of the global variable
814 * default_ignore_case.
816 * In any case, no Unicode normalization is done before comparing strings.
818 * Returns a pointer to the dentry that is the result of the lookup, or NULL if
819 * no such dentry exists. If NULL is returned, errno is set to one of the
822 * ENOTDIR if one of the path components used as a directory existed but
823 * was not, in fact, a directory.
829 * - This function does not consider a reparse point to be a directory, even
830 * if it has FILE_ATTRIBUTE_DIRECTORY set.
832 * - This function does not dereference symbolic links or junction points
833 * when performing the search.
835 * - Since this function ignores leading slashes, the empty path is valid and
836 * names the root directory of the WIM image.
838 * - An image added with wimlib_add_empty_image() does not have a root
839 * directory yet, and this function will fail with ENOENT for any path on
843 get_dentry(WIMStruct *wim, const tchar *path, CASE_SENSITIVITY_TYPE case_type)
846 const utf16lechar *path_utf16le;
847 struct wim_dentry *dentry;
849 ret = tstr_get_utf16le(path, &path_utf16le);
852 dentry = get_dentry_utf16le(wim, path_utf16le, case_type);
853 tstr_put_utf16le(path_utf16le);
857 /* Modify @path, which is a null-terminated string @len 'tchars' in length,
858 * in-place to produce the path to its parent directory. */
860 to_parent_name(tchar *path, size_t len)
862 ssize_t i = (ssize_t)len - 1;
863 while (i >= 0 && path[i] == WIM_PATH_SEPARATOR)
865 while (i >= 0 && path[i] != WIM_PATH_SEPARATOR)
867 while (i >= 0 && path[i] == WIM_PATH_SEPARATOR)
869 path[i + 1] = T('\0');
872 /* Similar to get_dentry(), but returns the dentry named by @path with the last
873 * component stripped off.
875 * Note: The returned dentry is NOT guaranteed to be a directory. */
877 get_parent_dentry(WIMStruct *wim, const tchar *path,
878 CASE_SENSITIVITY_TYPE case_type)
880 size_t path_len = tstrlen(path);
881 tchar buf[path_len + 1];
883 tmemcpy(buf, path, path_len + 1);
884 to_parent_name(buf, path_len);
885 return get_dentry(wim, buf, case_type);
889 * Create an unlinked dentry.
891 * @name specifies the long name to give the new dentry. If NULL or empty, the
892 * new dentry will be given no long name.
894 * The new dentry will have no short name and no associated inode.
896 * On success, returns 0 and a pointer to the new, allocated dentry is stored in
897 * *dentry_ret. On failure, returns WIMLIB_ERR_NOMEM or an error code resulting
898 * from a failed string conversion.
901 new_dentry(const tchar *name, struct wim_dentry **dentry_ret)
903 struct wim_dentry *dentry;
906 dentry = CALLOC(1, sizeof(struct wim_dentry));
908 return WIMLIB_ERR_NOMEM;
911 ret = dentry_set_name(dentry, name);
917 dentry->d_parent = dentry;
918 *dentry_ret = dentry;
923 _new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret,
926 struct wim_dentry *dentry;
929 ret = new_dentry(name, &dentry);
934 dentry->d_inode = new_timeless_inode();
936 dentry->d_inode = new_inode();
937 if (dentry->d_inode == NULL) {
939 return WIMLIB_ERR_NOMEM;
942 inode_add_dentry(dentry, dentry->d_inode);
943 *dentry_ret = dentry;
947 /* Like new_dentry(), but also allocate an inode and associate it with the
948 * dentry. The timestamps for the inode will be set to the current time. */
950 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret)
952 return _new_dentry_with_inode(name, dentry_ret, false);
955 /* Like new_dentry_with_inode(), but don't bother setting the timestamps for the
956 * new inode; instead, just leave them as 0, under the presumption that the
957 * caller will set them itself. */
959 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret)
961 return _new_dentry_with_inode(name, dentry_ret, true);
964 /* Create an unnamed dentry with a new inode for a directory with the default
967 new_filler_directory(struct wim_dentry **dentry_ret)
970 struct wim_dentry *dentry;
972 ret = new_dentry_with_inode(NULL, &dentry);
975 /* Leave the inode number as 0; this is allowed for non
976 * hard-linked files. */
977 dentry->d_inode->i_resolved = 1;
978 dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
979 *dentry_ret = dentry;
984 dentry_clear_inode_visited(struct wim_dentry *dentry, void *_ignore)
986 dentry->d_inode->i_visited = 0;
991 dentry_tree_clear_inode_visited(struct wim_dentry *root)
993 for_dentry_in_tree(root, dentry_clear_inode_visited, NULL);
999 * In addition to freeing the dentry itself, this decrements the link count of
1000 * the corresponding inode (if any). If the inode's link count reaches 0, the
1001 * inode is freed as well.
1004 free_dentry(struct wim_dentry *dentry)
1007 FREE(dentry->file_name);
1008 FREE(dentry->short_name);
1009 FREE(dentry->_full_path);
1010 if (dentry->d_inode)
1011 put_inode(dentry->d_inode);
1017 do_free_dentry(struct wim_dentry *dentry, void *_ignore)
1019 free_dentry(dentry);
1024 do_free_dentry_and_unref_streams(struct wim_dentry *dentry, void *lookup_table)
1026 inode_unref_streams(dentry->d_inode, lookup_table);
1027 free_dentry(dentry);
1032 * Free all dentries in a tree.
1035 * The root of the dentry tree to free. If NULL, this function has no
1039 * A pointer to the lookup table for the WIM, or NULL if not specified. If
1040 * specified, this function will decrement the reference counts of the
1041 * single-instance streams referenced by the dentries.
1043 * This function also releases references to the corresponding inodes.
1045 * This function does *not* unlink @root from its parent directory, if it has
1046 * one. If @root has a parent, the caller must unlink @root before calling this
1050 free_dentry_tree(struct wim_dentry *root, struct wim_lookup_table *lookup_table)
1052 int (*f)(struct wim_dentry *, void *);
1055 f = do_free_dentry_and_unref_streams;
1059 for_dentry_in_tree_depth(root, f, lookup_table);
1062 /* Insert the @child dentry into the case sensitive index of the @dir directory.
1063 * Return NULL if successfully inserted, otherwise a pointer to the
1064 * already-inserted duplicate. */
1065 static struct wim_dentry *
1066 dir_index_child(struct wim_inode *dir, struct wim_dentry *child)
1068 struct avl_tree_node *duplicate;
1070 duplicate = avl_tree_insert(&dir->i_children,
1071 &child->d_index_node,
1072 _avl_dentry_compare_names);
1075 return avl_tree_entry(duplicate, struct wim_dentry, d_index_node);
1078 /* Insert the @child dentry into the case insensitive index of the @dir
1079 * directory. Return NULL if successfully inserted, otherwise a pointer to the
1080 * already-inserted duplicate. */
1081 static struct wim_dentry *
1082 dir_index_child_ci(struct wim_inode *dir, struct wim_dentry *child)
1084 struct avl_tree_node *duplicate;
1086 duplicate = avl_tree_insert(&dir->i_children_ci,
1087 &child->d_index_node_ci,
1088 _avl_dentry_compare_names_ci);
1091 return avl_tree_entry(duplicate, struct wim_dentry, d_index_node_ci);
1094 /* Remove the specified dentry from its directory's case-sensitive index. */
1096 dir_unindex_child(struct wim_inode *dir, struct wim_dentry *child)
1098 avl_tree_remove(&dir->i_children, &child->d_index_node);
1101 /* Remove the specified dentry from its directory's case-insensitive index. */
1103 dir_unindex_child_ci(struct wim_inode *dir, struct wim_dentry *child)
1105 avl_tree_remove(&dir->i_children_ci, &child->d_index_node_ci);
1108 /* Return true iff the specified dentry is in its parent directory's
1109 * case-insensitive index. */
1111 dentry_in_ci_index(const struct wim_dentry *dentry)
1113 return !avl_tree_node_is_unlinked(&dentry->d_index_node_ci);
1117 * Link a dentry into the tree.
1120 * The dentry that will be the parent of @child. It must name a directory.
1123 * The dentry to link. It must be currently unlinked.
1125 * Returns NULL if successful. If @parent already contains a dentry with the
1126 * same case-sensitive name as @child, returns a pointer to this duplicate
1130 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child)
1132 struct wim_dentry *duplicate;
1133 struct wim_inode *dir;
1135 wimlib_assert(parent != child);
1137 dir = parent->d_inode;
1139 wimlib_assert(inode_is_directory(dir));
1141 duplicate = dir_index_child(dir, child);
1145 duplicate = dir_index_child_ci(dir, child);
1147 list_add(&child->d_ci_conflict_list, &duplicate->d_ci_conflict_list);
1148 avl_tree_node_set_unlinked(&child->d_index_node_ci);
1150 INIT_LIST_HEAD(&child->d_ci_conflict_list);
1152 child->d_parent = parent;
1156 /* Unlink a dentry from the tree. */
1158 unlink_dentry(struct wim_dentry *dentry)
1160 struct wim_inode *dir;
1162 /* Do nothing if the dentry is root or it's already unlinked. Not
1163 * actually necessary based on the current callers, but we do the check
1164 * here to be safe. */
1165 if (unlikely(dentry->d_parent == dentry))
1168 dir = dentry->d_parent->d_inode;
1170 dir_unindex_child(dir, dentry);
1172 if (dentry_in_ci_index(dentry)) {
1174 dir_unindex_child_ci(dir, dentry);
1176 if (!list_empty(&dentry->d_ci_conflict_list)) {
1177 /* Make a different case-insensitively-the-same dentry
1178 * be the "representative" in the search index. */
1179 struct list_head *next;
1180 struct wim_dentry *other;
1181 struct wim_dentry *existing;
1183 next = dentry->d_ci_conflict_list.next;
1184 other = list_entry(next, struct wim_dentry, d_ci_conflict_list);
1185 existing = dir_index_child_ci(dir, other);
1186 wimlib_assert(existing == NULL);
1189 list_del(&dentry->d_ci_conflict_list);
1191 /* Not actually necessary, but to be safe don't retain the now-obsolete
1192 * parent pointer. */
1193 dentry->d_parent = dentry;
1197 read_extra_data(const u8 *p, const u8 *end, struct wim_inode *inode)
1199 while (((uintptr_t)p & 7) && p < end)
1202 if (unlikely(p < end)) {
1203 inode->i_extra = memdup(p, end - p);
1204 if (!inode->i_extra)
1205 return WIMLIB_ERR_NOMEM;
1206 inode->i_extra_size = end - p;
1211 /* Read a dentry, including all alternate data stream entries that follow it,
1212 * from an uncompressed metadata resource buffer. */
1214 read_dentry(const u8 * restrict buf, size_t buf_len,
1215 u64 *offset_p, struct wim_dentry **dentry_ret)
1217 u64 offset = *offset_p;
1220 const struct wim_dentry_on_disk *disk_dentry;
1221 struct wim_dentry *dentry;
1222 struct wim_inode *inode;
1223 u16 short_name_nbytes;
1224 u16 file_name_nbytes;
1225 u64 calculated_size;
1228 BUILD_BUG_ON(sizeof(struct wim_dentry_on_disk) != WIM_DENTRY_DISK_SIZE);
1230 /* Before reading the whole dentry, we need to read just the length.
1231 * This is because a dentry of length 8 (that is, just the length field)
1232 * terminates the list of sibling directory entries. */
1234 /* Check for buffer overrun. */
1235 if (unlikely(offset + sizeof(u64) > buf_len ||
1236 offset + sizeof(u64) < offset))
1238 ERROR("Directory entry starting at %"PRIu64" ends past the "
1239 "end of the metadata resource (size %zu)",
1241 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1244 /* Get pointer to the dentry data. */
1246 disk_dentry = (const struct wim_dentry_on_disk*)p;
1248 /* Get dentry length. */
1249 length = le64_to_cpu(disk_dentry->length);
1251 /* Check for end-of-directory. */
1257 /* Validate dentry length. */
1258 if (unlikely(length < sizeof(struct wim_dentry_on_disk))) {
1259 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
1261 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1264 /* Check for buffer overrun. */
1265 if (unlikely(offset + length > buf_len ||
1266 offset + length < offset))
1268 ERROR("Directory entry at offset %"PRIu64" and with size "
1269 "%"PRIu64" ends past the end of the metadata resource "
1270 "(size %zu)", offset, length, buf_len);
1271 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1274 /* Allocate new dentry structure, along with a preliminary inode. */
1275 ret = new_dentry_with_timeless_inode(NULL, &dentry);
1279 inode = dentry->d_inode;
1281 /* Read more fields: some into the dentry, and some into the inode. */
1282 inode->i_attributes = le32_to_cpu(disk_dentry->attributes);
1283 inode->i_security_id = le32_to_cpu(disk_dentry->security_id);
1284 dentry->subdir_offset = le64_to_cpu(disk_dentry->subdir_offset);
1285 inode->i_creation_time = le64_to_cpu(disk_dentry->creation_time);
1286 inode->i_last_access_time = le64_to_cpu(disk_dentry->last_access_time);
1287 inode->i_last_write_time = le64_to_cpu(disk_dentry->last_write_time);
1288 copy_hash(inode->i_hash, disk_dentry->unnamed_stream_hash);
1290 /* I don't know what's going on here. It seems like M$ screwed up the
1291 * reparse points, then put the fields in the same place and didn't
1292 * document it. So we have some fields we read for reparse points, and
1293 * some fields in the same place for non-reparse-points. */
1294 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1295 inode->i_rp_unknown_1 = le32_to_cpu(disk_dentry->reparse.rp_unknown_1);
1296 inode->i_reparse_tag = le32_to_cpu(disk_dentry->reparse.reparse_tag);
1297 inode->i_rp_unknown_2 = le16_to_cpu(disk_dentry->reparse.rp_unknown_2);
1298 inode->i_not_rpfixed = le16_to_cpu(disk_dentry->reparse.not_rpfixed);
1299 /* Leave inode->i_ino at 0. Note that this means the WIM file
1300 * cannot archive hard-linked reparse points. Such a thing
1301 * doesn't really make sense anyway, although I believe it's
1302 * theoretically possible to have them on NTFS. */
1304 inode->i_rp_unknown_1 = le32_to_cpu(disk_dentry->nonreparse.rp_unknown_1);
1305 inode->i_ino = le64_to_cpu(disk_dentry->nonreparse.hard_link_group_id);
1307 inode->i_num_ads = le16_to_cpu(disk_dentry->num_alternate_data_streams);
1309 /* Now onto reading the names. There are two of them: the (long) file
1310 * name, and the short name. */
1312 short_name_nbytes = le16_to_cpu(disk_dentry->short_name_nbytes);
1313 file_name_nbytes = le16_to_cpu(disk_dentry->file_name_nbytes);
1315 if (unlikely((short_name_nbytes & 1) | (file_name_nbytes & 1))) {
1316 ERROR("Dentry name is not valid UTF-16 (odd number of bytes)!");
1317 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1318 goto err_free_dentry;
1321 /* We now know the length of the file name and short name. Make sure
1322 * the length of the dentry is large enough to actually hold them.
1324 * The calculated length here is unaligned to allow for the possibility
1325 * that the dentry's length is unaligned, although this would be
1327 calculated_size = dentry_min_len_with_names(file_name_nbytes,
1330 if (unlikely(length < calculated_size)) {
1331 ERROR("Unexpected end of directory entry! (Expected "
1332 "at least %"PRIu64" bytes, got %"PRIu64" bytes.)",
1333 calculated_size, length);
1334 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1335 goto err_free_dentry;
1338 /* Advance p to point past the base dentry, to the first name. */
1339 p += sizeof(struct wim_dentry_on_disk);
1341 /* Read the filename if present. Note: if the filename is empty, there
1342 * is no null terminator following it. */
1343 if (file_name_nbytes) {
1344 dentry->file_name = utf16le_dupz((const utf16lechar *)p,
1346 if (dentry->file_name == NULL) {
1347 ret = WIMLIB_ERR_NOMEM;
1348 goto err_free_dentry;
1350 dentry->file_name_nbytes = file_name_nbytes;
1351 p += (u32)file_name_nbytes + 2;
1354 /* Read the short filename if present. Note: if there is no short
1355 * filename, there is no null terminator following it. */
1356 if (short_name_nbytes) {
1357 dentry->short_name = utf16le_dupz((const utf16lechar *)p,
1359 if (dentry->short_name == NULL) {
1360 ret = WIMLIB_ERR_NOMEM;
1361 goto err_free_dentry;
1363 dentry->short_name_nbytes = short_name_nbytes;
1364 p += (u32)short_name_nbytes + 2;
1367 /* Read extra data at end of dentry (but before alternate data stream
1368 * entries). This may contain tagged items. */
1369 ret = read_extra_data(p, &buf[offset + length], inode);
1371 goto err_free_dentry;
1373 /* Align the dentry length. */
1374 length = (length + 7) & ~7;
1378 /* Read the alternate data streams, if present. inode->i_num_ads tells
1379 * us how many they are, and they will directly follow the dentry in the
1380 * metadata resource buffer.
1382 * Note that each alternate data stream entry begins on an 8-byte
1383 * aligned boundary, and the alternate data stream entries seem to NOT
1384 * be included in the dentry->length field for some reason. */
1385 if (unlikely(inode->i_num_ads != 0)) {
1386 size_t orig_bytes_remaining;
1387 size_t bytes_remaining;
1389 if (offset > buf_len) {
1390 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1391 goto err_free_dentry;
1393 bytes_remaining = buf_len - offset;
1394 orig_bytes_remaining = bytes_remaining;
1395 ret = read_ads_entries(&buf[offset], inode, &bytes_remaining);
1397 goto err_free_dentry;
1398 offset += (orig_bytes_remaining - bytes_remaining);
1401 *offset_p = offset; /* Sets offset of next dentry in directory */
1402 *dentry_ret = dentry;
1406 free_dentry(dentry);
1410 /* Is the dentry named "." or ".." ? */
1412 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
1414 if (dentry->file_name_nbytes <= 4) {
1415 if (dentry->file_name_nbytes == 4) {
1416 if (dentry->file_name[0] == cpu_to_le16('.') &&
1417 dentry->file_name[1] == cpu_to_le16('.'))
1419 } else if (dentry->file_name_nbytes == 2) {
1420 if (dentry->file_name[0] == cpu_to_le16('.'))
1428 read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len,
1429 struct wim_dentry * restrict dir)
1431 u64 cur_offset = dir->subdir_offset;
1433 /* Check for cyclic directory structure, which would cause infinite
1434 * recursion if not handled. */
1435 for (struct wim_dentry *d = dir->d_parent;
1436 !dentry_is_root(d); d = d->d_parent)
1438 if (unlikely(d->subdir_offset == cur_offset)) {
1439 ERROR("Cyclic directory structure detected: children "
1440 "of \"%"TS"\" coincide with children of \"%"TS"\"",
1441 dentry_full_path(dir), dentry_full_path(d));
1442 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1447 struct wim_dentry *child;
1448 struct wim_dentry *duplicate;
1451 /* Read next child of @dir. */
1452 ret = read_dentry(buf, buf_len, &cur_offset, &child);
1456 /* Check for end of directory. */
1460 /* All dentries except the root should be named. */
1461 if (unlikely(!dentry_has_long_name(child))) {
1462 WARNING("Ignoring unnamed dentry in "
1463 "directory \"%"TS"\"", dentry_full_path(dir));
1468 /* Don't allow files named "." or "..". */
1469 if (unlikely(dentry_is_dot_or_dotdot(child))) {
1470 WARNING("Ignoring file named \".\" or \"..\"; "
1471 "potentially malicious archive!!!");
1476 /* Link the child into the directory. */
1477 duplicate = dentry_add_child(dir, child);
1478 if (unlikely(duplicate)) {
1479 /* We already found a dentry with this same
1480 * case-sensitive long name. Only keep the first one.
1482 WARNING("Ignoring duplicate file \"%"TS"\" "
1483 "(the WIM image already contains a file "
1484 "at that path with the exact same name)",
1485 dentry_full_path(duplicate));
1490 /* If this child is a directory that itself has children, call
1491 * this procedure recursively. */
1492 if (child->subdir_offset != 0) {
1493 if (likely(dentry_is_directory(child))) {
1494 ret = read_dentry_tree_recursive(buf,
1500 WARNING("Ignoring children of "
1501 "non-directory file \"%"TS"\"",
1502 dentry_full_path(child));
1509 * Read a tree of dentries from a WIM metadata resource.
1512 * Buffer containing an uncompressed WIM metadata resource.
1515 * Length of the uncompressed metadata resource, in bytes.
1518 * Offset in the metadata resource of the root of the dentry tree.
1521 * On success, either NULL or a pointer to the root dentry is written to
1522 * this location. The former case only occurs in the unexpected case that
1523 * the tree began with an end-of-directory entry.
1526 * WIMLIB_ERR_SUCCESS (0)
1527 * WIMLIB_ERR_INVALID_METADATA_RESOURCE
1531 read_dentry_tree(const u8 *buf, size_t buf_len,
1532 u64 root_offset, struct wim_dentry **root_ret)
1535 struct wim_dentry *root;
1537 DEBUG("Reading dentry tree (root_offset=%"PRIu64")", root_offset);
1539 ret = read_dentry(buf, buf_len, &root_offset, &root);
1543 if (likely(root != NULL)) {
1544 if (unlikely(dentry_has_long_name(root) ||
1545 dentry_has_short_name(root)))
1547 WARNING("The root directory has a nonempty name; "
1549 dentry_set_name(root, NULL);
1552 if (unlikely(!dentry_is_directory(root))) {
1553 ERROR("The root of the WIM image is not a directory!");
1554 ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
1555 goto err_free_dentry_tree;
1558 if (likely(root->subdir_offset != 0)) {
1559 ret = read_dentry_tree_recursive(buf, buf_len, root);
1561 goto err_free_dentry_tree;
1564 WARNING("The metadata resource has no directory entries; "
1565 "treating as an empty image.");
1570 err_free_dentry_tree:
1571 free_dentry_tree(root, NULL);
1576 * Write a WIM alternate data stream (ADS) entry to an output buffer.
1579 * The ADS entry to write.
1582 * The hash field to use (instead of the one stored directly in the ADS
1583 * entry, which isn't valid if the inode has been "resolved").
1586 * The memory location to which to write the data.
1588 * Returns a pointer to the byte after the last byte written.
1591 write_ads_entry(const struct wim_ads_entry *ads_entry,
1592 const u8 *hash, u8 * restrict p)
1594 struct wim_ads_entry_on_disk *disk_ads_entry =
1595 (struct wim_ads_entry_on_disk*)p;
1598 disk_ads_entry->reserved = cpu_to_le64(ads_entry->reserved);
1599 copy_hash(disk_ads_entry->hash, hash);
1600 disk_ads_entry->stream_name_nbytes = cpu_to_le16(ads_entry->stream_name_nbytes);
1601 p += sizeof(struct wim_ads_entry_on_disk);
1602 if (ads_entry->stream_name_nbytes) {
1603 p = mempcpy(p, ads_entry->stream_name,
1604 (u32)ads_entry->stream_name_nbytes + 2);
1606 /* Align to 8-byte boundary */
1607 while ((uintptr_t)p & 7)
1609 disk_ads_entry->length = cpu_to_le64(p - orig_p);
1614 * Write a WIM dentry to an output buffer.
1616 * This includes any alternate data stream entries that may follow the dentry
1620 * The dentry to write.
1623 * The memory location to which to write the data.
1625 * Returns a pointer to the byte following the last written.
1628 write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p)
1630 const struct wim_inode *inode;
1631 struct wim_dentry_on_disk *disk_dentry;
1634 bool use_dummy_stream;
1637 wimlib_assert(((uintptr_t)p & 7) == 0); /* 8 byte aligned */
1640 inode = dentry->d_inode;
1641 use_dummy_stream = inode_needs_dummy_stream(inode);
1642 disk_dentry = (struct wim_dentry_on_disk*)p;
1644 disk_dentry->attributes = cpu_to_le32(inode->i_attributes);
1645 disk_dentry->security_id = cpu_to_le32(inode->i_security_id);
1646 disk_dentry->subdir_offset = cpu_to_le64(dentry->subdir_offset);
1648 disk_dentry->unused_1 = cpu_to_le64(0);
1649 disk_dentry->unused_2 = cpu_to_le64(0);
1651 disk_dentry->creation_time = cpu_to_le64(inode->i_creation_time);
1652 disk_dentry->last_access_time = cpu_to_le64(inode->i_last_access_time);
1653 disk_dentry->last_write_time = cpu_to_le64(inode->i_last_write_time);
1654 if (use_dummy_stream)
1657 hash = inode_stream_hash(inode, 0);
1658 copy_hash(disk_dentry->unnamed_stream_hash, hash);
1659 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1660 disk_dentry->reparse.rp_unknown_1 = cpu_to_le32(inode->i_rp_unknown_1);
1661 disk_dentry->reparse.reparse_tag = cpu_to_le32(inode->i_reparse_tag);
1662 disk_dentry->reparse.rp_unknown_2 = cpu_to_le16(inode->i_rp_unknown_2);
1663 disk_dentry->reparse.not_rpfixed = cpu_to_le16(inode->i_not_rpfixed);
1665 disk_dentry->nonreparse.rp_unknown_1 = cpu_to_le32(inode->i_rp_unknown_1);
1666 disk_dentry->nonreparse.hard_link_group_id =
1667 cpu_to_le64((inode->i_nlink == 1) ? 0 : inode->i_ino);
1669 num_ads = inode->i_num_ads;
1670 if (use_dummy_stream)
1672 disk_dentry->num_alternate_data_streams = cpu_to_le16(num_ads);
1673 disk_dentry->short_name_nbytes = cpu_to_le16(dentry->short_name_nbytes);
1674 disk_dentry->file_name_nbytes = cpu_to_le16(dentry->file_name_nbytes);
1675 p += sizeof(struct wim_dentry_on_disk);
1677 wimlib_assert(dentry_is_root(dentry) != dentry_has_long_name(dentry));
1679 if (dentry_has_long_name(dentry))
1680 p = mempcpy(p, dentry->file_name, (u32)dentry->file_name_nbytes + 2);
1682 if (dentry_has_short_name(dentry))
1683 p = mempcpy(p, dentry->short_name, (u32)dentry->short_name_nbytes + 2);
1685 /* Align to 8-byte boundary */
1686 while ((uintptr_t)p & 7)
1689 if (inode->i_extra_size) {
1690 /* Extra tagged items --- not usually present. */
1691 p = mempcpy(p, inode->i_extra, inode->i_extra_size);
1692 while ((uintptr_t)p & 7)
1696 disk_dentry->length = cpu_to_le64(p - orig_p);
1698 if (use_dummy_stream) {
1699 hash = inode_unnamed_stream_hash(inode);
1700 p = write_ads_entry(&(struct wim_ads_entry){}, hash, p);
1703 /* Write the alternate data streams entries, if any. */
1704 for (u16 i = 0; i < inode->i_num_ads; i++) {
1705 hash = inode_stream_hash(inode, i + 1);
1706 p = write_ads_entry(&inode->i_ads_entries[i], hash, p);
1713 write_dir_dentries(struct wim_dentry *dir, void *_pp)
1715 if (dir->subdir_offset != 0) {
1718 struct wim_dentry *child;
1720 /* write child dentries */
1721 for_dentry_child(child, dir)
1722 p = write_dentry(child, p);
1724 /* write end of directory entry */
1733 * Write a directory tree to the metadata resource.
1736 * The root of a dentry tree on which calculate_subdir_offsets() has been
1737 * called. This cannot be NULL; if the dentry tree is empty, the caller is
1738 * expected to first generate a dummy root directory.
1741 * Pointer to a buffer with enough space for the dentry tree. This size
1742 * must have been obtained by calculate_subdir_offsets().
1744 * Returns a pointer to the byte following the last written.
1747 write_dentry_tree(struct wim_dentry *root, u8 *p)
1749 DEBUG("Writing dentry tree.");
1751 wimlib_assert(root != NULL);
1753 /* write root dentry and end-of-directory entry following it */
1754 p = write_dentry(root, p);
1758 /* write the rest of the dentry tree */
1759 for_dentry_in_tree(root, write_dir_dentries, &p);