1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
15 /* Size of the struct dentry up to and including the file_name_len. */
16 #define WIM_DENTRY_DISK_SIZE 102
18 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
19 * including the stream length field (see below). */
20 #define WIM_ADS_ENTRY_DISK_SIZE 38
24 * Reparse tags documented at
25 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
27 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000
28 #define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001
29 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
30 #define WIM_IO_REPARSE_TAG_HSM 0xC0000004
31 #define WIM_IO_REPARSE_TAG_HSM2 0x80000006
32 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
33 #define WIM_IO_REPARSE_TAG_SIS 0x80000007
34 #define WIM_IO_REPARSE_TAG_DFS 0x8000000A
35 #define WIM_IO_REPARSE_TAG_DFSR 0x80000012
36 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
37 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
39 #define FILE_ATTRIBUTE_READONLY 0x00000001
40 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
41 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
42 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
43 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
44 #define FILE_ATTRIBUTE_DEVICE 0x00000040
45 #define FILE_ATTRIBUTE_NORMAL 0x00000080
46 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
47 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
48 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
49 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
50 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
51 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
52 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
53 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
55 struct lookup_table_entry;
57 /* Alternate data stream entry.
59 * We read this from disk in the read_ads_entries() function; see that function
60 * for more explanation. */
63 /* SHA-1 message digest of stream contents */
64 u8 hash[SHA1_HASH_SIZE];
66 /* The corresponding lookup table entry (only for resolved
68 struct lookup_table_entry *lte;
71 /* Length of stream name (UTF-16) */
74 /* Length of stream name (UTF-8) */
75 u16 stream_name_utf8_len;
77 /* Stream name (UTF-16) */
80 /* Stream name (UTF-8) */
81 char *stream_name_utf8;
88 /* Returns the total length of a WIM alternate data stream entry on-disk,
89 * including the stream name, the null terminator, AND the padding after the
90 * entry to align the next one (or the next dentry) on an 8-byte boundary. */
91 static inline u64 ads_entry_total_length(const struct ads_entry *entry)
93 u64 len = WIM_ADS_ENTRY_DISK_SIZE;
94 if (entry->stream_name_len)
95 len += entry->stream_name_len + 2;
96 return (len + 7) & ~7;
99 static inline bool ads_entry_has_name(const struct ads_entry *entry,
100 const char *name, size_t name_len)
102 if (entry->stream_name_utf8_len != name_len)
104 return memcmp(entry->stream_name_utf8, name, name_len) == 0;
107 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
108 const struct ads_entry *entry_2)
110 if (entry_1->stream_name_len != entry_2->stream_name_len)
112 return memcmp(entry_1->stream_name, entry_2->stream_name,
113 entry_1->stream_name_len) == 0;
119 /* Timestamps for the inode. The timestamps are the number of
120 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
121 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
123 u64 last_access_time;
126 /* The file attributes associated with this inode. This is a bitwise OR
127 * of the FILE_ATTRIBUTE_* flags. */
130 /* The index of the security descriptor in the WIM image's table of
131 * security descriptors that contains this file's security information.
132 * If -1, no security information exists for this file. */
135 /* %true iff the inode's lookup table entries has been resolved (i.e.
136 * the @lte field is valid, but the @hash field is not valid)
138 * (This is not an on-disk field.) */
143 /* A hash of the file's contents, or a pointer to the lookup table entry
144 * for this dentry if the lookup table entries have been resolved.
146 * More specifically, this is for the un-named default file stream, as
147 * opposed to the alternate (named) file streams, which may have their
148 * own lookup table entries. */
150 u8 hash[SHA1_HASH_SIZE];
151 struct lookup_table_entry *lte;
154 /* Identity of a reparse point. See
155 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
156 * for what a reparse point is. */
161 struct ads_entry **ads_entries;
163 /* If the file is part of a hard link set, all the directory entries in
164 * the set will share the same value for this field.
166 * Unfortunately, in some WIMs it is NOT the case that all dentries that
167 * share this field are actually in the same hard link set, although the
168 * WIMs that wimlib writes maintain this restriction. */
171 struct list_head dentry_list;
172 struct hlist_node hlist;
173 char *extracted_file;
175 struct dentry *children;
179 u16 num_allocated_fds;
180 struct wimlib_fd **fds;
185 #define inode_for_each_dentry(dentry, inode) \
186 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
188 #define inode_add_dentry(dentry, inode) \
189 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list)
192 * In-memory structure for a WIM directory entry (dentry). There is a directory
193 * tree for each image in the WIM.
195 * Please note that this is a directory entry and not an inode. Since NTFS
196 * allows hard links, it's possible for a NTFS inode to correspond to multiple
197 * WIM dentries. The @hard_link field tells you the number of the NTFS inode
198 * that the dentry corresponds to.
200 * Unfortunately, WIM files do not have an analogue to an inode; instead certain
201 * information, such as file attributes, the security descriptor, and file
202 * streams is replicated in each hard-linked dentry, even though this
203 * information really is associated with an inode.
205 * Confusingly, it's also possible for stream information to be missing from a
206 * dentry in a hard link set, in which case the stream information needs to be
207 * gotten from one of the other dentries in the hard link set. In addition, it
208 * is possible for dentries to have inconsistent security IDs, file attributes,
209 * or file streams when they share the same hard link ID (don't even ask. I
210 * hope that Microsoft may have fixed this problem, since I've only noticed it
211 * in the 'install.wim' for Windows 7). For those dentries, we have to use the
212 * conflicting fields to split up the hard link groups.
215 /* The inode for this dentry */
218 /* The parent of this directory entry. */
219 struct dentry *parent;
221 /* Linked list of sibling directory entries. */
226 * Size of directory entry on disk, in bytes. Typical size is around
229 * It is possible for the length field to be 0. This situation, which
230 * is undocumented, indicates the end of a list of sibling nodes in a
231 * directory. It also means the real length is 8, because the dentry
232 * included only the length field, but that takes up 8 bytes.
234 * The length here includes the base directory entry on disk as well as
235 * the long and short filenames. It does NOT include any alternate
236 * stream entries that may follow the directory entry, even though the
237 * size of those needs to be considered. The length SHOULD be 8-byte
238 * aligned, although we don't require it to be. We do require the
239 * length to be large enough to hold the file name(s) of the dentry;
240 * additionally, a warning is issued if this field is larger than the
246 /* The offset, from the start of the uncompressed WIM metadata resource
247 * for this image, of this dentry's child dentries. 0 if the directory
248 * entry has no children, which is the case for regular files or reparse
253 /* Although M$'s documentation does not tell you this, it seems that the
254 * reparse_reserved field does not actually exist. So the hard_link
255 * field directly follows the reparse_tag on disk. EXCEPT when the
256 * dentry is actually a reparse point... well, just take a look at the
257 * read_dentry() function. */
258 //u32 reparse_reserved;
261 /* Length of short filename, in bytes, not including the terminating
262 * zero wide-character. */
265 /* Length of file name, in bytes, not including the terminating zero
269 /* Length of the filename converted into UTF-8, in bytes, not including
270 * the terminating zero byte. */
271 u16 file_name_utf8_len;
273 /* Pointer to the short filename (malloc()ed buffer) */
276 /* Pointer to the filename (malloc()ed buffer). */
279 /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
280 char *file_name_utf8;
282 /* Full path to this dentry (malloc()ed buffer). */
283 char *full_path_utf8;
284 u32 full_path_utf8_len;
286 /* Number of references to the dentry tree itself, as in multiple
290 /* List of dentries in the hard link set */
291 struct list_head inode_dentry_list;
292 struct list_head tmp_list;
296 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
297 const char *stream_name,
300 extern struct ads_entry *inode_add_ads(struct inode *dentry,
301 const char *stream_name);
303 extern const char *path_stream_name(const char *path);
305 extern u64 dentry_total_length(const struct dentry *dentry);
306 extern u64 dentry_correct_total_length(const struct dentry *dentry);
308 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
310 extern int for_dentry_in_tree(struct dentry *root,
311 int (*visitor)(struct dentry*, void*),
314 extern int for_dentry_in_tree_depth(struct dentry *root,
315 int (*visitor)(struct dentry*, void*),
318 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
319 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
320 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
321 u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
323 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
324 extern int change_ads_name(struct ads_entry *entry, const char *new_name);
326 extern void unlink_dentry(struct dentry *dentry);
327 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
329 extern int print_dentry(struct dentry *dentry, void *lookup_table);
330 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
332 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
333 extern struct inode *wim_pathname_to_inode(WIMStruct *w, const char *path);
334 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
335 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
337 extern void dentry_update_all_timestamps(struct dentry *dentry);
338 extern void init_dentry(struct dentry *dentry, const char *name);
339 extern struct dentry *new_dentry(const char *name);
340 extern struct inode *new_inode();
341 extern struct inode *new_timeless_inode();
342 extern struct dentry *new_dentry_with_inode(const char *name);
344 extern void free_ads_entry(struct ads_entry *entry);
345 extern void inode_free_ads_entries(struct inode *inode);
346 extern struct inode *free_dentry(struct dentry *dentry);
347 extern void free_inode(struct inode *inode);
348 extern struct inode *put_inode(struct inode *inode);
349 extern struct dentry *clone_dentry(struct dentry *old);
350 extern void put_dentry(struct dentry *dentry);
351 extern void free_dentry_tree(struct dentry *root,
352 struct lookup_table *lookup_table);
353 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
354 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
356 extern void calculate_dir_tree_statistics(struct dentry *root,
357 struct lookup_table *table,
360 u64 *total_bytes_ret,
361 u64 *hard_link_bytes_ret);
363 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
364 u64 offset, struct dentry *dentry);
366 extern int verify_dentry(struct dentry *dentry, void *wim);
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);
374 static inline struct dentry *inode_first_dentry(struct inode *inode)
376 return container_of(inode->dentry_list.next, struct dentry,
381 static inline bool dentry_is_root(const struct dentry *dentry)
383 return dentry->parent == dentry;
386 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
388 return dentry_is_root(dentry) || dentry->parent->inode->children == dentry;
391 static inline bool dentry_is_only_child(const struct dentry *dentry)
393 return dentry->next == dentry;
396 static inline bool inode_is_directory(const struct inode *inode)
398 return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
399 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
402 static inline bool dentry_is_directory(const struct dentry *dentry)
404 return inode_is_directory(dentry->inode);
407 /* For our purposes, we consider "real" symlinks and "junction points" to both
409 static inline bool inode_is_symlink(const struct inode *inode)
411 return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
412 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
413 inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
416 static inline bool dentry_is_symlink(const struct dentry *dentry)
418 return inode_is_symlink(dentry->inode);
421 static inline bool inode_is_regular_file(const struct inode *inode)
423 return !inode_is_directory(inode) && !inode_is_symlink(inode);
426 static inline bool dentry_is_regular_file(const struct dentry *dentry)
428 return inode_is_regular_file(dentry->inode);
431 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
433 return dentry_is_directory(dentry) && dentry->inode->children == NULL;