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 <string.h>
   8
   9
  10 struct stat;
  11 struct lookup_table;
  12 typedef struct WIMStruct WIMStruct;
  13
  14 /* Size of the struct dentry up to and including the file_name_len. */
  15 #define WIM_DENTRY_DISK_SIZE    102
  16
  17 #define WIM_ADS_ENTRY_DISK_SIZE 38
  18
  19 #ifndef WIM_HASH_SIZE
  20 #define WIM_HASH_SIZE 20
  21 #endif
  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 /* Alternate data stream entry */
  56 struct ads_entry {
  57         /* SHA-1 message digest of stream contents */
  58         u8 hash[WIM_HASH_SIZE];
  59
  60         /* Length of stream name (UTF-16) */
  61         u16 stream_name_len;
  62
  63         /* Length of stream name (UTF-8) */
  64         u16 stream_name_utf8_len;
  65
  66         /* Stream name (UTF-16) */
  67         char *stream_name;
  68
  69         /* Stream name (UTF-8) */
  70         char *stream_name_utf8;
  71 };
  72
  73 static inline u64 ads_entry_length(const struct ads_entry *entry)
  74 {
  75         u64 len = WIM_ADS_ENTRY_DISK_SIZE + entry->stream_name_len + 2;
  76         return (len + 7) & ~7;
  77 }
  78
  79 static inline void destroy_ads_entry(struct ads_entry *entry)
  80 {
  81         FREE(entry->stream_name);
  82         FREE(entry->stream_name_utf8);
  83         memset(entry, 0, sizeof(entry));
  84 }
  85
  86 static inline bool ads_entry_has_name(const struct ads_entry *entry,
  87                                       const char *name, size_t name_len)
  88 {
  89         if (entry->stream_name_utf8_len != name_len)
  90                 return false;
  91         return memcmp(entry->stream_name_utf8, name, name_len) == 0;
  92 }
  93
  94
  95 /* In-memory structure for a directory entry.  There is a directory tree for
  96  * each image in the WIM.  */
  97 struct dentry {
  98         /* The parent of this directory entry. */
  99         struct dentry *parent;
 100
 101         /* Linked list of sibling directory entries. */
 102         struct dentry *next;
 103
 104         struct dentry *prev;
 105
 106         /* Pointer to a child of this directory entry. */
 107         struct dentry *children;
 108
 109         /* Size of directory entry, in bytes.  Typical size is around 104 to 120
 110          * bytes. */
 111         /* It is possible for the length field to be 0.  This situation, which
 112          * is undocumented, indicates the end of a list of sibling nodes in a
 113          * directory.  It also means the real length is 8, because the dentry
 114          * included only the length field, but that takes up 8 bytes. */
 115         u64 length;
 116
 117
 118         /* The file attributes associated with this file. */
 119         u32 attributes;
 120
 121         /* The index of the node in the security table that contains this file's
 122          * security information.  If -1, no security information exists for this
 123          * file.  */
 124         int32_t security_id;
 125
 126         /* The offset, from the start of the metadata section, of this directory
 127          * entry's child files.  0 if the directory entry has no children. */
 128         u64 subdir_offset;
 129
 130         /* Reserved for future disuse.  Currently ignoring these fields. */
 131         u64 unused1;
 132         u64 unused2;
 133
 134         /* Timestamps for the entry.  The timestamps are the number of
 135          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
 136          * 1st, 1601, UTC. */
 137         u64 creation_time;
 138         u64 last_access_time;
 139         u64 last_write_time;
 140
 141         /* A hash of the file's contents. */
 142         u8 hash[WIM_HASH_SIZE];
 143
 144         /* Identity of a reparse point.  See
 145          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
 146          * for what a reparse point is. */
 147         u32 reparse_tag;
 148
 149         /* Although M$'s documentation does not tell you this, it seems that the
 150          * reparse_reserved field does not actually exist.  So the hard_link
 151          * field directly follows the reparse_tag on disk.  EXCEPT when the
 152          * dentry is actually a reparse point... well, just take a look at the
 153          * read_dentry() function. */
 154         //u32 reparse_reserved;
 155
 156         /* If the reparse_reserved field existed, there would be a 4-byte gap
 157          * here to align hard_link on an 8-byte field.  However,
 158          * reparse_reserved does not actually exist, so there is no gap here. */
 159
 160         /* If the file is part of a hard link set, all the directory entries in
 161          * the set will share the same value for this field. */
 162         u64 hard_link;
 163
 164         /* Number of alternate data streams associated with this file. */
 165         u16 num_ads;
 166
 167         /* Length of short filename, in bytes, not including the terminating
 168          * zero wide-character. */
 169         u16 short_name_len;
 170
 171         /* Length of file name, in bytes, not including the terminating zero
 172          * wide-character. */
 173         u16 file_name_len;
 174
 175         /* Length of the filename converted into UTF-8, in bytes, not including
 176          * the terminating zero byte. */
 177         u16 file_name_utf8_len;
 178
 179         /* Pointer to the short filename */
 180         char *short_name;
 181
 182         /* Pointer to the filename. */
 183         char *file_name;
 184
 185         /* Pointer to the filename converted to UTF-8. */
 186         char *file_name_utf8;
 187
 188         /* Full path to this dentry. */
 189         char *full_path_utf8;
 190         u32   full_path_utf8_len;
 191
 192         /* Alternate stream entries for this dentry. */
 193         struct ads_entry *ads_entries;
 194
 195         union {
 196                 /* Number of references to the dentry tree itself, as in multiple
 197                  * WIMStructs */
 198                 int refcnt;
 199
 200                 /* Number of times this dentry has been opened (only for
 201                  * directories!) */
 202                 u32 num_times_opened;
 203         };
 204
 205         /* List of dentries in the hard link set */
 206         enum {
 207                 GROUP_INDEPENDENT,
 208                 GROUP_MASTER,
 209                 GROUP_SLAVE
 210         } link_group_master_status;
 211         struct list_head link_group_list;
 212 };
 213
 214 /* Return hash of the "unnamed" (default) data stream. */
 215 static inline const u8 *dentry_hash(const struct dentry *dentry)
 216 {
 217         /* If there are alternate data streams, the dentry hash field is zeroed
 218          * out, and we need to find the hash in the un-named data stream (should
 219          * be the first one, but check them in order just in case, and fall back
 220          * to the dentry hash field if we can't find an unnamed data stream). */
 221         for (u16 i = 0; i < dentry->num_ads; i++)
 222                 if (dentry->ads_entries[i].stream_name_len == 0)
 223                         return dentry->ads_entries[i].hash;
 224         return dentry->hash;
 225 }
 226
 227 static inline size_t dentry_link_group_size(const struct dentry *dentry)
 228 {
 229         const struct list_head *cur = &dentry->link_group_list;
 230         size_t size = 0;
 231         do {
 232                 size++;
 233                 cur = cur->next;
 234         } while (cur != &dentry->link_group_list);
 235         return size;
 236 }
 237
 238 extern struct ads_entry *dentry_get_ads_entry(struct dentry *dentry,
 239                                               const char *stream_name);
 240
 241 extern struct ads_entry *dentry_add_ads(struct dentry *dentry,
 242                                         const char *stream_name);
 243
 244 extern void dentry_remove_ads(struct dentry *dentry, struct ads_entry *entry);
 245
 246 extern const char *path_stream_name(const char *path);
 247
 248 extern u64 dentry_total_length(const struct dentry *dentry);
 249
 250 extern void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry);
 251
 252 extern void dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf,
 253                             const struct lookup_table *table);
 254
 255 extern int for_dentry_in_tree(struct dentry *root,
 256                               int (*visitor)(struct dentry*, void*),
 257                               void *args);
 258
 259 extern int for_dentry_in_tree_depth(struct dentry *root,
 260                                     int (*visitor)(struct dentry*, void*),
 261                                     void *args);
 262
 263 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
 264 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
 265 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
 266                      u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
 267                      const char *name);
 268 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
 269 extern int change_ads_name(struct ads_entry *entry, const char *new_name);
 270
 271 extern void unlink_dentry(struct dentry *dentry);
 272 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
 273
 274 extern int print_dentry(struct dentry *dentry, void *lookup_table);
 275 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
 276
 277 extern struct dentry *get_dentry(WIMStruct *w, const char *path);
 278 extern struct dentry *get_parent_dentry(WIMStruct *w, const char *path);
 279 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
 280                                                         const char *name);
 281 extern void dentry_update_all_timestamps(struct dentry *dentry);
 282 extern void init_dentry(struct dentry *dentry, const char *name);
 283 extern struct dentry *new_dentry(const char *name);
 284
 285 extern void dentry_free_ads_entries(struct dentry *dentry);
 286 extern void free_dentry(struct dentry *dentry);
 287 extern void put_dentry(struct dentry *dentry);
 288 extern int share_dentry_streams(struct dentry *master,
 289                                 struct dentry *slave);
 290 extern struct dentry *clone_dentry(struct dentry *old);
 291 extern void free_dentry_tree(struct dentry *root,
 292                              struct lookup_table *lookup_table,
 293                              bool lt_decrement_refcnt);
 294 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
 295 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
 296
 297 extern void calculate_dir_tree_statistics(struct dentry *root,
 298                                           struct lookup_table *table,
 299                                           u64 *dir_count_ret,
 300                                           u64 *file_count_ret,
 301                                           u64 *total_bytes_ret,
 302                                           u64 *hard_link_bytes_ret);
 303
 304 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
 305                        u64 offset, struct dentry *dentry);
 306
 307 extern int read_dentry_tree(const u8 metadata_resource[],
 308                             u64 metadata_resource_len, struct dentry *dentry);
 309
 310 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
 311
 312
 313 /* Inline utility functions for WIMDentries */
 314
 315
 316 static inline bool dentry_is_root(const struct dentry *dentry)
 317 {
 318         return dentry->parent == dentry;
 319 }
 320
 321 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
 322 {
 323         return dentry_is_root(dentry) || dentry->parent->children == dentry;
 324 }
 325
 326 static inline bool dentry_is_only_child(const struct dentry *dentry)
 327 {
 328         return dentry->next == dentry;
 329 }
 330
 331 static inline bool dentry_is_directory(const struct dentry *dentry)
 332 {
 333         return (dentry->attributes & FILE_ATTRIBUTE_DIRECTORY)
 334                 && !(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
 335 }
 336
 337 /* For our purposes, we consider "real" symlinks and "junction points" to both
 338  * be symlinks. */
 339 static inline bool dentry_is_symlink(const struct dentry *dentry)
 340 {
 341         return (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
 342                 && ((dentry->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
 343                      dentry->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
 344 }
 345
 346 static inline bool dentry_is_regular_file(const struct dentry *dentry)
 347 {
 348         return !dentry_is_directory(dentry) && !dentry_is_symlink(dentry);
 349 }
 350
 351 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
 352 {
 353         return dentry_is_directory(dentry) && dentry->children == NULL;
 354 }
 355
 356 #endif