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