extract.c: Store dentries to extract in list
[wimlib] / 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         /* These correspond to the two unused fields in the on-disk WIM dentry;
116          * we read them into memory so we can write them unchanged.  These
117          * fields are set to 0 on new dentries.  */
118         u64 d_unused_1;
119         u64 d_unused_2;
120
121         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
122          * if this dentry has no short name.  */
123         utf16lechar *short_name;
124
125         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
126          * dentry has no filename.  */
127         utf16lechar *file_name;
128
129         /* Full path to this dentry in the WIM, in platform-dependent tchars
130          * that can be printed without conversion.  By default this field will
131          * be NULL and will only be calculated on-demand by the
132          * calculate_dentry_full_path() or dentry_full_path() functions.  */
133         tchar *_full_path;
134
135         /* (Extraction only) Actual name to extract this dentry as, along with
136          * its length in tchars excluding the NULL terminator.  This usually
137          * will be the same as file_name, with the character encoding converted
138          * if needed.  But if file_name contains characters not accepted on the
139          * current platform, then this may be set slightly differently from
140          * file_name.  This will be either NULL or a malloc()ed buffer that may
141          * alias file_name.  */
142         tchar *extraction_name;
143         size_t extraction_name_nchars;
144 };
145
146 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
147
148 static inline bool
149 dentry_is_first_in_inode(const struct wim_dentry *dentry)
150 {
151         return inode_first_dentry(dentry->d_inode) == dentry;
152 }
153
154 extern u64
155 dentry_out_total_length(const struct wim_dentry *dentry);
156
157 extern int
158 for_dentry_in_tree(struct wim_dentry *root,
159                    int (*visitor)(struct wim_dentry*, void*),
160                    void *args);
161
162 extern int
163 for_dentry_in_rbtree(struct rb_node *node,
164                      int (*visitor)(struct wim_dentry *, void *),
165                      void *arg);
166
167 extern int
168 for_dentry_child(const struct wim_dentry *dentry,
169                  int (*visitor)(struct wim_dentry *, void *),
170                  void *arg);
171
172 extern int
173 for_dentry_in_tree_depth(struct wim_dentry *root,
174                          int (*visitor)(struct wim_dentry*, void*),
175                          void *args);
176
177 extern void
178 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
179
180 extern int
181 dentry_set_name(struct wim_dentry *dentry, const tchar *new_name);
182
183 extern struct wim_dentry *
184 get_dentry(struct WIMStruct *wim, const tchar *path,
185            CASE_SENSITIVITY_TYPE case_type);
186
187 extern struct wim_dentry *
188 get_dentry_child_with_name(const struct wim_dentry *dentry,
189                            const tchar *name,
190                            CASE_SENSITIVITY_TYPE case_type);
191
192 extern struct wim_dentry *
193 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
194                                    const utf16lechar *name,
195                                    size_t name_nbytes,
196                                    CASE_SENSITIVITY_TYPE case_type);
197
198 extern struct wim_dentry *
199 get_parent_dentry(struct WIMStruct *wim, const tchar *path,
200                   CASE_SENSITIVITY_TYPE case_type);
201
202 #ifdef WITH_FUSE
203
204 #define LOOKUP_FLAG_ADS_OK              0x00000001
205 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
206
207 extern int
208 wim_pathname_to_stream(WIMStruct *wim,
209                        const tchar *path,
210                        int lookup_flags,
211                        struct wim_dentry **dentry_ret,
212                        struct wim_lookup_table_entry **lte_ret,
213                        u16 *stream_idx_ret);
214 #endif
215
216 extern int
217 calculate_dentry_full_path(struct wim_dentry *dentry);
218
219 extern int
220 calculate_dentry_tree_full_paths(struct wim_dentry *root);
221
222 extern tchar *
223 dentry_full_path(struct wim_dentry *dentry);
224
225 extern int
226 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
227
228 extern int
229 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
230
231 extern int
232 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
233
234 extern void
235 dentry_tree_clear_inode_visited(struct wim_dentry *root);
236
237 extern int
238 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
239
240 extern void
241 free_dentry(struct wim_dentry *dentry);
242
243 extern void
244 put_dentry(struct wim_dentry *dentry);
245
246 extern void
247 free_dentry_tree(struct wim_dentry *root,
248                  struct wim_lookup_table *lookup_table);
249
250 extern void
251 unlink_dentry(struct wim_dentry *dentry);
252
253 extern struct wim_dentry *
254 dentry_add_child(struct wim_dentry * restrict parent,
255                  struct wim_dentry * restrict child);
256
257 extern int
258 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
259                 CASE_SENSITIVITY_TYPE case_type);
260
261
262 extern int
263 read_dentry_tree(const u8 *buf, size_t buf_len,
264                  u64 root_offset, struct wim_dentry **root_ret);
265
266 extern u8 *
267 write_dentry_tree(const struct wim_dentry * restrict tree,
268                   u8 * restrict p);
269
270 static inline bool
271 dentry_is_root(const struct wim_dentry *dentry)
272 {
273         return dentry->parent == dentry;
274 }
275
276 static inline bool
277 dentry_is_directory(const struct wim_dentry *dentry)
278 {
279         return inode_is_directory(dentry->d_inode);
280 }
281
282 static inline bool
283 dentry_has_children(const struct wim_dentry *dentry)
284 {
285         return inode_has_children(dentry->d_inode);
286 }
287
288 static inline bool
289 dentry_has_short_name(const struct wim_dentry *dentry)
290 {
291         return dentry->short_name_nbytes != 0;
292 }
293
294 static inline bool
295 dentry_has_long_name(const struct wim_dentry *dentry)
296 {
297         return dentry->file_name_nbytes != 0;
298 }
299
300 extern int
301 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
302 #endif /* _WIMLIB_DENTRY_H */