wimlib.net Git - wimlib/blob - src/dentry.h

   1 #ifndef _WIMLIB_DENTRY_H
   2 #define _WIMLIB_DENTRY_H
   3
   4 #include "util.h"
   5 #include "config.h"
   6 #include "list.h"
   7 #include "sha1.h"
   8 #include "rbtree.h"
   9 #include <string.h>
  10
  11 #ifdef WITH_FUSE
  12 #include <pthread.h>
  13 #endif
  14
  15 struct stat;
  16 struct lookup_table;
  17 struct WIMStruct;
  18 struct lookup_table_entry;
  19 struct wimlib_fd;
  20 struct inode;
  21 struct dentry;
  22
  23 /* Size of the struct dentry up to and including the file_name_len. */
  24 #define WIM_DENTRY_DISK_SIZE    102
  25
  26 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
  27  * including the stream length field (see below). */
  28 #define WIM_ADS_ENTRY_DISK_SIZE 38
  29
  30 /*
  31  * Reparse tags documented at
  32  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
  33  */
  34 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
  35 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
  36 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
  37 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
  38 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
  39 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
  40 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
  41 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
  42 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
  43 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
  44 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
  45
  46 #define FILE_ATTRIBUTE_READONLY            0x00000001
  47 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
  48 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
  49 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
  50 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
  51 #define FILE_ATTRIBUTE_DEVICE              0x00000040
  52 #define FILE_ATTRIBUTE_NORMAL              0x00000080
  53 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
  54 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
  55 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
  56 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
  57 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
  58 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
  59 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
  60 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
  61
  62
  63 /* Alternate data stream entry.
  64  *
  65  * We read this from disk in the read_ads_entries() function; see that function
  66  * for more explanation. */
  67 struct ads_entry {
  68         union {
  69                 /* SHA-1 message digest of stream contents */
  70                 u8 hash[SHA1_HASH_SIZE];
  71
  72                 /* The corresponding lookup table entry (only for resolved
  73                  * streams) */
  74                 struct lookup_table_entry *lte;
  75         };
  76
  77         /* Length of stream name (UTF-16).  This is in bytes, not characters,
  78          * and does not include the terminating null character   */
  79         u16 stream_name_len;
  80
  81         /* Length of stream name (UTF-8) */
  82         u16 stream_name_utf8_len;
  83
  84         /* Stream name (UTF-16) */
  85         char *stream_name;
  86
  87         /* Stream name (UTF-8) */
  88         char *stream_name_utf8;
  89
  90 #ifdef WITH_FUSE
  91         /* Number to identify an alternate data stream even after it's possibly
  92          * been moved or renamed. */
  93         u32 stream_id;
  94 #endif
  95 };
  96
  97
  98 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
  99                                               const struct ads_entry *entry_2)
 100 {
 101         if (entry_1->stream_name_len != entry_2->stream_name_len)
 102                 return false;
 103         return memcmp(entry_1->stream_name, entry_2->stream_name,
 104                       entry_1->stream_name_len) == 0;
 105 }
 106
 107 /*
 108  * In-memory structure for a WIM directory entry (dentry).  There is a directory
 109  * tree for each image in the WIM.
 110  *
 111  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
 112  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
 113  * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
 114  * inode that the dentry corresponds to.
 115  *
 116  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
 117  * information, such as file attributes, the security descriptor, and file
 118  * streams is replicated in each hard-linked dentry, even though this
 119  * information really is associated with an inode.  In-memory, we fix up this
 120  * flaw by allocating a `struct inode' for each dentry that contains some of
 121  * this duplicated information, then combining the inodes for each hard link
 122  * group together.
 123  *
 124  * Confusingly, it's possible for stream information to be missing from a dentry
 125  * in a hard link set, in which case the stream information needs to be gotten
 126  * from one of the other dentries in the hard link set.  In addition, it is
 127  * possible for dentries to have inconsistent security IDs, file attributes, or
 128  * file streams when they share the same hard link ID (don't even ask.  I hope
 129  * that Microsoft may have fixed this problem, since I've only noticed it in the
 130  * 'install.wim' for Windows 7).  For those dentries, we have to use the
 131  * conflicting fields to split up the hard link groups.  (See fix_inodes() in
 132  * hardlink.c).
 133  */
 134 struct dentry {
 135         /* Byte 0 */
 136
 137         /* The inode for this dentry */
 138         struct inode *d_inode;
 139
 140         /* Byte 8 */
 141
 142         /* Red-black tree of sibling dentries */
 143         struct rb_node rb_node;
 144
 145         /* Byte 32 */
 146
 147         /* Length of short filename, in bytes, not including the terminating
 148          * zero wide-character. */
 149         u16 short_name_len;
 150
 151         /* Length of file name, in bytes, not including the terminating zero
 152          * wide-character. */
 153         u16 file_name_len;
 154
 155         /* Length of the filename converted into UTF-8, in bytes, not including
 156          * the terminating zero byte. */
 157         u16 file_name_utf8_len;
 158
 159         u8 is_extracted : 1;
 160         u8 visited : 1;
 161         u8 canonical : 1;
 162
 163         /* Byte 40 */
 164
 165         /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
 166         char *file_name_utf8;
 167
 168         /* Byte 48 */
 169
 170         struct list_head tmp_list;
 171
 172         /* Byte 64 */
 173
 174         /* List of dentries in the inode (hard link set)  */
 175         struct list_head inode_dentry_list;
 176
 177         /* The parent of this directory entry. */
 178         struct dentry *parent;
 179
 180         /*
 181          * Size of directory entry on disk, in bytes.  Typical size is around
 182          * 104 to 120 bytes.
 183          *
 184          * It is possible for the length field to be 0.  This situation, which
 185          * is undocumented, indicates the end of a list of sibling nodes in a
 186          * directory.  It also means the real length is 8, because the dentry
 187          * included only the length field, but that takes up 8 bytes.
 188          *
 189          * The length here includes the base directory entry on disk as well as
 190          * the long and short filenames.  It does NOT include any alternate
 191          * stream entries that may follow the directory entry, even though the
 192          * size of those needs to be considered.  The length SHOULD be 8-byte
 193          * aligned, although we don't require it to be.  We do require the
 194          * length to be large enough to hold the file name(s) of the dentry;
 195          * additionally, a warning is issued if this field is larger than the
 196          * aligned size.
 197          */
 198         u64 length;
 199
 200         /* The offset, from the start of the uncompressed WIM metadata resource
 201          * for this image, of this dentry's child dentries.  0 if the directory
 202          * entry has no children, which is the case for regular files or reparse
 203          * points. */
 204         u64 subdir_offset;
 205
 206         /* Number of references to the dentry tree itself, as in multiple
 207          * WIMStructs */
 208         u32 refcnt;
 209
 210         u32 full_path_utf8_len;
 211
 212         /* Pointer to the UTF-16 short filename (malloc()ed buffer) */
 213         char *short_name;
 214
 215         /* Pointer to the UTF-16 filename (malloc()ed buffer). */
 216         char *file_name;
 217
 218         /* Full path (UTF-8) to this dentry (malloc()ed buffer). */
 219         char *full_path_utf8;
 220 };
 221
 222 #define rbnode_dentry(node) container_of(node, struct dentry, rb_node)
 223
 224 /*
 225  * WIM inode.
 226  *
 227  * As mentioned above, in the WIM file that is no on-disk analogue of a real
 228  * inode, as most of these fields are duplicated in the dentries.
 229  */
 230 struct inode {
 231         /* Timestamps for the inode.  The timestamps are the number of
 232          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
 233          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
 234         u64 creation_time;
 235         u64 last_access_time;
 236         u64 last_write_time;
 237
 238         /* The file attributes associated with this inode.  This is a bitwise OR
 239          * of the FILE_ATTRIBUTE_* flags. */
 240         u32 attributes;
 241
 242         /* The index of the security descriptor in the WIM image's table of
 243          * security descriptors that contains this file's security information.
 244          * If -1, no security information exists for this file.  */
 245         int32_t security_id;
 246
 247         /* %true iff the inode's lookup table entries has been resolved (i.e.
 248          * the @lte field is valid, but the @hash field is not valid)
 249          *
 250          * (This is not an on-disk field.) */
 251         u8 resolved : 1;
 252
 253         /* %true iff verify_inode() has run on this dentry. */
 254         u8 verified : 1;
 255
 256         /* temporary flag */
 257         u8 visited    : 1;
 258
 259         /* Number of alternate data streams associated with this inode */
 260         u16 num_ads;
 261
 262         /* A hash of the file's contents, or a pointer to the lookup table entry
 263          * for this dentry if the lookup table entries have been resolved.
 264          *
 265          * More specifically, this is for the un-named default file stream, as
 266          * opposed to the alternate (named) file streams, which may have their
 267          * own lookup table entries.  */
 268         union {
 269                 u8 hash[SHA1_HASH_SIZE];
 270                 struct lookup_table_entry *lte;
 271         };
 272
 273         /* Identity of a reparse point.  See
 274          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
 275          * for what a reparse point is. */
 276         u32 reparse_tag;
 277
 278         /* Number of dentries that reference this inode */
 279         u32 link_count;
 280
 281         /* Alternate data stream entries. */
 282         struct ads_entry *ads_entries;
 283
 284         /* Inode number */
 285         u64 ino;
 286
 287         /* List of dentries that reference this inode (there should be
 288          * link_count of them) */
 289         struct list_head dentry_list;
 290
 291         struct hlist_node hlist;
 292
 293         struct list_head lte_inode_list;
 294
 295         char *extracted_file;
 296
 297         /* Root of a red-black tree storing the children of this inode (if
 298          * non-empty, implies the inode is a directory, although that is also
 299          * noted in the @attributes field.) */
 300         struct rb_root children;
 301
 302 #ifdef WITH_FUSE
 303         /* wimfs file descriptors table for the inode */
 304         u16 num_opened_fds;
 305         u16 num_allocated_fds;
 306         struct wimlib_fd **fds;
 307
 308         /* Next alternate data stream ID to be assigned */
 309         u32 next_stream_id;
 310
 311         /* This mutex protects the inode's file descriptors table during
 312          * read-only mounts.  Read-write mounts are still restricted to 1
 313          * thread. */
 314         pthread_mutex_t i_mutex;
 315 #endif
 316 };
 317
 318 #define inode_for_each_dentry(dentry, inode) \
 319                 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
 320
 321 #define inode_add_dentry(dentry, inode) \
 322                 list_add_tail(&(dentry)->inode_dentry_list, &(inode)->dentry_list)
 323
 324 static inline bool dentry_is_first_in_inode(const struct dentry *dentry)
 325 {
 326         return container_of(dentry->d_inode->dentry_list.next,
 327                             struct dentry,
 328                             inode_dentry_list) == dentry;
 329 }
 330
 331 extern u64 dentry_correct_total_length(const struct dentry *dentry);
 332
 333 extern int for_dentry_in_tree(struct dentry *root,
 334                               int (*visitor)(struct dentry*, void*),
 335                               void *args);
 336
 337 extern int for_dentry_in_rbtree(struct rb_node *node,
 338                                 int (*visitor)(struct dentry *, void *),
 339                                 void *arg);
 340
 341 extern int for_dentry_in_tree_depth(struct dentry *root,
 342                                     int (*visitor)(struct dentry*, void*),
 343                                     void *args);
 344
 345 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
 346 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
 347 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
 348                      u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
 349                      const char *name);
 350
 351 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
 352 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
 353                                            const char *path);
 354 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
 355                                                  const char *name);
 356 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
 357
 358 extern int print_dentry(struct dentry *dentry, void *lookup_table);
 359 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
 360
 361 #ifdef WITH_FUSE
 362 extern struct dentry *new_dentry(const char *name);
 363 #endif
 364
 365 extern struct dentry *new_dentry_with_inode(const char *name);
 366 extern struct dentry *new_dentry_with_timeless_inode(const char *name);
 367
 368 extern void free_inode(struct inode *inode);
 369 extern void free_dentry(struct dentry *dentry);
 370 extern void put_dentry(struct dentry *dentry);
 371
 372 extern void free_dentry_tree(struct dentry *root,
 373                              struct lookup_table *lookup_table);
 374 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
 375
 376 extern void unlink_dentry(struct dentry *dentry);
 377 extern bool dentry_add_child(struct dentry * restrict parent,
 378                              struct dentry * restrict child);
 379
 380 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
 381                                              const char *stream_name,
 382                                              u16 *idx_ret);
 383 extern struct ads_entry *inode_add_ads(struct inode *dentry,
 384                                        const char *stream_name);
 385
 386 extern void inode_remove_ads(struct inode *inode, u16 idx,
 387                              struct lookup_table *lookup_table);
 388
 389 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
 390                        u64 offset, struct dentry *dentry);
 391
 392
 393 extern int read_dentry_tree(const u8 metadata_resource[],
 394                             u64 metadata_resource_len, struct dentry *dentry);
 395
 396 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
 397
 398 static inline bool dentry_is_root(const struct dentry *dentry)
 399 {
 400         return dentry->parent == dentry;
 401 }
 402
 403 static inline bool inode_is_directory(const struct inode *inode)
 404 {
 405         return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
 406                 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
 407 }
 408
 409 static inline bool dentry_is_directory(const struct dentry *dentry)
 410 {
 411         return inode_is_directory(dentry->d_inode);
 412 }
 413
 414 /* For our purposes, we consider "real" symlinks and "junction points" to both
 415  * be symlinks. */
 416 static inline bool inode_is_symlink(const struct inode *inode)
 417 {
 418         return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
 419                 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
 420                      inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
 421 }
 422
 423 static inline bool inode_is_regular_file(const struct inode *inode)
 424 {
 425         return !inode_is_directory(inode) && !inode_is_symlink(inode);
 426 }
 427
 428 static inline bool dentry_is_regular_file(const struct dentry *dentry)
 429 {
 430         return inode_is_regular_file(dentry->d_inode);
 431 }
 432
 433 static inline bool inode_has_children(const struct inode *inode)
 434 {
 435         return inode->children.rb_node != NULL;
 436 }
 437
 438 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
 439 {
 440         const struct inode *inode = dentry->d_inode;
 441         return inode_is_directory(inode) && !inode_has_children(inode);
 442 }
 443
 444 #endif