Don't use entire word for d_extraction_name_nchars
[wimlib] / 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 blob_table;
13
14 /* Base size of a WIM dentry in the on-disk format, up to and including the file
15  * name length.  This does not include the variable-length file name, short
16  * name, extra stream entries, and padding to 8-byte boundaries.  */
17 #define WIM_DENTRY_DISK_SIZE 102
18
19 /*
20  * In-memory structure for a WIM directory entry (dentry).  There is a directory
21  * tree for each image in the WIM.
22  *
23  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
24  * links, it's possible for an NTFS inode to correspond to multiple WIM
25  * dentries.  The hard link group ID field of the on-disk WIM dentry tells us
26  * the number of the NTFS inode that the dentry corresponds to (and this gets
27  * placed in d_inode->i_ino).
28  *
29  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
30  * information, such as file attributes, the security descriptor, and streams is
31  * replicated in each hard-linked dentry, even though this information really is
32  * associated with an inode.  In-memory, we fix up this flaw by allocating a
33  * `struct wim_inode' for each dentry that contains some of this duplicated
34  * information, then combining the inodes for each hard link group together.
35  * (See dentry_tree_fix_inodes().)
36  */
37 struct wim_dentry {
38         /* Pointer to the inode for this dentry.  This will contain some
39          * information that was factored out of the on-disk WIM dentry as common
40          * to all dentries in a hard link group.  */
41         struct wim_inode *d_inode;
42
43         /* Node for the parent's balanced binary search tree of child dentries
44          * sorted by case sensitive long name (root i_children).  */
45         struct avl_tree_node d_index_node;
46
47         /* Node for the parent's balanced binary search tree of child dentries,
48          * sorted by case insensitive long name (root i_children_ci). */
49         struct avl_tree_node d_index_node_ci;
50
51         /* List of dentries in a directory that have different case sensitive
52          * long names but share the same case insensitive long name.  */
53         struct list_head d_ci_conflict_list;
54
55         /* The parent of this directory entry. (The root is its own parent.)  */
56         struct wim_dentry *d_parent;
57
58         /* Linked list node that places this dentry in the list of aliases for
59          * its inode (d_inode) */
60         struct hlist_node d_alias_node;
61
62         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
63          * dentry has no filename.  */
64         utf16lechar *d_name;
65
66         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
67          * if this dentry has no short name.  */
68         utf16lechar *d_short_name;
69
70         /* Length of 'd_name' in bytes, excluding the terminating null  */
71         u16 d_name_nbytes;
72
73         /* Length of 'd_short_name' in bytes, excluding the terminating null  */
74         u16 d_short_name_nbytes;
75
76         /* (Extraction only) Length of 'd_extraction_name' in _characters_,
77          * excluding the terminating null  */
78         u16 d_extraction_name_nchars;
79
80         /* When capturing from an NTFS volume using NTFS-3g, this flag is set on
81          * dentries that were created from a filename in the WIN32 or WIN32+DOS
82          * namespaces rather than the POSIX namespace.  Otherwise this will
83          * always be 0.  */
84         u16 d_is_win32_name : 1;
85
86         /* Temporary flag; always reset to 0 when done using.  */
87         u16 d_tmp_flag : 1;
88
89         /* Used by wimlib_update_image()  */
90         u16 d_is_orphan : 1;
91
92         union {
93                 /* The subdir offset is only used while reading and writing this
94                  * dentry.  See the corresponding field in `struct
95                  * wim_dentry_on_disk' for explanation.  */
96                 u64 d_subdir_offset;
97
98                 /* Temporary list field  */
99                 struct list_head d_tmp_list;
100         };
101
102         /* Full path to this dentry in the WIM, in platform-dependent tchars
103          * that can be printed without conversion.  By default this field will
104          * be NULL and will only be calculated on-demand by the
105          * calculate_dentry_full_path() or dentry_full_path() functions.  */
106         tchar *d_full_path;
107
108         /* (Extraction only) Actual name to extract this dentry as.  This may be
109          * either in 'tchars' or in 'utf16lechars', depending on what encoding
110          * the extraction backend needs.  This may alias 'd_name'.  If it
111          * doesn't, it is an allocated buffer which must be freed.  */
112         void *d_extraction_name;
113
114         /* (Extraction only) Linked list node that connects all dentries being
115          * extracted as part of the current extraction operation.  */
116         struct list_head d_extraction_list_node;
117
118         /* (Extraction only) Pointer to the next alias of this dentry's inode
119          * that needs to be extracted as part of the current extraction
120          * operation, or NULL if this is the last alias.  */
121         struct wim_dentry *d_next_extraction_alias;
122 };
123
124 static inline bool
125 will_extract_dentry(const struct wim_dentry *dentry)
126 {
127         return dentry->d_extraction_list_node.next != NULL;
128 }
129
130 extern size_t
131 dentry_out_total_length(const struct wim_dentry *dentry);
132
133 extern int
134 for_dentry_in_tree(struct wim_dentry *root,
135                    int (*visitor)(struct wim_dentry*, void*),
136                    void *args);
137
138 /* Iterate through each @child dentry of the @dir directory inode,
139  * in sorted order by case sensitive name.  */
140 #define for_inode_child(child, dir)                                     \
141         avl_tree_for_each_in_order((child), (dir)->i_children,          \
142                                    struct wim_dentry, d_index_node)
143
144 /* Iterate through each @child dentry of the @parent dentry,
145  * in sorted order by case sensitive name.  */
146 #define for_dentry_child(child, parent) \
147         for_inode_child((child), (parent)->d_inode)
148
149 /* Iterate through each @child dentry of the @dir directory inode,
150  * in sorted order by case insensitive name.  */
151 #define for_inode_child_case_insensitive(child, dir)                    \
152         avl_tree_for_each_in_order((child), (dir)->i_children_ci,       \
153                                    struct wim_dentry, d_index_node_ci)
154
155 /* Iterate through each @child dentry of the @parent dentry,
156  * in sorted order by case insensitive name.  */
157 #define for_dentry_child_case_insensitive(child, parent) \
158         for_inode_child_case_insensitive((child), (parent)->d_inode)
159
160 /* Iterate through each @child dentry of the @dir directory inode,
161  * in postorder (safe for freeing the child dentries).  */
162 #define for_inode_child_postorder(child, dir)                           \
163         avl_tree_for_each_in_postorder((child), (dir)->i_children,      \
164                                        struct wim_dentry, d_index_node)
165
166 /* Iterate through each @child dentry of the @parent dentry,
167  * in postorder (safe for freeing the child dentries).  */
168 #define for_dentry_child_postorder(child, parent) \
169         for_inode_child_postorder((child), (parent)->d_inode)
170
171 /* Get any child dentry of the @dir directory inode.  Requires
172  * inode_has_children(@dir) == true.  */
173 #define inode_any_child(dir)    \
174         avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
175
176 /* Get any child dentry of the @parent dentry.  Requires
177  * dentry_has_children(@parent) == true.  */
178 #define dentry_any_child(parent) \
179         inode_any_child((parent)->d_inode)
180
181 extern void
182 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
183
184 extern int
185 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
186
187 extern int
188 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name,
189                         size_t new_name_nbytes);
190
191 extern struct wim_dentry *
192 get_dentry(struct WIMStruct *wim, const tchar *path,
193            CASE_SENSITIVITY_TYPE case_type);
194
195 extern struct wim_dentry *
196 get_dentry_child_with_name(const struct wim_dentry *dentry,
197                            const tchar *name,
198                            CASE_SENSITIVITY_TYPE case_type);
199
200 extern struct wim_dentry *
201 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
202                                    const utf16lechar *name,
203                                    size_t name_nbytes,
204                                    CASE_SENSITIVITY_TYPE case_type);
205
206 extern struct wim_dentry *
207 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
208                   CASE_SENSITIVITY_TYPE case_type);
209
210 extern int
211 calculate_dentry_full_path(struct wim_dentry *dentry);
212
213 extern tchar *
214 dentry_full_path(struct wim_dentry *dentry);
215
216 extern int
217 new_dentry_with_new_inode(const tchar *name, bool set_timestamps,
218                           struct wim_dentry **dentry_ret);
219
220 extern int
221 new_dentry_with_existing_inode(const tchar *name, struct wim_inode *inode,
222                                struct wim_dentry **dentry_ret);
223
224 extern void
225 dentry_tree_clear_inode_visited(struct wim_dentry *root);
226
227 extern int
228 new_filler_directory(struct wim_dentry **dentry_ret);
229
230 extern void
231 free_dentry(struct wim_dentry *dentry);
232
233 extern void
234 free_dentry_tree(struct wim_dentry *root,
235                  struct blob_table *blob_table);
236
237 extern void
238 unlink_dentry(struct wim_dentry *dentry);
239
240 extern struct wim_dentry *
241 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child);
242
243 struct update_command_journal;
244
245 extern int
246 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
247                 CASE_SENSITIVITY_TYPE case_type,
248                 struct update_command_journal *j);
249
250
251 extern int
252 read_dentry_tree(const u8 *buf, size_t buf_len,
253                  u64 root_offset, struct wim_dentry **root_ret);
254
255 extern u8 *
256 write_dentry_tree(struct wim_dentry *root, u8 *p);
257
258 static inline bool
259 dentry_is_root(const struct wim_dentry *dentry)
260 {
261         return dentry->d_parent == dentry;
262 }
263
264 static inline bool
265 dentry_is_directory(const struct wim_dentry *dentry)
266 {
267         return inode_is_directory(dentry->d_inode);
268 }
269
270 static inline bool
271 dentry_has_children(const struct wim_dentry *dentry)
272 {
273         return inode_has_children(dentry->d_inode);
274 }
275
276 static inline bool
277 dentry_has_long_name(const struct wim_dentry *dentry)
278 {
279         return dentry->d_name_nbytes != 0;
280 }
281
282 static inline bool
283 dentry_has_short_name(const struct wim_dentry *dentry)
284 {
285         return dentry->d_short_name_nbytes != 0;
286 }
287 #endif /* _WIMLIB_DENTRY_H */