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