2d84ad35f8f0699d2b388dd2e473f7f069a2c170
[wimlib] / 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 struct 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;
93         if (entry->stream_name_len)
94                 len += entry->stream_name_len + 2;
95         return (len + 7) & ~7;
96 }
97
98 static inline void destroy_ads_entry(struct ads_entry *entry)
99 {
100         FREE(entry->stream_name);
101         FREE(entry->stream_name_utf8);
102         memset(entry, 0, sizeof(entry));
103 }
104
105 static inline bool ads_entry_has_name(const struct ads_entry *entry,
106                                       const char *name, size_t name_len)
107 {
108         if (entry->stream_name_utf8_len != name_len)
109                 return false;
110         return memcmp(entry->stream_name_utf8, name, name_len) == 0;
111 }
112
113 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
114                                               const struct ads_entry *entry_2)
115 {
116         if (entry_1->stream_name_len != entry_2->stream_name_len)
117                 return false;
118         return memcmp(entry_1->stream_name, entry_2->stream_name,
119                       entry_1->stream_name_len) == 0;
120 }
121
122
123 /* 
124  * In-memory structure for a WIM directory entry (dentry).  There is a directory
125  * tree for each image in the WIM. 
126  *
127  * Please note that this is a directory entry and not an inode.  Since NTFS
128  * allows hard links, it's possible for a NTFS inode to correspond to multiple
129  * WIM dentries.  The @hard_link field tells you the number of the NTFS inode
130  * that the dentry corresponds to.
131  *
132  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
133  * information, such as file attributes, the security descriptor, and file
134  * streams is replicated in each hard-linked dentry, even though this
135  * information really is associated with an inode.
136  *
137  * Confusingly, it's also possible for stream information to be missing from a
138  * dentry in a hard link set, in which case the stream information needs to be
139  * gotten from one of the other dentries in the hard link set.  In addition, it
140  * is possible for dentries to have inconsistent security IDs, file attributes,
141  * or file streams when they share the same hard link ID (don't even ask.  I
142  * hope that Microsoft may have fixed this problem, since I've only noticed it
143  * in the 'install.wim' for Windows 7).  For those dentries, we have to use the
144  * conflicting fields to split up the hard link groups.
145  */
146 struct dentry {
147         /* The parent of this directory entry. */
148         struct dentry *parent;
149
150         /* Linked list of sibling directory entries. */
151         struct dentry *next;
152         struct dentry *prev;
153
154         /* Pointer to a child of this directory entry. */
155         struct dentry *children;
156
157         /* 
158          * Size of directory entry on disk, in bytes.  Typical size is around
159          * 104 to 120 bytes.
160          *
161          * It is possible for the length field to be 0.  This situation, which
162          * is undocumented, indicates the end of a list of sibling nodes in a
163          * directory.  It also means the real length is 8, because the dentry
164          * included only the length field, but that takes up 8 bytes.
165          *
166          * The length here includes the base directory entry on disk as well as
167          * the long and short filenames.  It does NOT include any alternate
168          * stream entries that may follow the directory entry, even though the
169          * size of those needs to be considered.  The length SHOULD be 8-byte
170          * aligned, although we don't require it to be.  We do require the
171          * length to be large enough to hold the file name(s) of the dentry;
172          * additionally, a warning is issued if this field is larger than the
173          * aligned size.
174          */
175         u64 length;
176
177         /* The file attributes associated with this file.  This is a bitwise OR
178          * of the FILE_ATTRIBUTE_* flags. */
179         u32 attributes;
180
181         /* The index of the security descriptor in the WIM image's table of
182          * security descriptors that contains this file's security information.
183          * If -1, no security information exists for this file.  */
184         int32_t security_id;
185
186         /* The offset, from the start of the uncompressed WIM metadata resource
187          * for this image, of this dentry's child dentries.  0 if the directory
188          * entry has no children, which is the case for regular files or reparse
189          * points. */
190         u64 subdir_offset;
191
192         /* Timestamps for the dentry.  The timestamps are the number of
193          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
194          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
195         u64 creation_time;
196         u64 last_access_time;
197         u64 last_write_time;
198
199         /* %true iff the dentry's lookup table entry has been resolved (i.e. the
200          * @lte field is valid, but the @hash field is not valid) 
201          *
202          * (This is not an on-disk field.) */
203         bool resolved;
204
205         /* A hash of the file's contents, or a pointer to the lookup table entry
206          * for this dentry if the lookup table entries have been resolved.
207          *
208          * More specifically, this is for the un-named default file stream, as
209          * opposed to the alternate (named) file streams, which may have their
210          * own lookup table entries.  */
211         union {
212                 u8 hash[SHA1_HASH_SIZE];
213                 struct lookup_table_entry *lte;
214         };
215
216         /* Identity of a reparse point.  See
217          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
218          * for what a reparse point is. */
219         u32 reparse_tag;
220
221         /* Although M$'s documentation does not tell you this, it seems that the
222          * reparse_reserved field does not actually exist.  So the hard_link
223          * field directly follows the reparse_tag on disk.  EXCEPT when the
224          * dentry is actually a reparse point... well, just take a look at the
225          * read_dentry() function. */
226         //u32 reparse_reserved;
227
228         /* If the file is part of a hard link set, all the directory entries in
229          * the set will share the same value for this field. 
230          *
231          * Unfortunately, in some WIMs it is NOT the case that all dentries that
232          * share this field are actually in the same hard link set, although the
233          * WIMs that wimlib writes maintain this restriction. */
234         u64 link_group_id;
235
236         /* Number of alternate data streams associated with this file. */
237         u16 num_ads;
238
239         /* Length of short filename, in bytes, not including the terminating
240          * zero wide-character. */
241         u16 short_name_len;
242
243         /* Length of file name, in bytes, not including the terminating zero
244          * wide-character. */
245         u16 file_name_len;
246
247         /* Length of the filename converted into UTF-8, in bytes, not including
248          * the terminating zero byte. */
249         u16 file_name_utf8_len;
250
251         /* Pointer to the short filename (malloc()ed buffer) */
252         char *short_name;
253
254         /* Pointer to the filename (malloc()ed buffer). */
255         char *file_name;
256
257         /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
258         char *file_name_utf8;
259
260         /* Full path to this dentry (malloc()ed buffer). */
261         char *full_path_utf8;
262         u32   full_path_utf8_len;
263
264         /* Alternate stream entries for this dentry (malloc()ed buffer). */
265         struct ads_entry *ads_entries;
266
267         union {
268                 /* Number of references to the dentry tree itself, as in multiple
269                  * WIMStructs */
270                 u32 refcnt;
271
272                 /* Number of times this dentry has been opened (only for
273                  * directories!) */
274                 u32 num_times_opened;
275         };
276
277         enum {
278                 /* This dentry is the owner of its ads_entries, although it may
279                  * be in a hard link set */
280                 ADS_ENTRIES_DEFAULT = 0,
281
282                 /* This dentry is the owner of the ads_entries in the hard link
283                  * set */
284                 ADS_ENTRIES_OWNER,
285
286                 /* This dentry shares its ads_entries with a dentry in the hard
287                  * link set that has ADS_ENTRIES_OWNER set. */
288                 ADS_ENTRIES_USER
289         } ads_entries_status;
290
291
292         /* List of dentries in the hard link set */
293         struct list_head link_group_list;
294
295         union {
296         /* List of dentries sharing the same lookup table entry */
297                 struct stream_list_head lte_group_list;
298                 struct list_head tmp_list;
299         };
300
301         /* Path to extracted file on disk (used during extraction only)
302          * (malloc()ed buffer) */
303         char *extracted_file;
304 };
305
306
307 extern struct ads_entry *dentry_get_ads_entry(struct dentry *dentry,
308                                               const char *stream_name);
309
310 extern struct ads_entry *dentry_add_ads(struct dentry *dentry,
311                                         const char *stream_name);
312
313 extern void dentry_remove_ads(struct dentry *dentry, struct ads_entry *entry);
314
315 extern const char *path_stream_name(const char *path);
316
317 extern u64 dentry_total_length(const struct dentry *dentry);
318 extern u64 dentry_correct_total_length(const struct dentry *dentry);
319
320 extern void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry);
321
322 extern int for_dentry_in_tree(struct dentry *root, 
323                               int (*visitor)(struct dentry*, void*), 
324                               void *args);
325
326 extern int for_dentry_in_tree_depth(struct dentry *root, 
327                                     int (*visitor)(struct dentry*, void*), 
328                                     void *args);
329
330 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
331 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
332 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
333                      u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
334                      const char *name);
335 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
336 extern int change_ads_name(struct ads_entry *entry, const char *new_name);
337
338 extern void unlink_dentry(struct dentry *dentry);
339 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
340
341 extern int print_dentry(struct dentry *dentry, void *lookup_table);
342 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
343
344 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
345 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
346 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry, 
347                                                         const char *name);
348 extern void dentry_update_all_timestamps(struct dentry *dentry);
349 extern void init_dentry(struct dentry *dentry, const char *name);
350 extern struct dentry *new_dentry(const char *name);
351
352 extern void dentry_free_ads_entries(struct dentry *dentry);
353 extern void free_dentry(struct dentry *dentry);
354 extern void put_dentry(struct dentry *dentry);
355 extern struct dentry *clone_dentry(struct dentry *old);
356 extern void free_dentry_tree(struct dentry *root,
357                              struct lookup_table *lookup_table);
358 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
359 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
360
361 extern void calculate_dir_tree_statistics(struct dentry *root, 
362                                           struct lookup_table *table, 
363                                           u64 *dir_count_ret, 
364                                           u64 *file_count_ret, 
365                                           u64 *total_bytes_ret, 
366                                           u64 *hard_link_bytes_ret);
367
368 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, 
369                        u64 offset, struct dentry *dentry);
370
371 extern int verify_dentry(struct dentry *dentry, void *wim);
372
373 extern int read_dentry_tree(const u8 metadata_resource[], 
374                             u64 metadata_resource_len, struct dentry *dentry);
375
376 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
377
378
379 /* Return the number of dentries in the hard link group */
380 static inline size_t dentry_link_group_size(const struct dentry *dentry)
381 {
382         const struct list_head *cur = &dentry->link_group_list;
383         size_t size = 0;
384         wimlib_assert(cur != NULL);
385         do {
386                 size++;
387                 cur = cur->next;
388         } while (cur != &dentry->link_group_list);
389         return size;
390 }
391
392 static inline bool dentry_is_root(const struct dentry *dentry)
393 {
394         return dentry->parent == dentry;
395 }
396
397 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
398 {
399         return dentry_is_root(dentry) || dentry->parent->children == dentry;
400 }
401
402 static inline bool dentry_is_only_child(const struct dentry *dentry)
403 {
404         return dentry->next == dentry;
405 }
406
407 static inline bool dentry_is_directory(const struct dentry *dentry)
408 {
409         return (dentry->attributes & FILE_ATTRIBUTE_DIRECTORY)
410                 && !(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
411 }
412
413 /* For our purposes, we consider "real" symlinks and "junction points" to both
414  * be symlinks. */
415 static inline bool dentry_is_symlink(const struct dentry *dentry)
416 {
417         return (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
418                 && ((dentry->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
419                      dentry->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
420 }
421
422 static inline bool dentry_is_regular_file(const struct dentry *dentry)
423 {
424         return !dentry_is_directory(dentry) && !dentry_is_symlink(dentry);
425 }
426
427 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
428 {
429         return dentry_is_directory(dentry) && dentry->children == NULL;
430 }
431
432 #endif