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         union {
 103                 /* 'subdir_offset' is only used while reading and writing this
 104                  * dentry.  See the corresponding field in `struct
 105                  * wim_dentry_on_disk' for explanation.  */
 106                 u64 subdir_offset;
 107
 108                 /* Temporary list field  */
 109                 struct list_head tmp_list;
 110         };
 111
 112         /* Full path to this dentry in the WIM, in platform-dependent tchars
 113          * that can be printed without conversion.  By default this field will
 114          * be NULL and will only be calculated on-demand by the
 115          * calculate_dentry_full_path() or dentry_full_path() functions.  */
 116         tchar *_full_path;
 117
 118         /* (Extraction only) Actual name to extract this dentry as.  This may be
 119          * either in 'tchars' or in 'utf16lechars', depending on what encoding
 120          * the extraction backend needs.  This may alias 'file_name'.  If it
 121          * doesn't, it is an allocated buffer which must be freed.  */
 122         void *d_extraction_name;
 123
 124         /* (Extraction only) Number of characters in d_extraction_name.  */
 125         size_t d_extraction_name_nchars;
 126
 127         /* (Extraction only) Linked list node that connects all dentries being
 128          * extracted as part of the current extraction operation.  */
 129         struct list_head d_extraction_list_node;
 130
 131         /* (Extraction only) Linked list node that connects all dentries being
 132          * extracted as aliases of the same inode as part of the current
 133          * extraction operation.  */
 134         struct list_head d_extraction_alias_node;
 135 };
 136
 137 static inline bool
 138 dentry_is_first_in_inode(const struct wim_dentry *dentry)
 139 {
 140         return inode_first_dentry(dentry->d_inode) == dentry;
 141 }
 142
 143 static inline bool
 144 will_extract_dentry(const struct wim_dentry *dentry)
 145 {
 146         return dentry->d_extraction_list_node.next != NULL;
 147 }
 148
 149 extern u64
 150 dentry_out_total_length(const struct wim_dentry *dentry);
 151
 152 extern int
 153 for_dentry_in_tree(struct wim_dentry *root,
 154                    int (*visitor)(struct wim_dentry*, void*),
 155                    void *args);
 156
 157 extern int
 158 for_dentry_in_tree_depth(struct wim_dentry *root,
 159                          int (*visitor)(struct wim_dentry*, void*),
 160                          void *args);
 161
 162 /* Iterate through each @child dentry of the @dir directory inode,
 163  * in sorted order (by case sensitive name).  */
 164 #define for_inode_child(child, dir)                                             \
 165         avl_tree_for_each_in_order((child), (dir)->i_children,                  \
 166                                    struct wim_dentry, d_index_node)
 167
 168 /* Iterate through each @child dentry of the @parent dentry,
 169  * in sorted order (by case sensitive name).  */
 170 #define for_dentry_child(child, parent) \
 171         for_inode_child((child), (parent)->d_inode)
 172
 173 /* Iterate through each @child dentry of the @dir directory inode,
 174  * in postorder (safe for freeing the child dentries).  */
 175 #define for_inode_child_postorder(child, dir)                           \
 176         avl_tree_for_each_in_postorder((child), (dir)->i_children,      \
 177                                        struct wim_dentry, d_index_node)
 178
 179 /* Iterate through each @child dentry of the @parent dentry,
 180  * in postorder (safe for freeing the child dentries).  */
 181 #define for_dentry_child_postorder(child, parent) \
 182         for_inode_child_postorder((child), (parent)->d_inode)
 183
 184 /* Get any child dentry of the @dir directory inode.  Requires
 185  * inode_has_children(@dir) == true.  */
 186 #define inode_any_child(dir)    \
 187         avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
 188
 189 /* Get any child dentry of the @parent dentry.  Requires
 190  * dentry_has_children(@parent) == true.  */
 191 #define dentry_any_child(parent) \
 192         inode_any_child((parent)->d_inode)
 193
 194 extern void
 195 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
 196
 197 extern int
 198 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
 199
 200 extern int
 201 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name,
 202                         size_t new_name_nbytes);
 203
 204 extern struct wim_dentry *
 205 get_dentry(struct WIMStruct *wim, const tchar *path,
 206            CASE_SENSITIVITY_TYPE case_type);
 207
 208 extern struct wim_dentry *
 209 get_dentry_child_with_name(const struct wim_dentry *dentry,
 210                            const tchar *name,
 211                            CASE_SENSITIVITY_TYPE case_type);
 212
 213 extern struct wim_dentry *
 214 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
 215                                    const utf16lechar *name,
 216                                    size_t name_nbytes,
 217                                    CASE_SENSITIVITY_TYPE case_type);
 218
 219 extern struct wim_dentry *
 220 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
 221                   CASE_SENSITIVITY_TYPE case_type);
 222
 223 extern int
 224 calculate_dentry_full_path(struct wim_dentry *dentry);
 225
 226 extern tchar *
 227 dentry_full_path(struct wim_dentry *dentry);
 228
 229 extern int
 230 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 231
 232 extern int
 233 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 234
 235 extern int
 236 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 237
 238 extern void
 239 dentry_tree_clear_inode_visited(struct wim_dentry *root);
 240
 241 extern int
 242 new_filler_directory(struct wim_dentry **dentry_ret);
 243
 244 extern void
 245 free_dentry(struct wim_dentry *dentry);
 246
 247 extern void
 248 free_dentry_tree(struct wim_dentry *root,
 249                  struct wim_lookup_table *lookup_table);
 250
 251 extern void
 252 unlink_dentry(struct wim_dentry *dentry);
 253
 254 extern struct wim_dentry *
 255 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child);
 256
 257 struct update_command_journal;
 258
 259 extern int
 260 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
 261                 CASE_SENSITIVITY_TYPE case_type,
 262                 struct update_command_journal *j);
 263
 264
 265 extern int
 266 read_dentry_tree(const u8 *buf, size_t buf_len,
 267                  u64 root_offset, struct wim_dentry **root_ret);
 268
 269 extern u8 *
 270 write_dentry_tree(struct wim_dentry *root, u8 *p);
 271
 272 static inline bool
 273 dentry_is_root(const struct wim_dentry *dentry)
 274 {
 275         return dentry->d_parent == dentry;
 276 }
 277
 278 static inline bool
 279 dentry_is_directory(const struct wim_dentry *dentry)
 280 {
 281         return inode_is_directory(dentry->d_inode);
 282 }
 283
 284 static inline bool
 285 dentry_has_children(const struct wim_dentry *dentry)
 286 {
 287         return inode_has_children(dentry->d_inode);
 288 }
 289
 290 static inline bool
 291 dentry_has_short_name(const struct wim_dentry *dentry)
 292 {
 293         return dentry->short_name_nbytes != 0;
 294 }
 295
 296 static inline bool
 297 dentry_has_long_name(const struct wim_dentry *dentry)
 298 {
 299         return dentry->file_name_nbytes != 0;
 300 }
 301 #endif /* _WIMLIB_DENTRY_H */