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 typedef struct _ntfs_attr ntfs_attr;
31 typedef struct _ntfs_volume ntfs_volume;
32 struct ntfs_location {
34 char *stream_name_utf16;
35 u16 stream_name_utf16_num_chars;
36 ntfs_volume **ntfs_vol_p;
37 bool is_reparse_point;
42 * An entry in the lookup table in the WIM file.
44 * It is used to find data streams for files in the WIM.
46 * The lookup_table_entry for a given dentry in the WIM is found using the SHA1
47 * message digest field.
49 struct lookup_table_entry {
51 /* List of lookup table entries in this hash bucket */
52 struct hlist_node hash_list;
54 /* @resource_entry is read from the lookup table in the WIM
55 * file; it says where to find the file resource in the WIM
56 * file, and whether it is compressed or not. */
57 struct resource_entry resource_entry;
59 /* Currently ignored; set to 1 in new lookup table entries. */
62 /* If %true, this lookup table entry corresponds to a symbolic link
63 * reparse buffer. @symlink_reparse_data_buf will give the target of
64 * the symbolic link. */
66 RESOURCE_NONEXISTENT = 0,
68 RESOURCE_IN_FILE_ON_DISK,
69 RESOURCE_IN_STAGING_FILE,
70 RESOURCE_IN_ATTACHED_BUFFER,
71 RESOURCE_IN_NTFS_VOLUME,
74 /* Number of times this lookup table entry is referenced by dentries. */
78 /* SHA1 hash of the file resource pointed to by this lookup
80 u8 hash[SHA1_HASH_SIZE];
82 /* First 4 or 8 bytes of the SHA1 hash, used for inserting the
83 * entry into the hash table. Since the SHA1 hashes can be
84 * considered random, we don't really need the full 20 byte hash
85 * just to insert the entry in a hash table. */
89 /* If @file_on_disk != NULL, the file resource indicated by this lookup
90 * table entry is not in the WIM file, but rather a file on disk; this
91 * occurs for files that are added to the WIM. In that case,
92 * file_on_disk is the name of the file in the outside filesystem.
93 * It will not be compressed, and its size will be given by
94 * resource_entry.size and resource_entry.original_size. */
98 char *staging_file_name;
101 struct ntfs_location *ntfs_loc;
105 struct lookup_table_entry *next_lte_in_swm;
106 FILE *file_on_disk_fp;
112 /* File descriptors table for this data stream */
114 u16 num_allocated_fds;
115 struct wimlib_fd **fds;
118 /* When a WIM file is written, out_refcnt starts at 0 and is incremented
119 * whenever the file resource pointed to by this lookup table entry
120 * needs to be written. Naturally, the file resource only need to be
121 * written when out_refcnt is 0. Incrementing it further is needed to
122 * find the correct reference count to write to the lookup table in the
123 * output file, which may be less than the regular refcnt if not all
124 * images in the WIM file are written.
126 * output_resource_entry is the struct resource_entry for the position of the
127 * file resource when written to the output file. */
130 struct resource_entry output_resource_entry;
131 char *extracted_file;
134 /* Circular linked list of streams that share the same lookup table
137 * This list of streams may include streams from different hard link
138 * sets that happen to be the same. */
139 struct list_head lte_group_list;
141 /* List of lookup table entries that correspond to streams that have
142 * been extracted to the staging directory when modifying a read-write
144 struct list_head staging_list;
147 static inline u64 wim_resource_size(const struct lookup_table_entry *lte)
149 return lte->resource_entry.original_size;
153 wim_resource_compressed_size(const struct lookup_table_entry *lte)
155 return lte->resource_entry.size;
159 * XXX Probably should store the compression type directly in the lookup table
163 wim_resource_compression_type(const struct lookup_table_entry *lte)
165 if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
166 || lte->resource_location != RESOURCE_IN_WIM)
167 return WIM_COMPRESSION_TYPE_NONE;
168 return wimlib_get_compression_type(lte->wim);
172 extern struct lookup_table *new_lookup_table(size_t capacity);
174 extern void lookup_table_insert(struct lookup_table *table,
175 struct lookup_table_entry *lte);
177 /* Unlinks a lookup table entry from the table; does not free it. */
178 static inline void lookup_table_unlink(struct lookup_table *table,
179 struct lookup_table_entry *lte)
181 hlist_del(<e->hash_list);
182 table->num_entries--;
186 extern struct lookup_table_entry *
187 lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
189 extern struct lookup_table_entry *
190 lte_decrement_refcnt(struct lookup_table_entry *lte,
191 struct lookup_table *table);
194 extern struct lookup_table_entry *new_lookup_table_entry();
196 extern int for_lookup_table_entry(struct lookup_table *table,
197 int (*visitor)(struct lookup_table_entry *, void *),
200 extern struct lookup_table_entry *
201 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
203 extern int lookup_resource(WIMStruct *w, const char *path,
204 int lookup_flags, struct dentry **dentry_ret,
205 struct lookup_table_entry **lte_ret,
206 unsigned *stream_idx_ret);
208 extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore);
210 extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
212 extern int read_lookup_table(WIMStruct *w);
214 extern void free_lookup_table(struct lookup_table *table);
216 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
218 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
220 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
222 /* Writes the lookup table to the output file. */
223 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
225 return for_lookup_table_entry(table, write_lookup_table_entry, out);
228 /* Unlinks and frees an entry from a lookup table. */
229 static inline void lookup_table_remove(struct lookup_table *table,
230 struct lookup_table_entry *lte)
232 lookup_table_unlink(table, lte);
233 free_lookup_table_entry(lte);
236 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
238 return &w->image_metadata[
239 w->current_image - 1].metadata_lte->resource_entry;
242 static inline struct lookup_table_entry *
243 dentry_stream_lte_resolved(const struct dentry *dentry, unsigned stream_idx)
245 wimlib_assert(dentry->resolved);
246 wimlib_assert(stream_idx <= dentry->num_ads);
250 return dentry->ads_entries[stream_idx - 1].lte;
253 static inline struct lookup_table_entry *
254 dentry_stream_lte_unresolved(const struct dentry *dentry, unsigned stream_idx,
255 const struct lookup_table *table)
257 wimlib_assert(!dentry->resolved);
258 wimlib_assert(stream_idx <= dentry->num_ads);
262 return __lookup_resource(table, dentry->hash);
264 return __lookup_resource(table,
266 stream_idx - 1].hash);
269 * Returns the lookup table entry for stream @stream_idx of the dentry, where
270 * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1
271 * corresponds to an alternate data stream.
273 * This works for both resolved and un-resolved dentries.
275 static inline struct lookup_table_entry *
276 dentry_stream_lte(const struct dentry *dentry, unsigned stream_idx,
277 const struct lookup_table *table)
279 if (dentry->resolved)
280 return dentry_stream_lte_resolved(dentry, stream_idx);
282 return dentry_stream_lte_unresolved(dentry, stream_idx, table);
286 static inline const u8 *dentry_stream_hash_unresolved(const struct dentry *dentry,
289 wimlib_assert(!dentry->resolved);
290 wimlib_assert(stream_idx <= dentry->num_ads);
294 return dentry->ads_entries[stream_idx - 1].hash;
297 static inline u16 dentry_stream_name_len(const struct dentry *dentry,
300 wimlib_assert(stream_idx <= dentry->num_ads);
304 return dentry->ads_entries[stream_idx - 1].stream_name_len;
307 static inline const u8 *dentry_stream_hash_resolved(const struct dentry *dentry,
310 struct lookup_table_entry *lte;
311 lte = dentry_stream_lte_resolved(dentry, stream_idx);
319 * Returns the hash for stream @stream_idx of the dentry, where stream_idx = 0
320 * means the default un-named file stream, and stream_idx >= 1 corresponds to an
321 * alternate data stream.
323 * This works for both resolved and un-resolved dentries.
325 static inline const u8 *dentry_stream_hash(const struct dentry *dentry,
328 if (dentry->resolved)
329 return dentry_stream_hash_resolved(dentry, stream_idx);
331 return dentry_stream_hash_unresolved(dentry, stream_idx);
334 static inline struct lookup_table_entry *
335 dentry_unnamed_lte_resolved(const struct dentry *dentry)
337 wimlib_assert(dentry->resolved);
338 for (unsigned i = 0; i <= dentry->num_ads; i++)
339 if (dentry_stream_name_len(dentry, i) == 0 &&
340 !is_zero_hash(dentry_stream_hash_resolved(dentry, i)))
341 return dentry_stream_lte_resolved(dentry, i);
345 static inline struct lookup_table_entry *
346 dentry_unnamed_lte_unresolved(const struct dentry *dentry,
347 const struct lookup_table *table)
349 wimlib_assert(!dentry->resolved);
350 for (unsigned i = 0; i <= dentry->num_ads; i++)
351 if (dentry_stream_name_len(dentry, i) == 0 &&
352 !is_zero_hash(dentry_stream_hash_unresolved(dentry, i)))
353 return dentry_stream_lte_unresolved(dentry, i, table);
357 extern struct lookup_table_entry *
358 dentry_unnamed_lte(const struct dentry *dentry,
359 const struct lookup_table *table);