]> wimlib.net Git - wimlib/blobdiff - include/wimlib/dentry.h
inode/blob cleanups
[wimlib] / include / wimlib / dentry.h
index 15decce02c955757071d558fff7b193e39b8e135..40a4c8e67d7e259a5be7a69a2dd2e5a6dc63fa71 100644 (file)
@@ -9,11 +9,11 @@
 #include "wimlib/types.h"
 
 struct wim_inode;
-struct wim_lookup_table;
+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
 
 /*
@@ -21,28 +21,18 @@ struct wim_lookup_table;
  * 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 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).
+ * 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
@@ -62,7 +52,7 @@ struct wim_dentry {
         * long names but share the same case insensitive long name.  */
        struct list_head d_ci_conflict_list;
 
-       /* The parent of this directory entry. */
+       /* The parent of this directory entry. (The root is its own parent.)  */
        struct wim_dentry *d_parent;
 
        /* Linked list node that places this dentry in the list of aliases for
@@ -144,7 +134,7 @@ will_extract_dentry(const struct wim_dentry *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
@@ -152,22 +142,28 @@ for_dentry_in_tree(struct wim_dentry *root,
                   int (*visitor)(struct wim_dentry*, void*),
                   void *args);
 
-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,                  \
+ * 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).  */
+ * 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)                          \
@@ -225,13 +221,12 @@ 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);
@@ -244,7 +239,7 @@ free_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);