4 * A dentry (directory entry) contains the metadata for a file. In the WIM file
5 * format, the dentries are stored in the "metadata resource" section right
6 * after the security data. Each image in the WIM file has its own metadata
7 * resource with its own security data and dentry tree. Dentries in different
8 * images may share file resources by referring to the same lookup table
14 * Copyright (C) 2010 Carl Thijssen
15 * Copyright (C) 2012 Eric Biggers
17 * This file is part of wimlib, a library for working with WIM files.
19 * wimlib is free software; you can redistribute it and/or modify it under the
20 * terms of the GNU Lesser General Public License as published by the Free
21 * Software Foundation; either version 2.1 of the License, or (at your option)
24 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
25 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
26 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
29 * You should have received a copy of the GNU Lesser General Public License
30 * along with wimlib; if not, see http://www.gnu.org/licenses/.
38 #include "wimlib_internal.h"
41 #include "timestamp.h"
42 #include "lookup_table.h"
46 * Returns true if @dentry has the UTF-8 file name @name that has length
49 static bool dentry_has_name(const struct dentry *dentry, const char *name,
52 if (dentry->file_name_utf8_len != name_len)
54 return memcmp(dentry->file_name_utf8, name, name_len) == 0;
57 /* Real length of a dentry, including the alternate data stream entries, which
58 * are not included in the dentry->length field... */
59 u64 dentry_total_length(const struct dentry *dentry)
61 u64 length = (dentry->length + 7) & ~7;
62 for (u16 i = 0; i < dentry->num_ads; i++)
63 length += ads_entry_length(&dentry->ads_entries[i]);
67 /* Transfers file attributes from a `stat' buffer to a struct dentry. */
68 void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry)
70 if (S_ISLNK(stbuf->st_mode)) {
71 dentry->attributes = FILE_ATTRIBUTE_REPARSE_POINT;
72 dentry->reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
73 } else if (S_ISDIR(stbuf->st_mode)) {
74 dentry->attributes = FILE_ATTRIBUTE_DIRECTORY;
76 dentry->attributes = FILE_ATTRIBUTE_NORMAL;
78 if (sizeof(ino_t) >= 8)
79 dentry->hard_link = (u64)stbuf->st_ino;
81 dentry->hard_link = (u64)stbuf->st_ino |
82 ((u64)stbuf->st_dev << (sizeof(ino_t) * 8));
84 dentry->creation_time = timespec_to_wim_timestamp(&stbuf->st_mtim);
85 dentry->last_write_time = timespec_to_wim_timestamp(&stbuf->st_mtim);
86 dentry->last_access_time = timespec_to_wim_timestamp(&stbuf->st_atim);
90 /* Makes all timestamp fields for the dentry be the current time. */
91 void dentry_update_all_timestamps(struct dentry *dentry)
93 u64 now = get_wim_timestamp();
94 dentry->creation_time = now;
95 dentry->last_access_time = now;
96 dentry->last_write_time = now;
99 struct ads_entry *dentry_get_ads_entry(struct dentry *dentry,
100 const char *stream_name)
102 size_t stream_name_len;
105 if (dentry->num_ads) {
107 stream_name_len = strlen(stream_name);
109 if (ads_entry_has_name(&dentry->ads_entries[i],
110 stream_name, stream_name_len))
111 return &dentry->ads_entries[i];
112 } while (++i != dentry->num_ads);
117 static void ads_entry_init(struct ads_entry *ads_entry)
119 memset(ads_entry, 0, sizeof(struct ads_entry));
120 INIT_LIST_HEAD(&ads_entry->lte_group_list.list);
121 ads_entry->lte_group_list.type = STREAM_TYPE_ADS;
124 /* Add an alternate stream entry to a dentry and return a pointer to it, or NULL
126 struct ads_entry *dentry_add_ads(struct dentry *dentry, const char *stream_name)
129 struct ads_entry *ads_entries;
130 struct ads_entry *new_entry;
132 DEBUG("Add alternate data stream %s:%s",
133 dentry->file_name_utf8, stream_name);
135 if (dentry->num_ads == 0xffff)
137 num_ads = dentry->num_ads + 1;
138 ads_entries = REALLOC(dentry->ads_entries,
139 num_ads * sizeof(struct ads_entry));
142 if (ads_entries != dentry->ads_entries) {
143 /* We moved the ADS entries. Adjust the stream lists. */
144 for (u16 i = 0; i < dentry->num_ads; i++) {
145 struct list_head *cur = &ads_entries[i].lte_group_list.list;
146 cur->prev->next = cur;
147 cur->next->prev = cur;
151 new_entry = &ads_entries[num_ads - 1];
152 ads_entry_init(new_entry);
153 if (change_ads_name(new_entry, stream_name) != 0)
155 dentry->ads_entries = ads_entries;
156 dentry->num_ads = num_ads;
160 void dentry_remove_ads(struct dentry *dentry, struct ads_entry *ads_entry)
165 wimlib_assert(dentry->num_ads);
166 idx = ads_entry - dentry->ads_entries;
167 wimlib_assert(idx < dentry->num_ads);
168 following = dentry->num_ads - idx - 1;
170 destroy_ads_entry(ads_entry);
171 memcpy(ads_entry, ads_entry + 1, following * sizeof(struct ads_entry));
173 /* We moved the ADS entries. Adjust the stream lists. */
174 for (u16 i = 0; i < following; i++) {
175 struct list_head *cur = &ads_entry[i].lte_group_list.list;
176 cur->prev->next = cur;
177 cur->next->prev = cur;
184 * Calls a function on all directory entries in a directory tree. It is called
185 * on a parent before its children.
187 int for_dentry_in_tree(struct dentry *root,
188 int (*visitor)(struct dentry*, void*), void *arg)
191 struct dentry *child;
193 ret = visitor(root, arg);
198 child = root->children;
204 ret = for_dentry_in_tree(child, visitor, arg);
208 } while (child != root->children);
213 * Like for_dentry_in_tree(), but the visitor function is always called on a
214 * dentry's children before on itself.
216 int for_dentry_in_tree_depth(struct dentry *root,
217 int (*visitor)(struct dentry*, void*), void *arg)
220 struct dentry *child;
223 child = root->children;
227 ret = for_dentry_in_tree_depth(child, visitor, arg);
231 } while (child != root->children);
233 return visitor(root, arg);
237 * Calculate the full path of @dentry, based on its parent's full path and on
238 * its UTF-8 file name.
240 int calculate_dentry_full_path(struct dentry *dentry, void *ignore)
244 if (dentry_is_root(dentry)) {
245 full_path = MALLOC(2);
252 char *parent_full_path;
253 u32 parent_full_path_len;
254 const struct dentry *parent = dentry->parent;
256 if (dentry_is_root(parent)) {
257 parent_full_path = "";
258 parent_full_path_len = 0;
260 parent_full_path = parent->full_path_utf8;
261 parent_full_path_len = parent->full_path_utf8_len;
264 full_path_len = parent_full_path_len + 1 +
265 dentry->file_name_utf8_len;
266 full_path = MALLOC(full_path_len + 1);
270 memcpy(full_path, parent_full_path, parent_full_path_len);
271 full_path[parent_full_path_len] = '/';
272 memcpy(full_path + parent_full_path_len + 1,
273 dentry->file_name_utf8,
274 dentry->file_name_utf8_len);
275 full_path[full_path_len] = '\0';
277 FREE(dentry->full_path_utf8);
278 dentry->full_path_utf8 = full_path;
279 dentry->full_path_utf8_len = full_path_len;
282 ERROR("Out of memory while calculating dentry full path");
283 return WIMLIB_ERR_NOMEM;
287 * Recursively calculates the subdir offsets for a directory tree.
289 * @dentry: The root of the directory tree.
290 * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory
291 * offset for @dentry.
293 void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p)
295 struct dentry *child;
297 child = dentry->children;
298 dentry->subdir_offset = *subdir_offset_p;
301 /* Advance the subdir offset by the amount of space the children
302 * of this dentry take up. */
304 *subdir_offset_p += dentry_total_length(child);
306 } while (child != dentry->children);
308 /* End-of-directory dentry on disk. */
309 *subdir_offset_p += 8;
311 /* Recursively call calculate_subdir_offsets() on all the
314 calculate_subdir_offsets(child, subdir_offset_p);
316 } while (child != dentry->children);
318 /* On disk, childless directories have a valid subdir_offset
319 * that points to an 8-byte end-of-directory dentry. Regular
320 * files have a subdir_offset of 0. */
321 if (dentry_is_directory(dentry))
322 *subdir_offset_p += 8;
324 dentry->subdir_offset = 0;
329 /* Returns the child of @dentry that has the file name @name.
330 * Returns NULL if no child has the name. */
331 struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
334 struct dentry *child;
337 child = dentry->children;
339 name_len = strlen(name);
341 if (dentry_has_name(child, name, name_len))
344 } while (child != dentry->children);
349 /* Retrieves the dentry that has the UTF-8 @path relative to the dentry
350 * @cur_dir. Returns NULL if no dentry having the path is found. */
351 static struct dentry *get_dentry_relative_path(struct dentry *cur_dir, const char *path)
353 struct dentry *child;
355 const char *new_path;
360 child = cur_dir->children;
362 new_path = path_next_part(path, &base_len);
364 if (dentry_has_name(child, path, base_len))
365 return get_dentry_relative_path(child, new_path);
367 } while (child != cur_dir->children);
372 /* Returns the dentry corresponding to the UTF-8 @path, or NULL if there is no
374 struct dentry *get_dentry(WIMStruct *w, const char *path)
376 struct dentry *root = wim_root_dentry(w);
379 return get_dentry_relative_path(root, path);
382 /* Returns the parent directory for the @path. */
383 struct dentry *get_parent_dentry(WIMStruct *w, const char *path)
385 size_t path_len = strlen(path);
386 char buf[path_len + 1];
388 memcpy(buf, path, path_len + 1);
390 to_parent_name(buf, path_len);
392 return get_dentry(w, buf);
395 /* Prints the full path of a dentry. */
396 int print_dentry_full_path(struct dentry *dentry, void *ignore)
398 if (dentry->full_path_utf8)
399 puts(dentry->full_path_utf8);
403 struct file_attr_flag {
407 struct file_attr_flag file_attr_flags[] = {
408 {FILE_ATTRIBUTE_READONLY, "READONLY"},
409 {FILE_ATTRIBUTE_HIDDEN, "HIDDEN"},
410 {FILE_ATTRIBUTE_SYSTEM, "SYSTEM"},
411 {FILE_ATTRIBUTE_DIRECTORY, "DIRECTORY"},
412 {FILE_ATTRIBUTE_ARCHIVE, "ARCHIVE"},
413 {FILE_ATTRIBUTE_DEVICE, "DEVICE"},
414 {FILE_ATTRIBUTE_NORMAL, "NORMAL"},
415 {FILE_ATTRIBUTE_TEMPORARY, "TEMPORARY"},
416 {FILE_ATTRIBUTE_SPARSE_FILE, "SPARSE_FILE"},
417 {FILE_ATTRIBUTE_REPARSE_POINT, "REPARSE_POINT"},
418 {FILE_ATTRIBUTE_COMPRESSED, "COMPRESSED"},
419 {FILE_ATTRIBUTE_OFFLINE, "OFFLINE"},
420 {FILE_ATTRIBUTE_NOT_CONTENT_INDEXED,"NOT_CONTENT_INDEXED"},
421 {FILE_ATTRIBUTE_ENCRYPTED, "ENCRYPTED"},
422 {FILE_ATTRIBUTE_VIRTUAL, "VIRTUAL"},
425 /* Prints a directory entry. @lookup_table is a pointer to the lookup table, or
426 * NULL if the resource entry for the dentry is not to be printed. */
427 int print_dentry(struct dentry *dentry, void *lookup_table)
430 struct lookup_table_entry *lte;
432 printf("[DENTRY]\n");
433 printf("Length = %"PRIu64"\n", dentry->length);
434 printf("Attributes = 0x%x\n", dentry->attributes);
435 for (unsigned i = 0; i < ARRAY_LEN(file_attr_flags); i++)
436 if (file_attr_flags[i].flag & dentry->attributes)
437 printf(" FILE_ATTRIBUTE_%s is set\n",
438 file_attr_flags[i].name);
439 printf("Security ID = %d\n", dentry->security_id);
440 printf("Subdir offset = %"PRIu64"\n", dentry->subdir_offset);
442 printf("Unused1 = 0x%"PRIu64"\n", dentry->unused1);
443 printf("Unused2 = %"PRIu64"\n", dentry->unused2);
446 printf("Creation Time = 0x%"PRIx64"\n");
447 printf("Last Access Time = 0x%"PRIx64"\n");
448 printf("Last Write Time = 0x%"PRIx64"\n");
451 time_t creat_time = wim_timestamp_to_unix(dentry->creation_time);
452 time_t access_time = wim_timestamp_to_unix(dentry->last_access_time);
453 time_t mod_time = wim_timestamp_to_unix(dentry->last_write_time);
454 printf("Creation Time = %s", asctime(localtime(&creat_time)));
455 printf("Last Access Time = %s", asctime(localtime(&access_time)));
456 printf("Last Write Time = %s", asctime(localtime(&mod_time)));
458 printf("Reparse Tag = 0x%"PRIx32"\n", dentry->reparse_tag);
459 printf("Hard Link Group = 0x%"PRIx64"\n", dentry->hard_link);
460 printf("Number of Alternate Data Streams = %hu\n", dentry->num_ads);
461 printf("Filename = \"");
462 print_string(dentry->file_name, dentry->file_name_len);
464 printf("Filename Length = %hu\n", dentry->file_name_len);
465 printf("Filename (UTF-8) = \"%s\"\n", dentry->file_name_utf8);
466 printf("Filename (UTF-8) Length = %hu\n", dentry->file_name_utf8_len);
467 printf("Short Name = \"");
468 print_string(dentry->short_name, dentry->short_name_len);
470 printf("Short Name Length = %hu\n", dentry->short_name_len);
471 printf("Full Path (UTF-8) = \"%s\"\n", dentry->full_path_utf8);
472 lte = dentry_stream_lte(dentry, 0, lookup_table);
474 print_lookup_table_entry(lte);
476 hash = dentry_stream_hash(dentry, 0);
484 for (u16 i = 0; i < dentry->num_ads; i++) {
485 printf("[Alternate Stream Entry %u]\n", i);
486 printf("Name = \"%s\"\n", dentry->ads_entries[i].stream_name_utf8);
487 printf("Name Length (UTF-16) = %u\n",
488 dentry->ads_entries[i].stream_name_len);
489 hash = dentry_stream_hash(dentry, i + 1);
495 print_lookup_table_entry(dentry_stream_lte(dentry, i + 1,
501 static inline void dentry_common_init(struct dentry *dentry)
503 memset(dentry, 0, sizeof(struct dentry));
505 dentry->security_id = -1;
506 dentry->ads_entries_status = ADS_ENTRIES_DEFAULT;
507 dentry->lte_group_list.type = STREAM_TYPE_NORMAL;
511 * Creates an unlinked directory entry.
513 * @name: The base name of the new dentry.
514 * @return: A pointer to the new dentry, or NULL if out of memory.
516 struct dentry *new_dentry(const char *name)
518 struct dentry *dentry;
520 dentry = MALLOC(sizeof(struct dentry));
524 dentry_common_init(dentry);
525 if (change_dentry_name(dentry, name) != 0)
528 dentry_update_all_timestamps(dentry);
529 dentry->next = dentry;
530 dentry->prev = dentry;
531 dentry->parent = dentry;
532 INIT_LIST_HEAD(&dentry->link_group_list);
536 ERROR("Failed to allocate new dentry");
540 void dentry_free_ads_entries(struct dentry *dentry)
542 for (u16 i = 0; i < dentry->num_ads; i++)
543 destroy_ads_entry(&dentry->ads_entries[i]);
544 FREE(dentry->ads_entries);
545 dentry->ads_entries = NULL;
549 static void __destroy_dentry(struct dentry *dentry)
551 FREE(dentry->file_name);
552 FREE(dentry->file_name_utf8);
553 FREE(dentry->short_name);
554 FREE(dentry->full_path_utf8);
555 FREE(dentry->extracted_file);
558 void free_dentry(struct dentry *dentry)
560 wimlib_assert(dentry);
561 __destroy_dentry(dentry);
562 if (dentry->ads_entries_status != ADS_ENTRIES_USER)
563 dentry_free_ads_entries(dentry);
567 /* Like free_dentry(), but assigns a new ADS entries owner if this dentry was
568 * the previous owner, and also deletes the dentry from its link_group_list */
569 void put_dentry(struct dentry *dentry)
571 if (dentry->ads_entries_status == ADS_ENTRIES_OWNER) {
572 struct dentry *new_owner;
573 list_for_each_entry(new_owner, &dentry->link_group_list,
576 if (new_owner->ads_entries_status == ADS_ENTRIES_USER) {
577 new_owner->ads_entries_status = ADS_ENTRIES_OWNER;
581 dentry->ads_entries_status = ADS_ENTRIES_USER;
583 struct list_head *next;
584 list_del(&dentry->link_group_list);
592 * - memory for file names is not cloned
593 * - next, prev, and children pointers and not touched
594 * - stream entries are not cloned.
596 struct dentry *clone_dentry(struct dentry *old)
598 struct dentry *new = MALLOC(sizeof(struct dentry));
601 memcpy(new, old, sizeof(struct dentry));
602 new->file_name = NULL;
603 new->file_name_len = 0;
604 new->file_name_utf8 = NULL;
605 new->file_name_utf8_len = 0;
606 new->short_name = NULL;
607 new->short_name_len = 0;
612 * This function is passed as an argument to for_dentry_in_tree_depth() in order
613 * to free a directory tree. __args is a pointer to a `struct free_dentry_args'.
615 static int do_free_dentry(struct dentry *dentry, void *__lookup_table)
617 struct lookup_table *lookup_table = __lookup_table;
619 struct lookup_table_entry *lte;
620 if (dentry->resolved)
623 lte = __lookup_resource(lookup_table, dentry->hash);
624 lte_decrement_refcnt(lte, lookup_table);
627 wimlib_assert(dentry->refcnt != 0);
628 if (--dentry->refcnt == 0)
634 * Unlinks and frees a dentry tree.
636 * @root: The root of the tree.
637 * @lookup_table: The lookup table for dentries. If non-NULL, the
638 * reference counts in the lookup table for the lookup
639 * table entries corresponding to the dentries will be
642 void free_dentry_tree(struct dentry *root, struct lookup_table *lookup_table)
644 if (!root || !root->parent)
646 for_dentry_in_tree_depth(root, do_free_dentry, lookup_table);
649 int increment_dentry_refcnt(struct dentry *dentry, void *ignore)
656 * Links a dentry into the directory tree.
658 * @dentry: The dentry to link.
659 * @parent: The dentry that will be the parent of @dentry.
661 void link_dentry(struct dentry *dentry, struct dentry *parent)
663 wimlib_assert(dentry_is_directory(parent));
664 dentry->parent = parent;
665 if (parent->children) {
666 /* Not an only child; link to siblings. */
667 dentry->next = parent->children;
668 dentry->prev = parent->children->prev;
669 dentry->next->prev = dentry;
670 dentry->prev->next = dentry;
672 /* Only child; link to parent. */
673 parent->children = dentry;
674 dentry->next = dentry;
675 dentry->prev = dentry;
680 /* Unlink a dentry from the directory tree.
682 * Note: This merely removes it from the in-memory tree structure. See
683 * remove_dentry() in mount.c for a function implemented on top of this one that
684 * frees the dentry and implements reference counting for the lookup table
686 void unlink_dentry(struct dentry *dentry)
688 if (dentry_is_root(dentry))
690 if (dentry_is_only_child(dentry)) {
691 dentry->parent->children = NULL;
693 if (dentry_is_first_sibling(dentry))
694 dentry->parent->children = dentry->next;
695 dentry->next->prev = dentry->prev;
696 dentry->prev->next = dentry->next;
701 /* Recalculates the length of @dentry based on its file name length and short
703 static inline void recalculate_dentry_size(struct dentry *dentry)
705 dentry->length = WIM_DENTRY_DISK_SIZE + dentry->file_name_len +
706 2 + dentry->short_name_len;
707 /* Must be multiple of 8. */
708 dentry->length = (dentry->length + 7) & ~7;
711 /* Duplicates a UTF-8 name into UTF-8 and UTF-16 strings and returns the strings
712 * and their lengths in the pointer arguments */
713 int get_names(char **name_utf16_ret, char **name_utf8_ret,
714 u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
719 char *name_utf16, *name_utf8;
721 utf8_len = strlen(name);
723 name_utf16 = utf8_to_utf16(name, utf8_len, &utf16_len);
726 return WIMLIB_ERR_NOMEM;
728 name_utf8 = MALLOC(utf8_len + 1);
731 return WIMLIB_ERR_NOMEM;
733 memcpy(name_utf8, name, utf8_len + 1);
734 FREE(*name_utf8_ret);
735 FREE(*name_utf16_ret);
736 *name_utf8_ret = name_utf8;
737 *name_utf16_ret = name_utf16;
738 *name_utf8_len_ret = utf8_len;
739 *name_utf16_len_ret = utf16_len;
743 /* Changes the name of a dentry to @new_name. Only changes the file_name and
744 * file_name_utf8 fields; does not change the short_name, short_name_utf8, or
745 * full_path_utf8 fields. Also recalculates its length. */
746 int change_dentry_name(struct dentry *dentry, const char *new_name)
750 ret = get_names(&dentry->file_name, &dentry->file_name_utf8,
751 &dentry->file_name_len, &dentry->file_name_utf8_len,
754 recalculate_dentry_size(dentry);
758 int change_ads_name(struct ads_entry *entry, const char *new_name)
760 return get_names(&entry->stream_name, &entry->stream_name_utf8,
761 &entry->stream_name_len,
762 &entry->stream_name_utf8_len,
766 /* Parameters for calculate_dentry_statistics(). */
767 struct image_statistics {
768 struct lookup_table *lookup_table;
772 u64 *hard_link_bytes;
775 static int calculate_dentry_statistics(struct dentry *dentry, void *arg)
777 struct image_statistics *stats;
778 struct lookup_table_entry *lte;
783 if (dentry_is_directory(dentry) && !dentry_is_root(dentry))
786 ++*stats->file_count;
788 if (dentry->resolved)
791 lte = __lookup_resource(stats->lookup_table, dentry->hash);
795 u64 size = lte->resource_entry.original_size;
796 *stats->total_bytes += size;
797 if (++lte->out_refcnt == 1)
798 *stats->hard_link_bytes += size;
800 if (i == dentry->num_ads)
802 lte = __lookup_resource(stats->lookup_table,
803 dentry->ads_entries[i].hash);
810 void calculate_dir_tree_statistics(struct dentry *root, struct lookup_table *table,
811 u64 *dir_count_ret, u64 *file_count_ret,
812 u64 *total_bytes_ret,
813 u64 *hard_link_bytes_ret)
815 struct image_statistics stats;
818 *total_bytes_ret = 0;
819 *hard_link_bytes_ret = 0;
820 stats.lookup_table = table;
821 stats.dir_count = dir_count_ret;
822 stats.file_count = file_count_ret;
823 stats.total_bytes = total_bytes_ret;
824 stats.hard_link_bytes = hard_link_bytes_ret;
825 for_lookup_table_entry(table, zero_out_refcnts, NULL);
826 for_dentry_in_tree(root, calculate_dentry_statistics, &stats);
829 static int read_ads_entries(const u8 *p, struct dentry *dentry,
832 u16 num_ads = dentry->num_ads;
833 struct ads_entry *ads_entries = CALLOC(num_ads, sizeof(struct ads_entry));
836 ERROR("Could not allocate memory for %"PRIu16" "
837 "alternate data stream entries", num_ads);
838 return WIMLIB_ERR_NOMEM;
840 DEBUG2("Reading %"PRIu16" alternate data streams "
841 "(remaining size = %"PRIu64")", num_ads, remaining_size);
843 for (u16 i = 0; i < num_ads; i++) {
844 struct ads_entry *cur_entry = &ads_entries[i];
847 const char *p_save = p;
848 /* Read the base stream entry, excluding the stream name. */
849 if (remaining_size < WIM_ADS_ENTRY_DISK_SIZE) {
850 ERROR("Stream entries go past end of metadata resource");
851 ERROR("(remaining_size = %"PRIu64")", remaining_size);
852 ret = WIMLIB_ERR_INVALID_DENTRY;
853 goto out_free_ads_entries;
855 remaining_size -= WIM_ADS_ENTRY_DISK_SIZE;
857 p = get_u64(p, &length); /* ADS entry length */
859 DEBUG2("ADS length = %"PRIu64, length);
862 p = get_bytes(p, SHA1_HASH_SIZE, (u8*)cur_entry->hash);
863 p = get_u16(p, &cur_entry->stream_name_len);
865 DEBUG2("Stream name length = %u", cur_entry->stream_name_len);
867 cur_entry->stream_name = NULL;
868 cur_entry->stream_name_utf8 = NULL;
870 if (remaining_size < cur_entry->stream_name_len + 2) {
871 ERROR("Stream entries go past end of metadata resource");
872 ERROR("(remaining_size = %"PRIu64" bytes, stream_name_len "
873 "= %"PRIu16" bytes", remaining_size,
874 cur_entry->stream_name_len);
875 ret = WIMLIB_ERR_INVALID_DENTRY;
876 goto out_free_ads_entries;
878 remaining_size -= cur_entry->stream_name_len + 2;
880 cur_entry->stream_name = MALLOC(cur_entry->stream_name_len);
881 if (!cur_entry->stream_name) {
882 ret = WIMLIB_ERR_NOMEM;
883 goto out_free_ads_entries;
885 get_bytes(p, cur_entry->stream_name_len,
886 (u8*)cur_entry->stream_name);
887 cur_entry->stream_name_utf8 = utf16_to_utf8(cur_entry->stream_name,
888 cur_entry->stream_name_len,
890 cur_entry->stream_name_utf8_len = utf8_len;
892 if (!cur_entry->stream_name_utf8) {
893 ret = WIMLIB_ERR_NOMEM;
894 goto out_free_ads_entries;
896 p = p_save + ads_entry_length(cur_entry);
898 dentry->ads_entries = ads_entries;
900 out_free_ads_entries:
901 for (u16 i = 0; i < num_ads; i++) {
902 FREE(ads_entries[i].stream_name);
903 FREE(ads_entries[i].stream_name_utf8);
910 * Reads a directory entry from the metadata resource.
912 int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
913 u64 offset, struct dentry *dentry)
918 char *file_name_utf8;
922 size_t file_name_utf8_len;
925 dentry_common_init(dentry);
927 /*Make sure the dentry really fits into the metadata resource.*/
928 if (offset + 8 > metadata_resource_len) {
929 ERROR("Directory entry starting at %"PRIu64" ends past the "
930 "end of the metadata resource (size %"PRIu64")",
931 offset, metadata_resource_len);
932 return WIMLIB_ERR_INVALID_DENTRY;
935 /* Before reading the whole entry, we need to read just the length.
936 * This is because an entry of length 8 (that is, just the length field)
937 * terminates the list of sibling directory entries. */
939 p = get_u64(&metadata_resource[offset], &dentry->length);
941 /* A zero length field (really a length of 8, since that's how big the
942 * directory entry is...) indicates that this is the end of directory
943 * dentry. We do not read it into memory as an actual dentry, so just
944 * return true in that case. */
945 if (dentry->length == 0)
948 if (offset + dentry->length >= metadata_resource_len) {
949 ERROR("Directory entry at offset %"PRIu64" and with size "
950 "%"PRIu64" ends past the end of the metadata resource "
952 offset, dentry->length, metadata_resource_len);
953 return WIMLIB_ERR_INVALID_DENTRY;
956 /* If it is a recognized length, read the rest of the directory entry.
957 * Note: The root directory entry has no name, and its length does not
958 * include the short name length field. */
959 if (dentry->length < WIM_DENTRY_DISK_SIZE) {
960 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
962 return WIMLIB_ERR_INVALID_DENTRY;
965 p = get_u32(p, &dentry->attributes);
966 p = get_u32(p, (u32*)&dentry->security_id);
967 p = get_u64(p, &dentry->subdir_offset);
969 /* 2 unused fields */
970 p += 2 * sizeof(u64);
971 /*p = get_u64(p, &dentry->unused1);*/
972 /*p = get_u64(p, &dentry->unused2);*/
974 p = get_u64(p, &dentry->creation_time);
975 p = get_u64(p, &dentry->last_access_time);
976 p = get_u64(p, &dentry->last_write_time);
978 p = get_bytes(p, SHA1_HASH_SIZE, dentry->hash);
981 * I don't know what's going on here. It seems like M$ screwed up the
982 * reparse points, then put the fields in the same place and didn't
983 * document it. The WIM_HDR_FLAG_RP_FIX flag in the WIM header might
984 * have something to do with this, but it's not documented.
986 if (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
989 p = get_u32(p, &dentry->reparse_tag);
992 p = get_u32(p, &dentry->reparse_tag);
993 p = get_u64(p, &dentry->hard_link);
996 /* By the way, the reparse_reserved field does not actually exist (at
997 * least when the file is not a reparse point) */
1000 p = get_u16(p, &dentry->num_ads);
1002 p = get_u16(p, &short_name_len);
1003 p = get_u16(p, &file_name_len);
1005 calculated_size = WIM_DENTRY_DISK_SIZE + file_name_len + 2 +
1008 if (dentry->length < calculated_size) {
1009 ERROR("Unexpected end of directory entry! (Expected "
1010 "%"PRIu64" bytes, got %"PRIu64" bytes. "
1011 "short_name_len = %hu, file_name_len = %hu)",
1012 calculated_size, dentry->length,
1013 short_name_len, file_name_len);
1014 return WIMLIB_ERR_INVALID_DENTRY;
1017 /* Read the filename. */
1018 file_name = MALLOC(file_name_len);
1020 ERROR("Failed to allocate %hu bytes for dentry file name",
1022 return WIMLIB_ERR_NOMEM;
1024 p = get_bytes(p, file_name_len, file_name);
1026 /* Convert filename to UTF-8. */
1027 file_name_utf8 = utf16_to_utf8(file_name, file_name_len,
1028 &file_name_utf8_len);
1030 if (!file_name_utf8) {
1031 ERROR("Failed to allocate memory to convert UTF-16 "
1032 "filename (%hu bytes) to UTF-8", file_name_len);
1033 ret = WIMLIB_ERR_NOMEM;
1034 goto out_free_file_name;
1037 /* Undocumented padding between file name and short name. This probably
1038 * is supposed to be a terminating null character. */
1041 /* Read the short filename. */
1042 short_name = MALLOC(short_name_len);
1044 ERROR("Failed to allocate %hu bytes for short filename",
1046 ret = WIMLIB_ERR_NOMEM;
1047 goto out_free_file_name_utf8;
1050 p = get_bytes(p, short_name_len, short_name);
1052 /* Some directory entries inexplicibly have a little over 70 bytes of
1053 * extra data. The exact amount of data seems to be 72 bytes, but it is
1054 * aligned on the next 8-byte boundary. Here's an example of the
1057 * 01000000 40000000 6c786bba c58ede11 b0bb0026 1870892a b6adb76f
1058 * e63a3e46 8fca8653 0d2effa1 6c786bba c58ede11 b0bb0026 1870892a
1059 * 00000000 00000000 00000000 00000000
1061 * Here's one interpretation of how the data is laid out.
1064 * u32 field1; (always 0x00000001)
1065 * u32 field2; (always 0x40000000)
1066 * u8 data[48]; (???)
1067 * u64 reserved1; (always 0)
1068 * u64 reserved2; (always 0)
1071 if (dentry->length - calculated_size >= WIM_ADS_ENTRY_DISK_SIZE) {
1072 printf("%s: %lu / %lu (", file_name_utf8,
1073 calculated_size, dentry->length);
1074 print_string(p + WIM_ADS_ENTRY_DISK_SIZE, dentry->length - calculated_size - WIM_ADS_ENTRY_DISK_SIZE);
1076 print_byte_field(p, dentry->length - calculated_size);
1081 if (dentry->num_ads != 0) {
1082 calculated_size = (calculated_size + 7) & ~7;
1083 if (calculated_size > metadata_resource_len - offset) {
1084 ERROR("Not enough space in metadata resource for "
1085 "alternate stream entries");
1086 ret = WIMLIB_ERR_INVALID_DENTRY;
1087 goto out_free_short_name;
1089 ret = read_ads_entries(&metadata_resource[offset + calculated_size],
1091 metadata_resource_len - offset - calculated_size);
1093 goto out_free_short_name;
1096 dentry->file_name = file_name;
1097 dentry->file_name_utf8 = file_name_utf8;
1098 dentry->short_name = short_name;
1099 dentry->file_name_len = file_name_len;
1100 dentry->file_name_utf8_len = file_name_utf8_len;
1101 dentry->short_name_len = short_name_len;
1103 out_free_short_name:
1105 out_free_file_name_utf8:
1106 FREE(file_name_utf8);
1113 * Writes a dentry to an output buffer.
1115 * @dentry: The dentry structure.
1116 * @p: The memory location to write the data to.
1117 * @return: Pointer to the byte after the last byte we wrote as part of the
1120 static u8 *write_dentry(const struct dentry *dentry, u8 *p)
1126 p = put_u64(p, dentry->length);
1127 p = put_u32(p, dentry->attributes);
1128 p = put_u32(p, dentry->security_id);
1129 p = put_u64(p, dentry->subdir_offset);
1130 p = put_u64(p, 0); /* unused1 */
1131 p = put_u64(p, 0); /* unused2 */
1132 p = put_u64(p, dentry->creation_time);
1133 p = put_u64(p, dentry->last_access_time);
1134 p = put_u64(p, dentry->last_write_time);
1135 if (dentry->resolved && dentry->lte)
1136 hash = dentry->lte->hash;
1138 hash = dentry->hash;
1139 p = put_bytes(p, SHA1_HASH_SIZE, hash);
1140 if (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1141 p = put_zeroes(p, 4);
1142 p = put_u32(p, dentry->reparse_tag);
1143 p = put_zeroes(p, 4);
1147 if (dentry->link_group_list.next == &dentry->link_group_list)
1150 hard_link = dentry->hard_link;
1151 p = put_u64(p, hard_link);
1153 p = put_u16(p, dentry->num_ads);
1154 p = put_u16(p, dentry->short_name_len);
1155 p = put_u16(p, dentry->file_name_len);
1156 p = put_bytes(p, dentry->file_name_len, (u8*)dentry->file_name);
1157 p = put_u16(p, 0); /* filename padding, 2 bytes. */
1158 p = put_bytes(p, dentry->short_name_len, (u8*)dentry->short_name);
1160 wimlib_assert(p - orig_p <= dentry->length);
1161 if (p - orig_p < dentry->length)
1162 p = put_zeroes(p, dentry->length - (p - orig_p));
1164 p = put_zeroes(p, (8 - dentry->length % 8) % 8);
1166 for (u16 i = 0; i < dentry->num_ads; i++) {
1167 p = put_u64(p, ads_entry_length(&dentry->ads_entries[i]));
1168 p = put_u64(p, 0); /* Unused */
1169 if (dentry->resolved && dentry->ads_entries[i].lte)
1170 hash = dentry->ads_entries[i].lte->hash;
1172 hash = dentry->ads_entries[i].hash;
1173 p = put_bytes(p, SHA1_HASH_SIZE, hash);
1174 p = put_u16(p, dentry->ads_entries[i].stream_name_len);
1175 p = put_bytes(p, dentry->ads_entries[i].stream_name_len,
1176 (u8*)dentry->ads_entries[i].stream_name);
1178 p = put_zeroes(p, (8 - (p - orig_p) % 8) % 8);
1183 /* Recursive function that writes a dentry tree rooted at @tree, not including
1184 * @tree itself, which has already been written, except in the case of the root
1185 * dentry, which is written right away, along with an end-of-directory entry. */
1186 u8 *write_dentry_tree(const struct dentry *tree, u8 *p)
1188 const struct dentry *child;
1190 if (dentry_is_root(tree)) {
1191 p = write_dentry(tree, p);
1193 /* write end of directory entry */
1196 /* Nothing to do for non-directories */
1197 if (!dentry_is_directory(tree))
1201 /* Write child dentries and end-of-directory entry. */
1202 child = tree->children;
1205 p = write_dentry(child, p);
1206 child = child->next;
1207 } while (child != tree->children);
1210 /* write end of directory entry */
1213 /* Recurse on children. */
1216 p = write_dentry_tree(child, p);
1217 child = child->next;
1218 } while (child != tree->children);
1223 /* Reads the children of a dentry, and all their children, ..., etc. from the
1224 * metadata resource and into the dentry tree.
1226 * @metadata_resource: An array that contains the uncompressed metadata
1227 * resource for the WIM file.
1228 * @metadata_resource_len: The length of @metadata_resource.
1229 * @dentry: A pointer to a struct dentry that is the root of the directory
1230 * tree and has already been read from the metadata resource. It
1231 * does not need to be the real root because this procedure is
1232 * called recursively.
1234 * @return: Zero on success, nonzero on failure.
1236 int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
1237 struct dentry *dentry)
1239 u64 cur_offset = dentry->subdir_offset;
1240 struct dentry *prev_child = NULL;
1241 struct dentry *first_child = NULL;
1242 struct dentry *child;
1243 struct dentry cur_child;
1246 /* If @dentry is a regular file, nothing more needs to be done for this
1248 if (cur_offset == 0)
1251 /* Find and read all the children of @dentry. */
1254 /* Read next child of @dentry into @cur_child. */
1255 ret = read_dentry(metadata_resource, metadata_resource_len,
1256 cur_offset, &cur_child);
1260 /* Check for end of directory. */
1261 if (cur_child.length == 0) {
1266 /* Not end of directory. Allocate this child permanently and
1267 * link it to the parent and previous child. */
1268 child = MALLOC(sizeof(struct dentry));
1270 ERROR("Failed to allocate %zu bytes for new dentry",
1271 sizeof(struct dentry));
1272 ret = WIMLIB_ERR_NOMEM;
1275 memcpy(child, &cur_child, sizeof(struct dentry));
1278 prev_child->next = child;
1279 child->prev = prev_child;
1281 first_child = child;
1284 child->parent = dentry;
1287 /* If there are children of this child, call this procedure
1289 if (child->subdir_offset != 0) {
1290 ret = read_dentry_tree(metadata_resource,
1291 metadata_resource_len, child);
1296 /* Advance to the offset of the next child. */
1297 cur_offset += dentry_total_length(child);
1300 /* Link last child to first one, and set parent's
1301 * children pointer to the first child. */
1303 prev_child->next = first_child;
1304 first_child->prev = prev_child;
1306 dentry->children = first_child;