Fix packed attribute on struct wimlib_unix_data
[wimlib] / include / wimlib / dentry.h
1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
3
4 #include "wimlib/compiler.h"
5 #include "wimlib/list.h"
6 #include "wimlib/rbtree.h"
7 #include "wimlib/sha1.h"
8 #include "wimlib/types.h"
9
10 #include <string.h>
11 #include <sys/types.h> /* uid_t, gid_t */
12
13 #ifdef WITH_FUSE
14 #  include <pthread.h>
15 #endif
16
17 struct wim_lookup_table;
18 struct wim_lookup_table_entry;
19 struct wimfs_fd;
20 struct wim_inode;
21
22 /* Size of the struct wim_dentry up to and including the file_name_len. */
23 #define WIM_DENTRY_DISK_SIZE    102
24
25 /*
26  * Reparse tags documented at
27  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
28  */
29 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
30 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
31 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
32 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
33 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
34 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
35 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
36 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
37 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
38 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
39 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
40
41 #define FILE_ATTRIBUTE_READONLY            0x00000001
42 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
43 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
44 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
45 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
46 #define FILE_ATTRIBUTE_DEVICE              0x00000040
47 #define FILE_ATTRIBUTE_NORMAL              0x00000080
48 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
49 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
50 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
51 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
52 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
53 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
54 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
55 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
56
57
58 /* Alternate data stream entry.
59  *
60  * We read this from disk in the read_ads_entries() function; see that function
61  * for more explanation. */
62 struct wim_ads_entry {
63         union {
64                 /* SHA-1 message digest of stream contents */
65                 u8 hash[SHA1_HASH_SIZE];
66
67                 /* The corresponding lookup table entry (only for resolved
68                  * streams) */
69                 struct wim_lookup_table_entry *lte;
70         };
71
72         /* Length of UTF16-encoded stream name, in bytes, not including the
73          * terminating null character; or 0 if the stream is unnamed. */
74         u16 stream_name_nbytes;
75
76         /* Number to identify an alternate data stream even after it's possibly
77          * been moved or renamed. */
78         u32 stream_id;
79
80         /* Stream name (UTF-16LE), null-terminated, or NULL if the stream is
81          * unnamed.  */
82         utf16lechar *stream_name;
83
84         /* Reserved field.  We read it into memory so we can write it out
85          * unchanged. */
86         u64 reserved;
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         /* Does this dentry need to be extracted? */
147         u8 needs_extraction : 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         u64 d_unused_1;
188         u64 d_unused_2;
189
190         /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */
191         utf16lechar *short_name;
192
193         /* Pointer to the UTF-16LE filename (malloc()ed buffer). */
194         utf16lechar *file_name;
195
196         /* Full path of this dentry */
197         tchar *_full_path;
198 };
199
200 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
201
202 /*
203  * WIM inode.
204  *
205  * As mentioned above, in the WIM file that is no on-disk analogue of a real
206  * inode, as most of these fields are duplicated in the dentries.
207  */
208 struct wim_inode {
209         /* Timestamps for the inode.  The timestamps are the number of
210          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
211          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
212         u64 i_creation_time;
213         u64 i_last_access_time;
214         u64 i_last_write_time;
215
216         /* The file attributes associated with this inode.  This is a bitwise OR
217          * of the FILE_ATTRIBUTE_* flags. */
218         u32 i_attributes;
219
220         /* The index of the security descriptor in the WIM image's table of
221          * security descriptors that contains this file's security information.
222          * If -1, no security information exists for this file.  */
223         int32_t i_security_id;
224
225         /* %true iff the inode's lookup table entries has been resolved (i.e.
226          * the @lte field is valid, but the @hash field is not valid)
227          *
228          * (This is not an on-disk field.) */
229         u8 i_resolved : 1;
230
231         /* %true iff verify_inode() has run on this inode. */
232         u8 i_verified : 1;
233
234         u8 i_visited : 1;
235
236         /* Used only in NTFS-mode extraction */
237         u8 i_dos_name_extracted : 1;
238
239         /* Set to 0 if reparse point fixups have been done.  Otherwise set to 1.
240          *
241          * Note: this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.  */
242         u16 i_not_rpfixed;
243
244         /* Number of alternate data streams associated with this inode */
245         u16 i_num_ads;
246
247         /* Unused/unknown fields that we just read into memory so we can
248          * re-write them unchanged.  */
249         u32 i_rp_unknown_1;
250         u16 i_rp_unknown_2;
251
252         /* If i_resolved == 0:
253          *      SHA1 message digest of the contents of the unnamed-data stream
254          *      of this inode, or all zeroes if this inode has no unnamed data
255          *      stream, or optionally all zeroes if this inode has an empty
256          *      unnamed data stream.
257          *
258          * If i_resolved == 1:
259          *      Pointer to the lookup table entry for the unnamed data stream
260          *      of this inode, or NULL if this inode has no unnamed data stream,
261          *      or optionally all zeroes if this inode has an empty unnamed data
262          *      stream.
263          */
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         /* Device number, used only during image capture */
284         u64 i_devno;
285
286         /* List of dentries that reference this inode (there should be
287          * link_count of them) */
288         struct list_head i_dentry;
289
290         union {
291                 struct hlist_node i_hlist;
292                 struct list_head i_list;
293         };
294
295         tchar *i_extracted_file;
296
297         /* Root of a red-black tree storing the children of this inode (if
298          * non-empty, implies the inode is a directory, although that is also
299          * noted in the @attributes field.) */
300         struct rb_root i_children;
301
302         /* Next alternate data stream ID to be assigned */
303         u32 i_next_stream_id;
304
305 #ifdef WITH_FUSE
306         /* wimfs file descriptors table for the inode */
307         u16 i_num_opened_fds;
308         u16 i_num_allocated_fds;
309         struct wimfs_fd **i_fds;
310         /* This mutex protects the inode's file descriptors table during
311          * read-only mounts.  Read-write mounts are still restricted to 1
312          * thread. */
313         pthread_mutex_t i_mutex;
314 #endif
315 };
316
317 #define inode_for_each_dentry(dentry, inode) \
318                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
319
320 #define inode_add_dentry(dentry, inode) \
321                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
322
323 #define inode_first_dentry(inode) \
324                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
325
326 static inline bool
327 dentry_is_first_in_inode(const struct wim_dentry *dentry)
328 {
329         return inode_first_dentry(dentry->d_inode) == dentry;
330 }
331
332 extern u64
333 dentry_correct_total_length(const struct wim_dentry *dentry);
334
335 extern int
336 for_dentry_in_tree(struct wim_dentry *root,
337                    int (*visitor)(struct wim_dentry*, void*),
338                    void *args);
339
340 extern int
341 for_dentry_in_rbtree(struct rb_node *node,
342                      int (*visitor)(struct wim_dentry *, void *),
343                      void *arg);
344
345 static inline int
346 for_dentry_child(const struct wim_dentry *dentry,
347                  int (*visitor)(struct wim_dentry *, void *),
348                  void *arg)
349 {
350         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
351                                     visitor,
352                                     arg);
353 }
354
355 extern int
356 for_dentry_in_tree_depth(struct wim_dentry *root,
357                          int (*visitor)(struct wim_dentry*, void*),
358                          void *args);
359
360 extern void
361 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
362
363 extern int
364 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
365
366 extern struct wim_dentry *
367 get_dentry(struct WIMStruct *w, const tchar *path);
368
369 extern struct wim_inode *
370 wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
371
372 extern struct wim_dentry *
373 get_dentry_child_with_name(const struct wim_dentry *dentry,
374                            const tchar *name);
375
376 extern struct wim_dentry *
377 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
378                                    const utf16lechar *name,
379                                    size_t name_nbytes);
380
381 extern struct wim_dentry *
382 get_parent_dentry(struct WIMStruct *w, const tchar *path);
383
384 extern int
385 print_dentry(struct wim_dentry *dentry, void *lookup_table);
386
387 extern int
388 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
389
390 extern int
391 calculate_dentry_tree_full_paths(struct wim_dentry *root);
392
393 extern tchar *
394 dentry_full_path(struct wim_dentry *dentry);
395
396 extern struct wim_inode *
397 new_timeless_inode(void) _malloc_attribute;
398
399 extern int
400 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
401
402 extern int
403 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
404
405 extern int
406 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
407
408 extern int
409 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
410
411 extern void
412 free_inode(struct wim_inode *inode);
413
414 extern void
415 free_dentry(struct wim_dentry *dentry);
416
417 extern void
418 put_dentry(struct wim_dentry *dentry);
419
420 extern void
421 free_dentry_tree(struct wim_dentry *root,
422                  struct wim_lookup_table *lookup_table);
423
424 extern void
425 unlink_dentry(struct wim_dentry *dentry);
426
427 extern struct wim_dentry *
428 dentry_add_child(struct wim_dentry * restrict parent,
429                  struct wim_dentry * restrict child);
430
431 extern struct wim_ads_entry *
432 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
433                     u16 *idx_ret);
434
435 extern struct wim_ads_entry *
436 inode_add_ads_utf16le(struct wim_inode *inode,
437                       const utf16lechar *stream_name,
438                       size_t stream_name_nbytes);
439
440 extern struct wim_ads_entry *
441 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
442
443 extern int
444 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
445                         const void *value, size_t size,
446                         struct wim_lookup_table *lookup_table);
447
448 extern int
449 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
450                          struct wim_lookup_table *lookup_table);
451
452 extern void
453 inode_remove_ads(struct wim_inode *inode, u16 idx,
454                  struct wim_lookup_table *lookup_table);
455
456
457 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
458 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
459
460 #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"
461 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
462
463 /* Format for special alternate data stream entries to store UNIX data for files
464  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
465 struct wimlib_unix_data {
466         u16 version; /* Must be 0 */
467         u16 uid;
468         u16 gid;
469         u16 mode;
470 } _packed_attribute;
471
472 #ifndef __WIN32__
473
474 #define NO_UNIX_DATA (-1)
475 #define BAD_UNIX_DATA (-2)
476 extern int
477 inode_get_unix_data(const struct wim_inode *inode,
478                     struct wimlib_unix_data *unix_data,
479                     u16 *stream_idx_ret);
480
481 #define UNIX_DATA_UID    0x1
482 #define UNIX_DATA_GID    0x2
483 #define UNIX_DATA_MODE   0x4
484 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
485 #define UNIX_DATA_CREATE 0x8
486 extern int
487 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
488                     struct wim_lookup_table *lookup_table, int which);
489 #endif
490
491 extern int
492 read_dentry(const u8 *metadata_resource, u64 metadata_resource_len,
493             u64 offset, struct wim_dentry *dentry);
494
495 extern int
496 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
497                  struct wim_dentry *dentry);
498
499 extern u8 *
500 write_dentry_tree(const struct wim_dentry *tree, u8 *p);
501
502 static inline bool
503 dentry_is_root(const struct wim_dentry *dentry)
504 {
505         return dentry->parent == dentry;
506 }
507
508 static inline bool
509 inode_is_directory(const struct wim_inode *inode)
510 {
511         return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
512                 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
513 }
514
515 static inline bool
516 dentry_is_directory(const struct wim_dentry *dentry)
517 {
518         return inode_is_directory(dentry->d_inode);
519 }
520
521 /* For our purposes, we consider "real" symlinks and "junction points" to both
522  * be symlinks. */
523 static inline bool
524 inode_is_symlink(const struct wim_inode *inode)
525 {
526         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
527                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
528                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
529 }
530
531 static inline bool
532 inode_is_regular_file(const struct wim_inode *inode)
533 {
534         return !inode_is_directory(inode) && !inode_is_symlink(inode);
535 }
536
537 static inline bool
538 dentry_is_regular_file(const struct wim_dentry *dentry)
539 {
540         return inode_is_regular_file(dentry->d_inode);
541 }
542
543 static inline bool
544 inode_has_children(const struct wim_inode *inode)
545 {
546         return inode->i_children.rb_node != NULL;
547 }
548
549 static inline bool
550 dentry_has_children(const struct wim_dentry *dentry)
551 {
552         return inode_has_children(dentry->d_inode);
553 }
554
555 static inline bool
556 dentry_has_short_name(const struct wim_dentry *dentry)
557 {
558         return dentry->short_name_nbytes != 0;
559 }
560
561 static inline bool
562 dentry_has_long_name(const struct wim_dentry *dentry)
563 {
564         return dentry->file_name_nbytes != 0;
565 }
566
567 extern void
568 inode_ref_streams(struct wim_inode *inode);
569
570 extern int
571 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
572
573 extern int
574 verify_dentry(struct wim_dentry *dentry, void *wim);
575
576 #endif