8d359a952d27af4daa5666985c9352b28d066098
[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 struct wim_lookup_table;
14 struct wim_lookup_table_entry;
15 struct wimfs_fd;
16 struct wim_inode;
17 struct wim_security_data;
18
19 /* Size of the struct wim_dentry up to and including the file_name_len. */
20 #define WIM_DENTRY_DISK_SIZE    102
21
22 /*
23  * Reparse tags documented at
24  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
25  */
26 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
27 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
28 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
29 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
30 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
31 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
32 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
33 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
34 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
35 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
36 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
37
38 #define FILE_ATTRIBUTE_READONLY            0x00000001
39 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
40 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
41 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
42 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
43 #define FILE_ATTRIBUTE_DEVICE              0x00000040
44 #define FILE_ATTRIBUTE_NORMAL              0x00000080
45 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
46 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
47 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
48 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
49 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
50 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
51 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
52 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
53
54
55 /* Alternate data stream entry.
56  *
57  * We read this from disk in the read_ads_entries() function; see that function
58  * for more explanation. */
59 struct wim_ads_entry {
60         union {
61                 /* SHA-1 message digest of stream contents */
62                 u8 hash[SHA1_HASH_SIZE];
63
64                 /* The corresponding lookup table entry (only for resolved
65                  * streams) */
66                 struct wim_lookup_table_entry *lte;
67         };
68
69         /* Length of UTF16-encoded stream name, in bytes, not including the
70          * terminating null character; or 0 if the stream is unnamed. */
71         u16 stream_name_nbytes;
72
73         /* Number to identify an alternate data stream even after it's possibly
74          * been moved or renamed. */
75         u32 stream_id;
76
77         /* Stream name (UTF-16LE), null-terminated, or NULL if the stream is
78          * unnamed.  */
79         utf16lechar *stream_name;
80
81         /* Reserved field.  We read it into memory so we can write it out
82          * unchanged. */
83         u64 reserved;
84 };
85
86
87 static inline bool
88 ads_entries_have_same_name(const struct wim_ads_entry *entry_1,
89                            const struct wim_ads_entry *entry_2)
90 {
91         return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes &&
92                memcmp(entry_1->stream_name, entry_2->stream_name,
93                       entry_1->stream_name_nbytes) == 0;
94 }
95
96 /*
97  * In-memory structure for a WIM directory entry (dentry).  There is a directory
98  * tree for each image in the WIM.
99  *
100  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
101  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
102  * The hard link group ID field of the on-disk WIM dentry tells us the number of
103  * the NTFS inode that the dentry corresponds to (and this gets placed in
104  * d_inode->i_ino).
105  *
106  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
107  * information, such as file attributes, the security descriptor, and file
108  * streams is replicated in each hard-linked dentry, even though this
109  * information really is associated with an inode.  In-memory, we fix up this
110  * flaw by allocating a `struct wim_inode' for each dentry that contains some of
111  * this duplicated information, then combining the inodes for each hard link
112  * group together.
113  *
114  * Confusingly, it's possible for stream information to be missing from a dentry
115  * in a hard link set, in which case the stream information needs to be gotten
116  * from one of the other dentries in the hard link set.  In addition, it is
117  * possible for dentries to have inconsistent security IDs, file attributes, or
118  * file streams when they share the same hard link ID (don't even ask.  I hope
119  * that Microsoft may have fixed this problem, since I've only noticed it in the
120  * 'install.wim' for Windows 7).  For those dentries, we have to use the
121  * conflicting fields to split up the hard link groups.  (See
122  * dentry_tree_fix_inodes() in hardlink.c).
123  */
124 struct wim_dentry {
125         /* Pointer to the inode for this dentry.  This will contain some
126          * information that was factored out of the on-disk WIM dentry as common
127          * to all dentries in a hard link group.  */
128         struct wim_inode *d_inode;
129
130         /* Node for the parent's red-black tree of child dentries, sorted by
131          * case sensitive long name. */
132         struct rb_node rb_node;
133
134 #ifdef __WIN32__
135         /* Node for the parent's red-black tree of child dentries, sorted by
136          * case insensitive long name. */
137         struct rb_node rb_node_case_insensitive;
138
139         /* List of dentries in a directory that have different case sensitive
140          * long names but share the same case insensitive long name */
141         struct list_head case_insensitive_conflict_list;
142 #endif
143
144         /* Length of UTF-16LE encoded short filename, in bytes, not including
145          * the terminating zero wide-character. */
146         u16 short_name_nbytes;
147
148         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
149          * the terminating null character. */
150         u16 file_name_nbytes;
151
152         /* Length of full path name encoded using "tchars", in bytes, not
153          * including the terminating null character. */
154         u32 full_path_nbytes;
155
156         /* For extraction operations, this flag will be set when a dentry in the
157          * tree being extracted is not being extracted for some reason (file
158          * type not supported by target filesystem or contains invalid
159          * characters).  Otherwise this will always be 0. */
160         u8 extraction_skipped : 1;
161
162         /* For extraction operations, this flag will be set on dentries in the
163          * tree being extracted.  */
164         u8 in_extraction_tree : 1;
165
166         /* During extraction extractions, this flag will be set after the
167          * "skeleton" of the dentry has been extracted.  */
168         u8 skeleton_extracted : 1;
169
170         /* When capturing from a NTFS volume using NTFS-3g, this flag is set on
171          * dentries that were created from a filename in the WIN32 or WIN32+DOS
172          * namespaces rather than the POSIX namespace.  Otherwise this will
173          * always be 0.  */
174         u8 is_win32_name : 1;
175
176         /* When verifying the dentry tree after reading it into memory, this
177          * flag will be set on all dentries in a hard link group that have a
178          * nonempty DOS name except one.  This is because it is supposed to be
179          * illegal (on NTFS, at least) for a single inode to have multiple DOS
180          * names.  */
181         u8 dos_name_invalid : 1;
182
183         u8 tmp_flag : 1;
184
185         u8 was_hardlinked : 1;
186
187         /* Temporary list field used to make lists of dentries in a few places.
188          * */
189         struct list_head tmp_list;
190
191         /* Linked list node that places this dentry in the list of aliases for
192          * its inode (d_inode) */
193         struct list_head d_alias;
194
195         /* The parent of this directory entry. */
196         struct wim_dentry *parent;
197
198         /* 'length' and 'subdir_offset' are only used while reading and writing
199          * this dentry; see the corresponding field in
200          * `struct wim_dentry_on_disk' for explanation.  */
201         u64 length;
202         u64 subdir_offset;
203
204         /* These correspond to the two unused fields in the on-disk WIM dentry;
205          * we read them into memory so we can write them unchanged.  These
206          * fields are set to 0 on new dentries.  */
207         u64 d_unused_1;
208         u64 d_unused_2;
209
210         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
211          * if this dentry has no short name.  */
212         utf16lechar *short_name;
213
214         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
215          * dentry has no filename.  */
216         utf16lechar *file_name;
217
218         /* Full path to this dentry in the WIM, in platform-dependent tchars
219          * that can be printed without conversion.  By default this field will
220          * be NULL and will only be calculated on-demand by the
221          * calculate_dentry_full_path() or dentry_full_path() functions.  */
222         tchar *_full_path;
223
224         /* (Extraction only) Actual name to extract this dentry as, along with
225          * its length in tchars excluding the NULL terminator.  This usually
226          * will be the same as file_name, with the character encoding converted
227          * if needed.  But if file_name contains characters not accepted on the
228          * current platform, then this may be set slightly differently from
229          * file_name.  This will be either NULL or a malloc()ed buffer that may
230          * alias file_name.  */
231         tchar *extraction_name;
232         size_t extraction_name_nchars;
233
234         /* (Extraction only) List head for building a list of dentries that
235          * contain a certain stream. */
236         struct list_head extraction_stream_list;
237 };
238
239 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
240
241 /*
242  * WIM inode.
243  *
244  * As mentioned in the comment above `struct wim_dentry', in the WIM file that
245  * is no on-disk analogue of a real inode, as most of these fields are
246  * duplicated in the dentries.  Instead, a `struct wim_inode' is something we
247  * create ourselves to simplify the handling of hard links.
248  */
249 struct wim_inode {
250         /* If i_resolved == 0:
251          *      SHA1 message digest of the contents of the unnamed-data stream
252          *      of this inode.
253          *
254          * If i_resolved == 1:
255          *      Pointer to the lookup table entry for the unnamed data stream
256          *      of this inode, or NULL.
257          *
258          * i_hash corresponds to the 'unnamed_stream_hash' field of the `struct
259          * wim_dentry_on_disk' and the additional caveats documented about that
260          * field apply here (for example, the quirks regarding all-zero hashes).
261          */
262         union {
263                 u8 i_hash[SHA1_HASH_SIZE];
264                 struct wim_lookup_table_entry *i_lte;
265         };
266
267         /* Corresponds to the 'attributes' field of `struct wim_dentry_on_disk';
268          * bitwise OR of the FILE_ATTRIBUTE_* flags that give the attributes of
269          * this inode. */
270         u32 i_attributes;
271
272         /* Root of a red-black tree storing the child dentries of this inode, if
273          * any.  Keyed by wim_dentry->file_name, case sensitively. */
274         struct rb_root i_children;
275
276 #ifdef __WIN32__
277         /* Root of a red-black tree storing the children of this inode, if any.
278          * Keyed by wim_dentry->file_name, case insensitively. */
279         struct rb_root i_children_case_insensitive;
280 #endif
281
282         /* List of dentries that are aliases for this inode.  There will be
283          * i_nlink dentries in this list.  */
284         struct list_head i_dentry;
285
286         /* Field to place this inode into a list. */
287         union {
288                 /* Hash list node- used in hardlink.c when the inodes are placed
289                  * into a hash table keyed by inode number and optionally device
290                  * number, in order to detect dentries that are aliases for the
291                  * same inode. */
292                 struct hlist_node i_hlist;
293
294                 /* Normal list node- used to connect all the inodes of a WIM image
295                  * into a single linked list referenced from the
296                  * `struct wim_image_metadata' for that image. */
297                 struct list_head i_list;
298         };
299
300         /* Number of dentries that are aliases for this inode.  */
301         u32 i_nlink;
302
303         /* Number of alternate data streams associated with this inode */
304         u16 i_num_ads;
305
306         /* Flag that indicates whether this inode's streams have been
307          * "resolved".  By default, the inode starts as "unresolved", meaning
308          * that the i_hash field, along with the hash field of any associated
309          * wim_ads_entry's, are valid and should be used as keys in the WIM
310          * lookup table to find the associated `struct wim_lookup_table_entry'.
311          * But if the inode has been resolved, then each of these fields is
312          * replaced with a pointer directly to the appropriate `struct
313          * wim_lookup_table_entry', or NULL if the stream is empty.  */
314         u8 i_resolved : 1;
315
316         /* Flag used to mark this inode as visited; this is used when visiting
317          * all the inodes in a dentry tree exactly once.  It will be 0 by
318          * default and must be cleared following the tree traversal, even in
319          * error paths.  */
320         u8 i_visited : 1;
321
322         /* Set if the DOS name of an inode has already been extracted.  */
323         u8 i_dos_name_extracted : 1;
324
325         /* Pointer to a malloc()ed array of i_num_ads alternate data stream
326          * entries for this inode.  */
327         struct wim_ads_entry *i_ads_entries;
328
329         /* Creation time, last access time, and last write time for this inode, in
330          * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601.  They
331          * should correspond to the times gotten by calling GetFileTime() on
332          * Windows. */
333         u64 i_creation_time;
334         u64 i_last_access_time;
335         u64 i_last_write_time;
336
337         /* Corresponds to 'security_id' in `struct wim_dentry_on_disk':  The
338          * index of this inode's security descriptor in the WIM image's table of
339          * security descriptors, or -1.  Note: in verify_inode(), called
340          * whenever a WIM image is loaded, out-of-bounds indices are set to -1,
341          * so the extraction code does not need to do bounds checks.  */
342         int32_t i_security_id;
343
344         /* Identity of a reparse point.  See
345          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
346          * for what a reparse point is. */
347         u32 i_reparse_tag;
348
349         /* Unused/unknown fields that we just read into memory so we can
350          * re-write them unchanged.  */
351         u32 i_rp_unknown_1;
352         u16 i_rp_unknown_2;
353
354         /* Corresponds to not_rpfixed in `struct wim_dentry_on_disk':  Set to 0
355          * if reparse point fixups have been done.  Otherwise set to 1.  Note:
356          * this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.
357          */
358         u16 i_not_rpfixed;
359
360         /* Inode number; corresponds to hard_link_group_id in the `struct
361          * wim_dentry_on_disk'.  */
362         u64 i_ino;
363
364         union {
365                 /* Device number, used only during image capture, so we can
366                  * identify hard linked files by the combination of inode number
367                  * and device number (rather than just inode number, which could
368                  * be ambigious if the captured tree spans a mountpoint).  Set
369                  * to 0 otherwise.  */
370                 u64 i_devno;
371
372                 struct {
373
374                         /* Used only during image extraction: pointer to the first path
375                          * (malloc()ed buffer) at which this inode has been extracted.
376                          * Freed and set to NULL after the extraction is done (either
377                          * success or failure).  */
378                         tchar *i_extracted_file;
379
380                         /** Used only during image extraction: "cookie" that
381                          * identifies this extracted file (inode), for example
382                          * an inode number.  Only used if supported by the
383                          * extraction mode.  */
384                         u64 extract_cookie;
385                 };
386
387 #ifdef WITH_FUSE
388                 /* Used only during image mount:  Table of file descriptors that
389                  * have been opened to this inode.  The table is automatically
390                  * freed when the last file descriptor is closed.  */
391                 struct wimfs_fd **i_fds;
392 #endif
393         };
394
395 #ifdef WITH_FUSE
396         u16 i_num_opened_fds;
397         u16 i_num_allocated_fds;
398 #endif
399
400         /* Next alternate data stream ID to be assigned */
401         u32 i_next_stream_id;
402 };
403
404 #define inode_for_each_dentry(dentry, inode) \
405                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
406
407 #define inode_add_dentry(dentry, inode) \
408                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
409
410 #define inode_first_dentry(inode) \
411                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
412
413 #define inode_first_full_path(inode) \
414                 dentry_full_path(inode_first_dentry(inode))
415
416 static inline bool
417 dentry_is_first_in_inode(const struct wim_dentry *dentry)
418 {
419         return inode_first_dentry(dentry->d_inode) == dentry;
420 }
421
422 extern u64
423 dentry_correct_total_length(const struct wim_dentry *dentry);
424
425 extern int
426 for_dentry_in_tree(struct wim_dentry *root,
427                    int (*visitor)(struct wim_dentry*, void*),
428                    void *args);
429
430 extern int
431 for_dentry_in_rbtree(struct rb_node *node,
432                      int (*visitor)(struct wim_dentry *, void *),
433                      void *arg);
434
435 static inline int
436 for_dentry_child(const struct wim_dentry *dentry,
437                  int (*visitor)(struct wim_dentry *, void *),
438                  void *arg)
439 {
440         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
441                                     visitor,
442                                     arg);
443 }
444
445 extern int
446 for_dentry_in_tree_depth(struct wim_dentry *root,
447                          int (*visitor)(struct wim_dentry*, void*),
448                          void *args);
449
450 extern void
451 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
452
453 extern int
454 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
455
456 extern struct wim_dentry *
457 get_dentry(struct WIMStruct *wim, const tchar *path);
458
459 extern struct wim_inode *
460 wim_pathname_to_inode(struct WIMStruct *wim, const tchar *path);
461
462 extern struct wim_dentry *
463 get_dentry_child_with_name(const struct wim_dentry *dentry,
464                            const tchar *name);
465
466 extern struct wim_dentry *
467 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
468                                    const utf16lechar *name,
469                                    size_t name_nbytes);
470
471 extern struct wim_dentry *
472 get_parent_dentry(struct WIMStruct *wim, const tchar *path);
473
474 extern int
475 print_dentry(struct wim_dentry *dentry, void *lookup_table);
476
477 extern int
478 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
479
480 extern int
481 calculate_dentry_full_path(struct wim_dentry *dentry);
482
483 extern int
484 calculate_dentry_tree_full_paths(struct wim_dentry *root);
485
486 extern tchar *
487 dentry_full_path(struct wim_dentry *dentry);
488
489 extern struct wim_inode *
490 new_timeless_inode(void) _malloc_attribute;
491
492 extern int
493 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
494
495 extern int
496 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
497
498 extern int
499 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
500
501 extern void
502 dentry_tree_clear_inode_visited(struct wim_dentry *root);
503
504 extern int
505 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
506
507 extern void
508 free_inode(struct wim_inode *inode);
509
510 extern void
511 free_dentry(struct wim_dentry *dentry);
512
513 extern void
514 put_dentry(struct wim_dentry *dentry);
515
516 extern void
517 free_dentry_tree(struct wim_dentry *root,
518                  struct wim_lookup_table *lookup_table);
519
520 extern void
521 unlink_dentry(struct wim_dentry *dentry);
522
523 extern struct wim_dentry *
524 dentry_add_child(struct wim_dentry * restrict parent,
525                  struct wim_dentry * restrict child);
526
527 extern struct wim_ads_entry *
528 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
529                     u16 *idx_ret);
530
531 extern struct wim_ads_entry *
532 inode_add_ads_utf16le(struct wim_inode *inode,
533                       const utf16lechar *stream_name,
534                       size_t stream_name_nbytes);
535
536 extern struct wim_ads_entry *
537 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
538
539 extern int
540 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
541                         const void *value, size_t size,
542                         struct wim_lookup_table *lookup_table);
543
544 bool
545 inode_has_named_stream(const struct wim_inode *inode);
546
547 extern int
548 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
549                          struct wim_lookup_table *lookup_table);
550
551 extern void
552 inode_remove_ads(struct wim_inode *inode, u16 idx,
553                  struct wim_lookup_table *lookup_table);
554
555
556 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
557 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
558
559 #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"
560 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
561
562 static inline bool
563 ads_entry_is_unix_data(const struct wim_ads_entry *entry)
564 {
565         return (entry->stream_name_nbytes ==
566                         WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES) &&
567                 !memcmp(entry->stream_name, WIMLIB_UNIX_DATA_TAG_UTF16LE,
568                         WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES);
569 }
570
571 static inline bool
572 ads_entry_is_named_stream(const struct wim_ads_entry *entry)
573 {
574         return entry->stream_name_nbytes != 0 && !ads_entry_is_unix_data(entry);
575 }
576
577 #ifndef __WIN32__
578 /* Format for special alternate data stream entries to store UNIX data for files
579  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
580 struct wimlib_unix_data {
581         u16 version; /* Must be 0 */
582         u16 uid;
583         u16 gid;
584         u16 mode;
585 } _packed_attribute;
586
587 #define NO_UNIX_DATA (-1)
588 #define BAD_UNIX_DATA (-2)
589 extern int
590 inode_get_unix_data(const struct wim_inode *inode,
591                     struct wimlib_unix_data *unix_data,
592                     u16 *stream_idx_ret);
593
594 #define UNIX_DATA_UID    0x1
595 #define UNIX_DATA_GID    0x2
596 #define UNIX_DATA_MODE   0x4
597 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
598 #define UNIX_DATA_CREATE 0x8
599 extern int
600 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
601                     struct wim_lookup_table *lookup_table, int which);
602 #endif /* !__WIN32__ */
603
604 extern bool
605 inode_has_unix_data(const struct wim_inode *inode);
606
607 extern int
608 read_dentry(const u8 * restrict metadata_resource,
609             u64 metadata_resource_len, u64 offset,
610             struct wim_dentry * restrict dentry);
611
612 extern int
613 read_dentry_tree(const u8 * restrict metadata_resource,
614                  u64 metadata_resource_len,
615                  struct wim_dentry * restrict dentry);
616
617 extern u8 *
618 write_dentry_tree(const struct wim_dentry * restrict tree,
619                   u8 * restrict p);
620
621 static inline bool
622 dentry_is_root(const struct wim_dentry *dentry)
623 {
624         return dentry->parent == dentry;
625 }
626
627 static inline bool
628 inode_is_directory(const struct wim_inode *inode)
629 {
630         return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
631                                        FILE_ATTRIBUTE_REPARSE_POINT))
632                         == FILE_ATTRIBUTE_DIRECTORY;
633 }
634
635 static inline bool
636 inode_is_encrypted_directory(const struct wim_inode *inode)
637 {
638         return ((inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
639                                         FILE_ATTRIBUTE_ENCRYPTED))
640                 == (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_ENCRYPTED));
641 }
642
643 static inline bool
644 dentry_is_directory(const struct wim_dentry *dentry)
645 {
646         return inode_is_directory(dentry->d_inode);
647 }
648
649 /* For our purposes, we consider "real" symlinks and "junction points" to both
650  * be symlinks. */
651 static inline bool
652 inode_is_symlink(const struct wim_inode *inode)
653 {
654         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
655                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
656                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
657 }
658
659 static inline bool
660 inode_has_children(const struct wim_inode *inode)
661 {
662         return inode->i_children.rb_node != NULL;
663 }
664
665 static inline bool
666 dentry_has_children(const struct wim_dentry *dentry)
667 {
668         return inode_has_children(dentry->d_inode);
669 }
670
671 static inline bool
672 dentry_has_short_name(const struct wim_dentry *dentry)
673 {
674         return dentry->short_name_nbytes != 0;
675 }
676
677 static inline bool
678 dentry_has_long_name(const struct wim_dentry *dentry)
679 {
680         return dentry->file_name_nbytes != 0;
681 }
682
683 extern void
684 inode_ref_streams(struct wim_inode *inode);
685
686 extern int
687 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
688
689 extern int
690 verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
691
692 #endif /* _WIMLIB_DENTRY_H */