1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
7 /* Size of the struct dentry up to and including the file_name_len. */
8 #define WIM_DENTRY_DISK_SIZE 102
10 #define WIM_ADS_ENTRY_DISK_SIZE (2 * sizeof(u64) + WIM_HASH_SIZE + sizeof(u16))
12 /* Alternate data stream entry */
14 /* SHA-1 message digest of stream contents */
15 u8 hash[WIM_HASH_SIZE];
17 /* Length of stream name (UTF-16) */
20 /* Length of stream name (UTF-8) */
21 u16 stream_name_len_utf8;
23 /* Stream name (UTF-16) */
26 /* Stream name (UTF-8) */
27 char *stream_name_utf8;
30 static inline u64 ads_entry_length(const struct ads_entry *entry)
32 return WIM_ADS_ENTRY_DISK_SIZE + entry->stream_name_len;
35 /* In-memory structure for a directory entry. There is a directory tree for
36 * each image in the WIM. */
38 /* The parent of this directory entry. */
39 struct dentry *parent;
41 /* Linked list of sibling directory entries. */
46 /* Pointer to a child of this directory entry. */
47 struct dentry *children;
49 /* Size of directory entry, in bytes. Typical size is around 104 to 120
51 /* It is possible for the length field to be 0. This situation, which
52 * is undocumented, indicates the end of a list of sibling nodes in a
53 * directory. It also means the real length is 8, because the dentry
54 * included only the length field, but that takes up 8 bytes. */
58 /* The file attributes associated with this file. */
61 /* The index of the node in the security table that contains this file's
62 * security information. If -1, no security information exists for this
66 /* The offset, from the start of the metadata section, of this directory
67 * entry's child files. 0 if the directory entry has no children. */
70 /* Reserved for future disuse. Currently ignoring these fields. */
74 /* Timestamps for the entry. The timestamps are the number of
75 * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
81 /* A hash of the file's contents. */
82 u8 hash[WIM_HASH_SIZE];
84 /* Identity of a reparse point. See
85 * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
86 * for what a reparse point is. */
89 /* Although M$'s documentation does not tell you this, it seems that the
90 * reparse_reserved field does not actually exist. So the hard_link
91 * field directly follows the reparse_tag on disk. */
92 //u32 reparse_reserved;
94 /* If the reparse_reserved field existed, there would be a 4-byte gap
95 * here to align hard_link on an 8-byte field. However,
96 * reparse_reserved does not actually exist, so there is no gap here. */
98 /* If the file is part of a hard link set, all the directory entries in
99 * the set will share the same value for this field. */
102 /* Number of alternate data streams associated with this file. */
105 /* Length of short filename, in bytes, not including the terminating
106 * zero wide-character. */
109 /* Length of file name, in bytes, not including the terminating zero
113 /* Length of the filename converted into UTF-8, in bytes, not including
114 * the terminating zero byte. */
115 u16 file_name_utf8_len;
117 /* Pointer to the short filename */
120 /* Pointer to the filename. */
123 /* Pointer to the filename converted to UTF-8. */
124 char *file_name_utf8;
126 /* Full path to this dentry. */
127 char *full_path_utf8;
128 u32 full_path_utf8_len;
130 /* Alternate stream entries for this dentry. */
131 struct ads_entry *ads_entries;
133 /* Number of references to the dentry tree itself, as in multiple
138 #define WIM_FILE_ATTRIBUTE_READONLY 0x00000001
139 #define WIM_FILE_ATTRIBUTE_HIDDEN 0x00000002
140 #define WIM_FILE_ATTRIBUTE_SYSTEM 0x00000004
141 #define WIM_FILE_ATTRIBUTE_DIRECTORY 0x00000010
142 #define WIM_FILE_ATTRIBUTE_ARCHIVE 0x00000020
143 #define WIM_FILE_ATTRIBUTE_DEVICE 0x00000040
144 #define WIM_FILE_ATTRIBUTE_NORMAL 0x00000080
145 #define WIM_FILE_ATTRIBUTE_TEMPORARY 0x00000100
146 #define WIM_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
147 #define WIM_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
148 #define WIM_FILE_ATTRIBUTE_COMPRESSED 0x00000800
149 #define WIM_FILE_ATTRIBUTE_OFFLINE 0x00001000
150 #define WIM_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
151 #define WIM_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
152 #define WIM_FILE_ATTRIBUTE_VIRTUAL 0x00010000
154 extern void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry);
156 extern void dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf,
157 const struct lookup_table *table);
159 extern int for_dentry_in_tree(struct dentry *root,
160 int (*visitor)(struct dentry*, void*),
163 extern int for_dentry_in_tree_depth(struct dentry *root,
164 int (*visitor)(struct dentry*, void*),
167 extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore);
168 extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p);
169 extern int change_dentry_name(struct dentry *dentry, const char *new_name);
171 extern void unlink_dentry(struct dentry *dentry);
172 extern void link_dentry(struct dentry *dentry, struct dentry *parent);
174 extern int print_dentry(struct dentry *dentry, void *lookup_table);
175 extern int print_dentry_full_path(struct dentry *entry, void *ignore);
177 extern struct dentry *get_dentry(WIMStruct *w, const char *path);
178 extern struct dentry *get_parent_dentry(WIMStruct *w, const char *path);
179 extern struct dentry *get_dentry_child_with_name(const struct dentry *dentry,
181 extern void dentry_update_all_timestamps(struct dentry *dentry);
182 extern void init_dentry(struct dentry *dentry, const char *name);
183 extern struct dentry *new_dentry(const char *name);
185 extern void free_dentry(struct dentry *dentry);
186 extern void free_dentry_tree(struct dentry *root,
187 struct lookup_table *lookup_table,
188 bool lt_decrement_refcnt);
189 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
190 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
192 extern void calculate_dir_tree_statistics(struct dentry *root,
193 struct lookup_table *table,
196 u64 *total_bytes_ret,
197 u64 *hard_link_bytes_ret);
199 extern int read_dentry(const u8 metadata_resource[], u64 metadata_resource_len,
200 u64 offset, struct dentry *dentry);
202 extern int read_dentry_tree(const u8 metadata_resource[],
203 u64 metadata_resource_len, struct dentry *dentry);
205 extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p);
207 /* Inline utility functions for WIMDentries */
210 * Returns true if @dentry has the UTF-8 file name @name that has length
213 static inline bool dentry_has_name(const struct dentry *dentry, const char *name,
216 if (dentry->file_name_utf8_len != name_len)
218 return memcmp(dentry->file_name_utf8, name, name_len) == 0;
221 static inline bool dentry_is_root(const struct dentry *dentry)
223 return dentry->parent == dentry;
226 static inline bool dentry_is_first_sibling(const struct dentry *dentry)
228 return dentry_is_root(dentry) || dentry->parent->children == dentry;
231 static inline bool dentry_is_only_child(const struct dentry *dentry)
233 return dentry->next == dentry;
236 static inline bool dentry_is_directory(const struct dentry *dentry)
238 return (dentry->attributes & WIM_FILE_ATTRIBUTE_DIRECTORY) != 0;
241 static inline bool dentry_is_regular_file(const struct dentry *dentry)
243 return !dentry_is_directory(dentry);
246 static inline bool dentry_is_empty_directory(const struct dentry *dentry)
248 return dentry_is_directory(dentry) && dentry->children == NULL;