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