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/.
33 #include "wimlib_internal.h"
36 #include "timestamp.h"
37 #include "lookup_table.h"
43 * Returns true if @dentry has the UTF-8 file name @name that has length
46 static bool dentry_has_name(const struct dentry *dentry, const char *name,
49 if (dentry->file_name_utf8_len != name_len)
51 return memcmp(dentry->file_name_utf8, name, name_len) == 0;
54 /* Real length of a dentry, including the alternate data stream entries, which
55 * are not included in the dentry->length field... */
56 u64 dentry_total_length(const struct dentry *dentry)
58 u64 length = (dentry->length + 7) & ~7;
59 for (u16 i = 0 ; i < dentry->num_ads; i++)
60 length += ads_entry_length(&dentry->ads_entries[i]);
64 /* Transfers file attributes from a `stat' buffer to a struct dentry. */
65 void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry)
67 if (S_ISLNK(stbuf->st_mode)) {
68 dentry->attributes = FILE_ATTRIBUTE_REPARSE_POINT;
69 dentry->reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
70 } else if (S_ISDIR(stbuf->st_mode)) {
71 dentry->attributes = FILE_ATTRIBUTE_DIRECTORY;
73 dentry->attributes = FILE_ATTRIBUTE_NORMAL;
75 if (sizeof(ino_t) >= 8)
76 dentry->hard_link = (u64)stbuf->st_ino;
78 dentry->hard_link = (u64)stbuf->st_ino |
79 ((u64)stbuf->st_dev << (sizeof(ino_t) * 8));
82 /* Transfers file attributes from a struct dentry to a `stat' buffer. */
83 void dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf,
84 const struct lookup_table *table)
86 struct lookup_table_entry *lte;
88 if (dentry_is_symlink(dentry))
89 stbuf->st_mode = S_IFLNK | 0777;
90 else if (dentry_is_directory(dentry))
91 stbuf->st_mode = S_IFDIR | 0755;
93 stbuf->st_mode = S_IFREG | 0644;
96 lte = __lookup_resource(table, dentry_hash(dentry));
101 stbuf->st_nlink = lte->refcnt;
102 stbuf->st_size = lte->resource_entry.original_size;
107 stbuf->st_uid = getuid();
108 stbuf->st_gid = getgid();
109 stbuf->st_atime = ms_timestamp_to_unix(dentry->last_access_time);
110 stbuf->st_mtime = ms_timestamp_to_unix(dentry->last_write_time);
111 stbuf->st_ctime = ms_timestamp_to_unix(dentry->creation_time);
112 stbuf->st_blocks = (stbuf->st_size + 511) / 512;
115 /* Makes all timestamp fields for the dentry be the current time. */
116 void dentry_update_all_timestamps(struct dentry *dentry)
118 u64 now = get_timestamp();
119 dentry->creation_time = now;
120 dentry->last_access_time = now;
121 dentry->last_write_time = now;
124 struct ads_entry *dentry_get_ads_entry(struct dentry *dentry,
125 const char *stream_name)
127 size_t stream_name_len = strlen(stream_name);
130 for (u16 i = 0; i < dentry->num_ads; i++)
131 if (ads_entry_has_name(&dentry->ads_entries[i],
132 stream_name, stream_name_len))
133 return &dentry->ads_entries[i];
137 /* Add an alternate stream entry to a dentry and return a pointer to it, or NULL
139 struct ads_entry *dentry_add_ads(struct dentry *dentry, const char *stream_name)
141 u16 num_ads = dentry->num_ads + 1;
142 struct ads_entry *ads_entries;
143 struct ads_entry *new_entry;
144 if (num_ads == 0xffff)
146 ads_entries = MALLOC(num_ads * sizeof(struct ads_entry));
150 new_entry = &ads_entries[num_ads - 1];
151 if (change_ads_name(new_entry, stream_name) != 0) {
156 memcpy(ads_entries, dentry->ads_entries,
157 (num_ads - 1) * sizeof(struct ads_entry));
158 FREE(dentry->ads_entries);
159 dentry->ads_entries = ads_entries;
160 dentry->num_ads = num_ads;
161 return memset(new_entry, 0, sizeof(struct ads_entry));
164 void dentry_remove_ads(struct dentry *dentry, struct ads_entry *sentry)
166 destroy_ads_entry(sentry);
167 memcpy(sentry, sentry + 1,
168 (dentry->num_ads - (sentry - dentry->ads_entries))
169 * sizeof(struct ads_entry));
174 * Calls a function on all directory entries in a directory tree. It is called
175 * on a parent before its children.
177 int for_dentry_in_tree(struct dentry *root,
178 int (*visitor)(struct dentry*, void*), void *arg)
181 struct dentry *child;
183 ret = visitor(root, arg);
188 child = root->children;
194 ret = for_dentry_in_tree(child, visitor, arg);
198 } while (child != root->children);
203 * Like for_dentry_in_tree(), but the visitor function is always called on a
204 * dentry's children before on itself.
206 int for_dentry_in_tree_depth(struct dentry *root,
207 int (*visitor)(struct dentry*, void*), void *arg)
210 struct dentry *child;
213 child = root->children;
217 ret = for_dentry_in_tree_depth(child, visitor, arg);
221 } while (child != root->children);
223 return visitor(root, arg);
227 * Calculate the full path of @dentry, based on its parent's full path and on
228 * its UTF-8 file name.
230 int calculate_dentry_full_path(struct dentry *dentry, void *ignore)
234 if (dentry_is_root(dentry)) {
235 full_path = MALLOC(2);
242 char *parent_full_path;
243 u32 parent_full_path_len;
244 const struct dentry *parent = dentry->parent;
246 if (dentry_is_root(parent)) {
247 parent_full_path = "";
248 parent_full_path_len = 0;
250 parent_full_path = parent->full_path_utf8;
251 parent_full_path_len = parent->full_path_utf8_len;
254 full_path_len = parent_full_path_len + 1 +
255 dentry->file_name_utf8_len;
256 full_path = MALLOC(full_path_len + 1);
260 memcpy(full_path, parent_full_path, parent_full_path_len);
261 full_path[parent_full_path_len] = '/';
262 memcpy(full_path + parent_full_path_len + 1,
263 dentry->file_name_utf8,
264 dentry->file_name_utf8_len);
265 full_path[full_path_len] = '\0';
267 FREE(dentry->full_path_utf8);
268 dentry->full_path_utf8 = full_path;
269 dentry->full_path_utf8_len = full_path_len;
272 ERROR("Out of memory while calculating dentry full path");
273 return WIMLIB_ERR_NOMEM;
277 * Recursively calculates the subdir offsets for a directory tree.
279 * @dentry: The root of the directory tree.
280 * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory
281 * offset for @dentry.
283 void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p)
285 struct dentry *child;
287 child = dentry->children;
288 dentry->subdir_offset = *subdir_offset_p;
291 /* Advance the subdir offset by the amount of space the children
292 * of this dentry take up. */
294 *subdir_offset_p += dentry_total_length(child);
296 } while (child != dentry->children);
298 /* End-of-directory dentry on disk. */
299 *subdir_offset_p += 8;
301 /* Recursively call calculate_subdir_offsets() on all the
304 calculate_subdir_offsets(child, subdir_offset_p);
306 } while (child != dentry->children);
308 /* On disk, childless directories have a valid subdir_offset
309 * that points to an 8-byte end-of-directory dentry. Regular
310 * files have a subdir_offset of 0. */
311 if (dentry_is_directory(dentry))
312 *subdir_offset_p += 8;
314 dentry->subdir_offset = 0;
319 /* Returns the child of @dentry that has the file name @name.
320 * Returns NULL if no child has the name. */
321 struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
324 struct dentry *child;
327 child = dentry->children;
329 name_len = strlen(name);
331 if (dentry_has_name(child, name, name_len))
334 } while (child != dentry->children);
339 /* Retrieves the dentry that has the UTF-8 @path relative to the dentry
340 * @cur_dir. Returns NULL if no dentry having the path is found. */
341 static struct dentry *get_dentry_relative_path(struct dentry *cur_dir, const char *path)
343 struct dentry *child;
345 const char *new_path;
350 child = cur_dir->children;
352 new_path = path_next_part(path, &base_len);
354 if (dentry_has_name(child, path, base_len))
355 return get_dentry_relative_path(child, new_path);
357 } while (child != cur_dir->children);
362 /* Returns the dentry corresponding to the UTF-8 @path, or NULL if there is no
364 struct dentry *get_dentry(WIMStruct *w, const char *path)
366 struct dentry *root = wim_root_dentry(w);
369 return get_dentry_relative_path(root, path);
372 /* Returns the parent directory for the @path. */
373 struct dentry *get_parent_dentry(WIMStruct *w, const char *path)
375 size_t path_len = strlen(path);
376 char buf[path_len + 1];
378 memcpy(buf, path, path_len + 1);
380 to_parent_name(buf, path_len);
382 return get_dentry(w, buf);
385 /* Prints the full path of a dentry. */
386 int print_dentry_full_path(struct dentry *dentry, void *ignore)
388 if (dentry->full_path_utf8)
389 puts(dentry->full_path_utf8);
393 struct file_attr_flag {
397 struct file_attr_flag file_attr_flags[] = {
398 {FILE_ATTRIBUTE_READONLY, "READONLY"},
399 {FILE_ATTRIBUTE_HIDDEN, "HIDDEN"},
400 {FILE_ATTRIBUTE_SYSTEM, "SYSTEM"},
401 {FILE_ATTRIBUTE_DIRECTORY, "DIRECTORY"},
402 {FILE_ATTRIBUTE_ARCHIVE, "ARCHIVE"},
403 {FILE_ATTRIBUTE_DEVICE, "DEVICE"},
404 {FILE_ATTRIBUTE_NORMAL, "NORMAL"},
405 {FILE_ATTRIBUTE_TEMPORARY, "TEMPORARY"},
406 {FILE_ATTRIBUTE_SPARSE_FILE, "SPARSE_FILE"},
407 {FILE_ATTRIBUTE_REPARSE_POINT, "REPARSE_POINT"},
408 {FILE_ATTRIBUTE_COMPRESSED, "COMPRESSED"},
409 {FILE_ATTRIBUTE_OFFLINE, "OFFLINE"},
410 {FILE_ATTRIBUTE_NOT_CONTENT_INDEXED,"NOT_CONTENT_INDEXED"},
411 {FILE_ATTRIBUTE_ENCRYPTED, "ENCRYPTED"},
412 {FILE_ATTRIBUTE_VIRTUAL, "VIRTUAL"},
415 /* Prints a directory entry. @lookup_table is a pointer to the lookup table, or
416 * NULL if the resource entry for the dentry is not to be printed. */
417 int print_dentry(struct dentry *dentry, void *lookup_table)
419 struct lookup_table_entry *lte;
422 printf("[DENTRY]\n");
423 printf("Length = %"PRIu64"\n", dentry->length);
424 printf("Attributes = 0x%x\n", dentry->attributes);
425 for (i = 0; i < ARRAY_LEN(file_attr_flags); i++)
426 if (file_attr_flags[i].flag & dentry->attributes)
427 printf(" FILE_ATTRIBUTE_%s is set\n",
428 file_attr_flags[i].name);
429 printf("Security ID = %d\n", dentry->security_id);
430 printf("Subdir offset = %"PRIu64"\n", dentry->subdir_offset);
431 /*printf("Unused1 = 0x%"PRIu64"\n", dentry->unused1);*/
432 /*printf("Unused2 = %"PRIu64"\n", dentry->unused2);*/
433 printf("Creation Time = 0x%"PRIx64"\n", dentry->creation_time);
434 printf("Last Access Time = 0x%"PRIx64"\n", dentry->last_access_time);
435 printf("Last Write Time = 0x%"PRIx64"\n", dentry->last_write_time);
437 print_hash(dentry->hash);
439 printf("Reparse Tag = 0x%"PRIx32"\n", dentry->reparse_tag);
440 printf("Hard Link Group = 0x%"PRIx64"\n", dentry->hard_link);
441 printf("Number of Alternate Data Streams = %hu\n", dentry->num_ads);
442 printf("Filename = \"");
443 print_string(dentry->file_name, dentry->file_name_len);
445 printf("Filename Length = %hu\n", dentry->file_name_len);
446 printf("Filename (UTF-8) = \"%s\"\n", dentry->file_name_utf8);
447 printf("Filename (UTF-8) Length = %hu\n", dentry->file_name_utf8_len);
448 printf("Short Name = \"");
449 print_string(dentry->short_name, dentry->short_name_len);
451 printf("Short Name Length = %hu\n", dentry->short_name_len);
452 printf("Full Path (UTF-8) = \"%s\"\n", dentry->full_path_utf8);
453 if (lookup_table && (lte = __lookup_resource(lookup_table, dentry->hash)))
454 print_lookup_table_entry(lte, NULL);
457 for (u16 i = 0; i < dentry->num_ads; i++) {
458 printf("[Alternate Stream Entry %u]\n", i);
459 printf("Name = \"%s\"\n", dentry->ads_entries[i].stream_name_utf8);
460 printf("Name Length (UTF-16) = %u\n",
461 dentry->ads_entries[i].stream_name_len);
463 print_hash(dentry->ads_entries[i].hash);
465 (lte = __lookup_resource(lookup_table,
466 dentry->ads_entries[i].hash)))
468 print_lookup_table_entry(lte, NULL);
476 static inline void dentry_common_init(struct dentry *dentry)
478 memset(dentry, 0, sizeof(struct dentry));
480 dentry->security_id = -1;
484 * Creates an unlinked directory entry.
486 * @name: The base name of the new dentry.
487 * @return: A pointer to the new dentry, or NULL if out of memory.
489 struct dentry *new_dentry(const char *name)
491 struct dentry *dentry;
493 dentry = MALLOC(sizeof(struct dentry));
497 dentry_common_init(dentry);
498 if (change_dentry_name(dentry, name) != 0)
501 dentry_update_all_timestamps(dentry);
502 dentry->next = dentry;
503 dentry->prev = dentry;
504 dentry->parent = dentry;
508 ERROR("Failed to allocate new dentry");
512 static void dentry_free_ads_entries(struct dentry *dentry)
514 for (u16 i = 0; i < dentry->num_ads; i++)
515 destroy_ads_entry(&dentry->ads_entries[i]);
516 FREE(dentry->ads_entries);
517 dentry->ads_entries = NULL;
522 void free_dentry(struct dentry *dentry)
524 FREE(dentry->file_name);
525 FREE(dentry->file_name_utf8);
526 FREE(dentry->short_name);
527 FREE(dentry->full_path_utf8);
528 dentry_free_ads_entries(dentry);
532 /* Arguments for do_free_dentry(). */
533 struct free_dentry_args {
534 struct lookup_table *lookup_table;
535 bool lt_decrement_refcnt;
539 * This function is passed as an argument to for_dentry_in_tree_depth() in order
540 * to free a directory tree. __args is a pointer to a `struct free_dentry_args'.
542 static int do_free_dentry(struct dentry *dentry, void *__args)
544 struct free_dentry_args *args = (struct free_dentry_args*)__args;
546 if (args->lt_decrement_refcnt && !dentry_is_directory(dentry)) {
547 lookup_table_decrement_refcnt(args->lookup_table,
551 wimlib_assert(dentry->refcnt >= 1);
552 if (--dentry->refcnt == 0)
558 * Unlinks and frees a dentry tree.
560 * @root: The root of the tree.
561 * @lookup_table: The lookup table for dentries.
562 * @decrement_refcnt: True if the dentries in the tree are to have their
563 * reference counts in the lookup table decremented.
565 void free_dentry_tree(struct dentry *root, struct lookup_table *lookup_table,
566 bool lt_decrement_refcnt)
568 if (!root || !root->parent)
571 struct free_dentry_args args;
572 args.lookup_table = lookup_table;
573 args.lt_decrement_refcnt = lt_decrement_refcnt;
574 for_dentry_in_tree_depth(root, do_free_dentry, &args);
577 int increment_dentry_refcnt(struct dentry *dentry, void *ignore)
584 * Links a dentry into the directory tree.
586 * @dentry: The dentry to link.
587 * @parent: The dentry that will be the parent of @dentry.
589 void link_dentry(struct dentry *dentry, struct dentry *parent)
591 dentry->parent = parent;
592 if (parent->children) {
593 /* Not an only child; link to siblings. */
594 dentry->next = parent->children;
595 dentry->prev = parent->children->prev;
596 dentry->next->prev = dentry;
597 dentry->prev->next = dentry;
599 /* Only child; link to parent. */
600 parent->children = dentry;
601 dentry->next = dentry;
602 dentry->prev = dentry;
606 /* Unlink a dentry from the directory tree. */
607 void unlink_dentry(struct dentry *dentry)
609 if (dentry_is_root(dentry))
611 if (dentry_is_only_child(dentry)) {
612 dentry->parent->children = NULL;
614 if (dentry_is_first_sibling(dentry))
615 dentry->parent->children = dentry->next;
616 dentry->next->prev = dentry->prev;
617 dentry->prev->next = dentry->next;
622 /* Recalculates the length of @dentry based on its file name length and short
624 static inline void recalculate_dentry_size(struct dentry *dentry)
626 dentry->length = WIM_DENTRY_DISK_SIZE + dentry->file_name_len +
627 2 + dentry->short_name_len;
628 /* Must be multiple of 8. */
629 dentry->length = (dentry->length + 7) & ~7;
632 static int do_name_change(char **file_name_ret,
633 char **file_name_utf8_ret,
634 u16 *file_name_len_ret,
635 u16 *file_name_utf8_len_ret,
636 const char *new_name)
640 char *file_name, *file_name_utf8;
642 utf8_len = strlen(new_name);
644 file_name = utf8_to_utf16(new_name, utf8_len, &utf16_len);
647 return WIMLIB_ERR_NOMEM;
649 file_name_utf8 = MALLOC(utf8_len + 1);
650 if (!file_name_utf8) {
652 return WIMLIB_ERR_NOMEM;
654 memcpy(file_name_utf8, new_name, utf8_len + 1);
656 FREE(*file_name_ret);
657 FREE(*file_name_utf8_ret);
658 *file_name_ret = file_name;
659 *file_name_utf8_ret = file_name_utf8;
660 *file_name_len_ret = utf16_len;
661 *file_name_utf8_len_ret = utf8_len;
665 /* Changes the name of a dentry to @new_name. Only changes the file_name and
666 * file_name_utf8 fields; does not change the short_name, short_name_utf8, or
667 * full_path_utf8 fields. Also recalculates its length. */
668 int change_dentry_name(struct dentry *dentry, const char *new_name)
672 ret = do_name_change(&dentry->file_name, &dentry->file_name_utf8,
673 &dentry->file_name_len, &dentry->file_name_utf8_len,
676 recalculate_dentry_size(dentry);
680 int change_ads_name(struct ads_entry *entry, const char *new_name)
682 return do_name_change(&entry->stream_name, &entry->stream_name_utf8,
683 &entry->stream_name_len,
684 &entry->stream_name_utf8_len,
688 /* Parameters for calculate_dentry_statistics(). */
689 struct image_statistics {
690 struct lookup_table *lookup_table;
694 u64 *hard_link_bytes;
697 static int calculate_dentry_statistics(struct dentry *dentry, void *arg)
699 struct image_statistics *stats;
700 struct lookup_table_entry *lte;
705 if (dentry_is_directory(dentry) && !dentry_is_root(dentry))
708 ++*stats->file_count;
710 lte = __lookup_resource(stats->lookup_table, dentry->hash);
714 u64 size = lte->resource_entry.original_size;
715 *stats->total_bytes += size;
716 if (++lte->out_refcnt == 1)
717 *stats->hard_link_bytes += size;
719 if (i == dentry->num_ads)
721 lte = __lookup_resource(stats->lookup_table,
722 dentry->ads_entries[i].hash);
729 void calculate_dir_tree_statistics(struct dentry *root, struct lookup_table *table,
730 u64 *dir_count_ret, u64 *file_count_ret,
731 u64 *total_bytes_ret,
732 u64 *hard_link_bytes_ret)
734 struct image_statistics stats;
737 *total_bytes_ret = 0;
738 *hard_link_bytes_ret = 0;
739 stats.lookup_table = table;
740 stats.dir_count = dir_count_ret;
741 stats.file_count = file_count_ret;
742 stats.total_bytes = total_bytes_ret;
743 stats.hard_link_bytes = hard_link_bytes_ret;
744 for_lookup_table_entry(table, zero_out_refcnts, NULL);
745 for_dentry_in_tree(root, calculate_dentry_statistics, &stats);
748 static int read_ads_entries(const u8 *p, struct dentry *dentry,
751 u16 num_ads = dentry->num_ads;
752 struct ads_entry *ads_entries = CALLOC(num_ads, sizeof(struct ads_entry));
755 ERROR("Could not allocate memory for %"PRIu16" "
756 "alternate data stream entries", num_ads);
757 return WIMLIB_ERR_NOMEM;
759 DEBUG2("Reading %"PRIu16" alternate data streams "
760 "(remaining size = %"PRIu64")", num_ads, remaining_size);
762 for (u16 i = 0; i < num_ads; i++) {
763 struct ads_entry *cur_entry = &ads_entries[i];
766 const char *p_save = p;
767 /* Read the base stream entry, excluding the stream name. */
768 if (remaining_size < WIM_ADS_ENTRY_DISK_SIZE) {
769 ERROR("Stream entries go past end of metadata resource");
770 ERROR("(remaining_size = %"PRIu64")", remaining_size);
771 ret = WIMLIB_ERR_INVALID_DENTRY;
772 goto out_free_ads_entries;
774 remaining_size -= WIM_ADS_ENTRY_DISK_SIZE;
776 p = get_u64(p, &length); /* ADS entry length */
778 DEBUG2("ADS length = %"PRIu64, length);
781 p = get_bytes(p, WIM_HASH_SIZE, (u8*)cur_entry->hash);
782 p = get_u16(p, &cur_entry->stream_name_len);
784 DEBUG2("Stream name length = %u", cur_entry->stream_name_len);
786 cur_entry->stream_name = NULL;
787 cur_entry->stream_name_utf8 = NULL;
789 if (remaining_size < cur_entry->stream_name_len + 2) {
790 ERROR("Stream entries go past end of metadata resource");
791 ERROR("(remaining_size = %"PRIu64" bytes, stream_name_len "
792 "= %"PRIu16" bytes", remaining_size,
793 cur_entry->stream_name_len);
794 ret = WIMLIB_ERR_INVALID_DENTRY;
795 goto out_free_ads_entries;
797 remaining_size -= cur_entry->stream_name_len + 2;
799 cur_entry->stream_name = MALLOC(cur_entry->stream_name_len);
800 if (!cur_entry->stream_name) {
801 ret = WIMLIB_ERR_NOMEM;
802 goto out_free_ads_entries;
804 get_bytes(p, cur_entry->stream_name_len,
805 (u8*)cur_entry->stream_name);
806 cur_entry->stream_name_utf8 = utf16_to_utf8(cur_entry->stream_name,
807 cur_entry->stream_name_len,
809 cur_entry->stream_name_utf8_len = utf8_len;
811 if (!cur_entry->stream_name_utf8) {
812 ret = WIMLIB_ERR_NOMEM;
813 goto out_free_ads_entries;
815 p = p_save + ads_entry_length(cur_entry);
817 dentry->ads_entries = ads_entries;
819 out_free_ads_entries:
820 for (u16 i = 0; i < num_ads; i++) {
821 FREE(ads_entries[i].stream_name);
822 FREE(ads_entries[i].stream_name_utf8);
829 * Reads a directory entry from the metadata resource.
831 int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
832 u64 offset, struct dentry *dentry)
837 char *file_name_utf8;
841 size_t file_name_utf8_len;
844 dentry_common_init(dentry);
846 /*Make sure the dentry really fits into the metadata resource.*/
847 if (offset + 8 > metadata_resource_len) {
848 ERROR("Directory entry starting at %"PRIu64" ends past the "
849 "end of the metadata resource (size %"PRIu64")",
850 offset, metadata_resource_len);
851 return WIMLIB_ERR_INVALID_DENTRY;
854 /* Before reading the whole entry, we need to read just the length.
855 * This is because an entry of length 8 (that is, just the length field)
856 * terminates the list of sibling directory entries. */
858 p = get_u64(&metadata_resource[offset], &dentry->length);
860 /* A zero length field (really a length of 8, since that's how big the
861 * directory entry is...) indicates that this is the end of directory
862 * dentry. We do not read it into memory as an actual dentry, so just
863 * return true in that case. */
864 if (dentry->length == 0)
867 if (offset + dentry->length >= metadata_resource_len) {
868 ERROR("Directory entry at offset %"PRIu64" and with size "
869 "%"PRIu64" ends past the end of the metadata resource "
871 offset, dentry->length, metadata_resource_len);
872 return WIMLIB_ERR_INVALID_DENTRY;
875 /* If it is a recognized length, read the rest of the directory entry.
876 * Note: The root directory entry has no name, and its length does not
877 * include the short name length field. */
878 if (dentry->length < WIM_DENTRY_DISK_SIZE) {
879 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
881 return WIMLIB_ERR_INVALID_DENTRY;
884 p = get_u32(p, &dentry->attributes);
885 p = get_u32(p, (u32*)&dentry->security_id);
886 p = get_u64(p, &dentry->subdir_offset);
888 /* 2 unused fields */
889 p += 2 * sizeof(u64);
890 /*p = get_u64(p, &dentry->unused1);*/
891 /*p = get_u64(p, &dentry->unused2);*/
893 p = get_u64(p, &dentry->creation_time);
894 p = get_u64(p, &dentry->last_access_time);
895 p = get_u64(p, &dentry->last_write_time);
897 p = get_bytes(p, WIM_HASH_SIZE, dentry->hash);
900 * I don't know what's going on here. It seems like M$ screwed up the
901 * reparse points, then put the fields in the same place and didn't
902 * document it. The WIM_HDR_FLAG_RP_FIX flag in the WIM header might
903 * have something to do with this, but it's not documented.
905 if (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
910 p = get_u32(p, &dentry->reparse_tag);
913 dentry->hard_link = (u64)(u1) | ((u64)(u2) << 32);
915 p = get_u32(p, &dentry->reparse_tag);
916 p = get_u64(p, &dentry->hard_link);
919 /* By the way, the reparse_reserved field does not actually exist (at
920 * least when the file is not a reparse point) */
923 p = get_u16(p, &dentry->num_ads);
925 p = get_u16(p, &short_name_len);
926 p = get_u16(p, &file_name_len);
928 calculated_size = WIM_DENTRY_DISK_SIZE + file_name_len + 2 +
931 if (dentry->length < calculated_size) {
932 ERROR("Unexpected end of directory entry! (Expected "
933 "%"PRIu64" bytes, got %"PRIu64" bytes. "
934 "short_name_len = %hu, file_name_len = %hu)",
935 calculated_size, dentry->length,
936 short_name_len, file_name_len);
937 return WIMLIB_ERR_INVALID_DENTRY;
940 /* Read the filename. */
941 file_name = MALLOC(file_name_len);
943 ERROR("Failed to allocate %hu bytes for dentry file name",
945 return WIMLIB_ERR_NOMEM;
947 p = get_bytes(p, file_name_len, file_name);
949 /* Convert filename to UTF-8. */
950 file_name_utf8 = utf16_to_utf8(file_name, file_name_len,
951 &file_name_utf8_len);
953 if (!file_name_utf8) {
954 ERROR("Failed to allocate memory to convert UTF-16 "
955 "filename (%hu bytes) to UTF-8", file_name_len);
956 ret = WIMLIB_ERR_NOMEM;
957 goto out_free_file_name;
960 /* Undocumented padding between file name and short name. This probably
961 * is supposed to be a terminating null character. */
964 /* Read the short filename. */
965 short_name = MALLOC(short_name_len);
967 ERROR("Failed to allocate %hu bytes for short filename",
969 ret = WIMLIB_ERR_NOMEM;
970 goto out_free_file_name_utf8;
973 p = get_bytes(p, short_name_len, short_name);
975 /* Some directory entries inexplicibly have a little over 70 bytes of
976 * extra data. The exact amount of data seems to be 72 bytes, but it is
977 * aligned on the next 8-byte boundary. Here's an example of the
980 * 01000000400000006c786bbac58ede11b0bb00261870892ab6adb76fe63a3
981 * e468fca86530d2effa16c786bbac58ede11b0bb00261870892a0000000000
982 * 0000000000000000000000
984 * Here's one interpretation of how the data is laid out.
987 * u32 field1; (always 0x00000001)
988 * u32 field2; (always 0x40000000)
994 * u64 reserved1; (always 0)
995 * u64 reserved2; (always 0)
998 if (dentry->length - calculated_size >= WIM_ADS_ENTRY_DISK_SIZE) {
999 printf("%s: %lu / %lu (", file_name_utf8,
1000 calculated_size, dentry->length);
1001 print_string(p + WIM_ADS_ENTRY_DISK_SIZE, dentry->length - calculated_size - WIM_ADS_ENTRY_DISK_SIZE);
1003 print_byte_field(p, dentry->length - calculated_size);
1008 if (dentry->num_ads != 0) {
1009 calculated_size = (calculated_size + 7) & ~7;
1010 if (calculated_size > metadata_resource_len - offset) {
1011 ERROR("Not enough space in metadata resource for "
1012 "alternate stream entries");
1013 ret = WIMLIB_ERR_INVALID_DENTRY;
1014 goto out_free_short_name;
1016 ret = read_ads_entries(&metadata_resource[offset + calculated_size],
1018 metadata_resource_len - offset - calculated_size);
1020 goto out_free_short_name;
1023 dentry->file_name = file_name;
1024 dentry->file_name_utf8 = file_name_utf8;
1025 dentry->short_name = short_name;
1026 dentry->file_name_len = file_name_len;
1027 dentry->file_name_utf8_len = file_name_utf8_len;
1028 dentry->short_name_len = short_name_len;
1030 out_free_short_name:
1032 out_free_file_name_utf8:
1033 FREE(file_name_utf8);
1040 * Writes a dentry to an output buffer.
1042 * @dentry: The dentry structure.
1043 * @p: The memory location to write the data to.
1044 * @return: Pointer to the byte after the last byte we wrote as part of the
1047 static u8 *write_dentry(const struct dentry *dentry, u8 *p)
1051 memset(p, 0, dentry->length);
1052 p = put_u64(p, dentry->length);
1053 p = put_u32(p, dentry->attributes);
1054 p = put_u32(p, dentry->security_id);
1055 p = put_u64(p, dentry->subdir_offset);
1056 p = put_u64(p, 0); /* unused1 */
1057 p = put_u64(p, 0); /* unused2 */
1058 p = put_u64(p, dentry->creation_time);
1059 p = put_u64(p, dentry->last_access_time);
1060 p = put_u64(p, dentry->last_write_time);
1061 memcpy(p, dentry->hash, WIM_HASH_SIZE);
1063 p = put_u32(p, dentry->reparse_tag);
1064 p = put_u64(p, dentry->hard_link);
1065 p = put_u16(p, dentry->num_ads); /*streams */
1066 p = put_u16(p, dentry->short_name_len);
1067 p = put_u16(p, dentry->file_name_len);
1068 p = put_bytes(p, dentry->file_name_len, (u8*)dentry->file_name);
1069 p = put_u16(p, 0); /* filename padding, 2 bytes. */
1070 p = put_bytes(p, dentry->short_name_len, (u8*)dentry->short_name);
1072 wimlib_assert(p - orig_p <= dentry->length);
1073 if (p - orig_p < dentry->length)
1074 p = put_zeroes(p, dentry->length - (p - orig_p));
1076 p = put_zeroes(p, (8 - (p - orig_p) % 8) % 8);
1078 for (u16 i = 0; i < dentry->num_ads; i++) {
1079 p = put_u64(p, ads_entry_length(&dentry->ads_entries[i]));
1080 p = put_u64(p, 0); /* Unused */
1081 p = put_bytes(p, WIM_HASH_SIZE, dentry->ads_entries[i].hash);
1082 p = put_u16(p, dentry->ads_entries[i].stream_name_len);
1083 p = put_bytes(p, dentry->ads_entries[i].stream_name_len,
1084 (u8*)dentry->ads_entries[i].stream_name);
1085 p = put_zeroes(p, (8 - (p - orig_p) % 8) % 8);
1090 /* Recursive function that writes a dentry tree rooted at @tree, not including
1091 * @tree itself, which has already been written, except in the case of the root
1092 * dentry, which is written right away, along with an end-of-directory entry. */
1093 u8 *write_dentry_tree(const struct dentry *tree, u8 *p)
1095 const struct dentry *child;
1097 if (dentry_is_root(tree)) {
1098 p = write_dentry(tree, p);
1100 /* write end of directory entry */
1103 /* Nothing to do for a regular file. */
1104 if (dentry_is_regular_file(tree))
1108 /* Write child dentries and end-of-directory entry. */
1109 child = tree->children;
1112 p = write_dentry(child, p);
1113 child = child->next;
1114 } while (child != tree->children);
1117 /* write end of directory entry */
1120 /* Recurse on children. */
1123 p = write_dentry_tree(child, p);
1124 child = child->next;
1125 } while (child != tree->children);
1130 /* Reads the children of a dentry, and all their children, ..., etc. from the
1131 * metadata resource and into the dentry tree.
1133 * @metadata_resource: An array that contains the uncompressed metadata
1134 * resource for the WIM file.
1135 * @metadata_resource_len: The length of @metadata_resource.
1136 * @dentry: A pointer to a struct dentry that is the root of the directory
1137 * tree and has already been read from the metadata resource. It
1138 * does not need to be the real root because this procedure is
1139 * called recursively.
1141 * @return: Zero on success, nonzero on failure.
1143 int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
1144 struct dentry *dentry)
1146 u64 cur_offset = dentry->subdir_offset;
1147 struct dentry *prev_child = NULL;
1148 struct dentry *first_child = NULL;
1149 struct dentry *child;
1150 struct dentry cur_child;
1153 /* If @dentry is a regular file, nothing more needs to be done for this
1155 if (cur_offset == 0)
1158 /* Find and read all the children of @dentry. */
1161 /* Read next child of @dentry into @cur_child. */
1162 ret = read_dentry(metadata_resource, metadata_resource_len,
1163 cur_offset, &cur_child);
1167 /* Check for end of directory. */
1168 if (cur_child.length == 0) {
1173 /* Not end of directory. Allocate this child permanently and
1174 * link it to the parent and previous child. */
1175 child = MALLOC(sizeof(struct dentry));
1177 ERROR("Failed to allocate %zu bytes for new dentry",
1178 sizeof(struct dentry));
1179 ret = WIMLIB_ERR_NOMEM;
1182 memcpy(child, &cur_child, sizeof(struct dentry));
1185 prev_child->next = child;
1186 child->prev = prev_child;
1188 first_child = child;
1191 child->parent = dentry;
1194 /* If there are children of this child, call this procedure
1196 if (child->subdir_offset != 0) {
1197 ret = read_dentry_tree(metadata_resource,
1198 metadata_resource_len, child);
1203 /* Advance to the offset of the next child. */
1204 cur_offset += dentry_total_length(child);
1207 /* Link last child to first one, and set parent's
1208 * children pointer to the first child. */
1210 prev_child->next = first_child;
1211 first_child->prev = prev_child;
1213 dentry->children = first_child;
1217 int dentry_set_symlink_buf(struct dentry *dentry, const u8 symlink_buf_hash[])
1219 struct ads_entry *ads_entries;
1221 ads_entries = CALLOC(2, sizeof(struct ads_entry));
1223 return WIMLIB_ERR_NOMEM;
1224 memcpy(ads_entries[1].hash, symlink_buf_hash, WIM_HASH_SIZE);
1225 dentry_free_ads_entries(dentry);
1226 dentry->num_ads = 2;
1227 dentry->ads_entries = ads_entries;