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
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;
91 /* Returns the total length of a WIM alternate data stream entry on-disk,
92 * including the stream name, the null terminator, AND the padding after the
93 * entry to align the next one (or the next dentry) on an 8-byte boundary. */
94 static inline u64 ads_entry_total_length(const struct ads_entry *entry)
96 u64 len = WIM_ADS_ENTRY_DISK_SIZE;
97 if (entry->stream_name_len)
98 len += entry->stream_name_len + 2;
99 return (len + 7) & ~7;
102 static inline bool ads_entry_has_name(const struct ads_entry *entry,
103 const char *name, size_t name_len)
105 if (entry->stream_name_utf8_len != name_len)
107 return memcmp(entry->stream_name_utf8, name, name_len) == 0;
110 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
111 const struct ads_entry *entry_2)
113 if (entry_1->stream_name_len != entry_2->stream_name_len)
115 return memcmp(entry_1->stream_name, entry_2->stream_name,
116 entry_1->stream_name_len) == 0;
120 * In-memory structure for a WIM directory entry (dentry). There is a directory
121 * tree for each image in the WIM.
123 * Note that this is a directory entry and not an inode. Since NTFS allows hard
124 * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
125 * The hard_link field on the on-disk WIM dentry tells us the number of the NTFS
126 * inode that the dentry corresponds to.
128 * Unfortunately, WIM files do not have an analogue to an inode; instead certain
129 * information, such as file attributes, the security descriptor, and file
130 * streams is replicated in each hard-linked dentry, even though this
131 * information really is associated with an inode. In-memory, we fix up this
132 * flaw by allocating a `struct inode' for each dentry that contains some of
133 * this duplicated information, then combining the inodes for each hard link
136 * Confusingly, it's possible for stream information to be missing from a dentry
137 * in a hard link set, in which case the stream information needs to be gotten
138 * from one of the other dentries in the hard link set. In addition, it is
139 * possible for dentries to have inconsistent security IDs, file attributes, or
140 * file streams when they share the same hard link ID (don't even ask. I hope
141 * that Microsoft may have fixed this problem, since I've only noticed it in the
142 * 'install.wim' for Windows 7). For those dentries, we have to use the
143 * conflicting fields to split up the hard link groups. (See fix_inodes() in
147 /* The inode for this dentry */
150 /* The parent of this directory entry. */
151 struct dentry *parent;
153 /* Linked list of sibling directory entries. */
158 * Size of directory entry on disk, in bytes. Typical size is around
161 * It is possible for the length field to be 0. This situation, which
162 * is undocumented, indicates the end of a list of sibling nodes in a
163 * directory. It also means the real length is 8, because the dentry
164 * included only the length field, but that takes up 8 bytes.
166 * The length here includes the base directory entry on disk as well as
167 * the long and short filenames. It does NOT include any alternate
168 * stream entries that may follow the directory entry, even though the
169 * size of those needs to be considered. The length SHOULD be 8-byte
170 * aligned, although we don't require it to be. We do require the
171 * length to be large enough to hold the file name(s) of the dentry;
172 * additionally, a warning is issued if this field is larger than the
177 /* The offset, from the start of the uncompressed WIM metadata resource
178 * for this image, of this dentry's child dentries. 0 if the directory
179 * entry has no children, which is the case for regular files or reparse
183 /* Length of short filename, in bytes, not including the terminating
184 * zero wide-character. */
187 /* Length of file name, in bytes, not including the terminating zero
191 /* Length of the filename converted into UTF-8, in bytes, not including
192 * the terminating zero byte. */
193 u16 file_name_utf8_len;
195 /* Pointer to the short filename (malloc()ed buffer) */
198 /* Pointer to the filename (malloc()ed buffer). */
201 /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
202 char *file_name_utf8;
204 /* Full path to this dentry (malloc()ed buffer). */
205 char *full_path_utf8;
206 u32 full_path_utf8_len;
208 /* Number of references to the dentry tree itself, as in multiple
212 /* List of dentries in the inode (hard link set) */
213 struct list_head inode_dentry_list;
216 struct list_head tmp_list;
224 * As mentioned above, in the WIM file that is no on-disk analogue of a real
225 * inode, as most of these fields are duplicated in the dentries.
228 /* Timestamps for the inode. The timestamps are the number of
229 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
230 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
232 u64 last_access_time;
235 /* The file attributes associated with this inode. This is a bitwise OR
236 * of the FILE_ATTRIBUTE_* flags. */
239 /* The index of the security descriptor in the WIM image's table of
240 * security descriptors that contains this file's security information.
241 * If -1, no security information exists for this file. */
244 /* %true iff the inode's lookup table entries has been resolved (i.e.
245 * the @lte field is valid, but the @hash field is not valid)
247 * (This is not an on-disk field.) */
250 /* %true iff verify_inode() has run on this dentry. */
253 /* Number of alternate data streams associated with this inode */
256 /* A hash of the file's contents, or a pointer to the lookup table entry
257 * for this dentry if the lookup table entries have been resolved.
259 * More specifically, this is for the un-named default file stream, as
260 * opposed to the alternate (named) file streams, which may have their
261 * own lookup table entries. */
263 u8 hash[SHA1_HASH_SIZE];
264 struct lookup_table_entry *lte;
267 /* Identity of a reparse point. See
268 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
269 * for what a reparse point is. */
272 /* Number of dentries that reference this inode */
275 /* Alternate data stream entries. */
276 struct ads_entry *ads_entries;
281 /* List of dentries that reference this inode (there should be
282 * link_count of them) */
283 struct list_head dentry_list;
284 struct hlist_node hlist;
285 char *extracted_file;
287 /* If non-NULL, the children of this inode (implies the inode is a
289 struct dentry *children;
292 /* wimfs file descriptors table for the inode */
294 u16 num_allocated_fds;
295 struct wimlib_fd **fds;
297 /* Next alternate data stream ID to be assigned */
302 #define inode_for_each_dentry(dentry, inode) \
303 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
305 #define inode_add_dentry(dentry, inode) \
307 wimlib_assert((inode)->dentry_list.next != NULL); \
308 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list); \
311 static inline bool dentry_is_extracted(const struct dentry *dentry)
313 return dentry->is_extracted;
316 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
317 const char *stream_name,
320 extern struct ads_entry *inode_add_ads(struct inode *dentry,
321 const char *stream_name);
323 extern void inode_remove_ads(struct inode *inode, u16 idx,
324 struct lookup_table *lookup_table);
326 extern const char *path_stream_name(const char *path);
328 extern u64 dentry_total_length(const struct dentry *dentry);
329 extern u64 dentry_correct_total_length(const struct dentry *dentry);
331 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
332 extern int inode_to_stbuf(const struct inode *inode,
333 struct lookup_table_entry *lte, struct stat *stbuf);
335 extern int for_dentry_in_tree(struct dentry *root,
336 int (*visitor)(struct dentry*, void*),
339 extern int for_dentry_in_tree_depth(struct dentry *root,
340 int (*visitor)(struct dentry*, void*),
343 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
344 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
345 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
346 u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
348 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
349 extern int change_ads_name(struct ads_entry *entry, const char *new_name);
351 extern void unlink_dentry(struct dentry *dentry);
352 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
354 extern int print_dentry(struct dentry *dentry, void *lookup_table);
355 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
357 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
358 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
360 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
361 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
363 extern void dentry_update_all_timestamps(struct dentry *dentry);
364 extern void init_dentry(struct dentry *dentry, const char *name);
365 extern struct dentry *new_dentry(const char *name);
366 extern struct inode *new_inode();
367 extern struct inode *new_timeless_inode();
368 extern struct dentry *new_dentry_with_inode(const char *name);
369 extern struct dentry *new_dentry_with_timeless_inode(const char *name);
371 extern void inode_free_ads_entries(struct inode *inode);
372 extern struct inode *free_dentry(struct dentry *dentry);
373 extern void free_inode(struct inode *inode);
374 extern struct inode *put_inode(struct inode *inode);
375 extern struct dentry *clone_dentry(struct dentry *old);
376 extern void put_dentry(struct dentry *dentry);
377 extern void free_dentry_tree(struct dentry *root,
378 struct lookup_table *lookup_table);
379 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
380 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
382 extern void calculate_dir_tree_statistics(struct dentry *root,
383 struct lookup_table *table,
386 u64 *total_bytes_ret,
387 u64 *hard_link_bytes_ret);
389 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
390 u64 offset, struct dentry *dentry);
392 extern int verify_dentry(struct dentry *dentry, void *wim);
394 extern int read_dentry_tree(const u8 metadata_resource[],
395 u64 metadata_resource_len, struct dentry *dentry);
397 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
400 static inline struct dentry *inode_first_dentry(struct inode *inode)
402 wimlib_assert(inode->dentry_list.next != &inode->dentry_list);
403 return container_of(inode->dentry_list.next, struct dentry,
407 static inline bool dentry_is_root(const struct dentry *dentry)
409 return dentry->parent == dentry;
412 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
414 return dentry_is_root(dentry) || dentry->parent->inode->children == dentry;
417 static inline bool dentry_is_only_child(const struct dentry *dentry)
419 return dentry->next == dentry;
422 static inline bool inode_is_directory(const struct inode *inode)
424 return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
425 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
428 static inline bool dentry_is_directory(const struct dentry *dentry)
430 return inode_is_directory(dentry->inode);
433 /* For our purposes, we consider "real" symlinks and "junction points" to both
435 static inline bool inode_is_symlink(const struct inode *inode)
437 return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
438 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
439 inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
442 static inline bool dentry_is_symlink(const struct dentry *dentry)
444 return inode_is_symlink(dentry->inode);
447 static inline bool inode_is_regular_file(const struct inode *inode)
449 return !inode_is_directory(inode) && !inode_is_symlink(inode);
452 static inline bool dentry_is_regular_file(const struct dentry *dentry)
454 return inode_is_regular_file(dentry->inode);
457 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
459 return dentry_is_directory(dentry) && dentry->inode->children == NULL;