1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
16 struct wim_lookup_table;
18 struct wim_lookup_table_entry;
23 /* Size of the struct wim_dentry up to and including the file_name_len. */
24 #define WIM_DENTRY_DISK_SIZE 102
26 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
27 * including the stream length field (see below). */
28 #define WIM_ADS_ENTRY_DISK_SIZE 38
31 * Reparse tags documented at
32 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
34 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000
35 #define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001
36 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
37 #define WIM_IO_REPARSE_TAG_HSM 0xC0000004
38 #define WIM_IO_REPARSE_TAG_HSM2 0x80000006
39 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
40 #define WIM_IO_REPARSE_TAG_SIS 0x80000007
41 #define WIM_IO_REPARSE_TAG_DFS 0x8000000A
42 #define WIM_IO_REPARSE_TAG_DFSR 0x80000012
43 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
44 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
46 #define FILE_ATTRIBUTE_READONLY 0x00000001
47 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
48 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
49 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
50 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
51 #define FILE_ATTRIBUTE_DEVICE 0x00000040
52 #define FILE_ATTRIBUTE_NORMAL 0x00000080
53 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
54 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
55 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
56 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
57 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
58 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
59 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
60 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
63 /* Alternate data stream entry.
65 * We read this from disk in the read_ads_entries() function; see that function
66 * for more explanation. */
69 /* SHA-1 message digest of stream contents */
70 u8 hash[SHA1_HASH_SIZE];
72 /* The corresponding lookup table entry (only for resolved
74 struct wim_lookup_table_entry *lte;
77 /* Length of stream name (UTF-16). This is in bytes, not characters,
78 * and does not include the terminating null character */
81 /* Length of stream name (UTF-8) */
82 u16 stream_name_utf8_len;
84 /* Stream name (UTF-16) */
87 /* Stream name (UTF-8) */
88 char *stream_name_utf8;
91 /* Number to identify an alternate data stream even after it's possibly
92 * been moved or renamed. */
98 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
99 const struct ads_entry *entry_2)
101 if (entry_1->stream_name_len != entry_2->stream_name_len)
103 return memcmp(entry_1->stream_name, entry_2->stream_name,
104 entry_1->stream_name_len) == 0;
108 * In-memory structure for a WIM directory entry (dentry). There is a directory
109 * tree for each image in the WIM.
111 * Note that this is a directory entry and not an inode. Since NTFS allows hard
112 * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
113 * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
114 * inode that the dentry corresponds to.
116 * Unfortunately, WIM files do not have an analogue to an inode; instead certain
117 * information, such as file attributes, the security descriptor, and file
118 * streams is replicated in each hard-linked dentry, even though this
119 * information really is associated with an inode. In-memory, we fix up this
120 * flaw by allocating a `struct wim_inode' for each dentry that contains some of
121 * this duplicated information, then combining the inodes for each hard link
124 * Confusingly, it's possible for stream information to be missing from a dentry
125 * in a hard link set, in which case the stream information needs to be gotten
126 * from one of the other dentries in the hard link set. In addition, it is
127 * possible for dentries to have inconsistent security IDs, file attributes, or
128 * file streams when they share the same hard link ID (don't even ask. I hope
129 * that Microsoft may have fixed this problem, since I've only noticed it in the
130 * 'install.wim' for Windows 7). For those dentries, we have to use the
131 * conflicting fields to split up the hard link groups. (See fix_inodes() in
137 /* The inode for this dentry */
138 struct wim_inode *d_inode;
142 /* Red-black tree of sibling dentries */
143 struct rb_node rb_node;
147 /* Length of short filename, in bytes, not including the terminating
148 * zero wide-character. */
151 /* Length of file name, in bytes, not including the terminating zero
155 /* Length of the filename converted into UTF-8, in bytes, not including
156 * the terminating zero byte. */
157 u16 file_name_utf8_len;
163 /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
164 char *file_name_utf8;
168 struct list_head tmp_list;
172 /* List of dentries in the inode (hard link set) */
173 struct list_head d_alias;
175 /* The parent of this directory entry. */
176 struct wim_dentry *parent;
179 * Size of directory entry on disk, in bytes. Typical size is around
182 * It is possible for the length field to be 0. This situation, which
183 * is undocumented, indicates the end of a list of sibling nodes in a
184 * directory. It also means the real length is 8, because the dentry
185 * included only the length field, but that takes up 8 bytes.
187 * The length here includes the base directory entry on disk as well as
188 * the long and short filenames. It does NOT include any alternate
189 * stream entries that may follow the directory entry, even though the
190 * size of those needs to be considered. The length SHOULD be 8-byte
191 * aligned, although we don't require it to be. We do require the
192 * length to be large enough to hold the file name(s) of the dentry;
193 * additionally, a warning is issued if this field is larger than the
198 /* The offset, from the start of the uncompressed WIM metadata resource
199 * for this image, of this dentry's child dentries. 0 if the directory
200 * entry has no children, which is the case for regular files or reparse
204 /* Number of references to the dentry tree itself, as in multiple
208 u32 full_path_utf8_len;
210 /* Pointer to the UTF-16 short filename (malloc()ed buffer) */
213 /* Pointer to the UTF-16 filename (malloc()ed buffer). */
216 /* Full path (UTF-8) to this dentry (malloc()ed buffer). */
217 char *full_path_utf8;
220 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
225 * As mentioned above, in the WIM file that is no on-disk analogue of a real
226 * inode, as most of these fields are duplicated in the dentries.
229 /* Timestamps for the inode. The timestamps are the number of
230 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
231 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
233 u64 i_last_access_time;
234 u64 i_last_write_time;
236 /* The file attributes associated with this inode. This is a bitwise OR
237 * of the FILE_ATTRIBUTE_* flags. */
240 /* The index of the security descriptor in the WIM image's table of
241 * security descriptors that contains this file's security information.
242 * If -1, no security information exists for this file. */
243 int32_t i_security_id;
245 /* %true iff the inode's lookup table entries has been resolved (i.e.
246 * the @lte field is valid, but the @hash field is not valid)
248 * (This is not an on-disk field.) */
251 /* %true iff verify_inode() has run on this inode. */
254 /* Number of alternate data streams associated with this inode */
257 /* A hash of the file's contents, or a pointer to the lookup table entry
258 * for this dentry if the lookup table entries have been resolved.
260 * More specifically, this is for the un-named default file stream, as
261 * opposed to the alternate (named) file streams, which may have their
262 * own lookup table entries. */
264 u8 i_hash[SHA1_HASH_SIZE];
265 struct wim_lookup_table_entry *i_lte;
268 /* Identity of a reparse point. See
269 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
270 * for what a reparse point is. */
273 /* Number of dentries that reference this inode */
276 /* Alternate data stream entries. */
277 struct ads_entry *i_ads_entries;
282 /* List of dentries that reference this inode (there should be
283 * link_count of them) */
284 struct list_head i_dentry;
286 struct hlist_node i_hlist;
288 struct list_head i_lte_inode_list;
290 char *i_extracted_file;
292 /* Root of a red-black tree storing the children of this inode (if
293 * non-empty, implies the inode is a directory, although that is also
294 * noted in the @attributes field.) */
295 struct rb_root i_children;
298 /* wimfs file descriptors table for the inode */
299 u16 i_num_opened_fds;
300 u16 i_num_allocated_fds;
301 struct wimfs_fd **i_fds;
303 /* Next alternate data stream ID to be assigned */
304 u32 i_next_stream_id;
306 /* This mutex protects the inode's file descriptors table during
307 * read-only mounts. Read-write mounts are still restricted to 1
309 pthread_mutex_t i_mutex;
313 #define inode_for_each_dentry(dentry, inode) \
314 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
316 #define inode_add_dentry(dentry, inode) \
317 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
319 static inline struct wim_dentry *inode_first_dentry(struct wim_inode *inode)
321 return container_of(inode->i_dentry.next, struct wim_dentry, d_alias);
324 static inline bool dentry_is_first_in_inode(const struct wim_dentry *dentry)
326 return inode_first_dentry(dentry->d_inode) == dentry;
329 extern u64 dentry_correct_total_length(const struct wim_dentry *dentry);
331 extern int for_dentry_in_tree(struct wim_dentry *root,
332 int (*visitor)(struct wim_dentry*, void*),
335 extern int for_dentry_in_rbtree(struct rb_node *node,
336 int (*visitor)(struct wim_dentry *, void *),
339 extern int for_dentry_in_tree_depth(struct wim_dentry *root,
340 int (*visitor)(struct wim_dentry*, void*),
343 extern int calculate_dentry_full_path(struct wim_dentry *dentry, void *ignore);
344 extern void calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
345 extern int set_dentry_name(struct wim_dentry *dentry, const char *new_name);
347 extern struct wim_dentry *get_dentry(struct WIMStruct *w, const char *path);
348 extern struct wim_inode *wim_pathname_to_inode(struct WIMStruct *w,
350 extern struct wim_dentry *get_dentry_child_with_name(const struct wim_dentry *dentry,
352 extern struct wim_dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
354 extern int print_dentry(struct wim_dentry *dentry, void *lookup_table);
355 extern int print_dentry_full_path(struct wim_dentry *entry, void *ignore);
357 extern struct wim_dentry *new_dentry(const char *name);
358 extern struct wim_dentry *new_dentry_with_inode(const char *name);
359 extern struct wim_dentry *new_dentry_with_timeless_inode(const char *name);
361 extern void free_inode(struct wim_inode *inode);
362 extern void free_dentry(struct wim_dentry *dentry);
363 extern void put_dentry(struct wim_dentry *dentry);
365 extern void free_dentry_tree(struct wim_dentry *root,
366 struct wim_lookup_table *lookup_table);
367 extern int increment_dentry_refcnt(struct wim_dentry *dentry, void *ignore);
369 extern void unlink_dentry(struct wim_dentry *dentry);
370 extern bool dentry_add_child(struct wim_dentry * restrict parent,
371 struct wim_dentry * restrict child);
373 extern struct ads_entry *inode_get_ads_entry(struct wim_inode *inode,
374 const char *stream_name,
376 extern struct ads_entry *inode_add_ads(struct wim_inode *dentry,
377 const char *stream_name);
379 extern void inode_remove_ads(struct wim_inode *inode, u16 idx,
380 struct wim_lookup_table *lookup_table);
382 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
383 u64 offset, struct wim_dentry *dentry);
386 extern int read_dentry_tree(const u8 metadata_resource[],
387 u64 metadata_resource_len, struct wim_dentry *dentry);
389 extern u8 *write_dentry_tree(const struct wim_dentry *tree, u8 *p);
391 static inline bool dentry_is_root(const struct wim_dentry *dentry)
393 return dentry->parent == dentry;
396 static inline bool inode_is_directory(const struct wim_inode *inode)
398 return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
399 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
402 static inline bool dentry_is_directory(const struct wim_dentry *dentry)
404 return inode_is_directory(dentry->d_inode);
407 /* For our purposes, we consider "real" symlinks and "junction points" to both
409 static inline bool inode_is_symlink(const struct wim_inode *inode)
411 return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
412 && ((inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
413 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
416 static inline bool inode_is_regular_file(const struct wim_inode *inode)
418 return !inode_is_directory(inode) && !inode_is_symlink(inode);
421 static inline bool dentry_is_regular_file(const struct wim_dentry *dentry)
423 return inode_is_regular_file(dentry->d_inode);
426 static inline bool inode_has_children(const struct wim_inode *inode)
428 return inode->i_children.rb_node != NULL;
431 static inline bool dentry_has_children(const struct wim_dentry *dentry)
433 return inode_has_children(dentry->d_inode);