hardlink.c: Fix some error paths
[wimlib] / include / wimlib / dentry.h
1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
3
4 #include "wimlib/compiler.h"
5 #include "wimlib/list.h"
6 #include "wimlib/rbtree.h"
7 #include "wimlib/sha1.h"
8 #include "wimlib/types.h"
9
10 #include <string.h>
11 #include <sys/types.h> /* uid_t, gid_t */
12
13 #ifdef WITH_FUSE
14 #  include <pthread.h>
15 #endif
16
17 struct wim_lookup_table;
18 struct wim_lookup_table_entry;
19 struct wimfs_fd;
20 struct wim_inode;
21
22 /* Size of the struct wim_dentry up to and including the file_name_len. */
23 #define WIM_DENTRY_DISK_SIZE    102
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 wim_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 wim_lookup_table_entry *lte;
70         };
71
72         /* Length of UTF16-encoded stream name, in bytes, not including the
73          * terminating null character; or 0 if the stream is unnamed. */
74         u16 stream_name_nbytes;
75
76         /* Number to identify an alternate data stream even after it's possibly
77          * been moved or renamed. */
78         u32 stream_id;
79
80         /* Stream name (UTF-16LE), null-terminated, or NULL if the stream is
81          * unnamed.  */
82         utf16lechar *stream_name;
83
84         /* Reserved field.  We read it into memory so we can write it out
85          * unchanged. */
86         u64 reserved;
87 };
88
89
90 static inline bool
91 ads_entries_have_same_name(const struct wim_ads_entry *entry_1,
92                            const struct wim_ads_entry *entry_2)
93 {
94         return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes &&
95                memcmp(entry_1->stream_name, entry_2->stream_name,
96                       entry_1->stream_name_nbytes) == 0;
97 }
98
99 /*
100  * In-memory structure for a WIM directory entry (dentry).  There is a directory
101  * tree for each image in the WIM.
102  *
103  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
104  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
105  * The hard link group ID field of the on-disk WIM dentry tells us the number of
106  * the NTFS inode that the dentry corresponds to (and this gets placed in
107  * d_inode->i_ino).
108  *
109  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
110  * information, such as file attributes, the security descriptor, and file
111  * streams is replicated in each hard-linked dentry, even though this
112  * information really is associated with an inode.  In-memory, we fix up this
113  * flaw by allocating a `struct wim_inode' for each dentry that contains some of
114  * this duplicated information, then combining the inodes for each hard link
115  * group together.
116  *
117  * Confusingly, it's possible for stream information to be missing from a dentry
118  * in a hard link set, in which case the stream information needs to be gotten
119  * from one of the other dentries in the hard link set.  In addition, it is
120  * possible for dentries to have inconsistent security IDs, file attributes, or
121  * file streams when they share the same hard link ID (don't even ask.  I hope
122  * that Microsoft may have fixed this problem, since I've only noticed it in the
123  * 'install.wim' for Windows 7).  For those dentries, we have to use the
124  * conflicting fields to split up the hard link groups.  (See
125  * dentry_tree_fix_inodes() in hardlink.c).
126  */
127 struct wim_dentry {
128         /* The inode for this dentry */
129         struct wim_inode *d_inode;
130
131         /* Node for the parent's red-black tree of child dentries, sorted by
132          * case sensitive long name. */
133         struct rb_node rb_node;
134
135 #ifdef __WIN32__
136         /* Node for the parent's red-black tree of child dentries, sorted by
137          * case insensitive long name. */
138         struct rb_node rb_node_case_insensitive;
139
140         /* List of dentries in a directory that have different case sensitive
141          * long names but share the same case insensitive long name */
142         struct list_head case_insensitive_conflict_list;
143 #endif
144
145         /* Length of UTF-16LE encoded short filename, in bytes, not including
146          * the terminating zero wide-character. */
147         u16 short_name_nbytes;
148
149         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
150          * the terminating null character. */
151         u16 file_name_nbytes;
152
153         /* Length of full path name encoded using "tchars", in bytes, not
154          * including the terminating null character. */
155         u32 full_path_nbytes;
156
157         /* Does this dentry need to be extracted? */
158         u8 needs_extraction : 1;
159
160         u8 not_extracted : 1;
161
162         /* Only used during NTFS capture */
163         u8 is_win32_name : 1;
164
165         /* Set to 1 if an inode has multiple DOS names. */
166         u8 dos_name_invalid : 1;
167
168         /* Temporary list */
169         struct list_head tmp_list;
170
171         /* List of dentries in the inode (hard link set)  */
172         struct list_head d_alias;
173
174         /* The parent of this directory entry. */
175         struct wim_dentry *parent;
176
177         /*
178          * Size of directory entry on disk, in bytes.  Typical size is around
179          * 104 to 120 bytes.
180          *
181          * It is possible for the length field to be 0.  This situation, which
182          * is undocumented, indicates the end of a list of sibling nodes in a
183          * directory.  It also means the real length is 8, because the dentry
184          * included only the length field, but that takes up 8 bytes.
185          *
186          * The length here includes the base directory entry on disk as well as
187          * the long and short filenames.  It does NOT include any alternate
188          * stream entries that may follow the directory entry, even though the
189          * size of those needs to be considered.  The length SHOULD be 8-byte
190          * aligned, although we don't require it to be.  We do require the
191          * length to be large enough to hold the file name(s) of the dentry;
192          * additionally, a warning is issued if this field is larger than the
193          * aligned size.
194          */
195         u64 length;
196
197         /* The offset, from the start of the uncompressed WIM metadata resource
198          * for this image, of this dentry's child dentries.  0 if the directory
199          * entry has no children, which is the case for regular files or reparse
200          * points. */
201         u64 subdir_offset;
202
203         u64 d_unused_1;
204         u64 d_unused_2;
205
206         /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */
207         utf16lechar *short_name;
208
209         /* Pointer to the UTF-16LE filename (malloc()ed buffer). */
210         utf16lechar *file_name;
211
212         /* Full path of this dentry in the WIM */
213         tchar *_full_path;
214
215         /* Actual name to extract this dentry as. */
216         tchar *extraction_name;
217         size_t extraction_name_nchars;
218
219         /* List head for building a list of dentries that contain a certain
220          * stream. */
221         struct list_head extraction_stream_list;
222 };
223
224 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
225
226 /*
227  * WIM inode.
228  *
229  * As mentioned above, in the WIM file that is no on-disk analogue of a real
230  * inode, as most of these fields are duplicated in the dentries.
231  */
232 struct wim_inode {
233         /* Timestamps for the inode.  The timestamps are the number of
234          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
235          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
236         u64 i_creation_time;
237         u64 i_last_access_time;
238         u64 i_last_write_time;
239
240         /* The file attributes associated with this inode.  This is a bitwise OR
241          * of the FILE_ATTRIBUTE_* flags. */
242         u32 i_attributes;
243
244         /* The index of the security descriptor in the WIM image's table of
245          * security descriptors that contains this file's security information.
246          * If -1, no security information exists for this file.  */
247         int32_t i_security_id;
248
249         /* %true iff the inode's lookup table entries has been resolved (i.e.
250          * the @lte field is valid, but the @hash field is not valid)
251          *
252          * (This is not an on-disk field.) */
253         u8 i_resolved : 1;
254
255         /* %true iff verify_inode() has run on this inode. */
256         u8 i_verified : 1;
257
258         u8 i_visited : 1;
259
260         /* Used only in NTFS-mode extraction */
261         u8 i_dos_name_extracted : 1;
262
263         /* Set to 0 if reparse point fixups have been done.  Otherwise set to 1.
264          *
265          * Note: this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.  */
266         u16 i_not_rpfixed;
267
268         /* Number of alternate data streams associated with this inode */
269         u16 i_num_ads;
270
271         /* Unused/unknown fields that we just read into memory so we can
272          * re-write them unchanged.  */
273         u32 i_rp_unknown_1;
274         u16 i_rp_unknown_2;
275
276         /* If i_resolved == 0:
277          *      SHA1 message digest of the contents of the unnamed-data stream
278          *      of this inode, or all zeroes if this inode has no unnamed data
279          *      stream, or optionally all zeroes if this inode has an empty
280          *      unnamed data stream.
281          *
282          * If i_resolved == 1:
283          *      Pointer to the lookup table entry for the unnamed data stream
284          *      of this inode, or NULL if this inode has no unnamed data stream,
285          *      or optionally all zeroes if this inode has an empty unnamed data
286          *      stream.
287          */
288         union {
289                 u8 i_hash[SHA1_HASH_SIZE];
290                 struct wim_lookup_table_entry *i_lte;
291         };
292
293         /* Identity of a reparse point.  See
294          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
295          * for what a reparse point is. */
296         u32 i_reparse_tag;
297
298         /* Number of dentries that reference this inode */
299         u32 i_nlink;
300
301         /* Alternate data stream entries. */
302         struct wim_ads_entry *i_ads_entries;
303
304         /* Inode number */
305         u64 i_ino;
306
307         /* Device number, used only during image capture */
308         u64 i_devno;
309
310         /* List of dentries that reference this inode (there should be i_nlink
311          * of them) */
312         struct list_head i_dentry;
313
314         union {
315                 struct hlist_node i_hlist;
316                 struct list_head i_list;
317         };
318
319         tchar *i_extracted_file;
320
321         /* Root of a red-black tree storing the children of this inode (if
322          * non-empty, implies the inode is a directory, although that is also
323          * noted in the @attributes field.) */
324         struct rb_root i_children;
325
326 #ifdef __WIN32__
327         struct rb_root i_children_case_insensitive;
328 #endif
329
330         /* Next alternate data stream ID to be assigned */
331         u32 i_next_stream_id;
332
333 #ifdef WITH_FUSE
334         /* wimfs file descriptors table for the inode */
335         u16 i_num_opened_fds;
336         u16 i_num_allocated_fds;
337         struct wimfs_fd **i_fds;
338         /* This mutex protects the inode's file descriptors table during
339          * read-only mounts.  Read-write mounts are still restricted to 1
340          * thread. */
341         pthread_mutex_t i_mutex;
342 #endif
343 };
344
345 #define inode_for_each_dentry(dentry, inode) \
346                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
347
348 #define inode_add_dentry(dentry, inode) \
349                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
350
351 #define inode_first_dentry(inode) \
352                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
353
354 static inline bool
355 dentry_is_first_in_inode(const struct wim_dentry *dentry)
356 {
357         return inode_first_dentry(dentry->d_inode) == dentry;
358 }
359
360 extern u64
361 dentry_correct_total_length(const struct wim_dentry *dentry);
362
363 extern int
364 for_dentry_in_tree(struct wim_dentry *root,
365                    int (*visitor)(struct wim_dentry*, void*),
366                    void *args);
367
368 extern int
369 for_dentry_in_rbtree(struct rb_node *node,
370                      int (*visitor)(struct wim_dentry *, void *),
371                      void *arg);
372
373 static inline int
374 for_dentry_child(const struct wim_dentry *dentry,
375                  int (*visitor)(struct wim_dentry *, void *),
376                  void *arg)
377 {
378         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
379                                     visitor,
380                                     arg);
381 }
382
383 extern int
384 for_dentry_in_tree_depth(struct wim_dentry *root,
385                          int (*visitor)(struct wim_dentry*, void*),
386                          void *args);
387
388 extern void
389 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
390
391 extern int
392 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
393
394 extern struct wim_dentry *
395 get_dentry(struct WIMStruct *w, const tchar *path);
396
397 extern struct wim_inode *
398 wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
399
400 extern struct wim_dentry *
401 get_dentry_child_with_name(const struct wim_dentry *dentry,
402                            const tchar *name);
403
404 extern struct wim_dentry *
405 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
406                                    const utf16lechar *name,
407                                    size_t name_nbytes);
408
409 extern struct wim_dentry *
410 get_parent_dentry(struct WIMStruct *w, const tchar *path);
411
412 extern int
413 print_dentry(struct wim_dentry *dentry, void *lookup_table);
414
415 extern int
416 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
417
418 extern int
419 calculate_dentry_full_path(struct wim_dentry *dentry);
420
421 extern int
422 calculate_dentry_tree_full_paths(struct wim_dentry *root);
423
424 extern tchar *
425 dentry_full_path(struct wim_dentry *dentry);
426
427 extern struct wim_inode *
428 new_timeless_inode(void) _malloc_attribute;
429
430 extern int
431 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
432
433 extern int
434 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
435
436 extern int
437 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
438
439 extern int
440 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
441
442 extern void
443 free_inode(struct wim_inode *inode);
444
445 extern void
446 free_dentry(struct wim_dentry *dentry);
447
448 extern void
449 put_dentry(struct wim_dentry *dentry);
450
451 extern void
452 free_dentry_tree(struct wim_dentry *root,
453                  struct wim_lookup_table *lookup_table);
454
455 extern void
456 unlink_dentry(struct wim_dentry *dentry);
457
458 extern struct wim_dentry *
459 dentry_add_child(struct wim_dentry * restrict parent,
460                  struct wim_dentry * restrict child);
461
462 extern struct wim_ads_entry *
463 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
464                     u16 *idx_ret);
465
466 extern struct wim_ads_entry *
467 inode_add_ads_utf16le(struct wim_inode *inode,
468                       const utf16lechar *stream_name,
469                       size_t stream_name_nbytes);
470
471 extern struct wim_ads_entry *
472 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
473
474 extern int
475 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
476                         const void *value, size_t size,
477                         struct wim_lookup_table *lookup_table);
478
479 extern int
480 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
481                          struct wim_lookup_table *lookup_table);
482
483 extern void
484 inode_remove_ads(struct wim_inode *inode, u16 idx,
485                  struct wim_lookup_table *lookup_table);
486
487
488 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
489 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
490
491 #define WIMLIB_UNIX_DATA_TAG_UTF16LE "$\0$\0_\0_\0w\0i\0m\0l\0i\0b\0_\0U\0N\0I\0X\0_\0d\0a\0t\0a\0"
492 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
493
494 /* Format for special alternate data stream entries to store UNIX data for files
495  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
496 struct wimlib_unix_data {
497         u16 version; /* Must be 0 */
498         u16 uid;
499         u16 gid;
500         u16 mode;
501 } _packed_attribute;
502
503 #ifndef __WIN32__
504
505 #define NO_UNIX_DATA (-1)
506 #define BAD_UNIX_DATA (-2)
507 extern int
508 inode_get_unix_data(const struct wim_inode *inode,
509                     struct wimlib_unix_data *unix_data,
510                     u16 *stream_idx_ret);
511
512 #define UNIX_DATA_UID    0x1
513 #define UNIX_DATA_GID    0x2
514 #define UNIX_DATA_MODE   0x4
515 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
516 #define UNIX_DATA_CREATE 0x8
517 extern int
518 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
519                     struct wim_lookup_table *lookup_table, int which);
520 #endif
521
522 extern int
523 read_dentry(const u8 *metadata_resource, u64 metadata_resource_len,
524             u64 offset, struct wim_dentry *dentry);
525
526 extern int
527 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
528                  struct wim_dentry *dentry);
529
530 extern u8 *
531 write_dentry_tree(const struct wim_dentry *tree, u8 *p);
532
533 static inline bool
534 dentry_is_root(const struct wim_dentry *dentry)
535 {
536         return dentry->parent == dentry;
537 }
538
539 static inline bool
540 inode_is_directory(const struct wim_inode *inode)
541 {
542         return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
543                 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
544 }
545
546 static inline bool
547 dentry_is_directory(const struct wim_dentry *dentry)
548 {
549         return inode_is_directory(dentry->d_inode);
550 }
551
552 /* For our purposes, we consider "real" symlinks and "junction points" to both
553  * be symlinks. */
554 static inline bool
555 inode_is_symlink(const struct wim_inode *inode)
556 {
557         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
558                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
559                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
560 }
561
562 static inline bool
563 inode_is_regular_file(const struct wim_inode *inode)
564 {
565         return !inode_is_directory(inode) && !inode_is_symlink(inode);
566 }
567
568 static inline bool
569 dentry_is_regular_file(const struct wim_dentry *dentry)
570 {
571         return inode_is_regular_file(dentry->d_inode);
572 }
573
574 static inline bool
575 inode_has_children(const struct wim_inode *inode)
576 {
577         return inode->i_children.rb_node != NULL;
578 }
579
580 static inline bool
581 dentry_has_children(const struct wim_dentry *dentry)
582 {
583         return inode_has_children(dentry->d_inode);
584 }
585
586 static inline bool
587 dentry_has_short_name(const struct wim_dentry *dentry)
588 {
589         return dentry->short_name_nbytes != 0;
590 }
591
592 static inline bool
593 dentry_has_long_name(const struct wim_dentry *dentry)
594 {
595         return dentry->file_name_nbytes != 0;
596 }
597
598 extern void
599 inode_ref_streams(struct wim_inode *inode);
600
601 extern int
602 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
603
604 extern int
605 verify_dentry(struct wim_dentry *dentry, void *wim);
606
607 #endif