1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
14 struct lookup_table_entry;
19 /* Size of the struct dentry up to and including the file_name_len. */
20 #define WIM_DENTRY_DISK_SIZE 102
22 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
23 * including the stream length field (see below). */
24 #define WIM_ADS_ENTRY_DISK_SIZE 38
27 * Reparse tags documented at
28 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
30 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000
31 #define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001
32 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
33 #define WIM_IO_REPARSE_TAG_HSM 0xC0000004
34 #define WIM_IO_REPARSE_TAG_HSM2 0x80000006
35 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
36 #define WIM_IO_REPARSE_TAG_SIS 0x80000007
37 #define WIM_IO_REPARSE_TAG_DFS 0x8000000A
38 #define WIM_IO_REPARSE_TAG_DFSR 0x80000012
39 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
40 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
42 #define FILE_ATTRIBUTE_READONLY 0x00000001
43 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
44 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
45 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
46 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
47 #define FILE_ATTRIBUTE_DEVICE 0x00000040
48 #define FILE_ATTRIBUTE_NORMAL 0x00000080
49 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
50 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
51 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
52 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
53 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
54 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
55 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
56 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
59 /* Alternate data stream entry.
61 * We read this from disk in the read_ads_entries() function; see that function
62 * for more explanation. */
65 /* SHA-1 message digest of stream contents */
66 u8 hash[SHA1_HASH_SIZE];
68 /* The corresponding lookup table entry (only for resolved
70 struct lookup_table_entry *lte;
73 /* Length of stream name (UTF-16). This is in bytes, not characters,
74 * and does not include the terminating null character */
77 /* Length of stream name (UTF-8) */
78 u16 stream_name_utf8_len;
80 /* Stream name (UTF-16) */
83 /* Stream name (UTF-8) */
84 char *stream_name_utf8;
87 /* Number to identify an alternate data stream even after it's possibly
88 * been moved or renamed. */
94 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
95 const struct ads_entry *entry_2)
97 if (entry_1->stream_name_len != entry_2->stream_name_len)
99 return memcmp(entry_1->stream_name, entry_2->stream_name,
100 entry_1->stream_name_len) == 0;
104 * In-memory structure for a WIM directory entry (dentry). There is a directory
105 * tree for each image in the WIM.
107 * Note that this is a directory entry and not an inode. Since NTFS allows hard
108 * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
109 * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
110 * inode that the dentry corresponds to.
112 * Unfortunately, WIM files do not have an analogue to an inode; instead certain
113 * information, such as file attributes, the security descriptor, and file
114 * streams is replicated in each hard-linked dentry, even though this
115 * information really is associated with an inode. In-memory, we fix up this
116 * flaw by allocating a `struct inode' for each dentry that contains some of
117 * this duplicated information, then combining the inodes for each hard link
120 * Confusingly, it's possible for stream information to be missing from a dentry
121 * in a hard link set, in which case the stream information needs to be gotten
122 * from one of the other dentries in the hard link set. In addition, it is
123 * possible for dentries to have inconsistent security IDs, file attributes, or
124 * file streams when they share the same hard link ID (don't even ask. I hope
125 * that Microsoft may have fixed this problem, since I've only noticed it in the
126 * 'install.wim' for Windows 7). For those dentries, we have to use the
127 * conflicting fields to split up the hard link groups. (See fix_inodes() in
133 /* The inode for this dentry */
134 struct inode *d_inode;
138 /* Red-black tree of sibling dentries */
139 struct rb_node rb_node;
143 /* Length of short filename, in bytes, not including the terminating
144 * zero wide-character. */
147 /* Length of file name, in bytes, not including the terminating zero
151 /* Length of the filename converted into UTF-8, in bytes, not including
152 * the terminating zero byte. */
153 u16 file_name_utf8_len;
159 /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
160 char *file_name_utf8;
165 struct list_head tmp_list;
174 /* List of dentries in the inode (hard link set) */
175 struct list_head inode_dentry_list;
177 /* The parent of this directory entry. */
178 struct dentry *parent;
181 * Size of directory entry on disk, in bytes. Typical size is around
184 * It is possible for the length field to be 0. This situation, which
185 * is undocumented, indicates the end of a list of sibling nodes in a
186 * directory. It also means the real length is 8, because the dentry
187 * included only the length field, but that takes up 8 bytes.
189 * The length here includes the base directory entry on disk as well as
190 * the long and short filenames. It does NOT include any alternate
191 * stream entries that may follow the directory entry, even though the
192 * size of those needs to be considered. The length SHOULD be 8-byte
193 * aligned, although we don't require it to be. We do require the
194 * length to be large enough to hold the file name(s) of the dentry;
195 * additionally, a warning is issued if this field is larger than the
201 /* The offset, from the start of the uncompressed WIM metadata resource
202 * for this image, of this dentry's child dentries. 0 if the directory
203 * entry has no children, which is the case for regular files or reparse
207 /* Number of references to the dentry tree itself, as in multiple
211 /* Pointer to the UTF-16 short filename (malloc()ed buffer) */
214 /* Pointer to the UTF-16 filename (malloc()ed buffer). */
217 /* Full path (UTF-8) to this dentry (malloc()ed buffer). */
218 char *full_path_utf8;
219 u32 full_path_utf8_len;
222 #define rbnode_dentry(node) container_of(node, struct dentry, rb_node)
227 * As mentioned above, in the WIM file that is no on-disk analogue of a real
228 * inode, as most of these fields are duplicated in the dentries.
231 /* Timestamps for the inode. The timestamps are the number of
232 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
233 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
235 u64 last_access_time;
238 /* The file attributes associated with this inode. This is a bitwise OR
239 * of the FILE_ATTRIBUTE_* flags. */
242 /* The index of the security descriptor in the WIM image's table of
243 * security descriptors that contains this file's security information.
244 * If -1, no security information exists for this file. */
247 /* %true iff the inode's lookup table entries has been resolved (i.e.
248 * the @lte field is valid, but the @hash field is not valid)
250 * (This is not an on-disk field.) */
253 /* %true iff verify_inode() has run on this dentry. */
256 /* Number of alternate data streams associated with this inode */
259 /* A hash of the file's contents, or a pointer to the lookup table entry
260 * for this dentry if the lookup table entries have been resolved.
262 * More specifically, this is for the un-named default file stream, as
263 * opposed to the alternate (named) file streams, which may have their
264 * own lookup table entries. */
266 u8 hash[SHA1_HASH_SIZE];
267 struct lookup_table_entry *lte;
270 /* Identity of a reparse point. See
271 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
272 * for what a reparse point is. */
275 /* Number of dentries that reference this inode */
278 /* Alternate data stream entries. */
279 struct ads_entry *ads_entries;
284 /* List of dentries that reference this inode (there should be
285 * link_count of them) */
286 struct list_head dentry_list;
287 struct hlist_node hlist;
288 char *extracted_file;
290 /* Root of a red-black tree storing the children of this inode (if
291 * non-empty, implies the inode is a directory, although that is also
292 * noted in the @attributes field.) */
293 struct rb_root children;
296 /* wimfs file descriptors table for the inode */
298 u16 num_allocated_fds;
299 struct wimlib_fd **fds;
301 /* Next alternate data stream ID to be assigned */
306 #define inode_for_each_dentry(dentry, inode) \
307 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
309 #define inode_add_dentry(dentry, inode) \
311 wimlib_assert((inode)->dentry_list.next != NULL); \
312 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list); \
315 static inline bool dentry_is_extracted(const struct dentry *dentry)
317 return dentry->is_extracted;
320 static inline bool dentry_is_first_in_inode(const struct dentry *dentry)
322 return container_of(dentry->d_inode->dentry_list.next,
324 inode_dentry_list) == dentry;
327 extern u64 dentry_correct_total_length(const struct dentry *dentry);
329 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
330 extern int inode_to_stbuf(const struct inode *inode,
331 struct lookup_table_entry *lte, struct stat *stbuf);
333 extern int for_dentry_in_tree(struct dentry *root,
334 int (*visitor)(struct dentry*, void*),
337 extern int for_dentry_in_rbtree(struct rb_node *node,
338 int (*visitor)(struct dentry *, void *),
341 extern int for_dentry_in_tree_depth(struct dentry *root,
342 int (*visitor)(struct dentry*, void*),
345 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
346 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
347 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
348 u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
351 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
352 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
354 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
356 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
358 extern int print_dentry(struct dentry *dentry, void *lookup_table);
359 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
361 extern struct dentry *new_dentry(const char *name);
362 extern struct dentry *new_dentry_with_inode(const char *name);
363 extern struct dentry *new_dentry_with_timeless_inode(const char *name);
365 extern void free_inode(struct inode *inode);
366 extern void free_dentry(struct dentry *dentry);
367 extern void put_dentry(struct dentry *dentry);
369 extern void free_dentry_tree(struct dentry *root,
370 struct lookup_table *lookup_table);
371 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
373 extern void unlink_dentry(struct dentry *dentry);
374 extern bool dentry_add_child(struct dentry * restrict parent,
375 struct dentry * restrict child);
378 #define link_dentry(child, parent) dentry_add_child(parent, child)
380 extern int verify_dentry(struct dentry *dentry, void *wim);
383 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
384 const char *stream_name,
386 extern struct ads_entry *inode_add_ads(struct inode *dentry,
387 const char *stream_name);
389 extern void inode_remove_ads(struct inode *inode, u16 idx,
390 struct lookup_table *lookup_table);
392 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
393 u64 offset, struct dentry *dentry);
396 extern int read_dentry_tree(const u8 metadata_resource[],
397 u64 metadata_resource_len, struct dentry *dentry);
399 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
401 static inline bool dentry_is_root(const struct dentry *dentry)
403 return dentry->parent == dentry;
406 static inline bool inode_is_directory(const struct inode *inode)
408 return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
409 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
412 static inline bool dentry_is_directory(const struct dentry *dentry)
414 return inode_is_directory(dentry->d_inode);
417 /* For our purposes, we consider "real" symlinks and "junction points" to both
419 static inline bool inode_is_symlink(const struct inode *inode)
421 return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
422 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
423 inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
426 static inline bool dentry_is_symlink(const struct dentry *dentry)
428 return inode_is_symlink(dentry->d_inode);
431 static inline bool inode_is_regular_file(const struct inode *inode)
433 return !inode_is_directory(inode) && !inode_is_symlink(inode);
436 static inline bool dentry_is_regular_file(const struct dentry *dentry)
438 return inode_is_regular_file(dentry->d_inode);
441 static inline bool inode_has_children(const struct inode *inode)
443 return inode->children.rb_node != NULL;
446 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
448 const struct inode *inode = dentry->d_inode;
449 return inode_is_directory(inode) && !inode_has_children(inode);