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