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"
42 /* Real length of a dentry, including the alternate data stream entries, which
43 * are not included in the dentry->length field... */
44 u64 dentry_total_length(const struct dentry *dentry)
46 u64 length = dentry->length;
47 if (dentry->num_ads) {
50 length += WIM_ADS_ENTRY_DISK_SIZE +
51 dentry->ads_entries[i].stream_name_len;
52 } while (++i != dentry->num_ads);
53 /* If there are Alternate Stream Entries, we apparently need to
54 * round up to the NEXT 8-byte boundary, even if we are already
55 * aligned on one... */
58 /* Round to 8 byte boundary. */
59 return (length + 7) & ~7;
62 /* Transfers file attributes from a `stat' buffer to a struct dentry. */
63 void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry)
65 if (S_ISDIR(stbuf->st_mode))
66 dentry->attributes = FILE_ATTRIBUTE_DIRECTORY;
68 dentry->attributes = FILE_ATTRIBUTE_NORMAL;
71 /* Transfers file attributes from a struct dentry to a `stat' buffer. */
72 void dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf,
73 const struct lookup_table *table)
75 struct lookup_table_entry *lte;
77 if (dentry_is_directory(dentry))
78 stbuf->st_mode = S_IFDIR | 0755;
80 stbuf->st_mode = S_IFREG | 0644;
83 lte = lookup_resource(table, dentry->hash);
88 stbuf->st_nlink = lte->refcnt;
89 stbuf->st_size = lte->resource_entry.original_size;
94 stbuf->st_uid = getuid();
95 stbuf->st_gid = getgid();
96 stbuf->st_atime = ms_timestamp_to_unix(dentry->last_access_time);
97 stbuf->st_mtime = ms_timestamp_to_unix(dentry->last_write_time);
98 stbuf->st_ctime = ms_timestamp_to_unix(dentry->creation_time);
99 stbuf->st_blocks = (stbuf->st_size + 511) / 512;
102 /* Makes all timestamp fields for the dentry be the current time. */
103 void dentry_update_all_timestamps(struct dentry *dentry)
105 u64 now = get_timestamp();
106 dentry->creation_time = now;
107 dentry->last_access_time = now;
108 dentry->last_write_time = now;
112 * Calls a function on all directory entries in a directory tree. It is called
113 * on a parent before its children.
115 int for_dentry_in_tree(struct dentry *root,
116 int (*visitor)(struct dentry*, void*), void *arg)
119 struct dentry *child;
121 ret = visitor(root, arg);
126 child = root->children;
132 ret = for_dentry_in_tree(child, visitor, arg);
136 } while (child != root->children);
141 * Like for_dentry_in_tree(), but the visitor function is always called on a
142 * dentry's children before on itself.
144 int for_dentry_in_tree_depth(struct dentry *root,
145 int (*visitor)(struct dentry*, void*), void *arg)
148 struct dentry *child;
151 child = root->children;
155 ret = for_dentry_in_tree_depth(child, visitor, arg);
159 } while (child != root->children);
161 return visitor(root, arg);
165 * Calculate the full path of @dentry, based on its parent's full path and on
166 * its UTF-8 file name.
168 int calculate_dentry_full_path(struct dentry *dentry, void *ignore)
172 if (dentry_is_root(dentry)) {
173 full_path = MALLOC(2);
180 char *parent_full_path;
181 u32 parent_full_path_len;
182 const struct dentry *parent = dentry->parent;
184 if (dentry_is_root(parent)) {
185 parent_full_path = "";
186 parent_full_path_len = 0;
188 parent_full_path = parent->full_path_utf8;
189 parent_full_path_len = parent->full_path_utf8_len;
192 full_path_len = parent_full_path_len + 1 +
193 dentry->file_name_utf8_len;
194 full_path = MALLOC(full_path_len + 1);
198 memcpy(full_path, parent_full_path, parent_full_path_len);
199 full_path[parent_full_path_len] = '/';
200 memcpy(full_path + parent_full_path_len + 1,
201 dentry->file_name_utf8,
202 dentry->file_name_utf8_len);
203 full_path[full_path_len] = '\0';
205 FREE(dentry->full_path_utf8);
206 dentry->full_path_utf8 = full_path;
207 dentry->full_path_utf8_len = full_path_len;
210 ERROR("Out of memory while calculating dentry full path");
211 return WIMLIB_ERR_NOMEM;
215 * Recursively calculates the subdir offsets for a directory tree.
217 * @dentry: The root of the directory tree.
218 * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory
219 * offset for @dentry.
221 void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p)
223 struct dentry *child;
225 child = dentry->children;
226 dentry->subdir_offset = *subdir_offset_p;
229 /* Advance the subdir offset by the amount of space the children
230 * of this dentry take up. */
232 *subdir_offset_p += dentry_total_length(child);
234 } while (child != dentry->children);
236 /* End-of-directory dentry on disk. */
237 *subdir_offset_p += 8;
239 /* Recursively call calculate_subdir_offsets() on all the
242 calculate_subdir_offsets(child, subdir_offset_p);
244 } while (child != dentry->children);
246 /* On disk, childless directories have a valid subdir_offset
247 * that points to an 8-byte end-of-directory dentry. Regular
248 * files have a subdir_offset of 0. */
249 if (dentry_is_directory(dentry))
250 *subdir_offset_p += 8;
252 dentry->subdir_offset = 0;
257 /* Returns the child of @dentry that has the file name @name.
258 * Returns NULL if no child has the name. */
259 struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
262 struct dentry *child;
265 child = dentry->children;
267 name_len = strlen(name);
269 if (dentry_has_name(child, name, name_len))
272 } while (child != dentry->children);
277 /* Retrieves the dentry that has the UTF-8 @path relative to the dentry
278 * @cur_dir. Returns NULL if no dentry having the path is found. */
279 static struct dentry *get_dentry_relative_path(struct dentry *cur_dir, const char *path)
281 struct dentry *child;
283 const char *new_path;
288 child = cur_dir->children;
290 new_path = path_next_part(path, &base_len);
292 if (dentry_has_name(child, path, base_len))
293 return get_dentry_relative_path(child, new_path);
295 } while (child != cur_dir->children);
300 /* Returns the dentry corresponding to the UTF-8 @path, or NULL if there is no
302 struct dentry *get_dentry(WIMStruct *w, const char *path)
304 struct dentry *root = wim_root_dentry(w);
307 return get_dentry_relative_path(root, path);
310 /* Returns the parent directory for the @path. */
311 struct dentry *get_parent_dentry(WIMStruct *w, const char *path)
313 size_t path_len = strlen(path);
314 char buf[path_len + 1];
316 memcpy(buf, path, path_len + 1);
318 to_parent_name(buf, path_len);
320 return get_dentry(w, buf);
323 /* Prints the full path of a dentry. */
324 int print_dentry_full_path(struct dentry *dentry, void *ignore)
326 if (dentry->full_path_utf8)
327 puts(dentry->full_path_utf8);
331 struct file_attr_flag {
335 struct file_attr_flag file_attr_flags[] = {
336 {FILE_ATTRIBUTE_READONLY, "READONLY"},
337 {FILE_ATTRIBUTE_HIDDEN, "HIDDEN"},
338 {FILE_ATTRIBUTE_SYSTEM, "SYSTEM"},
339 {FILE_ATTRIBUTE_DIRECTORY, "DIRECTORY"},
340 {FILE_ATTRIBUTE_ARCHIVE, "ARCHIVE"},
341 {FILE_ATTRIBUTE_DEVICE, "DEVICE"},
342 {FILE_ATTRIBUTE_NORMAL, "NORMAL"},
343 {FILE_ATTRIBUTE_TEMPORARY, "TEMPORARY"},
344 {FILE_ATTRIBUTE_SPARSE_FILE, "SPARSE_FILE"},
345 {FILE_ATTRIBUTE_REPARSE_POINT, "REPARSE_POINT"},
346 {FILE_ATTRIBUTE_COMPRESSED, "COMPRESSED"},
347 {FILE_ATTRIBUTE_OFFLINE, "OFFLINE"},
348 {FILE_ATTRIBUTE_NOT_CONTENT_INDEXED,"NOT_CONTENT_INDEXED"},
349 {FILE_ATTRIBUTE_ENCRYPTED, "ENCRYPTED"},
350 {FILE_ATTRIBUTE_VIRTUAL, "VIRTUAL"},
353 /* Prints a directory entry. @lookup_table is a pointer to the lookup table, or
354 * NULL if the resource entry for the dentry is not to be printed. */
355 int print_dentry(struct dentry *dentry, void *lookup_table)
357 struct lookup_table_entry *lte;
360 printf("[DENTRY]\n");
361 printf("Length = %"PRIu64"\n", dentry->length);
362 printf("Attributes = 0x%x\n", dentry->attributes);
363 for (i = 0; i < ARRAY_LEN(file_attr_flags); i++)
364 if (file_attr_flags[i].flag & dentry->attributes)
365 printf(" FILE_ATTRIBUTE_%s is set\n",
366 file_attr_flags[i].name);
367 printf("Security ID = %d\n", dentry->security_id);
368 printf("Subdir offset = %"PRIu64"\n", dentry->subdir_offset);
369 /*printf("Unused1 = 0x%"PRIu64"\n", dentry->unused1);*/
370 /*printf("Unused2 = %"PRIu64"\n", dentry->unused2);*/
371 printf("Creation Time = %"PRIu64"\n", dentry->creation_time);
372 printf("Last Access Time = %"PRIu64"\n", dentry->last_access_time);
373 printf("Last Write Time = %"PRIu64"\n", dentry->last_write_time);
374 printf("Creation Time = 0x%"PRIx64"\n", dentry->creation_time);
376 print_hash(dentry->hash);
378 printf("Reparse Tag = 0x%"PRIx32"\n", dentry->reparse_tag);
379 printf("Hard Link Group = 0x%"PRIx64"\n", dentry->hard_link);
380 printf("Number of Alternate Data Streams = %hu\n", dentry->num_ads);
381 printf("Filename = \"");
382 print_string(dentry->file_name, dentry->file_name_len);
384 printf("Filename Length = %hu\n", dentry->file_name_len);
385 printf("Filename (UTF-8) = \"%s\"\n", dentry->file_name_utf8);
386 printf("Filename (UTF-8) Length = %hu\n", dentry->file_name_utf8_len);
387 printf("Short Name = \"");
388 print_string(dentry->short_name, dentry->short_name_len);
390 printf("Short Name Length = %hu\n", dentry->short_name_len);
391 printf("Full Path (UTF-8) = \"%s\"\n", dentry->full_path_utf8);
393 lte = lookup_resource(lookup_table, dentry->hash);
395 print_lookup_table_entry(lte, NULL);
401 for (u16 i = 0; i < dentry->num_ads; i++) {
402 printf("[Alternate Stream Entry %u]\n", i);
403 printf("Name = \"%s\"\n", dentry->ads_entries[i].stream_name_utf8);
404 lte = lookup_resource(lookup_table, dentry->ads_entries[i].hash);
406 print_lookup_table_entry(lte, NULL);
413 static inline void dentry_common_init(struct dentry *dentry)
415 memset(dentry, 0, sizeof(struct dentry));
417 dentry->security_id = -1;
421 * Creates an unlinked directory entry.
423 * @name: The base name of the new dentry.
424 * @return: A pointer to the new dentry, or NULL if out of memory.
426 struct dentry *new_dentry(const char *name)
428 struct dentry *dentry;
430 dentry = MALLOC(sizeof(struct dentry));
434 dentry_common_init(dentry);
435 if (change_dentry_name(dentry, name) != 0) {
440 dentry_update_all_timestamps(dentry);
441 dentry->next = dentry;
442 dentry->prev = dentry;
443 dentry->parent = dentry;
448 void free_dentry(struct dentry *dentry)
450 FREE(dentry->file_name);
451 FREE(dentry->file_name_utf8);
452 FREE(dentry->short_name);
453 FREE(dentry->full_path_utf8);
457 /* Arguments for do_free_dentry(). */
458 struct free_dentry_args {
459 struct lookup_table *lookup_table;
460 bool lt_decrement_refcnt;
464 * This function is passed as an argument to for_dentry_in_tree_depth() in order
465 * to free a directory tree. __args is a pointer to a `struct free_dentry_args'.
467 static int do_free_dentry(struct dentry *dentry, void *__args)
469 struct free_dentry_args *args = (struct free_dentry_args*)__args;
471 if (args->lt_decrement_refcnt && !dentry_is_directory(dentry)) {
472 lookup_table_decrement_refcnt(args->lookup_table,
476 wimlib_assert(dentry->refcnt >= 1);
477 if (--dentry->refcnt == 0)
483 * Unlinks and frees a dentry tree.
485 * @root: The root of the tree.
486 * @lookup_table: The lookup table for dentries.
487 * @decrement_refcnt: True if the dentries in the tree are to have their
488 * reference counts in the lookup table decremented.
490 void free_dentry_tree(struct dentry *root, struct lookup_table *lookup_table,
491 bool lt_decrement_refcnt)
493 if (!root || !root->parent)
496 struct free_dentry_args args;
497 args.lookup_table = lookup_table;
498 args.lt_decrement_refcnt = lt_decrement_refcnt;
499 for_dentry_in_tree_depth(root, do_free_dentry, &args);
502 int increment_dentry_refcnt(struct dentry *dentry, void *ignore)
509 * Links a dentry into the directory tree.
511 * @dentry: The dentry to link.
512 * @parent: The dentry that will be the parent of @dentry.
514 void link_dentry(struct dentry *dentry, struct dentry *parent)
516 dentry->parent = parent;
517 if (parent->children) {
518 /* Not an only child; link to siblings. */
519 dentry->next = parent->children;
520 dentry->prev = parent->children->prev;
521 dentry->next->prev = dentry;
522 dentry->prev->next = dentry;
524 /* Only child; link to parent. */
525 parent->children = dentry;
526 dentry->next = dentry;
527 dentry->prev = dentry;
531 /* Unlink a dentry from the directory tree. */
532 void unlink_dentry(struct dentry *dentry)
534 if (dentry_is_root(dentry))
536 if (dentry_is_only_child(dentry)) {
537 dentry->parent->children = NULL;
539 if (dentry_is_first_sibling(dentry))
540 dentry->parent->children = dentry->next;
541 dentry->next->prev = dentry->prev;
542 dentry->prev->next = dentry->next;
547 /* Recalculates the length of @dentry based on its file name length and short
549 static inline void recalculate_dentry_size(struct dentry *dentry)
551 dentry->length = WIM_DENTRY_DISK_SIZE + dentry->file_name_len +
552 2 + dentry->short_name_len;
553 for (u16 i = 0; i < dentry->num_ads; i++)
554 dentry->length += ads_entry_length(&dentry->ads_entries[i]);
555 /* Must be multiple of 8. */
556 dentry->length = (dentry->length + 7) & ~7;
559 /* Changes the name of a dentry to @new_name. Only changes the file_name and
560 * file_name_utf8 fields; does not change the short_name, short_name_utf8, or
561 * full_path_utf8 fields. Also recalculates its length. */
562 int change_dentry_name(struct dentry *dentry, const char *new_name)
567 FREE(dentry->file_name);
569 utf8_len = strlen(new_name);
571 dentry->file_name = utf8_to_utf16(new_name, utf8_len, &utf16_len);
573 if (!dentry->file_name)
574 return WIMLIB_ERR_NOMEM;
576 FREE(dentry->file_name_utf8);
577 dentry->file_name_utf8 = MALLOC(utf8_len + 1);
578 if (!dentry->file_name_utf8) {
579 FREE(dentry->file_name);
580 dentry->file_name = NULL;
581 return WIMLIB_ERR_NOMEM;
584 dentry->file_name_len = utf16_len;
585 dentry->file_name_utf8_len = utf8_len;
586 memcpy(dentry->file_name_utf8, new_name, utf8_len + 1);
587 recalculate_dentry_size(dentry);
591 /* Parameters for calculate_dentry_statistics(). */
592 struct image_statistics {
593 struct lookup_table *lookup_table;
597 u64 *hard_link_bytes;
600 static int calculate_dentry_statistics(struct dentry *dentry, void *arg)
602 struct image_statistics *stats;
603 struct lookup_table_entry *lte;
606 lte = lookup_resource(stats->lookup_table, dentry->hash);
608 if (dentry_is_directory(dentry) && !dentry_is_root(dentry))
611 ++*stats->file_count;
614 u64 size = lte->resource_entry.original_size;
615 *stats->total_bytes += size;
616 if (++lte->out_refcnt == 1)
617 *stats->hard_link_bytes += size;
622 void calculate_dir_tree_statistics(struct dentry *root, struct lookup_table *table,
623 u64 *dir_count_ret, u64 *file_count_ret,
624 u64 *total_bytes_ret,
625 u64 *hard_link_bytes_ret)
627 struct image_statistics stats;
630 *total_bytes_ret = 0;
631 *hard_link_bytes_ret = 0;
632 stats.lookup_table = table;
633 stats.dir_count = dir_count_ret;
634 stats.file_count = file_count_ret;
635 stats.total_bytes = total_bytes_ret;
636 stats.hard_link_bytes = hard_link_bytes_ret;
637 for_lookup_table_entry(table, zero_out_refcnts, NULL);
638 for_dentry_in_tree(root, calculate_dentry_statistics, &stats);
641 static int read_ads_entries(const u8 *p, struct dentry *dentry,
644 u16 num_ads = dentry->num_ads;
645 struct ads_entry *ads_entries = CALLOC(num_ads, sizeof(struct ads_entry));
648 ERROR("Could not allocate memory for %"PRIu16" "
649 "alternate data stream entries", num_ads);
650 return WIMLIB_ERR_NOMEM;
652 DEBUG2("Reading %"PRIu16" alternate data streams "
653 "(remaining size = %"PRIu64")", num_ads, remaining_size);
655 for (u16 i = 0; i < num_ads; i++) {
656 struct ads_entry *cur_entry = &ads_entries[i];
659 /* Read the base stream entry, excluding the stream name. */
660 if (remaining_size < WIM_ADS_ENTRY_DISK_SIZE) {
661 ERROR("Stream entries go past end of metadata resource");
662 ret = WIMLIB_ERR_INVALID_DENTRY;
663 goto out_free_ads_entries;
665 remaining_size -= WIM_ADS_ENTRY_DISK_SIZE;
666 /*print_string(p + 40, 10);*/
667 /*print_byte_field(p, 50);*/
669 p = get_u64(p, &length); /* ADS entry length */
671 DEBUG2("ADS length = %"PRIu64, length);
674 p = get_bytes(p, WIM_HASH_SIZE, (u8*)cur_entry->hash);
675 p = get_u16(p, &cur_entry->stream_name_len);
677 DEBUG2("Stream name length = %u", cur_entry->stream_name_len);
679 cur_entry->stream_name = NULL;
680 cur_entry->stream_name_utf8 = NULL;
682 if (remaining_size < cur_entry->stream_name_len + 2) {
683 ERROR("Stream entries go past end of metadata resource");
684 ret = WIMLIB_ERR_INVALID_DENTRY;
685 goto out_free_ads_entries;
687 remaining_size -= cur_entry->stream_name_len + 2;
689 cur_entry->stream_name = MALLOC(cur_entry->stream_name_len);
690 if (!cur_entry->stream_name) {
691 ret = WIMLIB_ERR_NOMEM;
692 goto out_free_ads_entries;
694 p = get_bytes(p, cur_entry->stream_name_len,
695 (u8*)cur_entry->stream_name);
696 p += 2; /* NULL terminator of stream name */
697 cur_entry->stream_name_utf8 = utf16_to_utf8(cur_entry->stream_name,
698 cur_entry->stream_name_len,
700 cur_entry->stream_name_len_utf8 = utf8_len;
701 print_byte_field(p, 16);
703 if (!cur_entry->stream_name_utf8) {
704 ret = WIMLIB_ERR_NOMEM;
705 goto out_free_ads_entries;
708 dentry->ads_entries = ads_entries;
710 out_free_ads_entries:
711 for (u16 i = 0; i < num_ads; i++) {
712 FREE(ads_entries[i].stream_name);
713 FREE(ads_entries[i].stream_name_utf8);
720 * Reads a directory entry from the metadata resource.
722 int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
723 u64 offset, struct dentry *dentry)
728 char *file_name_utf8;
732 size_t file_name_utf8_len;
735 dentry_common_init(dentry);
737 /*Make sure the dentry really fits into the metadata resource.*/
738 if (offset + 8 > metadata_resource_len) {
739 ERROR("Directory entry starting at %"PRIu64" ends past the "
740 "end of the metadata resource (size %"PRIu64")",
741 offset, metadata_resource_len);
742 return WIMLIB_ERR_INVALID_DENTRY;
745 /* Before reading the whole entry, we need to read just the length.
746 * This is because an entry of length 8 (that is, just the length field)
747 * terminates the list of sibling directory entries. */
749 p = get_u64(&metadata_resource[offset], &dentry->length);
750 DEBUG("length = %zu, %zu\n", dentry->length, *(u64*)(&metadata_resource[offset]));
752 /* A zero length field (really a length of 8, since that's how big the
753 * directory entry is...) indicates that this is the end of directory
754 * dentry. We do not read it into memory as an actual dentry, so just
755 * return true in that case. */
756 if (dentry->length == 0)
759 if (offset + dentry->length >= metadata_resource_len) {
760 ERROR("Directory entry at offset %"PRIu64" and with size "
761 "%"PRIu64" ends past the end of the metadata resource "
763 offset, dentry->length, metadata_resource_len);
764 return WIMLIB_ERR_INVALID_DENTRY;
767 /* If it is a recognized length, read the rest of the directory entry.
768 * Note: The root directory entry has no name, and its length does not
769 * include the short name length field. */
770 if (dentry->length < WIM_DENTRY_DISK_SIZE) {
771 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
773 return WIMLIB_ERR_INVALID_DENTRY;
776 p = get_u32(p, &dentry->attributes);
777 p = get_u32(p, (u32*)&dentry->security_id);
778 p = get_u64(p, &dentry->subdir_offset);
780 /* 2 unused fields */
781 p += 2 * sizeof(u64);
782 /*p = get_u64(p, &dentry->unused1);*/
783 /*p = get_u64(p, &dentry->unused2);*/
785 p = get_u64(p, &dentry->creation_time);
786 p = get_u64(p, &dentry->last_access_time);
787 p = get_u64(p, &dentry->last_write_time);
789 p = get_bytes(p, WIM_HASH_SIZE, dentry->hash);
792 * I don't know what's going on here. It seems like M$ screwed up the
793 * reparse points, then put the fields in the same place and didn't
794 * document it. The WIM_HDR_FLAG_RP_FIX flag in the WIM header might
795 * have something to do with this, but it's not documented.
797 if (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
802 p = get_u32(p, &dentry->reparse_tag);
805 dentry->hard_link = (u64)(u1) | ((u64)(u2) << 32);
807 p = get_u32(p, &dentry->reparse_tag);
808 p = get_u64(p, &dentry->hard_link);
811 /* By the way, the reparse_reserved field does not actually exist (at
812 * least when the file is not a reparse point) */
815 p = get_u16(p, &dentry->num_ads);
817 p = get_u16(p, &short_name_len);
818 p = get_u16(p, &file_name_len);
820 calculated_size = WIM_DENTRY_DISK_SIZE + file_name_len + 2 +
823 if (dentry->length < calculated_size) {
824 ERROR("Unexpected end of directory entry! (Expected "
825 "%"PRIu64" bytes, got %"PRIu64" bytes. "
826 "short_name_len = %hu, file_name_len = %hu)",
827 calculated_size, dentry->length,
828 short_name_len, file_name_len);
829 return WIMLIB_ERR_INVALID_DENTRY;
832 /* Read the filename. */
833 file_name = MALLOC(file_name_len);
835 ERROR("Failed to allocate %hu bytes for dentry file name",
837 return WIMLIB_ERR_NOMEM;
839 p = get_bytes(p, file_name_len, file_name);
841 /* Convert filename to UTF-8. */
842 file_name_utf8 = utf16_to_utf8(file_name, file_name_len,
843 &file_name_utf8_len);
845 if (!file_name_utf8) {
846 ERROR("Failed to allocate memory to convert UTF-16 "
847 "filename (%hu bytes) to UTF-8", file_name_len);
848 ret = WIMLIB_ERR_NOMEM;
849 goto out_free_file_name;
852 /* Undocumented padding between file name and short name. This probably
853 * is supposed to be a terminating null character. */
856 /* Read the short filename. */
857 short_name = MALLOC(short_name_len);
859 ERROR("Failed to allocate %hu bytes for short filename",
861 ret = WIMLIB_ERR_NOMEM;
862 goto out_free_file_name_utf8;
865 p = get_bytes(p, short_name_len, short_name);
867 /* Some directory entries inexplicibly have a little over 70 bytes of
868 * extra data. The exact amount of data seems to be 72 bytes, but it is
869 * aligned on the next 8-byte boundary. Here's an example of the
872 * 01000000400000006c786bbac58ede11b0bb00261870892ab6adb76fe63a3
873 * e468fca86530d2effa16c786bbac58ede11b0bb00261870892a0000000000
874 * 0000000000000000000000
876 * Here's one interpretation of how the data is laid out.
879 * u32 field1; (always 0x00000001)
880 * u32 field2; (always 0x40000000)
886 * u64 reserved1; (always 0)
887 * u64 reserved2; (always 0)
890 if (dentry->length - calculated_size >= WIM_ADS_ENTRY_DISK_SIZE) {
891 printf("%s: %lu / %lu (", file_name_utf8,
892 calculated_size, dentry->length);
893 print_string(p + WIM_ADS_ENTRY_DISK_SIZE, dentry->length - calculated_size - WIM_ADS_ENTRY_DISK_SIZE);
895 print_byte_field(p, dentry->length - calculated_size);
900 if (dentry->num_ads != 0) {
901 ret = read_ads_entries(p, dentry,
902 metadata_resource_len - offset - calculated_size);
904 goto out_free_short_name;
907 dentry->file_name = file_name;
908 dentry->file_name_utf8 = file_name_utf8;
909 dentry->short_name = short_name;
910 dentry->file_name_len = file_name_len;
911 dentry->file_name_utf8_len = file_name_utf8_len;
912 dentry->short_name_len = short_name_len;
916 out_free_file_name_utf8:
917 FREE(file_name_utf8);
924 * Writes a dentry to an output buffer.
926 * @dentry: The dentry structure.
927 * @p: The memory location to write the data to.
928 * @return: Pointer to the byte after the last byte we wrote as part of the
931 static u8 *write_dentry(const struct dentry *dentry, u8 *p)
934 memset(p, 0, dentry->length);
935 p = put_u64(p, dentry->length);
936 p = put_u32(p, dentry->attributes);
937 p = put_u32(p, dentry->security_id);
938 p = put_u64(p, dentry->subdir_offset);
939 p = put_u64(p, 0); /* unused1 */
940 p = put_u64(p, 0); /* unused2 */
941 p = put_u64(p, dentry->creation_time);
942 p = put_u64(p, dentry->last_access_time);
943 p = put_u64(p, dentry->last_write_time);
944 memcpy(p, dentry->hash, WIM_HASH_SIZE);
946 p = put_u32(p, dentry->reparse_tag);
947 p = put_u64(p, dentry->hard_link);
948 p = put_u16(p, dentry->num_ads); /*streams */
949 p = put_u16(p, dentry->short_name_len);
950 p = put_u16(p, dentry->file_name_len);
951 p = put_bytes(p, dentry->file_name_len, (u8*)dentry->file_name);
952 p = put_u16(p, 0); /* filename padding, 2 bytes. */
953 p = put_bytes(p, dentry->short_name_len, (u8*)dentry->short_name);
954 for (u16 i = 0; i < dentry->num_ads; i++) {
955 p = put_u64(p, ads_entry_length(&dentry->ads_entries[i]));
956 p = put_u64(p, 0); /* Unused */
957 p = put_bytes(p, WIM_HASH_SIZE, dentry->ads_entries[i].hash);
958 p = put_u16(p, dentry->ads_entries[i].stream_name_len);
959 p = put_bytes(p, dentry->ads_entries[i].stream_name_len,
960 (u8*)dentry->ads_entries[i].stream_name);
962 return orig_p + dentry->length;
965 /* Recursive function that writes a dentry tree rooted at @tree, not including
966 * @tree itself, which has already been written, except in the case of the root
967 * dentry, which is written right away, along with an end-of-directory entry. */
968 u8 *write_dentry_tree(const struct dentry *tree, u8 *p)
970 const struct dentry *child;
972 if (dentry_is_root(tree)) {
973 p = write_dentry(tree, p);
975 /* write end of directory entry */
978 /* Nothing to do for a regular file. */
979 if (dentry_is_regular_file(tree))
983 /* Write child dentries and end-of-directory entry. */
984 child = tree->children;
987 p = write_dentry(child, p);
989 } while (child != tree->children);
992 /* write end of directory entry */
995 /* Recurse on children. */
998 p = write_dentry_tree(child, p);
1000 } while (child != tree->children);
1005 /* Reads the children of a dentry, and all their children, ..., etc. from the
1006 * metadata resource and into the dentry tree.
1008 * @metadata_resource: An array that contains the uncompressed metadata
1009 * resource for the WIM file.
1010 * @metadata_resource_len: The length of @metadata_resource.
1011 * @dentry: A pointer to a struct dentry that is the root of the directory
1012 * tree and has already been read from the metadata resource. It
1013 * does not need to be the real root because this procedure is
1014 * called recursively.
1016 * @return: Zero on success, nonzero on failure.
1018 int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
1019 struct dentry *dentry)
1021 u64 cur_offset = dentry->subdir_offset;
1022 struct dentry *prev_child = NULL;
1023 struct dentry *first_child = NULL;
1024 struct dentry *child;
1025 struct dentry cur_child;
1028 /* If @dentry is a regular file, nothing more needs to be done for this
1030 if (cur_offset == 0)
1033 /* Find and read all the children of @dentry. */
1036 /* Read next child of @dentry into @cur_child. */
1037 ret = read_dentry(metadata_resource, metadata_resource_len,
1038 cur_offset, &cur_child);
1042 /* Check for end of directory. */
1043 if (cur_child.length == 0) {
1048 /* Not end of directory. Allocate this child permanently and
1049 * link it to the parent and previous child. */
1050 child = MALLOC(sizeof(struct dentry));
1052 ERROR("Failed to allocate %zu bytes for new dentry",
1053 sizeof(struct dentry));
1054 ret = WIMLIB_ERR_NOMEM;
1057 memcpy(child, &cur_child, sizeof(struct dentry));
1060 prev_child->next = child;
1061 child->prev = prev_child;
1063 first_child = child;
1066 child->parent = dentry;
1069 /* If there are children of this child, call this procedure
1071 if (child->subdir_offset != 0) {
1072 ret = read_dentry_tree(metadata_resource,
1073 metadata_resource_len, child);
1078 /* Advance to the offset of the next child. */
1079 cur_offset += dentry_total_length(child);
1082 /* Link last child to first one, and set parent's
1083 * children pointer to the first child. */
1085 prev_child->next = first_child;
1086 first_child->prev = prev_child;
1088 dentry->children = first_child;