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