Fix up calculation of image XML statistics
[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 struct stat;
11 struct lookup_table;
12 struct WIMStruct;
13 struct lookup_table_entry;
14 struct wimlib_fd;
15 struct inode;
16 struct dentry;
17
18 /* Size of the struct dentry up to and including the file_name_len. */
19 #define WIM_DENTRY_DISK_SIZE    102
20
21 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
22  * including the stream length field (see below). */
23 #define WIM_ADS_ENTRY_DISK_SIZE 38
24
25 /* 
26  * Reparse tags documented at 
27  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
28  */
29 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
30 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
31 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
32 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
33 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
34 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
35 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
36 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
37 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
38 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
39 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
40
41 #define FILE_ATTRIBUTE_READONLY            0x00000001
42 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
43 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
44 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
45 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
46 #define FILE_ATTRIBUTE_DEVICE              0x00000040
47 #define FILE_ATTRIBUTE_NORMAL              0x00000080
48 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
49 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
50 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
51 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
52 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
53 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
54 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
55 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
56
57
58 /* Alternate data stream entry.
59  *
60  * We read this from disk in the read_ads_entries() function; see that function
61  * for more explanation. */
62 struct ads_entry {
63         union {
64                 /* SHA-1 message digest of stream contents */
65                 u8 hash[SHA1_HASH_SIZE];
66
67                 /* The corresponding lookup table entry (only for resolved
68                  * streams) */
69                 struct lookup_table_entry *lte;
70         };
71
72         /* Length of stream name (UTF-16).  This is in bytes, not characters,
73          * and does not include the terminating null character   */
74         u16 stream_name_len;
75
76         /* Length of stream name (UTF-8) */
77         u16 stream_name_utf8_len;
78
79         /* Stream name (UTF-16) */
80         char *stream_name;
81
82         /* Stream name (UTF-8) */
83         char *stream_name_utf8;
84
85 #ifdef WITH_FUSE
86         /* Number to identify an alternate data stream even after it's possibly
87          * been moved or renamed. */
88         u32 stream_id;
89 #endif
90 };
91
92
93 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
94                                               const struct ads_entry *entry_2)
95 {
96         if (entry_1->stream_name_len != entry_2->stream_name_len)
97                 return false;
98         return memcmp(entry_1->stream_name, entry_2->stream_name,
99                       entry_1->stream_name_len) == 0;
100 }
101
102 /* 
103  * In-memory structure for a WIM directory entry (dentry).  There is a directory
104  * tree for each image in the WIM. 
105  *
106  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
107  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
108  * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
109  * inode that the dentry corresponds to.
110  *
111  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
112  * information, such as file attributes, the security descriptor, and file
113  * streams is replicated in each hard-linked dentry, even though this
114  * information really is associated with an inode.  In-memory, we fix up this
115  * flaw by allocating a `struct inode' for each dentry that contains some of
116  * this duplicated information, then combining the inodes for each hard link
117  * group together.
118  *
119  * Confusingly, it's possible for stream information to be missing from a dentry
120  * in a hard link set, in which case the stream information needs to be gotten
121  * from one of the other dentries in the hard link set.  In addition, it is
122  * possible for dentries to have inconsistent security IDs, file attributes, or
123  * file streams when they share the same hard link ID (don't even ask.  I hope
124  * that Microsoft may have fixed this problem, since I've only noticed it in the
125  * 'install.wim' for Windows 7).  For those dentries, we have to use the
126  * conflicting fields to split up the hard link groups.  (See fix_inodes() in
127  * hardlink.c).
128  */
129 struct dentry {
130         /* The inode for this dentry */
131         struct inode *d_inode;
132
133         /* The parent of this directory entry. */
134         struct dentry *parent;
135
136         /* Linked list of sibling directory entries. */
137         struct dentry *next;
138         struct dentry *prev;
139
140         /* 
141          * Size of directory entry on disk, in bytes.  Typical size is around
142          * 104 to 120 bytes.
143          *
144          * It is possible for the length field to be 0.  This situation, which
145          * is undocumented, indicates the end of a list of sibling nodes in a
146          * directory.  It also means the real length is 8, because the dentry
147          * included only the length field, but that takes up 8 bytes.
148          *
149          * The length here includes the base directory entry on disk as well as
150          * the long and short filenames.  It does NOT include any alternate
151          * stream entries that may follow the directory entry, even though the
152          * size of those needs to be considered.  The length SHOULD be 8-byte
153          * aligned, although we don't require it to be.  We do require the
154          * length to be large enough to hold the file name(s) of the dentry;
155          * additionally, a warning is issued if this field is larger than the
156          * aligned size.
157          */
158         u64 length;
159
160         /* The offset, from the start of the uncompressed WIM metadata resource
161          * for this image, of this dentry's child dentries.  0 if the directory
162          * entry has no children, which is the case for regular files or reparse
163          * points. */
164         u64 subdir_offset;
165
166         /* Length of short filename, in bytes, not including the terminating
167          * zero wide-character. */
168         u16 short_name_len;
169
170         /* Length of file name, in bytes, not including the terminating zero
171          * wide-character. */
172         u16 file_name_len;
173
174         /* Length of the filename converted into UTF-8, in bytes, not including
175          * the terminating zero byte. */
176         u16 file_name_utf8_len;
177
178         /* Pointer to the short filename (malloc()ed buffer) */
179         char *short_name;
180
181         /* Pointer to the filename (malloc()ed buffer). */
182         char *file_name;
183
184         /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
185         char *file_name_utf8;
186
187         /* Full path to this dentry (malloc()ed buffer). */
188         char *full_path_utf8;
189         u32   full_path_utf8_len;
190
191         /* Number of references to the dentry tree itself, as in multiple
192          * WIMStructs */
193         u32 refcnt;
194
195         /* List of dentries in the inode (hard link set)  */
196         struct list_head inode_dentry_list;
197
198         union {
199                 struct list_head tmp_list;
200                 bool is_extracted;
201         };
202 };
203
204 /*
205  * WIM inode.
206  *
207  * As mentioned above, in the WIM file that is no on-disk analogue of a real
208  * inode, as most of these fields are duplicated in the dentries.
209  */
210 struct inode {
211         /* Timestamps for the inode.  The timestamps are the number of
212          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
213          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
214         u64 creation_time;
215         u64 last_access_time;
216         u64 last_write_time;
217
218         /* The file attributes associated with this inode.  This is a bitwise OR
219          * of the FILE_ATTRIBUTE_* flags. */
220         u32 attributes;
221
222         /* The index of the security descriptor in the WIM image's table of
223          * security descriptors that contains this file's security information.
224          * If -1, no security information exists for this file.  */
225         int32_t security_id;
226
227         /* %true iff the inode's lookup table entries has been resolved (i.e.
228          * the @lte field is valid, but the @hash field is not valid) 
229          *
230          * (This is not an on-disk field.) */
231         u8 resolved : 1;
232
233         /* %true iff verify_inode() has run on this dentry. */
234         u8 verified : 1;
235
236         /* Number of alternate data streams associated with this inode */
237         u16 num_ads;
238
239         /* A hash of the file's contents, or a pointer to the lookup table entry
240          * for this dentry if the lookup table entries have been resolved.
241          *
242          * More specifically, this is for the un-named default file stream, as
243          * opposed to the alternate (named) file streams, which may have their
244          * own lookup table entries.  */
245         union {
246                 u8 hash[SHA1_HASH_SIZE];
247                 struct lookup_table_entry *lte;
248         };
249
250         /* Identity of a reparse point.  See
251          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
252          * for what a reparse point is. */
253         u32 reparse_tag;
254
255         /* Number of dentries that reference this inode */
256         u32 link_count;
257
258         /* Alternate data stream entries. */
259         struct ads_entry *ads_entries;
260
261         /* Inode number */
262         u64 ino;
263
264         /* List of dentries that reference this inode (there should be
265          * link_count of them) */
266         struct list_head dentry_list;
267         struct hlist_node hlist;
268         char *extracted_file;
269
270         /* If non-NULL, the children of this inode (implies the inode is a
271          * directory) */
272         struct dentry *children;
273
274 #ifdef WITH_FUSE
275         /* wimfs file descriptors table for the inode */
276         u16 num_opened_fds;
277         u16 num_allocated_fds;
278         struct wimlib_fd **fds;
279
280         /* Next alternate data stream ID to be assigned */
281         u32 next_stream_id;
282 #endif
283 };
284
285 #define inode_for_each_dentry(dentry, inode) \
286                 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
287
288 #define inode_add_dentry(dentry, inode) \
289         ({                                                              \
290                 wimlib_assert((inode)->dentry_list.next != NULL);               \
291                 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list);  \
292         })
293
294 static inline bool dentry_is_extracted(const struct dentry *dentry)
295 {
296         return dentry->is_extracted;
297 }
298
299 static inline bool dentry_is_first_in_inode(const struct dentry *dentry)
300 {
301         return container_of(dentry->d_inode->dentry_list.next,
302                             struct dentry,
303                             inode_dentry_list) == dentry;
304 }
305
306 extern u64 dentry_correct_total_length(const struct dentry *dentry);
307
308 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
309 extern int inode_to_stbuf(const struct inode *inode,
310                           struct lookup_table_entry *lte, struct stat *stbuf);
311
312 extern int for_dentry_in_tree(struct dentry *root, 
313                               int (*visitor)(struct dentry*, void*), 
314                               void *args);
315
316 extern int for_dentry_in_tree_depth(struct dentry *root, 
317                                     int (*visitor)(struct dentry*, void*), 
318                                     void *args);
319
320 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
321 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
322 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
323                      u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
324                      const char *name);
325
326 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
327 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
328                                            const char *path);
329 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry, 
330                                                  const char *name);
331 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
332
333 extern int print_dentry(struct dentry *dentry, void *lookup_table);
334 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
335
336 extern struct dentry *new_dentry(const char *name);
337 extern struct dentry *new_dentry_with_inode(const char *name);
338 extern struct dentry *new_dentry_with_timeless_inode(const char *name);
339
340 extern void free_inode(struct inode *inode);
341 extern void free_dentry(struct dentry *dentry);
342 extern void put_dentry(struct dentry *dentry);
343
344 extern void free_dentry_tree(struct dentry *root,
345                              struct lookup_table *lookup_table);
346 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
347
348 extern void unlink_dentry(struct dentry *dentry);
349 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
350
351 extern int verify_dentry(struct dentry *dentry, void *wim);
352
353
354 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
355                                              const char *stream_name,
356                                              u16 *idx_ret);
357 extern struct ads_entry *inode_add_ads(struct inode *dentry,
358                                        const char *stream_name);
359
360 extern void inode_remove_ads(struct inode *inode, u16 idx,
361                              struct lookup_table *lookup_table);
362
363 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len, 
364                        u64 offset, struct dentry *dentry);
365
366
367 extern int read_dentry_tree(const u8 metadata_resource[], 
368                             u64 metadata_resource_len, struct dentry *dentry);
369
370 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
371
372 static inline bool dentry_is_root(const struct dentry *dentry)
373 {
374         return dentry->parent == dentry;
375 }
376
377 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
378 {
379         return dentry_is_root(dentry) || dentry->parent->d_inode->children == dentry;
380 }
381
382 static inline bool dentry_is_only_child(const struct dentry *dentry)
383 {
384         return dentry->next == dentry;
385 }
386
387 static inline bool inode_is_directory(const struct inode *inode)
388 {
389         return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
390                 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
391 }
392
393 static inline bool dentry_is_directory(const struct dentry *dentry)
394 {
395         return inode_is_directory(dentry->d_inode);
396 }
397
398 /* For our purposes, we consider "real" symlinks and "junction points" to both
399  * be symlinks. */
400 static inline bool inode_is_symlink(const struct inode *inode)
401 {
402         return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
403                 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
404                      inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
405 }
406
407 static inline bool dentry_is_symlink(const struct dentry *dentry)
408 {
409         return inode_is_symlink(dentry->d_inode);
410 }
411
412 static inline bool inode_is_regular_file(const struct inode *inode)
413 {
414         return !inode_is_directory(inode) && !inode_is_symlink(inode);
415 }
416
417 static inline bool dentry_is_regular_file(const struct dentry *dentry)
418 {
419         return inode_is_regular_file(dentry->d_inode);
420 }
421
422 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
423 {
424         return dentry_is_directory(dentry) && dentry->d_inode->children == NULL;
425 }
426
427 #endif