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