X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fdentry.c;h=90cadb433190f53742e17965ad65598199056861;hp=d92fb85263942593b02afa228a423b5d39e7507f;hb=c7af42d3d894338bbd1cb7f4b77948f746485482;hpb=89198eafbaf6afac99dc74f77753466f9c1bc7f0 diff --git a/src/dentry.c b/src/dentry.c index d92fb852..90cadb43 100644 --- a/src/dentry.c +++ b/src/dentry.c @@ -1,12 +1,11 @@ /* * dentry.c * - * A dentry (directory entry) contains the metadata for a file. In the WIM file - * format, the dentries are stored in the "metadata resource" section right - * after the security data. Each image in the WIM file has its own metadata - * resource with its own security data and dentry tree. Dentries in different - * images may share file resources by referring to the same lookup table - * entries. + * In the WIM file format, the dentries are stored in the "metadata resource" + * section right after the security data. Each image in the WIM file has its + * own metadata resource with its own security data and dentry tree. Dentries + * in different images may share file resources by referring to the same lookup + * table entries. */ /* @@ -27,19 +26,16 @@ * wimlib; if not, see http://www.gnu.org/licenses/. */ -#include -#include -#include -#include - +#include "buffer_io.h" #include "dentry.h" -#include "io.h" #include "lookup_table.h" -#include "sha1.h" #include "timestamp.h" #include "wimlib_internal.h" +#include - +/* Calculates the unaligned length, in bytes, of an on-disk WIM dentry that has + * a file name and short name that take the specified numbers of bytes. This + * excludes any alternate data stream entries that may follow the dentry. */ static u64 __dentry_correct_length_unaligned(u16 file_name_len, u16 short_name_len) { @@ -51,32 +47,26 @@ static u64 __dentry_correct_length_unaligned(u16 file_name_len, return length; } -static u64 dentry_correct_length_unaligned(const struct dentry *dentry) +/* Calculates the unaligned length, in bytes, of an on-disk WIM dentry, based on + * the file name length and short name length. Note that dentry->length is + * ignored; also, this excludes any alternate data stream entries that may + * follow the dentry. */ +static u64 dentry_correct_length_unaligned(const struct wim_dentry *dentry) { return __dentry_correct_length_unaligned(dentry->file_name_len, dentry->short_name_len); } -/* Return the "correct" value to write in the length field of the dentry, based - * on the file name length and short name length */ -static u64 dentry_correct_length(const struct dentry *dentry) +/* Return the "correct" value to write in the length field of a WIM dentry, + * based on the file name length and short name length. */ +static u64 dentry_correct_length(const struct wim_dentry *dentry) { return (dentry_correct_length_unaligned(dentry) + 7) & ~7; } -/* - * Returns true if @dentry has the UTF-8 file name @name that has length - * @name_len. - */ -static bool dentry_has_name(const struct dentry *dentry, const char *name, - size_t name_len) -{ - if (dentry->file_name_utf8_len != name_len) - return false; - return memcmp(dentry->file_name_utf8, name, name_len) == 0; -} - -static inline bool ads_entry_has_name(const struct ads_entry *entry, +/* Return %true iff the alternate data stream entry @entry has the UTF-8 stream + * name @name that has length @name_len bytes. */ +static inline bool ads_entry_has_name(const struct wim_ads_entry *entry, const char *name, size_t name_len) { if (entry->stream_name_utf8_len != name_len) @@ -84,26 +74,26 @@ static inline bool ads_entry_has_name(const struct ads_entry *entry, return memcmp(entry->stream_name_utf8, name, name_len) == 0; } -/* Duplicates a UTF-8 name into UTF-8 and UTF-16 strings and returns the strings - * and their lengths in the pointer arguments */ -int get_names(char **name_utf16_ret, char **name_utf8_ret, - u16 *name_utf16_len_ret, u16 *name_utf8_len_ret, - const char *name) +/* Duplicates a UTF-8 string into UTF-8 and UTF-16 strings and returns the + * strings and their lengths in the pointer arguments. (Frees existing strings + * first.) */ +static int get_names(char **name_utf16_ret, char **name_utf8_ret, + u16 *name_utf16_len_ret, u16 *name_utf8_len_ret, + const char *name) { size_t utf8_len; size_t utf16_len; char *name_utf16, *name_utf8; + int ret; utf8_len = strlen(name); - - name_utf16 = utf8_to_utf16(name, utf8_len, &utf16_len); - - if (!name_utf16) - return WIMLIB_ERR_NOMEM; + ret = utf8_to_utf16(name, utf8_len, &name_utf16, &utf16_len); + if (ret != 0) + return ret; name_utf8 = MALLOC(utf8_len + 1); if (!name_utf8) { - FREE(name_utf8); + FREE(name_utf16); return WIMLIB_ERR_NOMEM; } memcpy(name_utf8, name, utf8_len + 1); @@ -116,26 +106,27 @@ int get_names(char **name_utf16_ret, char **name_utf8_ret, return 0; } -/* Changes the name of a dentry to @new_name. Only changes the file_name and - * file_name_utf8 fields; does not change the short_name, short_name_utf8, or - * full_path_utf8 fields. Also recalculates its length. */ -static int change_dentry_name(struct dentry *dentry, const char *new_name) +/* Sets the name of a WIM dentry. */ +int set_dentry_name(struct wim_dentry *dentry, const char *new_name) { int ret; ret = get_names(&dentry->file_name, &dentry->file_name_utf8, &dentry->file_name_len, &dentry->file_name_utf8_len, - new_name); - FREE(dentry->short_name); - dentry->short_name_len = 0; - if (ret == 0) + new_name); + if (ret == 0) { + if (dentry->short_name_len) { + FREE(dentry->short_name); + dentry->short_name_len = 0; + } dentry->length = dentry_correct_length(dentry); + } return ret; } /* * Changes the name of an alternate data stream */ -static int change_ads_name(struct ads_entry *entry, const char *new_name) +static int change_ads_name(struct wim_ads_entry *entry, const char *new_name) { return get_names(&entry->stream_name, &entry->stream_name_utf8, &entry->stream_name_len, @@ -145,8 +136,8 @@ static int change_ads_name(struct ads_entry *entry, const char *new_name) /* Returns the total length of a WIM alternate data stream entry on-disk, * including the stream name, the null terminator, AND the padding after the - * entry to align the next one (or the next dentry) on an 8-byte boundary. */ -static u64 ads_entry_total_length(const struct ads_entry *entry) + * entry to align the next ADS entry or dentry on an 8-byte boundary. */ +static u64 ads_entry_total_length(const struct wim_ads_entry *entry) { u64 len = WIM_ADS_ENTRY_DISK_SIZE; if (entry->stream_name_len) @@ -155,153 +146,325 @@ static u64 ads_entry_total_length(const struct ads_entry *entry) } -static u64 __dentry_total_length(const struct dentry *dentry, u64 length) +static u64 __dentry_total_length(const struct wim_dentry *dentry, u64 length) { - const struct inode *inode = dentry->d_inode; - for (u16 i = 0; i < inode->num_ads; i++) - length += ads_entry_total_length(&inode->ads_entries[i]); + const struct wim_inode *inode = dentry->d_inode; + for (u16 i = 0; i < inode->i_num_ads; i++) + length += ads_entry_total_length(&inode->i_ads_entries[i]); return (length + 7) & ~7; } -u64 dentry_correct_total_length(const struct dentry *dentry) +/* Calculate the aligned *total* length of an on-disk WIM dentry. This includes + * all alternate data streams. */ +u64 dentry_correct_total_length(const struct wim_dentry *dentry) { return __dentry_total_length(dentry, dentry_correct_length_unaligned(dentry)); } -/* Real length of a dentry, including the alternate data stream entries, which - * are not included in the dentry->length field... */ -static u64 dentry_total_length(const struct dentry *dentry) +/* Like dentry_correct_total_length(), but use the existing dentry->length field + * instead of calculating its "correct" value. */ +static u64 dentry_total_length(const struct wim_dentry *dentry) { return __dentry_total_length(dentry, dentry->length); } -/* Transfers file attributes from a `stat' buffer to an inode. */ -void stbuf_to_inode(const struct stat *stbuf, struct inode *inode) +int for_dentry_in_rbtree(struct rb_node *root, + int (*visitor)(struct wim_dentry *, void *), + void *arg) { - if (S_ISLNK(stbuf->st_mode)) { - inode->attributes = FILE_ATTRIBUTE_REPARSE_POINT; - inode->reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK; - } else if (S_ISDIR(stbuf->st_mode)) { - inode->attributes = FILE_ATTRIBUTE_DIRECTORY; - } else { - inode->attributes = FILE_ATTRIBUTE_NORMAL; + int ret; + struct rb_node *node = root; + LIST_HEAD(stack); + while (1) { + if (node) { + list_add(&rbnode_dentry(node)->tmp_list, &stack); + node = node->rb_left; + } else { + struct list_head *next; + struct wim_dentry *dentry; + + next = stack.next; + if (next == &stack) + return 0; + dentry = container_of(next, struct wim_dentry, tmp_list); + list_del(next); + ret = visitor(dentry, arg); + if (ret != 0) + return ret; + node = dentry->rb_node.rb_right; + } } - if (sizeof(ino_t) >= 8) - inode->ino = (u64)stbuf->st_ino; - else - inode->ino = (u64)stbuf->st_ino | - ((u64)stbuf->st_dev << (sizeof(ino_t) * 8)); - /* Set timestamps */ - inode->creation_time = timespec_to_wim_timestamp(&stbuf->st_mtim); - inode->last_write_time = timespec_to_wim_timestamp(&stbuf->st_mtim); - inode->last_access_time = timespec_to_wim_timestamp(&stbuf->st_atim); } -#ifdef WITH_FUSE -/* Transfers file attributes from a struct inode to a `stat' buffer. - * - * The lookup table entry tells us which stream in the inode we are statting. - * For a named data stream, everything returned is the same as the unnamed data - * stream except possibly the size and block count. */ -int inode_to_stbuf(const struct inode *inode, struct lookup_table_entry *lte, - struct stat *stbuf) +static int for_dentry_tree_in_rbtree_depth(struct rb_node *node, + int (*visitor)(struct wim_dentry*, void*), + void *arg) { - if (inode_is_symlink(inode)) - stbuf->st_mode = S_IFLNK | 0777; - else if (inode_is_directory(inode)) - stbuf->st_mode = S_IFDIR | 0755; - else - stbuf->st_mode = S_IFREG | 0644; + int ret; + if (node) { + ret = for_dentry_tree_in_rbtree_depth(node->rb_left, + visitor, arg); + if (ret != 0) + return ret; + ret = for_dentry_tree_in_rbtree_depth(node->rb_right, + visitor, arg); + if (ret != 0) + return ret; + ret = for_dentry_in_tree_depth(rbnode_dentry(node), visitor, arg); + if (ret != 0) + return ret; + } + return 0; +} - stbuf->st_ino = (ino_t)inode->ino; - stbuf->st_nlink = inode->link_count; - stbuf->st_uid = getuid(); - stbuf->st_gid = getgid(); +/*#define RECURSIVE_FOR_DENTRY_IN_TREE*/ - if (lte) { - if (lte->resource_location == RESOURCE_IN_STAGING_FILE) { - wimlib_assert(lte->staging_file_name); - struct stat native_stat; - if (stat(lte->staging_file_name, &native_stat) != 0) { - DEBUG("Failed to stat `%s': %m", - lte->staging_file_name); - return -errno; - } - stbuf->st_size = native_stat.st_size; - } else { - stbuf->st_size = wim_resource_size(lte); - } - } else { - stbuf->st_size = 0; +#ifdef RECURSIVE_FOR_DENTRY_IN_TREE +static int for_dentry_tree_in_rbtree(struct rb_node *node, + int (*visitor)(struct wim_dentry*, void*), + void *arg) +{ + int ret; + if (node) { + ret = for_dentry_tree_in_rbtree(node->rb_left, visitor, arg); + if (ret != 0) + return ret; + ret = for_dentry_in_tree(rbnode_dentry(node), visitor, arg); + if (ret != 0) + return ret; + ret = for_dentry_tree_in_rbtree(node->rb_right, visitor, arg); + if (ret != 0) + return ret; } - - stbuf->st_atime = wim_timestamp_to_unix(inode->last_access_time); - stbuf->st_mtime = wim_timestamp_to_unix(inode->last_write_time); - stbuf->st_ctime = wim_timestamp_to_unix(inode->creation_time); - stbuf->st_blocks = (stbuf->st_size + 511) / 512; return 0; } #endif -/* - * Calls a function on all directory entries in a directory tree. It is called - * on a parent before its children. +/* + * Calls a function on all directory entries in a WIM dentry tree. Logically, + * this is a pre-order traversal (the function is called on a parent dentry + * before its children), but sibling dentries will be visited in order as well. + * + * In reality, the data structures are more complicated than the above might + * suggest because there is a separate red-black tree for each dentry that + * contains its direct children. */ -int for_dentry_in_tree(struct dentry *root, - int (*visitor)(struct dentry*, void*), void *arg) +int for_dentry_in_tree(struct wim_dentry *root, + int (*visitor)(struct wim_dentry*, void*), void *arg) { +#ifdef RECURSIVE_FOR_DENTRY_IN_TREE + int ret = visitor(root, arg); + if (ret != 0) + return ret; + return for_dentry_tree_in_rbtree(root->d_inode->i_children.rb_node, visitor, arg); +#else int ret; - struct dentry *child; + struct list_head main_stack; + struct list_head sibling_stack; + struct list_head *sibling_stack_bottom; + struct wim_dentry *main_dentry; + struct rb_node *node; + struct list_head *next_sibling; + struct wim_dentry *dentry; ret = visitor(root, arg); - if (ret != 0) return ret; - child = root->d_inode->children; + main_dentry = root; + sibling_stack_bottom = &sibling_stack; + INIT_LIST_HEAD(&main_stack); + INIT_LIST_HEAD(&sibling_stack); - if (!child) - return 0; + list_add(&root->tmp_list, &main_stack); + node = root->d_inode->i_children.rb_node; - do { - ret = for_dentry_in_tree(child, visitor, arg); - if (ret != 0) - return ret; - child = child->next; - } while (child != root->d_inode->children); - return 0; + while (1) { + // Prepare for non-recursive in-order traversal of the red-black + // tree of this dentry's children + + while (node) { + // Push this node to the sibling stack and examine the + // left neighbor, if any + list_add(&rbnode_dentry(node)->tmp_list, &sibling_stack); + node = node->rb_left; + } + + next_sibling = sibling_stack.next; + if (next_sibling == sibling_stack_bottom) { + // Done with all siblings. Pop the main dentry to move + // back up one level. + main_dentry = container_of(main_stack.next, + struct wim_dentry, + tmp_list); + list_del(&main_dentry->tmp_list); + + if (main_dentry == root) + goto out; + + // Restore sibling stack bottom from the previous level + sibling_stack_bottom = (void*)main_dentry->parent; + + // Restore the just-popped main dentry's parent + main_dentry->parent = container_of(main_stack.next, + struct wim_dentry, + tmp_list); + + // The next sibling to traverse in the previous level, + // in the in-order traversal of the red-black tree, is + // the one to the right. + node = main_dentry->rb_node.rb_right; + } else { + // The sibling stack is not empty, so there are more to + // go! + + // Pop a sibling from the stack. + list_del(next_sibling); + dentry = container_of(next_sibling, struct wim_dentry, tmp_list); + + // Visit the sibling. + ret = visitor(dentry, arg); + if (ret != 0) { + // Failed. Restore parent pointers for the + // dentries in the main stack + list_for_each_entry(dentry, &main_stack, tmp_list) { + dentry->parent = container_of(dentry->tmp_list.next, + struct wim_dentry, + tmp_list); + } + goto out; + } + + // We'd like to recursively visit the dentry tree rooted + // at this sibling. To do this, add it to the main + // stack, save the bottom of this level's sibling stack + // in the dentry->parent field, re-set the bottom of the + // sibling stack to be its current height, and set + // main_dentry to the sibling so it becomes the parent + // dentry in the next iteration through the outer loop. + if (inode_has_children(dentry->d_inode)) { + list_add(&dentry->tmp_list, &main_stack); + dentry->parent = (void*)sibling_stack_bottom; + sibling_stack_bottom = sibling_stack.next; + + main_dentry = dentry; + node = main_dentry->d_inode->i_children.rb_node; + } else { + node = dentry->rb_node.rb_right; + } + } + } +out: + root->parent = root; + return ret; +#endif } -/* +/* * Like for_dentry_in_tree(), but the visitor function is always called on a * dentry's children before on itself. */ -int for_dentry_in_tree_depth(struct dentry *root, - int (*visitor)(struct dentry*, void*), void *arg) +int for_dentry_in_tree_depth(struct wim_dentry *root, + int (*visitor)(struct wim_dentry*, void*), void *arg) { +#if 1 int ret; - struct dentry *child; - struct dentry *next; + ret = for_dentry_tree_in_rbtree_depth(root->d_inode->i_children.rb_node, + visitor, arg); + if (ret != 0) + return ret; + return visitor(root, arg); - child = root->d_inode->children; - if (child) { - do { - next = child->next; - ret = for_dentry_in_tree_depth(child, visitor, arg); - if (ret != 0) +#else + int ret; + struct list_head main_stack; + struct list_head sibling_stack; + struct list_head *sibling_stack_bottom; + struct wim_dentry *main_dentry; + struct rb_node *node; + struct list_head *next_sibling; + struct wim_dentry *dentry; + + main_dentry = root; + sibling_stack_bottom = &sibling_stack; + INIT_LIST_HEAD(&main_stack); + INIT_LIST_HEAD(&sibling_stack); + + list_add(&main_dentry->tmp_list, &main_stack); + + while (1) { + node = main_dentry->d_inode->i_children.rb_node; + + while (1) { + if (node->rb_left) { + list_add(&rbnode_dentry(node)->tmp_list, &sibling_stack); + node = node->rb_left; + continue; + } + if (node->rb_right) { + list_add(&rbnode_dentry(node)->tmp_list, &sibling_stack); + node = node->rb_right; + continue; + } + list_add(&rbnode_dentry(node)->tmp_list, &sibling_stack); + } + + pop_sibling: + next_sibling = sibling_stack.next; + if (next_sibling == sibling_stack_bottom) { + main_dentry = container_of(main_stack.next, + struct wim_dentry, + tmp_list); + list_del(&main_dentry->tmp_list); + + + sibling_stack_bottom = (void*)main_dentry->parent; + + if (main_dentry == root) { + main_dentry->parent = main_dentry; + ret = visitor(dentry, arg); return ret; - child = next; - } while (child != root->d_inode->children); + } else { + main_dentry->parent = container_of(main_stack.next, + struct wim_dentry, + tmp_list); + } + + ret = visitor(main_dentry, arg); + + if (ret != 0) { + list_del(&root->tmp_list); + list_for_each_entry(dentry, &main_stack, tmp_list) { + dentry->parent = container_of(dentry->tmp_list.next, + struct wim_dentry, + tmp_list); + } + root->parent = root; + return ret; + } + goto pop_sibling; + } else { + + list_del(next_sibling); + dentry = container_of(next_sibling, struct wim_dentry, tmp_list); + + + list_add(&dentry->tmp_list, &main_stack); + dentry->parent = (void*)sibling_stack_bottom; + sibling_stack_bottom = sibling_stack.next; + + main_dentry = dentry; + } } - return visitor(root, arg); +#endif } -/* +/* * Calculate the full path of @dentry, based on its parent's full path and on - * its UTF-8 file name. + * its UTF-8 file name. */ -int calculate_dentry_full_path(struct dentry *dentry, void *ignore) +int calculate_dentry_full_path(struct wim_dentry *dentry, void *ignore) { char *full_path; u32 full_path_len; @@ -315,7 +478,7 @@ int calculate_dentry_full_path(struct dentry *dentry, void *ignore) } else { char *parent_full_path; u32 parent_full_path_len; - const struct dentry *parent = dentry->parent; + const struct wim_dentry *parent = dentry->parent; if (dentry_is_root(parent)) { parent_full_path = ""; @@ -347,37 +510,43 @@ oom: return WIMLIB_ERR_NOMEM; } -/* - * Recursively calculates the subdir offsets for a directory tree. +static int increment_subdir_offset(struct wim_dentry *dentry, void *subdir_offset_p) +{ + *(u64*)subdir_offset_p += dentry_correct_total_length(dentry); + return 0; +} + +static int call_calculate_subdir_offsets(struct wim_dentry *dentry, + void *subdir_offset_p) +{ + calculate_subdir_offsets(dentry, subdir_offset_p); + return 0; +} + +/* + * Recursively calculates the subdir offsets for a directory tree. * * @dentry: The root of the directory tree. * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory - * offset for @dentry. + * offset for @dentry. */ -void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p) +void calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p) { - struct dentry *child; + struct rb_node *node; - child = dentry->d_inode->children; dentry->subdir_offset = *subdir_offset_p; - - if (child) { + node = dentry->d_inode->i_children.rb_node; + if (node) { /* Advance the subdir offset by the amount of space the children * of this dentry take up. */ - do { - *subdir_offset_p += dentry_correct_total_length(child); - child = child->next; - } while (child != dentry->d_inode->children); + for_dentry_in_rbtree(node, increment_subdir_offset, subdir_offset_p); /* End-of-directory dentry on disk. */ *subdir_offset_p += 8; /* Recursively call calculate_subdir_offsets() on all the * children. */ - do { - calculate_subdir_offsets(child, subdir_offset_p); - child = child->next; - } while (child != dentry->d_inode->children); + for_dentry_in_rbtree(node, call_calculate_subdir_offsets, subdir_offset_p); } else { /* On disk, childless directories have a valid subdir_offset * that points to an 8-byte end-of-directory dentry. Regular @@ -389,73 +558,108 @@ void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p) } } -/* Returns the child of @dentry that has the file name @name. - * Returns NULL if no child has the name. */ -struct dentry *get_dentry_child_with_name(const struct dentry *dentry, - const char *name) +static int compare_names(const char *name_1, u16 len_1, + const char *name_2, u16 len_2) { - struct dentry *child; - size_t name_len; - - child = dentry->d_inode->children; - if (child) { - name_len = strlen(name); - do { - if (dentry_has_name(child, name, name_len)) - return child; - child = child->next; - } while (child != dentry->d_inode->children); + int result = strncasecmp(name_1, name_2, min(len_1, len_2)); + if (result) { + return result; + } else { + return (int)len_1 - (int)len_2; } +} + +static int dentry_compare_names(const struct wim_dentry *d1, const struct wim_dentry *d2) +{ + return compare_names(d1->file_name_utf8, d1->file_name_utf8_len, + d2->file_name_utf8, d2->file_name_utf8_len); +} + + +static struct wim_dentry * +get_rbtree_child_with_name(const struct rb_node *node, + const char *name, size_t name_len) +{ + do { + struct wim_dentry *child = rbnode_dentry(node); + int result = compare_names(name, name_len, + child->file_name_utf8, + child->file_name_utf8_len); + if (result < 0) + node = node->rb_left; + else if (result > 0) + node = node->rb_right; + else + return child; + } while (node); return NULL; } -/* Retrieves the dentry that has the UTF-8 @path relative to the dentry - * @cur_dir. Returns NULL if no dentry having the path is found. */ -static struct dentry *get_dentry_relative_path(struct dentry *cur_dir, - const char *path) +/* Returns the child of @dentry that has the file name @name. + * Returns NULL if no child has the name. */ +struct wim_dentry *get_dentry_child_with_name(const struct wim_dentry *dentry, + const char *name) { - struct dentry *child; - size_t base_len; - const char *new_path; + struct rb_node *node = dentry->d_inode->i_children.rb_node; + if (node) + return get_rbtree_child_with_name(node, name, strlen(name)); + else + return NULL; +} +/* Retrieves the dentry that has the UTF-8 @path relative to the dentry + * @cur_dentry. Returns NULL if no dentry having the path is found. */ +static struct wim_dentry *get_dentry_relative_path(struct wim_dentry *cur_dentry, + const char *path) +{ if (*path == '\0') - return cur_dir; + return cur_dentry; + + struct rb_node *node = cur_dentry->d_inode->i_children.rb_node; + if (node) { + struct wim_dentry *child; + size_t base_len; + const char *new_path; - child = cur_dir->d_inode->children; - if (child) { new_path = path_next_part(path, &base_len); - do { - if (dentry_has_name(child, path, base_len)) - return get_dentry_relative_path(child, new_path); - child = child->next; - } while (child != cur_dir->d_inode->children); + + child = get_rbtree_child_with_name(node, path, base_len); + if (child) + return get_dentry_relative_path(child, new_path); } + /* errno is set to ENOTDIR if the lookup failed due to reaching a + * non-directory, or ENOENT if the lookup failed otherwise. This maybe + * should be factored out somehow. */ + if (dentry_is_directory(cur_dentry)) + errno = ENOENT; + else + errno = ENOTDIR; return NULL; } /* Returns the dentry corresponding to the UTF-8 @path, or NULL if there is no * such dentry. */ -struct dentry *get_dentry(WIMStruct *w, const char *path) +struct wim_dentry *get_dentry(WIMStruct *w, const char *path) { - struct dentry *root = wim_root_dentry(w); + struct wim_dentry *root = wim_root_dentry(w); while (*path == '/') path++; return get_dentry_relative_path(root, path); } -struct inode *wim_pathname_to_inode(WIMStruct *w, const char *path) +struct wim_inode *wim_pathname_to_inode(WIMStruct *w, const char *path) { - struct dentry *dentry; + struct wim_dentry *dentry; dentry = get_dentry(w, path); - if (!dentry) - return NULL; - else + if (dentry) return dentry->d_inode; + else + return NULL; } /* Returns the dentry that corresponds to the parent directory of @path, or NULL * if the dentry is not found. */ -struct dentry *get_parent_dentry(WIMStruct *w, const char *path) +struct wim_dentry *get_parent_dentry(WIMStruct *w, const char *path) { size_t path_len = strlen(path); char buf[path_len + 1]; @@ -468,7 +672,7 @@ struct dentry *get_parent_dentry(WIMStruct *w, const char *path) } /* Prints the full path of a dentry. */ -int print_dentry_full_path(struct dentry *dentry, void *ignore) +int print_dentry_full_path(struct wim_dentry *dentry, void *ignore) { if (dentry->full_path_utf8) puts(dentry->full_path_utf8); @@ -502,54 +706,42 @@ struct file_attr_flag file_attr_flags[] = { /* Prints a directory entry. @lookup_table is a pointer to the lookup table, if * available. If the dentry is unresolved and the lookup table is NULL, the * lookup table entries will not be printed. Otherwise, they will be. */ -int print_dentry(struct dentry *dentry, void *lookup_table) +int print_dentry(struct wim_dentry *dentry, void *lookup_table) { const u8 *hash; - struct lookup_table_entry *lte; - const struct inode *inode = dentry->d_inode; - time_t time; - char *p; + struct wim_lookup_table_entry *lte; + const struct wim_inode *inode = dentry->d_inode; + char buf[50]; printf("[DENTRY]\n"); printf("Length = %"PRIu64"\n", dentry->length); - printf("Attributes = 0x%x\n", inode->attributes); - for (unsigned i = 0; i < ARRAY_LEN(file_attr_flags); i++) - if (file_attr_flags[i].flag & inode->attributes) + printf("Attributes = 0x%x\n", inode->i_attributes); + for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++) + if (file_attr_flags[i].flag & inode->i_attributes) printf(" FILE_ATTRIBUTE_%s is set\n", file_attr_flags[i].name); - printf("Security ID = %d\n", inode->security_id); + printf("Security ID = %d\n", inode->i_security_id); printf("Subdir offset = %"PRIu64"\n", dentry->subdir_offset); - /* Translate the timestamps into something readable */ - time = wim_timestamp_to_unix(inode->creation_time); - p = asctime(gmtime(&time)); - *(strrchr(p, '\n')) = '\0'; - printf("Creation Time = %s UTC\n", p); - - time = wim_timestamp_to_unix(inode->last_access_time); - p = asctime(gmtime(&time)); - *(strrchr(p, '\n')) = '\0'; - printf("Last Access Time = %s UTC\n", p); - - time = wim_timestamp_to_unix(inode->last_write_time); - p = asctime(gmtime(&time)); - *(strrchr(p, '\n')) = '\0'; - printf("Last Write Time = %s UTC\n", p); - - printf("Reparse Tag = 0x%"PRIx32"\n", inode->reparse_tag); - printf("Hard Link Group = 0x%"PRIx64"\n", inode->ino); - printf("Hard Link Group Size = %"PRIu32"\n", inode->link_count); - printf("Number of Alternate Data Streams = %hu\n", inode->num_ads); - printf("Filename = \""); - print_string(dentry->file_name, dentry->file_name_len); - puts("\""); - printf("Filename Length = %hu\n", dentry->file_name_len); + wim_timestamp_to_str(inode->i_creation_time, buf, sizeof(buf)); + printf("Creation Time = %s\n", buf); + + wim_timestamp_to_str(inode->i_last_access_time, buf, sizeof(buf)); + printf("Last Access Time = %s\n", buf); + + wim_timestamp_to_str(inode->i_last_write_time, buf, sizeof(buf)); + printf("Last Write Time = %s\n", buf); + + printf("Reparse Tag = 0x%"PRIx32"\n", inode->i_reparse_tag); + printf("Hard Link Group = 0x%"PRIx64"\n", inode->i_ino); + printf("Hard Link Group Size = %"PRIu32"\n", inode->i_nlink); + printf("Number of Alternate Data Streams = %hu\n", inode->i_num_ads); printf("Filename (UTF-8) = \"%s\"\n", dentry->file_name_utf8); - printf("Filename (UTF-8) Length = %hu\n", dentry->file_name_utf8_len); - printf("Short Name = \""); + /*printf("Filename (UTF-8) Length = %hu\n", dentry->file_name_utf8_len);*/ + printf("Short Name (UTF-16LE) = \""); print_string(dentry->short_name, dentry->short_name_len); puts("\""); - printf("Short Name Length = %hu\n", dentry->short_name_len); + /*printf("Short Name Length = %hu\n", dentry->short_name_len);*/ printf("Full Path (UTF-8) = \"%s\"\n", dentry->full_path_utf8); lte = inode_stream_lte(dentry->d_inode, 0, lookup_table); if (lte) { @@ -557,20 +749,20 @@ int print_dentry(struct dentry *dentry, void *lookup_table) } else { hash = inode_stream_hash(inode, 0); if (hash) { - printf("Hash = 0x"); + printf("Hash = 0x"); print_hash(hash); putchar('\n'); putchar('\n'); } } - for (u16 i = 0; i < inode->num_ads; i++) { + for (u16 i = 0; i < inode->i_num_ads; i++) { printf("[Alternate Stream Entry %u]\n", i); - printf("Name = \"%s\"\n", inode->ads_entries[i].stream_name_utf8); + printf("Name = \"%s\"\n", inode->i_ads_entries[i].stream_name_utf8); printf("Name Length (UTF-16) = %u\n", - inode->ads_entries[i].stream_name_len); + inode->i_ads_entries[i].stream_name_len); hash = inode_stream_hash(inode, i + 1); if (hash) { - printf("Hash = 0x"); + printf("Hash = 0x"); print_hash(hash); putchar('\n'); } @@ -580,73 +772,77 @@ int print_dentry(struct dentry *dentry, void *lookup_table) return 0; } -/* Initializations done on every `struct dentry'. */ -static void dentry_common_init(struct dentry *dentry) +/* Initializations done on every `struct wim_dentry'. */ +static void dentry_common_init(struct wim_dentry *dentry) { - memset(dentry, 0, sizeof(struct dentry)); + memset(dentry, 0, sizeof(struct wim_dentry)); dentry->refcnt = 1; } -static struct inode *new_timeless_inode() +static struct wim_inode *new_timeless_inode() { - struct inode *inode = CALLOC(1, sizeof(struct inode)); - if (!inode) - return NULL; - inode->security_id = -1; - inode->link_count = 1; -#ifdef WITH_FUSE - inode->next_stream_id = 1; -#endif - INIT_LIST_HEAD(&inode->dentry_list); + struct wim_inode *inode = CALLOC(1, sizeof(struct wim_inode)); + if (inode) { + inode->i_security_id = -1; + inode->i_nlink = 1; + #ifdef WITH_FUSE + inode->i_next_stream_id = 1; + if (pthread_mutex_init(&inode->i_mutex, NULL) != 0) { + ERROR_WITH_ERRNO("Error initializing mutex"); + FREE(inode); + return NULL; + } + #endif + INIT_LIST_HEAD(&inode->i_dentry); + } return inode; } -static struct inode *new_inode() +static struct wim_inode *new_inode() { - struct inode *inode = new_timeless_inode(); - if (!inode) - return NULL; - u64 now = get_wim_timestamp(); - inode->creation_time = now; - inode->last_access_time = now; - inode->last_write_time = now; + struct wim_inode *inode = new_timeless_inode(); + if (inode) { + u64 now = get_wim_timestamp(); + inode->i_creation_time = now; + inode->i_last_access_time = now; + inode->i_last_write_time = now; + } return inode; } -/* +/* * Creates an unlinked directory entry. * * @name: The UTF-8 filename of the new dentry. * * Returns a pointer to the new dentry, or NULL if out of memory. */ -struct dentry *new_dentry(const char *name) +struct wim_dentry *new_dentry(const char *name) { - struct dentry *dentry; - - dentry = MALLOC(sizeof(struct dentry)); + struct wim_dentry *dentry; + + dentry = MALLOC(sizeof(struct wim_dentry)); if (!dentry) goto err; dentry_common_init(dentry); - if (change_dentry_name(dentry, name) != 0) + if (set_dentry_name(dentry, name) != 0) goto err; - dentry->next = dentry; - dentry->prev = dentry; dentry->parent = dentry; return dentry; err: FREE(dentry); - ERROR("Failed to allocate new dentry"); + ERROR_WITH_ERRNO("Failed to create new dentry with name \"%s\"", name); return NULL; } -static struct dentry *__new_dentry_with_inode(const char *name, bool timeless) +static struct wim_dentry * +__new_dentry_with_inode(const char *name, bool timeless) { - struct dentry *dentry; + struct wim_dentry *dentry; dentry = new_dentry(name); if (dentry) { if (timeless) @@ -663,18 +859,18 @@ static struct dentry *__new_dentry_with_inode(const char *name, bool timeless) return dentry; } -struct dentry *new_dentry_with_timeless_inode(const char *name) +struct wim_dentry *new_dentry_with_timeless_inode(const char *name) { return __new_dentry_with_inode(name, true); } -struct dentry *new_dentry_with_inode(const char *name) +struct wim_dentry *new_dentry_with_inode(const char *name) { return __new_dentry_with_inode(name, false); } -static int init_ads_entry(struct ads_entry *ads_entry, const char *name) +static int init_ads_entry(struct wim_ads_entry *ads_entry, const char *name) { int ret = 0; memset(ads_entry, 0, sizeof(*ads_entry)); @@ -683,7 +879,7 @@ static int init_ads_entry(struct ads_entry *ads_entry, const char *name) return ret; } -static void destroy_ads_entry(struct ads_entry *ads_entry) +static void destroy_ads_entry(struct wim_ads_entry *ads_entry) { FREE(ads_entry->stream_name); FREE(ads_entry->stream_name_utf8); @@ -691,79 +887,76 @@ static void destroy_ads_entry(struct ads_entry *ads_entry) /* Frees an inode. */ -void free_inode(struct inode *inode) +void free_inode(struct wim_inode *inode) { if (inode) { - if (inode->ads_entries) { - for (u16 i = 0; i < inode->num_ads; i++) - destroy_ads_entry(&inode->ads_entries[i]); - FREE(inode->ads_entries); + if (inode->i_ads_entries) { + for (u16 i = 0; i < inode->i_num_ads; i++) + destroy_ads_entry(&inode->i_ads_entries[i]); + FREE(inode->i_ads_entries); } #ifdef WITH_FUSE - wimlib_assert(inode->num_opened_fds == 0); - FREE(inode->fds); + wimlib_assert(inode->i_num_opened_fds == 0); + FREE(inode->i_fds); + pthread_mutex_destroy(&inode->i_mutex); + if (inode->i_hlist.pprev) + hlist_del(&inode->i_hlist); #endif + FREE(inode->i_extracted_file); FREE(inode); } } /* Decrements link count on an inode and frees it if the link count reaches 0. * */ -static void put_inode(struct inode *inode) +static void put_inode(struct wim_inode *inode) { - wimlib_assert(inode); - wimlib_assert(inode->link_count); - if (--inode->link_count == 0) { + wimlib_assert(inode->i_nlink != 0); + if (--inode->i_nlink == 0) { #ifdef WITH_FUSE - if (inode->num_opened_fds == 0) + if (inode->i_num_opened_fds == 0) #endif { free_inode(inode); - inode = NULL; } } } -/* Frees a WIM dentry. +/* Frees a WIM dentry. * - * The inode is freed only if its link count is decremented to 0. + * The corresponding inode (if any) is freed only if its link count is + * decremented to 0. */ -void free_dentry(struct dentry *dentry) +void free_dentry(struct wim_dentry *dentry) { - wimlib_assert(dentry); - struct inode *inode; - FREE(dentry->file_name); FREE(dentry->file_name_utf8); FREE(dentry->short_name); FREE(dentry->full_path_utf8); - put_inode(dentry->d_inode); + if (dentry->d_inode) + put_inode(dentry->d_inode); FREE(dentry); } -void put_dentry(struct dentry *dentry) +void put_dentry(struct wim_dentry *dentry) { - wimlib_assert(dentry); - wimlib_assert(dentry->refcnt); - + wimlib_assert(dentry->refcnt != 0); if (--dentry->refcnt == 0) free_dentry(dentry); } -/* - * This function is passed as an argument to for_dentry_in_tree_depth() in order - * to free a directory tree. __args is a pointer to a `struct free_dentry_args'. - */ -static int do_free_dentry(struct dentry *dentry, void *__lookup_table) +/* This function is passed as an argument to for_dentry_in_tree_depth() in order + * to free a directory tree. */ +static int do_free_dentry(struct wim_dentry *dentry, void *__lookup_table) { - struct lookup_table *lookup_table = __lookup_table; + struct wim_lookup_table *lookup_table = __lookup_table; unsigned i; if (lookup_table) { - struct lookup_table_entry *lte; - struct inode *inode = dentry->d_inode; - wimlib_assert(inode->link_count); - for (i = 0; i <= inode->num_ads; i++) { + struct wim_lookup_table_entry *lte; + struct wim_inode *inode = dentry->d_inode; + wimlib_assert(inode->i_nlink != 0); + for (i = 0; i <= inode->i_num_ads; i++) { lte = inode_stream_lte(inode, i, lookup_table); if (lte) lte_decrement_refcnt(lte, lookup_table); @@ -774,7 +967,7 @@ static int do_free_dentry(struct dentry *dentry, void *__lookup_table) return 0; } -/* +/* * Unlinks and frees a dentry tree. * * @root: The root of the tree. @@ -783,332 +976,138 @@ static int do_free_dentry(struct dentry *dentry, void *__lookup_table) * table entries corresponding to the dentries will be * decremented. */ -void free_dentry_tree(struct dentry *root, struct lookup_table *lookup_table) +void free_dentry_tree(struct wim_dentry *root, struct wim_lookup_table *lookup_table) { - if (!root || !root->parent) - return; - for_dentry_in_tree_depth(root, do_free_dentry, lookup_table); + if (root) + for_dentry_in_tree_depth(root, do_free_dentry, lookup_table); } -int increment_dentry_refcnt(struct dentry *dentry, void *ignore) +int increment_dentry_refcnt(struct wim_dentry *dentry, void *ignore) { dentry->refcnt++; return 0; } -/* +/* * Links a dentry into the directory tree. * * @dentry: The dentry to link. * @parent: The dentry that will be the parent of @dentry. */ -void link_dentry(struct dentry *dentry, struct dentry *parent) +bool dentry_add_child(struct wim_dentry * restrict parent, + struct wim_dentry * restrict child) { wimlib_assert(dentry_is_directory(parent)); - dentry->parent = parent; - if (parent->d_inode->children) { - /* Not an only child; link to siblings. */ - dentry->next = parent->d_inode->children; - dentry->prev = parent->d_inode->children->prev; - dentry->next->prev = dentry; - dentry->prev->next = dentry; - } else { - /* Only child; link to parent. */ - parent->d_inode->children = dentry; - dentry->next = dentry; - dentry->prev = dentry; - } -} + struct rb_root *root = &parent->d_inode->i_children; + struct rb_node **new = &(root->rb_node); + struct rb_node *rb_parent = NULL; -#ifdef WITH_FUSE -/* - * Unlink a dentry from the directory tree. - * - * Note: This merely removes it from the in-memory tree structure. - */ -void unlink_dentry(struct dentry *dentry) -{ - if (dentry_is_root(dentry)) - return; - if (dentry_is_only_child(dentry)) { - dentry->parent->d_inode->children = NULL; - } else { - if (dentry_is_first_sibling(dentry)) - dentry->parent->d_inode->children = dentry->next; - dentry->next->prev = dentry->prev; - dentry->prev->next = dentry->next; - } -} -#endif + while (*new) { + struct wim_dentry *this = rbnode_dentry(*new); + int result = dentry_compare_names(child, this); -/* Parameters for calculate_dentry_statistics(). */ -struct image_statistics { - struct lookup_table *lookup_table; - u64 *dir_count; - u64 *file_count; - u64 *total_bytes; - u64 *hard_link_bytes; -}; + rb_parent = *new; -static int calculate_dentry_statistics(struct dentry *dentry, void *arg) -{ - struct image_statistics *stats; - struct lookup_table_entry *lte; - - stats = arg; - - if (dentry_is_directory(dentry) && !dentry_is_root(dentry)) - ++*stats->dir_count; - else - ++*stats->file_count; - - for (unsigned i = 0; i <= dentry->d_inode->num_ads; i++) { - lte = inode_stream_lte(dentry->d_inode, i, stats->lookup_table); - if (lte) { - *stats->total_bytes += wim_resource_size(lte); - if (++lte->out_refcnt == 1) - *stats->hard_link_bytes += wim_resource_size(lte); - } + if (result < 0) + new = &((*new)->rb_left); + else if (result > 0) + new = &((*new)->rb_right); + else + return false; } - return 0; -} - -/* Calculates some statistics about a dentry tree. */ -void calculate_dir_tree_statistics(struct dentry *root, struct lookup_table *table, - u64 *dir_count_ret, u64 *file_count_ret, - u64 *total_bytes_ret, - u64 *hard_link_bytes_ret) -{ - struct image_statistics stats; - *dir_count_ret = 0; - *file_count_ret = 0; - *total_bytes_ret = 0; - *hard_link_bytes_ret = 0; - stats.lookup_table = table; - stats.dir_count = dir_count_ret; - stats.file_count = file_count_ret; - stats.total_bytes = total_bytes_ret; - stats.hard_link_bytes = hard_link_bytes_ret; - for_lookup_table_entry(table, lte_zero_out_refcnt, NULL); - for_dentry_in_tree(root, calculate_dentry_statistics, &stats); -} - -static inline struct dentry *inode_first_dentry(struct inode *inode) -{ - wimlib_assert(inode->dentry_list.next != &inode->dentry_list); - return container_of(inode->dentry_list.next, struct dentry, - inode_dentry_list); + child->parent = parent; + rb_link_node(&child->rb_node, rb_parent, new); + rb_insert_color(&child->rb_node, root); + return true; } -static int verify_inode(struct inode *inode, const WIMStruct *w) +#ifdef WITH_FUSE +/* Unlink a WIM dentry from the directory entry tree. */ +void unlink_dentry(struct wim_dentry *dentry) { - const struct lookup_table *table = w->lookup_table; - const struct wim_security_data *sd = wim_const_security_data(w); - const struct dentry *first_dentry = inode_first_dentry(inode); - int ret = WIMLIB_ERR_INVALID_DENTRY; - - /* Check the security ID */ - if (inode->security_id < -1) { - ERROR("Dentry `%s' has an invalid security ID (%d)", - first_dentry->full_path_utf8, inode->security_id); - goto out; - } - if (inode->security_id >= sd->num_entries) { - ERROR("Dentry `%s' has an invalid security ID (%d) " - "(there are only %u entries in the security table)", - first_dentry->full_path_utf8, inode->security_id, - sd->num_entries); - goto out; - } - - /* Check that lookup table entries for all the resources exist, except - * if the SHA1 message digest is all 0's, which indicates there is - * intentionally no resource there. */ - if (w->hdr.total_parts == 1) { - for (unsigned i = 0; i <= inode->num_ads; i++) { - struct lookup_table_entry *lte; - const u8 *hash; - hash = inode_stream_hash_unresolved(inode, i); - lte = __lookup_resource(table, hash); - if (!lte && !is_zero_hash(hash)) { - ERROR("Could not find lookup table entry for stream " - "%u of dentry `%s'", i, first_dentry->full_path_utf8); - goto out; - } - if (lte && (lte->real_refcnt += inode->link_count) > lte->refcnt) - { - #ifdef ENABLE_ERROR_MESSAGES - WARNING("The following lookup table entry " - "has a reference count of %u, but", - lte->refcnt); - WARNING("We found %zu references to it", - lte->real_refcnt); - WARNING("(One dentry referencing it is at `%s')", - first_dentry->full_path_utf8); - - print_lookup_table_entry(lte); - #endif - /* Guess what! install.wim for Windows 8 - * contains a stream with 2 dentries referencing - * it, but the lookup table entry has reference - * count of 1. So we will need to handle this - * case and not just make it be an error... I'm - * just setting the reference count to the - * number of references we found. - * (Unfortunately, even after doing this, the - * reference count could be too low if it's also - * referenced in other WIM images) */ - - #if 1 - lte->refcnt = lte->real_refcnt; - WARNING("Fixing reference count"); - #else - goto out; - #endif - } - } - } - - /* Make sure there is only one un-named stream. */ - unsigned num_unnamed_streams = 0; - for (unsigned i = 0; i <= inode->num_ads; i++) { - const u8 *hash; - hash = inode_stream_hash_unresolved(inode, i); - if (!inode_stream_name_len(inode, i) && !is_zero_hash(hash)) - num_unnamed_streams++; - } - if (num_unnamed_streams > 1) { - ERROR("Dentry `%s' has multiple (%u) un-named streams", - first_dentry->full_path_utf8, num_unnamed_streams); - goto out; - } - inode->verified = true; - ret = 0; -out: - return ret; + struct wim_dentry *parent = dentry->parent; + if (parent == dentry) + return; + rb_erase(&dentry->rb_node, &parent->d_inode->i_children); } - -/* Run some miscellaneous verifications on a WIM dentry */ -int verify_dentry(struct dentry *dentry, void *wim) -{ - const WIMStruct *w = wim; - const struct inode *inode = dentry->d_inode; - int ret = WIMLIB_ERR_INVALID_DENTRY; - - if (!dentry->d_inode->verified) { - ret = verify_inode(dentry->d_inode, w); - if (ret != 0) - goto out; - } - - /* Cannot have a short name but no long name */ - if (dentry->short_name_len && !dentry->file_name_len) { - ERROR("Dentry `%s' has a short name but no long name", - dentry->full_path_utf8); - goto out; - } - - /* Make sure root dentry is unnamed */ - if (dentry_is_root(dentry)) { - if (dentry->file_name_len) { - ERROR("The root dentry is named `%s', but it must " - "be unnamed", dentry->file_name_utf8); - goto out; - } - } - -#if 0 - /* Check timestamps */ - if (inode->last_access_time < inode->creation_time || - inode->last_write_time < inode->creation_time) { - WARNING("Dentry `%s' was created after it was last accessed or " - "written to", dentry->full_path_utf8); - } #endif - ret = 0; -out: - return ret; -} - - #ifdef WITH_FUSE -/* Returns the alternate data stream entry belonging to @inode that has the - * stream name @stream_name. */ -struct ads_entry *inode_get_ads_entry(struct inode *inode, +/* + * Returns the alternate data stream entry belonging to @inode that has the + * stream name @stream_name. + */ +struct wim_ads_entry *inode_get_ads_entry(struct wim_inode *inode, const char *stream_name, u16 *idx_ret) { - size_t stream_name_len; - if (!stream_name) - return NULL; - if (inode->num_ads) { + if (inode->i_num_ads != 0) { u16 i = 0; - stream_name_len = strlen(stream_name); + size_t stream_name_len = strlen(stream_name); do { - if (ads_entry_has_name(&inode->ads_entries[i], + if (ads_entry_has_name(&inode->i_ads_entries[i], stream_name, stream_name_len)) { if (idx_ret) *idx_ret = i; - return &inode->ads_entries[i]; + return &inode->i_ads_entries[i]; } - } while (++i != inode->num_ads); + } while (++i != inode->i_num_ads); } return NULL; } #endif #if defined(WITH_FUSE) || defined(WITH_NTFS_3G) -/* - * Add an alternate stream entry to an inode and return a pointer to it, or NULL - * if memory could not be allocated. +/* + * Add an alternate stream entry to a WIM inode and return a pointer to it, or + * NULL if memory could not be allocated. */ -struct ads_entry *inode_add_ads(struct inode *inode, const char *stream_name) +struct wim_ads_entry *inode_add_ads(struct wim_inode *inode, const char *stream_name) { u16 num_ads; - struct ads_entry *ads_entries; - struct ads_entry *new_entry; + struct wim_ads_entry *ads_entries; + struct wim_ads_entry *new_entry; DEBUG("Add alternate data stream \"%s\"", stream_name); - if (inode->num_ads >= 0xfffe) { + if (inode->i_num_ads >= 0xfffe) { ERROR("Too many alternate data streams in one inode!"); return NULL; } - num_ads = inode->num_ads + 1; - ads_entries = REALLOC(inode->ads_entries, - num_ads * sizeof(inode->ads_entries[0])); + num_ads = inode->i_num_ads + 1; + ads_entries = REALLOC(inode->i_ads_entries, + num_ads * sizeof(inode->i_ads_entries[0])); if (!ads_entries) { ERROR("Failed to allocate memory for new alternate data stream"); return NULL; } - inode->ads_entries = ads_entries; + inode->i_ads_entries = ads_entries; - new_entry = &inode->ads_entries[num_ads - 1]; + new_entry = &inode->i_ads_entries[num_ads - 1]; if (init_ads_entry(new_entry, stream_name) != 0) return NULL; #ifdef WITH_FUSE - new_entry->stream_id = inode->next_stream_id++; + new_entry->stream_id = inode->i_next_stream_id++; #endif - inode->num_ads = num_ads; + inode->i_num_ads = num_ads; return new_entry; } #endif #ifdef WITH_FUSE -/* Remove an alternate data stream from the inode */ -void inode_remove_ads(struct inode *inode, u16 idx, - struct lookup_table *lookup_table) +/* Remove an alternate data stream from a WIM inode */ +void inode_remove_ads(struct wim_inode *inode, u16 idx, + struct wim_lookup_table *lookup_table) { - struct ads_entry *ads_entry; - struct lookup_table_entry *lte; + struct wim_ads_entry *ads_entry; + struct wim_lookup_table_entry *lte; - wimlib_assert(idx < inode->num_ads); - wimlib_assert(inode->resolved); + wimlib_assert(idx < inode->i_num_ads); + wimlib_assert(inode->i_resolved); - ads_entry = &inode->ads_entries[idx]; + ads_entry = &inode->i_ads_entries[idx]; DEBUG("Remove alternate data stream \"%s\"", ads_entry->stream_name_utf8); @@ -1118,22 +1117,22 @@ void inode_remove_ads(struct inode *inode, u16 idx, destroy_ads_entry(ads_entry); - memcpy(&inode->ads_entries[idx], - &inode->ads_entries[idx + 1], - (inode->num_ads - idx - 1) * sizeof(inode->ads_entries[0])); - inode->num_ads--; + memcpy(&inode->i_ads_entries[idx], + &inode->i_ads_entries[idx + 1], + (inode->i_num_ads - idx - 1) * sizeof(inode->i_ads_entries[0])); + inode->i_num_ads--; } #endif -/* - * Reads the alternate data stream entries for a dentry. +/* + * Reads the alternate data stream entries of a WIM dentry. * * @p: Pointer to buffer that starts with the first alternate stream entry. * * @inode: Inode to load the alternate data streams into. - * @inode->num_ads must have been set to the number of + * @inode->i_num_ads must have been set to the number of * alternate data streams that are expected. * * @remaining_size: Number of bytes of data remaining in the buffer pointed @@ -1141,9 +1140,9 @@ void inode_remove_ads(struct inode *inode, u16 idx, * * The format of the on-disk alternate stream entries is as follows: * - * struct ads_entry_on_disk { + * struct wim_ads_entry_on_disk { * u64 length; // Length of the entry, in bytes. This includes - * all fields (including the stream name and + * all fields (including the stream name and * null terminator if present, AND the padding!). * u64 reserved; // Seems to be unused * u8 hash[20]; // SHA1 message digest of the uncompressed stream @@ -1163,19 +1162,19 @@ void inode_remove_ads(struct inode *inode, u16 idx, * * In addition, the entries are 8-byte aligned. * - * Return 0 on success or nonzero on failure. On success, inode->ads_entries - * is set to an array of `struct ads_entry's of length inode->num_ads. On + * Return 0 on success or nonzero on failure. On success, inode->i_ads_entries + * is set to an array of `struct wim_ads_entry's of length inode->i_num_ads. On * failure, @inode is not modified. */ -static int read_ads_entries(const u8 *p, struct inode *inode, +static int read_ads_entries(const u8 *p, struct wim_inode *inode, u64 remaining_size) { u16 num_ads; - struct ads_entry *ads_entries; + struct wim_ads_entry *ads_entries; int ret; - num_ads = inode->num_ads; - ads_entries = CALLOC(num_ads, sizeof(inode->ads_entries[0])); + num_ads = inode->i_num_ads; + ads_entries = CALLOC(num_ads, sizeof(inode->i_ads_entries[0])); if (!ads_entries) { ERROR("Could not allocate memory for %"PRIu16" " "alternate data stream entries", num_ads); @@ -1183,7 +1182,7 @@ static int read_ads_entries(const u8 *p, struct inode *inode, } for (u16 i = 0; i < num_ads; i++) { - struct ads_entry *cur_entry; + struct wim_ads_entry *cur_entry; u64 length; u64 length_no_padding; u64 total_length; @@ -1255,15 +1254,14 @@ static int read_ads_entries(const u8 *p, struct inode *inode, } get_bytes(p, cur_entry->stream_name_len, (u8*)cur_entry->stream_name); - cur_entry->stream_name_utf8 = utf16_to_utf8(cur_entry->stream_name, - cur_entry->stream_name_len, - &utf8_len); - cur_entry->stream_name_utf8_len = utf8_len; - if (!cur_entry->stream_name_utf8) { - ret = WIMLIB_ERR_NOMEM; + ret = utf16_to_utf8(cur_entry->stream_name, + cur_entry->stream_name_len, + &cur_entry->stream_name_utf8, + &utf8_len); + if (ret != 0) goto out_free_ads_entries; - } + cur_entry->stream_name_utf8_len = utf8_len; } /* It's expected that the size of every ADS entry is a multiple * of 8. However, to be safe, I'm allowing the possibility of @@ -1279,9 +1277,9 @@ static int read_ads_entries(const u8 *p, struct inode *inode, else remaining_size -= total_length; } - inode->ads_entries = ads_entries; + inode->i_ads_entries = ads_entries; #ifdef WITH_FUSE - inode->next_stream_id = inode->num_ads + 1; + inode->i_next_stream_id = inode->i_num_ads + 1; #endif return 0; out_free_ads_entries: @@ -1291,23 +1289,23 @@ out_free_ads_entries: return ret; } -/* - * Reads a directory entry, including all alternate data stream entries that +/* + * Reads a WIM directory entry, including all alternate data stream entries that * follow it, from the WIM image's metadata resource. * * @metadata_resource: Buffer containing the uncompressed metadata resource. * @metadata_resource_len: Length of the metadata resource. * @offset: Offset of this directory entry in the metadata resource. - * @dentry: A `struct dentry' that will be filled in by this function. + * @dentry: A `struct wim_dentry' that will be filled in by this function. * - * Return 0 on success or nonzero on failure. On failure, @dentry have been - * modified, bu it will be left with no pointers to any allocated buffers. - * On success, the dentry->length field must be examined. If zero, this was a - * special "end of directory" dentry and not a real dentry. If nonzero, this - * was a real dentry. + * Return 0 on success or nonzero on failure. On failure, @dentry will have + * been modified, but it will not be left with pointers to any allocated + * buffers. On success, the dentry->length field must be examined. If zero, + * this was a special "end of directory" dentry and not a real dentry. If + * nonzero, this was a real dentry. */ -int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, - u64 offset, struct dentry *dentry) +int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, + u64 offset, struct wim_dentry *dentry) { const u8 *p; u64 calculated_size; @@ -1318,7 +1316,7 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, u16 file_name_len; size_t file_name_utf8_len = 0; int ret; - struct inode *inode = NULL; + struct wim_inode *inode = NULL; dentry_common_init(dentry); @@ -1367,8 +1365,8 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, if (!inode) return WIMLIB_ERR_NOMEM; - p = get_u32(p, &inode->attributes); - p = get_u32(p, (u32*)&inode->security_id); + p = get_u32(p, &inode->i_attributes); + p = get_u32(p, (u32*)&inode->i_security_id); p = get_u64(p, &dentry->subdir_offset); /* 2 unused fields */ @@ -1376,38 +1374,38 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, /*p = get_u64(p, &dentry->unused1);*/ /*p = get_u64(p, &dentry->unused2);*/ - p = get_u64(p, &inode->creation_time); - p = get_u64(p, &inode->last_access_time); - p = get_u64(p, &inode->last_write_time); + p = get_u64(p, &inode->i_creation_time); + p = get_u64(p, &inode->i_last_access_time); + p = get_u64(p, &inode->i_last_write_time); + + p = get_bytes(p, SHA1_HASH_SIZE, inode->i_hash); - p = get_bytes(p, SHA1_HASH_SIZE, inode->hash); - /* * I don't know what's going on here. It seems like M$ screwed up the * reparse points, then put the fields in the same place and didn't * document it. The WIM_HDR_FLAG_RP_FIX flag in the WIM header might * have something to do with this, but it's not documented. */ - if (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT) { + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { /* ??? */ p += 4; - p = get_u32(p, &inode->reparse_tag); + p = get_u32(p, &inode->i_reparse_tag); p += 4; } else { - p = get_u32(p, &inode->reparse_tag); - p = get_u64(p, &inode->ino); + p = get_u32(p, &inode->i_reparse_tag); + p = get_u64(p, &inode->i_ino); } /* By the way, the reparse_reserved field does not actually exist (at * least when the file is not a reparse point) */ - - p = get_u16(p, &inode->num_ads); + + p = get_u16(p, &inode->i_num_ads); p = get_u16(p, &short_name_len); p = get_u16(p, &file_name_len); /* We now know the length of the file name and short name. Make sure - * the length of the dentry is large enough to actually hold them. + * the length of the dentry is large enough to actually hold them. * * The calculated length here is unaligned to allow for the possibility * that the dentry->length names an unaligned length, although this @@ -1418,10 +1416,11 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, if (dentry->length < calculated_size) { ERROR("Unexpected end of directory entry! (Expected " "at least %"PRIu64" bytes, got %"PRIu64" bytes. " - "short_name_len = %hu, file_name_len = %hu)", + "short_name_len = %hu, file_name_len = %hu)", calculated_size, dentry->length, short_name_len, file_name_len); - return WIMLIB_ERR_INVALID_DENTRY; + ret = WIMLIB_ERR_INVALID_DENTRY; + goto out_free_inode; } /* Read the filename if present. Note: if the filename is empty, there @@ -1431,20 +1430,16 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, if (!file_name) { ERROR("Failed to allocate %hu bytes for dentry file name", file_name_len); - return WIMLIB_ERR_NOMEM; + ret = WIMLIB_ERR_NOMEM; + goto out_free_inode; } p = get_bytes(p, file_name_len, file_name); /* Convert filename to UTF-8. */ - file_name_utf8 = utf16_to_utf8(file_name, file_name_len, - &file_name_utf8_len); - - if (!file_name_utf8) { - ERROR("Failed to allocate memory to convert UTF-16 " - "filename (%hu bytes) to UTF-8", file_name_len); - ret = WIMLIB_ERR_NOMEM; + ret = utf16_to_utf8(file_name, file_name_len, &file_name_utf8, + &file_name_utf8_len); + if (ret != 0) goto out_free_file_name; - } if (*(u16*)p) WARNING("Expected two zero bytes following the file name " "`%s', but found non-zero bytes", file_name_utf8); @@ -1496,12 +1491,12 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, p = get_bytes(p, short_name_len, short_name); if (*(u16*)p) - WARNING("Expected two zero bytes following the file name " + WARNING("Expected two zero bytes following the short name of " "`%s', but found non-zero bytes", file_name_utf8); p += 2; } - /* + /* * Read the alternate data streams, if present. dentry->num_ads tells * us how many they are, and they will directly follow the dentry * on-disk. @@ -1510,23 +1505,40 @@ int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, * aligned boundary, and the alternate data stream entries are NOT * included in the dentry->length field for some reason. */ - if (inode->num_ads != 0) { - if (calculated_size > metadata_resource_len - offset) { - ERROR("Not enough space in metadata resource for " - "alternate stream entries"); - ret = WIMLIB_ERR_INVALID_DENTRY; - goto out_free_short_name; + if (inode->i_num_ads != 0) { + + /* Trying different lengths is just a hack to make sure we have + * a chance of reading the ADS entries correctly despite the + * poor documentation. */ + + if (calculated_size != dentry->length) { + WARNING("Trying calculated dentry length (%"PRIu64") " + "instead of dentry->length field (%"PRIu64") " + "to read ADS entries", + calculated_size, dentry->length); } - ret = read_ads_entries(&metadata_resource[offset + calculated_size], - inode, - metadata_resource_len - offset - calculated_size); - if (ret != 0) - goto out_free_short_name; + u64 lengths_to_try[3] = {calculated_size, + (dentry->length + 7) & ~7, + dentry->length}; + ret = WIMLIB_ERR_INVALID_DENTRY; + for (size_t i = 0; i < ARRAY_LEN(lengths_to_try); i++) { + if (lengths_to_try[i] > metadata_resource_len - offset) + continue; + ret = read_ads_entries(&metadata_resource[offset + lengths_to_try[i]], + inode, + metadata_resource_len - offset - lengths_to_try[i]); + if (ret == 0) + goto out; + } + ERROR("Failed to read alternate data stream " + "entries of `%s'", dentry->file_name_utf8); + goto out_free_short_name; } +out: /* We've read all the data for this dentry. Set the names and their * lengths, and we've done. */ - dentry->d_inode = inode; + dentry->d_inode = inode; dentry->file_name = file_name; dentry->file_name_utf8 = file_name_utf8; dentry->short_name = short_name; @@ -1554,7 +1566,7 @@ out_free_inode: * @metadata_resource_len: The length of the uncompressed metadata resource, in * bytes. * - * @dentry: A pointer to a `struct dentry' that is the root of the directory + * @dentry: A pointer to a `struct wim_dentry' that is the root of the directory * tree and has already been read from the metadata resource. It * does not need to be the real root because this procedure is * called recursively. @@ -1562,16 +1574,14 @@ out_free_inode: * @return: Zero on success, nonzero on failure. */ int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len, - struct dentry *dentry) + struct wim_dentry *dentry) { u64 cur_offset = dentry->subdir_offset; - struct dentry *prev_child = NULL; - struct dentry *first_child = NULL; - struct dentry *child; - struct dentry cur_child; + struct wim_dentry *child; + struct wim_dentry cur_child; int ret; - /* + /* * If @dentry has no child dentries, nothing more needs to be done for * this branch. This is the case for regular files, symbolic links, and * *possibly* empty directories (although an empty directory may also @@ -1584,7 +1594,7 @@ int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len, while (1) { /* Read next child of @dentry into @cur_child. */ - ret = read_dentry(metadata_resource, metadata_resource_len, + ret = read_dentry(metadata_resource, metadata_resource_len, cur_offset, &cur_child); if (ret != 0) break; @@ -1595,30 +1605,21 @@ int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len, /* Not end of directory. Allocate this child permanently and * link it to the parent and previous child. */ - child = MALLOC(sizeof(struct dentry)); + child = MALLOC(sizeof(struct wim_dentry)); if (!child) { ERROR("Failed to allocate %zu bytes for new dentry", - sizeof(struct dentry)); + sizeof(struct wim_dentry)); ret = WIMLIB_ERR_NOMEM; break; } - memcpy(child, &cur_child, sizeof(struct dentry)); - - if (prev_child) { - prev_child->next = child; - child->prev = prev_child; - } else { - first_child = child; - } - - child->parent = dentry; - prev_child = child; + memcpy(child, &cur_child, sizeof(struct wim_dentry)); + dentry_add_child(dentry, child); inode_add_dentry(child, child->d_inode); /* If there are children of this child, call this procedure * recursively. */ if (child->subdir_offset != 0) { - ret = read_dentry_tree(metadata_resource, + ret = read_dentry_tree(metadata_resource, metadata_resource_len, child); if (ret != 0) break; @@ -1631,18 +1632,10 @@ int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len, * entries. */ cur_offset += dentry_total_length(child); } - - /* Link last child to first one, and set parent's children pointer to - * the first child. */ - if (prev_child) { - prev_child->next = first_child; - first_child->prev = prev_child; - } - dentry->d_inode->children = first_child; return ret; } -/* +/* * Writes a WIM dentry to an output buffer. * * @dentry: The dentry structure. @@ -1650,11 +1643,11 @@ int read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len, * @return: Pointer to the byte after the last byte we wrote as part of the * dentry. */ -static u8 *write_dentry(const struct dentry *dentry, u8 *p) +static u8 *write_dentry(const struct wim_dentry *dentry, u8 *p) { u8 *orig_p = p; const u8 *hash; - const struct inode *inode = dentry->d_inode; + const struct wim_inode *inode = dentry->d_inode; /* We calculate the correct length of the dentry ourselves because the * dentry->length field may been set to an unexpected value from when we @@ -1663,30 +1656,30 @@ static u8 *write_dentry(const struct dentry *dentry, u8 *p) u64 length = dentry_correct_length(dentry); p = put_u64(p, length); - p = put_u32(p, inode->attributes); - p = put_u32(p, inode->security_id); + p = put_u32(p, inode->i_attributes); + p = put_u32(p, inode->i_security_id); p = put_u64(p, dentry->subdir_offset); p = put_u64(p, 0); /* unused1 */ p = put_u64(p, 0); /* unused2 */ - p = put_u64(p, inode->creation_time); - p = put_u64(p, inode->last_access_time); - p = put_u64(p, inode->last_write_time); + p = put_u64(p, inode->i_creation_time); + p = put_u64(p, inode->i_last_access_time); + p = put_u64(p, inode->i_last_write_time); hash = inode_stream_hash(inode, 0); p = put_bytes(p, SHA1_HASH_SIZE, hash); - if (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT) { + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { p = put_zeroes(p, 4); - p = put_u32(p, inode->reparse_tag); + p = put_u32(p, inode->i_reparse_tag); p = put_zeroes(p, 4); } else { u64 link_group_id; p = put_u32(p, 0); - if (inode->link_count == 1) + if (inode->i_nlink == 1) link_group_id = 0; else - link_group_id = inode->ino; + link_group_id = inode->i_ino; p = put_u64(p, link_group_id); } - p = put_u16(p, inode->num_ads); + p = put_u16(p, inode->i_num_ads); p = put_u16(p, dentry->short_name_len); p = put_u16(p, dentry->file_name_len); if (dentry->file_name_len) { @@ -1705,15 +1698,15 @@ static u8 *write_dentry(const struct dentry *dentry, u8 *p) /* Write the alternate data streams, if there are any. Please see * read_ads_entries() for comments about the format of the on-disk * alternate data stream entries. */ - for (u16 i = 0; i < inode->num_ads; i++) { - p = put_u64(p, ads_entry_total_length(&inode->ads_entries[i])); + for (u16 i = 0; i < inode->i_num_ads; i++) { + p = put_u64(p, ads_entry_total_length(&inode->i_ads_entries[i])); p = put_u64(p, 0); /* Unused */ hash = inode_stream_hash(inode, i + 1); p = put_bytes(p, SHA1_HASH_SIZE, hash); - p = put_u16(p, inode->ads_entries[i].stream_name_len); - if (inode->ads_entries[i].stream_name_len) { - p = put_bytes(p, inode->ads_entries[i].stream_name_len, - (u8*)inode->ads_entries[i].stream_name); + p = put_u16(p, inode->i_ads_entries[i].stream_name_len); + if (inode->i_ads_entries[i].stream_name_len) { + p = put_bytes(p, inode->i_ads_entries[i].stream_name_len, + (u8*)inode->i_ads_entries[i].stream_name); p = put_u16(p, 0); } p = put_zeroes(p, (8 - (p - orig_p) % 8) % 8); @@ -1722,40 +1715,44 @@ static u8 *write_dentry(const struct dentry *dentry, u8 *p) return p; } +static int write_dentry_cb(struct wim_dentry *dentry, void *_p) +{ + u8 **p = _p; + *p = write_dentry(dentry, *p); + return 0; +} + +static u8 *write_dentry_tree_recursive(const struct wim_dentry *parent, u8 *p); + +static int write_dentry_tree_recursive_cb(struct wim_dentry *dentry, void *_p) +{ + u8 **p = _p; + *p = write_dentry_tree_recursive(dentry, *p); + return 0; +} + /* Recursive function that writes a dentry tree rooted at @parent, not including * @parent itself, which has already been written. */ -static u8 *write_dentry_tree_recursive(const struct dentry *parent, u8 *p) +static u8 *write_dentry_tree_recursive(const struct wim_dentry *parent, u8 *p) { - const struct dentry *child; - /* Nothing to do if this dentry has no children. */ if (parent->subdir_offset == 0) return p; - /* Write child dentries and end-of-directory entry. + /* Write child dentries and end-of-directory entry. * * Note: we need to write all of this dentry's children before * recursively writing the directory trees rooted at each of the child * dentries, since the on-disk dentries for a dentry's children are * always located at consecutive positions in the metadata resource! */ - child = parent->d_inode->children; - if (child) { - do { - p = write_dentry(child, p); - child = child->next; - } while (child != parent->d_inode->children); - } + for_dentry_in_rbtree(parent->d_inode->i_children.rb_node, write_dentry_cb, &p); /* write end of directory entry */ p = put_u64(p, 0); /* Recurse on children. */ - if (child) { - do { - p = write_dentry_tree_recursive(child, p); - child = child->next; - } while (child != parent->d_inode->children); - } + for_dentry_in_rbtree(parent->d_inode->i_children.rb_node, + write_dentry_tree_recursive_cb, &p); return p; } @@ -1766,8 +1763,9 @@ static u8 *write_dentry_tree_recursive(const struct dentry *parent, u8 *p) * * Returns pointer to the byte after the last byte we wrote. */ -u8 *write_dentry_tree(const struct dentry *root, u8 *p) +u8 *write_dentry_tree(const struct wim_dentry *root, u8 *p) { + DEBUG("Writing dentry tree."); wimlib_assert(dentry_is_root(root)); /* If we're the root dentry, we have no parent that already @@ -1781,4 +1779,3 @@ u8 *write_dentry_tree(const struct dentry *root, u8 *p) /* Recursively write the rest of the dentry tree. */ return write_dentry_tree_recursive(root, p); } -