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