1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
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"
12 struct wim_lookup_table;
13 struct wim_lookup_table_entry;
14 struct wim_security_data;
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
22 * In-memory structure for a WIM directory entry (dentry). There is a directory
23 * tree for each image in the WIM.
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
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
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.)
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;
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;
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;
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;
67 /* The parent of this directory entry. */
68 struct wim_dentry *d_parent;
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;
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;
78 /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
79 * dentry has no filename. */
80 utf16lechar *file_name;
82 /* Length of UTF-16LE encoded short filename, in bytes, not including
83 * the terminating zero wide-character. */
84 u16 short_name_nbytes;
86 /* Length of UTF-16LE encoded "long" file name, in bytes, not including
87 * the terminating null character. */
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
96 /* Temporary flag; always reset to 0 when done using. */
99 /* Used by wimlib_update_image() */
102 /* Temporary list field */
103 struct list_head tmp_list;
105 /* 'subdir_offset' is only used while reading and writing this dentry.
106 * See the corresponding field in `struct wim_dentry_on_disk' for
110 /* Full path to this dentry in the WIM, in platform-dependent tchars
111 * that can be printed without conversion. By default this field will
112 * be NULL and will only be calculated on-demand by the
113 * calculate_dentry_full_path() or dentry_full_path() functions. */
116 /* (Extraction only) Actual name to extract this dentry as. This may be
117 * either in 'tchars' or in 'utf16lechars', depending on what encoding
118 * the extraction backend needs. This may alias 'file_name'. If it
119 * doesn't, it is an allocated buffer which must be freed. */
120 void *d_extraction_name;
122 /* (Extraction only) Number of characters in d_extraction_name. */
123 size_t d_extraction_name_nchars;
125 /* (Extraction only) Linked list node that connects all dentries being
126 * extracted as part of the current extraction operation. */
127 struct list_head d_extraction_list_node;
129 /* (Extraction only) Linked list node that connects all dentries being
130 * extracted as aliases of the same inode as part of the current
131 * extraction operation. */
132 struct list_head d_extraction_alias_node;
136 dentry_is_first_in_inode(const struct wim_dentry *dentry)
138 return inode_first_dentry(dentry->d_inode) == dentry;
142 will_extract_dentry(const struct wim_dentry *dentry)
144 return dentry->d_extraction_list_node.next != NULL;
148 dentry_out_total_length(const struct wim_dentry *dentry);
151 for_dentry_in_tree(struct wim_dentry *root,
152 int (*visitor)(struct wim_dentry*, void*),
156 for_dentry_in_tree_depth(struct wim_dentry *root,
157 int (*visitor)(struct wim_dentry*, void*),
160 /* Iterate through each @child dentry of the @dir directory inode,
161 * in sorted order (by case sensitive name). */
162 #define for_inode_child(child, dir) \
163 avl_tree_for_each_in_order((child), (dir)->i_children, \
164 struct wim_dentry, d_index_node)
166 /* Iterate through each @child dentry of the @parent dentry,
167 * in sorted order (by case sensitive name). */
168 #define for_dentry_child(child, parent) \
169 for_inode_child((child), (parent)->d_inode)
171 /* Iterate through each @child dentry of the @dir directory inode,
172 * in postorder (safe for freeing the child dentries). */
173 #define for_inode_child_postorder(child, dir) \
174 avl_tree_for_each_in_postorder((child), (dir)->i_children, \
175 struct wim_dentry, d_index_node)
177 /* Iterate through each @child dentry of the @parent dentry,
178 * in postorder (safe for freeing the child dentries). */
179 #define for_dentry_child_postorder(child, parent) \
180 for_inode_child_postorder((child), (parent)->d_inode)
182 /* Get any child dentry of the @dir directory inode. Requires
183 * inode_has_children(@dir) == true. */
184 #define inode_any_child(dir) \
185 avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
187 /* Get any child dentry of the @parent dentry. Requires
188 * dentry_has_children(@parent) == true. */
189 #define dentry_any_child(parent) \
190 inode_any_child((parent)->d_inode)
193 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
196 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
199 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name,
200 size_t new_name_nbytes);
202 extern struct wim_dentry *
203 get_dentry(struct WIMStruct *wim, const tchar *path,
204 CASE_SENSITIVITY_TYPE case_type);
206 extern struct wim_dentry *
207 get_dentry_child_with_name(const struct wim_dentry *dentry,
209 CASE_SENSITIVITY_TYPE case_type);
211 extern struct wim_dentry *
212 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
213 const utf16lechar *name,
215 CASE_SENSITIVITY_TYPE case_type);
217 extern struct wim_dentry *
218 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
219 CASE_SENSITIVITY_TYPE case_type);
223 #define LOOKUP_FLAG_ADS_OK 0x00000001
224 #define LOOKUP_FLAG_DIRECTORY_OK 0x00000002
227 wim_pathname_to_stream(WIMStruct *wim,
230 struct wim_dentry **dentry_ret,
231 struct wim_lookup_table_entry **lte_ret,
232 u16 *stream_idx_ret);
236 calculate_dentry_full_path(struct wim_dentry *dentry);
239 dentry_full_path(struct wim_dentry *dentry);
242 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
245 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
248 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
251 dentry_tree_clear_inode_visited(struct wim_dentry *root);
254 new_filler_directory(struct wim_dentry **dentry_ret);
257 free_dentry(struct wim_dentry *dentry);
260 free_dentry_tree(struct wim_dentry *root,
261 struct wim_lookup_table *lookup_table);
264 unlink_dentry(struct wim_dentry *dentry);
266 extern struct wim_dentry *
267 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child);
269 struct update_command_journal;
272 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
273 CASE_SENSITIVITY_TYPE case_type,
274 struct update_command_journal *j);
278 read_dentry_tree(const u8 *buf, size_t buf_len,
279 u64 root_offset, struct wim_dentry **root_ret);
282 write_dentry_tree(struct wim_dentry *root, u8 *p);
285 dentry_is_root(const struct wim_dentry *dentry)
287 return dentry->d_parent == dentry;
291 dentry_is_directory(const struct wim_dentry *dentry)
293 return inode_is_directory(dentry->d_inode);
297 dentry_has_children(const struct wim_dentry *dentry)
299 return inode_has_children(dentry->d_inode);
303 dentry_has_short_name(const struct wim_dentry *dentry)
305 return dentry->short_name_nbytes != 0;
309 dentry_has_long_name(const struct wim_dentry *dentry)
311 return dentry->file_name_nbytes != 0;
313 #endif /* _WIMLIB_DENTRY_H */