1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
13 struct lookup_table_entry;
18 /* Size of the struct dentry up to and including the file_name_len. */
19 #define WIM_DENTRY_DISK_SIZE 102
21 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
22 * including the stream length field (see below). */
23 #define WIM_ADS_ENTRY_DISK_SIZE 38
26 * Reparse tags documented at
27 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
29 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000
30 #define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001
31 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
32 #define WIM_IO_REPARSE_TAG_HSM 0xC0000004
33 #define WIM_IO_REPARSE_TAG_HSM2 0x80000006
34 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
35 #define WIM_IO_REPARSE_TAG_SIS 0x80000007
36 #define WIM_IO_REPARSE_TAG_DFS 0x8000000A
37 #define WIM_IO_REPARSE_TAG_DFSR 0x80000012
38 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
39 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
41 #define FILE_ATTRIBUTE_READONLY 0x00000001
42 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
43 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
44 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
45 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
46 #define FILE_ATTRIBUTE_DEVICE 0x00000040
47 #define FILE_ATTRIBUTE_NORMAL 0x00000080
48 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
49 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
50 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
51 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
52 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
53 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
54 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
55 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
58 /* Alternate data stream entry.
60 * We read this from disk in the read_ads_entries() function; see that function
61 * for more explanation. */
64 /* SHA-1 message digest of stream contents */
65 u8 hash[SHA1_HASH_SIZE];
67 /* The corresponding lookup table entry (only for resolved
69 struct lookup_table_entry *lte;
72 /* Length of stream name (UTF-16). This is in bytes, not characters,
73 * and does not include the terminating null character */
76 /* Length of stream name (UTF-8) */
77 u16 stream_name_utf8_len;
79 /* Stream name (UTF-16) */
82 /* Stream name (UTF-8) */
83 char *stream_name_utf8;
86 /* Number to identify an alternate data stream even after it's possibly
87 * been moved or renamed. */
93 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
94 const struct ads_entry *entry_2)
96 if (entry_1->stream_name_len != entry_2->stream_name_len)
98 return memcmp(entry_1->stream_name, entry_2->stream_name,
99 entry_1->stream_name_len) == 0;
103 * In-memory structure for a WIM directory entry (dentry). There is a directory
104 * tree for each image in the WIM.
106 * Note that this is a directory entry and not an inode. Since NTFS allows hard
107 * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
108 * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
109 * inode that the dentry corresponds to.
111 * Unfortunately, WIM files do not have an analogue to an inode; instead certain
112 * information, such as file attributes, the security descriptor, and file
113 * streams is replicated in each hard-linked dentry, even though this
114 * information really is associated with an inode. In-memory, we fix up this
115 * flaw by allocating a `struct inode' for each dentry that contains some of
116 * this duplicated information, then combining the inodes for each hard link
119 * Confusingly, it's possible for stream information to be missing from a dentry
120 * in a hard link set, in which case the stream information needs to be gotten
121 * from one of the other dentries in the hard link set. In addition, it is
122 * possible for dentries to have inconsistent security IDs, file attributes, or
123 * file streams when they share the same hard link ID (don't even ask. I hope
124 * that Microsoft may have fixed this problem, since I've only noticed it in the
125 * 'install.wim' for Windows 7). For those dentries, we have to use the
126 * conflicting fields to split up the hard link groups. (See fix_inodes() in
130 /* The inode for this dentry */
131 struct inode *d_inode;
133 /* The parent of this directory entry. */
134 struct dentry *parent;
136 /* Linked list of sibling directory entries. */
141 * Size of directory entry on disk, in bytes. Typical size is around
144 * It is possible for the length field to be 0. This situation, which
145 * is undocumented, indicates the end of a list of sibling nodes in a
146 * directory. It also means the real length is 8, because the dentry
147 * included only the length field, but that takes up 8 bytes.
149 * The length here includes the base directory entry on disk as well as
150 * the long and short filenames. It does NOT include any alternate
151 * stream entries that may follow the directory entry, even though the
152 * size of those needs to be considered. The length SHOULD be 8-byte
153 * aligned, although we don't require it to be. We do require the
154 * length to be large enough to hold the file name(s) of the dentry;
155 * additionally, a warning is issued if this field is larger than the
160 /* The offset, from the start of the uncompressed WIM metadata resource
161 * for this image, of this dentry's child dentries. 0 if the directory
162 * entry has no children, which is the case for regular files or reparse
166 /* Length of short filename, in bytes, not including the terminating
167 * zero wide-character. */
170 /* Length of file name, in bytes, not including the terminating zero
174 /* Length of the filename converted into UTF-8, in bytes, not including
175 * the terminating zero byte. */
176 u16 file_name_utf8_len;
178 /* Pointer to the short filename (malloc()ed buffer) */
181 /* Pointer to the filename (malloc()ed buffer). */
184 /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
185 char *file_name_utf8;
187 /* Full path to this dentry (malloc()ed buffer). */
188 char *full_path_utf8;
189 u32 full_path_utf8_len;
191 /* Number of references to the dentry tree itself, as in multiple
195 /* List of dentries in the inode (hard link set) */
196 struct list_head inode_dentry_list;
199 struct list_head tmp_list;
207 * As mentioned above, in the WIM file that is no on-disk analogue of a real
208 * inode, as most of these fields are duplicated in the dentries.
211 /* Timestamps for the inode. The timestamps are the number of
212 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
213 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
215 u64 last_access_time;
218 /* The file attributes associated with this inode. This is a bitwise OR
219 * of the FILE_ATTRIBUTE_* flags. */
222 /* The index of the security descriptor in the WIM image's table of
223 * security descriptors that contains this file's security information.
224 * If -1, no security information exists for this file. */
227 /* %true iff the inode's lookup table entries has been resolved (i.e.
228 * the @lte field is valid, but the @hash field is not valid)
230 * (This is not an on-disk field.) */
233 /* %true iff verify_inode() has run on this dentry. */
236 /* Number of alternate data streams associated with this inode */
239 /* A hash of the file's contents, or a pointer to the lookup table entry
240 * for this dentry if the lookup table entries have been resolved.
242 * More specifically, this is for the un-named default file stream, as
243 * opposed to the alternate (named) file streams, which may have their
244 * own lookup table entries. */
246 u8 hash[SHA1_HASH_SIZE];
247 struct lookup_table_entry *lte;
250 /* Identity of a reparse point. See
251 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
252 * for what a reparse point is. */
255 /* Number of dentries that reference this inode */
258 /* Alternate data stream entries. */
259 struct ads_entry *ads_entries;
264 /* List of dentries that reference this inode (there should be
265 * link_count of them) */
266 struct list_head dentry_list;
267 struct hlist_node hlist;
268 char *extracted_file;
270 /* If non-NULL, the children of this inode (implies the inode is a
272 struct dentry *children;
275 /* wimfs file descriptors table for the inode */
277 u16 num_allocated_fds;
278 struct wimlib_fd **fds;
280 /* Next alternate data stream ID to be assigned */
285 #define inode_for_each_dentry(dentry, inode) \
286 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
288 #define inode_add_dentry(dentry, inode) \
290 wimlib_assert((inode)->dentry_list.next != NULL); \
291 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list); \
294 static inline bool dentry_is_extracted(const struct dentry *dentry)
296 return dentry->is_extracted;
300 extern u64 dentry_correct_total_length(const struct dentry *dentry);
302 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
303 extern int inode_to_stbuf(const struct inode *inode,
304 struct lookup_table_entry *lte, struct stat *stbuf);
306 extern int for_dentry_in_tree(struct dentry *root,
307 int (*visitor)(struct dentry*, void*),
310 extern int for_dentry_in_tree_depth(struct dentry *root,
311 int (*visitor)(struct dentry*, void*),
314 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
315 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
316 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
317 u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
320 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
321 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
323 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
325 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
327 extern int print_dentry(struct dentry *dentry, void *lookup_table);
328 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
330 extern struct dentry *new_dentry(const char *name);
331 extern struct dentry *new_dentry_with_inode(const char *name);
332 extern struct dentry *new_dentry_with_timeless_inode(const char *name);
334 extern void free_inode(struct inode *inode);
335 extern void free_dentry(struct dentry *dentry);
336 extern void put_dentry(struct dentry *dentry);
338 extern void free_dentry_tree(struct dentry *root,
339 struct lookup_table *lookup_table);
340 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
342 extern void unlink_dentry(struct dentry *dentry);
343 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
345 extern void calculate_dir_tree_statistics(struct dentry *root,
346 struct lookup_table *table,
349 u64 *total_bytes_ret,
350 u64 *hard_link_bytes_ret);
352 extern int verify_dentry(struct dentry *dentry, void *wim);
355 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
356 const char *stream_name,
358 extern struct ads_entry *inode_add_ads(struct inode *dentry,
359 const char *stream_name);
361 extern void inode_remove_ads(struct inode *inode, u16 idx,
362 struct lookup_table *lookup_table);
364 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
365 u64 offset, struct dentry *dentry);
368 extern int read_dentry_tree(const u8 metadata_resource[],
369 u64 metadata_resource_len, struct dentry *dentry);
371 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
373 static inline bool dentry_is_root(const struct dentry *dentry)
375 return dentry->parent == dentry;
378 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
380 return dentry_is_root(dentry) || dentry->parent->d_inode->children == dentry;
383 static inline bool dentry_is_only_child(const struct dentry *dentry)
385 return dentry->next == dentry;
388 static inline bool inode_is_directory(const struct inode *inode)
390 return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
391 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
394 static inline bool dentry_is_directory(const struct dentry *dentry)
396 return inode_is_directory(dentry->d_inode);
399 /* For our purposes, we consider "real" symlinks and "junction points" to both
401 static inline bool inode_is_symlink(const struct inode *inode)
403 return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
404 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
405 inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
408 static inline bool dentry_is_symlink(const struct dentry *dentry)
410 return inode_is_symlink(dentry->d_inode);
413 static inline bool inode_is_regular_file(const struct inode *inode)
415 return !inode_is_directory(inode) && !inode_is_symlink(inode);
418 static inline bool dentry_is_regular_file(const struct dentry *dentry)
420 return inode_is_regular_file(dentry->d_inode);
423 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
425 return dentry_is_directory(dentry) && dentry->d_inode->children == NULL;