X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fdentry.h;h=3c59f128f675f514bbc001af148e1c6bc1430acb;hp=cb534453abc1b8332dd27f887ee9e47eef48009e;hb=9fb3aaca115429b0af2a623bf20bfceef74f047f;hpb=140c0920af14b19292e8b7694bb91864c8f52f3c diff --git a/src/dentry.h b/src/dentry.h index cb534453..3c59f128 100644 --- a/src/dentry.h +++ b/src/dentry.h @@ -5,25 +5,30 @@ #include "config.h" #include "list.h" #include "sha1.h" +#include "rbtree.h" #include +#ifdef WITH_FUSE +#include +#endif + struct stat; -struct lookup_table; +struct wim_lookup_table; struct WIMStruct; -struct lookup_table_entry; -struct wimlib_fd; -struct inode; -struct dentry; +struct wim_lookup_table_entry; +struct wimfs_fd; +struct wim_inode; +struct wim_dentry; -/* Size of the struct dentry up to and including the file_name_len. */ +/* Size of the struct wim_dentry up to and including the file_name_len. */ #define WIM_DENTRY_DISK_SIZE 102 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and * including the stream length field (see below). */ #define WIM_ADS_ENTRY_DISK_SIZE 38 -/* - * Reparse tags documented at +/* + * Reparse tags documented at * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx */ #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000 @@ -59,58 +64,55 @@ struct dentry; * * We read this from disk in the read_ads_entries() function; see that function * for more explanation. */ -struct ads_entry { +struct wim_ads_entry { union { /* SHA-1 message digest of stream contents */ u8 hash[SHA1_HASH_SIZE]; /* The corresponding lookup table entry (only for resolved * streams) */ - struct lookup_table_entry *lte; + struct wim_lookup_table_entry *lte; }; - /* Length of stream name (UTF-16). This is in bytes, not characters, - * and does not include the terminating null character */ - u16 stream_name_len; - - /* Length of stream name (UTF-8) */ - u16 stream_name_utf8_len; + /* Length of UTF16-encoded stream name, in bytes, not including the + * terminating null character. */ + u16 stream_name_nbytes; - /* Stream name (UTF-16) */ - char *stream_name; - - /* Stream name (UTF-8) */ - char *stream_name_utf8; + /* Stream name (UTF-16LE) */ + utf16lechar *stream_name; #ifdef WITH_FUSE + /* Number to identify an alternate data stream even after it's possibly + * been moved or renamed. */ u32 stream_id; #endif }; -static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1, - const struct ads_entry *entry_2) +static inline bool +ads_entries_have_same_name(const struct wim_ads_entry *entry_1, + const struct wim_ads_entry *entry_2) { - if (entry_1->stream_name_len != entry_2->stream_name_len) - return false; - return memcmp(entry_1->stream_name, entry_2->stream_name, - entry_1->stream_name_len) == 0; + return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes && + memcmp(entry_1->stream_name, entry_2->stream_name, + entry_1->stream_name_nbytes) == 0; } -/* +/* * In-memory structure for a WIM directory entry (dentry). There is a directory - * tree for each image in the WIM. + * 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 field on the on-disk WIM dentry tells us the number of the NTFS - * inode that the dentry corresponds to. + * 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 inode' for each dentry that contains some of + * 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. * @@ -121,21 +123,42 @@ static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1, * 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 fix_inodes() in - * hardlink.c). + * conflicting fields to split up the hard link groups. (See + * dentry_tree_fix_inodes() in hardlink.c). */ -struct dentry { +struct wim_dentry { /* The inode for this dentry */ - struct inode *d_inode; + struct wim_inode *d_inode; - /* The parent of this directory entry. */ - struct dentry *parent; + /* Red-black tree of sibling dentries */ + struct rb_node rb_node; + + /* Length of UTF-16LE encoded short filename, in bytes, not including + * the terminating zero wide-character. */ + u16 short_name_nbytes; - /* Linked list of sibling directory entries. */ - struct dentry *next; - struct dentry *prev; + /* Length of UTF-16LE encoded "long" file name, in bytes, not including + * the terminating null character. */ + u16 file_name_nbytes; - /* + /* Length of full path name, in bytes, as a multibyte-encoded string */ + u32 full_path_nbytes; + + u8 is_extracted : 1; + + /* Only used during NTFS capture */ + u8 is_win32_name : 1; + + /* Temporary list */ + struct list_head tmp_list; + + /* List of dentries in the inode (hard link set) */ + struct list_head d_alias; + + /* The parent of this directory entry. */ + struct wim_dentry *parent; + + /* * Size of directory entry on disk, in bytes. Typical size is around * 104 to 120 bytes. * @@ -161,78 +184,59 @@ struct dentry { * points. */ u64 subdir_offset; - /* Length of short filename, in bytes, not including the terminating - * zero wide-character. */ - u16 short_name_len; - - /* Length of file name, in bytes, not including the terminating zero - * wide-character. */ - u16 file_name_len; - - /* Length of the filename converted into UTF-8, in bytes, not including - * the terminating zero byte. */ - u16 file_name_utf8_len; - - /* Pointer to the short filename (malloc()ed buffer) */ - char *short_name; - - /* Pointer to the filename (malloc()ed buffer). */ - char *file_name; - - /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */ - char *file_name_utf8; - - /* Full path to this dentry (malloc()ed buffer). */ - char *full_path_utf8; - u32 full_path_utf8_len; - /* Number of references to the dentry tree itself, as in multiple * WIMStructs */ u32 refcnt; - /* List of dentries in the inode (hard link set) */ - struct list_head inode_dentry_list; + /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */ + utf16lechar *short_name; - union { - struct list_head tmp_list; - bool is_extracted; - }; + /* Pointer to the UTF-16LE filename (malloc()ed buffer). */ + utf16lechar *file_name; + + /* Full path of this dentry */ + mbchar *full_path; }; +#define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node) + /* * WIM inode. * * As mentioned above, in the WIM file that is no on-disk analogue of a real * inode, as most of these fields are duplicated in the dentries. */ -struct inode { +struct wim_inode { /* Timestamps for the inode. The timestamps are the number of * 100-nanosecond intervals that have elapsed since 12:00 A.M., January * 1st, 1601, UTC. This is the same format used in NTFS inodes. */ - u64 creation_time; - u64 last_access_time; - u64 last_write_time; + u64 i_creation_time; + u64 i_last_access_time; + u64 i_last_write_time; /* The file attributes associated with this inode. This is a bitwise OR * of the FILE_ATTRIBUTE_* flags. */ - u32 attributes; + u32 i_attributes; /* The index of the security descriptor in the WIM image's table of * security descriptors that contains this file's security information. * If -1, no security information exists for this file. */ - int32_t security_id; + int32_t i_security_id; /* %true iff the inode's lookup table entries has been resolved (i.e. - * the @lte field is valid, but the @hash field is not valid) + * the @lte field is valid, but the @hash field is not valid) * * (This is not an on-disk field.) */ - u8 resolved : 1; + u8 i_resolved : 1; - /* %true iff verify_inode() has run on this dentry. */ - u8 verified : 1; + /* %true iff verify_inode() has run on this inode. */ + u8 i_verified : 1; + + /* Used only in NTFS-mode extraction */ + u8 i_dos_name_extracted : 1; /* Number of alternate data streams associated with this inode */ - u16 num_ads; + u16 i_num_ads; /* A hash of the file's contents, or a pointer to the lookup table entry * for this dentry if the lookup table entries have been resolved. @@ -241,186 +245,298 @@ struct inode { * opposed to the alternate (named) file streams, which may have their * own lookup table entries. */ union { - u8 hash[SHA1_HASH_SIZE]; - struct lookup_table_entry *lte; + u8 i_hash[SHA1_HASH_SIZE]; + struct wim_lookup_table_entry *i_lte; }; /* Identity of a reparse point. See * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx * for what a reparse point is. */ - u32 reparse_tag; + u32 i_reparse_tag; /* Number of dentries that reference this inode */ - u32 link_count; + u32 i_nlink; /* Alternate data stream entries. */ - struct ads_entry *ads_entries; + struct wim_ads_entry *i_ads_entries; /* Inode number */ - u64 ino; + u64 i_ino; /* List of dentries that reference this inode (there should be * link_count of them) */ - struct list_head dentry_list; - struct hlist_node hlist; - char *extracted_file; + struct list_head i_dentry; + + struct hlist_node i_hlist; + + struct list_head i_lte_inode_list; + +#ifdef __WIN32__ + utf16lechar *i_extracted_file; +#else + mbchar *i_extracted_file; +#endif - /* If non-NULL, the children of this inode (implies the inode is a - * directory) */ - struct dentry *children; + /* Root of a red-black tree storing the children of this inode (if + * non-empty, implies the inode is a directory, although that is also + * noted in the @attributes field.) */ + struct rb_root i_children; #ifdef WITH_FUSE /* wimfs file descriptors table for the inode */ - u16 num_opened_fds; - u16 num_allocated_fds; - struct wimlib_fd **fds; + u16 i_num_opened_fds; + u16 i_num_allocated_fds; + struct wimfs_fd **i_fds; /* Next alternate data stream ID to be assigned */ - u32 next_stream_id; + u32 i_next_stream_id; + + /* This mutex protects the inode's file descriptors table during + * read-only mounts. Read-write mounts are still restricted to 1 + * thread. */ + pthread_mutex_t i_mutex; #endif }; #define inode_for_each_dentry(dentry, inode) \ - list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list) + list_for_each_entry((dentry), &(inode)->i_dentry, d_alias) #define inode_add_dentry(dentry, inode) \ - ({ \ - wimlib_assert((inode)->dentry_list.next != NULL); \ - list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list); \ - }) + list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry) + +#define inode_first_dentry(inode) \ + container_of(inode->i_dentry.next, struct wim_dentry, d_alias) -static inline bool dentry_is_extracted(const struct dentry *dentry) +static inline bool +dentry_is_first_in_inode(const struct wim_dentry *dentry) { - return dentry->is_extracted; + return inode_first_dentry(dentry->d_inode) == dentry; } +extern u64 +dentry_correct_total_length(const struct wim_dentry *dentry); + +extern int +for_dentry_in_tree(struct wim_dentry *root, + 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); + +static inline 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); +} + +extern int +for_dentry_in_tree_depth(struct wim_dentry *root, + int (*visitor)(struct wim_dentry*, void*), + void *args); + +extern int +calculate_dentry_full_path(struct wim_dentry *dentry, void *ignore); + +extern void +calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p); + +extern int +set_dentry_name(struct wim_dentry *dentry, const mbchar *new_name); + +extern struct wim_dentry * +get_dentry(struct WIMStruct *w, const mbchar *path); + +extern struct wim_inode * +wim_pathname_to_inode(struct WIMStruct *w, const mbchar *path); + +extern struct wim_dentry * +get_dentry_child_with_name(const struct wim_dentry *dentry, + const mbchar *name); + +extern struct wim_dentry * +get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry, + const utf16lechar *name, + size_t name_nbytes); + +extern struct wim_dentry * +get_parent_dentry(struct WIMStruct *w, const mbchar *path); + +extern int +print_dentry(struct wim_dentry *dentry, void *lookup_table); + +extern int +print_dentry_full_path(struct wim_dentry *entry, void *ignore); -extern u64 dentry_correct_total_length(const struct dentry *dentry); +extern int +new_dentry(const mbchar *name, struct wim_dentry **dentry_ret); -extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode); -extern int inode_to_stbuf(const struct inode *inode, - struct lookup_table_entry *lte, struct stat *stbuf); +extern int +new_dentry_with_inode(const mbchar *name, struct wim_dentry **dentry_ret); -extern int for_dentry_in_tree(struct dentry *root, - int (*visitor)(struct dentry*, void*), - void *args); +extern int +new_dentry_with_timeless_inode(const mbchar *name, struct wim_dentry **dentry_ret); -extern int for_dentry_in_tree_depth(struct dentry *root, - int (*visitor)(struct dentry*, void*), - void *args); +extern void +free_inode(struct wim_inode *inode); -extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore); -extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p); -extern int get_names(char **name_utf16_ret, char **name_utf8_ret, - u16 *name_utf16_len_ret, u16 *name_utf8_len_ret, - const char *name); +extern void +free_dentry(struct wim_dentry *dentry); -extern struct dentry *get_dentry(struct WIMStruct *w, const char *path); -extern struct inode *wim_pathname_to_inode(struct WIMStruct *w, - const char *path); -extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry, - const char *name); -extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path); +extern void +put_dentry(struct wim_dentry *dentry); -extern int print_dentry(struct dentry *dentry, void *lookup_table); -extern int print_dentry_full_path(struct dentry *entry, void *ignore); +extern void +free_dentry_tree(struct wim_dentry *root, + struct wim_lookup_table *lookup_table); -extern struct dentry *new_dentry(const char *name); -extern struct dentry *new_dentry_with_inode(const char *name); -extern struct dentry *new_dentry_with_timeless_inode(const char *name); +extern int +increment_dentry_refcnt(struct wim_dentry *dentry, void *ignore); -extern void free_inode(struct inode *inode); -extern void free_dentry(struct dentry *dentry); -extern void put_dentry(struct dentry *dentry); +extern void +unlink_dentry(struct wim_dentry *dentry); -extern void free_dentry_tree(struct dentry *root, - struct lookup_table *lookup_table); -extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore); +extern bool +dentry_add_child(struct wim_dentry * restrict parent, + struct wim_dentry * restrict child); -extern void unlink_dentry(struct dentry *dentry); -extern void link_dentry(struct dentry *dentry, struct dentry *parent); +extern struct wim_ads_entry * +inode_get_ads_entry(struct wim_inode *inode, const mbchar *stream_name, + u16 *idx_ret); -extern 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); +extern struct wim_ads_entry * +inode_add_ads_utf16le(struct wim_inode *inode, + const utf16lechar *stream_name, + size_t stream_name_nbytes); -extern int verify_dentry(struct dentry *dentry, void *wim); +extern struct wim_ads_entry * +inode_add_ads(struct wim_inode *dentry, const mbchar *stream_name); +extern int +inode_add_ads_with_data(struct wim_inode *inode, const mbchar *name, + const void *value, size_t size, + struct wim_lookup_table *lookup_table); -extern struct ads_entry *inode_get_ads_entry(struct inode *inode, - const char *stream_name, - u16 *idx_ret); -extern struct ads_entry *inode_add_ads(struct inode *dentry, - const char *stream_name); +extern void +inode_remove_ads(struct wim_inode *inode, u16 idx, + struct wim_lookup_table *lookup_table); -extern void inode_remove_ads(struct inode *inode, u16 idx, - struct lookup_table *lookup_table); -extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, - u64 offset, struct dentry *dentry); +#define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data" +#define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1) +#define WIMLIB_UNIX_DATA_TAG_UTF16LE "$\0$\0_\0_\0w\0i\0m\0l\0i\0b\0_\0U\0N\0I\0X\0_\0d\0a\0t\0a\0" +#define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1) -extern int read_dentry_tree(const u8 metadata_resource[], - u64 metadata_resource_len, struct dentry *dentry); +/* Format for special alternate data stream entries to store UNIX data for files + * and directories (see: WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */ +struct wimlib_unix_data { + u16 version; /* Must be 0 */ + u16 uid; + u16 gid; + u16 mode; +} PACKED; -extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p); +#ifndef __WIN32__ -static inline bool dentry_is_root(const struct dentry *dentry) +#define NO_UNIX_DATA (-1) +#define BAD_UNIX_DATA (-2) +extern int +inode_get_unix_data(const struct wim_inode *inode, + struct wimlib_unix_data *unix_data, + u16 *stream_idx_ret); + +#define UNIX_DATA_UID 0x1 +#define UNIX_DATA_GID 0x2 +#define UNIX_DATA_MODE 0x4 +#define UNIX_DATA_ALL (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE) +#define UNIX_DATA_CREATE 0x8 +extern int +inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode, + struct wim_lookup_table *lookup_table, int which); +#endif + +extern int +read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, + u64 offset, struct wim_dentry *dentry); + + +extern int +read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len, + struct wim_dentry *dentry); + +extern u8 * +write_dentry_tree(const struct wim_dentry *tree, u8 *p); + +static inline bool +dentry_is_root(const struct wim_dentry *dentry) { return dentry->parent == dentry; } -static inline bool dentry_is_first_sibling(const struct dentry *dentry) +static inline bool +inode_is_directory(const struct wim_inode *inode) { - return dentry_is_root(dentry) || dentry->parent->d_inode->children == dentry; + return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) + && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT); } -static inline bool dentry_is_only_child(const struct dentry *dentry) +static inline bool +dentry_is_directory(const struct wim_dentry *dentry) { - return dentry->next == dentry; + return inode_is_directory(dentry->d_inode); } -static inline bool inode_is_directory(const struct inode *inode) +/* For our purposes, we consider "real" symlinks and "junction points" to both + * be symlinks. */ +static inline bool +inode_is_symlink(const struct wim_inode *inode) { - return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY) - && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT); + return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) + && ((inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) || + inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT); } -static inline bool dentry_is_directory(const struct dentry *dentry) +static inline bool +inode_is_regular_file(const struct wim_inode *inode) { - return inode_is_directory(dentry->d_inode); + return !inode_is_directory(inode) && !inode_is_symlink(inode); } -/* For our purposes, we consider "real" symlinks and "junction points" to both - * be symlinks. */ -static inline bool inode_is_symlink(const struct inode *inode) +static inline bool +dentry_is_regular_file(const struct wim_dentry *dentry) { - return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT) - && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) || - inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT); + return inode_is_regular_file(dentry->d_inode); } -static inline bool dentry_is_symlink(const struct dentry *dentry) +static inline bool +inode_has_children(const struct wim_inode *inode) { - return inode_is_symlink(dentry->d_inode); + return inode->i_children.rb_node != NULL; } -static inline bool inode_is_regular_file(const struct inode *inode) +static inline bool +dentry_has_children(const struct wim_dentry *dentry) { - return !inode_is_directory(inode) && !inode_is_symlink(inode); + return inode_has_children(dentry->d_inode); } -static inline bool dentry_is_regular_file(const struct dentry *dentry) +static inline bool +dentry_has_short_name(const struct wim_dentry *dentry) { - return inode_is_regular_file(dentry->d_inode); + return dentry->short_name_nbytes != 0; } -static inline bool dentry_is_empty_directory(const struct dentry *dentry) +static inline bool +dentry_has_long_name(const struct wim_dentry *dentry) { - return dentry_is_directory(dentry) && dentry->d_inode->children == NULL; + return dentry->file_name_nbytes != 0; } #endif