]> wimlib.net Git - wimlib/blobdiff - include/wimlib/dentry.h
Add support for extract list files
[wimlib] / include / wimlib / dentry.h
index 0871edc2d418894edc160743346ca3ae523091ce..f5140281e686af0ee8b80338c204f9a5517ad399 100644 (file)
 #include <string.h>
 #include <sys/types.h> /* uid_t, gid_t */
 
-#ifdef WITH_FUSE
-#  include <pthread.h>
-#endif
-
 struct wim_lookup_table;
 struct wim_lookup_table_entry;
 struct wimfs_fd;
@@ -157,16 +153,19 @@ struct wim_dentry {
         * including the terminating null character. */
        u32 full_path_nbytes;
 
-       /* For extraction operations, a subtree of dentries will have this flag
-        * set so we can keep track of which dentries still need to be
-        * extracted.  Otherwise this will always be 0.  */
-       u8 needs_extraction : 1;
-
        /* 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 or contains invalid
         * characters).  Otherwise this will always be 0. */
-       u8 not_extracted : 1;
+       u8 extraction_skipped : 1;
+
+       /* For extraction operations, this flag will be set on dentries in the
+        * tree being extracted.  */
+       u8 in_extraction_tree : 1;
+
+       /* During extraction extractions, this flag will be set after the
+        * "skeleton" of the dentry has been extracted.  */
+       u8 skeleton_extracted : 1;
 
        /* When capturing from a NTFS volume using NTFS-3g, this flag is set on
         * dentries that were created from a filename in the WIN32 or WIN32+DOS
@@ -181,6 +180,10 @@ struct wim_dentry {
         * names.  */
        u8 dos_name_invalid : 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;
@@ -227,10 +230,6 @@ struct wim_dentry {
         * alias file_name.  */
        tchar *extraction_name;
        size_t extraction_name_nchars;
-
-       /* (Extraction only) List head for building a list of dentries that
-        * contain a certain stream. */
-       struct list_head extraction_stream_list;
 };
 
 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
@@ -297,7 +296,7 @@ struct wim_inode {
        /* Number of dentries that are aliases for this inode.  */
        u32 i_nlink;
 
-       /* Number of alternate data streams associated with this inode */
+       /* Number of alternate data streams (ADS) associated with this inode */
        u16 i_num_ads;
 
        /* Flag that indicates whether this inode's streams have been
@@ -316,10 +315,13 @@ struct wim_inode {
         * error paths.  */
        u8 i_visited : 1;
 
-       /* For NTFS-3g extraction:  Set after the DOS name for this inode has
-        * been extracted.  */
+       /* Set if the DOS name of an inode has already been extracted.  */
        u8 i_dos_name_extracted : 1;
 
+       /* 1 iff all ADS entries of this inode are named or if this inode
+        * has no ADS entries  */
+       u8 i_canonical_streams : 1;
+
        /* Pointer to a malloc()ed array of i_num_ads alternate data stream
         * entries for this inode.  */
        struct wim_ads_entry *i_ads_entries;
@@ -367,26 +369,36 @@ struct wim_inode {
                 * to 0 otherwise.  */
                u64 i_devno;
 
-               /* Used only during image extraction: pointer to the first path
-                * (malloc()ed buffer) at which this inode has been extracted.
-                * Freed and set to NULL after the extraction is done (either
-                * success or failure).  */
-               tchar *i_extracted_file;
-       };
+               struct {
 
-       /* Next alternate data stream ID to be assigned */
-       u32 i_next_stream_id;
+                       /* Used only during image extraction: pointer to the first path
+                        * (malloc()ed buffer) at which this inode has been extracted.
+                        * Freed and set to NULL after the extraction is done (either
+                        * success or failure).  */
+                       tchar *i_extracted_file;
+
+                       /** Used only during image extraction: "cookie" that
+                        * identifies this extracted file (inode), for example
+                        * an inode number.  Only used if supported by the
+                        * extraction mode.  */
+                       u64 extract_cookie;
+               };
+
+#ifdef WITH_FUSE
+               /* Used only during image mount:  Table of file descriptors that
+                * have been opened to this inode.  The table is automatically
+                * freed when the last file descriptor is closed.  */
+               struct wimfs_fd **i_fds;
+#endif
+       };
 
 #ifdef WITH_FUSE
-       /* wimfs file descriptors table for the inode */
        u16 i_num_opened_fds;
        u16 i_num_allocated_fds;
-       struct wimfs_fd **i_fds;
-       /* 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
+
+       /* Next alternate data stream ID to be assigned */
+       u32 i_next_stream_id;
 };
 
 #define inode_for_each_dentry(dentry, inode) \
@@ -408,7 +420,7 @@ dentry_is_first_in_inode(const struct wim_dentry *dentry)
 }
 
 extern u64
