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