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). This is in bytes, not characters,
72 * and does not include the terminating null character */
75 /* Length of stream name (UTF-8) */
76 u16 stream_name_utf8_len;
78 /* Stream name (UTF-16) */
81 /* Stream name (UTF-8) */
82 char *stream_name_utf8;
89 /* Returns the total length of a WIM alternate data stream entry on-disk,
90 * including the stream name, the null terminator, AND the padding after the
91 * entry to align the next one (or the next dentry) on an 8-byte boundary. */
92 static inline u64 ads_entry_total_length(const struct ads_entry *entry)
94 u64 len = WIM_ADS_ENTRY_DISK_SIZE;
95 if (entry->stream_name_len)
96 len += entry->stream_name_len + 2;
97 return (len + 7) & ~7;
100 static inline bool ads_entry_has_name(const struct ads_entry *entry,
101 const char *name, size_t name_len)
103 if (entry->stream_name_utf8_len != name_len)
105 return memcmp(entry->stream_name_utf8, name, name_len) == 0;
108 static inline bool ads_entries_have_same_name(const struct ads_entry *entry_1,
109 const struct ads_entry *entry_2)
111 if (entry_1->stream_name_len != entry_2->stream_name_len)
113 return memcmp(entry_1->stream_name, entry_2->stream_name,
114 entry_1->stream_name_len) == 0;
120 /* Timestamps for the inode. The timestamps are the number of
121 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
122 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
124 u64 last_access_time;
127 /* The file attributes associated with this inode. This is a bitwise OR
128 * of the FILE_ATTRIBUTE_* flags. */
131 /* The index of the security descriptor in the WIM image's table of
132 * security descriptors that contains this file's security information.
133 * If -1, no security information exists for this file. */
136 /* %true iff the inode's lookup table entries has been resolved (i.e.
137 * the @lte field is valid, but the @hash field is not valid)
139 * (This is not an on-disk field.) */
146 /* A hash of the file's contents, or a pointer to the lookup table entry
147 * for this dentry if the lookup table entries have been resolved.
149 * More specifically, this is for the un-named default file stream, as
150 * opposed to the alternate (named) file streams, which may have their
151 * own lookup table entries. */
153 u8 hash[SHA1_HASH_SIZE];
154 struct lookup_table_entry *lte;
157 /* Identity of a reparse point. See
158 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
159 * for what a reparse point is. */
164 struct ads_entry **ads_entries;
166 /* If the file is part of a hard link set, all the directory entries in
167 * the set will share the same value for this field.
169 * Unfortunately, in some WIMs it is NOT the case that all dentries that
170 * share this field are actually in the same hard link set, although the
171 * WIMs that wimlib writes maintain this restriction. */
174 struct list_head dentry_list;
175 struct hlist_node hlist;
176 char *extracted_file;
178 struct dentry *children;
182 u16 num_allocated_fds;
183 struct wimlib_fd **fds;
188 #define inode_for_each_dentry(dentry, inode) \
189 list_for_each_entry((dentry), &(inode)->dentry_list, inode_dentry_list)
191 #define inode_add_dentry(dentry, inode) \
192 list_add(&(dentry)->inode_dentry_list, &(inode)->dentry_list)
195 * In-memory structure for a WIM directory entry (dentry). There is a directory
196 * tree for each image in the WIM.
198 * Please note that this is a directory entry and not an inode. Since NTFS
199 * allows hard links, it's possible for a NTFS inode to correspond to multiple
200 * WIM dentries. The @hard_link field tells you the number of the NTFS inode
201 * that the dentry corresponds to.
203 * Unfortunately, WIM files do not have an analogue to an inode; instead certain
204 * information, such as file attributes, the security descriptor, and file
205 * streams is replicated in each hard-linked dentry, even though this
206 * information really is associated with an inode.
208 * Confusingly, it's also possible for stream information to be missing from a
209 * dentry in a hard link set, in which case the stream information needs to be
210 * gotten from one of the other dentries in the hard link set. In addition, it
211 * is possible for dentries to have inconsistent security IDs, file attributes,
212 * or file streams when they share the same hard link ID (don't even ask. I
213 * hope that Microsoft may have fixed this problem, since I've only noticed it
214 * in the 'install.wim' for Windows 7). For those dentries, we have to use the
215 * conflicting fields to split up the hard link groups.
218 /* The inode for this dentry */
221 /* The parent of this directory entry. */
222 struct dentry *parent;
224 /* Linked list of sibling directory entries. */
229 * Size of directory entry on disk, in bytes. Typical size is around
232 * It is possible for the length field to be 0. This situation, which
233 * is undocumented, indicates the end of a list of sibling nodes in a
234 * directory. It also means the real length is 8, because the dentry
235 * included only the length field, but that takes up 8 bytes.
237 * The length here includes the base directory entry on disk as well as
238 * the long and short filenames. It does NOT include any alternate
239 * stream entries that may follow the directory entry, even though the
240 * size of those needs to be considered. The length SHOULD be 8-byte
241 * aligned, although we don't require it to be. We do require the
242 * length to be large enough to hold the file name(s) of the dentry;
243 * additionally, a warning is issued if this field is larger than the
249 /* The offset, from the start of the uncompressed WIM metadata resource
250 * for this image, of this dentry's child dentries. 0 if the directory
251 * entry has no children, which is the case for regular files or reparse
256 /* Although M$'s documentation does not tell you this, it seems that the
257 * reparse_reserved field does not actually exist. So the hard_link
258 * field directly follows the reparse_tag on disk. EXCEPT when the
259 * dentry is actually a reparse point... well, just take a look at the
260 * read_dentry() function. */
261 //u32 reparse_reserved;
264 /* Length of short filename, in bytes, not including the terminating
265 * zero wide-character. */
268 /* Length of file name, in bytes, not including the terminating zero
272 /* Length of the filename converted into UTF-8, in bytes, not including
273 * the terminating zero byte. */
274 u16 file_name_utf8_len;
276 /* Pointer to the short filename (malloc()ed buffer) */
279 /* Pointer to the filename (malloc()ed buffer). */
282 /* Pointer to the filename converted to UTF-8 (malloc()ed buffer). */
283 char *file_name_utf8;
285 /* Full path to this dentry (malloc()ed buffer). */
286 char *full_path_utf8;
287 u32 full_path_utf8_len;
289 /* Number of references to the dentry tree itself, as in multiple
293 /* List of dentries in the hard link set */
294 struct list_head inode_dentry_list;
296 struct list_head tmp_list;
301 static inline bool dentry_is_extracted(const struct dentry *dentry)
303 return dentry->is_extracted;
307 extern struct ads_entry *inode_get_ads_entry(struct inode *inode,
308 const char *stream_name,
311 extern struct ads_entry *inode_add_ads(struct inode *dentry,
312 const char *stream_name);
314 extern const char *path_stream_name(const char *path);
316 extern u64 dentry_total_length(const struct dentry *dentry);
317 extern u64 dentry_correct_total_length(const struct dentry *dentry);
319 extern void stbuf_to_inode(const struct stat *stbuf, struct inode *inode);
321 extern int for_dentry_in_tree(struct dentry *root,
322 int (*visitor)(struct dentry*, void*),
325 extern int for_dentry_in_tree_depth(struct dentry *root,
326 int (*visitor)(struct dentry*, void*),
329 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
330 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
331 extern int get_names(char **name_utf16_ret, char **name_utf8_ret,
332 u16 *name_utf16_len_ret, u16 *name_utf8_len_ret,
334 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
335 extern int change_ads_name(struct ads_entry *entry, const char *new_name);
337 extern void unlink_dentry(struct dentry *dentry);
338 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
340 extern int print_dentry(struct dentry *dentry, void *lookup_table);
341 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
343 extern struct dentry *get_dentry(struct WIMStruct *w, const char *path);
344 extern struct inode *wim_pathname_to_inode(struct WIMStruct *w,
346 extern struct dentry *get_parent_dentry(struct WIMStruct *w, const char *path);
347 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
349 extern void dentry_update_all_timestamps(struct dentry *dentry);
350 extern void init_dentry(struct dentry *dentry, const char *name);
351 extern struct dentry *new_dentry(const char *name);
352 extern struct inode *new_inode();
353 extern struct inode *new_timeless_inode();
354 extern struct dentry *new_dentry_with_inode(const char *name);
356 extern void free_ads_entry(struct ads_entry *entry);
357 extern void inode_free_ads_entries(struct inode *inode);
358 extern struct inode *free_dentry(struct dentry *dentry);
359 extern void free_inode(struct inode *inode);
360 extern struct inode *put_inode(struct inode *inode);
361 extern struct dentry *clone_dentry(struct dentry *old);
362 extern void put_dentry(struct dentry *dentry);
363 extern void free_dentry_tree(struct dentry *root,
364 struct lookup_table *lookup_table);
365 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
366 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
368 extern void calculate_dir_tree_statistics(struct dentry *root,
369 struct lookup_table *table,
372 u64 *total_bytes_ret,
373 u64 *hard_link_bytes_ret);
375 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
376 u64 offset, struct dentry *dentry);
378 extern int verify_dentry(struct dentry *dentry, void *wim);
380 extern int read_dentry_tree(const u8 metadata_resource[],
381 u64 metadata_resource_len, struct dentry *dentry);
383 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
386 static inline struct dentry *inode_first_dentry(struct inode *inode)
388 wimlib_assert(inode->dentry_list.next != &inode->dentry_list);
389 return container_of(inode->dentry_list.next, struct dentry,
393 static inline bool dentry_is_root(const struct dentry *dentry)
395 return dentry->parent == dentry;
398 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
400 return dentry_is_root(dentry) || dentry->parent->inode->children == dentry;
403 static inline bool dentry_is_only_child(const struct dentry *dentry)
405 return dentry->next == dentry;
408 static inline bool inode_is_directory(const struct inode *inode)
410 return (inode->attributes & FILE_ATTRIBUTE_DIRECTORY)
411 && !(inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
414 static inline bool dentry_is_directory(const struct dentry *dentry)
416 return inode_is_directory(dentry->inode);
419 /* For our purposes, we consider "real" symlinks and "junction points" to both
421 static inline bool inode_is_symlink(const struct inode *inode)
423 return (inode->attributes & FILE_ATTRIBUTE_REPARSE_POINT)
424 && ((inode->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
425 inode->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
428 static inline bool dentry_is_symlink(const struct dentry *dentry)
430 return inode_is_symlink(dentry->inode);
433 static inline bool inode_is_regular_file(const struct inode *inode)
435 return !inode_is_directory(inode) && !inode_is_symlink(inode);
438 static inline bool dentry_is_regular_file(const struct dentry *dentry)
440 return inode_is_regular_file(dentry->inode);
443 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
445 return dentry_is_directory(dentry) && dentry->inode->children == NULL;