]> wimlib.net Git - wimlib/blobdiff - src/dentry.h
Fixes, comments
[wimlib] / src / dentry.h
index 0d3f89e3b0de54b4386ad7c18dfe62216d6cfc09..299abc9fba37703bc3ef5d2813d5cc17feaa27b9 100644 (file)
 #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
@@ -64,28 +64,22 @@ 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 UTF16-encoded stream name, in bytes, not including the
+        * terminating null character. */
+       u16 stream_name_nbytes;
 
-       /* Length of stream name (UTF-8) */
-       u16 stream_name_utf8_len;
-
-       /* 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
@@ -95,13 +89,13 @@ struct ads_entry {
 };
 
 
-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;
 }
 
 /*
@@ -110,14 +104,15 @@ static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
  *
  * 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.
  *
@@ -128,54 +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 {
-       /* Byte 0 */
-
+struct wim_dentry {
        /* The inode for this dentry */
-       struct inode *d_inode;
-
-       /* Byte 8 */
+       struct wim_inode *d_inode;
 
        /* Red-black tree of sibling dentries */
        struct rb_node rb_node;
 
-       /* Byte 32 */
+       /* Length of UTF-16LE encoded short filename, in bytes, not including
+        * the terminating zero wide-character. */
+       u16 short_name_nbytes;
 
-       /* Length of short filename, in bytes, not including the terminating
-        * zero wide-character. */
-       u16 short_name_len;
+       /* Length of UTF-16LE encoded "long" file name, in bytes, not including
+        * the terminating null character. */
+       u16 file_name_nbytes;
 
-       /* 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;
+       /* Length of full path name encoded using "tchars", in bytes, not
+        * including the terminating null character. */
+       u32 full_path_nbytes;
 
+       /* Has this dentry been extracted yet? */
        u8 is_extracted : 1;
-       u8 visited : 1;
-       u8 canonical : 1;
-
-       /* Byte 40 */
-
-       /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
-       char *file_name_utf8;
 
-       /* Byte 48 */
+       /* Only used during NTFS capture */
+       u8 is_win32_name : 1;
 
+       /* Temporary list */
        struct list_head tmp_list;
 
-       /* Byte 64 */
-
        /* List of dentries in the inode (hard link set)  */
-       struct list_head inode_dentry_list;
+       struct list_head d_alias;
 
        /* The parent of this directory entry. */
-       struct dentry *parent;
+       struct wim_dentry *parent;
 
        /*
         * Size of directory entry on disk, in bytes.  Typical size is around
@@ -203,23 +186,17 @@ struct dentry {
         * points. */
        u64 subdir_offset;
 
-       /* Number of references to the dentry tree itself, as in multiple
-        * WIMStructs */
-       u32 refcnt;
-
-       u32 full_path_utf8_len;
-
-       /* Pointer to the UTF-16 short filename (malloc()ed buffer) */
-       char *short_name;
+       /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */
+       utf16lechar *short_name;
 
-       /* Pointer to the UTF-16 filename (malloc()ed buffer). */
-       char *file_name;
+       /* Pointer to the UTF-16LE filename (malloc()ed buffer). */
+       utf16lechar *file_name;
 
-       /* Full path (UTF-8) to this dentry (malloc()ed buffer). */
-       char *full_path_utf8;
+       /* Full path of this dentry */
+       tchar *_full_path;
 };
 
-#define rbnode_dentry(node) container_of(node, struct dentry, rb_node)
+#define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
 
 /*
  * WIM inode.
@@ -227,37 +204,37 @@ struct dentry {
  * 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)
         *
         * (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;
 
-       /* temporary flag */
-       u8 visited    : 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.
@@ -266,47 +243,57 @@ 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 list_head i_dentry;
+
+       union {
+               struct hlist_node i_hlist;
+               struct list_head i_list;
+       };
 
-       struct hlist_node hlist;
+       union {
+               /* Used during image extraction to build a list of inodes that
+                * share a certain stream */
+               struct list_head i_lte_inode_list;
 
-       struct list_head lte_inode_list;
+               /* Device number, used only during image capture */
+               u64 i_devno;
+       };
 
