1 #ifndef _WIMLIB_LOOKUP_TABLE_H
2 #define _WIMLIB_LOOKUP_TABLE_H
3 #include "wimlib_internal.h"
8 /* Size of each lookup table entry in the WIM file. */
9 #define WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE 50
11 #define LOOKUP_FLAG_ADS_OK 0x00000001
12 #define LOOKUP_FLAG_DIRECTORY_OK 0x00000002
15 //#define LOOKUP_FLAG_FOLLOW_SYMLINKS 0x00000004
18 /* A lookup table that is used to translate the hash codes of dentries into the
19 * offsets and sizes of uncompressed or compressed file resources. It is
20 * implemented as a hash table. */
22 struct hlist_head *array;
30 struct ntfs_location {
32 char *stream_name_utf16;
33 u16 stream_name_utf16_num_chars;
34 struct _ntfs_volume **ntfs_vol_p;
35 bool is_reparse_point;
40 * An entry in the lookup table in the WIM file.
42 * It is used to find data streams for files in the WIM.
44 * Metadata resources and reparse point data buffers will also have lookup table
45 * entries associated with the data.
47 * The lookup_table_entry for a given dentry or alternate stream entry in the
48 * WIM is found using the SHA1 message digest field.
50 struct lookup_table_entry {
52 /* List of lookup table entries in this hash bucket */
53 struct hlist_node hash_list;
55 /* Location and size of the stream in the WIM, whether it is compressed
56 * or not, and whether it's a metadata resource or not. This is an
58 struct resource_entry resource_entry;
60 /* Specifies which part of the split WIM the resource is located in.
61 * This is on on-disk field.
63 * In stand-alone WIMs, this must be 1.
65 * In split WIMs, every split WIM part has its own lookup table, and in
66 * read_lookup_table() it's currently expected that the part number of
67 * each lookup table entry in a split WIM part's lookup table is the
68 * same as the part number of that split WIM part. So this makes this
69 * field redundant since we store a pointer to the corresponding
70 * WIMStruct in the lookup table entry anyway.
74 /* An enumerated type that identifies where the stream corresponding to
75 * this lookup table entry is actually located.
77 * Obviously if we open a WIM and read its lookup table, the location is
78 * set to RESOURCE_IN_WIM since all the streams will initially be
79 * located in the WIM. However, to deal with problems such as image
80 * capture and image mount, we allow the actual location of the stream
81 * to be somewhere else, such as an external file.
84 /* The lookup table entry does not correspond to a stream (this
85 * state should exist only temporarily) */
86 RESOURCE_NONEXISTENT = 0,
88 /* The stream resource is located in a WIM file. The WIMStruct
89 * for the WIM file will be pointed to by the @wim member. */
92 /* The stream resource is located in an external file. The
93 * name of the file will be provided by @file_on_disk member.
94 * In addition, if @file_on_disk_fp is not NULL, it will be an
95 * open FILE * to the file. */
96 RESOURCE_IN_FILE_ON_DISK,
98 /* The stream resource is located in an external file in the
99 * staging directory for a read-write mount. */
100 RESOURCE_IN_STAGING_FILE,
102 /* The stream resource is directly attached in an in-memory
103 * buffer pointed to by @attached_buffer. */
104 RESOURCE_IN_ATTACHED_BUFFER,
106 /* The stream resource is located in an NTFS volume. It is
107 * identified by volume, filename, data stream name, and by
108 * whether it is a reparse point or not. @ntfs_loc points to a
109 * structure containing this information. */
110 RESOURCE_IN_NTFS_VOLUME,
114 * Number of times this lookup table entry is referenced by dentries.
115 * Unfortunately, this field is not always set correctly in Microsoft's
116 * WIMs, so we have no choice but to fix it if more references to the
117 * lookup table entry are found than stated here. */
121 /* (On-disk field) SHA1 message digest of the stream referenced
122 * by this lookup table entry */
123 u8 hash[SHA1_HASH_SIZE];
125 /* First 4 or 8 bytes of the SHA1 message digest, used for
126 * inserting the entry into the hash table. Since the SHA1
127 * message digest can be considered random, we don't really need
128 * the full 20 byte hash just to insert the entry in a hash
133 /* Pointers to somewhere where the stream is actually located. See the
134 * comments for the @resource_location field above. */
138 char *staging_file_name;
141 struct ntfs_location *ntfs_loc;
145 /* Temporary field for creating a singly linked list. Shouldn't
147 struct lookup_table_entry *next_lte_in_swm;
149 /* @file_on_disk_fp and @attr are both used to cache file/stream
150 * handles so we don't have re-open them on every read */
151 FILE *file_on_disk_fp;
153 struct _ntfs_attr *attr;
157 /* File descriptors table for this data stream. This is used if the WIM
158 * is mounted. Basically, each time a file is open()ed, a new file
159 * descriptor is added here, and each time a file is close()ed, the file
160 * descriptor is gotten rid of. If the stream is opened for writing, it
161 * will be extracted to the staging directory and there will be an
162 * actual native file descriptor associated with each "wimlib file
165 u16 num_allocated_fds;
166 struct wimlib_fd **fds;
169 /* When a WIM file is written, out_refcnt starts at 0 and is incremented
170 * whenever the file resource pointed to by this lookup table entry
171 * needs to be written. The file resource only need to be written when
172 * out_refcnt is nonzero, since otherwise it is not referenced by any
176 /* When a WIM file is written, @output_resource_entry is filled
177 * in with the resource entry for the output WIM. This will not
178 * necessarily be the same as the @resource_entry since:
179 * - The stream may have a different offset in the new WIM
180 * - The stream may have a different compressed size in the
181 * new WIM if the compression type changed
183 struct resource_entry output_resource_entry;
185 /* This field is used for the special hardlink or symlink image
186 * application mode. In these mode, all identical files are
187 * linked together, and @extracted_file will be set to the
188 * filename of the first extracted file containing this stream.
190 char *extracted_file;
192 /* Circular linked list of streams that share the same lookup table
195 * This list of streams may include streams from different hard link
196 * sets that happen to be the same. */
197 struct list_head lte_group_list;
199 /* List of lookup table entries that correspond to streams that have
200 * been extracted to the staging directory when modifying a read-write
202 struct list_head staging_list;
205 static inline u64 wim_resource_size(const struct lookup_table_entry *lte)
207 return lte->resource_entry.original_size;
211 wim_resource_compressed_size(const struct lookup_table_entry *lte)
213 return lte->resource_entry.size;
217 * XXX Probably should store the compression type directly in the lookup table
221 wim_resource_compression_type(const struct lookup_table_entry *lte)
223 if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
224 || lte->resource_location != RESOURCE_IN_WIM)
225 return WIM_COMPRESSION_TYPE_NONE;
226 return wimlib_get_compression_type(lte->wim);
230 extern struct lookup_table *new_lookup_table(size_t capacity);
232 extern void lookup_table_insert(struct lookup_table *table,
233 struct lookup_table_entry *lte);
235 /* Unlinks a lookup table entry from the table; does not free it. */
236 static inline void lookup_table_unlink(struct lookup_table *table,
237 struct lookup_table_entry *lte)
239 hlist_del(<e->hash_list);
240 table->num_entries--;
244 extern struct lookup_table_entry *
245 lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
247 extern struct lookup_table_entry *
248 lte_decrement_refcnt(struct lookup_table_entry *lte,
249 struct lookup_table *table);
252 extern struct lookup_table_entry *new_lookup_table_entry();
254 extern int for_lookup_table_entry(struct lookup_table *table,
255 int (*visitor)(struct lookup_table_entry *, void *),
258 extern struct lookup_table_entry *
259 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
261 extern int lookup_resource(WIMStruct *w, const char *path,
262 int lookup_flags, struct dentry **dentry_ret,
263 struct lookup_table_entry **lte_ret,
264 unsigned *stream_idx_ret);
266 extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore);
268 extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
270 extern int read_lookup_table(WIMStruct *w);
272 extern void free_lookup_table(struct lookup_table *table);
274 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
276 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
278 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
280 /* Writes the lookup table to the output file. */
281 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
283 return for_lookup_table_entry(table, write_lookup_table_entry, out);
286 /* Unlinks and frees an entry from a lookup table. */
287 static inline void lookup_table_remove(struct lookup_table *table,
288 struct lookup_table_entry *lte)
290 lookup_table_unlink(table, lte);
291 free_lookup_table_entry(lte);
294 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
296 return &w->image_metadata[
297 w->current_image - 1].metadata_lte->resource_entry;
300 static inline struct lookup_table_entry *
301 inode_stream_lte_resolved(const struct inode *inode, unsigned stream_idx)
303 wimlib_assert(inode->resolved);
304 wimlib_assert(stream_idx <= inode->num_ads);
308 return inode->ads_entries[stream_idx - 1]->lte;
311 static inline struct lookup_table_entry *
312 inode_stream_lte_unresolved(const struct inode *inode, unsigned stream_idx,
313 const struct lookup_table *table)
315 wimlib_assert(!inode->resolved);
316 wimlib_assert(stream_idx <= inode->num_ads);
320 return __lookup_resource(table, inode->hash);
322 return __lookup_resource(table,
324 stream_idx - 1]->hash);
327 * Returns the lookup table entry for stream @stream_idx of the inode, where
328 * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1
329 * corresponds to an alternate data stream.
331 * This works for both resolved and un-resolved dentries.
333 static inline struct lookup_table_entry *
334 inode_stream_lte(const struct inode *inode, unsigned stream_idx,
335 const struct lookup_table *table)
338 return inode_stream_lte_resolved(inode, stream_idx);
340 return inode_stream_lte_unresolved(inode, stream_idx, table);
344 static inline const u8 *inode_stream_hash_unresolved(const struct inode *inode,
347 wimlib_assert(!inode->resolved);
348 wimlib_assert(stream_idx <= inode->num_ads);
352 return inode->ads_entries[stream_idx - 1]->hash;
356 static inline const u8 *inode_stream_hash_resolved(const struct inode *inode,
359 struct lookup_table_entry *lte;
360 lte = inode_stream_lte_resolved(inode, stream_idx);
368 * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
369 * means the default un-named file stream, and stream_idx >= 1 corresponds to an
370 * alternate data stream.
372 * This works for both resolved and un-resolved dentries.
374 static inline const u8 *inode_stream_hash(const struct inode *inode,
378 return inode_stream_hash_resolved(inode, stream_idx);
380 return inode_stream_hash_unresolved(inode, stream_idx);
383 static inline u16 inode_stream_name_len(const struct inode *inode,
386 wimlib_assert(stream_idx <= inode->num_ads);
390 return inode->ads_entries[stream_idx - 1]->stream_name_len;
393 static inline struct lookup_table_entry *
394 inode_unnamed_lte_resolved(const struct inode *inode)
396 wimlib_assert(inode->resolved);
397 for (unsigned i = 0; i <= inode->num_ads; i++)
398 if (inode_stream_name_len(inode, i) == 0 &&
399 !is_zero_hash(inode_stream_hash_resolved(inode, i)))
400 return inode_stream_lte_resolved(inode, i);
404 static inline struct lookup_table_entry *
405 inode_unnamed_lte_unresolved(const struct inode *inode,
406 const struct lookup_table *table)
408 wimlib_assert(!inode->resolved);
409 for (unsigned i = 0; i <= inode->num_ads; i++)
410 if (inode_stream_name_len(inode, i) == 0 &&
411 !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
412 return inode_stream_lte_unresolved(inode, i, table);
416 extern struct lookup_table_entry *
417 inode_unnamed_lte(const struct inode *inode,
418 const struct lookup_table *table);