5f7ccd5b6cf886837a5c7cf5b5d692198f5216ce
[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         /* Number of alternate data streams associated with this inode */
235         u16 i_num_ads;
236
237         /* A hash of the file's contents, or a pointer to the lookup table entry
238          * for this dentry if the lookup table entries have been resolved.
239          *
240          * More specifically, this is for the un-named default file stream, as
241          * opposed to the alternate (named) file streams, which may have their
242          * own lookup table entries.  */
243         union {
244                 u8 i_hash[SHA1_HASH_SIZE];
245                 struct wim_lookup_table_entry *i_lte;
246         };
247
248         /* Identity of a reparse point.  See
249          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
250          * for what a reparse point is. */
251         u32 i_reparse_tag;
252
253         /* Number of dentries that reference this inode */
254         u32 i_nlink;
255
256         /* Alternate data stream entries. */
257         struct wim_ads_entry *i_ads_entries;
258
259         /* Inode number */
260         u64 i_ino;
261
262         /* List of dentries that reference this inode (there should be
263          * link_count of them) */
264         struct list_head i_dentry;
265
266         union {
267                 struct hlist_node i_hlist;
268                 struct list_head i_list;
269         };
270
271         union {
272                 /* Used during image extraction to build a list of inodes that
273                  * share a certain stream */
274                 struct list_head i_lte_inode_list;
275
276                 /* Device number, used only during image capture */
277                 u64 i_devno;
278         };
279
280         tchar *i_extracted_file;
281
282         /* Root of a red-black tree storing the children of this inode (if
283          * non-empty, implies the inode is a directory, although that is also
284          * noted in the @attributes field.) */
285         struct rb_root i_children;
286
287         /* Next alternate data stream ID to be assigned */
288         u32 i_next_stream_id;
289
290 #ifdef WITH_FUSE
291         /* wimfs file descriptors table for the inode */
292         u16 i_num_opened_fds;
293         u16 i_num_allocated_fds;
294         struct wimfs_fd **i_fds;
295         /* This mutex protects the inode's file descriptors table during
296          * read-only mounts.  Read-write mounts are still restricted to 1
297          * thread. */
298         pthread_mutex_t i_mutex;
299 #endif
300 };
301
302 #define inode_for_each_dentry(dentry, inode) \
303                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
304
305 #define inode_add_dentry(dentry, inode) \
306                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
307
308 #define inode_first_dentry(inode) \
309                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
310
311 static inline bool
312 dentry_is_first_in_inode(const struct wim_dentry *dentry)
313 {
314         return inode_first_dentry(dentry->d_inode) == dentry;
315 }
316
317 extern u64
318 dentry_correct_total_length(const struct wim_dentry *dentry);
319
320 extern int
321 for_dentry_in_tree(struct wim_dentry *root,
322                    int (*visitor)(struct wim_dentry*, void*),
323                    void *args);
324
325 extern int
326 for_dentry_in_rbtree(struct rb_node *node,
327                      int (*visitor)(struct wim_dentry *, void *),
328                      void *arg);
329
330 static inline int
331 for_dentry_child(const struct wim_dentry *dentry,
332                  int (*visitor)(struct wim_dentry *, void *),
333                  void *arg)
334 {
335         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
336                                     visitor,
337                                     arg);
338 }
339
340 extern int
341 for_dentry_in_tree_depth(struct wim_dentry *root,
342                          int (*visitor)(struct wim_dentry*, void*),
343                          void *args);
344
345 extern void
346 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
347
348 extern int
349 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
350
351 extern struct wim_dentry *
352 get_dentry(struct WIMStruct *w, const tchar *path);
353
354 extern struct wim_inode *
355 wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
356
357 extern struct wim_dentry *
358 get_dentry_child_with_name(const struct wim_dentry *dentry,
359                            const tchar *name);
360
361 extern struct wim_dentry *
362 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
363                                    const utf16lechar *name,
364                                    size_t name_nbytes);
365
366 extern struct wim_dentry *
367 get_parent_dentry(struct WIMStruct *w, const tchar *path);
368
369 extern int
370 print_dentry(struct wim_dentry *dentry, void *lookup_table);
371
372 extern int
373 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
374
375 extern tchar *
376 dentry_full_path(struct wim_dentry *dentry);
377
378 extern struct wim_inode *
379 new_timeless_inode();
380
381 extern int
382 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
383
384 extern int
385 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
386
387 extern int
388 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
389
390 extern void
391 free_inode(struct wim_inode *inode);
392
393 extern void
394 free_dentry(struct wim_dentry *dentry);
395
396 extern void
397 put_dentry(struct wim_dentry *dentry);
398
399 extern void
400 free_dentry_tree(struct wim_dentry *root,
401                  struct wim_lookup_table *lookup_table);
402
403 extern void
404 unlink_dentry(struct wim_dentry *dentry);
405
406 extern bool
407 dentry_add_child(struct wim_dentry * restrict parent,
408                  struct wim_dentry * restrict child);
409
410 extern struct wim_ads_entry *
411 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
412                     u16 *idx_ret);
413
414 extern struct wim_ads_entry *
415 inode_add_ads_utf16le(struct wim_inode *inode,
416                       const utf16lechar *stream_name,
417                       size_t stream_name_nbytes);
418
419 extern struct wim_ads_entry *
420 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
421
422 extern int
423 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
424                         const void *value, size_t size,
425                         struct wim_lookup_table *lookup_table);
426
427 extern void
428 inode_remove_ads(struct wim_inode *inode, u16 idx,
429                  struct wim_lookup_table *lookup_table);
430
431
432 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
433 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
434
435 #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"
436 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
437
438 /* Format for special alternate data stream entries to store UNIX data for files
439  * and directories (see: WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
440 struct wimlib_unix_data {
441         u16 version; /* Must be 0 */
442         u16 uid;
443         u16 gid;
444         u16 mode;
445 } PACKED;
446
447 #ifndef __WIN32__
448
449 #define NO_UNIX_DATA (-1)
450 #define BAD_UNIX_DATA (-2)
451 extern int
452 inode_get_unix_data(const struct wim_inode *inode,
453                     struct wimlib_unix_data *unix_data,
454                     u16 *stream_idx_ret);
455
456 #define UNIX_DATA_UID    0x1
457 #define UNIX_DATA_GID    0x2
458 #define UNIX_DATA_MODE   0x4
459 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
460 #define UNIX_DATA_CREATE 0x8
461 extern int
462 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
463                     struct wim_lookup_table *lookup_table, int which);
464 #endif
465
466 extern int
467 read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
468             u64 offset, struct wim_dentry *dentry);
469
470
471 extern int
472 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
473                  struct wim_dentry *dentry);
474
475 extern u8 *
476 write_dentry_tree(const struct wim_dentry *tree, u8 *p);
477
478 static inline bool
479 dentry_is_root(const struct wim_dentry *dentry)
480 {
481         return dentry->parent == dentry;
482 }
483
484 static inline bool
485 inode_is_directory(const struct wim_inode *inode)
486 {
487         return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
488                 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
489 }
490
491 static inline bool
492 dentry_is_directory(const struct wim_dentry *dentry)
493 {
494         return inode_is_directory(dentry->d_inode);
495 }
496
497 /* For our purposes, we consider "real" symlinks and "junction points" to both
498  * be symlinks. */
499 static inline bool
500 inode_is_symlink(const struct wim_inode *inode)
501 {
502         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
503                 && ((inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
504                      inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
505 }
506
507 static inline bool
508 inode_is_regular_file(const struct wim_inode *inode)
509 {
510         return !inode_is_directory(inode) && !inode_is_symlink(inode);
511 }
512
513 static inline bool
514 dentry_is_regular_file(const struct wim_dentry *dentry)
515 {
516         return inode_is_regular_file(dentry->d_inode);
517 }
518
519 static inline bool
520 inode_has_children(const struct wim_inode *inode)
521 {
522         return inode->i_children.rb_node != NULL;
523 }
524
525 static inline bool
526 dentry_has_children(const struct wim_dentry *dentry)
527 {
528         return inode_has_children(dentry->d_inode);
529 }
530
531 static inline bool
532 dentry_has_short_name(const struct wim_dentry *dentry)
533 {
534         return dentry->short_name_nbytes != 0;
535 }
536
537 static inline bool
538 dentry_has_long_name(const struct wim_dentry *dentry)
539 {
540         return dentry->file_name_nbytes != 0;
541 }
542
543 #endif