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 <string.h>
   9
  10
  11 struct stat;
  12 struct lookup_table;
  13 typedef struct WIMStruct WIMStruct;
  14
  15 /* Size of the struct dentry up to and including the file_name_len. */
  16 #define WIM_DENTRY_DISK_SIZE    102
  17
  18 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
  19  * including the stream length field (see below). */
  20 #define WIM_ADS_ENTRY_DISK_SIZE 38
  21
  22
  23 /*
  24  * Reparse tags documented at
  25  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
  26  */
  27 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
  28 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
  29 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
  30 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
  31 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
  32 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
  33 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
  34 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
  35 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
  36 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
  37 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
  38
  39 #define FILE_ATTRIBUTE_READONLY            0x00000001
  40 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
  41 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
  42 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
  43 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
  44 #define FILE_ATTRIBUTE_DEVICE              0x00000040
  45 #define FILE_ATTRIBUTE_NORMAL              0x00000080
  46 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
  47 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
  48 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
  49 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
  50 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
  51 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
  52 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
  53 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
  54
  55 struct lookup_table_entry;
  56
  57 /* Alternate data stream entry.
  58  *
  59  * We read this from disk in the read_ads_entries() function; see that function
  60  * for more explanation. */
  61 struct ads_entry {
  62         union {
  63                 /* SHA-1 message digest of stream contents */
  64                 u8 hash[SHA1_HASH_SIZE];
  65
  66                 /* The corresponding lookup table entry (only for resolved
  67                  * streams) */
  68                 struct lookup_table_entry *lte;
  69         };
  70
  71         /* Length of stream name (UTF-16) */
  72         u16 stream_name_len;
  73
  74         /* Length of stream name (UTF-8) */
  75         u16 stream_name_utf8_len;
  76
  77         /* Stream name (UTF-16) */
  78         char *stream_name;
  79
  80         /* Stream name (UTF-8) */
  81         char *stream_name_utf8;
  82
  83         /* Doubly linked list of streams that share the same lookup table entry */
  84         struct stream_list_head lte_group_list;
  85 };
  86
  87 /* Returns the total length of a WIM alternate data stream entry on-disk,
  88  * including the stream name, the null terminator, AND the padding after the
  89  * entry to align the next one (or the next dentry) on an 8-byte boundary. */
  90 static inline u64 ads_entry_total_length(const struct ads_entry *entry)
  91 {
  92         u64 len = WIM_ADS_ENTRY_DISK_SIZE + entry->stream_name_len + 2;
  93         return (len + 7) & ~7;
  94 }
  95
  96 static inline void destroy_ads_entry(struct ads_entry *entry)
  97 {
  98         FREE(entry->stream_name);
  99         FREE(entry->stream_name_utf8);
 100         memset(entry, 0, sizeof(entry));
 101 }
 102
 103 static inline bool ads_entry_has_name(const struct ads_entry *entry,
 104                                       const char *name, size_t name_len)
 105 {
 106         if (entry->stream_name_utf8_len != name_len)
 107                 return false;
 108         return memcmp(entry->stream_name_utf8, name, name_len) == 0;
 109 }
 110
 111
 112 /*
 113  * In-memory structure for a WIM directory entry (dentry).  There is a directory
 114  * tree for each image in the WIM.
 115  *
 116  * Please note that this is a directory entry and not an inode.  Since NTFS
 117  * allows hard links, it's possible for a NTFS inode to correspond to multiple
 118  * WIM dentries.  The @hard_link field tells you the number of the NTFS inode
 119  * that the dentry corresponds to.
 120  *
 121  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
 122  * information, such as file attributes, the security descriptor, and file
 123  * streams is replicated in each hard-linked dentry, even though this
 124  * information really is associated with an inode.
 125  *
 126  * Confusingly, it's also possible for stream information to be missing from a
 127  * dentry in a hard link set, in which case the stream information needs to be
 128  * gotten from one of the other dentries in the hard link set.  In addition, it
 129  * is possible for dentries to have inconsistent security IDs, file attributes,
 130  * or file streams when they share the same hard link ID (don't even ask.  I
 131  * hope that Microsoft may have fixed this problem, since I've only noticed it
 132  * in the 'install.wim' for Windows 7).  For those dentries, we have to use the
 133  * conflicting fields to split up the hard link groups.
 134  */
 135 struct dentry {
 136         /* The parent of this directory entry. */
 137         struct dentry *parent;
 138
 139         /* Linked list of sibling directory entries. */
 140         struct dentry *next;
 141         struct dentry *prev;
 142
 143         /* Pointer to a child of this directory entry. */
 144         struct dentry *children;
 145
 146         /*
 147          * Size of directory entry on disk, in bytes.  Typical size is around
 148          * 104 to 120 bytes.
 149          *
 150          * It is possible for the length field to be 0.  This situation, which
 151          * is undocumented, indicates the end of a list of sibling nodes in a
 152          * directory.  It also means the real length is 8, because the dentry
 153          * included only the length field, but that takes up 8 bytes.
 154          *
 155          * The length here includes the base directory entry on disk as well as
 156          * the long and short filenames.  It does NOT include any alternate
 157          * stream entries that may follow the directory entry, even though the
 158          * size of those needs to be considered.
 159          */
 160         u64 length;
 161
 162         /* The file attributes associated with this file.  This is a bitwise OR
 163          * of the FILE_ATTRIBUTE_* flags. */
 164         u32 attributes;
 165
 166         /* The index of the security descriptor in the WIM image's table of
 167          * security descriptors that contains this file's security information.
 168          * If -1, no security information exists for this file.  */
 169         int32_t security_id;
 170
 171         /* The offset, from the start of the uncompressed WIM metadata resource
 172          * for this image, of this dentry's child dentries.  0 if the directory
 173          * entry has no children, which is the case for regular files or reparse
 174          * points. */
 175         u64 subdir_offset;
 176
 177         /* Timestamps for the dentry.  The timestamps are the number of
 178          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
 179          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
 180         u64 creation_time;
 181         u64 last_access_time;
 182         u64 last_write_time;
 183
 184         /* %true iff the dentry's lookup table entry has been resolved (i.e. the
 185          * @lte field is valid, but the @hash field is not valid)
 186          *
 187          * (This is not an on-disk field.) */
 188         bool resolved;
 189
 190         /* A hash of the file's contents, or a pointer to the lookup table entry
 191          * for this dentry if the lookup table entries have been resolved.
 192          *
 193          * More specifically, this is for the un-named default file stream, as
 194          * opposed to the alternate (named) file streams, which may have their
 195          * own lookup table entries.  */
 196         union {
 197                 u8 hash[SHA1_HASH_SIZE];
 198                 struct lookup_table_entry *lte;
 199         };
 200
 201         /* Identity of a reparse point.  See
 202          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
 203          * for what a reparse point is. */
 204         u32 reparse_tag;
 205
 206         /* Although M$'s documentation does not tell you this, it seems that the
 207          * reparse_reserved field does not actually exist.  So the hard_link
 208          * field directly follows the reparse_tag on disk.  EXCEPT when the
 209          * dentry is actually a reparse point... well, just take a look at the
 210          * read_dentry() function. */
 211         //u32 reparse_reserved;
 212
 213         /* If the file is part of a hard link set, all the directory entries in
 214          * the set will share the same value for this field.
 215          *
 216          * Unfortunately, in some WIMs it is NOT the case that all dentries that
 217          * share this field are actually in the same hard link set, although the
 218          * WIMs that wimlib writes maintain this restriction. */
 219         u64 hard_link;
 220
 221         /* Number of alternate data streams associated with this file. */
 222         u16 num_ads;
 223
 224         /* Length of short filename, in bytes, not including the terminating
 225          * zero wide-character. */
 226         u16 short_name_len;
 227
 228         /* Length of file name, in bytes, not including the terminating zero
 229          * wide-character. */
 230         u16 file_name_len;
 231
 232         /* Length of the filename converted into UTF-8, in bytes, not including
 233          * the terminating zero byte. */
 234         u16 file_name_utf8_len;
 235
 236         /* Pointer to the short filename (malloc()ed buffer) */
 237         char *short_name;
 238
 239         /* Pointer to the filename (malloc()ed buffer). */
 240         char *file_name;
 241
 242         /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
 243         char *file_name_utf8;
 244
 245         /* Full path to this dentry (malloc()ed buffer). */
 246         char *full_path_utf8;
 247         u32   full_path_utf8_len;
 248
 249         /* Alternate stream entries for this dentry (malloc()ed buffer). */
 250         struct ads_entry *ads_entries;
 251
 252         union {
 253                 /* Number of references to the dentry tree itself, as in multiple
 254                  * WIMStructs */
 255                 u32 refcnt;
 256
 257                 /* Number of times this dentry has been opened (only for
 258                  * directories!) */
 259                 u32 num_times_opened;
 260         };
 261
 262         enum {
 263                 /* This dentry is the owner of its ads_entries, although it may
 264                  * be in a hard link set */
 265                 ADS_ENTRIES_DEFAULT = 0,
 266
 267                 /* This dentry is the owner of the ads_entries in the hard link
 268                  * set */
 269                 ADS_ENTRIES_OWNER,
 270
 271                 /* This dentry shares its ads_entries with a dentry in the hard
 272                  * link set that has ADS_ENTRIES_OWNER set. */
 273                 ADS_ENTRIES_USER
 274         } ads_entries_status;
 275
 276
 277         /* List of dentries in the hard link set */
 278         struct list_head link_group_list;
 279
 280         /* List of dentries sharing the same lookup table entry */
 281         struct stream_list_head lte_group_list;
 282
 283         /* Path to extracted file on disk (used during extraction only)
 284          * (malloc()ed buffer) */
 285         char *extracted_file;
 286 };
 287
 288
 289 extern struct ads_entry *dentry_get_ads_entry(struct dentry *dentry,
 290                                               const char *stream_name);
 291
 292 extern struct ads_entry *dentry_add_ads(struct dentry *dentry,
 293                                         const char *stream_name);
 294
 295 extern void dentry_remove_ads(struct dentry *dentry, struct ads_entry *entry);
 296
 297 extern const char *path_stream_name(const char *path);
 298
 299 extern u64 dentry_total_length(const struct dentry *dentry);
 300
 301 extern void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry);
 302
 303 extern int for_dentry_in_tree(struct dentry *root,
 304                               int (*visitor)(struct dentry*, void*),
 305                               void *args);
 306
 307 extern int for_dentry_in_tree_depth(struct dentry *root,
 308                                     int (*visitor)(struct dentry*, void*),
 309                                     void *args);
 310
 311 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
 312 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
 313 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
 314                      u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
 315                      const char *name);
 316 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
 317 extern int change_ads_name(struct ads_entry *entry, const char *new_name);
 318
 319 extern void unlink_dentry(struct dentry *dentry);
 320 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
 321
 322 extern int print_dentry(struct dentry *dentry, void *lookup_table);
 323 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
 324
 325 extern struct dentry *get_dentry(WIMStruct *w, const char *path);
 326 extern struct dentry *get_parent_dentry(WIMStruct *w, const char *path);
 327 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
 328                                                         const char *name);
 329 extern void dentry_update_all_timestamps(struct dentry *dentry);
 330 extern void init_dentry(struct dentry *dentry, const char *name);
 331 extern struct dentry *new_dentry(const char *name);
 332
 333 extern void dentry_free_ads_entries(struct dentry *dentry);
 334 extern void free_dentry(struct dentry *dentry);
 335 extern void put_dentry(struct dentry *dentry);
 336 extern struct dentry *clone_dentry(struct dentry *old);
 337 extern void free_dentry_tree(struct dentry *root,
 338                              struct lookup_table *lookup_table);
 339 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
 340 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
 341
 342 extern void calculate_dir_tree_statistics(struct dentry *root,
 343                                           struct lookup_table *table,
 344                                           u64 *dir_count_ret,
 345                                           u64 *file_count_ret,
 346                                           u64 *total_bytes_ret,
 347                                           u64 *hard_link_bytes_ret);
 348
 349 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
 350                        u64 offset, struct dentry *dentry);
 351
 352 extern int read_dentry_tree(const u8 metadata_resource[],
 353                             u64 metadata_resource_len, struct dentry *dentry);
 354
 355 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
 356
 357
 358 /* Return the number of dentries in the hard link group */
 359 static inline size_t dentry_link_group_size(const struct dentry *dentry)
 360 {
 361         const struct list_head *cur = &dentry->link_group_list;
 362         size_t size = 0;
 363         wimlib_assert(cur != NULL);
 364         do {
 365                 size++;
 366                 cur = cur->next;
 367         } while (cur != &dentry->link_group_list);
 368         return size;
 369 }
 370
 371 static inline bool dentry_is_root(const struct dentry *dentry)
 372 {
 373         return dentry->parent == dentry;
 374 }
 375
 376 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
 377 {
 378         return dentry_is_root(dentry) || dentry->parent->children == dentry;
 379 }
 380
 381 static inline bool dentry_is_only_child(const struct dentry *dentry)
 382 {
 383         return dentry->next == dentry;
 384 }
 385
 386 static inline bool dentry_is_directory(const struct dentry *dentry)
 387 {
 388         return (dentry->attributes & FILE_ATTRIBUTE_DIRECTORY)
 389                 && !(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
 390 }
 391
 392 /* For our purposes, we consider "real" symlinks and "junction points" to both
 393  * be symlinks. */
 394 static inline bool dentry_is_symlink(const struct dentry *dentry)
 395 {
 396         return (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
 397                 && ((dentry->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
 398                      dentry->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
 399 }
 400
 401 static inline bool dentry_is_regular_file(const struct dentry *dentry)
 402 {
 403         return !dentry_is_directory(dentry) && !dentry_is_symlink(dentry);
 404 }
 405
 406 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
 407 {
 408         return dentry_is_directory(dentry) && dentry->children == NULL;
 409 }
 410
 411 #endif