X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fdentry.c;h=324fbcf8a63b4f72dba20625fa927d6cbcaf48c4;hp=19e4199f76412797c8bda735ad97c22a942a129b;hb=65adcad3e3d5eb01aaaf0dab9d3e509364dac673;hpb=2850f8933244f6c63f608eec612ad804e01072e1 diff --git a/src/dentry.c b/src/dentry.c index 19e4199f..324fbcf8 100644 --- a/src/dentry.c +++ b/src/dentry.c @@ -1,50 +1,72 @@ /* - * dentry.c + * dentry.c - see description below + */ + +/* + * Copyright (C) 2012, 2013, 2014 Eric Biggers * - * 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. + * This file is free software; you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation; either version 3 of the License, or (at your option) any + * later version. + * + * This file is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more + * details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this file; if not, see http://www.gnu.org/licenses/. */ /* - * Copyright (C) 2012, 2013 Eric Biggers + * This file contains logic to deal with WIM directory entries, or "dentries": + * + * - Reading a dentry tree from a metadata resource in a WIM file + * - Writing a dentry tree to a metadata resource in a WIM file + * - Iterating through a tree of WIM dentries + * - Path lookup: translating a path into a WIM dentry or inode + * - Creating, modifying, and deleting WIM dentries * - * This file is part of wimlib, a library for working with WIM files. + * Notes: * - * wimlib is free software; you can redistribute it and/or modify it under the - * terms of the GNU General Public License as published by the Free Software - * Foundation; either version 3 of the License, or (at your option) any later - * version. + * - A WIM file can contain multiple images, each of which has an independent + * tree of dentries. "On disk", the dentry tree for an image is stored in + * the "metadata resource" for that image. * - * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY - * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - * A PARTICULAR PURPOSE. See the GNU General Public License for more details. + * - Multiple dentries in an image may correspond to the same inode, or "file". + * When this occurs, it means that the file has multiple names, or "hard + * links". A dentry is not a file, but rather the name of a file! * - * You should have received a copy of the GNU General Public License along with - * wimlib; if not, see http://www.gnu.org/licenses/. + * - Inodes are not represented explicitly in the WIM file format. Instead, + * the metadata resource provides a "hard link group ID" for each dentry. + * wimlib handles pulling out actual inodes from this information, but this + * occurs in inode_fixup.c and not in this file. + * + * - wimlib does not allow *directory* hard links, so a WIM image really does + * have a *tree* of dentries (and not an arbitrary graph of dentries). + * + * - wimlib indexes dentries both case-insensitively and case-sensitively, + * allowing either behavior to be used for path lookup. + * + * - Multiple dentries in a directory might have the same case-insensitive + * name. But wimlib enforces that at most one dentry in a directory can have + * a given case-sensitive name. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif -#include "wimlib.h" -#include "wimlib/case.h" +#include + +#include "wimlib/assert.h" #include "wimlib/dentry.h" +#include "wimlib/inode.h" #include "wimlib/encoding.h" #include "wimlib/endianness.h" -#include "wimlib/error.h" -#include "wimlib/lookup_table.h" #include "wimlib/metadata.h" #include "wimlib/paths.h" -#include "wimlib/resource.h" -#include "wimlib/security.h" -#include "wimlib/sha1.h" -#include "wimlib/timestamp.h" - -#include /* On-disk format of a WIM dentry (directory entry), located in the metadata * resource for a WIM image. */ @@ -84,7 +106,6 @@ struct wim_dentry_on_disk { le64 unused_1; le64 unused_2; - /* Creation time, last access time, and last write time, in * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601. They * should correspond to the times gotten by calling GetFileTime() on @@ -143,11 +164,8 @@ struct wim_dentry_on_disk { * not matter, as long as they are unique. * - However, due to bugs in Microsoft's software, it is actually NOT * guaranteed that directory entries that share the same hard link - * group ID are actually hard linked to each either. We have to - * handle this by using special code to use distinguishing features - * (which is possible because some information about the underlying - * inode is repeated in each dentry) to split up these fake hard link - * groups into what they actually are supposed to be. + * group ID are actually hard linked to each either. See + * inode_fixup.c for the code that handles this. */ union { struct { @@ -166,88 +184,157 @@ struct wim_dentry_on_disk { * dentry on-disk. */ le16 num_alternate_data_streams; - /* Length of this file's UTF-16LE encoded short name (8.3 DOS-compatible - * name), if present, in bytes, excluding the null terminator. If this - * file has no short name, then this field should be 0. */ + /* If nonzero, this is the length, in bytes, of this dentry's UTF-16LE + * encoded short name (8.3 DOS-compatible name), excluding the null + * terminator. If zero, then the long name of this dentry does not have + * a corresponding short name (but this does not exclude the possibility + * that another dentry for the same file has a short name). */ le16 short_name_nbytes; - /* Length of this file's UTF-16LE encoded "long" name, excluding the - * null terminator. If this file has no short name, then this field - * should be 0. It's expected that only the root dentry has this field - * set to 0. */ + /* If nonzero, this is the length, in bytes, of this dentry's UTF-16LE + * encoded "long" name, excluding the null terminator. If zero, then + * this file has no long name. The root dentry should not have a long + * name, but all other dentries in the image should have long names. */ le16 file_name_nbytes; - /* Followed by variable length file name, in UTF16-LE, if - * file_name_nbytes != 0. Includes null terminator. */ + /* Beginning of optional, variable-length fields */ + + /* If file_name_nbytes != 0, the next field will be the UTF-16LE encoded + * long file name. This will be null-terminated, so the size of this + * field will really be file_name_nbytes + 2. */ /*utf16lechar file_name[];*/ - /* Followed by variable length short name, in UTF16-LE, if - * short_name_nbytes != 0. Includes null terminator. */ + /* If short_name_nbytes != 0, the next field will be the UTF-16LE + * encoded short name. This will be null-terminated, so the size of + * this field will really be short_name_nbytes + 2. */ /*utf16lechar short_name[];*/ -} _packed_attribute; -/* 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. */ + /* If there is still space in the dentry (according to the 'length' + * field) after 8-byte alignment, then the remaining space will be a + * variable-length list of tagged metadata items. See tagged_items.c + * for more information. */ + /* u8 tagged_items[] _aligned_attribute(8); */ + +} _packed_attribute; + /* If num_alternate_data_streams != 0, then there are that many + * alternate data stream entries following the dentry, on an 8-byte + * aligned boundary. They are not counted in the 'length' field of the + * dentry. */ + +/* Calculate the minimum unaligned length, in bytes, of an on-disk WIM dentry + * that has names of the specified lengths. (Zero length means the + * corresponding name actually does not exist.) The returned value excludes + * tagged metadata items as well as any alternate data stream entries that may + * need to follow the dentry. */ static u64 -dentry_correct_length_unaligned(u16 file_name_nbytes, u16 short_name_nbytes) +dentry_min_len_with_names(u16 file_name_nbytes, u16 short_name_nbytes) { u64 length = sizeof(struct wim_dentry_on_disk); if (file_name_nbytes) - length += file_name_nbytes + 2; + length += (u32)file_name_nbytes + 2; if (short_name_nbytes) - length += short_name_nbytes + 2; + length += (u32)short_name_nbytes + 2; return length; } -/* 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_aligned(const struct wim_dentry *dentry) +static void +do_dentry_set_name(struct wim_dentry *dentry, utf16lechar *file_name, + size_t file_name_nbytes) { - u64 len; + FREE(dentry->file_name); + dentry->file_name = file_name; + dentry->file_name_nbytes = file_name_nbytes; - len = dentry_correct_length_unaligned(dentry->file_name_nbytes, - dentry->short_name_nbytes); - return (len + 7) & ~7; + if (dentry_has_short_name(dentry)) { + FREE(dentry->short_name); + dentry->short_name = NULL; + dentry->short_name_nbytes = 0; + } } -/* Sets the name of a WIM dentry from a multibyte string. - * Only use this on dentries not inserted into the tree. Use rename_wim_path() - * to do a real rename. */ +/* + * Set the name of a WIM dentry from a UTF-16LE string. + * + * This sets the long name of the dentry. The short name will automatically be + * removed, since it may not be appropriate for the new long name. + * + * The @name string need not be null-terminated, since its length is specified + * in @name_nbytes. + * + * If @name_nbytes is 0, both the long and short names of the dentry will be + * removed. + * + * Only use this function on unlinked dentries, since it doesn't update the name + * indices. For dentries that are currently linked into the tree, use + * rename_wim_path(). + * + * Returns 0 or WIMLIB_ERR_NOMEM. + */ int -dentry_set_name(struct wim_dentry *dentry, const tchar *new_name) +dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *name, + size_t name_nbytes) { + utf16lechar *dup = NULL; + + if (name_nbytes) { + dup = utf16le_dupz(name, name_nbytes); + if (!dup) + return WIMLIB_ERR_NOMEM; + } + do_dentry_set_name(dentry, dup, name_nbytes); + return 0; +} + + +/* + * Set the name of a WIM dentry from a 'tchar' string. + * + * This sets the long name of the dentry. The short name will automatically be + * removed, since it may not be appropriate for the new long name. + * + * If @name is NULL or empty, both the long and short names of the dentry will + * be removed. + * + * Only use this function on unlinked dentries, since it doesn't update the name + * indices. For dentries that are currently linked into the tree, use + * rename_wim_path(). + * + * Returns 0 or an error code resulting from a failed string conversion. + */ +int +dentry_set_name(struct wim_dentry *dentry, const tchar *name) +{ + utf16lechar *name_utf16le = NULL; + size_t name_utf16le_nbytes = 0; int ret; - ret = get_utf16le_string(new_name, &dentry->file_name, - &dentry->file_name_nbytes); - if (ret == 0) { - /* Clear the short name and recalculate the dentry length */ - if (dentry_has_short_name(dentry)) { - FREE(dentry->short_name); - dentry->short_name = NULL; - dentry->short_name_nbytes = 0; - } + + if (name && *name) { + ret = tstr_to_utf16le(name, tstrlen(name) * sizeof(tchar), + &name_utf16le, &name_utf16le_nbytes); + if (ret) + return ret; } - return ret; + + do_dentry_set_name(dentry, name_utf16le, name_utf16le_nbytes); + return 0; } -/* 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 ADS entry or dentry on an 8-byte boundary. */ +/* Return the length, in bytes, required for the specified alternate data stream + * (ADS) entry on-disk. This accounts for the fixed-length portion of the ADS + * entry, the {stream name and its null terminator} if present, and the padding + * after the entry to align the next ADS entry or dentry on an 8-byte boundary + * in the uncompressed metadata resource buffer. */ static u64 -ads_entry_total_length(const struct wim_ads_entry *entry) +ads_entry_out_total_length(const struct wim_ads_entry *entry) { u64 len = sizeof(struct wim_ads_entry_on_disk); if (entry->stream_name_nbytes) - len += entry->stream_name_nbytes + 2; + len += (u32)entry->stream_name_nbytes + 2; return (len + 7) & ~7; } /* - * Determine whether to include a "dummy" stream when writing a WIM dentry: + * Determine whether to include a "dummy" stream when writing a WIM dentry. * * Some versions of Microsoft's WIM software (the boot driver(s) in WinPE 3.0, * for example) contain a bug where they assume the first alternate data stream @@ -261,259 +348,188 @@ ads_entry_total_length(const struct wim_ads_entry *entry) * though there is already a field in the dentry itself for the unnamed stream * reference, which then goes to waste. */ -static inline bool +static bool inode_needs_dummy_stream(const struct wim_inode *inode) { - return (inode->i_num_ads > 0 && - inode->i_num_ads < 0xffff && /* overflow check */ - inode->i_canonical_streams); /* assume the dentry is okay if it - already had an unnamed ADS entry - when it was read in */ + /* Normal case */ + if (likely(inode->i_num_ads <= 0)) + return false; + + /* Overflow check */ + if (inode->i_num_ads >= 0xFFFF) + return false; + + /* Assume the dentry is okay if it already had an unnamed ADS entry when + * it was read in. */ + if (!inode->i_canonical_streams) + return false; + + /* We can't use use this workaround on encrypted files because WIMGAPI + * reports that the WIM is in an incorrect format. */ + if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) + return false; + + return true; } -/* Calculate the total number of bytes that will be consumed when a WIM dentry - * is written. This includes base dentry and name fields as well as all - * alternate data stream entries and alignment bytes. */ +/* Calculate the total number of bytes that will be consumed when a dentry is + * written. This includes the fixed-length portion of the dentry, the name + * fields, any tagged metadata items, and any alternate data stream entries. + * Also includes all alignment bytes. */ u64 dentry_out_total_length(const struct wim_dentry *dentry) { - u64 length = dentry_correct_length_aligned(dentry); const struct wim_inode *inode = dentry->d_inode; + u64 len; - if (inode_needs_dummy_stream(inode)) - length += ads_entry_total_length(&(struct wim_ads_entry){}); - - for (u16 i = 0; i < inode->i_num_ads; i++) - length += ads_entry_total_length(&inode->i_ads_entries[i]); + len = dentry_min_len_with_names(dentry->file_name_nbytes, + dentry->short_name_nbytes); + len = (len + 7) & ~7; - return length; -} + if (inode->i_extra_size) { + len += inode->i_extra_size; + len = (len + 7) & ~7; + } -/* Calculate the aligned, total length of a dentry, including all alternate data - * stream entries. Uses dentry->length. */ -static u64 -dentry_in_total_length(const struct wim_dentry *dentry) -{ - u64 length = dentry->length; - 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; -} + if (unlikely(inode->i_num_ads)) { + if (inode_needs_dummy_stream(inode)) + len += ads_entry_out_total_length(&(struct wim_ads_entry){}); -int -for_dentry_in_rbtree(struct rb_node *root, - int (*visitor)(struct wim_dentry *, void *), - void *arg) -{ - 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; - } + for (u16 i = 0; i < inode->i_num_ads; i++) + len += ads_entry_out_total_length(&inode->i_ads_entries[i]); } + + return len; } +/* Internal version of for_dentry_in_tree() that omits the NULL check */ static int -for_dentry_tree_in_rbtree_depth(struct rb_node *node, - int (*visitor)(struct wim_dentry*, void*), - void *arg) +do_for_dentry_in_tree(struct wim_dentry *dentry, + int (*visitor)(struct wim_dentry *, void *), void *arg) { 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) + struct wim_dentry *child; + + ret = (*visitor)(dentry, arg); + if (unlikely(ret)) + return ret; + + for_dentry_child(child, dentry) { + ret = do_for_dentry_in_tree(child, visitor, arg); + if (unlikely(ret)) return ret; } return 0; } +/* Internal version of for_dentry_in_tree_depth() that omits the NULL check */ static int -for_dentry_tree_in_rbtree(struct rb_node *node, - int (*visitor)(struct wim_dentry*, void*), - void *arg) +do_for_dentry_in_tree_depth(struct wim_dentry *dentry, + 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) - return ret; - ret = for_dentry_in_tree(rbnode_dentry(node), visitor, arg); - if (ret) - return ret; - ret = for_dentry_tree_in_rbtree(node->rb_right, visitor, arg); - if (ret) + struct wim_dentry *child; + + for_dentry_child_postorder(child, dentry) { + ret = do_for_dentry_in_tree_depth(child, visitor, arg); + if (unlikely(ret)) return ret; } - return 0; + return unlikely((*visitor)(dentry, arg)); } /* - * Iterate over all children of @dentry, calling the function @visitor, passing - * it a child dentry and the extra argument @arg. + * Call a function on all dentries in a tree. * - * Note: this function iterates over ALL child dentries, even those with the - * same case-insensitive name. + * @arg will be passed as the second argument to each invocation of @visitor. * - * Note: this function clobbers the tmp_list field of the child dentries. */ -int -for_dentry_child(const struct wim_dentry *dentry, - int (*visitor)(struct wim_dentry *, void *), - void *arg) -{ - return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node, - visitor, - arg); -} - -/* 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. - * */ + * This function does a pre-order traversal --- that is, a parent will be + * visited before its children. It also will visit siblings in order of + * case-sensitive filename. Equivalently, this function visits the entire tree + * in the case-sensitive lexicographic order of the full paths. + * + * It is safe to pass NULL for @root, which means that the dentry tree is empty. + * In this case, this function does nothing. + * + * @visitor must not modify the structure of the dentry tree during the + * traversal. + * + * The return value will be 0 if all calls to @visitor returned 0. Otherwise, + * the return value will be the first nonzero value returned by @visitor. + */ int for_dentry_in_tree(struct wim_dentry *root, - int (*visitor)(struct wim_dentry*, void*), void *arg) + int (*visitor)(struct wim_dentry *, void *), void *arg) { - int ret; - - if (root == NULL) + if (unlikely(!root)) return 0; - ret = (*visitor)(root, arg); - if (ret) - return ret; - return for_dentry_tree_in_rbtree(root->d_inode->i_children.rb_node, - visitor, - arg); + return do_for_dentry_in_tree(root, visitor, arg); } -/* Like for_dentry_in_tree(), but the visitor function is always called on a - * dentry's children before on itself. */ -int +/* Like for_dentry_in_tree(), but do a depth-first traversal of the dentry tree. + * That is, the visitor function will be called on a dentry's children before + * itself. It will be safe to free a dentry when visiting it. */ +static int for_dentry_in_tree_depth(struct wim_dentry *root, - int (*visitor)(struct wim_dentry*, void*), void *arg) + int (*visitor)(struct wim_dentry *, void *), void *arg) { - int ret; - - if (root == NULL) + if (unlikely(!root)) return 0; - ret = for_dentry_tree_in_rbtree_depth(root->d_inode->i_children.rb_node, - visitor, arg); - if (ret) - return ret; - return (*visitor)(root, arg); + return do_for_dentry_in_tree_depth(root, visitor, arg); } -/* Calculate the full path of @dentry. The full path of its parent must have - * already been calculated, or it must be the root dentry. */ +/* + * Calculate the full path to @dentry within the WIM image, if not already done. + * + * The full name will be saved in the cached value 'dentry->_full_path'. + * + * Whenever possible, use dentry_full_path() instead of calling this and + * accessing _full_path directly. + * + * Returns 0 or an error code resulting from a failed string conversion. + */ int calculate_dentry_full_path(struct wim_dentry *dentry) { - tchar *full_path; - u32 full_path_nbytes; - int ret; + size_t ulen; + size_t dummy; + const struct wim_dentry *d; if (dentry->_full_path) return 0; - if (dentry_is_root(dentry)) { - static const tchar _root_path[] = {WIM_PATH_SEPARATOR, T('\0')}; - full_path = TSTRDUP(_root_path); - if (full_path == NULL) - return WIMLIB_ERR_NOMEM; - full_path_nbytes = 1 * sizeof(tchar); - } else { - struct wim_dentry *parent; - tchar *parent_full_path; - u32 parent_full_path_nbytes; - size_t filename_nbytes; - - parent = dentry->parent; - if (dentry_is_root(parent)) { - parent_full_path = T(""); - parent_full_path_nbytes = 0; - } else { - if (parent->_full_path == NULL) { - ret = calculate_dentry_full_path(parent); - if (ret) - return ret; - } - parent_full_path = parent->_full_path; - parent_full_path_nbytes = parent->full_path_nbytes; - } - - /* Append this dentry's name as a tchar string to the full path - * of the parent followed by the path separator */ - #if TCHAR_IS_UTF16LE - filename_nbytes = dentry->file_name_nbytes; - #else - { - int ret = utf16le_to_tstr_nbytes(dentry->file_name, - dentry->file_name_nbytes, - &filename_nbytes); - if (ret) - return ret; - } - #endif - - full_path_nbytes = parent_full_path_nbytes + sizeof(tchar) + - filename_nbytes; - full_path = MALLOC(full_path_nbytes + sizeof(tchar)); - if (full_path == NULL) - return WIMLIB_ERR_NOMEM; - memcpy(full_path, parent_full_path, parent_full_path_nbytes); - full_path[parent_full_path_nbytes / sizeof(tchar)] = WIM_PATH_SEPARATOR; - #if TCHAR_IS_UTF16LE - memcpy(&full_path[parent_full_path_nbytes / sizeof(tchar) + 1], - dentry->file_name, - filename_nbytes + sizeof(tchar)); - #else - utf16le_to_tstr_buf(dentry->file_name, - dentry->file_name_nbytes, - &full_path[parent_full_path_nbytes / - sizeof(tchar) + 1]); - #endif - } - dentry->_full_path = full_path; - dentry->full_path_nbytes= full_path_nbytes; - return 0; -} - -static int -do_calculate_dentry_full_path(struct wim_dentry *dentry, void *_ignore) -{ - return calculate_dentry_full_path(dentry); -} - -int -calculate_dentry_tree_full_paths(struct wim_dentry *root) -{ - return for_dentry_in_tree(root, do_calculate_dentry_full_path, NULL); + ulen = 0; + d = dentry; + do { + ulen += d->file_name_nbytes / sizeof(utf16lechar); + ulen++; + d = d->d_parent; /* assumes d == d->d_parent for root */ + } while (!dentry_is_root(d)); + + utf16lechar ubuf[ulen]; + utf16lechar *p = &ubuf[ulen]; + + d = dentry; + do { + p -= d->file_name_nbytes / sizeof(utf16lechar); + memcpy(p, d->file_name, d->file_name_nbytes); + *--p = cpu_to_le16(WIM_PATH_SEPARATOR); + d = d->d_parent; /* assumes d == d->d_parent for root */ + } while (!dentry_is_root(d)); + + wimlib_assert(p == ubuf); + + return utf16le_to_tstr(ubuf, ulen * sizeof(utf16lechar), + &dentry->_full_path, &dummy); } +/* + * Return the full path to the @dentry within the WIM image, or NULL if the full + * path could not be determined due to a string conversion error. + * + * The returned memory will be cached in the dentry, so the caller is not + * responsible for freeing it. + */ tchar * dentry_full_path(struct wim_dentry *dentry) { @@ -522,55 +538,49 @@ dentry_full_path(struct wim_dentry *dentry) } static int -increment_subdir_offset(struct wim_dentry *dentry, void *subdir_offset_p) +dentry_calculate_subdir_offset(struct wim_dentry *dentry, void *_subdir_offset_p) { - *(u64*)subdir_offset_p += dentry_out_total_length(dentry); - return 0; -} + if (dentry_is_directory(dentry)) { + u64 *subdir_offset_p = _subdir_offset_p; + struct wim_dentry *child; -static int -call_calculate_subdir_offsets(struct wim_dentry *dentry, void *subdir_offset_p) -{ - calculate_subdir_offsets(dentry, subdir_offset_p); + /* Set offset of directory's child dentries */ + dentry->subdir_offset = *subdir_offset_p; + + /* Account for child dentries */ + for_dentry_child(child, dentry) + *subdir_offset_p += dentry_out_total_length(child); + + /* Account for end-of-directory entry */ + *subdir_offset_p += 8; + } else { + /* Not a directory; set subdir_offset to 0 */ + dentry->subdir_offset = 0; + } return 0; } /* - * Recursively calculates the subdir offsets for a directory tree. + * Calculate the subdir offsets for a dentry tree, in preparation of writing + * that dentry tree to a metadata resource. + * + * The subdir offset of each dentry is the offset in the uncompressed metadata + * resource at which its child dentries begin, or 0 if that dentry has no + * children. * - * @dentry: The root of the directory tree. - * @subdir_offset_p: The current subdirectory offset; i.e., the subdirectory - * offset for @dentry. + * The caller must initialize *subdir_offset_p to the first subdir offset that + * is available to use after the root dentry is written. + * + * When this function returns, *subdir_offset_p will have been advanced past the + * size needed for the dentry tree within the uncompressed metadata resource. */ void -calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p) +calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p) { - struct rb_node *node; - - dentry->subdir_offset = *subdir_offset_p; - 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. */ - 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. */ - 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 - * files or reparse points have a subdir_offset of 0. */ - if (dentry_is_directory(dentry)) - *subdir_offset_p += 8; - else - dentry->subdir_offset = 0; - } + for_dentry_in_tree(root, dentry_calculate_subdir_offset, subdir_offset_p); } +/* Compare the UTF-16LE long filenames of two dentries case insensitively. */ static int dentry_compare_names_case_insensitive(const struct wim_dentry *d1, const struct wim_dentry *d2) @@ -582,6 +592,7 @@ dentry_compare_names_case_insensitive(const struct wim_dentry *d1, true); } +/* Compare the UTF-16LE long filenames of two dentries case sensitively. */ static int dentry_compare_names_case_sensitive(const struct wim_dentry *d1, const struct wim_dentry *d2) @@ -593,9 +604,32 @@ dentry_compare_names_case_sensitive(const struct wim_dentry *d1, false); } +static int +_avl_dentry_compare_names_ci(const struct avl_tree_node *n1, + const struct avl_tree_node *n2) +{ + const struct wim_dentry *d1, *d2; + + d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node_ci); + d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node_ci); + return dentry_compare_names_case_insensitive(d1, d2); +} + +static int +_avl_dentry_compare_names(const struct avl_tree_node *n1, + const struct avl_tree_node *n2) +{ + const struct wim_dentry *d1, *d2; + + d1 = avl_tree_entry(n1, struct wim_dentry, d_index_node); + d2 = avl_tree_entry(n2, struct wim_dentry, d_index_node); + return dentry_compare_names_case_sensitive(d1, d2); +} + /* Default case sensitivity behavior for searches with - * WIMLIB_CASE_PLATFORM_DEFAULT specified. This can be modified by - * wimlib_global_init(). */ + * WIMLIB_CASE_PLATFORM_DEFAULT specified. This can be modified by passing + * WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE or + * WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE to wimlib_global_init(). */ bool default_ignore_case = #ifdef __WIN32__ true @@ -604,110 +638,121 @@ bool default_ignore_case = #endif ; +/* Case-sensitive dentry lookup. Only @file_name and @file_name_nbytes of + * @dummy must be valid. */ +static struct wim_dentry * +dir_lookup(const struct wim_inode *dir, const struct wim_dentry *dummy) +{ + struct avl_tree_node *node; + + node = avl_tree_lookup_node(dir->i_children, + &dummy->d_index_node, + _avl_dentry_compare_names); + if (!node) + return NULL; + return avl_tree_entry(node, struct wim_dentry, d_index_node); +} + +/* Case-insensitive dentry lookup. Only @file_name and @file_name_nbytes of + * @dummy must be valid. */ +static struct wim_dentry * +dir_lookup_ci(const struct wim_inode *dir, const struct wim_dentry *dummy) +{ + struct avl_tree_node *node; + + node = avl_tree_lookup_node(dir->i_children_ci, + &dummy->d_index_node_ci, + _avl_dentry_compare_names_ci); + if (!node) + return NULL; + return avl_tree_entry(node, struct wim_dentry, d_index_node_ci); +} + /* Given a UTF-16LE filename and a directory, look up the dentry for the file. - * Return it if found, otherwise NULL. This is case-sensitive on UNIX and - * case-insensitive on Windows. */ + * Return it if found, otherwise NULL. This has configurable case sensitivity, + * and @name need not be null-terminated. */ struct wim_dentry * get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry, const utf16lechar *name, size_t name_nbytes, CASE_SENSITIVITY_TYPE case_ctype) { - struct rb_node *node; - + const struct wim_inode *dir = dentry->d_inode; bool ignore_case = will_ignore_case(case_ctype); + struct wim_dentry dummy; + struct wim_dentry *child; - if (ignore_case) - node = dentry->d_inode->i_children_case_insensitive.rb_node; - else - node = dentry->d_inode->i_children.rb_node; + dummy.file_name = (utf16lechar*)name; + dummy.file_name_nbytes = name_nbytes; - struct wim_dentry *child; - while (node) { - if (ignore_case) - child = rb_entry(node, struct wim_dentry, rb_node_case_insensitive); - else - child = rb_entry(node, struct wim_dentry, rb_node); - - int result = cmp_utf16le_strings(name, - name_nbytes / 2, - child->file_name, - child->file_name_nbytes / 2, - ignore_case); - if (result < 0) { - node = node->rb_left; - } else if (result > 0) { - node = node->rb_right; - } else if (!ignore_case || - list_empty(&child->case_insensitive_conflict_list)) { - return child; - } else { - /* Multiple dentries have the same case-insensitive - * name, and a case-insensitive lookup is being - * performed. Choose the dentry with the same - * case-sensitive name, if one exists; otherwise print a - * warning and choose one arbitrarily. */ - struct wim_dentry *alt = child; - size_t num_alts = 0; - - do { - num_alts++; - if (0 == cmp_utf16le_strings(name, - name_nbytes / 2, - alt->file_name, - alt->file_name_nbytes / 2, - false)) - return alt; - alt = list_entry(alt->case_insensitive_conflict_list.next, - struct wim_dentry, - case_insensitive_conflict_list); - } while (alt != child); - - WARNING("Result of case-insensitive lookup is ambiguous\n" - " (returning \"%"TS"\" of %zu " - "possible files, including \"%"TS"\")", - dentry_full_path(child), - num_alts, - dentry_full_path(list_entry(child->case_insensitive_conflict_list.next, - struct wim_dentry, - case_insensitive_conflict_list))); - return child; - } - } - return NULL; + if (!ignore_case) + /* Case-sensitive lookup. */ + return dir_lookup(dir, &dummy); + + /* Case-insensitive lookup. */ + + child = dir_lookup_ci(dir, &dummy); + if (!child) + return NULL; + + if (likely(list_empty(&child->d_ci_conflict_list))) + /* Only one dentry has this case-insensitive name; return it */ + return child; + + /* Multiple dentries have the same case-insensitive name. Choose the + * dentry with the same case-sensitive name, if one exists; otherwise + * print a warning and choose one of the possible dentries arbitrarily. + */ + struct wim_dentry *alt = child; + size_t num_alts = 0; + + do { + num_alts++; + if (!dentry_compare_names_case_sensitive(&dummy, alt)) + return alt; + alt = list_entry(alt->d_ci_conflict_list.next, + struct wim_dentry, d_ci_conflict_list); + } while (alt != child); + + WARNING("Result of case-insensitive lookup is ambiguous\n" + " (returning \"%"TS"\" of %zu " + "possible files, including \"%"TS"\")", + dentry_full_path(child), + num_alts, + dentry_full_path(list_entry(child->d_ci_conflict_list.next, + struct wim_dentry, + d_ci_conflict_list))); + return child; } -/* Returns the child of @dentry that has the file name @name. Returns NULL if - * no child has the name. */ +/* Given a 'tchar' filename and a directory, look up the dentry for the file. + * If the filename was successfully converted to UTF-16LE and the dentry was + * found, return it; otherwise return NULL. This has configurable case + * sensitivity. */ struct wim_dentry * get_dentry_child_with_name(const struct wim_dentry *dentry, const tchar *name, CASE_SENSITIVITY_TYPE case_type) { -#if TCHAR_IS_UTF16LE - return get_dentry_child_with_utf16le_name(dentry, name, - tstrlen(name) * sizeof(tchar), - case_type); -#else - utf16lechar *utf16le_name; - size_t utf16le_name_nbytes; int ret; + const utf16lechar *name_utf16le; + size_t name_utf16le_nbytes; struct wim_dentry *child; - ret = tstr_to_utf16le(name, tstrlen(name) * sizeof(tchar), - &utf16le_name, &utf16le_name_nbytes); - if (ret) { - child = NULL; - } else { - child = get_dentry_child_with_utf16le_name(dentry, - utf16le_name, - utf16le_name_nbytes, - case_type); - FREE(utf16le_name); - } + ret = tstr_get_utf16le_and_len(name, &name_utf16le, + &name_utf16le_nbytes); + if (ret) + return NULL; + + child = get_dentry_child_with_utf16le_name(dentry, + name_utf16le, + name_utf16le_nbytes, + case_type); + tstr_put_utf16le(name_utf16le); return child; -#endif } +/* This is the UTF-16LE version of get_dentry(), currently private to this file + * because no one needs it besides get_dentry(). */ static struct wim_dentry * get_dentry_utf16le(WIMStruct *wim, const utf16lechar *path, CASE_SENSITIVITY_TYPE case_type) @@ -718,7 +763,7 @@ get_dentry_utf16le(WIMStruct *wim, const utf16lechar *path, /* Start with the root directory of the image. Note: this will be NULL * if an image has been added directly with wimlib_add_empty_image() but * no files have been added yet; in that case we fail with ENOENT. */ - cur_dentry = wim_root_dentry(wim); + cur_dentry = wim_get_current_root_dentry(wim); name_start = path; for (;;) { @@ -812,37 +857,31 @@ get_dentry_utf16le(WIMStruct *wim, const utf16lechar *path, struct wim_dentry * get_dentry(WIMStruct *wim, const tchar *path, CASE_SENSITIVITY_TYPE case_type) { -#if TCHAR_IS_UTF16LE - return get_dentry_utf16le(wim, path, case_type); -#else - utf16lechar *path_utf16le; - size_t path_utf16le_nbytes; int ret; + const utf16lechar *path_utf16le; struct wim_dentry *dentry; - ret = tstr_to_utf16le(path, tstrlen(path) * sizeof(tchar), - &path_utf16le, &path_utf16le_nbytes); + ret = tstr_get_utf16le(path, &path_utf16le); if (ret) return NULL; dentry = get_dentry_utf16le(wim, path_utf16le, case_type); - FREE(path_utf16le); + tstr_put_utf16le(path_utf16le); return dentry; -#endif } -/* Takes in a path of length @len in @buf, and transforms it into a string for - * the path of its parent directory. */ +/* Modify @path, which is a null-terminated string @len 'tchars' in length, + * in-place to produce the path to its parent directory. */ static void -to_parent_name(tchar *buf, size_t len) +to_parent_name(tchar *path, size_t len) { ssize_t i = (ssize_t)len - 1; - while (i >= 0 && buf[i] == WIM_PATH_SEPARATOR) + while (i >= 0 && path[i] == WIM_PATH_SEPARATOR) i--; - while (i >= 0 && buf[i] != WIM_PATH_SEPARATOR) + while (i >= 0 && path[i] != WIM_PATH_SEPARATOR) i--; - while (i >= 0 && buf[i] == WIM_PATH_SEPARATOR) + while (i >= 0 && path[i] == WIM_PATH_SEPARATOR) i--; - buf[i + 1] = T('\0'); + path[i + 1] = T('\0'); } /* Similar to get_dentry(), but returns the dentry named by @path with the last @@ -861,114 +900,46 @@ get_parent_dentry(WIMStruct *wim, const tchar *path, return get_dentry(wim, buf, case_type); } -#ifdef WITH_FUSE -/* Finds the dentry, lookup table entry, and stream index for a WIM file stream, - * given a path name. +/* + * Create an unlinked dentry. * - * Currently, lookups of this type are only needed if FUSE is enabled. */ -int -wim_pathname_to_stream(WIMStruct *wim, - const tchar *path, - int lookup_flags, - struct wim_dentry **dentry_ret, - struct wim_lookup_table_entry **lte_ret, - u16 *stream_idx_ret) -{ - struct wim_dentry *dentry; - struct wim_lookup_table_entry *lte; - u16 stream_idx; - const tchar *stream_name = NULL; - struct wim_inode *inode; - tchar *p = NULL; - - if (lookup_flags & LOOKUP_FLAG_ADS_OK) { - stream_name = path_stream_name(path); - if (stream_name) { - p = (tchar*)stream_name - 1; - *p = T('\0'); - } - } - - dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE); - if (p) - *p = T(':'); - if (!dentry) - return -errno; - - inode = dentry->d_inode; - - if (!inode->i_resolved) - if (inode_resolve_streams(inode, wim->lookup_table, false)) - return -EIO; - - if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK) - && inode_is_directory(inode)) - return -EISDIR; - - if (stream_name) { - struct wim_ads_entry *ads_entry; - u16 ads_idx; - ads_entry = inode_get_ads_entry(inode, stream_name, - &ads_idx); - if (ads_entry) { - stream_idx = ads_idx + 1; - lte = ads_entry->lte; - goto out; - } else { - return -ENOENT; - } - } else { - lte = inode_unnamed_stream_resolved(inode, &stream_idx); - } -out: - if (dentry_ret) - *dentry_ret = dentry; - if (lte_ret) - *lte_ret = lte; - if (stream_idx_ret) - *stream_idx_ret = stream_idx; - return 0; -} -#endif /* WITH_FUSE */ - -/* Initializations done on every `struct wim_dentry'. */ -static void -dentry_common_init(struct wim_dentry *dentry) -{ - memset(dentry, 0, sizeof(struct wim_dentry)); -} - -/* Creates an unlinked directory entry. */ + * @name specifies the long name to give the new dentry. If NULL or empty, the + * new dentry will be given no long name. + * + * The new dentry will have no short name and no associated inode. + * + * On success, returns 0 and a pointer to the new, allocated dentry is stored in + * *dentry_ret. On failure, returns WIMLIB_ERR_NOMEM or an error code resulting + * from a failed string conversion. + */ int new_dentry(const tchar *name, struct wim_dentry **dentry_ret) { struct wim_dentry *dentry; int ret; - dentry = MALLOC(sizeof(struct wim_dentry)); - if (dentry == NULL) + dentry = CALLOC(1, sizeof(struct wim_dentry)); + if (!dentry) return WIMLIB_ERR_NOMEM; - dentry_common_init(dentry); - if (*name) { + if (name && *name) { ret = dentry_set_name(dentry, name); if (ret) { FREE(dentry); - ERROR("Failed to set name on new dentry with name \"%"TS"\"", - name); return ret; } } - dentry->parent = dentry; + dentry->d_parent = dentry; *dentry_ret = dentry; return 0; } static int _new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret, - bool timeless) + bool timeless) { struct wim_dentry *dentry; + struct wim_inode *inode; int ret; ret = new_dentry(name, &dentry); @@ -976,39 +947,46 @@ _new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret, return ret; if (timeless) - dentry->d_inode = new_timeless_inode(); + inode = new_timeless_inode(); else - dentry->d_inode = new_inode(); - if (dentry->d_inode == NULL) { + inode = new_inode(); + if (!inode) { free_dentry(dentry); return WIMLIB_ERR_NOMEM; } - inode_add_dentry(dentry, dentry->d_inode); + d_associate(dentry, inode); + *dentry_ret = dentry; return 0; } +/* Like new_dentry(), but also allocate an inode and associate it with the + * dentry. The timestamps for the inode will be set to the current time. */ int -new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret) +new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret) { - return _new_dentry_with_inode(name, dentry_ret, true); + return _new_dentry_with_inode(name, dentry_ret, false); } +/* Like new_dentry_with_inode(), but don't bother setting the timestamps for the + * new inode; instead, just leave them as 0, under the presumption that the + * caller will set them itself. */ int -new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret) +new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret) { - return _new_dentry_with_inode(name, dentry_ret, false); + return _new_dentry_with_inode(name, dentry_ret, true); } +/* Create an unnamed dentry with a new inode for a directory with the default + * metadata. */ int -new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret) +new_filler_directory(struct wim_dentry **dentry_ret) { int ret; struct wim_dentry *dentry; - DEBUG("Creating filler directory \"%"TS"\"", name); - ret = new_dentry_with_inode(name, &dentry); + ret = new_dentry_with_inode(NULL, &dentry); if (ret) return ret; /* Leave the inode number as 0; this is allowed for non @@ -1032,260 +1010,226 @@ dentry_tree_clear_inode_visited(struct wim_dentry *root) for_dentry_in_tree(root, dentry_clear_inode_visited, NULL); } -/* Frees a WIM dentry. +/* + * Free a WIM dentry. * - * The corresponding inode (if any) is freed only if its link count is - * decremented to 0. */ + * In addition to freeing the dentry itself, this disassociates the dentry from + * its inode. If the inode is no longer in use, it will be freed as well. + */ void free_dentry(struct wim_dentry *dentry) { if (dentry) { + d_disassociate(dentry); FREE(dentry->file_name); FREE(dentry->short_name); FREE(dentry->_full_path); - if (dentry->d_inode) - put_inode(dentry->d_inode); FREE(dentry); } } -/* 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) +do_free_dentry(struct wim_dentry *dentry, void *_ignore) { - struct wim_lookup_table *lookup_table = _lookup_table; - - if (lookup_table) { - struct wim_inode *inode = dentry->d_inode; - for (unsigned i = 0; i <= inode->i_num_ads; i++) { - struct wim_lookup_table_entry *lte; + free_dentry(dentry); + return 0; +} - lte = inode_stream_lte(inode, i, lookup_table); - if (lte) - lte_decrement_refcnt(lte, lookup_table); - } - } +static int +do_free_dentry_and_unref_streams(struct wim_dentry *dentry, void *lookup_table) +{ + inode_unref_streams(dentry->d_inode, lookup_table); free_dentry(dentry); return 0; } /* - * Unlinks and frees a dentry tree. + * Free all dentries in a tree. * * @root: - * The root of the tree. + * The root of the dentry tree to free. If NULL, this function has no + * effect. * * @lookup_table: - * The lookup table for dentries. If non-NULL, the reference counts in the - * lookup table for the lookup table entries corresponding to the dentries - * will be decremented. + * A pointer to the lookup table for the WIM, or NULL if not specified. If + * specified, this function will decrement the reference counts of the + * single-instance streams referenced by the dentries. + * + * This function also releases references to the corresponding inodes. + * + * This function does *not* unlink @root from its parent directory, if it has + * one. If @root has a parent, the caller must unlink @root before calling this + * function. */ void free_dentry_tree(struct wim_dentry *root, struct wim_lookup_table *lookup_table) { - for_dentry_in_tree_depth(root, do_free_dentry, lookup_table); + int (*f)(struct wim_dentry *, void *); + + if (lookup_table) + f = do_free_dentry_and_unref_streams; + else + f = do_free_dentry; + + for_dentry_in_tree_depth(root, f, lookup_table); } -/* Insert a dentry into the case insensitive index for a directory. - * - * This is a red-black tree, but when multiple dentries share the same - * case-insensitive name, only one is inserted into the tree itself; the rest - * are connected in a list. - */ +/* Insert the @child dentry into the case sensitive index of the @dir directory. + * Return NULL if successfully inserted, otherwise a pointer to the + * already-inserted duplicate. */ static struct wim_dentry * -dentry_add_child_case_insensitive(struct wim_dentry *parent, - struct wim_dentry *child) +dir_index_child(struct wim_inode *dir, struct wim_dentry *child) { - struct rb_root *root; - struct rb_node **new; - struct rb_node *rb_parent; - - root = &parent->d_inode->i_children_case_insensitive; - new = &root->rb_node; - rb_parent = NULL; - while (*new) { - struct wim_dentry *this = container_of(*new, struct wim_dentry, - rb_node_case_insensitive); - int result = dentry_compare_names_case_insensitive(child, this); - - rb_parent = *new; - - if (result < 0) - new = &((*new)->rb_left); - else if (result > 0) - new = &((*new)->rb_right); - else - return this; - } - rb_link_node(&child->rb_node_case_insensitive, rb_parent, new); - rb_insert_color(&child->rb_node_case_insensitive, root); - return NULL; + struct avl_tree_node *duplicate; + + duplicate = avl_tree_insert(&dir->i_children, + &child->d_index_node, + _avl_dentry_compare_names); + if (!duplicate) + return NULL; + return avl_tree_entry(duplicate, struct wim_dentry, d_index_node); +} + +/* Insert the @child dentry into the case insensitive index of the @dir + * directory. Return NULL if successfully inserted, otherwise a pointer to the + * already-inserted duplicate. */ +static struct wim_dentry * +dir_index_child_ci(struct wim_inode *dir, struct wim_dentry *child) +{ + struct avl_tree_node *duplicate; + + duplicate = avl_tree_insert(&dir->i_children_ci, + &child->d_index_node_ci, + _avl_dentry_compare_names_ci); + if (!duplicate) + return NULL; + return avl_tree_entry(duplicate, struct wim_dentry, d_index_node_ci); +} + +/* Remove the specified dentry from its directory's case-sensitive index. */ +static void +dir_unindex_child(struct wim_inode *dir, struct wim_dentry *child) +{ + avl_tree_remove(&dir->i_children, &child->d_index_node); +} + +/* Remove the specified dentry from its directory's case-insensitive index. */ +static void +dir_unindex_child_ci(struct wim_inode *dir, struct wim_dentry *child) +{ + avl_tree_remove(&dir->i_children_ci, &child->d_index_node_ci); +} + +/* Return true iff the specified dentry is in its parent directory's + * case-insensitive index. */ +static bool +dentry_in_ci_index(const struct wim_dentry *dentry) +{ + return !avl_tree_node_is_unlinked(&dentry->d_index_node_ci); } /* - * Links a dentry into the directory tree. + * Link a dentry into the tree. * - * @parent: The dentry that will be the parent of @child. - * @child: The dentry to link. + * @parent: + * The dentry that will be the parent of @child. It must name a directory. + * + * @child: + * The dentry to link. It must be currently unlinked. * * Returns NULL if successful. If @parent already contains a dentry with the - * same case-sensitive name as @child, the pointer to this duplicate dentry is - * returned. + * same case-sensitive name as @child, returns a pointer to this duplicate + * dentry. */ struct wim_dentry * -dentry_add_child(struct wim_dentry * restrict parent, - struct wim_dentry * restrict child) +dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child) { - struct rb_root *root; - struct rb_node **new; - struct rb_node *rb_parent; + struct wim_dentry *duplicate; + struct wim_inode *dir; - wimlib_assert(dentry_is_directory(parent)); wimlib_assert(parent != child); - /* Case sensitive child dentry index */ - root = &parent->d_inode->i_children; - new = &root->rb_node; - rb_parent = NULL; - while (*new) { - struct wim_dentry *this = rbnode_dentry(*new); - int result = dentry_compare_names_case_sensitive(child, this); - - rb_parent = *new; - - if (result < 0) - new = &((*new)->rb_left); - else if (result > 0) - new = &((*new)->rb_right); - else - return this; - } - child->parent = parent; - rb_link_node(&child->rb_node, rb_parent, new); - rb_insert_color(&child->rb_node, root); + dir = parent->d_inode; - /* Case insensitive child dentry index */ - { - struct wim_dentry *existing; - existing = dentry_add_child_case_insensitive(parent, child); - if (existing) { - list_add(&child->case_insensitive_conflict_list, - &existing->case_insensitive_conflict_list); - child->rb_node_case_insensitive.__rb_parent_color = 0; - } else { - INIT_LIST_HEAD(&child->case_insensitive_conflict_list); - } + wimlib_assert(inode_is_directory(dir)); + + duplicate = dir_index_child(dir, child); + if (duplicate) + return duplicate; + + duplicate = dir_index_child_ci(dir, child); + if (duplicate) { + list_add(&child->d_ci_conflict_list, &duplicate->d_ci_conflict_list); + avl_tree_node_set_unlinked(&child->d_index_node_ci); + } else { + INIT_LIST_HEAD(&child->d_ci_conflict_list); } + child->d_parent = parent; return NULL; } -/* Unlink a WIM dentry from the directory entry tree. */ +/* Unlink a dentry from the tree. */ void unlink_dentry(struct wim_dentry *dentry) { - struct wim_dentry *parent = dentry->parent; + struct wim_inode *dir; - if (parent == dentry) + /* Do nothing if the dentry is root or it's already unlinked. Not + * actually necessary based on the current callers, but we do the check + * here to be safe. */ + if (unlikely(dentry->d_parent == dentry)) return; - rb_erase(&dentry->rb_node, &parent->d_inode->i_children); - if (dentry->rb_node_case_insensitive.__rb_parent_color) { - /* This dentry was in the case-insensitive red-black tree. */ - rb_erase(&dentry->rb_node_case_insensitive, - &parent->d_inode->i_children_case_insensitive); - if (!list_empty(&dentry->case_insensitive_conflict_list)) { + dir = dentry->d_parent->d_inode; + + dir_unindex_child(dir, dentry); + + if (dentry_in_ci_index(dentry)) { + + dir_unindex_child_ci(dir, dentry); + + if (!list_empty(&dentry->d_ci_conflict_list)) { /* Make a different case-insensitively-the-same dentry - * be the "representative" in the red-black tree. */ + * be the "representative" in the search index. */ struct list_head *next; struct wim_dentry *other; struct wim_dentry *existing; - next = dentry->case_insensitive_conflict_list.next; - other = list_entry(next, struct wim_dentry, case_insensitive_conflict_list); - existing = dentry_add_child_case_insensitive(parent, other); + next = dentry->d_ci_conflict_list.next; + other = list_entry(next, struct wim_dentry, d_ci_conflict_list); + existing = dir_index_child_ci(dir, other); wimlib_assert(existing == NULL); } } - list_del(&dentry->case_insensitive_conflict_list); -} + list_del(&dentry->d_ci_conflict_list); -static int -free_dentry_full_path(struct wim_dentry *dentry, void *_ignore) -{ - FREE(dentry->_full_path); - dentry->_full_path = NULL; - return 0; + /* Not actually necessary, but to be safe don't retain the now-obsolete + * parent pointer. */ + dentry->d_parent = dentry; } -/* Rename a file or directory in the WIM. */ -int -rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to, - CASE_SENSITIVITY_TYPE case_type) +static int +read_extra_data(const u8 *p, const u8 *end, struct wim_inode *inode) { - struct wim_dentry *src; - struct wim_dentry *dst; - struct wim_dentry *parent_of_dst; - int ret; - - /* This rename() implementation currently only supports actual files - * (not alternate data streams) */ - - src = get_dentry(wim, from, case_type); - if (!src) - return -errno; - - dst = get_dentry(wim, to, case_type); - - if (dst) { - /* Destination file exists */ - - if (src == dst) /* Same file */ - return 0; + while (((uintptr_t)p & 7) && p < end) + p++; - if (!dentry_is_directory(src)) { - /* Cannot rename non-directory to directory. */ - if (dentry_is_directory(dst)) - return -EISDIR; - } else { - /* Cannot rename directory to a non-directory or a non-empty - * directory */ - if (!dentry_is_directory(dst)) - return -ENOTDIR; - if (dentry_has_children(dst)) - return -ENOTEMPTY; - } - parent_of_dst = dst->parent; - } else { - /* Destination does not exist */ - parent_of_dst = get_parent_dentry(wim, to, case_type); - if (!parent_of_dst) - return -errno; - - if (!dentry_is_directory(parent_of_dst)) - return -ENOTDIR; - } - - ret = dentry_set_name(src, path_basename(to)); - if (ret) - return -ENOMEM; - if (dst) { - unlink_dentry(dst); - free_dentry_tree(dst, wim->lookup_table); + if (unlikely(p < end)) { + inode->i_extra = memdup(p, end - p); + if (!inode->i_extra) + return WIMLIB_ERR_NOMEM; + inode->i_extra_size = end - p; } - unlink_dentry(src); - dentry_add_child(parent_of_dst, src); - if (src->_full_path) - for_dentry_in_tree(src, free_dentry_full_path, NULL); return 0; } -/* Reads a WIM directory entry, including all alternate data stream entries that - * follow it, from the WIM image's metadata resource. */ +/* Read a dentry, including all alternate data stream entries that follow it, + * from an uncompressed metadata resource buffer. */ static int read_dentry(const u8 * restrict buf, size_t buf_len, - u64 offset, struct wim_dentry **dentry_ret) + u64 *offset_p, struct wim_dentry **dentry_ret) { + u64 offset = *offset_p; u64 length; const u8 *p; const struct wim_dentry_on_disk *disk_dentry; @@ -1316,9 +1260,6 @@ read_dentry(const u8 * restrict buf, size_t buf_len, p = &buf[offset]; disk_dentry = (const struct wim_dentry_on_disk*)p; - if (unlikely((uintptr_t)p & 7)) - WARNING("WIM dentry is not 8-byte aligned"); - /* Get dentry length. */ length = le64_to_cpu(disk_dentry->length); @@ -1346,19 +1287,16 @@ read_dentry(const u8 * restrict buf, size_t buf_len, } /* Allocate new dentry structure, along with a preliminary inode. */ - ret = new_dentry_with_timeless_inode(T(""), &dentry); + ret = new_dentry_with_timeless_inode(NULL, &dentry); if (ret) return ret; - dentry->length = length; inode = dentry->d_inode; /* Read more fields: some into the dentry, and some into the inode. */ inode->i_attributes = le32_to_cpu(disk_dentry->attributes); inode->i_security_id = le32_to_cpu(disk_dentry->security_id); dentry->subdir_offset = le64_to_cpu(disk_dentry->subdir_offset); - dentry->d_unused_1 = le64_to_cpu(disk_dentry->unused_1); - dentry->d_unused_2 = le64_to_cpu(disk_dentry->unused_2); inode->i_creation_time = le64_to_cpu(disk_dentry->creation_time); inode->i_last_access_time = le64_to_cpu(disk_dentry->last_access_time); inode->i_last_write_time = le64_to_cpu(disk_dentry->last_write_time); @@ -1399,15 +1337,15 @@ read_dentry(const u8 * restrict buf, size_t buf_len, * 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 - * would be unexpected. */ - calculated_size = dentry_correct_length_unaligned(file_name_nbytes, - short_name_nbytes); + * that the dentry's length is unaligned, although this would be + * unexpected. */ + calculated_size = dentry_min_len_with_names(file_name_nbytes, + short_name_nbytes); - if (unlikely(dentry->length < calculated_size)) { + if (unlikely(length < calculated_size)) { ERROR("Unexpected end of directory entry! (Expected " "at least %"PRIu64" bytes, got %"PRIu64" bytes.)", - calculated_size, dentry->length); + calculated_size, length); ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE; goto err_free_dentry; } @@ -1418,33 +1356,37 @@ read_dentry(const u8 * restrict buf, size_t buf_len, /* Read the filename if present. Note: if the filename is empty, there * is no null terminator following it. */ if (file_name_nbytes) { - dentry->file_name = MALLOC(file_name_nbytes + 2); + dentry->file_name = utf16le_dupz(p, file_name_nbytes); if (dentry->file_name == NULL) { ret = WIMLIB_ERR_NOMEM; goto err_free_dentry; } dentry->file_name_nbytes = file_name_nbytes; - memcpy(dentry->file_name, p, file_name_nbytes); - p += file_name_nbytes + 2; - dentry->file_name[file_name_nbytes / 2] = cpu_to_le16(0); + p += (u32)file_name_nbytes + 2; } /* Read the short filename if present. Note: if there is no short * filename, there is no null terminator following it. */ if (short_name_nbytes) { - dentry->short_name = MALLOC(short_name_nbytes + 2); + dentry->short_name = utf16le_dupz(p, short_name_nbytes); if (dentry->short_name == NULL) { ret = WIMLIB_ERR_NOMEM; goto err_free_dentry; } dentry->short_name_nbytes = short_name_nbytes; - memcpy(dentry->short_name, p, short_name_nbytes); - p += short_name_nbytes + 2; - dentry->short_name[short_name_nbytes / 2] = cpu_to_le16(0); + p += (u32)short_name_nbytes + 2; } + /* Read extra data at end of dentry (but before alternate data stream + * entries). This may contain tagged items. */ + ret = read_extra_data(p, &buf[offset + length], inode); + if (ret) + goto err_free_dentry; + /* Align the dentry length. */ - dentry->length = (dentry->length + 7) & ~7; + length = (length + 7) & ~7; + + offset += length; /* Read the alternate data streams, if present. inode->i_num_ads tells * us how many they are, and they will directly follow the dentry in the @@ -1454,19 +1396,22 @@ read_dentry(const u8 * restrict buf, size_t buf_len, * aligned boundary, and the alternate data stream entries seem to NOT * be included in the dentry->length field for some reason. */ if (unlikely(inode->i_num_ads != 0)) { - ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE; - if (offset + dentry->length > buf_len || - (ret = read_ads_entries(&buf[offset + dentry->length], - inode, - buf_len - offset - dentry->length))) - { - ERROR("Failed to read alternate data stream " - "entries of WIM dentry \"%"WS"\"", - dentry->file_name); + size_t orig_bytes_remaining; + size_t bytes_remaining; + + if (offset > buf_len) { + ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE; goto err_free_dentry; } + bytes_remaining = buf_len - offset; + orig_bytes_remaining = bytes_remaining; + ret = read_ads_entries(&buf[offset], inode, &bytes_remaining); + if (ret) + goto err_free_dentry; + offset += (orig_bytes_remaining - bytes_remaining); } + *offset_p = offset; /* Sets offset of next dentry in directory */ *dentry_ret = dentry; return 0; @@ -1475,18 +1420,7 @@ err_free_dentry: return ret; } -static const tchar * -dentry_get_file_type_string(const struct wim_dentry *dentry) -{ - const struct wim_inode *inode = dentry->d_inode; - if (inode_is_directory(inode)) - return T("directory"); - else if (inode_is_symlink(inode)) - return T("symbolic link"); - else - return T("file"); -} - +/* Is the dentry named "." or ".." ? */ static bool dentry_is_dot_or_dotdot(const struct wim_dentry *dentry) { @@ -1511,8 +1445,8 @@ read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len, /* Check for cyclic directory structure, which would cause infinite * recursion if not handled. */ - for (struct wim_dentry *d = dir->parent; - !dentry_is_root(d); d = d->parent) + for (struct wim_dentry *d = dir->d_parent; + !dentry_is_root(d); d = d->d_parent) { if (unlikely(d->subdir_offset == cur_offset)) { ERROR("Cyclic directory structure detected: children " @@ -1528,7 +1462,7 @@ read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len, int ret; /* Read next child of @dir. */ - ret = read_dentry(buf, buf_len, cur_offset, &child); + ret = read_dentry(buf, buf_len, &cur_offset, &child); if (ret) return ret; @@ -1536,13 +1470,6 @@ read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len, if (child == NULL) return 0; - /* Advance to the offset of the next child. Note: We need to - * advance by the TOTAL length of the dentry, not by the length - * child->length, which although it does take into account the - * padding, it DOES NOT take into account alternate stream - * entries. */ - cur_offset += dentry_in_total_length(child); - /* All dentries except the root should be named. */ if (unlikely(!dentry_has_long_name(child))) { WARNING("Ignoring unnamed dentry in " @@ -1565,14 +1492,10 @@ read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len, /* We already found a dentry with this same * case-sensitive long name. Only keep the first one. */ - const tchar *child_type, *duplicate_type; - child_type = dentry_get_file_type_string(child); - duplicate_type = dentry_get_file_type_string(duplicate); - WARNING("Ignoring duplicate %"TS" \"%"TS"\" " - "(the WIM image already contains a %"TS" " + WARNING("Ignoring duplicate file \"%"TS"\" " + "(the WIM image already contains a file " "at that path with the exact same name)", - child_type, dentry_full_path(duplicate), - duplicate_type); + dentry_full_path(duplicate)); free_dentry(child); continue; } @@ -1596,7 +1519,7 @@ read_dentry_tree_recursive(const u8 * restrict buf, size_t buf_len, } /* - * Read a tree of dentries (directory entries) from a WIM metadata resource. + * Read a tree of dentries from a WIM metadata resource. * * @buf: * Buffer containing an uncompressed WIM metadata resource. @@ -1626,7 +1549,7 @@ read_dentry_tree(const u8 *buf, size_t buf_len, DEBUG("Reading dentry tree (root_offset=%"PRIu64")", root_offset); - ret = read_dentry(buf, buf_len, root_offset, &root); + ret = read_dentry(buf, buf_len, &root_offset, &root); if (ret) return ret; @@ -1636,12 +1559,7 @@ read_dentry_tree(const u8 *buf, size_t buf_len, { WARNING("The root directory has a nonempty name; " "removing it."); - FREE(root->file_name); - FREE(root->short_name); - root->file_name = NULL; - root->short_name = NULL; - root->file_name_nbytes = 0; - root->short_name_nbytes = 0; + dentry_set_name(root, NULL); } if (unlikely(!dentry_is_directory(root))) { @@ -1668,11 +1586,17 @@ err_free_dentry_tree: } /* - * Writes a WIM alternate data stream (ADS) entry to an output buffer. + * Write a WIM alternate data stream (ADS) entry to an output buffer. + * + * @ads_entry: + * The ADS entry to write. * - * @ads_entry: The ADS entry structure. - * @hash: The hash field to use (instead of the one in the ADS entry). - * @p: The memory location to write the data to. + * @hash: + * The hash field to use (instead of the one stored directly in the ADS + * entry, which isn't valid if the inode has been "resolved"). + * + * @p: + * The memory location to which to write the data. * * Returns a pointer to the byte after the last byte written. */ @@ -1690,7 +1614,7 @@ write_ads_entry(const struct wim_ads_entry *ads_entry, p += sizeof(struct wim_ads_entry_on_disk); if (ads_entry->stream_name_nbytes) { p = mempcpy(p, ads_entry->stream_name, - ads_entry->stream_name_nbytes + 2); + (u32)ads_entry->stream_name_nbytes + 2); } /* Align to 8-byte boundary */ while ((uintptr_t)p & 7) @@ -1700,13 +1624,18 @@ write_ads_entry(const struct wim_ads_entry *ads_entry, } /* - * Writes a WIM dentry to an output buffer. + * Write a WIM dentry to an output buffer. + * + * This includes any alternate data stream entries that may follow the dentry + * itself. + * + * @dentry: + * The dentry to write. * - * @dentry: The dentry structure. - * @p: The memory location to write the data to. + * @p: + * The memory location to which to write the data. * - * Returns the pointer to the byte after the last byte we wrote as part of the - * dentry, including any alternate data stream entries. + * Returns a pointer to the byte following the last written. */ static u8 * write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p) @@ -1728,8 +1657,10 @@ write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p) disk_dentry->attributes = cpu_to_le32(inode->i_attributes); disk_dentry->security_id = cpu_to_le32(inode->i_security_id); disk_dentry->subdir_offset = cpu_to_le64(dentry->subdir_offset); - disk_dentry->unused_1 = cpu_to_le64(dentry->d_unused_1); - disk_dentry->unused_2 = cpu_to_le64(dentry->d_unused_2); + + disk_dentry->unused_1 = cpu_to_le64(0); + disk_dentry->unused_2 = cpu_to_le64(0); + disk_dentry->creation_time = cpu_to_le64(inode->i_creation_time); disk_dentry->last_access_time = cpu_to_le64(inode->i_last_access_time); disk_dentry->last_write_time = cpu_to_le64(inode->i_last_write_time); @@ -1759,20 +1690,22 @@ write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p) wimlib_assert(dentry_is_root(dentry) != dentry_has_long_name(dentry)); if (dentry_has_long_name(dentry)) - p = mempcpy(p, dentry->file_name, dentry->file_name_nbytes + 2); + p = mempcpy(p, dentry->file_name, (u32)dentry->file_name_nbytes + 2); if (dentry_has_short_name(dentry)) - p = mempcpy(p, dentry->short_name, dentry->short_name_nbytes + 2); + p = mempcpy(p, dentry->short_name, (u32)dentry->short_name_nbytes + 2); /* Align to 8-byte boundary */ while ((uintptr_t)p & 7) *p++ = 0; - /* We calculate the correct length of the dentry ourselves because the - * dentry->length field may been set to an unexpected value from when we - * read the dentry in (for example, there may have been unknown data - * appended to the end of the dentry...). Furthermore, the dentry may - * have been renamed, thus changing its needed length. */ + if (inode->i_extra_size) { + /* Extra tagged items --- not usually present. */ + p = mempcpy(p, inode->i_extra, inode->i_extra_size); + while ((uintptr_t)p & 7) + *p++ = 0; + } + disk_dentry->length = cpu_to_le64(p - orig_p); if (use_dummy_stream) { @@ -1790,72 +1723,53 @@ write_dentry(const struct wim_dentry * restrict dentry, u8 * restrict p) } static int -write_dentry_cb(struct wim_dentry *dentry, void *_p) +write_dir_dentries(struct wim_dentry *dir, void *_pp) { - u8 **p = _p; - *p = write_dentry(dentry, *p); - return 0; -} + if (dir->subdir_offset != 0) { + u8 **pp = _pp; + u8 *p = *pp; + struct wim_dentry *child; -static u8 * -write_dentry_tree_recursive(const struct wim_dentry *parent, u8 *p); + /* write child dentries */ + for_dentry_child(child, dir) + p = write_dentry(child, p); -static int -write_dentry_tree_recursive_cb(struct wim_dentry *dentry, void *_p) -{ - u8 **p = _p; - *p = write_dentry_tree_recursive(dentry, *p); + /* write end of directory entry */ + *(u64*)p = 0; + p += 8; + *pp = 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 wim_dentry *parent, u8 *p) -{ - /* Nothing to do if this dentry has no children. */ - if (parent->subdir_offset == 0) - return p; - - /* 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! */ - for_dentry_child(parent, write_dentry_cb, &p); - - /* write end of directory entry */ - *(le64*)p = cpu_to_le64(0); - p += 8; - - /* Recurse on children. */ - for_dentry_child(parent, write_dentry_tree_recursive_cb, &p); - return p; -} - -/* Writes a directory tree to the metadata resource. +/* + * Write a directory tree to the metadata resource. * - * @root: Root of the dentry tree. - * @p: Pointer to a buffer with enough space for the dentry tree. + * @root: + * The root of a dentry tree on which calculate_subdir_offsets() has been + * called. This cannot be NULL; if the dentry tree is empty, the caller is + * expected to first generate a dummy root directory. * - * Returns pointer to the byte after the last byte we wrote. + * @p: + * Pointer to a buffer with enough space for the dentry tree. This size + * must have been obtained by calculate_subdir_offsets(). + * + * Returns a pointer to the byte following the last written. */ u8 * -write_dentry_tree(const struct wim_dentry * restrict root, u8 * restrict p) +write_dentry_tree(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 - * wrote us, so we need to write ourselves. */ - p = write_dentry(root, p); + wimlib_assert(root != NULL); - /* Write end of directory entry after the root dentry just to be safe; - * however the root dentry obviously cannot have any siblings. */ - *(le64*)p = cpu_to_le64(0); + /* write root dentry and end-of-directory entry following it */ + p = write_dentry(root, p); + *(u64*)p = 0; p += 8; - /* Recursively write the rest of the dentry tree. */ - return write_dentry_tree_recursive(root, p); + /* write the rest of the dentry tree */ + for_dentry_in_tree(root, write_dir_dentries, &p); + + return p; }