#ifndef _WIMLIB_DENTRY_H
#define _WIMLIB_DENTRY_H
+#include "wimlib/avl_tree.h"
#include "wimlib/case.h"
#include "wimlib/compiler.h"
#include "wimlib/inode.h"
#include "wimlib/list.h"
-#include "wimlib/rbtree.h"
#include "wimlib/types.h"
struct wim_inode;
-struct wim_lookup_table;
-struct wim_lookup_table_entry;
-struct wim_security_data;
+struct blob_table;
/* Base size of a WIM dentry in the on-disk format, up to and including the file
* name length. This does not include the variable-length file name, short
- * name, alternate data stream entries, and padding to 8-byte boundaries. */
+ * name, extra stream entries, and padding to 8-byte boundaries. */
#define WIM_DENTRY_DISK_SIZE 102
/*
* tree for each image in the WIM.
*
* Note that this is a directory entry and not an inode. Since NTFS allows hard
- * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
- * The hard link group ID field of the on-disk WIM dentry tells us the number of
- * the NTFS inode that the dentry corresponds to (and this gets placed in
- * d_inode->i_ino).
+ * links, it's possible for an NTFS inode to correspond to multiple WIM
+ * dentries. The hard link group ID field of the on-disk WIM dentry tells us
+ * the number of the NTFS inode that the dentry corresponds to (and this gets
+ * placed in d_inode->i_ino).
*
* Unfortunately, WIM files do not have an analogue to an inode; instead certain
- * information, such as file attributes, the security descriptor, and file
- * streams is replicated in each hard-linked dentry, even though this
- * information really is associated with an inode. In-memory, we fix up this
- * flaw by allocating a `struct wim_inode' for each dentry that contains some of
- * this duplicated information, then combining the inodes for each hard link
- * group together.
- *
- * Confusingly, it's possible for stream information to be missing from a dentry
- * in a hard link set, in which case the stream information needs to be gotten
- * from one of the other dentries in the hard link set. In addition, it is
- * possible for dentries to have inconsistent security IDs, file attributes, or
- * file streams when they share the same hard link ID (don't even ask. I hope
- * that Microsoft may have fixed this problem, since I've only noticed it in the
- * 'install.wim' for Windows 7). For those dentries, we have to use the
- * conflicting fields to split up the hard link groups. (See
- * dentry_tree_fix_inodes() in inode_fixup.c.)
+ * information, such as file attributes, the security descriptor, and streams is
+ * replicated in each hard-linked dentry, even though this information really is
+ * associated with an inode. In-memory, we fix up this flaw by allocating a
+ * `struct wim_inode' for each dentry that contains some of this duplicated
+ * information, then combining the inodes for each hard link group together.
+ * (See dentry_tree_fix_inodes().)
*/
struct wim_dentry {
/* Pointer to the inode for this dentry. This will contain some
* to all dentries in a hard link group. */
struct wim_inode *d_inode;
- /* Node for the parent's red-black tree of child dentries, sorted by
- * case sensitive long name. */
- struct rb_node rb_node;
+ /* Node for the parent's balanced binary search tree of child dentries
+ * sorted by case sensitive long name (root i_children). */
+ struct avl_tree_node d_index_node;
- /* Node for the parent's red-black tree of child dentries, sorted by
- * case insensitive long name. */
- struct rb_node rb_node_case_insensitive;
+ /* Node for the parent's balanced binary search tree of child dentries,
+ * sorted by case insensitive long name (root i_children_ci). */
+ struct avl_tree_node d_index_node_ci;
/* List of dentries in a directory that have different case sensitive
- * long names but share the same case insensitive long name */
- struct list_head case_insensitive_conflict_list;
+ * long names but share the same case insensitive long name. */
+ struct list_head d_ci_conflict_list;
- /* Length of UTF-16LE encoded short filename, in bytes, not including
- * the terminating zero wide-character. */
- u16 short_name_nbytes;
+ /* The parent of this directory entry. (The root is its own parent.) */
+ struct wim_dentry *d_parent;
- /* Length of UTF-16LE encoded "long" file name, in bytes, not including
- * the terminating null character. */
- u16 file_name_nbytes;
+ /* Linked list node that places this dentry in the list of aliases for
+ * its inode (d_inode) */
+ struct hlist_node d_alias_node;
- /* Length of full path name encoded using "tchars", in bytes, not
- * including the terminating null character. */
- u32 full_path_nbytes;
+ /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
+ * dentry has no filename. */
+ utf16lechar *d_name;
- /* For extraction operations, this flag will be set on dentries in the
- * tree being extracted. Otherwise this will always be 0. */
- u8 in_extraction_tree : 1;
+ /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
+ * if this dentry has no short name. */
+ utf16lechar *d_short_name;
- /* For extraction operations, this flag will be set when a dentry in the
- * tree being extracted is not being extracted for some reason (file
- * type not supported by target filesystem, contains invalid characters,
- * or not in one of the multiple sub-trees being extracted). Otherwise
- * this will always be 0. */
- u8 extraction_skipped : 1;
+ /* Length of 'd_name' in bytes, excluding the terminating null */
+ u16 d_name_nbytes;
- /* During extraction extractions, this flag will be set after the
- * "skeleton" of the dentry has been extracted. */
- u8 skeleton_extracted : 1;
+ /* Length of 'd_short_name' in bytes, excluding the terminating null */
+ u16 d_short_name_nbytes;
- /* When capturing from a NTFS volume using NTFS-3g, this flag is set on
+ /* When capturing from an NTFS volume using NTFS-3g, this flag is set on
* dentries that were created from a filename in the WIN32 or WIN32+DOS
* namespaces rather than the POSIX namespace. Otherwise this will
* always be 0. */
- u8 is_win32_name : 1;
-
- u8 tmp_flag : 1;
-
- u8 was_hardlinked : 1;
-
- /* Temporary list field used to make lists of dentries in a few places.
- * */
- struct list_head tmp_list;
-
- /* Linked list node that places this dentry in the list of aliases for
- * its inode (d_inode) */
- struct list_head d_alias;
+ u8 d_is_win32_name : 1;
- /* The parent of this directory entry. */
- struct wim_dentry *parent;
+ /* Temporary flag; always reset to 0 when done using. */
+ u8 d_tmp_flag : 1;
- /* 'length' and 'subdir_offset' are only used while reading and writing
- * this dentry; see the corresponding field in
- * `struct wim_dentry_on_disk' for explanation. */
- u64 length;
- u64 subdir_offset;
+ /* Used by wimlib_update_image() */
+ u8 d_is_orphan : 1;
- /* These correspond to the two unused fields in the on-disk WIM dentry;
- * we read them into memory so we can write them unchanged. These
- * fields are set to 0 on new dentries. */
- u64 d_unused_1;
- u64 d_unused_2;
+ union {
+ /* The subdir offset is only used while reading and writing this
+ * dentry. See the corresponding field in `struct
+ * wim_dentry_on_disk' for explanation. */
+ u64 d_subdir_offset;
- /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
- * if this dentry has no short name. */
- utf16lechar *short_name;
-
- /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
- * dentry has no filename. */
- utf16lechar *file_name;
+ /* Temporary list field */
+ struct list_head d_tmp_list;
+ };
/* Full path to this dentry in the WIM, in platform-dependent tchars
* that can be printed without conversion. By default this field will
* be NULL and will only be calculated on-demand by the
* calculate_dentry_full_path() or dentry_full_path() functions. */
- tchar *_full_path;
-
- /* (Extraction only) Actual name to extract this dentry as, along with
- * its length in tchars excluding the NULL terminator. This usually
- * will be the same as file_name, with the character encoding converted
- * if needed. But if file_name contains characters not accepted on the
- * current platform, then this may be set slightly differently from
- * file_name. This will be either NULL or a malloc()ed buffer that may
- * alias file_name. */
- tchar *extraction_name;
- size_t extraction_name_nchars;
-};
+ tchar *d_full_path;
+
+ /* (Extraction only) Actual name to extract this dentry as. This may be
+ * either in 'tchars' or in 'utf16lechars', depending on what encoding
+ * the extraction backend needs. This may alias 'd_name'. If it
+ * doesn't, it is an allocated buffer which must be freed. */
+ void *d_extraction_name;
-#define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
+ /* (Extraction only) Number of characters in d_extraction_name. */
+ size_t d_extraction_name_nchars;
+
+ /* (Extraction only) Linked list node that connects all dentries being
+ * extracted as part of the current extraction operation. */
+ struct list_head d_extraction_list_node;
+
+ /* (Extraction only) Pointer to the next alias for this dentry's inode
+ * that needs to be extracted as part of the current extraction
+ * operation, or NULL if this is the last alias. */
+ struct wim_dentry *d_next_extraction_alias;
+};
static inline bool
-dentry_is_first_in_inode(const struct wim_dentry *dentry)
+will_extract_dentry(const struct wim_dentry *dentry)
{
- return inode_first_dentry(dentry->d_inode) == dentry;
+ return dentry->d_extraction_list_node.next != NULL;
}
-extern u64
+extern size_t
dentry_out_total_length(const struct wim_dentry *dentry);
extern int
int (*visitor)(struct wim_dentry*, void*),
void *args);
-extern int
-for_dentry_in_rbtree(struct rb_node *node,
- int (*visitor)(struct wim_dentry *, void *),
- void *arg);
-
-extern int
-for_dentry_child(const struct wim_dentry *dentry,
- int (*visitor)(struct wim_dentry *, void *),
- void *arg);
-
-extern int
-for_dentry_in_tree_depth(struct wim_dentry *root,
- int (*visitor)(struct wim_dentry*, void*),
- void *args);
+/* Iterate through each @child dentry of the @dir directory inode,
+ * in sorted order by case sensitive name. */
+#define for_inode_child(child, dir) \
+ avl_tree_for_each_in_order((child), (dir)->i_children, \
+ struct wim_dentry, d_index_node)
+
+/* Iterate through each @child dentry of the @parent dentry,
+ * in sorted order by case sensitive name. */
+#define for_dentry_child(child, parent) \
+ for_inode_child((child), (parent)->d_inode)
+
+/* Iterate through each @child dentry of the @dir directory inode,
+ * in sorted order by case insensitive name. */
+#define for_inode_child_case_insensitive(child, dir) \
+ avl_tree_for_each_in_order((child), (dir)->i_children_ci, \
+ struct wim_dentry, d_index_node_ci)
+
+/* Iterate through each @child dentry of the @parent dentry,
+ * in sorted order by case insensitive name. */
+#define for_dentry_child_case_insensitive(child, parent) \
+ for_inode_child_case_insensitive((child), (parent)->d_inode)
+
+/* Iterate through each @child dentry of the @dir directory inode,
+ * in postorder (safe for freeing the child dentries). */
+#define for_inode_child_postorder(child, dir) \
+ avl_tree_for_each_in_postorder((child), (dir)->i_children, \
+ struct wim_dentry, d_index_node)
+
+/* Iterate through each @child dentry of the @parent dentry,
+ * in postorder (safe for freeing the child dentries). */
+#define for_dentry_child_postorder(child, parent) \
+ for_inode_child_postorder((child), (parent)->d_inode)
+
+/* Get any child dentry of the @dir directory inode. Requires
+ * inode_has_children(@dir) == true. */
+#define inode_any_child(dir) \
+ avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
+
+/* Get any child dentry of the @parent dentry. Requires
+ * dentry_has_children(@parent) == true. */
+#define dentry_any_child(parent) \
+ inode_any_child((parent)->d_inode)
extern void
-calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
+calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
extern int
dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
+extern int
+dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name,
+ size_t new_name_nbytes);
+
extern struct wim_dentry *
get_dentry(struct WIMStruct *wim, const tchar *path,
CASE_SENSITIVITY_TYPE case_type);
get_parent_dentry(struct WIMStruct *wim, const tchar *path,
CASE_SENSITIVITY_TYPE case_type);
-#ifdef WITH_FUSE
-
-#define LOOKUP_FLAG_ADS_OK 0x00000001
-#define LOOKUP_FLAG_DIRECTORY_OK 0x00000002
-
-extern 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);
-#endif
-
-extern int
-print_dentry(struct wim_dentry *dentry, void *lookup_table);
-
-extern int
-print_dentry_full_path(struct wim_dentry *entry, void *ignore);
-
extern int
calculate_dentry_full_path(struct wim_dentry *dentry);
-extern int
-calculate_dentry_tree_full_paths(struct wim_dentry *root);
-
extern tchar *
dentry_full_path(struct wim_dentry *dentry);
extern int
-new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
-
-extern int
-new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
+new_dentry_with_new_inode(const tchar *name, bool set_timestamps,
+ struct wim_dentry **dentry_ret);
extern int
-new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
+new_dentry_with_existing_inode(const tchar *name, struct wim_inode *inode,
+ struct wim_dentry **dentry_ret);
extern void
dentry_tree_clear_inode_visited(struct wim_dentry *root);
extern int
-new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
+new_filler_directory(struct wim_dentry **dentry_ret);
extern void
free_dentry(struct wim_dentry *dentry);
-extern void
-put_dentry(struct wim_dentry *dentry);
-
extern void
free_dentry_tree(struct wim_dentry *root,
- struct wim_lookup_table *lookup_table);
+ struct blob_table *blob_table);
extern void
unlink_dentry(struct wim_dentry *dentry);
extern 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 update_command_journal;
extern int
rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
- CASE_SENSITIVITY_TYPE case_type);
+ CASE_SENSITIVITY_TYPE case_type,
+ struct update_command_journal *j);
extern int
u64 root_offset, struct wim_dentry **root_ret);
extern u8 *
-write_dentry_tree(const struct wim_dentry * restrict tree,
- u8 * restrict p);
+write_dentry_tree(struct wim_dentry *root, u8 *p);
static inline bool
dentry_is_root(const struct wim_dentry *dentry)
{
- return dentry->parent == dentry;
+ return dentry->d_parent == dentry;
}
static inline bool
}
static inline bool
-dentry_has_short_name(const struct wim_dentry *dentry)
+dentry_has_long_name(const struct wim_dentry *dentry)
{
- return dentry->short_name_nbytes != 0;
+ return dentry->d_name_nbytes != 0;
}
static inline bool
-dentry_has_long_name(const struct wim_dentry *dentry)
+dentry_has_short_name(const struct wim_dentry *dentry)
{
- return dentry->file_name_nbytes != 0;
+ return dentry->d_short_name_nbytes != 0;
}
-
-extern int
-dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
#endif /* _WIMLIB_DENTRY_H */
git://wimlib.net / wimlib / blobdiff