eacd9aa4596dfae4441de5ec9fb338f2973f1048
[wimlib] / src / lookup_table.h
1 #ifndef _WIMLIB_LOOKUP_TABLE_H
2 #define _WIMLIB_LOOKUP_TABLE_H
3 #include "wimlib_internal.h"
4 #include "dentry.h"
5 #include "sha1.h"
6 #include <sys/types.h>
7
8 /* Size of each lookup table entry in the WIM file. */
9 #define WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE 50
10
11 #define LOOKUP_FLAG_ADS_OK              0x00000001
12 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
13
14 #ifdef __WIN32__
15 #include <windef.h>
16 #endif
17
18
19 /* The lookup table of a WIM file maps SHA1 message digests to streams of data.
20  * Here, the in-memory structure is implemented as a hash table.
21  *
22  * Given a SHA1 message digest, the mapped-to stream is specified by an offset
23  * in the WIM, an uncompressed and compressed size, and resource flags (see
24  * 'struct resource_entry').  But, we associate additional information, such as
25  * a reference count, with each stream, so the actual mapping is from SHA1
26  * message digests to 'struct wim_lookup_table_entry's, each of which contains
27  * an embedded 'struct resource_entry'.
28  *
29  * Note: Everything will break horribly if there is a SHA1 collision.
30  */
31 struct wim_lookup_table {
32         struct hlist_head *array;
33         u64 num_entries;
34         u64 capacity;
35 };
36
37 #ifdef WITH_NTFS_3G
38 struct ntfs_location {
39         tchar *path;
40         utf16lechar *stream_name;
41         u16 stream_name_nchars;
42         struct _ntfs_volume **ntfs_vol_p;
43         bool is_reparse_point;
44 };
45 #endif
46
47 /* An enumerated type that identifies where the stream corresponding to this
48  * lookup table entry is actually located.
49  *
50  * If we open a WIM and read its lookup table, the location is set to
51  * RESOURCE_IN_WIM since all the streams will initially be located in the WIM.
52  * However, to deal with problems such as image capture and image mount, we
53  * allow the actual location of the stream to be somewhere else, such as an
54  * external file.
55  */
56 enum resource_location {
57         /* The lookup table entry does not correspond to a stream (this state
58          * should exist only temporarily) */
59         RESOURCE_NONEXISTENT = 0,
60
61         /* The stream resource is located in a WIM file.  The WIMStruct for the
62          * WIM file will be pointed to by the @wim member. */
63         RESOURCE_IN_WIM,
64
65         /* The stream resource is located in an external file.  The name of the
66          * file will be provided by @file_on_disk member.  In addition, if
67          * @file_on_disk_fp is not NULL, it will be an open FILE * to the file.
68          * */
69         RESOURCE_IN_FILE_ON_DISK,
70
71         /* The stream resource is located in an external file in the staging
72          * directory for a read-write mount.  */
73         RESOURCE_IN_STAGING_FILE,
74
75         /* The stream resource is directly attached in an in-memory buffer
76          * pointed to by @attached_buffer. */
77         RESOURCE_IN_ATTACHED_BUFFER,
78
79         /* The stream resource is located in an NTFS volume.  It is identified
80          * by volume, filename, data stream name, and by whether it is a reparse
81          * point or not. @ntfs_loc points to a structure containing this
82          * information. */
83         RESOURCE_IN_NTFS_VOLUME,
84
85         /* Resource must be accessed using Win32 API (may be a named data
86          * stream) */
87         RESOURCE_WIN32,
88 };
89
90 /*
91  * An entry in the lookup table in the WIM file.
92  *
93  * It is used to find data streams for files in the WIM.
94  *
95  * Metadata resources and reparse point data buffers will also have lookup table
96  * entries associated with the data.
97  *
98  * The lookup_table_entry for a given dentry or alternate stream entry in the
99  * WIM is found using the SHA1 message digest field.
100  */
101 struct wim_lookup_table_entry {
102
103         /* List of lookup table entries in this hash bucket */
104         struct hlist_node hash_list;
105
106         /* Location and size of the stream in the WIM, whether it is compressed
107          * or not, and whether it's a metadata resource or not.  This is an
108          * on-disk field. */
109         struct resource_entry resource_entry;
110
111         /* Specifies which part of the split WIM the resource is located in.
112          * This is on on-disk field.
113          *
114          * In stand-alone WIMs, this must be 1.
115          *
116          * In split WIMs, every split WIM part has its own lookup table, and in
117          * read_lookup_table() it's currently expected that the part number of
118          * each lookup table entry in a split WIM part's lookup table is the
119          * same as the part number of that split WIM part.  So this makes this
120          * field redundant since we store a pointer to the corresponding
121          * WIMStruct in the lookup table entry anyway.
122          */
123         u16 part_number;
124
125         /* See enum resource_location above */
126         u16 resource_location;
127
128         /* (On-disk field)
129          * Number of times this lookup table entry is referenced by dentries.
130          * Unfortunately, this field is not always set correctly in Microsoft's
131          * WIMs, so we have no choice but to fix it if more references to the
132          * lookup table entry are found than stated here. */
133         u32 refcnt;
134
135         union {
136                 /* (On-disk field) SHA1 message digest of the stream referenced
137                  * by this lookup table entry */
138                 u8  hash[SHA1_HASH_SIZE];
139
140                 /* First 4 or 8 bytes of the SHA1 message digest, used for
141                  * inserting the entry into the hash table.  Since the SHA1
142                  * message digest can be considered random, we don't really need
143                  * the full 20 byte hash just to insert the entry in a hash
144                  * table. */
145                 size_t hash_short;
146         };
147
148         union {
149                 #ifdef WITH_FUSE
150                 u16 num_opened_fds;
151                 #endif
152
153                 /* This field is used for the special hardlink or symlink image
154                  * extraction mode.   In these mode, all identical files are linked
155                  * together, and @extracted_file will be set to the filename of the
156                  * first extracted file containing this stream.  */
157                 tchar *extracted_file;
158         };
159
160         /* Pointers to somewhere where the stream is actually located.  See the
161          * comments for the @resource_location field above. */
162         union {
163                 WIMStruct *wim;
164                 tchar *file_on_disk;
165                 tchar *staging_file_name;
166                 void *attached_buffer;
167         #ifdef WITH_NTFS_3G
168                 struct ntfs_location *ntfs_loc;
169         #endif
170         };
171         union {
172                 /* @file_on_disk_fp and @attr are both used to cache file/stream
173                  * handles so we don't have re-open them on every read */
174
175
176                 /* Valid iff resource_location == RESOURCE_IN_FILE_ON_DISK */
177                 FILE *file_on_disk_fp;
178         #ifdef WITH_NTFS_3G
179                 /* Valid iff resource_location == RESOURCE_IN_NTFS_VOLUME */
180                 struct _ntfs_attr *attr;
181         #endif
182
183         #ifdef __WIN32__
184                 HANDLE win32_file_on_disk_fp;
185         #endif
186
187                 /* Pointer to inode that contains the opened file descriptors to
188                  * this stream (valid iff resource_location ==
189                  * RESOURCE_IN_STAGING_FILE) */
190                 struct wim_inode *lte_inode;
191         };
192
193         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
194          * whenever the file resource pointed to by this lookup table entry
195          * needs to be written.  The file resource only need to be written when
196          * out_refcnt is nonzero, since otherwise it is not referenced by any
197          * dentries. */
198         u32 out_refcnt;
199
200         u32 real_refcnt;
201
202         union {
203                 /* When a WIM file is written, @output_resource_entry is filled
204                  * in with the resource entry for the output WIM.  This will not
205                  * necessarily be the same as the @resource_entry since: - The
206                  * stream may have a different offset in the new WIM - The
207                  * stream may have a different compressed size in the new WIM if
208                  * the compression type changed
209                  */
210                 struct resource_entry output_resource_entry;
211
212                 struct list_head msg_list;
213                 struct list_head inode_list;
214         };
215
216         /* List of lookup table entries that correspond to streams that have
217          * been extracted to the staging directory when modifying a read-write
218          * mounted WIM.
219          *
220          * This field is also used to make other lists of lookup table entries.
221          * */
222         struct list_head staging_list;
223 };
224
225 static inline u64
226 wim_resource_size(const struct wim_lookup_table_entry *lte)
227 {
228         return lte->resource_entry.original_size;
229 }
230
231 static inline u64
232 wim_resource_chunks(const struct wim_lookup_table_entry *lte)
233 {
234         return (wim_resource_size(lte) + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
235 }
236
237 static inline u64
238 wim_resource_compressed_size(const struct wim_lookup_table_entry *lte)
239 {
240         return lte->resource_entry.size;
241 }
242
243 /*
244  * XXX Probably should store the compression type directly in the lookup table
245  * entry
246  */
247 static inline int
248 wim_resource_compression_type(const struct wim_lookup_table_entry *lte)
249 {
250         if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
251             || lte->resource_location != RESOURCE_IN_WIM)
252                 return WIMLIB_COMPRESSION_TYPE_NONE;
253         return wimlib_get_compression_type(lte->wim);
254 }
255
256
257 extern struct wim_lookup_table *
258 new_lookup_table(size_t capacity);
259
260 extern int
261 read_lookup_table(WIMStruct *w);
262
263 extern int
264 write_lookup_table(WIMStruct *w, int image, struct resource_entry *out_res_entry);
265
266 extern void
267 free_lookup_table(struct wim_lookup_table *table);
268
269 extern void
270 lookup_table_insert(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte);
271
272 /* Unlinks a lookup table entry from the table; does not free it. */
273 static inline void
274 lookup_table_unlink(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte)
275 {
276         hlist_del(&lte->hash_list);
277         wimlib_assert(table->num_entries != 0);
278         table->num_entries--;
279 }
280
281 extern struct wim_lookup_table_entry *
282 new_lookup_table_entry();
283
284 extern struct wim_lookup_table_entry *
285 clone_lookup_table_entry(const struct wim_lookup_table_entry *lte);
286
287 extern void
288 print_lookup_table_entry(const struct wim_lookup_table_entry *entry,
289                          FILE *out);
290
291 extern void
292 free_lookup_table_entry(struct wim_lookup_table_entry *lte);
293
294 extern int
295 for_lookup_table_entry(struct wim_lookup_table *table,
296                        int (*visitor)(struct wim_lookup_table_entry *, void *),
297                        void *arg);
298
299 extern int
300 sort_stream_list_by_wim_position(struct list_head *stream_list);
301
302 extern int
303 for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
304                                   int (*visitor)(struct wim_lookup_table_entry *,
305                                                  void *),
306                                   void *arg);
307
308 extern struct wim_lookup_table_entry *
309 __lookup_resource(const struct wim_lookup_table *table, const u8 hash[]);
310
311 extern int
312 lookup_resource(WIMStruct *w, const tchar *path,
313                 int lookup_flags, struct wim_dentry **dentry_ret,
314                 struct wim_lookup_table_entry **lte_ret, u16 *stream_idx_ret);
315
316 extern void
317 lte_decrement_refcnt(struct wim_lookup_table_entry *lte,
318                      struct wim_lookup_table *table);
319 #ifdef WITH_FUSE
320 extern void
321 lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte);
322 #endif
323
324 extern int
325 lte_zero_out_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
326
327 extern int
328 lte_zero_real_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
329
330 extern int
331 lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *ignore);
332
333 extern void
334 inode_resolve_ltes(struct wim_inode *inode, struct wim_lookup_table *table);
335
336 extern void
337 inode_unresolve_ltes(struct wim_inode *inode);
338
339 extern int
340 write_lookup_table_entry(struct wim_lookup_table_entry *lte, void *__out);
341
342 static inline struct resource_entry*
343 wim_metadata_resource_entry(WIMStruct *w)
344 {
345         return &w->image_metadata[
346                         w->current_image - 1].metadata_lte->resource_entry;
347 }
348
349 static inline struct wim_lookup_table_entry *
350 inode_stream_lte_resolved(const struct wim_inode *inode, unsigned stream_idx)
351 {
352         wimlib_assert(inode->i_resolved);
353         wimlib_assert(stream_idx <= inode->i_num_ads);
354         if (stream_idx == 0)
355                 return inode->i_lte;
356         else
357                 return inode->i_ads_entries[stream_idx - 1].lte;
358 }
359
360 static inline struct wim_lookup_table_entry *
361 inode_stream_lte_unresolved(const struct wim_inode *inode, unsigned stream_idx,
362                             const struct wim_lookup_table *table)
363 {
364         wimlib_assert(!inode->i_resolved);
365         wimlib_assert(stream_idx <= inode->i_num_ads);
366         if (!table)
367                 return NULL;
368         if (stream_idx == 0)
369                 return __lookup_resource(table, inode->i_hash);
370         else
371                 return __lookup_resource(table,
372                                          inode->i_ads_entries[
373                                                 stream_idx - 1].hash);
374 }
375
376 extern struct wim_lookup_table_entry *
377 inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx,
378                  const struct wim_lookup_table *table);
379
380 static inline const u8 *
381 inode_stream_hash_unresolved(const struct wim_inode *inode, unsigned stream_idx)
382 {
383         wimlib_assert(!inode->i_resolved);
384         wimlib_assert(stream_idx <= inode->i_num_ads);
385         if (stream_idx == 0)
386                 return inode->i_hash;
387         else
388                 return inode->i_ads_entries[stream_idx - 1].hash;
389 }
390
391
392 static inline const u8 *
393 inode_stream_hash_resolved(const struct wim_inode *inode, unsigned stream_idx)
394 {
395         struct wim_lookup_table_entry *lte;
396         lte = inode_stream_lte_resolved(inode, stream_idx);
397         if (lte)
398                 return lte->hash;
399         else
400                 return zero_hash;
401 }
402
403 /*
404  * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
405  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
406  * alternate data stream.
407  *
408  * This works for both resolved and un-resolved dentries.
409  */
410 static inline const u8 *
411 inode_stream_hash(const struct wim_inode *inode, unsigned stream_idx)
412 {
413         if (inode->i_resolved)
414                 return inode_stream_hash_resolved(inode, stream_idx);
415         else
416                 return inode_stream_hash_unresolved(inode, stream_idx);
417 }
418
419 static inline u16
420 inode_stream_name_nbytes(const struct wim_inode *inode, unsigned stream_idx)
421 {
422         wimlib_assert(stream_idx <= inode->i_num_ads);
423         if (stream_idx == 0)
424                 return 0;
425         else
426                 return inode->i_ads_entries[stream_idx - 1].stream_name_nbytes;
427 }
428
429 static inline struct wim_lookup_table_entry *
430 inode_unnamed_lte_resolved(const struct wim_inode *inode)
431 {
432         wimlib_assert(inode->i_resolved);
433         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
434                 if (inode_stream_name_nbytes(inode, i) == 0 &&
435                     !is_zero_hash(inode_stream_hash_resolved(inode, i)))
436                 {
437                         return inode_stream_lte_resolved(inode, i);
438                 }
439         }
440         return NULL;
441 }
442
443 static inline struct wim_lookup_table_entry *
444 inode_unnamed_lte_unresolved(const struct wim_inode *inode,
445                              const struct wim_lookup_table *table)
446 {
447         wimlib_assert(!inode->i_resolved);
448         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
449                 if (inode_stream_name_nbytes(inode, i) == 0 &&
450                     !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
451                 {
452                         return inode_stream_lte_unresolved(inode, i, table);
453                 }
454         }
455         return NULL;
456 }
457
458 extern struct wim_lookup_table_entry *
459 inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
460
461 extern u64
462 lookup_table_total_stream_size(struct wim_lookup_table *table);
463
464 #endif