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

   1 #ifndef _WIMLIB_DENTRY_H
   2 #define _WIMLIB_DENTRY_H
   3
   4 #include "wimlib/case.h"
   5 #include "wimlib/compiler.h"
   6 #include "wimlib/inode.h"
   7 #include "wimlib/list.h"
   8 #include "wimlib/rbtree.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 red-black tree of child dentries, sorted by
  56          * case sensitive long name. */
  57         struct rb_node rb_node;
  58
  59         /* Node for the parent's red-black tree of child dentries, sorted by
  60          * case insensitive long name. */
  61         struct rb_node rb_node_case_insensitive;
  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 case_insensitive_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 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
 141
 142 static inline bool
 143 dentry_is_first_in_inode(const struct wim_dentry *dentry)
 144 {
 145         return inode_first_dentry(dentry->d_inode) == dentry;
 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 @parent inode,
 162  * in sorted order (by case sensitive name).  */
 163 #define for_inode_child(child, parent)                                          \
 164         for (struct rb_node *_tmp = rb_first(&parent->i_children);              \
 165              _tmp &&                                                            \
 166                 ((child = rb_entry(_tmp, struct wim_dentry, rb_node)), 1);      \
 167              _tmp = rb_next(_tmp))
 168
 169 /* Iterate through each @child dentry of the @parent dentry,
 170  * in sorted order (by case sensitive name).  */
 171 #define for_dentry_child(child, parent) \
 172         for_inode_child(child, parent->d_inode)
 173
 174 /* Iterate through each @child dentry of the @parent inode,
 175  * in postorder (safe for freeing).  */
 176 #define for_inode_child_postorder(child, parent)                                        \
 177         for (struct rb_node *_tmp = rb_first_postorder(&parent->i_children), *_parent;  \
 178              _tmp &&                                                                    \
 179                 ((child = rb_entry(_tmp, struct wim_dentry, rb_node)), 1) &&            \
 180                 ((_parent = rb_parent(_tmp)), 1);                                       \
 181              _tmp = rb_next_postorder(_tmp, _parent))
 182
 183 /* Iterate through each @child dentry of the @parent dentry,
 184  * in postorder (safe for freeing).  */
 185 #define for_dentry_child_postorder(child, parent) \
 186         for_inode_child_postorder(child, parent->d_inode)
 187
 188 extern void
 189 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
 190
 191 extern int
 192 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
 193
 194 extern struct wim_dentry *
 195 get_dentry(struct WIMStruct *wim, const tchar *path,
 196            CASE_SENSITIVITY_TYPE case_type);
 197
 198 extern struct wim_dentry *
 199 get_dentry_child_with_name(const struct wim_dentry *dentry,
 200                            const tchar *name,
 201                            CASE_SENSITIVITY_TYPE case_type);
 202
 203 extern struct wim_dentry *
 204 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
 205                                    const utf16lechar *name,
 206                                    size_t name_nbytes,
 207                                    CASE_SENSITIVITY_TYPE case_type);
 208
 209 extern struct wim_dentry *
 210 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
 211                   CASE_SENSITIVITY_TYPE case_type);
 212
 213 #ifdef WITH_FUSE
 214
 215 #define LOOKUP_FLAG_ADS_OK              0x00000001
 216 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
 217
 218 extern int
 219 wim_pathname_to_stream(WIMStruct *wim,
 220                        const tchar *path,
 221                        int lookup_flags,
 222                        struct wim_dentry **dentry_ret,
 223                        struct wim_lookup_table_entry **lte_ret,
 224                        u16 *stream_idx_ret);
 225 #endif
 226
 227 extern int
 228 calculate_dentry_full_path(struct wim_dentry *dentry);
 229
 230 extern int
 231 calculate_dentry_tree_full_paths(struct wim_dentry *root);
 232
 233 extern tchar *
 234 dentry_full_path(struct wim_dentry *dentry);
 235
 236 extern int
 237 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 238
 239 extern int
 240 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 241
 242 extern int
 243 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 244
 245 extern void
 246 dentry_tree_clear_inode_visited(struct wim_dentry *root);
 247
 248 extern int
 249 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
 250
 251 extern void
 252 free_dentry(struct wim_dentry *dentry);
 253
 254 extern void
 255 put_dentry(struct wim_dentry *dentry);
 256
 257 extern void
 258 free_dentry_tree(struct wim_dentry *root,
 259                  struct wim_lookup_table *lookup_table);
 260
 261 extern void
 262 unlink_dentry(struct wim_dentry *dentry);
 263
 264 extern struct wim_dentry *
 265 dentry_add_child(struct wim_dentry * restrict parent,
 266                  struct wim_dentry * restrict child);
 267
 268 extern int
 269 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
 270                 CASE_SENSITIVITY_TYPE case_type);
 271
 272
 273 extern int
 274 read_dentry_tree(const u8 *buf, size_t buf_len,
 275                  u64 root_offset, struct wim_dentry **root_ret);
 276
 277 extern u8 *
 278 write_dentry_tree(struct wim_dentry *root, u8 *p);
 279
 280 static inline bool
 281 dentry_is_root(const struct wim_dentry *dentry)
 282 {
 283         return dentry->parent == dentry;
 284 }
 285
 286 static inline bool
 287 dentry_is_directory(const struct wim_dentry *dentry)
 288 {
 289         return inode_is_directory(dentry->d_inode);
 290 }
 291
 292 static inline bool
 293 dentry_has_children(const struct wim_dentry *dentry)
 294 {
 295         return inode_has_children(dentry->d_inode);
 296 }
 297
 298 static inline bool
 299 dentry_has_short_name(const struct wim_dentry *dentry)
 300 {
 301         return dentry->short_name_nbytes != 0;
 302 }
 303
 304 static inline bool
 305 dentry_has_long_name(const struct wim_dentry *dentry)
 306 {
 307         return dentry->file_name_nbytes != 0;
 308 }
 309
 310 extern int
 311 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 312 #endif /* _WIMLIB_DENTRY_H */