1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
16 struct wim_lookup_table;
18 struct wim_lookup_table_entry;
23 /* Size of the struct wim_dentry up to and including the file_name_len. */
24 #define WIM_DENTRY_DISK_SIZE 102
26 /* Size of on-disk WIM alternate data stream entry, in bytes, up to and
27 * including the stream length field (see below). */
28 #define WIM_ADS_ENTRY_DISK_SIZE 38
31 * Reparse tags documented at
32 * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
34 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000
35 #define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001
36 #define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
37 #define WIM_IO_REPARSE_TAG_HSM 0xC0000004
38 #define WIM_IO_REPARSE_TAG_HSM2 0x80000006
39 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
40 #define WIM_IO_REPARSE_TAG_SIS 0x80000007
41 #define WIM_IO_REPARSE_TAG_DFS 0x8000000A
42 #define WIM_IO_REPARSE_TAG_DFSR 0x80000012
43 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
44 #define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C
46 #define FILE_ATTRIBUTE_READONLY 0x00000001
47 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
48 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
49 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
50 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
51 #define FILE_ATTRIBUTE_DEVICE 0x00000040
52 #define FILE_ATTRIBUTE_NORMAL 0x00000080
53 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
54 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
55 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
56 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
57 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
58 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
59 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
60 #define FILE_ATTRIBUTE_VIRTUAL 0x00010000
63 /* Alternate data stream entry.
65 * We read this from disk in the read_ads_entries() function; see that function
66 * for more explanation. */
67 struct wim_ads_entry {
69 /* SHA-1 message digest of stream contents */
70 u8 hash[SHA1_HASH_SIZE];
72 /* The corresponding lookup table entry (only for resolved
74 struct wim_lookup_table_entry *lte;
77 /* Length of UTF16-encoded stream name, in bytes, not including the
78 * terminating null character. */
79 u16 stream_name_nbytes;
81 /* Stream name (UTF-16LE) */
82 utf16lechar *stream_name;
85 /* Number to identify an alternate data stream even after it's possibly
86 * been moved or renamed. */
93 ads_entries_have_same_name(const struct wim_ads_entry *entry_1,
94 const struct wim_ads_entry *entry_2)
96 return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes &&
97 memcmp(entry_1->stream_name, entry_2->stream_name,
98 entry_1->stream_name_nbytes) == 0;
102 * In-memory structure for a WIM directory entry (dentry). There is a directory
103 * tree for each image in the WIM.
105 * Note that this is a directory entry and not an inode. Since NTFS allows hard
106 * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
107 * The hard link group ID field of the on-disk WIM dentry tells us the number of
108 * the NTFS inode that the dentry corresponds to (and this gets placed in
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 wim_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
127 * dentry_tree_fix_inodes() in hardlink.c).
130 /* The inode for this dentry */
131 struct wim_inode *d_inode;
133 /* Red-black tree of sibling dentries */
134 struct rb_node rb_node;
136 /* Length of UTF-16LE encoded short filename, in bytes, not including
137 * the terminating zero wide-character. */
138 u16 short_name_nbytes;
140 /* Length of UTF-16LE encoded "long" file name, in bytes, not including
141 * the terminating null character. */
142 u16 file_name_nbytes;
144 /* Length of full path name, in bytes, as a multibyte-encoded string */
145 u32 full_path_nbytes;
149 /* Only used during NTFS capture */
150 u8 is_win32_name : 1;
153 struct list_head tmp_list;
155 /* List of dentries in the inode (hard link set) */
156 struct list_head d_alias;
158 /* The parent of this directory entry. */
159 struct wim_dentry *parent;
162 * Size of directory entry on disk, in bytes. Typical size is around
165 * It is possible for the length field to be 0. This situation, which
166 * is undocumented, indicates the end of a list of sibling nodes in a
167 * directory. It also means the real length is 8, because the dentry
168 * included only the length field, but that takes up 8 bytes.
170 * The length here includes the base directory entry on disk as well as
171 * the long and short filenames. It does NOT include any alternate
172 * stream entries that may follow the directory entry, even though the
173 * size of those needs to be considered. The length SHOULD be 8-byte
174 * aligned, although we don't require it to be. We do require the
175 * length to be large enough to hold the file name(s) of the dentry;
176 * additionally, a warning is issued if this field is larger than the
181 /* The offset, from the start of the uncompressed WIM metadata resource
182 * for this image, of this dentry's child dentries. 0 if the directory
183 * entry has no children, which is the case for regular files or reparse
187 /* Number of references to the dentry tree itself, as in multiple
191 /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */
192 utf16lechar *short_name;
194 /* Pointer to the UTF-16LE filename (malloc()ed buffer). */
195 utf16lechar *file_name;
197 /* Full path of this dentry */
201 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
206 * As mentioned above, in the WIM file that is no on-disk analogue of a real
207 * inode, as most of these fields are duplicated in the dentries.
210 /* Timestamps for the inode. The timestamps are the number of
211 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
212 * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
214 u64 i_last_access_time;
215 u64 i_last_write_time;
217 /* The file attributes associated with this inode. This is a bitwise OR
218 * of the FILE_ATTRIBUTE_* flags. */
221 /* The index of the security descriptor in the WIM image's table of
222 * security descriptors that contains this file's security information.
223 * If -1, no security information exists for this file. */
224 int32_t i_security_id;
226 /* %true iff the inode's lookup table entries has been resolved (i.e.
227 * the @lte field is valid, but the @hash field is not valid)
229 * (This is not an on-disk field.) */
232 /* %true iff verify_inode() has run on this inode. */
235 /* Used only in NTFS-mode extraction */
236 u8 i_dos_name_extracted : 1;
238 /* Number of alternate data streams associated with this inode */
241 /* A hash of the file's contents, or a pointer to the lookup table entry
242 * for this dentry if the lookup table entries have been resolved.
244 * More specifically, this is for the un-named default file stream, as
245 * opposed to the alternate (named) file streams, which may have their
246 * own lookup table entries. */
248 u8 i_hash[SHA1_HASH_SIZE];
249 struct wim_lookup_table_entry *i_lte;
252 /* Identity of a reparse point. See
253 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
254 * for what a reparse point is. */
257 /* Number of dentries that reference this inode */
260 /* Alternate data stream entries. */
261 struct wim_ads_entry *i_ads_entries;
266 /* List of dentries that reference this inode (there should be
267 * link_count of them) */
268 struct list_head i_dentry;
270 struct hlist_node i_hlist;
272 struct list_head i_lte_inode_list;
274 mbchar *i_extracted_file;
276 /* Root of a red-black tree storing the children of this inode (if
277 * non-empty, implies the inode is a directory, although that is also
278 * noted in the @attributes field.) */
279 struct rb_root i_children;
282 /* wimfs file descriptors table for the inode */
283 u16 i_num_opened_fds;
284 u16 i_num_allocated_fds;
285 struct wimfs_fd **i_fds;
287 /* Next alternate data stream ID to be assigned */
288 u32 i_next_stream_id;
290 /* This mutex protects the inode's file descriptors table during
291 * read-only mounts. Read-write mounts are still restricted to 1
293 pthread_mutex_t i_mutex;
297 #define inode_for_each_dentry(dentry, inode) \
298 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
300 #define inode_add_dentry(dentry, inode) \
301 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
303 #define inode_first_dentry(inode) \
304 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
307 dentry_is_first_in_inode(const struct wim_dentry *dentry)
309 return inode_first_dentry(dentry->d_inode) == dentry;
313 dentry_correct_total_length(const struct wim_dentry *dentry);
316 for_dentry_in_tree(struct wim_dentry *root,
317 int (*visitor)(struct wim_dentry*, void*),
321 for_dentry_in_rbtree(struct rb_node *node,
322 int (*visitor)(struct wim_dentry *, void *),
326 for_dentry_child(const struct wim_dentry *dentry,
327 int (*visitor)(struct wim_dentry *, void *),
330 return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
336 for_dentry_in_tree_depth(struct wim_dentry *root,
337 int (*visitor)(struct wim_dentry*, void*),
341 calculate_dentry_full_path(struct wim_dentry *dentry, void *ignore);
344 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
347 set_dentry_name(struct wim_dentry *dentry, const mbchar *new_name);
349 extern struct wim_dentry *
350 get_dentry(struct WIMStruct *w, const mbchar *path);
352 extern struct wim_inode *
353 wim_pathname_to_inode(struct WIMStruct *w, const mbchar *path);
355 extern struct wim_dentry *
356 get_dentry_child_with_name(const struct wim_dentry *dentry,
359 extern struct wim_dentry *
360 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
361 const utf16lechar *name,
364 extern struct wim_dentry *
365 get_parent_dentry(struct WIMStruct *w, const mbchar *path);
368 print_dentry(struct wim_dentry *dentry, void *lookup_table);
371 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
374 new_dentry(const mbchar *name, struct wim_dentry **dentry_ret);
377 new_dentry_with_inode(const mbchar *name, struct wim_dentry **dentry_ret);
380 new_dentry_with_timeless_inode(const mbchar *name, struct wim_dentry **dentry_ret);
383 free_inode(struct wim_inode *inode);
386 free_dentry(struct wim_dentry *dentry);
389 put_dentry(struct wim_dentry *dentry);
392 free_dentry_tree(struct wim_dentry *root,
393 struct wim_lookup_table *lookup_table);
396 increment_dentry_refcnt(struct wim_dentry *dentry, void *ignore);
399 unlink_dentry(struct wim_dentry *dentry);
402 dentry_add_child(struct wim_dentry * restrict parent,
403 struct wim_dentry * restrict child);
405 extern struct wim_ads_entry *
406 inode_get_ads_entry(struct wim_inode *inode, const mbchar *stream_name,
409 extern struct wim_ads_entry *
410 inode_add_ads_utf16le(struct wim_inode *inode,
411 const utf16lechar *stream_name,
412 size_t stream_name_nbytes);
414 extern struct wim_ads_entry *
415 inode_add_ads(struct wim_inode *dentry, const mbchar *stream_name);
418 inode_add_ads_with_data(struct wim_inode *inode, const mbchar *name,
419 const void *value, size_t size,
420 struct wim_lookup_table *lookup_table);
423 inode_remove_ads(struct wim_inode *inode, u16 idx,
424 struct wim_lookup_table *lookup_table);
427 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
428 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
430 #define WIMLIB_UNIX_DATA_TAG_UTF16LE "$\0$\0_\0_\0w\0i\0m\0l\0i\0b\0_\0U\0N\0I\0X\0_\0d\0a\0t\0a\0"
431 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
433 /* Format for special alternate data stream entries to store UNIX data for files
434 * and directories (see: WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
435 struct wimlib_unix_data {
436 u16 version; /* Must be 0 */
444 #define NO_UNIX_DATA (-1)
445 #define BAD_UNIX_DATA (-2)
447 inode_get_unix_data(const struct wim_inode *inode,
448 struct wimlib_unix_data *unix_data,
449 u16 *stream_idx_ret);
451 #define UNIX_DATA_UID 0x1
452 #define UNIX_DATA_GID 0x2
453 #define UNIX_DATA_MODE 0x4
454 #define UNIX_DATA_ALL (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
455 #define UNIX_DATA_CREATE 0x8
457 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
458 struct wim_lookup_table *lookup_table, int which);
462 read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
463 u64 offset, struct wim_dentry *dentry);
467 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
468 struct wim_dentry *dentry);
471 write_dentry_tree(const struct wim_dentry *tree, u8 *p);
474 dentry_is_root(const struct wim_dentry *dentry)
476 return dentry->parent == dentry;
480 inode_is_directory(const struct wim_inode *inode)
482 return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
483 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
487 dentry_is_directory(const struct wim_dentry *dentry)
489 return inode_is_directory(dentry->d_inode);
492 /* For our purposes, we consider "real" symlinks and "junction points" to both
495 inode_is_symlink(const struct wim_inode *inode)
497 return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
498 && ((inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) ||
499 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
503 inode_is_regular_file(const struct wim_inode *inode)
505 return !inode_is_directory(inode) && !inode_is_symlink(inode);
509 dentry_is_regular_file(const struct wim_dentry *dentry)
511 return inode_is_regular_file(dentry->d_inode);
515 inode_has_children(const struct wim_inode *inode)
517 return inode->i_children.rb_node != NULL;
521 dentry_has_children(const struct wim_dentry *dentry)
523 return inode_has_children(dentry->d_inode);
527 dentry_has_short_name(const struct wim_dentry *dentry)
529 return dentry->short_name_nbytes != 0;
533 dentry_has_long_name(const struct wim_dentry *dentry)
535 return dentry->file_name_nbytes != 0;