Limit exposure of dentry and inode creation
[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 dentries.
25  * The hard link group ID field of the on-disk WIM dentry tells us the number of
26  * the NTFS inode that the dentry corresponds to (and this gets placed in
27  * 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 file
31  * streams is replicated in each hard-linked dentry, even though this
32  * information really is associated with an inode.  In-memory, we fix up this
33  * flaw by allocating a `struct wim_inode' for each dentry that contains some of
34  * this duplicated information, then combining the inodes for each hard link
35  * group together.
36  *
37  * Confusingly, it's possible for stream information to be missing from a dentry
38  * in a hard link set, in which case the stream information needs to be gotten
39  * from one of the other dentries in the hard link set.  In addition, it is
40  * possible for dentries to have inconsistent security IDs, file attributes, or
41  * file streams when they share the same hard link ID (don't even ask.  I hope
42  * that Microsoft may have fixed this problem, since I've only noticed it in the
43  * 'install.wim' for Windows 7).  For those dentries, we have to use the
44  * conflicting fields to split up the hard link groups.  (See
45  * dentry_tree_fix_inodes() in inode_fixup.c.)
46  */
47 struct wim_dentry {
48         /* Pointer to the inode for this dentry.  This will contain some
49          * information that was factored out of the on-disk WIM dentry as common
50          * to all dentries in a hard link group.  */
51         struct wim_inode *d_inode;
52
53         /* Node for the parent's balanced binary search tree of child dentries
54          * sorted by case sensitive long name (root i_children).  */
55         struct avl_tree_node d_index_node;
56
57         /* Node for the parent's balanced binary search tree of child dentries,
58          * sorted by case insensitive long name (root i_children_ci). */
59         struct avl_tree_node d_index_node_ci;
60
61         /* List of dentries in a directory that have different case sensitive
62          * long names but share the same case insensitive long name.  */
63         struct list_head d_ci_conflict_list;
64
65         /* The parent of this directory entry. (The root is its own parent.)  */
66         struct wim_dentry *d_parent;
67
68         /* Linked list node that places this dentry in the list of aliases for
69          * its inode (d_inode) */
70         struct list_head d_alias;
71
72         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
73          * if this dentry has no short name.  */
74         utf16lechar *short_name;
75
76         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
77          * dentry has no filename.  */
78         utf16lechar *file_name;
79
80         /* Length of UTF-16LE encoded short filename, in bytes, not including
81          * the terminating zero wide-character. */
82         u16 short_name_nbytes;
83
84         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
85          * the terminating null character. */
86         u16 file_name_nbytes;
87
88         /* When capturing from an NTFS volume using NTFS-3g, this flag is set on
89          * dentries that were created from a filename in the WIN32 or WIN32+DOS
90          * namespaces rather than the POSIX namespace.  Otherwise this will
91          * always be 0.  */
92         u8 is_win32_name : 1;
93
94         /* Temporary flag; always reset to 0 when done using.  */
95         u8 tmp_flag : 1;
96
97         /* Used by wimlib_update_image()  */
98         u8 is_orphan : 1;
99
100         union {
101                 /* 'subdir_offset' is only used while reading and writing this
102                  * dentry.  See the corresponding field in `struct
103                  * wim_dentry_on_disk' for explanation.  */
104                 u64 subdir_offset;
105
106                 /* Temporary list field  */
107                 struct list_head tmp_list;
108         };
109
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.  */
114         tchar *_full_path;
115
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;
121
122         /* (Extraction only) Number of characters in d_extraction_name.  */
123         size_t d_extraction_name_nchars;
124
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;
128
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;
133 };
134
135 static inline bool
136 dentry_is_first_in_inode(const struct wim_dentry *dentry)
137 {
138         return inode_first_dentry(dentry->d_inode) == dentry;
139 }
140
141 static inline bool
142 will_extract_dentry(const struct wim_dentry *dentry)
143 {
144         return dentry->d_extraction_list_node.next != NULL;
145 }
146
147 extern size_t
148 dentry_out_total_length(const struct wim_dentry *dentry);
149
150 extern int
151 for_dentry_in_tree(struct wim_dentry *root,
152                    int (*visitor)(struct wim_dentry*, void*),
153                    void *args);
154
155 /* Iterate through each @child dentry of the @dir directory inode,
156  * in sorted order by case sensitive name.  */
157 #define for_inode_child(child, dir)                                     \
158         avl_tree_for_each_in_order((child), (dir)->i_children,          \
159                                    struct wim_dentry, d_index_node)
160
161 /* Iterate through each @child dentry of the @parent dentry,
162  * in sorted order by case sensitive name.  */
163 #define for_dentry_child(child, parent) \
164         for_inode_child((child), (parent)->d_inode)
165
166 /* Iterate through each @child dentry of the @dir directory inode,
167  * in sorted order by case insensitive name.  */
168 #define for_inode_child_case_insensitive(child, dir)                    \
169         avl_tree_for_each_in_order((child), (dir)->i_children_ci,       \
170                                    struct wim_dentry, d_index_node_ci)
171
172 /* Iterate through each @child dentry of the @parent dentry,
173  * in sorted order by case insensitive name.  */
174 #define for_dentry_child_case_insensitive(child, parent) \
175         for_inode_child_case_insensitive((child), (parent)->d_inode)
176
177 /* Iterate through each @child dentry of the @dir directory inode,
178  * in postorder (safe for freeing the child dentries).  */
179 #define for_inode_child_postorder(child, dir)                           \
180         avl_tree_for_each_in_postorder((child), (dir)->i_children,      \
181                                        struct wim_dentry, d_index_node)
182
183 /* Iterate through each @child dentry of the @parent dentry,
184  * in postorder (safe for freeing the child dentries).  */
185 #define for_dentry_child_postorder(child, parent) \
186         for_inode_child_postorder((child), (parent)->d_inode)
187
188 /* Get any child dentry of the @dir directory inode.  Requires
189  * inode_has_children(@dir) == true.  */
190 #define inode_any_child(dir)    \
191         avl_tree_entry((dir)->i_children, struct wim_dentry, d_index_node)
192
193 /* Get any child dentry of the @parent dentry.  Requires
194  * dentry_has_children(@parent) == true.  */
195 #define dentry_any_child(parent) \
196         inode_any_child((parent)->d_inode)
197
198 extern void
199 calculate_subdir_offsets(struct wim_dentry *root, u64 *subdir_offset_p);
200
201 extern int
202 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
203
204 extern int
205 dentry_set_name_utf16le(struct wim_dentry *dentry, const utf16lechar *new_name,
206                         size_t new_name_nbytes);
207
208 extern struct wim_dentry *
209 get_dentry(struct WIMStruct *wim, const tchar *path,
210            CASE_SENSITIVITY_TYPE case_type);
211
212 extern struct wim_dentry *
213 get_dentry_child_with_name(const struct wim_dentry *dentry,
214                            const tchar *name,
215                            CASE_SENSITIVITY_TYPE case_type);
216
217 extern struct wim_dentry *
218 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
219                                    const utf16lechar *name,
220                                    size_t name_nbytes,
221                                    CASE_SENSITIVITY_TYPE case_type);
222
223 extern struct wim_dentry *
224 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
225                   CASE_SENSITIVITY_TYPE case_type);
226
227 extern int
228 calculate_dentry_full_path(struct wim_dentry *dentry);
229
230 extern tchar *
231 dentry_full_path(struct wim_dentry *dentry);
232
233 extern int
234 new_dentry_with_new_inode(const tchar *name, bool set_timestamps,
235                           struct wim_dentry **dentry_ret);
236
237 extern int
238 new_dentry_with_existing_inode(const tchar *name, struct wim_inode *inode,
239                                struct wim_dentry **dentry_ret);
240
241 extern void
242 dentry_tree_clear_inode_visited(struct wim_dentry *root);
243
244 extern int
245 new_filler_directory(struct wim_dentry **dentry_ret);
246
247 extern void
248 free_dentry(struct wim_dentry *dentry);
249
250 extern void
251 free_dentry_tree(struct wim_dentry *root,
252                  struct blob_table *blob_table);
253
254 extern void
255 unlink_dentry(struct wim_dentry *dentry);
256
257 extern struct wim_dentry *
258 dentry_add_child(struct wim_dentry *parent, struct wim_dentry *child);
259
260 struct update_command_journal;
261
262 extern int
263 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
264                 CASE_SENSITIVITY_TYPE case_type,
265                 struct update_command_journal *j);
266
267
268 extern int
269 read_dentry_tree(const u8 *buf, size_t buf_len,
270                  u64 root_offset, struct wim_dentry **root_ret);
271
272 extern u8 *
273 write_dentry_tree(struct wim_dentry *root, u8 *p);
274
275 static inline bool
276 dentry_is_root(const struct wim_dentry *dentry)
277 {
278         return dentry->d_parent == dentry;
279 }
280
281 static inline bool
282 dentry_is_directory(const struct wim_dentry *dentry)
283 {
284         return inode_is_directory(dentry->d_inode);
285 }
286
287 static inline bool
288 dentry_has_children(const struct wim_dentry *dentry)
289 {
290         return inode_has_children(dentry->d_inode);
291 }
292
293 static inline bool
294 dentry_has_short_name(const struct wim_dentry *dentry)
295 {
296         return dentry->short_name_nbytes != 0;
297 }
298
299 static inline bool
300 dentry_has_long_name(const struct wim_dentry *dentry)
301 {
302         return dentry->file_name_nbytes != 0;
303 }
304 #endif /* _WIMLIB_DENTRY_H */