8c6aa95fef8cdccb05c16dd759e804000b26b392
[wimlib] / include / wimlib / inode.h
1 #ifndef _WIMLIB_INODE_H
2 #define _WIMLIB_INODE_H
3
4 #include "wimlib/assert.h"
5 #include "wimlib/list.h"
6 #include "wimlib/lookup_table.h"
7 #include "wimlib/sha1.h"
8
9 #include <string.h>
10
11 struct wim_ads_entry;
12 struct wim_dentry;
13 struct wim_security_data;
14 struct wim_lookup_table;
15 struct wimfs_fd;
16 struct avl_tree_node;
17
18 /*
19  * WIM inode.
20  *
21  * As mentioned in the comment above `struct wim_dentry', in the WIM file that
22  * is no on-disk analogue of a real inode, as most of these fields are
23  * duplicated in the dentries.  Instead, a `struct wim_inode' is something we
24  * create ourselves to simplify the handling of hard links.
25  */
26 struct wim_inode {
27         /* If i_resolved == 0:
28          *      SHA1 message digest of the contents of the unnamed-data stream
29          *      of this inode.
30          *
31          * If i_resolved == 1:
32          *      Pointer to the lookup table entry for the unnamed data stream
33          *      of this inode, or NULL.
34          *
35          * i_hash corresponds to the 'unnamed_stream_hash' field of the `struct
36          * wim_dentry_on_disk' and the additional caveats documented about that
37          * field apply here (for example, the quirks regarding all-zero hashes).
38          */
39         union {
40                 u8 i_hash[SHA1_HASH_SIZE];
41                 struct wim_lookup_table_entry *i_lte;
42         };
43
44         /* Corresponds to the 'attributes' field of `struct wim_dentry_on_disk';
45          * bitwise OR of the FILE_ATTRIBUTE_* flags that give the attributes of
46          * this inode. */
47         u32 i_attributes;
48
49         /* Root of a balanced binary search tree storing the child directory
50          * entries of this inode, if any.  Keyed by wim_dentry->file_name, case
51          * sensitively.  If this inode is not a directory or if it has no
52          * children then this will be an empty tree (NULL).  */
53         struct avl_tree_node *i_children;
54
55         /* Root of a balanced binary search tree storing the child directory
56          * entries of this inode, if any.  Keyed by wim_dentry->file_name, case
57          * insensitively.  If this inode is not a directory or if it has no
58          * children then this will be an empty tree (NULL).  */
59         struct avl_tree_node *i_children_ci;
60
61         /* List of dentries that are aliases for this inode.  There will be
62          * i_nlink dentries in this list.  */
63         struct list_head i_dentry;
64
65         /* Field to place this inode into a list. */
66         union {
67                 /* Hash list node- used in inode_fixup.c when the inodes are
68                  * placed into a hash table keyed by inode number and optionally
69                  * device number, in order to detect dentries that are aliases
70                  * for the same inode. */
71                 struct hlist_node i_hlist;
72
73                 /* Normal list node- used to connect all the inodes of a WIM image
74                  * into a single linked list referenced from the
75                  * `struct wim_image_metadata' for that image. */
76                 struct list_head i_list;
77         };
78
79         /* Number of dentries that are aliases for this inode.  */
80         u32 i_nlink;
81
82         /* Number of alternate data streams (ADS) associated with this inode */
83         u16 i_num_ads;
84
85         /* Flag that indicates whether this inode's streams have been
86          * "resolved".  By default, the inode starts as "unresolved", meaning
87          * that the i_hash field, along with the hash field of any associated
88          * wim_ads_entry's, are valid and should be used as keys in the WIM
89          * lookup table to find the associated `struct wim_lookup_table_entry'.
90          * But if the inode has been resolved, then each of these fields is
91          * replaced with a pointer directly to the appropriate `struct
92          * wim_lookup_table_entry', or NULL if the stream is empty.  */
93         u8 i_resolved : 1;
94
95         /* Flag used to mark this inode as visited; this is used when visiting
96          * all the inodes in a dentry tree exactly once.  It will be 0 by
97          * default and must be cleared following the tree traversal, even in
98          * error paths.  */
99         u8 i_visited : 1;
100
101         /* 1 iff all ADS entries of this inode are named or if this inode
102          * has no ADS entries  */
103         u8 i_canonical_streams : 1;
104
105         /* Pointer to a malloc()ed array of i_num_ads alternate data stream
106          * entries for this inode.  */
107         struct wim_ads_entry *i_ads_entries;
108
109         /* If not NULL, a pointer to the extra data that was read from the
110          * dentry.  This should be a series of tagged items, each of which
111          * represents a bit of extra metadata, such as the file's object ID.
112          * See tagged_items.c for more information.  */
113         void *i_extra;
114
115         /* Size of @i_extra buffer in bytes.  If 0, there is no extra data.  */
116         size_t i_extra_size;
117
118         /* Creation time, last access time, and last write time for this inode, in
119          * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601.  They
120          * should correspond to the times gotten by calling GetFileTime() on
121          * Windows. */
122         u64 i_creation_time;
123         u64 i_last_access_time;
124         u64 i_last_write_time;
125
126         /* Corresponds to 'security_id' in `struct wim_dentry_on_disk':  The
127          * index of this inode's security descriptor in the WIM image's table of
128          * security descriptors, or -1.  Note: in verify_inode(), called
129          * whenever a WIM image is loaded, out-of-bounds indices are set to -1,
130          * so the extraction code does not need to do bounds checks.  */
131         int32_t i_security_id;
132
133         /* Identity of a reparse point.  See
134          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
135          * for what a reparse point is. */
136         u32 i_reparse_tag;
137
138         /* Unused/unknown fields that we just read into memory so we can
139          * re-write them unchanged.  */
140         u32 i_rp_unknown_1;
141         u16 i_rp_unknown_2;
142
143         /* Corresponds to not_rpfixed in `struct wim_dentry_on_disk':  Set to 0
144          * if reparse point fixups have been done.  Otherwise set to 1.  Note:
145          * this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.
146          */
147         u16 i_not_rpfixed;
148
149         /* Inode number; corresponds to hard_link_group_id in the `struct
150          * wim_dentry_on_disk'.  */
151         u64 i_ino;
152
153         union {
154                 /* Device number, used only during image capture, so we can
155                  * identify hard linked files by the combination of inode number
156                  * and device number (rather than just inode number, which could
157                  * be ambigious if the captured tree spans a mountpoint).  Set
158                  * to 0 otherwise.  */
159                 u64 i_devno;
160
161                 /* Fields used only during extraction  */
162                 struct {
163                         /* List of aliases of this dentry that are being
164                          * extracted in the current extraction operation.  This
165                          * will be a (possibly nonproper) subset of the dentries
166                          * in the i_dentry list.  This list will be constructed
167                          * regardless of whether the extraction backend supports
168                          * hard links or not.  */
169                         struct list_head i_extraction_aliases;
170
171                 #ifdef WITH_NTFS_3G
172                         /* In NTFS-3g extraction mode, this is set to the Master
173                          * File Table (MFT) number of the NTFS file that was
174                          * created for this inode.  */
175                         u64 i_mft_no;
176                 #endif
177                 };
178
179 #ifdef WITH_FUSE
180                 /* Used only during image mount:  Table of file descriptors that
181                  * have been opened to this inode.  The table is automatically
182                  * freed when the last file descriptor is closed.  */
183                 struct wimfs_fd **i_fds;
184 #endif
185         };
186
187 #ifdef WITH_FUSE
188         u16 i_num_opened_fds;
189         u16 i_num_allocated_fds;
190 #endif
191
192         /* Next alternate data stream ID to be assigned */
193         u32 i_next_stream_id;
194 };
195
196 /* Alternate data stream entry.
197  *
198  * We read this from disk in the read_ads_entries() function; see that function
199  * for more explanation. */
200 struct wim_ads_entry {
201         union {
202                 /* SHA-1 message digest of stream contents */
203                 u8 hash[SHA1_HASH_SIZE];
204
205                 /* The corresponding lookup table entry (only for resolved
206                  * streams) */
207                 struct wim_lookup_table_entry *lte;
208         };
209
210         /* Length of UTF16-encoded stream name, in bytes, not including the
211          * terminating null character; or 0 if the stream is unnamed. */
212         u16 stream_name_nbytes;
213
214         /* Number to identify an alternate data stream even after it's possibly
215          * been moved or renamed. */
216         u32 stream_id;
217
218         /* Stream name (UTF-16LE), null-terminated, or NULL if the stream is
219          * unnamed.  */
220         utf16lechar *stream_name;
221
222         /* Reserved field.  We read it into memory so we can write it out
223          * unchanged. */
224         u64 reserved;
225 };
226
227 /* WIM alternate data stream entry (on-disk format) */
228 struct wim_ads_entry_on_disk {
229         /*  Length of the entry, in bytes.  This apparently includes all
230          *  fixed-length fields, plus the stream name and null terminator if
231          *  present, and the padding up to an 8 byte boundary.  wimlib is a
232          *  little less strict when reading the entries, and only requires that
233          *  the number of bytes from this field is at least as large as the size
234          *  of the fixed length fields and stream name without null terminator.
235          *  */
236         le64  length;
237
238         le64  reserved;
239
240         /* SHA1 message digest of the uncompressed stream; or, alternatively,
241          * can be all zeroes if the stream has zero length. */
242         u8 hash[SHA1_HASH_SIZE];
243
244         /* Length of the stream name, in bytes.  0 if the stream is unnamed.  */
245         le16 stream_name_nbytes;
246
247         /* Stream name in UTF-16LE.  It is @stream_name_nbytes bytes long,
248          * excluding the null terminator.  There is a null terminator
249          * character if @stream_name_nbytes != 0; i.e., if this stream is named.
250          * */
251         utf16lechar stream_name[];
252 } _packed_attribute;
253
254 #define WIM_ADS_ENTRY_DISK_SIZE 38
255
256 /*
257  * Reparse tags documented at
258  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
259  */
260 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
261 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
262 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
263 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
264 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
265 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
266 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
267 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
268 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
269 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
270 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
271
272 #define FILE_ATTRIBUTE_READONLY            0x00000001
273 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
274 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
275 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
276 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
277 #define FILE_ATTRIBUTE_DEVICE              0x00000040
278 #define FILE_ATTRIBUTE_NORMAL              0x00000080
279 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
280 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
281 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
282 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
283 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
284 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
285 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
286 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
287
288 extern struct wim_inode *
289 new_inode(void) _malloc_attribute;
290
291 extern struct wim_inode *
292 new_timeless_inode(void) _malloc_attribute;
293
294 extern void
295 put_inode(struct wim_inode *inode);
296
297 extern void
298 free_inode(struct wim_inode *inode);
299
300 /* Iterate through each alias of an inode.  */
301 #define inode_for_each_dentry(dentry, inode) \
302                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
303
304 /* Add a new alias for an inode.  Does not increment i_nlink; that must be done
305  * separately.  */
306 #define inode_add_dentry(dentry, inode) \
307                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
308
309 /* Return an alias of an inode.  */
310 #define inode_first_dentry(inode) \
311                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
312
313 /* Return the full path of an alias of an inode, or NULL if it could not be
314  * determined.  */
315 #define inode_first_full_path(inode) \
316                 dentry_full_path(inode_first_dentry(inode))
317
318 extern struct wim_ads_entry *
319 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
320                     u16 *idx_ret);
321
322 extern struct wim_ads_entry *
323 inode_add_ads_utf16le(struct wim_inode *inode,
324                       const utf16lechar *stream_name,
325                       size_t stream_name_nbytes);
326
327 extern struct wim_ads_entry *
328 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
329
330 extern int
331 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
332                         const void *value, size_t size,
333                         struct wim_lookup_table *lookup_table);
334
335 extern bool
336 inode_has_named_stream(const struct wim_inode *inode);
337
338 extern int
339 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
340                          struct wim_lookup_table *lookup_table);
341
342 extern void
343 inode_remove_ads(struct wim_inode *inode, u16 idx,
344                  struct wim_lookup_table *lookup_table);
345
346 static inline bool
347 ads_entry_is_named_stream(const struct wim_ads_entry *entry)
348 {
349         return entry->stream_name_nbytes != 0;
350 }
351
352 /* Is the inode a directory?
353  * This doesn't count directories with reparse data.
354  * wimlib only allows inodes of this type to have children.
355  */
356 static inline bool
357 inode_is_directory(const struct wim_inode *inode)
358 {
359         return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
360                                        FILE_ATTRIBUTE_REPARSE_POINT))
361                         == FILE_ATTRIBUTE_DIRECTORY;
362 }
363
364 /* Is the inode a directory with the encrypted attribute set?
365  * This currently returns true for encrypted directories even if they have
366  * reparse data (not sure if such files can even exist).  */
367 static inline bool
368 inode_is_encrypted_directory(const struct wim_inode *inode)
369 {
370         return ((inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
371                                         FILE_ATTRIBUTE_ENCRYPTED))
372                 == (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_ENCRYPTED));
373 }
374
375 /* Is the inode a symbolic link?
376  * This returns true iff the inode is a reparse point that is either a "real"
377  * symbolic link or a junction point.  */
378 static inline bool
379 inode_is_symlink(const struct wim_inode *inode)
380 {
381         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
382                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
383                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
384 }
385
386 /* Does the inode have children?
387  * Currently (based on read_dentry_tree()), this can only return true for inodes
388  * for which inode_is_directory() returns true.  (This also returns false on
389  * empty directories.)  */
390 static inline bool
391 inode_has_children(const struct wim_inode *inode)
392 {
393         return inode->i_children != NULL;
394 }
395
396 extern int
397 inode_resolve_streams(struct wim_inode *inode, struct wim_lookup_table *table,
398                       bool force);
399
400 extern int
401 stream_not_found_error(const struct wim_inode *inode, const u8 *hash);
402
403 extern void
404 inode_unresolve_streams(struct wim_inode *inode);
405
406 static inline struct wim_lookup_table_entry *
407 inode_stream_lte_resolved(const struct wim_inode *inode, unsigned stream_idx)
408 {
409         wimlib_assert(inode->i_resolved);
410         wimlib_assert(stream_idx <= inode->i_num_ads);
411         if (stream_idx == 0)
412                 return inode->i_lte;
413         else
414                 return inode->i_ads_entries[stream_idx - 1].lte;
415 }
416
417 static inline struct wim_lookup_table_entry *
418 inode_stream_lte_unresolved(const struct wim_inode *inode, unsigned stream_idx,
419                             const struct wim_lookup_table *table)
420 {
421         wimlib_assert(!inode->i_resolved);
422         wimlib_assert(stream_idx <= inode->i_num_ads);
423         if (table == NULL)
424                 return NULL;
425         if (stream_idx == 0)
426                 return lookup_stream(table, inode->i_hash);
427         else
428                 return lookup_stream(table, inode->i_ads_entries[ stream_idx - 1].hash);
429 }
430
431 extern struct wim_lookup_table_entry *
432 inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx,
433                  const struct wim_lookup_table *table);
434
435 static inline const u8 *
436 inode_stream_hash_unresolved(const struct wim_inode *inode, unsigned stream_idx)
437 {
438         wimlib_assert(!inode->i_resolved);
439         wimlib_assert(stream_idx <= inode->i_num_ads);
440         if (stream_idx == 0)
441                 return inode->i_hash;
442         else
443                 return inode->i_ads_entries[stream_idx - 1].hash;
444 }
445
446
447 static inline const u8 *
448 inode_stream_hash_resolved(const struct wim_inode *inode, unsigned stream_idx)
449 {
450         struct wim_lookup_table_entry *lte;
451         lte = inode_stream_lte_resolved(inode, stream_idx);
452         if (lte)
453                 return lte->hash;
454         else
455                 return zero_hash;
456 }
457
458 /*
459  * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
460  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
461  * alternate data stream.
462  *
463  * This works for both resolved and un-resolved dentries.
464  */
465 static inline const u8 *
466 inode_stream_hash(const struct wim_inode *inode, unsigned stream_idx)
467 {
468         if (inode->i_resolved)
469                 return inode_stream_hash_resolved(inode, stream_idx);
470         else
471                 return inode_stream_hash_unresolved(inode, stream_idx);
472 }
473
474 static inline u16
475 inode_stream_name_nbytes(const struct wim_inode *inode, unsigned stream_idx)
476 {
477         wimlib_assert(stream_idx <= inode->i_num_ads);
478         if (stream_idx == 0)
479                 return 0;
480         else
481                 return inode->i_ads_entries[stream_idx - 1].stream_name_nbytes;
482 }
483
484 extern struct wim_lookup_table_entry *
485 inode_unnamed_stream_resolved(const struct wim_inode *inode, u16 *stream_idx_ret);
486
487 extern struct wim_lookup_table_entry *
488 inode_unnamed_lte_resolved(const struct wim_inode *inode);
489
490 extern struct wim_lookup_table_entry *
491 inode_unnamed_lte_unresolved(const struct wim_inode *inode,
492                              const struct wim_lookup_table *table);
493
494 extern struct wim_lookup_table_entry *
495 inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
496
497 extern const u8 *
498 inode_unnamed_stream_hash(const struct wim_inode *inode);
499
500 extern int
501 read_ads_entries(const u8 * restrict p, struct wim_inode * restrict inode,
502                  size_t nbytes_remaining);
503
504 extern int
505 verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
506
507 extern void
508 inode_ref_streams(struct wim_inode *inode);
509
510 extern void
511 inode_unref_streams(struct wim_inode *inode,
512                     struct wim_lookup_table *lookup_table);
513
514 /* inode_fixup.c  */
515 extern int
516 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
517
518 #endif /* _WIMLIB_INODE_H  */