wimlib.net Git - wimlib/blob - 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, a subtree of dentries will have this flag
 157          * set so we can keep track of which dentries still need to be
 158          * extracted.  Otherwise this will always be 0.  */
 159         u8 needs_extraction : 1;
 160
 161         /* For extraction operations, this flag will be set when a dentry in the
 162          * tree being extracted is not being extracted for some reason (file
 163          * type not supported by target filesystem or contains invalid
 164          * characters).  Otherwise this will always be 0. */
 165         u8 not_extracted : 1;
 166
 167         /* When capturing from a NTFS volume using NTFS-3g, this flag is set on
 168          * dentries that were created from a filename in the WIN32 or WIN32+DOS
 169          * namespaces rather than the POSIX namespace.  Otherwise this will
 170          * always be 0.  */
 171         u8 is_win32_name : 1;
 172
 173         /* When verifying the dentry tree after reading it into memory, this
 174          * flag will be set on all dentries in a hard link group that have a
 175          * nonempty DOS name except one.  This is because it is supposed to be
 176          * illegal (on NTFS, at least) for a single inode to have multiple DOS
 177          * names.  */
 178         u8 dos_name_invalid : 1;
 179
 180         /* Temporary list field used to make lists of dentries in a few places.
 181          * */
 182         struct list_head tmp_list;
 183
 184         /* Linked list node that places this dentry in the list of aliases for
 185          * its inode (d_inode) */
 186         struct list_head d_alias;
 187
 188         /* The parent of this directory entry. */
 189         struct wim_dentry *parent;
 190
 191         /* 'length' and 'subdir_offset' are only used while reading and writing
 192          * this dentry; see the corresponding field in
 193          * `struct wim_dentry_on_disk' for explanation.  */
 194         u64 length;
 195         u64 subdir_offset;
 196
 197         /* These correspond to the two unused fields in the on-disk WIM dentry;
 198          * we read them into memory so we can write them unchanged.  These
 199          * fields are set to 0 on new dentries.  */
 200         u64 d_unused_1;
 201         u64 d_unused_2;
 202
 203         /* Pointer to the UTF-16LE short filename (malloc()ed buffer), or NULL
 204          * if this dentry has no short name.  */
 205         utf16lechar *short_name;
 206
 207         /* Pointer to the UTF-16LE filename (malloc()ed buffer), or NULL if this
 208          * dentry has no filename.  */
 209         utf16lechar *file_name;
 210
 211         /* Full path to this dentry in the WIM, in platform-dependent tchars
 212          * that can be printed without conversion.  By default this field will
 213          * be NULL and will only be calculated on-demand by the
 214          * calculate_dentry_full_path() or dentry_full_path() functions.  */
 215         tchar *_full_path;
 216
 217         /* (Extraction only) Actual name to extract this dentry as, along with
 218          * its length in tchars excluding the NULL terminator.  This usually
 219          * will be the same as file_name, with the character encoding converted
 220          * if needed.  But if file_name contains characters not accepted on the
 221          * current platform, then this may be set slightly differently from
 222          * file_name.  This will be either NULL or a malloc()ed buffer that may
 223          * alias file_name.  */
 224         tchar *extraction_name;
 225         size_t extraction_name_nchars;
 226
 227         /* (Extraction only) List head for building a list of dentries that
 228          * contain a certain stream. */
 229         struct list_head extraction_stream_list;
 230 };
 231
 232 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
 233
 234 /*
 235  * WIM inode.
 236  *
 237  * As mentioned in the comment above `struct wim_dentry', in the WIM file that
 238  * is no on-disk analogue of a real inode, as most of these fields are
 239  * duplicated in the dentries.  Instead, a `struct wim_inode' is something we
 240  * create ourselves to simplify the handling of hard links.
 241  */
 242 struct wim_inode {
 243         /* If i_resolved == 0:
 244          *      SHA1 message digest of the contents of the unnamed-data stream
 245          *      of this inode.
 246          *
 247          * If i_resolved == 1:
 248          *      Pointer to the lookup table entry for the unnamed data stream
 249          *      of this inode, or NULL.
 250          *
 251          * i_hash corresponds to the 'unnamed_stream_hash' field of the `struct
 252          * wim_dentry_on_disk' and the additional caveats documented about that
 253          * field apply here (for example, the quirks regarding all-zero hashes).
 254          */
 255         union {
 256                 u8 i_hash[SHA1_HASH_SIZE];
 257                 struct wim_lookup_table_entry *i_lte;
 258         };
 259
 260         /* Corresponds to the 'attributes' field of `struct wim_dentry_on_disk';
 261          * bitwise OR of the FILE_ATTRIBUTE_* flags that give the attributes of
 262          * this inode. */
 263         u32 i_attributes;
 264
 265         /* Root of a red-black tree storing the child dentries of this inode, if
 266          * any.  Keyed by wim_dentry->file_name, case sensitively. */
 267         struct rb_root i_children;
 268
 269 #ifdef __WIN32__
 270         /* Root of a red-black tree storing the children of this inode, if any.
 271          * Keyed by wim_dentry->file_name, case insensitively. */
 272         struct rb_root i_children_case_insensitive;
 273 #endif
 274
 275         /* List of dentries that are aliases for this inode.  There will be
 276          * i_nlink dentries in this list.  */
 277         struct list_head i_dentry;
 278
 279         /* Field to place this inode into a list. */
 280         union {
 281                 /* Hash list node- used in hardlink.c when the inodes are placed
 282                  * into a hash table keyed by inode number and optionally device
 283                  * number, in order to detect dentries that are aliases for the
 284                  * same inode. */
 285                 struct hlist_node i_hlist;
 286
 287                 /* Normal list node- used to connect all the inodes of a WIM image
 288                  * into a single linked list referenced from the
 289                  * `struct wim_image_metadata' for that image. */
 290                 struct list_head i_list;
 291         };
 292
 293         /* Number of dentries that are aliases for this inode.  */
 294         u32 i_nlink;
 295
 296         /* Number of alternate data streams associated with this inode */
 297         u16 i_num_ads;
 298
 299         /* Flag that indicates whether this inode's streams have been
 300          * "resolved".  By default, the inode starts as "unresolved", meaning
 301          * that the i_hash field, along with the hash field of any associated
 302          * wim_ads_entry's, are valid and should be used as keys in the WIM
 303          * lookup table to find the associated `struct wim_lookup_table_entry'.
 304          * But if the inode has been resolved, then each of these fields is
 305          * replaced with a pointer directly to the appropriate `struct
 306          * wim_lookup_table_entry', or NULL if the stream is empty.  */
 307         u8 i_resolved : 1;
 308
 309         /* Flag used to mark this inode as visited; this is used when visiting
 310          * all the inodes in a dentry tree exactly once.  It will be 0 by
 311          * default and must be cleared following the tree traversal, even in
 312          * error paths.  */
 313         u8 i_visited : 1;
 314
 315         /* For NTFS-3g extraction:  Set after the DOS name for this inode has
 316          * been extracted.  */
 317         u8 i_dos_name_extracted : 1;
 318
 319         /* Pointer to a malloc()ed array of i_num_ads alternate data stream
 320          * entries for this inode.  */
 321         struct wim_ads_entry *i_ads_entries;
 322
 323         /* Creation time, last access time, and last write time for this inode, in
 324          * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601.  They
 325          * should correspond to the times gotten by calling GetFileTime() on
 326          * Windows. */
 327         u64 i_creation_time;
 328         u64 i_last_access_time;
 329         u64 i_last_write_time;
 330
 331         /* Corresponds to 'security_id' in `struct wim_dentry_on_disk':  The
 332          * index of this inode's security descriptor in the WIM image's table of
 333          * security descriptors, or -1.  Note: in verify_inode(), called
 334          * whenever a WIM image is loaded, out-of-bounds indices are set to -1,
 335          * so the extraction code does not need to do bounds checks.  */
 336         int32_t i_security_id;
 337
 338         /* Identity of a reparse point.  See
 339          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
 340          * for what a reparse point is. */
 341         u32 i_reparse_tag;
 342
 343         /* Unused/unknown fields that we just read into memory so we can
 344          * re-write them unchanged.  */
 345         u32 i_rp_unknown_1;
 346         u16 i_rp_unknown_2;
 347
 348         /* Corresponds to not_rpfixed in `struct wim_dentry_on_disk':  Set to 0
 349          * if reparse point fixups have been done.  Otherwise set to 1.  Note:
 350          * this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.
 351          */
 352         u16 i_not_rpfixed;
 353
 354         /* Inode number; corresponds to hard_link_group_id in the `struct
 355          * wim_dentry_on_disk'.  */
 356         u64 i_ino;
 357
 358         union {
 359                 /* Device number, used only during image capture, so we can
 360                  * identify hard linked files by the combination of inode number
 361                  * and device number (rather than just inode number, which could
 362                  * be ambigious if the captured tree spans a mountpoint).  Set
 363                  * to 0 otherwise.  */
 364                 u64 i_devno;
 365
 366                 /* Used only during image extraction: pointer to the first path
 367                  * (malloc()ed buffer) at which this inode has been extracted.
 368                  * Freed and set to NULL after the extraction is done (either
 369                  * success or failure).  */
 370                 tchar *i_extracted_file;
 371
 372 #ifdef WITH_FUSE
 373                 /* Used only during image mount:  Table of file descriptors that
 374                  * have been opened to this inode.  The table is automatically
 375                  * freed when the last file descriptor is closed.  */
 376                 struct {
 377                         struct wimfs_fd **i_fds;
 378                         u16 i_num_opened_fds;
 379                         u16 i_num_allocated_fds;
 380                 };
 381 #endif
 382         };
 383
 384         /* Next alternate data stream ID to be assigned */
 385         u32 i_next_stream_id;
 386 };
 387
 388 #define inode_for_each_dentry(dentry, inode) \
 389                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
 390
 391 #define inode_add_dentry(dentry, inode) \
 392                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
 393
 394 #define inode_first_dentry(inode) \
 395                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
 396
 397 #define inode_first_full_path(inode) \
 398                 dentry_full_path(inode_first_dentry(inode))
 399
 400 static inline bool
 401 dentry_is_first_in_inode(const struct wim_dentry *dentry)
 402 {
 403         return inode_first_dentry(dentry->d_inode) == dentry;
 404 }
 405
 406 extern u64
 407 dentry_correct_total_length(const struct wim_dentry *dentry);
 408
 409 extern int
 410 for_dentry_in_tree(struct wim_dentry *root,
 411                    int (*visitor)(struct wim_dentry*, void*),
 412                    void *args);
 413
 414 extern int
 415 for_dentry_in_rbtree(struct rb_node *node,
 416                      int (*visitor)(struct wim_dentry *, void *),
 417                      void *arg);
 418
 419 static inline int
 420 for_dentry_child(const struct wim_dentry *dentry,
 421                  int (*visitor)(struct wim_dentry *, void *),
 422                  void *arg)
 423 {
 424         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
 425                                     visitor,
 426                                     arg);
 427 }
 428
 429 extern int
 430 for_dentry_in_tree_depth(struct wim_dentry *root,
 431                          int (*visitor)(struct wim_dentry*, void*),
 432                          void *args);
 433
 434 extern void
 435 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
 436
 437 extern int
 438 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
 439
 440 extern struct wim_dentry *
 441 get_dentry(struct WIMStruct *wim, const tchar *path);
 442
 443 extern struct wim_inode *
 444 wim_pathname_to_inode(struct WIMStruct *wim, const tchar *path);
 445
 446 extern struct wim_dentry *
 447 get_dentry_child_with_name(const struct wim_dentry *dentry,
 448                            const tchar *name);
 449
 450 extern struct wim_dentry *
 451 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
 452                                    const utf16lechar *name,
 453                                    size_t name_nbytes);
 454
 455 extern struct wim_dentry *
 456 get_parent_dentry(struct WIMStruct *wim, const tchar *path);
 457
 458 extern int
 459 print_dentry(struct wim_dentry *dentry, void *lookup_table);
 460
 461 extern int
 462 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
 463
 464 extern int
 465 calculate_dentry_full_path(struct wim_dentry *dentry);
 466
 467 extern int
 468 calculate_dentry_tree_full_paths(struct wim_dentry *root);
 469
 470 extern tchar *
 471 dentry_full_path(struct wim_dentry *dentry);
 472
 473 extern struct wim_inode *
 474 new_timeless_inode(void) _malloc_attribute;
 475
 476 extern int
 477 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 478
 479 extern int
 480 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 481
 482 extern int
 483 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 484
 485 extern int
 486 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
 487
 488 extern void
 489 free_inode(struct wim_inode *inode);
 490
 491 extern void
 492 free_dentry(struct wim_dentry *dentry);
 493
 494 extern void
 495 put_dentry(struct wim_dentry *dentry);
 496
 497 extern void
 498 free_dentry_tree(struct wim_dentry *root,
 499                  struct wim_lookup_table *lookup_table);
 500
 501 extern void
 502 unlink_dentry(struct wim_dentry *dentry);
 503
 504 extern struct wim_dentry *
 505 dentry_add_child(struct wim_dentry * restrict parent,
 506                  struct wim_dentry * restrict child);
 507
 508 extern struct wim_ads_entry *
 509 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
 510                     u16 *idx_ret);
 511
 512 extern struct wim_ads_entry *
 513 inode_add_ads_utf16le(struct wim_inode *inode,
 514                       const utf16lechar *stream_name,
 515                       size_t stream_name_nbytes);
 516
 517 extern struct wim_ads_entry *
 518 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
 519
 520 extern int
 521 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
 522                         const void *value, size_t size,
 523                         struct wim_lookup_table *lookup_table);
 524
 525 extern int
 526 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
 527                          struct wim_lookup_table *lookup_table);
 528
 529 extern void
 530 inode_remove_ads(struct wim_inode *inode, u16 idx,
 531                  struct wim_lookup_table *lookup_table);
 532
 533
 534 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
 535 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
 536
 537 #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"
 538 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
 539
 540 /* Format for special alternate data stream entries to store UNIX data for files
 541  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
 542 struct wimlib_unix_data {
 543         u16 version; /* Must be 0 */
 544         u16 uid;
 545         u16 gid;
 546         u16 mode;
 547 } _packed_attribute;
 548
 549 #ifndef __WIN32__
 550
 551 #define NO_UNIX_DATA (-1)
 552 #define BAD_UNIX_DATA (-2)
 553 extern int
 554 inode_get_unix_data(const struct wim_inode *inode,
 555                     struct wimlib_unix_data *unix_data,
 556                     u16 *stream_idx_ret);
 557
 558 #define UNIX_DATA_UID    0x1
 559 #define UNIX_DATA_GID    0x2
 560 #define UNIX_DATA_MODE   0x4
 561 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
 562 #define UNIX_DATA_CREATE 0x8
 563 extern int
 564 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
 565                     struct wim_lookup_table *lookup_table, int which);
 566 #endif
 567
 568 extern int
 569 read_dentry(const u8 * restrict metadata_resource,
 570             u64 metadata_resource_len, u64 offset,
 571             struct wim_dentry * restrict dentry);
 572
 573 extern int
 574 read_dentry_tree(const u8 * restrict metadata_resource,
 575                  u64 metadata_resource_len,
 576                  struct wim_dentry * restrict dentry);
 577
 578 extern u8 *
 579 write_dentry_tree(const struct wim_dentry * restrict tree,
 580                   u8 * restrict p);
 581
 582 static inline bool
 583 dentry_is_root(const struct wim_dentry *dentry)
 584 {
 585         return dentry->parent == dentry;
 586 }
 587
 588 static inline bool
 589 inode_is_directory(const struct wim_inode *inode)
 590 {
 591         return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
 592                                        FILE_ATTRIBUTE_REPARSE_POINT))
 593                         == FILE_ATTRIBUTE_DIRECTORY;
 594 }
 595
 596 static inline bool
 597 dentry_is_directory(const struct wim_dentry *dentry)
 598 {
 599         return inode_is_directory(dentry->d_inode);
 600 }
 601
 602 /* For our purposes, we consider "real" symlinks and "junction points" to both
 603  * be symlinks. */
 604 static inline bool
 605 inode_is_symlink(const struct wim_inode *inode)
 606 {
 607         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
 608                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
 609                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
 610 }
 611
 612 static inline bool
 613 inode_has_children(const struct wim_inode *inode)
 614 {
 615         return inode->i_children.rb_node != NULL;
 616 }
 617
 618 static inline bool
 619 dentry_has_children(const struct wim_dentry *dentry)
 620 {
 621         return inode_has_children(dentry->d_inode);
 622 }
 623
 624 static inline bool
 625 dentry_has_short_name(const struct wim_dentry *dentry)
 626 {
 627         return dentry->short_name_nbytes != 0;
 628 }
 629
 630 static inline bool
 631 dentry_has_long_name(const struct wim_dentry *dentry)
 632 {
 633         return dentry->file_name_nbytes != 0;
 634 }
 635
 636 extern void
 637 inode_ref_streams(struct wim_inode *inode);
 638
 639 extern int
 640 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 641
 642 extern int
 643 verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
 644
 645 #endif /* _WIMLIB_DENTRY_H */