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 an 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         /* The parent of this directory entry. */
  68         struct wim_dentry *d_parent;
  69
  70         /* Linked list node that places this dentry in the list of aliases for
  71          * its inode (d_inode) */
  72         struct list_head d_alias;
  73
  74         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
  75          * if this dentry has no short name.  */
  76         utf16lechar *short_name;
  77
  78         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
  79          * dentry has no filename.  */
  80         utf16lechar *file_name;
  81
  82         /* Length of UTF-16LE encoded short filename, in bytes, not including
  83          * the terminating zero wide-character. */
  84         u16 short_name_nbytes;
  85
  86         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
  87          * the terminating null character. */
  88         u16 file_name_nbytes;
  89
  90         /* When capturing from an NTFS volume using NTFS-3g, this flag is set on
  91          * dentries that were created from a filename in the WIN32 or WIN32+DOS
  92          * namespaces rather than the POSIX namespace.  Otherwise this will
  93          * always be 0.  */
  94         u8 is_win32_name : 1;
  95
  96         /* Temporary flag; always reset to 0 when done using.  */
  97         u8 tmp_flag : 1;
  98
  99         /* Used by wimlib_update_image()  */
 100         u8 is_orphan : 1;
 101
 102         /* Temporary list field  */
 103         struct list_head tmp_list;
 104
 105         /* 'length' and 'subdir_offset' are only used while reading and writing
 106          * this dentry; see the corresponding field in
 107          * `struct wim_dentry_on_disk' for explanation.  */
 108         u64 length;
 109         u64 subdir_offset;
 110
 111         /* Full path to this dentry in the WIM, in platform-dependent tchars
 112          * that can be printed without conversion.  By default this field will
 113          * be NULL and will only be calculated on-demand by the
 114          * calculate_dentry_full_path() or dentry_full_path() functions.  */
 115         tchar *_full_path;
 116
 117         /* (Extraction only) Actual name to extract this dentry as.  This may be
 118          * either in 'tchars' or in 'utf16lechars', depending on what encoding
 119          * the extraction backend needs.  This may alias 'file_name'.  If it
 120          * doesn't, it is an allocated buffer which must be freed.  */
 121         void *d_extraction_name;
 122
 123         /* (Extraction only) Number of characters in d_extraction_name.  */
 124         size_t d_extraction_name_nchars;
 125
 126         /* (Extraction only) Linked list node that connects all dentries being
 127          * extracted as part of the current extraction operation.  */
 128         struct list_head d_extraction_list_node;
 129
 130         /* (Extraction only) Linked list node that connects all dentries being
 131          * extracted as aliases of the same inode as part of the current
 132          * extraction operation.  */
 133         struct list_head d_extraction_alias_node;
 134 };
 135
 136 static inline bool
 137 dentry_is_first_in_inode(const struct wim_dentry *dentry)
 138 {
 139         return inode_first_dentry(dentry->d_inode) == dentry;
 140 }
 141
 142 static inline bool
 143 will_extract_dentry(const struct wim_dentry *dentry)
 144 {
 145         return dentry->d_extraction_list_node.next != NULL;
 146 }
 147
 148 extern u64
 149 dentry_out_total_length(const struct wim_dentry *dentry);
 150
 151 extern int
 152 for_dentry_in_tree(struct wim_dentry *root,
 153                    int (*visitor)(struct wim_dentry*, void*),
 154                    void *args);
 155
 156 extern int
 157 for_dentry_in_tree_depth(struct wim_dentry *root,
 158                          int (*visitor)(struct wim_dentry*, void*),
 159                          void *args);
 160
 161 /* Iterate through each @child dentry of the @dir directory inode,
 162  * in sorted order (by case sensitive name).  */
 163 #define for_inode_child(child, dir)                                             \
 164         avl_tree_for_each_in_order((child), (dir)->i_children,                  \
 165                                    struct wim_dentry, d_index_node)
 166
 167 /* Iterate through each @child dentry of the @parent dentry,
 168  * in sorted order (by case sensitive name).  */
 169 #define for_dentry_child(child, parent) \
 170         for_inode_child((child), (parent)->d_inode)
 171
 172 /* Iterate through each @child dentry of the @dir directory inode,
 173  * in postorder (safe for freeing the child dentries).  */
 174 #define for_inode_child_postorder(child, dir)                           \
 175         avl_tree_for_each_in_postorder((child), (dir)->i_children,      \
 176                                        struct wim_dentry, d_index_node)
 177
 178 /* Iterate through each @child dentry of the @parent dentry,
 179  * in postorder (safe for freeing the child dentries).  */
 180 #define for_dentry_child_postorder(child, parent) \
 181         for_inode_child_postorder((child), (parent)->d_inode)
 182
 183 /* Get any child dentry of the @dir directory inode.  Requires
 184  * inode_has_children(@dir) == true.  */
 185 #define inode_any_child(dir)    \
 186         avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
 187
 188 /* Get any child dentry of the @parent dentry.  Requires
 189  * dentry_has_children(@parent) == true.  */
 190 #define dentry_any_child(parent) \
 191         inode_any_child((parent)->d_inode)
 192
 193 extern void
 194 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
 195
 196 extern int
 197 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
 198
 199 extern int
 200 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name,
 201                         size_t new_name_nbytes);
 202
 203 extern struct wim_dentry *
 204 get_dentry(struct WIMStruct *wim, const tchar *path,
 205            CASE_SENSITIVITY_TYPE case_type);
 206
 207 extern struct wim_dentry *
 208 get_dentry_child_with_name(const struct wim_dentry *dentry,
 209                            const tchar *name,
 210                            CASE_SENSITIVITY_TYPE case_type);
 211
 212 extern struct wim_dentry *
 213 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
 214                                    const utf16lechar *name,
 215                                    size_t name_nbytes,
 216                                    CASE_SENSITIVITY_TYPE case_type);
 217
 218 extern struct wim_dentry *
 219 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
 220                   CASE_SENSITIVITY_TYPE case_type);
 221
 222 #ifdef WITH_FUSE
 223
 224 #define LOOKUP_FLAG_ADS_OK              0x00000001
 225 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
 226
 227 extern int
 228 wim_pathname_to_stream(WIMStruct *wim,
 229                        const tchar *path,
 230                        int lookup_flags,
 231                        struct wim_dentry **dentry_ret,
 232                        struct wim_lookup_table_entry **lte_ret,
 233                        u16 *stream_idx_ret);
 234 #endif
 235
 236 extern int
 237 calculate_dentry_full_path(struct wim_dentry *dentry);
 238
 239 extern tchar *
 240 dentry_full_path(struct wim_dentry *dentry);
 241
 242 extern int
 243 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 244
 245 extern int
 246 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 247
 248 extern int
 249 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 250
 251 extern void
 252 dentry_tree_clear_inode_visited(struct wim_dentry *root);
 253
 254 extern int
 255 new_filler_directory(struct wim_dentry **dentry_ret);
 256
 257 extern void
 258 free_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 struct update_command_journal;
 271
 272 extern int
 273 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
 274                 CASE_SENSITIVITY_TYPE case_type,
 275                 struct update_command_journal *j);
 276
 277
 278 extern int
 279 read_dentry_tree(const u8 *buf, size_t buf_len,
 280                  u64 root_offset, struct wim_dentry **root_ret);
 281
 282 extern u8 *
 283 write_dentry_tree(struct wim_dentry *root, u8 *p);
 284
 285 static inline bool
 286 dentry_is_root(const struct wim_dentry *dentry)
 287 {
 288         return dentry->d_parent == dentry;
 289 }
 290
 291 static inline bool
 292 dentry_is_directory(const struct wim_dentry *dentry)
 293 {
 294         return inode_is_directory(dentry->d_inode);
 295 }
 296
 297 static inline bool
 298 dentry_has_children(const struct wim_dentry *dentry)
 299 {
 300         return inode_has_children(dentry->d_inode);
 301 }
 302
 303 static inline bool
 304 dentry_has_short_name(const struct wim_dentry *dentry)
 305 {
 306         return dentry->short_name_nbytes != 0;
 307 }
 308
 309 static inline bool
 310 dentry_has_long_name(const struct wim_dentry *dentry)
 311 {
 312         return dentry->file_name_nbytes != 0;
 313 }
 314 #endif /* _WIMLIB_DENTRY_H */