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 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/.
29 #include "buffer_io.h"
31 #include "lookup_table.h"
32 #include "timestamp.h"
33 #include "wimlib_internal.h"
36 /* Calculates the unaligned length, in bytes, of an on-disk WIM dentry that has
37 * a file name and short name that take the specified numbers of bytes. This
38 * excludes any alternate data stream entries that may follow the dentry. */
40 __dentry_correct_length_unaligned(u16 file_name_nbytes, u16 short_name_nbytes)
42 u64 length = WIM_DENTRY_DISK_SIZE;
44 length += file_name_nbytes + 2;
45 if (short_name_nbytes)
46 length += short_name_nbytes + 2;
50 /* Calculates the unaligned length, in bytes, of an on-disk WIM dentry, based on
51 * the file name length and short name length. Note that dentry->length is
52 * ignored; also, this excludes any alternate data stream entries that may
53 * follow the dentry. */
55 dentry_correct_length_unaligned(const struct wim_dentry *dentry)
57 return __dentry_correct_length_unaligned(dentry->file_name_nbytes,
58 dentry->short_name_nbytes);
61 /* Return the "correct" value to write in the length field of a WIM dentry,
62 * based on the file name length and short name length. */
64 dentry_correct_length(const struct wim_dentry *dentry)
66 return (dentry_correct_length_unaligned(dentry) + 7) & ~7;
69 /* Return %true iff the alternate data stream entry @entry has the UTF-16LE
70 * stream name @name that has length @name_nbytes bytes. */
72 ads_entry_has_name(const struct wim_ads_entry *entry,
73 const utf16lechar *name, size_t name_nbytes)
75 return entry->stream_name_nbytes == name_nbytes &&
76 memcmp(entry->stream_name, name, name_nbytes) == 0;
79 /* Duplicates a multibyte string into a UTF-16LE string and returns the string
80 * and its length, in bytes, in the pointer arguments. Frees any existing
81 * string at the return location before overwriting it. */
83 get_utf16le_name(const mbchar *name, utf16lechar **name_utf16le_ret,
84 u16 *name_utf16le_nbytes_ret)
86 utf16lechar *name_utf16le;
87 size_t name_utf16le_nbytes;
90 ret = mbs_to_utf16le(name, strlen(name), &name_utf16le,
91 &name_utf16le_nbytes);
93 if (name_utf16le_nbytes > 0xffff) {
95 ERROR("Multibyte string \"%s\" is too long!", name);
96 ret = WIMLIB_ERR_INVALID_UTF8_STRING;
98 FREE(*name_utf16le_ret);
99 *name_utf16le_ret = name_utf16le;
100 *name_utf16le_nbytes_ret = name_utf16le_nbytes;
106 /* Sets the name of a WIM dentry from a multibyte string. */
108 set_dentry_name(struct wim_dentry *dentry, const mbchar *new_name)
111 ret = get_utf16le_name(new_name, &dentry->file_name,
112 &dentry->file_name_nbytes);
114 /* Clear the short name and recalculate the dentry length */
115 if (dentry_has_short_name(dentry)) {
116 FREE(dentry->short_name);
117 dentry->short_name = NULL;
118 dentry->short_name_nbytes = 0;
120 dentry->length = dentry_correct_length(dentry);
125 /* Returns the total length of a WIM alternate data stream entry on-disk,
126 * including the stream name, the null terminator, AND the padding after the
127 * entry to align the next ADS entry or dentry on an 8-byte boundary. */
129 ads_entry_total_length(const struct wim_ads_entry *entry)
131 u64 len = WIM_ADS_ENTRY_DISK_SIZE;
132 if (entry->stream_name_nbytes)
133 len += entry->stream_name_nbytes + 2;
134 return (len + 7) & ~7;
139 __dentry_total_length(const struct wim_dentry *dentry, u64 length)
141 const struct wim_inode *inode = dentry->d_inode;
142 for (u16 i = 0; i < inode->i_num_ads; i++)
143 length += ads_entry_total_length(&inode->i_ads_entries[i]);
144 return (length + 7) & ~7;
147 /* Calculate the aligned *total* length of an on-disk WIM dentry. This includes
148 * all alternate data streams. */
150 dentry_correct_total_length(const struct wim_dentry *dentry)
152 return __dentry_total_length(dentry,
153 dentry_correct_length_unaligned(dentry));
156 /* Like dentry_correct_total_length(), but use the existing dentry->length field
157 * instead of calculating its "correct" value. */
159 dentry_total_length(const struct wim_dentry *dentry)
161 return __dentry_total_length(dentry, dentry->length);
165 for_dentry_in_rbtree(struct rb_node *root,
166 int (*visitor)(struct wim_dentry *, void *),
170 struct rb_node *node = root;
174 list_add(&rbnode_dentry(node)->tmp_list, &stack);
175 node = node->rb_left;
177 struct list_head *next;
178 struct wim_dentry *dentry;
183 dentry = container_of(next, struct wim_dentry, tmp_list);
185 ret = visitor(dentry, arg);
188 node = dentry->rb_node.rb_right;
194 for_dentry_tree_in_rbtree_depth(struct rb_node *node,
195 int (*visitor)(struct wim_dentry*, void*),
200 ret = for_dentry_tree_in_rbtree_depth(node->rb_left,
204 ret = for_dentry_tree_in_rbtree_depth(node->rb_right,
208 ret = for_dentry_in_tree_depth(rbnode_dentry(node), visitor, arg);
216 for_dentry_tree_in_rbtree(struct rb_node *node,
217 int (*visitor)(struct wim_dentry*, void*),
222 ret = for_dentry_tree_in_rbtree(node->rb_left, visitor, arg);
225 ret = for_dentry_in_tree(rbnode_dentry(node), visitor, arg);
228 ret = for_dentry_tree_in_rbtree(node->rb_right, visitor, arg);
235 /* Calls a function on all directory entries in a WIM dentry tree. Logically,
236 * this is a pre-order traversal (the function is called on a parent dentry
237 * before its children), but sibling dentries will be visited in order as well.
240 for_dentry_in_tree(struct wim_dentry *root,
241 int (*visitor)(struct wim_dentry*, void*), void *arg)
243 int ret = visitor(root, arg);
245 ret = for_dentry_tree_in_rbtree(root->d_inode->i_children.rb_node,
252 /* Like for_dentry_in_tree(), but the visitor function is always called on a
253 * dentry's children before on itself. */
255 for_dentry_in_tree_depth(struct wim_dentry *root,
256 int (*visitor)(struct wim_dentry*, void*), void *arg)
259 ret = for_dentry_tree_in_rbtree_depth(root->d_inode->i_children.rb_node,
262 ret = visitor(root, arg);
266 /* Calculate the full path of @dentry. The full path of its parent must have
267 * already been calculated. */
269 calculate_dentry_full_path(struct wim_dentry *dentry, void *ignore)
272 u32 full_path_nbytes;
274 wimlib_assert(dentry_is_root(dentry) ||
275 dentry->parent->full_path != NULL);
277 if (dentry_is_root(dentry)) {
278 full_path = MALLOC(2);
280 return WIMLIB_ERR_NOMEM;
283 full_path_nbytes = 1;
285 char *parent_full_path;
286 u32 parent_full_path_nbytes;
287 const struct wim_dentry *parent;
288 size_t name_mbs_nbytes;
291 ret = utf16le_to_mbs_nbytes(dentry->file_name,
292 dentry->file_name_nbytes,
296 parent = dentry->parent;
297 if (dentry_is_root(parent)) {
298 parent_full_path = "";
299 parent_full_path_nbytes = 0;
301 parent_full_path = parent->full_path;
302 parent_full_path_nbytes = parent->full_path_nbytes;
304 full_path_nbytes = parent_full_path_nbytes + 1 +
306 full_path = MALLOC(full_path_nbytes + 1);
308 return WIMLIB_ERR_NOMEM;
309 memcpy(full_path, parent_full_path, parent_full_path_nbytes);
310 full_path[parent_full_path_nbytes] = '/';
312 utf16le_to_mbs_buf(dentry->file_name,
313 dentry->file_name_nbytes,
314 &full_path[parent_full_path_nbytes + 1]);
316 FREE(dentry->full_path);
317 dentry->full_path = full_path;
318 dentry->full_path_nbytes= full_path_nbytes;
323 increment_subdir_offset(struct wim_dentry *dentry, void *subdir_offset_p)
325 *(u64*)subdir_offset_p += dentry_correct_total_length(dentry);
330 call_calculate_subdir_offsets(struct wim_dentry *dentry, void *subdir_offset_p)
332 calculate_subdir_offsets(dentry, subdir_offset_p);
337 * Recursively calculates the subdir offsets for a directory tree.
339 * @dentry: The root of the directory tree.
340 * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory
341 * offset for @dentry.
344 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p)
346 struct rb_node *node;
348 dentry->subdir_offset = *subdir_offset_p;
349 node = dentry->d_inode->i_children.rb_node;
351 /* Advance the subdir offset by the amount of space the children
352 * of this dentry take up. */
353 for_dentry_in_rbtree(node, increment_subdir_offset, subdir_offset_p);
355 /* End-of-directory dentry on disk. */
356 *subdir_offset_p += 8;
358 /* Recursively call calculate_subdir_offsets() on all the
360 for_dentry_in_rbtree(node, call_calculate_subdir_offsets, subdir_offset_p);
362 /* On disk, childless directories have a valid subdir_offset
363 * that points to an 8-byte end-of-directory dentry. Regular
364 * files or reparse points have a subdir_offset of 0. */
365 if (dentry_is_directory(dentry))
366 *subdir_offset_p += 8;
368 dentry->subdir_offset = 0;
373 compare_utf16le_names(const utf16lechar *name1, size_t nbytes1,
374 const utf16lechar *name2, size_t nbytes2)
376 int result = memcmp(name1, name2, min(nbytes1, nbytes2));
380 return (int)nbytes1 - (int)nbytes2;
384 dentry_compare_names(const struct wim_dentry *d1, const struct wim_dentry *d2)
386 return compare_utf16le_names(d1->file_name, d1->file_name_nbytes,
387 d2->file_name, d2->file_name_nbytes);
392 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
393 const utf16lechar *name,
396 struct rb_node *node = dentry->d_inode->i_children.rb_node;
397 struct wim_dentry *child;
399 child = rbnode_dentry(node);
400 int result = compare_utf16le_names(name, name_nbytes,
402 child->file_name_nbytes);
404 node = node->rb_left;
406 node = node->rb_right;
413 /* Returns the child of @dentry that has the file name @name. Returns NULL if
414 * no child has the name. */
416 get_dentry_child_with_name(const struct wim_dentry *dentry, const mbchar *name)
418 utf16lechar *utf16le_name;
419 size_t utf16le_name_nbytes;
421 struct wim_dentry *child;
423 ret = mbs_to_utf16le(name, strlen(name),
424 &utf16le_name, &utf16le_name_nbytes);
428 child = get_dentry_child_with_utf16le_name(dentry,
430 utf16le_name_nbytes);
436 /* Returns the dentry corresponding to the @path, or NULL if there is no such
439 get_dentry(WIMStruct *w, const mbchar *path)
441 utf16lechar *path_utf16le;
442 size_t path_utf16le_nbytes;
444 struct wim_dentry *cur_dentry, *parent_dentry;
447 ret = mbs_to_utf16le(path, strlen(path), &path_utf16le,
448 &path_utf16le_nbytes);
452 parent_dentry = wim_root_dentry(w);
456 while (*p == cpu_to_le16('/'))
458 cur_dentry = parent_dentry;
462 while (*pp != cpu_to_le16('/') && *pp != '\0')
465 cur_dentry = get_dentry_child_with_utf16le_name(parent_dentry, p,
466 (void*)pp - (void*)p);
467 if (cur_dentry == NULL)
470 parent_dentry = cur_dentry;
473 if (cur_dentry == NULL) {
474 if (dentry_is_directory(parent_dentry))
483 wim_pathname_to_inode(WIMStruct *w, const mbchar *path)
485 struct wim_dentry *dentry;
486 dentry = get_dentry(w, path);
488 return dentry->d_inode;
493 /* Returns the dentry that corresponds to the parent directory of @path, or NULL
494 * if the dentry is not found. */
496 get_parent_dentry(WIMStruct *w, const mbchar *path)
498 size_t path_len = strlen(path);
499 mbchar buf[path_len + 1];
501 memcpy(buf, path, path_len + 1);
502 to_parent_name(buf, path_len);
503 return get_dentry(w, buf);
506 /* Prints the full path of a dentry. */
508 print_dentry_full_path(struct wim_dentry *dentry, void *ignore)
510 if (dentry->full_path)
511 puts(dentry->full_path);
515 /* We want to be able to show the names of the file attribute flags that are
517 struct file_attr_flag {
521 struct file_attr_flag file_attr_flags[] = {
522 {FILE_ATTRIBUTE_READONLY, "READONLY"},
523 {FILE_ATTRIBUTE_HIDDEN, "HIDDEN"},
524 {FILE_ATTRIBUTE_SYSTEM, "SYSTEM"},
525 {FILE_ATTRIBUTE_DIRECTORY, "DIRECTORY"},
526 {FILE_ATTRIBUTE_ARCHIVE, "ARCHIVE"},
527 {FILE_ATTRIBUTE_DEVICE, "DEVICE"},
528 {FILE_ATTRIBUTE_NORMAL, "NORMAL"},
529 {FILE_ATTRIBUTE_TEMPORARY, "TEMPORARY"},
530 {FILE_ATTRIBUTE_SPARSE_FILE, "SPARSE_FILE"},
531 {FILE_ATTRIBUTE_REPARSE_POINT, "REPARSE_POINT"},
532 {FILE_ATTRIBUTE_COMPRESSED, "COMPRESSED"},
533 {FILE_ATTRIBUTE_OFFLINE, "OFFLINE"},
534 {FILE_ATTRIBUTE_NOT_CONTENT_INDEXED,"NOT_CONTENT_INDEXED"},
535 {FILE_ATTRIBUTE_ENCRYPTED, "ENCRYPTED"},
536 {FILE_ATTRIBUTE_VIRTUAL, "VIRTUAL"},
539 /* Prints a directory entry. @lookup_table is a pointer to the lookup table, if
540 * available. If the dentry is unresolved and the lookup table is NULL, the
541 * lookup table entries will not be printed. Otherwise, they will be. */
543 print_dentry(struct wim_dentry *dentry, void *lookup_table)
546 struct wim_lookup_table_entry *lte;
547 const struct wim_inode *inode = dentry->d_inode;
550 printf("[DENTRY]\n");
551 printf("Length = %"PRIu64"\n", dentry->length);
552 printf("Attributes = 0x%x\n", inode->i_attributes);
553 for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++)
554 if (file_attr_flags[i].flag & inode->i_attributes)
555 printf(" FILE_ATTRIBUTE_%s is set\n",
556 file_attr_flags[i].name);
557 printf("Security ID = %d\n", inode->i_security_id);
558 printf("Subdir offset = %"PRIu64"\n", dentry->subdir_offset);
560 wim_timestamp_to_str(inode->i_creation_time, buf, sizeof(buf));
561 printf("Creation Time = %s\n", buf);
563 wim_timestamp_to_str(inode->i_last_access_time, buf, sizeof(buf));
564 printf("Last Access Time = %s\n", buf);
566 wim_timestamp_to_str(inode->i_last_write_time, buf, sizeof(buf));
567 printf("Last Write Time = %s\n", buf);
569 printf("Reparse Tag = 0x%"PRIx32"\n", inode->i_reparse_tag);
570 printf("Hard Link Group = 0x%"PRIx64"\n", inode->i_ino);
571 printf("Hard Link Group Size = %"PRIu32"\n", inode->i_nlink);
572 printf("Number of Alternate Data Streams = %hu\n", inode->i_num_ads);
573 if (dentry_has_long_name(dentry))
574 wimlib_printf("Filename = \"%W\"\n", dentry->file_name);
575 if (dentry_has_short_name(dentry))
576 wimlib_printf("Short Name \"%W\"\n", dentry->short_name);
577 if (dentry->full_path)
578 printf("Full Path = \"%s\"\n", dentry->full_path);
580 lte = inode_stream_lte(dentry->d_inode, 0, lookup_table);
582 print_lookup_table_entry(lte, stdout);
584 hash = inode_stream_hash(inode, 0);
592 for (u16 i = 0; i < inode->i_num_ads; i++) {
593 printf("[Alternate Stream Entry %u]\n", i);
594 wimlib_printf("Name = \"%W\"\n", inode->i_ads_entries[i].stream_name);
595 printf("Name Length (UTF16 bytes) = %hu\n",
596 inode->i_ads_entries[i].stream_name_nbytes);
597 hash = inode_stream_hash(inode, i + 1);
603 print_lookup_table_entry(inode_stream_lte(inode, i + 1, lookup_table),
609 /* Initializations done on every `struct wim_dentry'. */
611 dentry_common_init(struct wim_dentry *dentry)
613 memset(dentry, 0, sizeof(struct wim_dentry));
617 static struct wim_inode *
620 struct wim_inode *inode = CALLOC(1, sizeof(struct wim_inode));
622 inode->i_security_id = -1;
625 inode->i_next_stream_id = 1;
626 if (pthread_mutex_init(&inode->i_mutex, NULL) != 0) {
627 ERROR_WITH_ERRNO("Error initializing mutex");
632 INIT_LIST_HEAD(&inode->i_dentry);
637 static struct wim_inode *
640 struct wim_inode *inode = new_timeless_inode();
642 u64 now = get_wim_timestamp();
643 inode->i_creation_time = now;
644 inode->i_last_access_time = now;
645 inode->i_last_write_time = now;
650 /* Creates an unlinked directory entry. */
651 int new_dentry(const mbchar *name, struct wim_dentry **dentry_ret)
653 struct wim_dentry *dentry;
656 dentry = MALLOC(sizeof(struct wim_dentry));
658 return WIMLIB_ERR_NOMEM;
660 dentry_common_init(dentry);
661 ret = set_dentry_name(dentry, name);
663 dentry->parent = dentry;
664 *dentry_ret = dentry;
667 ERROR("Failed to set name on new dentry with name \"%s\"", name);
674 __new_dentry_with_inode(const mbchar *name, struct wim_dentry **dentry_ret,
677 struct wim_dentry *dentry;
680 ret = new_dentry(name, &dentry);
685 dentry->d_inode = new_timeless_inode();
687 dentry->d_inode = new_inode();
688 if (!dentry->d_inode) {
690 return WIMLIB_ERR_NOMEM;
693 inode_add_dentry(dentry, dentry->d_inode);
694 *dentry_ret = dentry;
699 new_dentry_with_timeless_inode(const mbchar *name, struct wim_dentry **dentry_ret)
701 return __new_dentry_with_inode(name, dentry_ret, true);
705 new_dentry_with_inode(const mbchar *name, struct wim_dentry **dentry_ret)
707 return __new_dentry_with_inode(name, dentry_ret, false);
712 init_ads_entry(struct wim_ads_entry *ads_entry, const void *name,
713 size_t name_nbytes, bool is_utf16le)
716 memset(ads_entry, 0, sizeof(*ads_entry));
719 utf16lechar *p = MALLOC(name_nbytes + sizeof(utf16lechar));
721 return WIMLIB_ERR_NOMEM;
722 memcpy(p, name, name_nbytes);
723 p[name_nbytes / 2] = 0;
724 ads_entry->stream_name = p;
725 ads_entry->stream_name_nbytes = name_nbytes;
727 if (name && *(const char*)name) {
728 ret = get_utf16le_name(name, &ads_entry->stream_name,
729 &ads_entry->stream_name_nbytes);
736 destroy_ads_entry(struct wim_ads_entry *ads_entry)
738 FREE(ads_entry->stream_name);
741 /* Frees an inode. */
742 void free_inode(struct wim_inode *inode)
745 if (inode->i_ads_entries) {
746 for (u16 i = 0; i < inode->i_num_ads; i++)
747 destroy_ads_entry(&inode->i_ads_entries[i]);
748 FREE(inode->i_ads_entries);
751 wimlib_assert(inode->i_num_opened_fds == 0);
753 pthread_mutex_destroy(&inode->i_mutex);
754 if (inode->i_hlist.pprev)
755 hlist_del(&inode->i_hlist);
757 FREE(inode->i_extracted_file);
762 /* Decrements link count on an inode and frees it if the link count reaches 0.
764 static void put_inode(struct wim_inode *inode)
766 wimlib_assert(inode->i_nlink != 0);
767 if (--inode->i_nlink == 0) {
769 if (inode->i_num_opened_fds == 0)
777 /* Frees a WIM dentry.
779 * The corresponding inode (if any) is freed only if its link count is
782 void free_dentry(struct wim_dentry *dentry)
784 FREE(dentry->file_name);
785 FREE(dentry->short_name);
786 FREE(dentry->full_path);
788 put_inode(dentry->d_inode);
792 void put_dentry(struct wim_dentry *dentry)
794 wimlib_assert(dentry->refcnt != 0);
795 if (--dentry->refcnt == 0)
799 /* This function is passed as an argument to for_dentry_in_tree_depth() in order
800 * to free a directory tree. */
801 static int do_free_dentry(struct wim_dentry *dentry, void *__lookup_table)
803 struct wim_lookup_table *lookup_table = __lookup_table;
807 struct wim_lookup_table_entry *lte;
808 struct wim_inode *inode = dentry->d_inode;
809 wimlib_assert(inode->i_nlink != 0);
810 for (i = 0; i <= inode->i_num_ads; i++) {
811 lte = inode_stream_lte(inode, i, lookup_table);
813 lte_decrement_refcnt(lte, lookup_table);
822 * Unlinks and frees a dentry tree.
824 * @root: The root of the tree.
825 * @lookup_table: The lookup table for dentries. If non-NULL, the
826 * reference counts in the lookup table for the lookup
827 * table entries corresponding to the dentries will be
830 void free_dentry_tree(struct wim_dentry *root, struct wim_lookup_table *lookup_table)
833 for_dentry_in_tree_depth(root, do_free_dentry, lookup_table);
836 int increment_dentry_refcnt(struct wim_dentry *dentry, void *ignore)
843 * Links a dentry into the directory tree.
845 * @parent: The dentry that will be the parent of @dentry.
846 * @dentry: The dentry to link.
849 dentry_add_child(struct wim_dentry * restrict parent,
850 struct wim_dentry * restrict child)
852 wimlib_assert(dentry_is_directory(parent));
854 struct rb_root *root = &parent->d_inode->i_children;
855 struct rb_node **new = &(root->rb_node);
856 struct rb_node *rb_parent = NULL;
859 struct wim_dentry *this = rbnode_dentry(*new);
860 int result = dentry_compare_names(child, this);
865 new = &((*new)->rb_left);
867 new = &((*new)->rb_right);
871 child->parent = parent;
872 rb_link_node(&child->rb_node, rb_parent, new);
873 rb_insert_color(&child->rb_node, root);
877 /* Unlink a WIM dentry from the directory entry tree. */
879 unlink_dentry(struct wim_dentry *dentry)
881 struct wim_dentry *parent = dentry->parent;
882 if (parent == dentry)
884 rb_erase(&dentry->rb_node, &parent->d_inode->i_children);
888 * Returns the alternate data stream entry belonging to @inode that has the
889 * stream name @stream_name.
891 struct wim_ads_entry *
892 inode_get_ads_entry(struct wim_inode *inode, const mbchar *stream_name,
895 if (inode->i_num_ads == 0) {
899 utf16lechar *stream_name_utf16le;
900 size_t stream_name_utf16le_nbytes;
902 struct wim_ads_entry *result;
904 ret = mbs_to_utf16le(stream_name, strlen(stream_name),
905 &stream_name_utf16le,
906 &stream_name_utf16le_nbytes);
913 if (ads_entry_has_name(&inode->i_ads_entries[i],
915 stream_name_utf16le_nbytes))
919 result = &inode->i_ads_entries[i];
922 } while (++i != inode->i_num_ads);
923 FREE(stream_name_utf16le);
928 static struct wim_ads_entry *
929 do_inode_add_ads(struct wim_inode *inode, const void *stream_name,
930 size_t stream_name_nbytes, bool is_utf16le)
933 struct wim_ads_entry *ads_entries;
934 struct wim_ads_entry *new_entry;
936 DEBUG("Add alternate data stream \"%s\"", stream_name);
938 if (inode->i_num_ads >= 0xfffe) {
939 ERROR("Too many alternate data streams in one inode!");
942 num_ads = inode->i_num_ads + 1;
943 ads_entries = REALLOC(inode->i_ads_entries,
944 num_ads * sizeof(inode->i_ads_entries[0]));
946 ERROR("Failed to allocate memory for new alternate data stream");
949 inode->i_ads_entries = ads_entries;
951 new_entry = &inode->i_ads_entries[num_ads - 1];
952 if (init_ads_entry(new_entry, stream_name, stream_name_nbytes, is_utf16le))
955 new_entry->stream_id = inode->i_next_stream_id++;
957 inode->i_num_ads = num_ads;
961 struct wim_ads_entry *
962 inode_add_ads_utf16le(struct wim_inode *inode,
963 const utf16lechar *stream_name,
964 size_t stream_name_nbytes)
966 return do_inode_add_ads(inode, stream_name, stream_name_nbytes, true);
970 * Add an alternate stream entry to a WIM inode and return a pointer to it, or
971 * NULL if memory could not be allocated.
973 struct wim_ads_entry *
974 inode_add_ads(struct wim_inode *inode, const char *stream_name)
976 return do_inode_add_ads(inode, stream_name, strlen(stream_name), false);
980 inode_add_ads_with_data(struct wim_inode *inode, const mbchar *name,
981 const void *value, size_t size,
982 struct wim_lookup_table *lookup_table)
984 int ret = WIMLIB_ERR_NOMEM;
985 struct wim_ads_entry *new_ads_entry;
986 struct wim_lookup_table_entry *existing_lte;
987 struct wim_lookup_table_entry *lte;
988 u8 value_hash[SHA1_HASH_SIZE];
990 wimlib_assert(inode->i_resolved);
991 new_ads_entry = inode_add_ads(inode, name);
994 sha1_buffer((const u8*)value, size, value_hash);
995 existing_lte = __lookup_resource(lookup_table, value_hash);
1001 lte = new_lookup_table_entry();
1003 goto out_remove_ads_entry;
1004 value_copy = MALLOC(size);
1007 goto out_remove_ads_entry;
1009 memcpy(value_copy, value, size);
1010 lte->resource_location = RESOURCE_IN_ATTACHED_BUFFER;
1011 lte->attached_buffer = value_copy;
1012 lte->resource_entry.original_size = size;
1013 lte->resource_entry.size = size;
1014 copy_hash(lte->hash, value_hash);
1015 lookup_table_insert(lookup_table, lte);
1017 new_ads_entry->lte = lte;
1020 out_remove_ads_entry:
1021 inode_remove_ads(inode, new_ads_entry - inode->i_ads_entries,
1027 /* Remove an alternate data stream from a WIM inode */
1029 inode_remove_ads(struct wim_inode *inode, u16 idx,
1030 struct wim_lookup_table *lookup_table)
1032 struct wim_ads_entry *ads_entry;
1033 struct wim_lookup_table_entry *lte;
1035 wimlib_assert(idx < inode->i_num_ads);
1036 wimlib_assert(inode->i_resolved);
1038 ads_entry = &inode->i_ads_entries[idx];
1040 DEBUG("Remove alternate data stream \"%W\"", ads_entry->stream_name);
1042 lte = ads_entry->lte;
1044 lte_decrement_refcnt(lte, lookup_table);
1046 destroy_ads_entry(ads_entry);
1048 memmove(&inode->i_ads_entries[idx],
1049 &inode->i_ads_entries[idx + 1],
1050 (inode->i_num_ads - idx - 1) * sizeof(inode->i_ads_entries[0]));
1056 inode_get_unix_data(const struct wim_inode *inode,
1057 struct wimlib_unix_data *unix_data,
1058 u16 *stream_idx_ret)
1060 const struct wim_ads_entry *ads_entry;
1061 const struct wim_lookup_table_entry *lte;
1065 wimlib_assert(inode->i_resolved);
1067 ads_entry = inode_get_ads_entry((struct wim_inode*)inode,
1068 WIMLIB_UNIX_DATA_TAG, NULL);
1070 return NO_UNIX_DATA;
1073 *stream_idx_ret = ads_entry - inode->i_ads_entries;
1075 lte = ads_entry->lte;
1077 return NO_UNIX_DATA;
1079 size = wim_resource_size(lte);
1080 if (size != sizeof(struct wimlib_unix_data))
1081 return BAD_UNIX_DATA;
1083 ret = read_full_wim_resource(lte, (u8*)unix_data, 0);
1087 if (unix_data->version != 0)
1088 return BAD_UNIX_DATA;
1093 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
1094 struct wim_lookup_table *lookup_table, int which)
1096 struct wimlib_unix_data unix_data;
1098 bool have_good_unix_data = false;
1099 bool have_unix_data = false;
1102 if (!(which & UNIX_DATA_CREATE)) {
1103 ret = inode_get_unix_data(inode, &unix_data, &stream_idx);
1104 if (ret == 0 || ret == BAD_UNIX_DATA || ret > 0)
1105 have_unix_data = true;
1107 have_good_unix_data = true;
1109 unix_data.version = 0;
1110 if (which & UNIX_DATA_UID || !have_good_unix_data)
1111 unix_data.uid = uid;
1112 if (which & UNIX_DATA_GID || !have_good_unix_data)
1113 unix_data.gid = gid;
1114 if (which & UNIX_DATA_MODE || !have_good_unix_data)
1115 unix_data.mode = mode;
1116 ret = inode_add_ads_with_data(inode, WIMLIB_UNIX_DATA_TAG,
1117 (const u8*)&unix_data,
1118 sizeof(struct wimlib_unix_data),
1120 if (ret == 0 && have_unix_data)
1121 inode_remove_ads(inode, stream_idx, lookup_table);
1124 #endif /* !__WIN32__ */
1127 * Reads the alternate data stream entries of a WIM dentry.
1129 * @p: Pointer to buffer that starts with the first alternate stream entry.
1131 * @inode: Inode to load the alternate data streams into.
1132 * @inode->i_num_ads must have been set to the number of
1133 * alternate data streams that are expected.
1135 * @remaining_size: Number of bytes of data remaining in the buffer pointed
1138 * The format of the on-disk alternate stream entries is as follows:
1140 * struct wim_ads_entry_on_disk {
1141 * u64 length; // Length of the entry, in bytes. This includes
1142 * all fields (including the stream name and
1143 * null terminator if present, AND the padding!).
1144 * u64 reserved; // Seems to be unused
1145 * u8 hash[20]; // SHA1 message digest of the uncompressed stream
1146 * u16 stream_name_len; // Length of the stream name, in bytes
1147 * char stream_name[]; // Stream name in UTF-16LE, @stream_name_len bytes long,
1148 * not including null terminator
1149 * u16 zero; // UTF-16 null terminator for the stream name, NOT
1150 * included in @stream_name_len. Based on what
1151 * I've observed from filenames in dentries,
1152 * this field should not exist when
1153 * (@stream_name_len == 0), but you can't
1154 * actually tell because of the padding anyway
1155 * (provided that the padding is zeroed, which
1156 * it always seems to be).
1157 * char padding[]; // Padding to make the size a multiple of 8 bytes.
1160 * In addition, the entries are 8-byte aligned.
1162 * Return 0 on success or nonzero on failure. On success, inode->i_ads_entries
1163 * is set to an array of `struct wim_ads_entry's of length inode->i_num_ads. On
1164 * failure, @inode is not modified.
1167 read_ads_entries(const u8 *p, struct wim_inode *inode, u64 remaining_size)
1170 struct wim_ads_entry *ads_entries;
1173 num_ads = inode->i_num_ads;
1174 ads_entries = CALLOC(num_ads, sizeof(inode->i_ads_entries[0]));
1176 ERROR("Could not allocate memory for %"PRIu16" "
1177 "alternate data stream entries", num_ads);
1178 return WIMLIB_ERR_NOMEM;
1181 for (u16 i = 0; i < num_ads; i++) {
1182 struct wim_ads_entry *cur_entry;
1184 u64 length_no_padding;
1186 const u8 *p_save = p;
1188 cur_entry = &ads_entries[i];
1191 ads_entries[i].stream_id = i + 1;
1194 /* Read the base stream entry, excluding the stream name. */
1195 if (remaining_size < WIM_ADS_ENTRY_DISK_SIZE) {
1196 ERROR("Stream entries go past end of metadata resource");
1197 ERROR("(remaining_size = %"PRIu64")", remaining_size);
1198 ret = WIMLIB_ERR_INVALID_DENTRY;
1199 goto out_free_ads_entries;
1202 p = get_u64(p, &length);
1203 p += 8; /* Skip the reserved field */
1204 p = get_bytes(p, SHA1_HASH_SIZE, cur_entry->hash);
1205 p = get_u16(p, &cur_entry->stream_name_nbytes);
1207 cur_entry->stream_name = NULL;
1209 /* Length including neither the null terminator nor the padding
1211 length_no_padding = WIM_ADS_ENTRY_DISK_SIZE +
1212 cur_entry->stream_name_nbytes;
1214 /* Length including the null terminator and the padding */
1215 total_length = ((length_no_padding + 2) + 7) & ~7;
1217 wimlib_assert(total_length == ads_entry_total_length(cur_entry));
1219 if (remaining_size < length_no_padding) {
1220 ERROR("Stream entries go past end of metadata resource");
1221 ERROR("(remaining_size = %"PRIu64" bytes, "
1222 "length_no_padding = %"PRIu64" bytes)",
1223 remaining_size, length_no_padding);
1224 ret = WIMLIB_ERR_INVALID_DENTRY;
1225 goto out_free_ads_entries;
1228 /* The @length field in the on-disk ADS entry is expected to be
1229 * equal to @total_length, which includes all of the entry and
1230 * the padding that follows it to align the next ADS entry to an
1231 * 8-byte boundary. However, to be safe, we'll accept the
1232 * length field as long as it's not less than the un-padded
1233 * total length and not more than the padded total length. */
1234 if (length < length_no_padding || length > total_length) {
1235 ERROR("Stream entry has unexpected length "
1236 "field (length field = %"PRIu64", "
1237 "unpadded total length = %"PRIu64", "
1238 "padded total length = %"PRIu64")",
1239 length, length_no_padding, total_length);
1240 ret = WIMLIB_ERR_INVALID_DENTRY;
1241 goto out_free_ads_entries;
1244 if (cur_entry->stream_name_nbytes) {
1245 cur_entry->stream_name = MALLOC(cur_entry->stream_name_nbytes + 2);
1246 if (!cur_entry->stream_name) {
1247 ret = WIMLIB_ERR_NOMEM;
1248 goto out_free_ads_entries;
1250 get_bytes(p, cur_entry->stream_name_nbytes,
1251 cur_entry->stream_name);
1252 cur_entry->stream_name[cur_entry->stream_name_nbytes / 2] = 0;
1254 /* It's expected that the size of every ADS entry is a multiple
1255 * of 8. However, to be safe, I'm allowing the possibility of
1256 * an ADS entry at the very end of the metadata resource ending
1257 * un-aligned. So although we still need to increment the input
1258 * pointer by @total_length to reach the next ADS entry, it's
1259 * possible that less than @total_length is actually remaining
1260 * in the metadata resource. We should set the remaining size to
1261 * 0 bytes if this happens. */
1262 p = p_save + total_length;
1263 if (remaining_size < total_length)
1266 remaining_size -= total_length;
1268 inode->i_ads_entries = ads_entries;
1270 inode->i_next_stream_id = inode->i_num_ads + 1;
1273 out_free_ads_entries:
1274 for (u16 i = 0; i < num_ads; i++)
1275 destroy_ads_entry(&ads_entries[i]);
1281 * Reads a WIM directory entry, including all alternate data stream entries that
1282 * follow it, from the WIM image's metadata resource.
1284 * @metadata_resource: Buffer containing the uncompressed metadata resource.
1285 * @metadata_resource_len: Length of the metadata resource.
1286 * @offset: Offset of this directory entry in the metadata resource.
1287 * @dentry: A `struct wim_dentry' that will be filled in by this function.
1289 * Return 0 on success or nonzero on failure. On failure, @dentry will have
1290 * been modified, but it will not be left with pointers to any allocated
1291 * buffers. On success, the dentry->length field must be examined. If zero,
1292 * this was a special "end of directory" dentry and not a real dentry. If
1293 * nonzero, this was a real dentry.
1296 read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
1297 u64 offset, struct wim_dentry *dentry)
1300 u64 calculated_size;
1301 utf16lechar *file_name = NULL;
1302 utf16lechar *short_name = NULL;
1303 u16 short_name_nbytes;
1304 u16 file_name_nbytes;
1306 struct wim_inode *inode = NULL;
1308 dentry_common_init(dentry);
1310 /*Make sure the dentry really fits into the metadata resource.*/
1311 if (offset + 8 > metadata_resource_len || offset + 8 < offset) {
1312 ERROR("Directory entry starting at %"PRIu64" ends past the "
1313 "end of the metadata resource (size %"PRIu64")",
1314 offset, metadata_resource_len);
1315 return WIMLIB_ERR_INVALID_DENTRY;
1318 /* Before reading the whole dentry, we need to read just the length.
1319 * This is because a dentry of length 8 (that is, just the length field)
1320 * terminates the list of sibling directory entries. */
1322 p = get_u64(&metadata_resource[offset], &dentry->length);
1324 /* A zero length field (really a length of 8, since that's how big the
1325 * directory entry is...) indicates that this is the end of directory
1326 * dentry. We do not read it into memory as an actual dentry, so just
1327 * return successfully in that case. */
1328 if (dentry->length == 0)
1331 /* If the dentry does not overflow the metadata resource buffer and is
1332 * not too short, read the rest of it (excluding the alternate data
1333 * streams, but including the file name and short name variable-length
1334 * fields) into memory. */
1335 if (offset + dentry->length >= metadata_resource_len
1336 || offset + dentry->length < offset)
1338 ERROR("Directory entry at offset %"PRIu64" and with size "
1339 "%"PRIu64" ends past the end of the metadata resource "
1341 offset, dentry->length, metadata_resource_len);
1342 return WIMLIB_ERR_INVALID_DENTRY;
1345 if (dentry->length < WIM_DENTRY_DISK_SIZE) {
1346 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
1348 return WIMLIB_ERR_INVALID_DENTRY;
1351 inode = new_timeless_inode();
1353 return WIMLIB_ERR_NOMEM;
1355 p = get_u32(p, &inode->i_attributes);
1356 p = get_u32(p, (u32*)&inode->i_security_id);
1357 p = get_u64(p, &dentry->subdir_offset);
1359 /* 2 unused fields */
1360 p += 2 * sizeof(u64);
1361 /*p = get_u64(p, &dentry->unused1);*/
1362 /*p = get_u64(p, &dentry->unused2);*/
1364 p = get_u64(p, &inode->i_creation_time);
1365 p = get_u64(p, &inode->i_last_access_time);
1366 p = get_u64(p, &inode->i_last_write_time);
1368 p = get_bytes(p, SHA1_HASH_SIZE, inode->i_hash);
1371 * I don't know what's going on here. It seems like M$ screwed up the
1372 * reparse points, then put the fields in the same place and didn't
1373 * document it. The WIM_HDR_FLAG_RP_FIX flag in the WIM header might
1374 * have something to do with this, but it's not documented.
1376 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1379 p = get_u32(p, &inode->i_reparse_tag);
1382 p = get_u32(p, &inode->i_reparse_tag);
1383 p = get_u64(p, &inode->i_ino);
1386 /* By the way, the reparse_reserved field does not actually exist (at
1387 * least when the file is not a reparse point) */
1389 p = get_u16(p, &inode->i_num_ads);
1391 p = get_u16(p, &short_name_nbytes);
1392 p = get_u16(p, &file_name_nbytes);
1394 /* We now know the length of the file name and short name. Make sure
1395 * the length of the dentry is large enough to actually hold them.
1397 * The calculated length here is unaligned to allow for the possibility
1398 * that the dentry->length names an unaligned length, although this
1399 * would be unexpected. */
1400 calculated_size = __dentry_correct_length_unaligned(file_name_nbytes,
1403 if (dentry->length < calculated_size) {
1404 ERROR("Unexpected end of directory entry! (Expected "
1405 "at least %"PRIu64" bytes, got %"PRIu64" bytes. "
1406 "short_name_nbytes = %hu, file_name_nbytes = %hu)",
1407 calculated_size, dentry->length,
1408 short_name_nbytes, file_name_nbytes);
1409 ret = WIMLIB_ERR_INVALID_DENTRY;
1410 goto out_free_inode;
1413 /* Read the filename if present. Note: if the filename is empty, there
1414 * is no null terminator following it. */
1415 if (file_name_nbytes) {
1416 file_name = MALLOC(file_name_nbytes + 2);
1418 ERROR("Failed to allocate %d bytes for dentry file name",
1419 file_name_nbytes + 2);
1420 ret = WIMLIB_ERR_NOMEM;
1421 goto out_free_inode;
1423 p = get_bytes(p, file_name_nbytes + 2, file_name);
1424 if (file_name[file_name_nbytes / 2] != 0) {
1425 file_name[file_name_nbytes / 2] = 0;
1426 WARNING("File name in WIM dentry \"%W\" is not "
1427 "null-terminated!", file_name);
1431 /* Align the calculated size */
1432 calculated_size = (calculated_size + 7) & ~7;
1434 if (dentry->length > calculated_size) {
1435 /* Weird; the dentry says it's longer than it should be. Note
1436 * that the length field does NOT include the size of the
1437 * alternate stream entries. */
1439 /* Strangely, some directory entries inexplicably have a little
1440 * over 70 bytes of extra data. The exact amount of data seems
1441 * to be 72 bytes, but it is aligned on the next 8-byte
1442 * boundary. It does NOT seem to be alternate data stream
1443 * entries. Here's an example of the aligned data:
1445 * 01000000 40000000 6c786bba c58ede11 b0bb0026 1870892a b6adb76f
1446 * e63a3e46 8fca8653 0d2effa1 6c786bba c58ede11 b0bb0026 1870892a
1447 * 00000000 00000000 00000000 00000000
1449 * Here's one interpretation of how the data is laid out.
1452 * u32 field1; (always 0x00000001)
1453 * u32 field2; (always 0x40000000)
1454 * u8 data[48]; (???)
1455 * u64 reserved1; (always 0)
1456 * u64 reserved2; (always 0)
1458 /*DEBUG("Dentry for file or directory `%s' has %"PRIu64" extra "*/
1459 /*"bytes of data",*/
1460 /*file_name_utf8, dentry->length - calculated_size);*/
1463 /* Read the short filename if present. Note: if there is no short
1464 * filename, there is no null terminator following it. */
1465 if (short_name_nbytes) {
1466 short_name = MALLOC(short_name_nbytes + 2);
1468 ERROR("Failed to allocate %d bytes for dentry short name",
1469 short_name_nbytes + 2);
1470 ret = WIMLIB_ERR_NOMEM;
1471 goto out_free_file_name;
1473 p = get_bytes(p, short_name_nbytes + 2, short_name);
1474 if (short_name[short_name_nbytes / 2] != 0) {
1475 short_name[short_name_nbytes / 2] = 0;
1476 WARNING("Short name in WIM dentry \"%W\" is not "
1477 "null-terminated!", file_name);
1482 * Read the alternate data streams, if present. dentry->num_ads tells
1483 * us how many they are, and they will directly follow the dentry
1486 * Note that each alternate data stream entry begins on an 8-byte
1487 * aligned boundary, and the alternate data stream entries are NOT
1488 * included in the dentry->length field for some reason.
1490 if (inode->i_num_ads != 0) {
1492 /* Trying different lengths is just a hack to make sure we have
1493 * a chance of reading the ADS entries correctly despite the
1494 * poor documentation. */
1496 if (calculated_size != dentry->length) {
1497 WARNING("Trying calculated dentry length (%"PRIu64") "
1498 "instead of dentry->length field (%"PRIu64") "
1499 "to read ADS entries",
1500 calculated_size, dentry->length);
1502 u64 lengths_to_try[3] = {calculated_size,
1503 (dentry->length + 7) & ~7,
1505 ret = WIMLIB_ERR_INVALID_DENTRY;
1506 for (size_t i = 0; i < ARRAY_LEN(lengths_to_try); i++) {
1507 if (lengths_to_try[i] > metadata_resource_len - offset)
1509 ret = read_ads_entries(&metadata_resource[offset + lengths_to_try[i]],
1511 metadata_resource_len - offset - lengths_to_try[i]);
1515 ERROR("Failed to read alternate data stream "
1516 "entries of WIM dentry \"%W\"", file_name);
1517 goto out_free_short_name;
1520 /* We've read all the data for this dentry. Set the names and their
1521 * lengths, and we've done. */
1522 dentry->d_inode = inode;
1523 dentry->file_name = file_name;
1524 dentry->short_name = short_name;
1525 dentry->file_name_nbytes = file_name_nbytes;
1526 dentry->short_name_nbytes = short_name_nbytes;
1528 out_free_short_name:
1537 /* Reads the children of a dentry, and all their children, ..., etc. from the
1538 * metadata resource and into the dentry tree.
1540 * @metadata_resource: An array that contains the uncompressed metadata
1541 * resource for the WIM file.
1543 * @metadata_resource_len: The length of the uncompressed metadata resource, in
1546 * @dentry: A pointer to a `struct wim_dentry' that is the root of the directory
1547 * tree and has already been read from the metadata resource. It
1548 * does not need to be the real root because this procedure is
1549 * called recursively.
1551 * Returns zero on success; nonzero on failure.
1554 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
1555 struct wim_dentry *dentry)
1557 u64 cur_offset = dentry->subdir_offset;
1558 struct wim_dentry *child;
1559 struct wim_dentry cur_child;
1563 * If @dentry has no child dentries, nothing more needs to be done for
1564 * this branch. This is the case for regular files, symbolic links, and
1565 * *possibly* empty directories (although an empty directory may also
1566 * have one child dentry that is the special end-of-directory dentry)
1568 if (cur_offset == 0)
1571 /* Find and read all the children of @dentry. */
1574 /* Read next child of @dentry into @cur_child. */
1575 ret = read_dentry(metadata_resource, metadata_resource_len,
1576 cur_offset, &cur_child);
1580 /* Check for end of directory. */
1581 if (cur_child.length == 0)
1584 /* Not end of directory. Allocate this child permanently and
1585 * link it to the parent and previous child. */
1586 child = MALLOC(sizeof(struct wim_dentry));
1588 ERROR("Failed to allocate %zu bytes for new dentry",
1589 sizeof(struct wim_dentry));
1590 ret = WIMLIB_ERR_NOMEM;
1593 memcpy(child, &cur_child, sizeof(struct wim_dentry));
1594 dentry_add_child(dentry, child);
1595 inode_add_dentry(child, child->d_inode);
1597 /* If there are children of this child, call this procedure
1599 if (child->subdir_offset != 0) {
1600 ret = read_dentry_tree(metadata_resource,
1601 metadata_resource_len, child);
1606 /* Advance to the offset of the next child. Note: We need to
1607 * advance by the TOTAL length of the dentry, not by the length
1608 * child->length, which although it does take into account the
1609 * padding, it DOES NOT take into account alternate stream
1611 cur_offset += dentry_total_length(child);
1617 * Writes a WIM dentry to an output buffer.
1619 * @dentry: The dentry structure.
1620 * @p: The memory location to write the data to.
1621 * @return: Pointer to the byte after the last byte we wrote as part of the
1625 write_dentry(const struct wim_dentry *dentry, u8 *p)
1629 const struct wim_inode *inode = dentry->d_inode;
1631 /* We calculate the correct length of the dentry ourselves because the
1632 * dentry->length field may been set to an unexpected value from when we
1633 * read the dentry in (for example, there may have been unknown data
1634 * appended to the end of the dentry...) */
1635 u64 length = dentry_correct_length(dentry);
1637 p = put_u64(p, length);
1638 p = put_u32(p, inode->i_attributes);
1639 p = put_u32(p, inode->i_security_id);
1640 p = put_u64(p, dentry->subdir_offset);
1641 p = put_u64(p, 0); /* unused1 */
1642 p = put_u64(p, 0); /* unused2 */
1643 p = put_u64(p, inode->i_creation_time);
1644 p = put_u64(p, inode->i_last_access_time);
1645 p = put_u64(p, inode->i_last_write_time);
1646 hash = inode_stream_hash(inode, 0);
1647 p = put_bytes(p, SHA1_HASH_SIZE, hash);
1648 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1649 p = put_zeroes(p, 4);
1650 p = put_u32(p, inode->i_reparse_tag);
1651 p = put_zeroes(p, 4);
1655 if (inode->i_nlink == 1)
1658 link_group_id = inode->i_ino;
1659 p = put_u64(p, link_group_id);
1661 p = put_u16(p, inode->i_num_ads);
1662 p = put_u16(p, dentry->short_name_nbytes);
1663 p = put_u16(p, dentry->file_name_nbytes);
1664 if (dentry_has_long_name(dentry)) {
1665 p = put_bytes(p, dentry->file_name_nbytes + 2,
1668 if (dentry_has_short_name(dentry)) {
1669 p = put_bytes(p, dentry->short_name_nbytes + 2,
1670 dentry->short_name);
1673 /* Align to 8-byte boundary */
1674 wimlib_assert(length >= (p - orig_p) && length - (p - orig_p) <= 7);
1675 p = put_zeroes(p, length - (p - orig_p));
1677 /* Write the alternate data streams, if there are any. Please see
1678 * read_ads_entries() for comments about the format of the on-disk
1679 * alternate data stream entries. */
1680 for (u16 i = 0; i < inode->i_num_ads; i++) {
1681 p = put_u64(p, ads_entry_total_length(&inode->i_ads_entries[i]));
1682 p = put_u64(p, 0); /* Unused */
1683 hash = inode_stream_hash(inode, i + 1);
1684 p = put_bytes(p, SHA1_HASH_SIZE, hash);
1685 p = put_u16(p, inode->i_ads_entries[i].stream_name_nbytes);
1686 if (inode->i_ads_entries[i].stream_name_nbytes) {
1688 inode->i_ads_entries[i].stream_name_nbytes + 2,
1689 inode->i_ads_entries[i].stream_name);
1691 p = put_zeroes(p, (8 - (p - orig_p) % 8) % 8);
1693 wimlib_assert(p - orig_p == __dentry_total_length(dentry, length));
1698 write_dentry_cb(struct wim_dentry *dentry, void *_p)
1701 *p = write_dentry(dentry, *p);
1706 write_dentry_tree_recursive(const struct wim_dentry *parent, u8 *p);
1709 write_dentry_tree_recursive_cb(struct wim_dentry *dentry, void *_p)
1712 *p = write_dentry_tree_recursive(dentry, *p);
1716 /* Recursive function that writes a dentry tree rooted at @parent, not including
1717 * @parent itself, which has already been written. */
1719 write_dentry_tree_recursive(const struct wim_dentry *parent, u8 *p)
1721 /* Nothing to do if this dentry has no children. */
1722 if (parent->subdir_offset == 0)
1725 /* Write child dentries and end-of-directory entry.
1727 * Note: we need to write all of this dentry's children before
1728 * recursively writing the directory trees rooted at each of the child
1729 * dentries, since the on-disk dentries for a dentry's children are
1730 * always located at consecutive positions in the metadata resource! */
1731 for_dentry_child(parent, write_dentry_cb, &p);
1733 /* write end of directory entry */
1736 /* Recurse on children. */
1737 for_dentry_child(parent, write_dentry_tree_recursive_cb, &p);
1741 /* Writes a directory tree to the metadata resource.
1743 * @root: Root of the dentry tree.
1744 * @p: Pointer to a buffer with enough space for the dentry tree.
1746 * Returns pointer to the byte after the last byte we wrote.
1749 write_dentry_tree(const struct wim_dentry *root, u8 *p)
1751 DEBUG("Writing dentry tree.");
1752 wimlib_assert(dentry_is_root(root));
1754 /* If we're the root dentry, we have no parent that already
1755 * wrote us, so we need to write ourselves. */
1756 p = write_dentry(root, p);
1758 /* Write end of directory entry after the root dentry just to be safe;
1759 * however the root dentry obviously cannot have any siblings. */
1762 /* Recursively write the rest of the dentry tree. */
1763 return write_dentry_tree_recursive(root, p);