Store dentry children in red-black trees
[wimlib] / src / dentry.h
1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
3
4 #include "util.h"
5 #include "config.h"
6 #include "list.h"
7 #include "sha1.h"
8 #include "rbtree.h"
9 #include <string.h>
10
11 struct stat;
12 struct lookup_table;
13 struct WIMStruct;
14 struct lookup_table_entry;
15 struct wimlib_fd;
16 struct inode;
17 struct dentry;
18
19 /* Size of the struct dentry up to and including the file_name_len. */
20 #define WIM_DENTRY_DISK_SIZE    102
21
22 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
23  * including the stream length field (see below). */
24 #define WIM_ADS_ENTRY_DISK_SIZE 38
25
26 /*
27  * Reparse tags documented at
28  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
29  */
30 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
31 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
32 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
33 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
34 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
35 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
36 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
37 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
38 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
39 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
40 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
41
42 #define FILE_ATTRIBUTE_READONLY            0x00000001
43 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
44 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
45 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
46 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
47 #define FILE_ATTRIBUTE_DEVICE              0x00000040
48 #define FILE_ATTRIBUTE_NORMAL              0x00000080
49 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
50 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
51 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
52 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
53 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
54 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
55 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
56 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
57
58
59 /* Alternate data stream entry.
60  *
61  * We read this from disk in the read_ads_entries() function; see that function
62  * for more explanation. */
63 struct ads_entry {
64         union {
65                 /* SHA-1 message digest of stream contents */
66                 u8 hash[SHA1_HASH_SIZE];
67
68                 /* The corresponding lookup table entry (only for resolved
69                  * streams) */
70                 struct lookup_table_entry *lte;
71         };
72
73         /* Length of stream name (UTF-16).  This is in bytes, not characters,
74          * and does not include the terminating null character   */
75         u16 stream_name_len;
76
77         /* Length of stream name (UTF-8) */
78         u16 stream_name_utf8_len;
79
80         /* Stream name (UTF-16) */
81         char *stream_name;
82
83         /* Stream name (UTF-8) */
84         char *stream_name_utf8;
85
86 #ifdef WITH_FUSE
87         /* Number to identify an alternate data stream even after it's possibly
88          * been moved or renamed. */
89         u32 stream_id;
90 #endif
91 };
92
93
94 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
95                                               const struct ads_entry *entry_2)
96 {
97         if (entry_1->stream_name_len != entry_2->stream_name_len)
98                 return false;
99         return memcmp(entry_1->stream_name, entry_2->stream_name,
100                       entry_1->stream_name_len) == 0;
101 }
102
103 /*
104  * In-memory structure for a WIM directory entry (dentry).  There is a directory
105  * tree for each image in the WIM.
106  *
107  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
108  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
109  * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
110  * inode that the dentry corresponds to.
111  *
112  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
113  * information, such as file attributes, the security descriptor, and file
114  * streams is replicated in each hard-linked dentry, even though this
115  * information really is associated with an inode.  In-memory, we fix up this
116  * flaw by allocating a `struct inode' for each dentry that contains some of
117  * this duplicated information, then combining the inodes for each hard link
118  * group together.
119  *
120  * Confusingly, it's possible for stream information to be missing from a dentry
121  * in a hard link set, in which case the stream information needs to be gotten
122  * from one of the other dentries in the hard link set.  In addition, it is
123  * possible for dentries to have inconsistent security IDs, file attributes, or
124  * file streams when they share the same hard link ID (don't even ask.  I hope
125  * that Microsoft may have fixed this problem, since I've only noticed it in the
126  * 'install.wim' for Windows 7).  For those dentries, we have to use the
127  * conflicting fields to split up the hard link groups.  (See fix_inodes() in
128  * hardlink.c).
129  */
130 struct dentry {
131         /* The inode for this dentry */
132         struct inode *d_inode;
133
134         /* The parent of this directory entry. */
135         struct dentry *parent;
136
137         struct rb_node rb_node;
138
139         /*
140          * Size of directory entry on disk, in bytes.  Typical size is around
141          * 104 to 120 bytes.
142          *
143          * It is possible for the length field to be 0.  This situation, which
144          * is undocumented, indicates the end of a list of sibling nodes in a
145          * directory.  It also means the real length is 8, because the dentry
146          * included only the length field, but that takes up 8 bytes.
147          *
148          * The length here includes the base directory entry on disk as well as
149          * the long and short filenames.  It does NOT include any alternate
150          * stream entries that may follow the directory entry, even though the
151          * size of those needs to be considered.  The length SHOULD be 8-byte
152          * aligned, although we don't require it to be.  We do require the
153          * length to be large enough to hold the file name(s) of the dentry;
154          * additionally, a warning is issued if this field is larger than the
155          * aligned size.
156          */
157         u64 length;
158
159         /* The offset, from the start of the uncompressed WIM metadata resource
160          * for this image, of this dentry's child dentries.  0 if the directory
161          * entry has no children, which is the case for regular files or reparse
162          * points. */
163         u64 subdir_offset;
164
165         /* Length of short filename, in bytes, not including the terminating
166          * zero wide-character. */
167         u16 short_name_len;
168
169         /* Length of file name, in bytes, not including the terminating zero
170          * wide-character. */
171         u16 file_name_len;
172
173         /* Length of the filename converted into UTF-8, in bytes, not including
174          * the terminating zero byte. */
175         u16 file_name_utf8_len;
176
177         /* Pointer to the short filename (malloc()ed buffer) */
178         char *short_name;
179
180         /* Pointer to the filename (malloc()ed buffer). */
181         char *file_name;
182
183         /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
184         char *file_name_utf8;
185
186         /* Full path to this dentry (malloc()ed buffer). */
187         char *full_path_utf8;
188         u32   full_path_utf8_len;
189
190         /* Number of references to the dentry tree itself, as in multiple
191          * WIMStructs */
192         u32 refcnt;
193
194         /* List of dentries in the inode (hard link set)  */
195         struct list_head inode_dentry_list;
196
197         union {
198                 struct list_head tmp_list;
199                 bool is_extracted;
200         };
201 };
202
203 #define rbnode_dentry(node) container_of(node, struct dentry, rb_node)
204
205 /*
206  * WIM inode.
207  *
208  * As mentioned above, in the WIM file that is no on-disk analogue of a real
209  * inode, as most of these fields are duplicated in the dentries.
210  */
211 struct inode {
212         /* Timestamps for the inode.  The timestamps are the number of
213          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
214          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
215         u64 creation_time;
216         u64 last_access_time;
217         u64 last_write_time;
218
219         /* The file attributes associated with this inode.  This is a bitwise OR
220          * of the FILE_ATTRIBUTE_* flags. */
221         u32 attributes;
222
223         /* The index of the security descriptor in the WIM image's table of
224          * security descriptors that contains this file's security information.
225          * If -1, no security information exists for this file.  */
226         int32_t security_id;
227
228         /* %true iff the inode's lookup table entries has been resolved (i.e.
229          * the @lte field is valid, but the @hash field is not valid)
230          *
231          * (This is not an on-disk field.) */
232         u8 resolved : 1;
233
234         /* %true iff verify_inode() has run on this dentry. */
235         u8 verified : 1;
236
237         /* Number of alternate data streams associated with this inode */
238         u16 num_ads;
239
240         /* A hash of the file's contents, or a pointer to the lookup table entry
241          * for this dentry if the lookup table entries have been resolved.
242          *
243          * More specifically, this is for the un-named default file stream, as
244          * opposed to the alternate (named) file streams, which may have their
245          * own lookup table entries.  */
246         union {
247                 u8 hash[SHA1_HASH_SIZE];
248                 struct lookup_table_entry *lte;
249         };
250
251         /* Identity of a reparse point.  See
252          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
253          * for what a reparse point is. */
254         u32 reparse_tag;
255
256         /* Number of dentries that reference this inode */
257         u32 link_count;
258
259         /* Alternate data stream entries. */
260         struct ads_entry *ads_entries;
261
262         /* Inode number */
263         u64 ino;
264
265         /* List of dentries that reference this inode (there should be
266          * link_count of them) */
267         struct list_head dentry_list;
268         struct hlist_node hlist;
269         char *extracted_file;
270
271         /* Root of a red-black tree storing the children of this inode (if
272          * non-empty, implies the inode is a directory, although that is also
273          * noted in the @attributes field.) */
274         struct rb_root children;
275
276 #ifdef WITH_FUSE
277         /* wimfs file descriptors table for the inode */
278         u16 num_opened_fds;
279         u16 num_allocated_fds;
280         struct wimlib_fd **fds;
281
282         /* Next alternate data stream ID to be assigned */
283         u32 next_stream_id;
284 #endif
285 };
286
287 #define inode_for_each_dentry(dentry, inode) \
288                 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
289
290 #define inode_add_dentry(dentry, inode) \
291         ({                                                              \
292                 wimlib_assert((inode)->dentry_list.next != NULL);               \
293                 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list);  \
294         })
295
296 static inline bool dentry_is_extracted(const struct dentry *dentry)
297 {
298         return dentry->is_extracted;
299 }
300
301 static inline bool dentry_is_first_in_inode(const struct dentry *dentry)
302 {
303         return container_of(dentry->d_inode->dentry_list.next,
304                             struct dentry,
305                             inode_dentry_list) == dentry;
306 }
307
308 extern u64 dentry_correct_total_length(const struct dentry *dentry);
309
310 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
311 extern int inode_to_stbuf(const struct inode *inode,
312                           struct lookup_table_entry *lte, struct stat *stbuf);
313
314 extern int for_dentry_in_tree(struct dentry *root,
315                               int (*visitor)(struct dentry*, void*),
316                               void *args);
317
318 extern int for_dentry_in_rbtree(struct rb_node *node,
319                                 int (*visitor)(struct dentry *, void *),
320                                 void *arg);
321
322 extern int for_dentry_in_tree_depth(struct dentry *root,
323                                     int (*visitor)(struct dentry*, void*),
324                                     void *args);
325
326 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
327 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
328 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
329                      u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
330                      const char *name);
331
332 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
333 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
334                                            const char *path);
335 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
336                                                  const char *name);
337 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
338
339 extern int print_dentry(struct dentry *dentry, void *lookup_table);
340 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
341
342 extern struct dentry *new_dentry(const char *name);
343 extern struct dentry *new_dentry_with_inode(const char *name);
344 extern struct dentry *new_dentry_with_timeless_inode(const char *name);
345
346 extern void free_inode(struct inode *inode);
347 extern void free_dentry(struct dentry *dentry);
348 extern void put_dentry(struct dentry *dentry);
349
350 extern void free_dentry_tree(struct dentry *root,
351                              struct lookup_table *lookup_table);
352 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
353
354 extern void unlink_dentry(struct dentry *dentry);
355 extern bool dentry_add_child(struct dentry * restrict parent,
356                              struct dentry * restrict child);
357
358 // XXX
359 #define link_dentry(child, parent) dentry_add_child(parent, child)
360
361 extern int verify_dentry(struct dentry *dentry, void *wim);
362
363
364 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
365                                              const char *stream_name,
366                                              u16 *idx_ret);
367 extern struct ads_entry *inode_add_ads(struct inode *dentry,
368                                        const char *stream_name);
369
370 extern void inode_remove_ads(struct inode *inode, u16 idx,
371                              struct lookup_table *lookup_table);
372
373 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
374                        u64 offset, struct dentry *dentry);
375
376
377 extern int read_dentry_tree(const u8 metadata_resource[],
378                             u64 metadata_resource_len, struct dentry *dentry);
379
380 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
381
382 static inline bool dentry_is_root(const struct dentry *dentry)
383 {
384         return dentry->parent == dentry;
385 }
386
387 static inline bool inode_is_directory(const struct inode *inode)
388 {
389         return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
390                 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
391 }
392
393 static inline bool dentry_is_directory(const struct dentry *dentry)
394 {
395         return inode_is_directory(dentry->d_inode);
396 }
397
398 /* For our purposes, we consider "real" symlinks and "junction points" to both
399  * be symlinks. */
400 static inline bool inode_is_symlink(const struct inode *inode)
401 {
402         return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
403                 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
404                      inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
405 }
406
407 static inline bool dentry_is_symlink(const struct dentry *dentry)
408 {
409         return inode_is_symlink(dentry->d_inode);
410 }
411
412 static inline bool inode_is_regular_file(const struct inode *inode)
413 {
414         return !inode_is_directory(inode) && !inode_is_symlink(inode);
415 }
416
417 static inline bool dentry_is_regular_file(const struct dentry *dentry)
418 {
419         return inode_is_regular_file(dentry->d_inode);
420 }
421
422 static inline bool inode_has_children(const struct inode *inode)
423 {
424         return inode->children.rb_node != NULL;
425 }
426
427 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
428 {
429         const struct inode *inode = dentry->d_inode;
430         return inode_is_directory(inode) && !inode_has_children(inode);
431 }
432
433 #endif