wimlib.net Git - wimlib/blob - include/wimlib/dentry.h

   1 #ifndef _WIMLIB_DENTRY_H
   2 #define _WIMLIB_DENTRY_H
   3
   4 #include "wimlib/avl_tree.h"
   5 #include "wimlib/case.h"
   6 #include "wimlib/compiler.h"
   7 #include "wimlib/inode.h"
   8 #include "wimlib/list.h"
   9 #include "wimlib/types.h"
  10
  11 struct wim_inode;
  12 struct wim_lookup_table;
  13 struct wim_lookup_table_entry;
  14 struct wim_security_data;
  15
  16 /* Base size of a WIM dentry in the on-disk format, up to and including the file
  17  * name length.  This does not include the variable-length file name, short
  18  * name, alternate data stream entries, and padding to 8-byte boundaries.  */
  19 #define WIM_DENTRY_DISK_SIZE 102
  20
  21 /*
  22  * In-memory structure for a WIM directory entry (dentry).  There is a directory
  23  * tree for each image in the WIM.
  24  *
  25  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
  26  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
  27  * The hard link group ID field of the on-disk WIM dentry tells us the number of
  28  * the NTFS inode that the dentry corresponds to (and this gets placed in
  29  * d_inode->i_ino).
  30  *
  31  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
  32  * information, such as file attributes, the security descriptor, and file
  33  * streams is replicated in each hard-linked dentry, even though this
  34  * information really is associated with an inode.  In-memory, we fix up this
  35  * flaw by allocating a `struct wim_inode' for each dentry that contains some of
  36  * this duplicated information, then combining the inodes for each hard link
  37  * group together.
  38  *
  39  * Confusingly, it's possible for stream information to be missing from a dentry
  40  * in a hard link set, in which case the stream information needs to be gotten
  41  * from one of the other dentries in the hard link set.  In addition, it is
  42  * possible for dentries to have inconsistent security IDs, file attributes, or
  43  * file streams when they share the same hard link ID (don't even ask.  I hope
  44  * that Microsoft may have fixed this problem, since I've only noticed it in the
  45  * 'install.wim' for Windows 7).  For those dentries, we have to use the
  46  * conflicting fields to split up the hard link groups.  (See
  47  * dentry_tree_fix_inodes() in inode_fixup.c.)
  48  */
  49 struct wim_dentry {
  50         /* Pointer to the inode for this dentry.  This will contain some
  51          * information that was factored out of the on-disk WIM dentry as common
  52          * to all dentries in a hard link group.  */
  53         struct wim_inode *d_inode;
  54
  55         /* Node for the parent's balanced binary search tree of child dentries
  56          * sorted by case sensitive long name (root i_children).  */
  57         struct avl_tree_node d_index_node;
  58
  59         /* Node for the parent's balanced binary search tree of child dentries,
  60          * sorted by case insensitive long name (root i_children_ci). */
  61         struct avl_tree_node d_index_node_ci;
  62
  63         /* List of dentries in a directory that have different case sensitive
  64          * long names but share the same case insensitive long name.  */
  65         struct list_head d_ci_conflict_list;
  66
  67         /* Length of UTF-16LE encoded short filename, in bytes, not including
  68          * the terminating zero wide-character. */
  69         u16 short_name_nbytes;
  70
  71         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
  72          * the terminating null character. */
  73         u16 file_name_nbytes;
  74
  75         /* Length of full path name encoded using "tchars", in bytes, not
  76          * including the terminating null character. */
  77         u32 full_path_nbytes;
  78
  79         /* During extraction extractions, this flag will be set after the
  80          * "skeleton" of the dentry has been extracted.  */
  81         u8 skeleton_extracted : 1;
  82
  83         /* When capturing from a NTFS volume using NTFS-3g, this flag is set on
  84          * dentries that were created from a filename in the WIN32 or WIN32+DOS
  85          * namespaces rather than the POSIX namespace.  Otherwise this will
  86          * always be 0.  */
  87         u8 is_win32_name : 1;
  88
  89         /* Temporary flag; always reset to 0 when done using.  */
  90         u8 tmp_flag : 1;
  91
  92         /* Set to 1 if this name was extracted as a link, so no streams need to
  93          * be extracted to it.  */
  94         u8 was_linked : 1;
  95
  96         /* Temporary list field  */
  97         struct list_head tmp_list;
  98
  99         /* Links list of dentries being extracted  */
 100         struct list_head extraction_list;
 101
 102         /* Linked list node that places this dentry in the list of aliases for
 103          * its inode (d_inode) */
 104         struct list_head d_alias;
 105
 106         /* The parent of this directory entry. */
 107         struct wim_dentry *parent;
 108
 109         /* 'length' and 'subdir_offset' are only used while reading and writing
 110          * this dentry; see the corresponding field in
 111          * `struct wim_dentry_on_disk' for explanation.  */
 112         u64 length;
 113         u64 subdir_offset;
 114
 115         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
 116          * if this dentry has no short name.  */
 117         utf16lechar *short_name;
 118
 119         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
 120          * dentry has no filename.  */
 121         utf16lechar *file_name;
 122
 123         /* Full path to this dentry in the WIM, in platform-dependent tchars
 124          * that can be printed without conversion.  By default this field will
 125          * be NULL and will only be calculated on-demand by the
 126          * calculate_dentry_full_path() or dentry_full_path() functions.  */
 127         tchar *_full_path;
 128
 129         /* (Extraction only) Actual name to extract this dentry as, along with
 130          * its length in tchars excluding the NULL terminator.  This usually
 131          * will be the same as file_name, with the character encoding converted
 132          * if needed.  But if file_name contains characters not accepted on the
 133          * current platform, then this may be set slightly differently from
 134          * file_name.  This will be either NULL or a malloc()ed buffer that may
 135          * alias file_name.  */
 136         tchar *extraction_name;
 137         size_t extraction_name_nchars;
 138 };
 139
 140 static inline bool
 141 dentry_is_first_in_inode(const struct wim_dentry *dentry)
 142 {
 143         return inode_first_dentry(dentry->d_inode) == dentry;
 144 }
 145
 146 extern u64
 147 dentry_out_total_length(const struct wim_dentry *dentry);
 148
 149 extern int
 150 for_dentry_in_tree(struct wim_dentry *root,
 151                    int (*visitor)(struct wim_dentry*, void*),
 152                    void *args);
 153
 154 extern int
 155 for_dentry_in_tree_depth(struct wim_dentry *root,
 156                          int (*visitor)(struct wim_dentry*, void*),
 157                          void *args);
 158
 159 /* Iterate through each @child dentry of the @dir directory inode,
 160  * in sorted order (by case sensitive name).  */
 161 #define for_inode_child(child, dir)                                             \
 162         avl_tree_for_each_in_order((child), (dir)->i_children,                  \
 163                                    struct wim_dentry, d_index_node)
 164
 165 /* Iterate through each @child dentry of the @parent dentry,
 166  * in sorted order (by case sensitive name).  */
 167 #define for_dentry_child(child, parent) \
 168         for_inode_child((child), (parent)->d_inode)
 169
 170 /* Iterate through each @child dentry of the @dir directory inode,
 171  * in postorder (safe for freeing the child dentries).  */
 172 #define for_inode_child_postorder(child, dir)                           \
 173         avl_tree_for_each_in_postorder((child), (dir)->i_children,      \
 174                                        struct wim_dentry, d_index_node)
 175
 176 /* Iterate through each @child dentry of the @parent dentry,
 177  * in postorder (safe for freeing the child dentries).  */
 178 #define for_dentry_child_postorder(child, parent) \
 179         for_inode_child_postorder((child), (parent)->d_inode)
 180
 181 /* Get any child dentry of the @dir directory inode.  Requires
 182  * inode_has_children(@dir) == true.  */
 183 #define inode_any_child(dir)    \
 184         avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
 185
 186 /* Get any child dentry of the @parent dentry.  Requires
 187  * dentry_has_children(@parent) == true.  */
 188 #define dentry_any_child(parent) \
 189         inode_any_child((parent)->d_inode)
 190
 191 extern void
 192 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
 193
 194 extern int
 195 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
 196
 197 extern struct wim_dentry *
 198 get_dentry(struct WIMStruct *wim, const tchar *path,
 199            CASE_SENSITIVITY_TYPE case_type);
 200
 201 extern struct wim_dentry *
 202 get_dentry_child_with_name(const struct wim_dentry *dentry,
 203                            const tchar *name,
 204                            CASE_SENSITIVITY_TYPE case_type);
 205
 206 extern struct wim_dentry *
 207 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
 208                                    const utf16lechar *name,
 209                                    size_t name_nbytes,
 210                                    CASE_SENSITIVITY_TYPE case_type);
 211
 212 extern struct wim_dentry *
 213 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
 214                   CASE_SENSITIVITY_TYPE case_type);
 215
 216 #ifdef WITH_FUSE
 217
 218 #define LOOKUP_FLAG_ADS_OK              0x00000001
 219 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
 220
 221 extern int
 222 wim_pathname_to_stream(WIMStruct *wim,
 223                        const tchar *path,
 224                        int lookup_flags,
 225                        struct wim_dentry **dentry_ret,
 226                        struct wim_lookup_table_entry **lte_ret,
 227                        u16 *stream_idx_ret);
 228 #endif
 229
 230 extern int
 231 calculate_dentry_full_path(struct wim_dentry *dentry);
 232
 233 extern int
 234 calculate_dentry_tree_full_paths(struct wim_dentry *root);
 235
 236 extern tchar *
 237 dentry_full_path(struct wim_dentry *dentry);
 238
 239 extern int
 240 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 241
 242 extern int
 243 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 244
 245 extern int
 246 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 247
 248 extern void
 249 dentry_tree_clear_inode_visited(struct wim_dentry *root);
 250
 251 extern int
 252 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
 253
 254 extern void
 255 free_dentry(struct wim_dentry *dentry);
 256
 257 extern void
 258 put_dentry(struct wim_dentry *dentry);
 259
 260 extern void
 261 free_dentry_tree(struct wim_dentry *root,
 262                  struct wim_lookup_table *lookup_table);
 263
 264 extern void
 265 unlink_dentry(struct wim_dentry *dentry);
 266
 267 extern struct wim_dentry *
 268 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child);
 269
 270 extern int
 271 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
 272                 CASE_SENSITIVITY_TYPE case_type);
 273
 274
 275 extern int
 276 read_dentry_tree(const u8 *buf, size_t buf_len,
 277                  u64 root_offset, struct wim_dentry **root_ret);
 278
 279 extern u8 *
 280 write_dentry_tree(struct wim_dentry *root, u8 *p);
 281
 282 static inline bool
 283 dentry_is_root(const struct wim_dentry *dentry)
 284 {
 285         return dentry->parent == dentry;
 286 }
 287
 288 static inline bool
 289 dentry_is_directory(const struct wim_dentry *dentry)
 290 {
 291         return inode_is_directory(dentry->d_inode);
 292 }
 293
 294 static inline bool
 295 dentry_has_children(const struct wim_dentry *dentry)
 296 {
 297         return inode_has_children(dentry->d_inode);
 298 }
 299
 300 static inline bool
 301 dentry_has_short_name(const struct wim_dentry *dentry)
 302 {
 303         return dentry->short_name_nbytes != 0;
 304 }
 305
 306 static inline bool
 307 dentry_has_long_name(const struct wim_dentry *dentry)
 308 {
 309         return dentry->file_name_nbytes != 0;
 310 }
 311
 312 extern int
 313 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 314 #endif /* _WIMLIB_DENTRY_H */