-       char *extracted_file;
+       tchar *i_extracted_file;
 
        /* 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 children;
+       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
@@ -316,129 +303,244 @@ struct inode {
 };
 
 #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) \
-               list_add_tail(&(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_first_in_inode(const struct dentry *dentry)
+static inline bool
+dentry_is_first_in_inode(const struct wim_dentry *dentry)
 {
-       return container_of(dentry->d_inode->dentry_list.next,
-                           struct dentry,
-                           inode_dentry_list) == dentry;
+       return inode_first_dentry(dentry->d_inode) == dentry;
 }
 
-extern u64 dentry_correct_total_length(const struct dentry *dentry);
+extern u64
+dentry_correct_total_length(const struct wim_dentry *dentry);
 
-extern int for_dentry_in_tree(struct dentry *root,
-                             int (*visitor)(struct dentry*, void*),
-                             void *args);
+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 dentry *, void *),
-                               void *arg);
+extern int
+for_dentry_in_rbtree(struct rb_node *node,
+                    int (*visitor)(struct wim_dentry *, void *),
+                    void *arg);
 
-extern int for_dentry_in_tree_depth(struct dentry *root,
-                                   int (*visitor)(struct dentry*, void*),
-                                   void *args);
+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 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 int
+for_dentry_in_tree_depth(struct wim_dentry *root,
+                        int (*visitor)(struct wim_dentry*, void*),
+                        void *args);
 
-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
+calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
 
-extern int print_dentry(struct dentry *dentry, void *lookup_table);
-extern int print_dentry_full_path(struct dentry *entry, void *ignore);
+extern int
+set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
 
-#ifdef WITH_FUSE
-extern struct dentry *new_dentry(const char *name);
-#endif
+extern struct wim_dentry *
+get_dentry(struct WIMStruct *w, const tchar *path);
+
+extern struct wim_inode *
+wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
+
+extern struct wim_dentry *
+get_dentry_child_with_name(const struct wim_dentry *dentry,
+                          const tchar *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 tchar *path);
+
+extern int
+print_dentry(struct wim_dentry *dentry, void *lookup_table);
 
-extern struct dentry *new_dentry_with_inode(const char *name);
-extern struct dentry *new_dentry_with_timeless_inode(const char *name);
+extern int
+print_dentry_full_path(struct wim_dentry *entry, void *ignore);
 
-extern void free_inode(struct inode *inode);
-extern void free_dentry(struct dentry *dentry);
-extern void put_dentry(struct dentry *dentry);
+extern tchar *
+dentry_full_path(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 struct wim_inode *
+new_timeless_inode();
 
-extern void unlink_dentry(struct dentry *dentry);
-extern bool dentry_add_child(struct dentry * restrict parent,
-                            struct dentry * restrict child);
+extern int
+new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 
-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 int
+new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 
-extern void inode_remove_ads(struct inode *inode, u16 idx,
-                            struct lookup_table *lookup_table);
+extern int
+new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 
-extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
-                      u64 offset, struct dentry *dentry);
+extern void
+free_inode(struct wim_inode *inode);
 
+extern void
+free_dentry(struct wim_dentry *dentry);
 
-extern int read_dentry_tree(const u8 metadata_resource[],
-                           u64 metadata_resource_len, struct dentry *dentry);
+extern void
+put_dentry(struct wim_dentry *dentry);
 
-extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
+extern void
+free_dentry_tree(struct wim_dentry *root,
+                struct wim_lookup_table *lookup_table);
 
-static inline bool dentry_is_root(const struct dentry *dentry)
+extern void
+unlink_dentry(struct wim_dentry *dentry);
+
+extern bool
+dentry_add_child(struct wim_dentry * restrict parent,
+                struct wim_dentry * restrict child);
+
+extern struct wim_ads_entry *
+inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
+                   u16 *idx_ret);
+
+extern struct wim_ads_entry *
+inode_add_ads_utf16le(struct wim_inode *inode,
+                     const utf16lechar *stream_name,
+                     size_t stream_name_nbytes);
+
+extern struct wim_ads_entry *
+inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
+
+extern int
+inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
+                       const void *value, size_t size,
+                       struct wim_lookup_table *lookup_table);
+
+extern void
+inode_remove_ads(struct wim_inode *inode, u16 idx,
+                struct wim_lookup_table *lookup_table);
+
+
+#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)
+
+/* 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;
+
+#ifndef __WIN32__
+
+#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 inode_is_directory(const struct inode *inode)
+static inline bool
+inode_is_directory(const struct wim_inode *inode)
 {
-       return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
-               && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
+       return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
+               && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
 }
 
-static inline bool dentry_is_directory(const struct dentry *dentry)
+static inline bool
+dentry_is_directory(const struct wim_dentry *dentry)
 {
        return inode_is_directory(dentry->d_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
+inode_is_symlink(const struct wim_inode *inode)
 {
-       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->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 inode_is_regular_file(const struct inode *inode)
+static inline bool
+inode_is_regular_file(const struct wim_inode *inode)
 {
        return !inode_is_directory(inode) && !inode_is_symlink(inode);
 }
 
-static inline bool dentry_is_regular_file(const struct dentry *dentry)
+static inline bool
+dentry_is_regular_file(const struct wim_dentry *dentry)
 {
        return inode_is_regular_file(dentry->d_inode);
 }
 
-static inline bool inode_has_children(const struct inode *inode)
+static inline bool
+inode_has_children(const struct wim_inode *inode)
+{
+       return inode->i_children.rb_node != NULL;
+}
+
+static inline bool
+dentry_has_children(const struct wim_dentry *dentry)
+{
+       return inode_has_children(dentry->d_inode);
+}
+
+static inline bool
+dentry_has_short_name(const struct wim_dentry *dentry)
 {
-       return inode->children.rb_node != NULL;
+       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)
 {
-       const struct inode *inode = dentry->d_inode;
-       return inode_is_directory(inode) && !inode_has_children(inode);
+       return dentry->file_name_nbytes != 0;
 }
 
 #endif