1 #ifndef _WIMLIB_INODE_H
2 #define _WIMLIB_INODE_H
4 #include "wimlib/assert.h"
5 #include "wimlib/list.h"
6 #include "wimlib/sha1.h"
7 #include "wimlib/types.h"
10 struct blob_descriptor;
13 struct wim_security_data;
16 /* Valid values for the 'stream_type' field of a 'struct wim_inode_stream' */
17 enum wim_inode_stream_type {
19 /* Data stream, may be unnamed (usual case) or named */
22 /* Reparse point stream. This is the same as the data of the on-disk
23 * reparse point attribute, except that the first 8 bytes of the on-disk
24 * attribute are omitted. The omitted bytes contain the reparse tag
25 * (which is instead stored in the on-disk WIM dentry), the reparse data
26 * size (which is redundant with the stream size), and a reserved field
27 * that is always zero. */
28 STREAM_TYPE_REPARSE_POINT,
30 /* Encrypted data in the "EFSRPC raw data format" specified by [MS-EFSR]
31 * section 2.2.3. This contains metadata for the Encrypting File System
32 * as well as the encrypted data of all the file's data streams. */
33 STREAM_TYPE_EFSRPC_RAW_DATA,
35 /* Stream type could not be determined */
39 extern const utf16lechar NO_STREAM_NAME[1];
42 * 'struct wim_inode_stream' describes a "stream", which associates a blob of
43 * data with an inode. Each stream has a type and optionally a name.
45 * The most frequently seen kind of stream is the "unnamed data stream"
46 * (stream_type == STREAM_TYPE_DATA && stream_name == NO_STREAM_NAME), which is
47 * the "default file contents". Many inodes just have an unnamed data stream
48 * and no other streams. However, files on NTFS filesystems may have
49 * additional, "named" data streams, and this is supported by the WIM format.
51 * A "reparse point" is an inode with reparse data set. The reparse data is
52 * stored in a stream of type STREAM_TYPE_REPARSE_POINT. There should be only
53 * one such stream, and it should be unnamed. However, it is possible for an
54 * inode to have both a reparse point stream and an unnamed data stream, and
55 * even named data streams as well.
57 struct wim_inode_stream {
59 /* The name of the stream or NO_STREAM_NAME. */
60 utf16lechar *stream_name;
63 * If 'stream_resolved' = 0, then 'stream_hash' is the SHA-1 message
64 * digest of the uncompressed data of this stream, or all zeroes if this
67 * If 'stream_resolved' = 1, then 'stream_blob' is a pointer directly to
68 * a descriptor for this stream's blob, or NULL if this stream is empty.
71 u8 _stream_hash[SHA1_HASH_SIZE];
72 struct blob_descriptor *_stream_blob;
75 /* 'stream_resolved' determines whether 'stream_hash' or 'stream_blob'
76 * is valid as described above. */
77 u32 stream_resolved : 1;
79 /* A unique identifier for this stream within the context of its inode.
80 * This stays constant even if the streams array is reallocated. */
83 /* The type of this stream as one of the STREAM_TYPE_* values */
88 * WIM inode - a "file" in an image which may be accessible via multiple paths
90 * Note: in WIM files there is no true on-disk analogue of an inode; there are
91 * only directory entries, and some fields are duplicated among all links to a
92 * file. However, wimlib uses inode structures internally to simplify handling
98 * The collection of streams for this inode. 'i_streams' points to
99 * either 'i_embedded_streams' or an allocated array.
101 struct wim_inode_stream *i_streams;
102 struct wim_inode_stream i_embedded_streams[1];
103 unsigned i_num_streams;
105 /* Windows file attribute flags (FILE_ATTRIBUTE_*). */
108 /* Root of a balanced binary search tree storing the child directory
109 * entries of this inode, if any. Keyed by wim_dentry->file_name, case
110 * sensitively. If this inode is not a directory or if it has no
111 * children then this will be an empty tree (NULL). */
112 struct avl_tree_node *i_children;
114 /* Root of a balanced binary search tree storing the child directory
115 * entries of this inode, if any. Keyed by wim_dentry->file_name, case
116 * insensitively. If this inode is not a directory or if it has no
117 * children then this will be an empty tree (NULL). */
118 struct avl_tree_node *i_children_ci;
120 /* List of dentries that are aliases for this inode. There will be
121 * i_nlink dentries in this list. */
122 struct list_head i_dentry;
124 /* Field to place this inode into a list. While reading a WIM image or
125 * adding files to a WIM image this is owned by the inode table;
126 * otherwise this links the inodes for the WIM image. */
127 struct hlist_node i_hlist;
129 /* Number of dentries that are aliases for this inode. */
132 /* Flag used to mark this inode as visited; this is used when visiting
133 * all the inodes in a dentry tree exactly once. It will be 0 by
134 * default and must be cleared following the tree traversal, even in
139 u8 i_can_externally_back : 1;
141 /* If not NULL, a pointer to the extra data that was read from the
142 * dentry. This should be a series of tagged items, each of which
143 * represents a bit of extra metadata, such as the file's object ID.
144 * See tagged_items.c for more information. */
147 /* Size of @i_extra buffer in bytes. If 0, there is no extra data. */
150 /* Creation time, last access time, and last write time for this inode,
151 * in 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601.
152 * They should correspond to the times gotten by calling GetFileTime()
155 u64 i_last_access_time;
156 u64 i_last_write_time;
158 /* Corresponds to 'security_id' in `struct wim_dentry_on_disk': The
159 * index of this inode's security descriptor in the WIM image's table of
160 * security descriptors, or -1. Note: when a WIM image is loaded,
161 * wimlib sets out-of-bounds indices and values less than -1 in this
162 * field to -1. So the extraction code need not do an upper bound check
163 * after checking for -1 (or equivalently < 0). */
166 /* Unknown field that we only read into memory so we can re-write it
167 * unchanged. Probably it's actually just padding... */
170 /* The following fields correspond to 'reparse_tag', 'rp_reserved', and
171 * 'rp_flags' in `struct wim_dentry_on_disk'. They are only meaningful
172 * for reparse point files. */
177 /* Inode number; corresponds to hard_link_group_id in the `struct
178 * wim_dentry_on_disk'. */
182 /* Device number, used only during image capture, so we can
183 * identify hard linked files by the combination of inode number
184 * and device number (rather than just inode number, which could
185 * be ambigious if the captured tree spans a mountpoint). Set
189 /* Fields used only during extraction */
191 /* List of aliases of this dentry that are being
192 * extracted in the current extraction operation. This
193 * will be a (possibly nonproper) subset of the dentries
194 * in the i_dentry list. This list will be constructed
195 * regardless of whether the extraction backend supports
196 * hard links or not. */
197 struct list_head i_extraction_aliases;
200 /* In NTFS-3g extraction mode, this is set to the Master
201 * File Table (MFT) number of the NTFS file that was
202 * created for this inode. */
207 /* Used during WIM writing with
208 * WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES: the number
209 * of streams this inode has that have not yet been fully read.
211 u32 num_remaining_streams;
215 /* Used only during image mount: Table of file
216 * descriptors that have been opened to this inode.
217 * This table is freed when the last file descriptor is
219 struct wimfs_fd **i_fds;
221 /* Lower bound on the index of the next available entry
229 u16 i_num_opened_fds;
230 u16 i_num_allocated_fds;
233 /* Next stream ID to be assigned */
234 u32 i_next_stream_id;
238 * The available reparse tags are documented at
239 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx.
240 * Here we only define the ones of interest to us.
242 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
243 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
244 #define WIM_IO_REPARSE_TAG_WOF 0x80000017
246 /* Flags for the rp_flags field. Currently the only known flag is NOT_FIXED,
247 * which indicates that the target of the absolute symbolic link or junction was
248 * not changed when it was stored. */
249 #define WIM_RP_FLAG_NOT_FIXED 0x0001
251 /* Windows file attribute flags */
252 #define FILE_ATTRIBUTE_READONLY 0x00000001
253 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
254 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
255 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
256 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
257 #define FILE_ATTRIBUTE_DEVICE 0x00000040
258 #define FILE_ATTRIBUTE_NORMAL 0x00000080
259 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
260 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
261 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
262 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
263 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
264 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
265 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
266 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
268 extern struct wim_inode *
269 new_inode(struct wim_dentry *dentry, bool set_timestamps);
271 /* Iterate through each alias of the specified inode. */
272 #define inode_for_each_dentry(dentry, inode) \
273 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
275 /* Return an alias of the specified inode. */
276 #define inode_first_dentry(inode) \
277 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
279 /* Return the full path of an alias of the specified inode, or NULL if a full
280 * path could not be determined. */
281 #define inode_first_full_path(inode) \
282 dentry_full_path(inode_first_dentry(inode))
285 d_associate(struct wim_dentry *dentry, struct wim_inode *inode);
288 d_disassociate(struct wim_dentry *dentry);
292 inode_dec_num_opened_fds(struct wim_inode *inode);
295 /* Is the inode a directory?
296 * This doesn't count directories with reparse data.
297 * wimlib only allows inodes of this type to have children.
300 inode_is_directory(const struct wim_inode *inode)
302 return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
303 FILE_ATTRIBUTE_REPARSE_POINT))
304 == FILE_ATTRIBUTE_DIRECTORY;
307 /* Is the inode a symbolic link?
308 * This returns true iff the inode is a reparse point that is either a "real"
309 * symbolic link or a junction point. */
311 inode_is_symlink(const struct wim_inode *inode)
313 return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
314 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
315 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
318 /* Does the inode have children? Currently (based on read_dentry_tree() as well
319 * as the various build-dentry-tree implementations), this can only return true
320 * for inodes for which inode_is_directory() returns true. */
322 inode_has_children(const struct wim_inode *inode)
324 return inode->i_children != NULL;
327 extern struct wim_inode_stream *
328 inode_get_stream(const struct wim_inode *inode, int stream_type,
329 const utf16lechar *stream_name);
331 extern struct wim_inode_stream *
332 inode_get_unnamed_stream(const struct wim_inode *inode, int stream_type);
334 static inline struct wim_inode_stream *
335 inode_get_unnamed_data_stream(const struct wim_inode *inode)
337 return inode_get_unnamed_stream(inode, STREAM_TYPE_DATA);
340 extern struct wim_inode_stream *
341 inode_add_stream(struct wim_inode *inode, int stream_type,
342 const utf16lechar *stream_name, struct blob_descriptor *blob);
345 inode_replace_stream_blob(struct wim_inode *inode,
346 struct wim_inode_stream *strm,
347 struct blob_descriptor *new_blob,
348 struct blob_table *blob_table);
351 inode_replace_stream_data(struct wim_inode *inode,
352 struct wim_inode_stream *strm,
353 const void *data, size_t size,
354 struct blob_table *blob_table);
357 inode_add_stream_with_data(struct wim_inode *inode, int stream_type,
358 const utf16lechar *stream_name,
359 const void *data, size_t size,
360 struct blob_table *blob_table);
363 inode_remove_stream(struct wim_inode *inode, struct wim_inode_stream *strm,
364 struct blob_table *blob_table);
366 static inline struct blob_descriptor *
367 stream_blob_resolved(const struct wim_inode_stream *strm)
369 wimlib_assert(strm->stream_resolved);
370 return strm->_stream_blob;
374 stream_is_named(const struct wim_inode_stream *strm)
376 return strm->stream_name != NO_STREAM_NAME;
380 stream_is_unnamed_data_stream(const struct wim_inode_stream *strm)
382 return strm->stream_type == STREAM_TYPE_DATA && !stream_is_named(strm);
386 stream_is_named_data_stream(const struct wim_inode_stream *strm)
388 return strm->stream_type == STREAM_TYPE_DATA && stream_is_named(strm);
392 inode_has_named_data_stream(const struct wim_inode *inode);
395 inode_resolve_streams(struct wim_inode *inode,
396 struct blob_table *table, bool force);
399 blob_not_found_error(const struct wim_inode *inode, const u8 *hash);
401 extern struct blob_descriptor *
402 stream_blob(const struct wim_inode_stream *strm, const struct blob_table *table);
404 extern struct blob_descriptor *
405 inode_get_blob_for_unnamed_data_stream(const struct wim_inode *inode,
406 const struct blob_table *blob_table);
408 extern struct blob_descriptor *
409 inode_get_blob_for_unnamed_data_stream_resolved(const struct wim_inode *inode);
412 stream_hash(const struct wim_inode_stream *strm);
415 inode_get_hash_of_unnamed_data_stream(const struct wim_inode *inode);
418 inode_ref_blobs(struct wim_inode *inode);
421 inode_unref_blobs(struct wim_inode *inode, struct blob_table *blob_table);
425 dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list);
427 #endif /* _WIMLIB_INODE_H */