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