-dentry_correct_total_length(const struct wim_dentry *dentry);
+dentry_out_total_length(const struct wim_dentry *dentry);
 
 extern int
 for_dentry_in_tree(struct wim_dentry *root,
@@ -420,15 +432,10 @@ for_dentry_in_rbtree(struct rb_node *node,
                     int (*visitor)(struct wim_dentry *, void *),
                     void *arg);
 
-static inline int
+extern 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);
-}
+                void *arg);
 
 extern int
 for_dentry_in_tree_depth(struct wim_dentry *root,
@@ -442,10 +449,10 @@ extern int
 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
 
 extern struct wim_dentry *
-get_dentry(struct WIMStruct *w, const tchar *path);
+get_dentry(struct WIMStruct *wim, const tchar *path);
 
 extern struct wim_inode *
-wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
+wim_pathname_to_inode(struct WIMStruct *wim, const tchar *path);
 
 extern struct wim_dentry *
 get_dentry_child_with_name(const struct wim_dentry *dentry,
@@ -457,7 +464,7 @@ get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
                                   size_t name_nbytes);
 
 extern struct wim_dentry *
-get_parent_dentry(struct WIMStruct *w, const tchar *path);
+get_parent_dentry(struct WIMStruct *wim, const tchar *path);
 
 extern int
 print_dentry(struct wim_dentry *dentry, void *lookup_table);
@@ -486,6 +493,9 @@ new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 extern int
 new_dentry_with_timeless_inode(const tchar *name, 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);
 
@@ -526,6 +536,9 @@ inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
                        const void *value, size_t size,
                        struct wim_lookup_table *lookup_table);
 
+bool
+inode_has_named_stream(const struct wim_inode *inode);
+
 extern int
 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
                         struct wim_lookup_table *lookup_table);
@@ -541,6 +554,22 @@ inode_remove_ads(struct wim_inode *inode, u16 idx,
 #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)
 
+static inline bool
+ads_entry_is_unix_data(const struct wim_ads_entry *entry)
+{
+       return (entry->stream_name_nbytes ==
+                       WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES) &&
+               !memcmp(entry->stream_name, WIMLIB_UNIX_DATA_TAG_UTF16LE,
+                       WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES);
+}
+
+static inline bool
+ads_entry_is_named_stream(const struct wim_ads_entry *entry)
+{
+       return entry->stream_name_nbytes != 0 && !ads_entry_is_unix_data(entry);
+}
+
+#ifndef __WIN32__
 /* Format for special alternate data stream entries to store UNIX data for files
  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
 struct wimlib_unix_data {
@@ -550,8 +579,6 @@ struct wimlib_unix_data {
        u16 mode;
 } _packed_attribute;
 
-#ifndef __WIN32__
-
 #define NO_UNIX_DATA (-1)
 #define BAD_UNIX_DATA (-2)
 extern int
@@ -567,18 +594,24 @@ inode_get_unix_data(const struct wim_inode *inode,
 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
+#endif /* !__WIN32__ */
+
+extern bool
+inode_has_unix_data(const struct wim_inode *inode);
 
 extern int
-read_dentry(const u8 *metadata_resource, u64 metadata_resource_len,
-           u64 offset, struct wim_dentry *dentry);
+read_dentry(const u8 * restrict metadata_resource,
+           u64 metadata_resource_len, u64 offset,
+           struct wim_dentry * restrict dentry);
 
 extern int
-read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
-                struct wim_dentry *dentry);
+read_dentry_tree(const u8 * restrict metadata_resource,
+                u64 metadata_resource_len,
+                struct wim_dentry * restrict dentry);
 
 extern u8 *
-write_dentry_tree(const struct wim_dentry *tree, u8 *p);
+write_dentry_tree(const struct wim_dentry * restrict tree,
+                 u8 * restrict p);
 
 static inline bool
 dentry_is_root(const struct wim_dentry *dentry)
@@ -589,8 +622,17 @@ dentry_is_root(const struct wim_dentry *dentry)
 static inline bool
 inode_is_directory(const struct wim_inode *inode)
 {
-       return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
-               && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
+       return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
+                                      FILE_ATTRIBUTE_REPARSE_POINT))
+                       == FILE_ATTRIBUTE_DIRECTORY;
+}
+
+static inline bool
+inode_is_encrypted_directory(const struct wim_inode *inode)
+{
+       return ((inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
+                                       FILE_ATTRIBUTE_ENCRYPTED))
+               == (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_ENCRYPTED));
 }
 
 static inline bool
@@ -609,18 +651,6 @@ inode_is_symlink(const struct wim_inode *inode)
                    inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
 }
 
-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 wim_dentry *dentry)
-{
-       return inode_is_regular_file(dentry->d_inode);
-}
-
 static inline bool
 inode_has_children(const struct wim_inode *inode)
 {
@@ -651,7 +681,7 @@ inode_ref_streams(struct wim_inode *inode);
 extern int
 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 
-int
+extern int
 verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
 
-#endif
+#endif /* _WIMLIB_DENTRY_H */