1 #ifndef _WIMLIB_INODE_H
2 #define _WIMLIB_INODE_H
4 #include "wimlib/assert.h"
5 #include "wimlib/list.h"
6 #include "wimlib/lookup_table.h"
7 #include "wimlib/sha1.h"
13 struct wim_security_data;
14 struct wim_lookup_table;
21 * As mentioned in the comment above `struct wim_dentry', in WIM files there
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.
27 /* If i_resolved == 0:
28 * SHA1 message digest of the contents of the unnamed-data stream
32 * Pointer to the lookup table entry for the unnamed data stream
33 * of this inode, or NULL.
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).
40 u8 i_hash[SHA1_HASH_SIZE];
41 struct wim_lookup_table_entry *i_lte;
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
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;
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;
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;
65 /* Field to place this inode into a list. */
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;
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;
79 /* Number of dentries that are aliases for this inode. */
82 /* Number of alternate data streams (ADS) associated with this inode */
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. */
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
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;
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;
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. */
115 /* Size of @i_extra buffer in bytes. If 0, there is no extra data. */
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
123 u64 i_last_access_time;
124 u64 i_last_write_time;
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;
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. */
138 /* Unused/unknown fields that we just read into memory so we can
139 * re-write them unchanged. */
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.
149 /* Inode number; corresponds to hard_link_group_id in the `struct
150 * wim_dentry_on_disk'. */
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
161 /* Fields used only during extraction */
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;
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. */
179 /* Used during WIM writing with
180 * WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES: the number
181 * of data streams this inode has that have not yet been fully
183 u32 num_unread_streams;
187 /* Used only during image mount: Table of file
188 * descriptors that have been opened to this inode.
189 * This table is freed when the last file descriptor is
191 struct wimfs_fd **i_fds;
193 /* Lower bound on the index of the next available entry
201 u16 i_num_opened_fds;
202 u16 i_num_allocated_fds;
205 /* Next alternate data stream ID to be assigned */
206 u32 i_next_stream_id;
209 /* Alternate data stream entry.
211 * We read this from disk in the read_ads_entries() function; see that function
212 * for more explanation. */
213 struct wim_ads_entry {
215 /* SHA-1 message digest of stream contents */
216 u8 hash[SHA1_HASH_SIZE];
218 /* The corresponding lookup table entry (only for resolved
220 struct wim_lookup_table_entry *lte;
223 /* Length of UTF16-encoded stream name, in bytes, not including the
224 * terminating null character; or 0 if the stream is unnamed. */
225 u16 stream_name_nbytes;
227 /* Number to identify an alternate data stream even after it's possibly
228 * been moved or renamed. */
231 /* Stream name (UTF-16LE), null-terminated, or NULL if the stream is
233 utf16lechar *stream_name;
235 /* Reserved field. We read it into memory so we can write it out
240 /* WIM alternate data stream entry (on-disk format) */
241 struct wim_ads_entry_on_disk {
242 /* Length of the entry, in bytes. This apparently includes all
243 * fixed-length fields, plus the stream name and null terminator if
244 * present, and the padding up to an 8 byte boundary. wimlib is a
245 * little less strict when reading the entries, and only requires that
246 * the number of bytes from this field is at least as large as the size
247 * of the fixed length fields and stream name without null terminator.
253 /* SHA1 message digest of the uncompressed stream; or, alternatively,
254 * can be all zeroes if the stream has zero length. */
255 u8 hash[SHA1_HASH_SIZE];
257 /* Length of the stream name, in bytes. 0 if the stream is unnamed. */
258 le16 stream_name_nbytes;
260 /* Stream name in UTF-16LE. It is @stream_name_nbytes bytes long,
261 * excluding the null terminator. There is a null terminator
262 * character if @stream_name_nbytes != 0; i.e., if this stream is named.
264 utf16lechar stream_name[];
267 #define WIM_ADS_ENTRY_DISK_SIZE 38
270 * Reparse tags documented at
271 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
273 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000
274 #define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001
275 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
276 #define WIM_IO_REPARSE_TAG_HSM 0xC0000004
277 #define WIM_IO_REPARSE_TAG_HSM2 0x80000006
278 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
279 #define WIM_IO_REPARSE_TAG_SIS 0x80000007
280 #define WIM_IO_REPARSE_TAG_DFS 0x8000000A
281 #define WIM_IO_REPARSE_TAG_DFSR 0x80000012
282 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
283 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
285 #define FILE_ATTRIBUTE_READONLY 0x00000001
286 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
287 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
288 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
289 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
290 #define FILE_ATTRIBUTE_DEVICE 0x00000040
291 #define FILE_ATTRIBUTE_NORMAL 0x00000080
292 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
293 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
294 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
295 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
296 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
297 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
298 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
299 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
301 extern struct wim_inode *
302 new_inode(void) _malloc_attribute;
304 extern struct wim_inode *
305 new_timeless_inode(void) _malloc_attribute;
308 put_inode(struct wim_inode *inode);
311 free_inode(struct wim_inode *inode);
313 /* Iterate through each alias of an inode. */
314 #define inode_for_each_dentry(dentry, inode) \
315 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
317 /* Add a new alias for an inode. Does not increment i_nlink; that must be done
319 #define inode_add_dentry(dentry, inode) \
320 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
322 /* Return an alias of an inode. */
323 #define inode_first_dentry(inode) \
324 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
326 /* Return the full path of an alias of an inode, or NULL if it could not be
328 #define inode_first_full_path(inode) \
329 dentry_full_path(inode_first_dentry(inode))
331 extern struct wim_ads_entry *
332 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name);
334 extern struct wim_ads_entry *
335 inode_add_ads_utf16le(struct wim_inode *inode,
336 const utf16lechar *stream_name,
337 size_t stream_name_nbytes);
339 extern struct wim_ads_entry *
340 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
342 extern struct wim_ads_entry *
343 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
344 const void *value, size_t size,
345 struct wim_lookup_table *lookup_table);
348 inode_has_named_stream(const struct wim_inode *inode);
351 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
352 struct wim_lookup_table *lookup_table);
355 inode_remove_ads(struct wim_inode *inode, struct wim_ads_entry *entry,
356 struct wim_lookup_table *lookup_table);
359 ads_entry_is_named_stream(const struct wim_ads_entry *entry)
361 return entry->stream_name_nbytes != 0;
364 /* Is the inode a directory?
365 * This doesn't count directories with reparse data.
366 * wimlib only allows inodes of this type to have children.
369 inode_is_directory(const struct wim_inode *inode)
371 return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
372 FILE_ATTRIBUTE_REPARSE_POINT))
373 == FILE_ATTRIBUTE_DIRECTORY;
376 /* Is the inode a directory with the encrypted attribute set?
377 * This currently returns true for encrypted directories even if they have
378 * reparse data (not sure if such files can even exist). */
380 inode_is_encrypted_directory(const struct wim_inode *inode)
382 return ((inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
383 FILE_ATTRIBUTE_ENCRYPTED))
384 == (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_ENCRYPTED));
387 /* Is the inode a symbolic link?
388 * This returns true iff the inode is a reparse point that is either a "real"
389 * symbolic link or a junction point. */
391 inode_is_symlink(const struct wim_inode *inode)
393 return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
394 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
395 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
398 /* Does the inode have children?
399 * Currently (based on read_dentry_tree()), this can only return true for inodes
400 * for which inode_is_directory() returns true. (This also returns false on
401 * empty directories.) */
403 inode_has_children(const struct wim_inode *inode)
405 return inode->i_children != NULL;
409 inode_resolve_streams(struct wim_inode *inode, struct wim_lookup_table *table,
413 stream_not_found_error(const struct wim_inode *inode, const u8 *hash);
416 inode_unresolve_streams(struct wim_inode *inode);
418 static inline struct wim_lookup_table_entry *
419 inode_stream_lte_resolved(const struct wim_inode *inode, unsigned stream_idx)
421 wimlib_assert(inode->i_resolved);
422 wimlib_assert(stream_idx <= inode->i_num_ads);
426 return inode->i_ads_entries[stream_idx - 1].lte;
429 static inline struct wim_lookup_table_entry *
430 inode_stream_lte_unresolved(const struct wim_inode *inode, unsigned stream_idx,
431 const struct wim_lookup_table *table)
433 wimlib_assert(!inode->i_resolved);
434 wimlib_assert(stream_idx <= inode->i_num_ads);
438 return lookup_stream(table, inode->i_hash);
440 return lookup_stream(table, inode->i_ads_entries[ stream_idx - 1].hash);
443 extern struct wim_lookup_table_entry *
444 inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx,
445 const struct wim_lookup_table *table);
447 static inline const u8 *
448 inode_stream_hash_unresolved(const struct wim_inode *inode, unsigned stream_idx)
450 wimlib_assert(!inode->i_resolved);
451 wimlib_assert(stream_idx <= inode->i_num_ads);
453 return inode->i_hash;
455 return inode->i_ads_entries[stream_idx - 1].hash;
459 static inline const u8 *
460 inode_stream_hash_resolved(const struct wim_inode *inode, unsigned stream_idx)
462 struct wim_lookup_table_entry *lte;
463 lte = inode_stream_lte_resolved(inode, stream_idx);
471 * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
472 * means the default un-named file stream, and stream_idx >= 1 corresponds to an
473 * alternate data stream.
475 * This works for both resolved and un-resolved dentries.
477 static inline const u8 *
478 inode_stream_hash(const struct wim_inode *inode, unsigned stream_idx)
480 if (inode->i_resolved)
481 return inode_stream_hash_resolved(inode, stream_idx);
483 return inode_stream_hash_unresolved(inode, stream_idx);
487 inode_stream_name_nbytes(const struct wim_inode *inode, unsigned stream_idx)
489 wimlib_assert(stream_idx <= inode->i_num_ads);
493 return inode->i_ads_entries[stream_idx - 1].stream_name_nbytes;
497 inode_stream_idx_to_id(const struct wim_inode *inode, unsigned stream_idx)
502 return inode->i_ads_entries[stream_idx - 1].stream_id;
505 extern struct wim_lookup_table_entry *
506 inode_unnamed_stream_resolved(const struct wim_inode *inode, u16 *stream_idx_ret);
508 extern struct wim_lookup_table_entry *
509 inode_unnamed_lte_resolved(const struct wim_inode *inode);
511 extern struct wim_lookup_table_entry *
512 inode_unnamed_lte_unresolved(const struct wim_inode *inode,
513 const struct wim_lookup_table *table);
515 extern struct wim_lookup_table_entry *
516 inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
519 inode_unnamed_stream_hash(const struct wim_inode *inode);
522 read_ads_entries(const u8 * restrict p, struct wim_inode * restrict inode,
523 size_t *nbytes_remaining_p);
526 verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
529 inode_ref_streams(struct wim_inode *inode);
532 inode_unref_streams(struct wim_inode *inode,
533 struct wim_lookup_table *lookup_table);
537 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
539 #endif /* _WIMLIB_INODE_H */