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, 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 (ADS) 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         /* 1 iff all ADS entries of this inode are named or if this inode
 326          * has no ADS entries  */
 327         u8 i_canonical_streams : 1;
 328
 329         /* Pointer to a malloc()ed array of i_num_ads alternate data stream
 330          * entries for this inode.  */
 331         struct wim_ads_entry *i_ads_entries;
 332
 333         /* Creation time, last access time, and last write time for this inode, in
 334          * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601.  They
 335          * should correspond to the times gotten by calling GetFileTime() on
 336          * Windows. */
 337         u64 i_creation_time;
 338         u64 i_last_access_time;
 339         u64 i_last_write_time;
 340
 341         /* Corresponds to 'security_id' in `struct wim_dentry_on_disk':  The
 342          * index of this inode's security descriptor in the WIM image's table of
 343          * security descriptors, or -1.  Note: in verify_inode(), called
 344          * whenever a WIM image is loaded, out-of-bounds indices are set to -1,
 345          * so the extraction code does not need to do bounds checks.  */
 346         int32_t i_security_id;
 347
 348         /* Identity of a reparse point.  See
 349          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
 350          * for what a reparse point is. */
 351         u32 i_reparse_tag;
 352
 353         /* Unused/unknown fields that we just read into memory so we can
 354          * re-write them unchanged.  */
 355         u32 i_rp_unknown_1;
 356         u16 i_rp_unknown_2;
 357
 358         /* Corresponds to not_rpfixed in `struct wim_dentry_on_disk':  Set to 0
 359          * if reparse point fixups have been done.  Otherwise set to 1.  Note:
 360          * this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.
 361          */
 362         u16 i_not_rpfixed;
 363
 364         /* Inode number; corresponds to hard_link_group_id in the `struct
 365          * wim_dentry_on_disk'.  */
 366         u64 i_ino;
 367
 368         union {
 369                 /* Device number, used only during image capture, so we can
 370                  * identify hard linked files by the combination of inode number
 371                  * and device number (rather than just inode number, which could
 372                  * be ambigious if the captured tree spans a mountpoint).  Set
 373                  * to 0 otherwise.  */
 374                 u64 i_devno;
 375
 376                 struct {
 377
 378                         /* Used only during image extraction: pointer to the first path
 379                          * (malloc()ed buffer) at which this inode has been extracted.
 380                          * Freed and set to NULL after the extraction is done (either
 381                          * success or failure).  */
 382                         tchar *i_extracted_file;
 383
 384                         /** Used only during image extraction: "cookie" that
 385                          * identifies this extracted file (inode), for example
 386                          * an inode number.  Only used if supported by the
 387                          * extraction mode.  */
 388                         u64 extract_cookie;
 389                 };
 390
 391 #ifdef WITH_FUSE
 392                 /* Used only during image mount:  Table of file descriptors that
 393                  * have been opened to this inode.  The table is automatically
 394                  * freed when the last file descriptor is closed.  */
 395                 struct wimfs_fd **i_fds;
 396 #endif
 397         };
 398
 399 #ifdef WITH_FUSE
 400         u16 i_num_opened_fds;
 401         u16 i_num_allocated_fds;
 402 #endif
 403
 404         /* Next alternate data stream ID to be assigned */
 405         u32 i_next_stream_id;
 406 };
 407
 408 #define inode_for_each_dentry(dentry, inode) \
 409                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
 410
 411 #define inode_add_dentry(dentry, inode) \
 412                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
 413
 414 #define inode_first_dentry(inode) \
 415                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
 416
 417 #define inode_first_full_path(inode) \
 418                 dentry_full_path(inode_first_dentry(inode))
 419
 420 static inline bool
 421 dentry_is_first_in_inode(const struct wim_dentry *dentry)
 422 {
 423         return inode_first_dentry(dentry->d_inode) == dentry;
 424 }
 425
 426 extern u64
 427 dentry_out_total_length(const struct wim_dentry *dentry);
 428
 429 extern int
 430 for_dentry_in_tree(struct wim_dentry *root,
 431                    int (*visitor)(struct wim_dentry*, void*),
 432                    void *args);
 433
 434 extern int
 435 for_dentry_in_rbtree(struct rb_node *node,
 436                      int (*visitor)(struct wim_dentry *, void *),
 437                      void *arg);
 438
 439 static inline int
 440 for_dentry_child(const struct wim_dentry *dentry,
 441                  int (*visitor)(struct wim_dentry *, void *),
 442                  void *arg)
 443 {
 444         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
 445                                     visitor,
 446                                     arg);
 447 }
 448
 449 extern int
 450 for_dentry_in_tree_depth(struct wim_dentry *root,
 451                          int (*visitor)(struct wim_dentry*, void*),
 452                          void *args);
 453
 454 extern void
 455 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
 456
 457 extern int
 458 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
 459
 460 extern struct wim_dentry *
 461 get_dentry(struct WIMStruct *wim, const tchar *path);
 462
 463 extern struct wim_inode *
 464 wim_pathname_to_inode(struct WIMStruct *wim, const tchar *path);
 465
 466 extern struct wim_dentry *
 467 get_dentry_child_with_name(const struct wim_dentry *dentry,
 468                            const tchar *name);
 469
 470 extern struct wim_dentry *
 471 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
 472                                    const utf16lechar *name,
 473                                    size_t name_nbytes);
 474
 475 extern struct wim_dentry *
 476 get_parent_dentry(struct WIMStruct *wim, const tchar *path);
 477
 478 extern int
 479 print_dentry(struct wim_dentry *dentry, void *lookup_table);
 480
 481 extern int
 482 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
 483
 484 extern int
 485 calculate_dentry_full_path(struct wim_dentry *dentry);
 486
 487 extern int
 488 calculate_dentry_tree_full_paths(struct wim_dentry *root);
 489
 490 extern tchar *
 491 dentry_full_path(struct wim_dentry *dentry);
 492
 493 extern struct wim_inode *
 494 new_timeless_inode(void) _malloc_attribute;
 495
 496 extern int
 497 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
 498
 499 extern int
 500 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
 501
 502 extern int
 503 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
 504
 505 extern void
 506 dentry_tree_clear_inode_visited(struct wim_dentry *root);
 507
 508 extern int
 509 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
 510
 511 extern void
 512 free_inode(struct wim_inode *inode);
 513
 514 extern void
 515 free_dentry(struct wim_dentry *dentry);
 516
 517 extern void
 518 put_dentry(struct wim_dentry *dentry);
 519
 520 extern void
 521 free_dentry_tree(struct wim_dentry *root,
 522                  struct wim_lookup_table *lookup_table);
 523
 524 extern void
 525 unlink_dentry(struct wim_dentry *dentry);
 526
 527 extern struct wim_dentry *
 528 dentry_add_child(struct wim_dentry * restrict parent,
 529                  struct wim_dentry * restrict child);
 530
 531 extern struct wim_ads_entry *
 532 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
 533                     u16 *idx_ret);
 534
 535 extern struct wim_ads_entry *
 536 inode_add_ads_utf16le(struct wim_inode *inode,
 537                       const utf16lechar *stream_name,
 538                       size_t stream_name_nbytes);
 539
 540 extern struct wim_ads_entry *
 541 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
 542
 543 extern int
 544 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
 545                         const void *value, size_t size,
 546                         struct wim_lookup_table *lookup_table);
 547
 548 bool
 549 inode_has_named_stream(const struct wim_inode *inode);
 550
 551 extern int
 552 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
 553                          struct wim_lookup_table *lookup_table);
 554
 555 extern void
 556 inode_remove_ads(struct wim_inode *inode, u16 idx,
 557                  struct wim_lookup_table *lookup_table);
 558
 559
 560 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
 561 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
 562
 563 #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"
 564 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
 565
 566 static inline bool
 567 ads_entry_is_unix_data(const struct wim_ads_entry *entry)
 568 {
 569         return (entry->stream_name_nbytes ==
 570                         WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES) &&
 571                 !memcmp(entry->stream_name, WIMLIB_UNIX_DATA_TAG_UTF16LE,
 572                         WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES);
 573 }
 574
 575 static inline bool
 576 ads_entry_is_named_stream(const struct wim_ads_entry *entry)
 577 {
 578         return entry->stream_name_nbytes != 0 && !ads_entry_is_unix_data(entry);
 579 }
 580
 581 #ifndef __WIN32__
 582 /* Format for special alternate data stream entries to store UNIX data for files
 583  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
 584 struct wimlib_unix_data {
 585         u16 version; /* Must be 0 */
 586         u16 uid;
 587         u16 gid;
 588         u16 mode;
 589 } _packed_attribute;
 590
 591 #define NO_UNIX_DATA (-1)
 592 #define BAD_UNIX_DATA (-2)
 593 extern int
 594 inode_get_unix_data(const struct wim_inode *inode,
 595                     struct wimlib_unix_data *unix_data,
 596                     u16 *stream_idx_ret);
 597
 598 #define UNIX_DATA_UID    0x1
 599 #define UNIX_DATA_GID    0x2
 600 #define UNIX_DATA_MODE   0x4
 601 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
 602 #define UNIX_DATA_CREATE 0x8
 603 extern int
 604 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
 605                     struct wim_lookup_table *lookup_table, int which);
 606 #endif /* !__WIN32__ */
 607
 608 extern bool
 609 inode_has_unix_data(const struct wim_inode *inode);
 610
 611 extern int
 612 read_dentry(const u8 * restrict metadata_resource,
 613             u64 metadata_resource_len, u64 offset,
 614             struct wim_dentry * restrict dentry);
 615
 616 extern int
 617 read_dentry_tree(const u8 * restrict metadata_resource,
 618                  u64 metadata_resource_len,
 619                  struct wim_dentry * restrict dentry);
 620
 621 extern u8 *
 622 write_dentry_tree(const struct wim_dentry * restrict tree,
 623                   u8 * restrict p);
 624
 625 static inline bool
 626 dentry_is_root(const struct wim_dentry *dentry)
 627 {
 628         return dentry->parent == dentry;
 629 }
 630
 631 static inline bool
 632 inode_is_directory(const struct wim_inode *inode)
 633 {
 634         return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
 635                                        FILE_ATTRIBUTE_REPARSE_POINT))
 636                         == FILE_ATTRIBUTE_DIRECTORY;
 637 }
 638
 639 static inline bool
 640 inode_is_encrypted_directory(const struct wim_inode *inode)
 641 {
 642         return ((inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
 643                                         FILE_ATTRIBUTE_ENCRYPTED))
 644                 == (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_ENCRYPTED));
 645 }
 646
 647 static inline bool
 648 dentry_is_directory(const struct wim_dentry *dentry)
 649 {
 650         return inode_is_directory(dentry->d_inode);
 651 }
 652
 653 /* For our purposes, we consider "real" symlinks and "junction points" to both
 654  * be symlinks. */
 655 static inline bool
 656 inode_is_symlink(const struct wim_inode *inode)
 657 {
 658         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
 659                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
 660                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
 661 }
 662
 663 static inline bool
 664 inode_has_children(const struct wim_inode *inode)
 665 {
 666         return inode->i_children.rb_node != NULL;
 667 }
 668
 669 static inline bool
 670 dentry_has_children(const struct wim_dentry *dentry)
 671 {
 672         return inode_has_children(dentry->d_inode);
 673 }
 674
 675 static inline bool
 676 dentry_has_short_name(const struct wim_dentry *dentry)
 677 {
 678         return dentry->short_name_nbytes != 0;
 679 }
 680
 681 static inline bool
 682 dentry_has_long_name(const struct wim_dentry *dentry)
 683 {
 684         return dentry->file_name_nbytes != 0;
 685 }
 686
 687 extern void
 688 inode_ref_streams(struct wim_inode *inode);
 689
 690 extern int
 691 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 692
 693 extern int
 694 verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
 695
 696 #endif /* _WIMLIB_DENTRY_H */