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 for (u16 i = 0 ; i < dentry->num_ads; i++)
48 length += ads_entry_length(&dentry->ads_entries[i]);
50 /* Round to 8 byte boundary. */
51 return (length + 7) & ~7;
54 /* Transfers file attributes from a `stat' buffer to a struct dentry. */
55 void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry)
57 if (S_ISDIR(stbuf->st_mode))
58 dentry->attributes = FILE_ATTRIBUTE_DIRECTORY;
60 dentry->attributes = FILE_ATTRIBUTE_NORMAL;
63 /* Transfers file attributes from a struct dentry to a `stat' buffer. */
64 void dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf,
65 const struct lookup_table *table)
67 struct lookup_table_entry *lte;
69 if (dentry_is_directory(dentry))
70 stbuf->st_mode = S_IFDIR | 0755;
72 stbuf->st_mode = S_IFREG | 0644;
75 lte = lookup_resource(table, dentry->hash);
80 stbuf->st_nlink = lte->refcnt;
81 stbuf->st_size = lte->resource_entry.original_size;
86 stbuf->st_uid = getuid();
87 stbuf->st_gid = getgid();
88 stbuf->st_atime = ms_timestamp_to_unix(dentry->last_access_time);
89 stbuf->st_mtime = ms_timestamp_to_unix(dentry->last_write_time);
90 stbuf->st_ctime = ms_timestamp_to_unix(dentry->creation_time);
91 stbuf->st_blocks = (stbuf->st_size + 511) / 512;
94 /* Makes all timestamp fields for the dentry be the current time. */
95 void dentry_update_all_timestamps(struct dentry *dentry)
97 u64 now = get_timestamp();
98 dentry->creation_time = now;
99 dentry->last_access_time = now;
100 dentry->last_write_time = now;
104 * Calls a function on all directory entries in a directory tree. It is called
105 * on a parent before its children.
107 int for_dentry_in_tree(struct dentry *root,
108 int (*visitor)(struct dentry*, void*), void *arg)
111 struct dentry *child;
113 ret = visitor(root, arg);
118 child = root->children;
124 ret = for_dentry_in_tree(child, visitor, arg);
128 } while (child != root->children);
133 * Like for_dentry_in_tree(), but the visitor function is always called on a
134 * dentry's children before on itself.
136 int for_dentry_in_tree_depth(struct dentry *root,
137 int (*visitor)(struct dentry*, void*), void *arg)
140 struct dentry *child;
143 child = root->children;
147 ret = for_dentry_in_tree_depth(child, visitor, arg);
151 } while (child != root->children);
153 return visitor(root, arg);
157 * Calculate the full path of @dentry, based on its parent's full path and on
158 * its UTF-8 file name.
160 int calculate_dentry_full_path(struct dentry *dentry, void *ignore)
164 if (dentry_is_root(dentry)) {
165 full_path = MALLOC(2);
172 char *parent_full_path;
173 u32 parent_full_path_len;
174 const struct dentry *parent = dentry->parent;
176 if (dentry_is_root(parent)) {
177 parent_full_path = "";
178 parent_full_path_len = 0;
180 parent_full_path = parent->full_path_utf8;
181 parent_full_path_len = parent->full_path_utf8_len;
184 full_path_len = parent_full_path_len + 1 +
185 dentry->file_name_utf8_len;
186 full_path = MALLOC(full_path_len + 1);
190 memcpy(full_path, parent_full_path, parent_full_path_len);
191 full_path[parent_full_path_len] = '/';
192 memcpy(full_path + parent_full_path_len + 1,
193 dentry->file_name_utf8,
194 dentry->file_name_utf8_len);
195 full_path[full_path_len] = '\0';
197 FREE(dentry->full_path_utf8);
198 dentry->full_path_utf8 = full_path;
199 dentry->full_path_utf8_len = full_path_len;
202 ERROR("Out of memory while calculating dentry full path");
203 return WIMLIB_ERR_NOMEM;
207 * Recursively calculates the subdir offsets for a directory tree.
209 * @dentry: The root of the directory tree.
210 * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory
211 * offset for @dentry.
213 void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p)
215 struct dentry *child;
217 child = dentry->children;
218 dentry->subdir_offset = *subdir_offset_p;
221 /* Advance the subdir offset by the amount of space the children
222 * of this dentry take up. */
224 *subdir_offset_p += dentry_total_length(child);
226 } while (child != dentry->children);
228 /* End-of-directory dentry on disk. */
229 *subdir_offset_p += 8;
231 /* Recursively call calculate_subdir_offsets() on all the
234 calculate_subdir_offsets(child, subdir_offset_p);
236 } while (child != dentry->children);
238 /* On disk, childless directories have a valid subdir_offset
239 * that points to an 8-byte end-of-directory dentry. Regular
240 * files have a subdir_offset of 0. */
241 if (dentry_is_directory(dentry))
242 *subdir_offset_p += 8;
244 dentry->subdir_offset = 0;
249 /* Returns the child of @dentry that has the file name @name.
250 * Returns NULL if no child has the name. */
251 struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
254 struct dentry *child;
257 child = dentry->children;
259 name_len = strlen(name);
261 if (dentry_has_name(child, name, name_len))
264 } while (child != dentry->children);
269 /* Retrieves the dentry that has the UTF-8 @path relative to the dentry
270 * @cur_dir. Returns NULL if no dentry having the path is found. */
271 static struct dentry *get_dentry_relative_path(struct dentry *cur_dir, const char *path)
273 struct dentry *child;
275 const char *new_path;
280 child = cur_dir->children;
282 new_path = path_next_part(path, &base_len);
284 if (dentry_has_name(child, path, base_len))
285 return get_dentry_relative_path(child, new_path);
287 } while (child != cur_dir->children);
292 /* Returns the dentry corresponding to the UTF-8 @path, or NULL if there is no
294 struct dentry *get_dentry(WIMStruct *w, const char *path)
296 struct dentry *root = wim_root_dentry(w);
299 return get_dentry_relative_path(root, path);
302 /* Returns the parent directory for the @path. */
303 struct dentry *get_parent_dentry(WIMStruct *w, const char *path)
305 size_t path_len = strlen(path);
306 char buf[path_len + 1];
308 memcpy(buf, path, path_len + 1);
310 to_parent_name(buf, path_len);
312 return get_dentry(w, buf);
315 /* Prints the full path of a dentry. */
316 int print_dentry_full_path(struct dentry *dentry, void *ignore)
318 if (dentry->full_path_utf8)
319 puts(dentry->full_path_utf8);
323 struct file_attr_flag {
327 struct file_attr_flag file_attr_flags[] = {
328 {FILE_ATTRIBUTE_READONLY, "READONLY"},
329 {FILE_ATTRIBUTE_HIDDEN, "HIDDEN"},
330 {FILE_ATTRIBUTE_SYSTEM, "SYSTEM"},
331 {FILE_ATTRIBUTE_DIRECTORY, "DIRECTORY"},
332 {FILE_ATTRIBUTE_ARCHIVE, "ARCHIVE"},
333 {FILE_ATTRIBUTE_DEVICE, "DEVICE"},
334 {FILE_ATTRIBUTE_NORMAL, "NORMAL"},
335 {FILE_ATTRIBUTE_TEMPORARY, "TEMPORARY"},
336 {FILE_ATTRIBUTE_SPARSE_FILE, "SPARSE_FILE"},
337 {FILE_ATTRIBUTE_REPARSE_POINT, "REPARSE_POINT"},
338 {FILE_ATTRIBUTE_COMPRESSED, "COMPRESSED"},
339 {FILE_ATTRIBUTE_OFFLINE, "OFFLINE"},
340 {FILE_ATTRIBUTE_NOT_CONTENT_INDEXED,"NOT_CONTENT_INDEXED"},
341 {FILE_ATTRIBUTE_ENCRYPTED, "ENCRYPTED"},
342 {FILE_ATTRIBUTE_VIRTUAL, "VIRTUAL"},
345 /* Prints a directory entry. @lookup_table is a pointer to the lookup table, or
346 * NULL if the resource entry for the dentry is not to be printed. */
347 int print_dentry(struct dentry *dentry, void *lookup_table)
349 struct lookup_table_entry *lte;
352 printf("[DENTRY]\n");
353 printf("Length = %"PRIu64"\n", dentry->length);
354 printf("Attributes = 0x%x\n", dentry->attributes);
355 for (i = 0; i < ARRAY_LEN(file_attr_flags); i++)
356 if (file_attr_flags[i].flag & dentry->attributes)
357 printf(" FILE_ATTRIBUTE_%s is set\n",
358 file_attr_flags[i].name);
359 printf("Security ID = %d\n", dentry->security_id);
360 printf("Subdir offset = %"PRIu64"\n", dentry->subdir_offset);
361 /*printf("Unused1 = 0x%"PRIu64"\n", dentry->unused1);*/
362 /*printf("Unused2 = %"PRIu64"\n", dentry->unused2);*/
363 printf("Creation Time = %"PRIu64"\n", dentry->creation_time);
364 printf("Last Access Time = %"PRIu64"\n", dentry->last_access_time);
365 printf("Last Write Time = %"PRIu64"\n", dentry->last_write_time);
366 printf("Creation Time = 0x%"PRIx64"\n", dentry->creation_time);
368 print_hash(dentry->hash);
370 printf("Reparse Tag = 0x%"PRIx32"\n", dentry->reparse_tag);
371 printf("Hard Link Group = 0x%"PRIx64"\n", dentry->hard_link);
372 printf("Number of Alternate Data Streams = %hu\n", dentry->num_ads);
373 printf("Filename = \"");
374 print_string(dentry->file_name, dentry->file_name_len);
376 printf("Filename Length = %hu\n", dentry->file_name_len);
377 printf("Filename (UTF-8) = \"%s\"\n", dentry->file_name_utf8);
378 printf("Filename (UTF-8) Length = %hu\n", dentry->file_name_utf8_len);
379 printf("Short Name = \"");
380 print_string(dentry->short_name, dentry->short_name_len);
382 printf("Short Name Length = %hu\n", dentry->short_name_len);
383 printf("Full Path (UTF-8) = \"%s\"\n", dentry->full_path_utf8);
385 lte = lookup_resource(lookup_table, dentry->hash);
387 print_lookup_table_entry(lte, NULL);
393 for (u16 i = 0; i < dentry->num_ads; i++) {
394 printf("[Alternate Stream Entry %u]\n", i);
395 printf("Name = \"%s\"\n", dentry->ads_entries[i].stream_name_utf8);
396 lte = lookup_resource(lookup_table, dentry->ads_entries[i].hash);
398 print_lookup_table_entry(lte, NULL);
405 static inline void dentry_common_init(struct dentry *dentry)
407 memset(dentry, 0, sizeof(struct dentry));
409 dentry->security_id = -1;
413 * Creates an unlinked directory entry.
415 * @name: The base name of the new dentry.
416 * @return: A pointer to the new dentry, or NULL if out of memory.
418 struct dentry *new_dentry(const char *name)
420 struct dentry *dentry;
422 dentry = MALLOC(sizeof(struct dentry));
426 dentry_common_init(dentry);
427 if (change_dentry_name(dentry, name) != 0) {
432 dentry_update_all_timestamps(dentry);
433 dentry->next = dentry;
434 dentry->prev = dentry;
435 dentry->parent = dentry;
440 void free_dentry(struct dentry *dentry)
442 FREE(dentry->file_name);
443 FREE(dentry->file_name_utf8);
444 FREE(dentry->short_name);
445 FREE(dentry->full_path_utf8);
449 /* Arguments for do_free_dentry(). */
450 struct free_dentry_args {
451 struct lookup_table *lookup_table;
452 bool lt_decrement_refcnt;
456 * This function is passed as an argument to for_dentry_in_tree_depth() in order
457 * to free a directory tree. __args is a pointer to a `struct free_dentry_args'.
459 static int do_free_dentry(struct dentry *dentry, void *__args)
461 struct free_dentry_args *args = (struct free_dentry_args*)__args;
463 if (args->lt_decrement_refcnt && !dentry_is_directory(dentry)) {
464 lookup_table_decrement_refcnt(args->lookup_table,
468 wimlib_assert(dentry->refcnt >= 1);
469 if (--dentry->refcnt == 0)
475 * Unlinks and frees a dentry tree.
477 * @root: The root of the tree.
478 * @lookup_table: The lookup table for dentries.
479 * @decrement_refcnt: True if the dentries in the tree are to have their
480 * reference counts in the lookup table decremented.
482 void free_dentry_tree(struct dentry *root, struct lookup_table *lookup_table,
483 bool lt_decrement_refcnt)
485 if (!root || !root->parent)
488 struct free_dentry_args args;
489 args.lookup_table = lookup_table;
490 args.lt_decrement_refcnt = lt_decrement_refcnt;
491 for_dentry_in_tree_depth(root, do_free_dentry, &args);
494 int increment_dentry_refcnt(struct dentry *dentry, void *ignore)
501 * Links a dentry into the directory tree.
503 * @dentry: The dentry to link.
504 * @parent: The dentry that will be the parent of @dentry.
506 void link_dentry(struct dentry *dentry, struct dentry *parent)
508 dentry->parent = parent;
509 if (parent->children) {
510 /* Not an only child; link to siblings. */
511 dentry->next = parent->children;
512 dentry->prev = parent->children->prev;
513 dentry->next->prev = dentry;
514 dentry->prev->next = dentry;
516 /* Only child; link to parent. */
517 parent->children = dentry;
518 dentry->next = dentry;
519 dentry->prev = dentry;
523 /* Unlink a dentry from the directory tree. */
524 void unlink_dentry(struct dentry *dentry)
526 if (dentry_is_root(dentry))
528 if (dentry_is_only_child(dentry)) {
529 dentry->parent->children = NULL;
531 if (dentry_is_first_sibling(dentry))
532 dentry->parent->children = dentry->next;
533 dentry->next->prev = dentry->prev;
534 dentry->prev->next = dentry->next;
539 /* Recalculates the length of @dentry based on its file name length and short
541 static inline void recalculate_dentry_size(struct dentry *dentry)
543 dentry->length = WIM_DENTRY_DISK_SIZE + dentry->file_name_len +
544 2 + dentry->short_name_len + 2;
545 /* Must be multiple of 8. */
546 dentry->length = (dentry->length + 7) & ~7;
549 /* Changes the name of a dentry to @new_name. Only changes the file_name and
550 * file_name_utf8 fields; does not change the short_name, short_name_utf8, or
551 * full_path_utf8 fields. Also recalculates its length. */
552 int change_dentry_name(struct dentry *dentry, const char *new_name)
557 FREE(dentry->file_name);
559 utf8_len = strlen(new_name);
561 dentry->file_name = utf8_to_utf16(new_name, utf8_len, &utf16_len);
563 if (!dentry->file_name)
564 return WIMLIB_ERR_NOMEM;
566 FREE(dentry->file_name_utf8);
567 dentry->file_name_utf8 = MALLOC(utf8_len + 1);
568 if (!dentry->file_name_utf8) {
569 FREE(dentry->file_name);
570 dentry->file_name = NULL;
571 return WIMLIB_ERR_NOMEM;
574 dentry->file_name_len = utf16_len;
575 dentry->file_name_utf8_len = utf8_len;
576 memcpy(dentry->file_name_utf8, new_name, utf8_len + 1);
577 recalculate_dentry_size(dentry);
581 /* Parameters for calculate_dentry_statistics(). */
582 struct image_statistics {
583 struct lookup_table *lookup_table;
587 u64 *hard_link_bytes;
590 static int calculate_dentry_statistics(struct dentry *dentry, void *arg)
592 struct image_statistics *stats;
593 struct lookup_table_entry *lte;
596 lte = lookup_resource(stats->lookup_table, dentry->hash);
598 if (dentry_is_directory(dentry) && !dentry_is_root(dentry))
601 ++*stats->file_count;
604 u64 size = lte->resource_entry.original_size;
605 *stats->total_bytes += size;
606 if (++lte->out_refcnt == 1)
607 *stats->hard_link_bytes += size;
612 void calculate_dir_tree_statistics(struct dentry *root, struct lookup_table *table,
613 u64 *dir_count_ret, u64 *file_count_ret,
614 u64 *total_bytes_ret,
615 u64 *hard_link_bytes_ret)
617 struct image_statistics stats;
620 *total_bytes_ret = 0;
621 *hard_link_bytes_ret = 0;
622 stats.lookup_table = table;
623 stats.dir_count = dir_count_ret;
624 stats.file_count = file_count_ret;
625 stats.total_bytes = total_bytes_ret;
626 stats.hard_link_bytes = hard_link_bytes_ret;
627 for_lookup_table_entry(table, zero_out_refcnts, NULL);
628 for_dentry_in_tree(root, calculate_dentry_statistics, &stats);
631 static int read_ads_entries(const u8 *p, struct dentry *dentry,
634 u16 num_ads = dentry->num_ads;
635 struct ads_entry *ads_entries = CALLOC(num_ads, sizeof(struct ads_entry));
638 ERROR("Could not allocate memory for %"PRIu16" "
639 "alternate data stream entries", num_ads);
640 return WIMLIB_ERR_NOMEM;
642 DEBUG2("Reading %"PRIu16" alternate data streams "
643 "(remaining size = %"PRIu64")", num_ads, remaining_size);
645 for (u16 i = 0; i < num_ads; i++) {
646 struct ads_entry *cur_entry = &ads_entries[i];
649 const char *p_save = p;
650 /* Read the base stream entry, excluding the stream name. */
651 if (remaining_size < WIM_ADS_ENTRY_DISK_SIZE) {
652 ERROR("Stream entries go past end of metadata resource");
653 ERROR("(remaining_size = %"PRIu64")", remaining_size);
654 ret = WIMLIB_ERR_INVALID_DENTRY;
655 goto out_free_ads_entries;
657 remaining_size -= WIM_ADS_ENTRY_DISK_SIZE;
658 /*print_string(p + 40, 10);*/
659 /*print_byte_field(p, 50);*/
661 p = get_u64(p, &length); /* ADS entry length */
663 DEBUG2("ADS length = %"PRIu64, length);
666 p = get_bytes(p, WIM_HASH_SIZE, (u8*)cur_entry->hash);
667 p = get_u16(p, &cur_entry->stream_name_len);
669 DEBUG2("Stream name length = %u", cur_entry->stream_name_len);
671 cur_entry->stream_name = NULL;
672 cur_entry->stream_name_utf8 = NULL;
674 if (remaining_size < cur_entry->stream_name_len + 2) {
675 ERROR("Stream entries go past end of metadata resource");
676 ERROR("(remaining_size = %"PRIu64" bytes, stream_name_len "
677 "= %"PRIu16" bytes", remaining_size,
678 cur_entry->stream_name_len);
679 ret = WIMLIB_ERR_INVALID_DENTRY;
680 goto out_free_ads_entries;
682 remaining_size -= cur_entry->stream_name_len + 2;
684 cur_entry->stream_name = MALLOC(cur_entry->stream_name_len);
685 if (!cur_entry->stream_name) {
686 ret = WIMLIB_ERR_NOMEM;
687 goto out_free_ads_entries;
689 get_bytes(p, cur_entry->stream_name_len,
690 (u8*)cur_entry->stream_name);
691 cur_entry->stream_name_utf8 = utf16_to_utf8(cur_entry->stream_name,
692 cur_entry->stream_name_len,
694 cur_entry->stream_name_len_utf8 = utf8_len;
696 if (!cur_entry->stream_name_utf8) {
697 ret = WIMLIB_ERR_NOMEM;
698 goto out_free_ads_entries;
700 p = p_save + ads_entry_length(cur_entry);
702 dentry->ads_entries = ads_entries;
704 out_free_ads_entries:
705 for (u16 i = 0; i < num_ads; i++) {
706 FREE(ads_entries[i].stream_name);
707 FREE(ads_entries[i].stream_name_utf8);
714 * Reads a directory entry from the metadata resource.
716 int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
717 u64 offset, struct dentry *dentry)
722 char *file_name_utf8;
726 size_t file_name_utf8_len;
729 dentry_common_init(dentry);
731 /*Make sure the dentry really fits into the metadata resource.*/
732 if (offset + 8 > metadata_resource_len) {
733 ERROR("Directory entry starting at %"PRIu64" ends past the "
734 "end of the metadata resource (size %"PRIu64")",
735 offset, metadata_resource_len);
736 return WIMLIB_ERR_INVALID_DENTRY;
739 /* Before reading the whole entry, we need to read just the length.
740 * This is because an entry of length 8 (that is, just the length field)
741 * terminates the list of sibling directory entries. */
743 p = get_u64(&metadata_resource[offset], &dentry->length);
745 /* A zero length field (really a length of 8, since that's how big the
746 * directory entry is...) indicates that this is the end of directory
747 * dentry. We do not read it into memory as an actual dentry, so just
748 * return true in that case. */
749 if (dentry->length == 0)
752 if (offset + dentry->length >= metadata_resource_len) {
753 ERROR("Directory entry at offset %"PRIu64" and with size "
754 "%"PRIu64" ends past the end of the metadata resource "
756 offset, dentry->length, metadata_resource_len);
757 return WIMLIB_ERR_INVALID_DENTRY;
760 /* If it is a recognized length, read the rest of the directory entry.
761 * Note: The root directory entry has no name, and its length does not
762 * include the short name length field. */
763 if (dentry->length < WIM_DENTRY_DISK_SIZE) {
764 ERROR("Directory entry has invalid length of %"PRIu64" bytes",
766 return WIMLIB_ERR_INVALID_DENTRY;
769 p = get_u32(p, &dentry->attributes);
770 p = get_u32(p, (u32*)&dentry->security_id);
771 p = get_u64(p, &dentry->subdir_offset);
773 /* 2 unused fields */
774 p += 2 * sizeof(u64);
775 /*p = get_u64(p, &dentry->unused1);*/
776 /*p = get_u64(p, &dentry->unused2);*/
778 p = get_u64(p, &dentry->creation_time);
779 p = get_u64(p, &dentry->last_access_time);
780 p = get_u64(p, &dentry->last_write_time);
782 p = get_bytes(p, WIM_HASH_SIZE, dentry->hash);
785 * I don't know what's going on here. It seems like M$ screwed up the
786 * reparse points, then put the fields in the same place and didn't
787 * document it. The WIM_HDR_FLAG_RP_FIX flag in the WIM header might
788 * have something to do with this, but it's not documented.
790 if (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
795 p = get_u32(p, &dentry->reparse_tag);
798 dentry->hard_link = (u64)(u1) | ((u64)(u2) << 32);
800 p = get_u32(p, &dentry->reparse_tag);
801 p = get_u64(p, &dentry->hard_link);
804 /* By the way, the reparse_reserved field does not actually exist (at
805 * least when the file is not a reparse point) */
808 p = get_u16(p, &dentry->num_ads);
810 p = get_u16(p, &short_name_len);
811 p = get_u16(p, &file_name_len);
813 calculated_size = WIM_DENTRY_DISK_SIZE + file_name_len + 2 +
816 if (dentry->length < calculated_size) {
817 ERROR("Unexpected end of directory entry! (Expected "
818 "%"PRIu64" bytes, got %"PRIu64" bytes. "
819 "short_name_len = %hu, file_name_len = %hu)",
820 calculated_size, dentry->length,
821 short_name_len, file_name_len);
822 return WIMLIB_ERR_INVALID_DENTRY;
825 /* Read the filename. */
826 file_name = MALLOC(file_name_len);
828 ERROR("Failed to allocate %hu bytes for dentry file name",
830 return WIMLIB_ERR_NOMEM;
832 p = get_bytes(p, file_name_len, file_name);
834 /* Convert filename to UTF-8. */
835 file_name_utf8 = utf16_to_utf8(file_name, file_name_len,
836 &file_name_utf8_len);
838 if (!file_name_utf8) {
839 ERROR("Failed to allocate memory to convert UTF-16 "
840 "filename (%hu bytes) to UTF-8", file_name_len);
841 ret = WIMLIB_ERR_NOMEM;
842 goto out_free_file_name;
845 /* Undocumented padding between file name and short name. This probably
846 * is supposed to be a terminating null character. */
849 /* Read the short filename. */
850 short_name = MALLOC(short_name_len);
852 ERROR("Failed to allocate %hu bytes for short filename",
854 ret = WIMLIB_ERR_NOMEM;
855 goto out_free_file_name_utf8;
858 p = get_bytes(p, short_name_len, short_name);
860 /* Some directory entries inexplicibly have a little over 70 bytes of
861 * extra data. The exact amount of data seems to be 72 bytes, but it is
862 * aligned on the next 8-byte boundary. Here's an example of the
865 * 01000000400000006c786bbac58ede11b0bb00261870892ab6adb76fe63a3
866 * e468fca86530d2effa16c786bbac58ede11b0bb00261870892a0000000000
867 * 0000000000000000000000
869 * Here's one interpretation of how the data is laid out.
872 * u32 field1; (always 0x00000001)
873 * u32 field2; (always 0x40000000)
879 * u64 reserved1; (always 0)
880 * u64 reserved2; (always 0)
883 if (dentry->length - calculated_size >= WIM_ADS_ENTRY_DISK_SIZE) {
884 printf("%s: %lu / %lu (", file_name_utf8,
885 calculated_size, dentry->length);
886 print_string(p + WIM_ADS_ENTRY_DISK_SIZE, dentry->length - calculated_size - WIM_ADS_ENTRY_DISK_SIZE);
888 print_byte_field(p, dentry->length - calculated_size);
893 if (dentry->num_ads != 0) {
894 ret = read_ads_entries(p, dentry,
895 metadata_resource_len - offset - calculated_size);
897 goto out_free_short_name;
900 dentry->file_name = file_name;
901 dentry->file_name_utf8 = file_name_utf8;
902 dentry->short_name = short_name;
903 dentry->file_name_len = file_name_len;
904 dentry->file_name_utf8_len = file_name_utf8_len;
905 dentry->short_name_len = short_name_len;
909 out_free_file_name_utf8:
910 FREE(file_name_utf8);
917 * Writes a dentry to an output buffer.
919 * @dentry: The dentry structure.
920 * @p: The memory location to write the data to.
921 * @return: Pointer to the byte after the last byte we wrote as part of the
924 static u8 *write_dentry(const struct dentry *dentry, u8 *p)
927 memset(p, 0, dentry->length);
928 p = put_u64(p, dentry->length);
929 p = put_u32(p, dentry->attributes);
930 p = put_u32(p, dentry->security_id);
931 p = put_u64(p, dentry->subdir_offset);
932 p = put_u64(p, 0); /* unused1 */
933 p = put_u64(p, 0); /* unused2 */
934 p = put_u64(p, dentry->creation_time);
935 p = put_u64(p, dentry->last_access_time);
936 p = put_u64(p, dentry->last_write_time);
937 memcpy(p, dentry->hash, WIM_HASH_SIZE);
939 p = put_u32(p, dentry->reparse_tag);
940 p = put_u64(p, dentry->hard_link);
941 p = put_u16(p, dentry->num_ads); /*streams */
942 p = put_u16(p, dentry->short_name_len);
943 p = put_u16(p, dentry->file_name_len);
944 p = put_bytes(p, dentry->file_name_len, (u8*)dentry->file_name);
945 p = put_u16(p, 0); /* filename padding, 2 bytes. */
946 p = put_bytes(p, dentry->short_name_len, (u8*)dentry->short_name);
947 for (u16 i = 0; i < dentry->num_ads; i++) {
948 p = put_u64(p, ads_entry_length(&dentry->ads_entries[i]));
949 p = put_u64(p, 0); /* Unused */
950 p = put_bytes(p, WIM_HASH_SIZE, dentry->ads_entries[i].hash);
951 p = put_u16(p, dentry->ads_entries[i].stream_name_len);
952 p = put_bytes(p, dentry->ads_entries[i].stream_name_len,
953 (u8*)dentry->ads_entries[i].stream_name);
955 return orig_p + dentry->length;
958 /* Recursive function that writes a dentry tree rooted at @tree, not including
959 * @tree itself, which has already been written, except in the case of the root
960 * dentry, which is written right away, along with an end-of-directory entry. */
961 u8 *write_dentry_tree(const struct dentry *tree, u8 *p)
963 const struct dentry *child;
965 if (dentry_is_root(tree)) {
966 p = write_dentry(tree, p);
968 /* write end of directory entry */
971 /* Nothing to do for a regular file. */
972 if (dentry_is_regular_file(tree))
976 /* Write child dentries and end-of-directory entry. */
977 child = tree->children;
980 p = write_dentry(child, p);
982 } while (child != tree->children);
985 /* write end of directory entry */
988 /* Recurse on children. */
991 p = write_dentry_tree(child, p);
993 } while (child != tree->children);
998 /* Reads the children of a dentry, and all their children, ..., etc. from the
999 * metadata resource and into the dentry tree.
1001 * @metadata_resource: An array that contains the uncompressed metadata
1002 * resource for the WIM file.
1003 * @metadata_resource_len: The length of @metadata_resource.
1004 * @dentry: A pointer to a struct dentry that is the root of the directory
1005 * tree and has already been read from the metadata resource. It
1006 * does not need to be the real root because this procedure is
1007 * called recursively.
1009 * @return: Zero on success, nonzero on failure.
1011 int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
1012 struct dentry *dentry)
1014 u64 cur_offset = dentry->subdir_offset;
1015 struct dentry *prev_child = NULL;
1016 struct dentry *first_child = NULL;
1017 struct dentry *child;
1018 struct dentry cur_child;
1021 /* If @dentry is a regular file, nothing more needs to be done for this
1023 if (cur_offset == 0)
1026 /* Find and read all the children of @dentry. */
1029 /* Read next child of @dentry into @cur_child. */
1030 ret = read_dentry(metadata_resource, metadata_resource_len,
1031 cur_offset, &cur_child);
1035 /* Check for end of directory. */
1036 if (cur_child.length == 0) {
1041 /* Not end of directory. Allocate this child permanently and
1042 * link it to the parent and previous child. */
1043 child = MALLOC(sizeof(struct dentry));
1045 ERROR("Failed to allocate %zu bytes for new dentry",
1046 sizeof(struct dentry));
1047 ret = WIMLIB_ERR_NOMEM;
1050 memcpy(child, &cur_child, sizeof(struct dentry));
1053 prev_child->next = child;
1054 child->prev = prev_child;
1056 first_child = child;
1059 child->parent = dentry;
1062 /* If there are children of this child, call this procedure
1064 if (child->subdir_offset != 0) {
1065 ret = read_dentry_tree(metadata_resource,
1066 metadata_resource_len, child);
1071 /* Advance to the offset of the next child. */
1072 cur_offset += dentry_total_length(child);
1075 /* Link last child to first one, and set parent's
1076 * children pointer to the first child. */
1078 prev_child->next = first_child;
1079 first_child->prev = prev_child;
1081 dentry->children = first_child;