do_overlay(): Do overlays recursively
[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 UTF16-encoded stream name, in bytes, not including the
78          * terminating null character. */
79         u16 stream_name_nbytes;
80
81         /* Stream name (UTF-16LE) */
82         utf16lechar *stream_name;
83
84         /* Number to identify an alternate data stream even after it's possibly
85          * been moved or renamed. */
86         u32 stream_id;
87 };
88
89
90 static inline bool
91 ads_entries_have_same_name(const struct wim_ads_entry *entry_1,
92                            const struct wim_ads_entry *entry_2)
93 {
94         return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes &&
95                memcmp(entry_1->stream_name, entry_2->stream_name,
96                       entry_1->stream_name_nbytes) == 0;
97 }
98
99 /*
100  * In-memory structure for a WIM directory entry (dentry).  There is a directory
101  * tree for each image in the WIM.
102  *
103  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
104  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
105  * The hard link group ID field of the on-disk WIM dentry tells us the number of
106  * the NTFS inode that the dentry corresponds to (and this gets placed in
107  * d_inode->i_ino).
108  *
109  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
110  * information, such as file attributes, the security descriptor, and file
111  * streams is replicated in each hard-linked dentry, even though this
112  * information really is associated with an inode.  In-memory, we fix up this
113  * flaw by allocating a `struct wim_inode' for each dentry that contains some of
114  * this duplicated information, then combining the inodes for each hard link
115  * group together.
116  *
117  * Confusingly, it's possible for stream information to be missing from a dentry
118  * in a hard link set, in which case the stream information needs to be gotten
119  * from one of the other dentries in the hard link set.  In addition, it is
120  * possible for dentries to have inconsistent security IDs, file attributes, or
121  * file streams when they share the same hard link ID (don't even ask.  I hope
122  * that Microsoft may have fixed this problem, since I've only noticed it in the
123  * 'install.wim' for Windows 7).  For those dentries, we have to use the
124  * conflicting fields to split up the hard link groups.  (See
125  * dentry_tree_fix_inodes() in hardlink.c).
126  */
127 struct wim_dentry {
128         /* The inode for this dentry */
129         struct wim_inode *d_inode;
130
131         /* Red-black tree of sibling dentries */
132         struct rb_node rb_node;
133
134         /* Length of UTF-16LE encoded short filename, in bytes, not including
135          * the terminating zero wide-character. */
136         u16 short_name_nbytes;
137
138         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
139          * the terminating null character. */
140         u16 file_name_nbytes;
141
142         /* Length of full path name encoded using "tchars", in bytes, not
143          * including the terminating null character. */
144         u32 full_path_nbytes;
145
146         /* Has this dentry been extracted yet? */
147         u8 is_extracted : 1;
148
149         /* Only used during NTFS capture */
150         u8 is_win32_name : 1;
151
152         /* Temporary list */
153         struct list_head tmp_list;
154
155         /* List of dentries in the inode (hard link set)  */
156         struct list_head d_alias;
157
158         /* The parent of this directory entry. */
159         struct wim_dentry *parent;
160
161         /*
162          * Size of directory entry on disk, in bytes.  Typical size is around
163          * 104 to 120 bytes.
164          *
165          * It is possible for the length field to be 0.  This situation, which
166          * is undocumented, indicates the end of a list of sibling nodes in a
167          * directory.  It also means the real length is 8, because the dentry
168          * included only the length field, but that takes up 8 bytes.
169          *
170          * The length here includes the base directory entry on disk as well as
171          * the long and short filenames.  It does NOT include any alternate
172          * stream entries that may follow the directory entry, even though the
173          * size of those needs to be considered.  The length SHOULD be 8-byte
174          * aligned, although we don't require it to be.  We do require the
175          * length to be large enough to hold the file name(s) of the dentry;
176          * additionally, a warning is issued if this field is larger than the
177          * aligned size.
178          */
179         u64 length;
180
181         /* The offset, from the start of the uncompressed WIM metadata resource
182          * for this image, of this dentry's child dentries.  0 if the directory
183          * entry has no children, which is the case for regular files or reparse
184          * points. */
185         u64 subdir_offset;
186
187         /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */
188         utf16lechar *short_name;
189
190         /* Pointer to the UTF-16LE filename (malloc()ed buffer). */
191         utf16lechar *file_name;
192
193         /* Full path of this dentry */
194         tchar *_full_path;
195 };
196
197 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
198
199 /*
200  * WIM inode.
201  *
202  * As mentioned above, in the WIM file that is no on-disk analogue of a real
203  * inode, as most of these fields are duplicated in the dentries.
204  */
205 struct wim_inode {
206         /* Timestamps for the inode.  The timestamps are the number of
207          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
208          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
209         u64 i_creation_time;
210         u64 i_last_access_time;
211         u64 i_last_write_time;
212
213         /* The file attributes associated with this inode.  This is a bitwise OR
214          * of the FILE_ATTRIBUTE_* flags. */
215         u32 i_attributes;
216
217         /* The index of the security descriptor in the WIM image's table of
218          * security descriptors that contains this file's security information.
219          * If -1, no security information exists for this file.  */
220         int32_t i_security_id;
221
222         /* %true iff the inode's lookup table entries has been resolved (i.e.
223          * the @lte field is valid, but the @hash field is not valid)
224          *
225          * (This is not an on-disk field.) */
226         u8 i_resolved : 1;
227
228         /* %true iff verify_inode() has run on this inode. */
229         u8 i_verified : 1;
230
231         /* Used only in NTFS-mode extraction */
232         u8 i_dos_name_extracted : 1;
233
234         u16 i_not_rpfixed;
235
236         /* Number of alternate data streams associated with this inode */
237         u16 i_num_ads;
238
239         u16 i_rp_unknown_2;
240         u32 i_rp_unknown_1;
241
242         /* A hash of the file's contents, or a pointer to the lookup table entry
243          * for this dentry if the lookup table entries have been resolved.
244          *
245          * More specifically, this is for the un-named default file stream, as
246          * opposed to the alternate (named) file streams, which may have their
247          * own lookup table entries.  */
248         union {
249                 u8 i_hash[SHA1_HASH_SIZE];
250                 struct wim_lookup_table_entry *i_lte;
251         };
252
253         /* Identity of a reparse point.  See
254          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
255          * for what a reparse point is. */
256         u32 i_reparse_tag;
257
258         /* Number of dentries that reference this inode */
259         u32 i_nlink;
260
261         /* Alternate data stream entries. */
262         struct wim_ads_entry *i_ads_entries;
263
264         /* Inode number */
265         u64 i_ino;
266
267         /* List of dentries that reference this inode (there should be
268          * link_count of them) */
269         struct list_head i_dentry;
270
271         union {
272                 struct hlist_node i_hlist;
273                 struct list_head i_list;
274         };
275
276         union {
277                 /* Used during image extraction to build a list of inodes that
278                  * share a certain stream */
279                 struct list_head i_lte_inode_list;
280
281                 /* Device number, used only during image capture */
282                 u64 i_devno;
283         };
284
285         tchar *i_extracted_file;
286
287         /* Root of a red-black tree storing the children of this inode (if
288          * non-empty, implies the inode is a directory, although that is also
289          * noted in the @attributes field.) */
290         struct rb_root i_children;
291
292         /* Next alternate data stream ID to be assigned */
293         u32 i_next_stream_id;
294
295 #ifdef WITH_FUSE
296         /* wimfs file descriptors table for the inode */
297         u16 i_num_opened_fds;
298         u16 i_num_allocated_fds;
299         struct wimfs_fd **i_fds;
300         /* This mutex protects the inode's file descriptors table during
301          * read-only mounts.  Read-write mounts are still restricted to 1
302          * thread. */
303         pthread_mutex_t i_mutex;
304 #endif
305 };
306
307 #define inode_for_each_dentry(dentry, inode) \
308                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
309
310 #define inode_add_dentry(dentry, inode) \
311                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
312
313 #define inode_first_dentry(inode) \
314                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
315
316 static inline bool
317 dentry_is_first_in_inode(const struct wim_dentry *dentry)
318 {
319         return inode_first_dentry(dentry->d_inode) == dentry;
320 }
321
322 extern u64
323 dentry_correct_total_length(const struct wim_dentry *dentry);
324
325 extern int
326 for_dentry_in_tree(struct wim_dentry *root,
327                    int (*visitor)(struct wim_dentry*, void*),
328                    void *args);
329
330 extern int
331 for_dentry_in_rbtree(struct rb_node *node,
332                      int (*visitor)(struct wim_dentry *, void *),
333                      void *arg);
334
335 static inline int
336 for_dentry_child(const struct wim_dentry *dentry,
337                  int (*visitor)(struct wim_dentry *, void *),
338                  void *arg)
339 {
340         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
341                                     visitor,
342                                     arg);
343 }
344
345 extern int
346 for_dentry_in_tree_depth(struct wim_dentry *root,
347                          int (*visitor)(struct wim_dentry*, void*),
348                          void *args);
349
350 extern void
351 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
352
353 extern int
354 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
355
356 extern struct wim_dentry *
357 get_dentry(struct WIMStruct *w, const tchar *path);
358
359 extern struct wim_inode *
360 wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
361
362 extern struct wim_dentry *
363 get_dentry_child_with_name(const struct wim_dentry *dentry,
364                            const tchar *name);
365
366 extern struct wim_dentry *
367 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
368                                    const utf16lechar *name,
369                                    size_t name_nbytes);
370
371 extern struct wim_dentry *
372 get_parent_dentry(struct WIMStruct *w, const tchar *path);
373
374 extern int
375 print_dentry(struct wim_dentry *dentry, void *lookup_table);
376
377 extern int
378 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
379
380 extern int
381 calculate_dentry_tree_full_paths(struct wim_dentry *root);
382
383 extern tchar *
384 dentry_full_path(struct wim_dentry *dentry);
385
386 extern struct wim_inode *
387 new_timeless_inode();
388
389 extern int
390 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
391
392 extern int
393 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
394
395 extern int
396 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
397
398 extern void
399 free_inode(struct wim_inode *inode);
400
401 extern void
402 free_dentry(struct wim_dentry *dentry);
403
404 extern void
405 put_dentry(struct wim_dentry *dentry);
406
407 extern void
408 free_dentry_tree(struct wim_dentry *root,
409                  struct wim_lookup_table *lookup_table);
410
411 extern void
412 unlink_dentry(struct wim_dentry *dentry);
413
414 extern struct wim_dentry *
415 dentry_add_child(struct wim_dentry * restrict parent,
416                  struct wim_dentry * restrict child);
417
418 extern struct wim_ads_entry *
419 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
420                     u16 *idx_ret);
421
422 extern struct wim_ads_entry *
423 inode_add_ads_utf16le(struct wim_inode *inode,
424                       const utf16lechar *stream_name,
425                       size_t stream_name_nbytes);
426
427 extern struct wim_ads_entry *
428 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
429
430 extern int
431 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
432                         const void *value, size_t size,
433                         struct wim_lookup_table *lookup_table);
434
435 extern void
436 inode_remove_ads(struct wim_inode *inode, u16 idx,
437                  struct wim_lookup_table *lookup_table);
438
439
440 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
441 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
442
443 #define WIMLIB_UNIX_DATA_TAG_UTF16LE "$\0$\0_\0_\0w\0i\0m\0l\0i\0b\0_\0U\0N\0I\0X\0_\0d\0a\0t\0a\0"
444 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
445
446 /* Format for special alternate data stream entries to store UNIX data for files
447  * and directories (see: WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
448 struct wimlib_unix_data {
449         u16 version; /* Must be 0 */
450         u16 uid;
451         u16 gid;
452         u16 mode;
453 } PACKED;
454
455 #ifndef __WIN32__
456
457 #define NO_UNIX_DATA (-1)
458 #define BAD_UNIX_DATA (-2)
459 extern int
460 inode_get_unix_data(const struct wim_inode *inode,
461                     struct wimlib_unix_data *unix_data,
462                     u16 *stream_idx_ret);
463
464 #define UNIX_DATA_UID    0x1
465 #define UNIX_DATA_GID    0x2
466 #define UNIX_DATA_MODE   0x4
467 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
468 #define UNIX_DATA_CREATE 0x8
469 extern int
470 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
471                     struct wim_lookup_table *lookup_table, int which);
472 #endif
473
474 extern int
475 read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
476             u64 offset, struct wim_dentry *dentry);
477
478
479 extern int
480 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
481                  struct wim_dentry *dentry);
482
483 extern u8 *
484 write_dentry_tree(const struct wim_dentry *tree, u8 *p);
485
486 static inline bool
487 dentry_is_root(const struct wim_dentry *dentry)
488 {
489         return dentry->parent == dentry;
490 }
491
492 static inline bool
493 inode_is_directory(const struct wim_inode *inode)
494 {
495         return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
496                 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
497 }
498
499 static inline bool
500 dentry_is_directory(const struct wim_dentry *dentry)
501 {
502         return inode_is_directory(dentry->d_inode);
503 }
504
505 /* For our purposes, we consider "real" symlinks and "junction points" to both
506  * be symlinks. */
507 static inline bool
508 inode_is_symlink(const struct wim_inode *inode)
509 {
510         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
511                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
512                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
513 }
514
515 static inline bool
516 inode_is_regular_file(const struct wim_inode *inode)
517 {
518         return !inode_is_directory(inode) && !inode_is_symlink(inode);
519 }
520
521 static inline bool
522 dentry_is_regular_file(const struct wim_dentry *dentry)
523 {
524         return inode_is_regular_file(dentry->d_inode);
525 }
526
527 static inline bool
528 inode_has_children(const struct wim_inode *inode)
529 {
530         return inode->i_children.rb_node != NULL;
531 }
532
533 static inline bool
534 dentry_has_children(const struct wim_dentry *dentry)
535 {
536         return inode_has_children(dentry->d_inode);
537 }
538
539 static inline bool
540 dentry_has_short_name(const struct wim_dentry *dentry)
541 {
542         return dentry->short_name_nbytes != 0;
543 }
544
545 static inline bool
546 dentry_has_long_name(const struct wim_dentry *dentry)
547 {
548         return dentry->file_name_nbytes != 0;
549 }
550
551 #endif