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