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