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