Add more comments
[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         /* One of the `enum resource_location' values documented above. */
139         u16 resource_location : 5;
140
141         /* 1 if this stream is a unique size (only set while writing streams). */
142         u8 unique_size : 1;
143
144         /* 1 if this stream had a SHA1-message digest calculated for it yet? */
145         u8 unhashed : 1;
146
147         /* (On-disk field)
148          * Number of times this lookup table entry is referenced by dentries.
149          * Unfortunately, this field is not always set correctly in Microsoft's
150          * WIMs, so we have no choice but to fix it if more references to the
151          * lookup table entry are found than stated here. */
152         u32 refcnt;
153
154         union {
155                 /* (On-disk field) SHA1 message digest of the stream referenced
156                  * by this lookup table entry */
157                 u8  hash[SHA1_HASH_SIZE];
158
159                 /* First 4 or 8 bytes of the SHA1 message digest, used for
160                  * inserting the entry into the hash table.  Since the SHA1
161                  * message digest can be considered random, we don't really need
162                  * the full 20 byte hash just to insert the entry in a hash
163                  * table. */
164                 size_t hash_short;
165
166                 /* Unhashed entries only (unhashed == 1): these variables make
167                  * it possible to find the pointer to this 'struct
168                  * wim_lookup_table_entry' contained in either 'struct
169                  * wim_ads_entry' or 'struct wim_inode'.  There can be at most 1
170                  * such pointer, as we can only join duplicate streams after
171                  * they have been hashed.  */
172                 struct {
173                         struct wim_inode *back_inode;
174                         u32 back_stream_id;
175                 };
176         };
177
178         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
179          * whenever the stream pointed to by this lookup table entry needs to be
180          * written.  The stream only need to be written when out_refcnt is
181          * nonzero, since otherwise it is not referenced by any dentries. */
182         u32 out_refcnt;
183
184         /* Pointers to somewhere where the stream is actually located.  See the
185          * comments for the @resource_location field above. */
186         union {
187                 WIMStruct *wim;
188                 tchar *file_on_disk;
189                 void *attached_buffer;
190         #ifdef WITH_FUSE
191                 tchar *staging_file_name;
192         #endif
193         #ifdef WITH_NTFS_3G
194                 struct ntfs_location *ntfs_loc;
195         #endif
196         };
197
198         /* Actual reference count to this stream (only used while
199          * verifying an image). */
200         u32 real_refcnt;
201
202         union {
203         #ifdef WITH_FUSE
204                 /* Number of times this stream has been opened (used only during
205                  * mounting) */
206                 u16 num_opened_fds;
207         #endif
208
209                 /* This field is used for the special hardlink or symlink image
210                  * extraction mode.   In these mode, all identical files are linked
211                  * together, and @extracted_file will be set to the filename of the
212                  * first extracted file containing this stream.  */
213                 tchar *extracted_file;
214         };
215
216         union {
217                 /* When a WIM file is written, @output_resource_entry is filled
218                  * in with the resource entry for the output WIM.  This will not
219                  * necessarily be the same as the @resource_entry since: - The
220                  * stream may have a different offset in the new WIM - The
221                  * stream may have a different compressed size in the new WIM if
222                  * the compression type changed
223                  */
224                 struct resource_entry output_resource_entry;
225
226                 struct list_head msg_list;
227                 struct list_head inode_list;
228
229                 struct {
230                         struct hlist_node hash_list_2;
231
232                         struct list_head write_streams_list;
233                 };
234         };
235
236         /* Temporary list fields */
237         union {
238                 struct list_head unhashed_list;
239                 struct list_head swm_stream_list;
240                 struct list_head extraction_list;
241                 struct list_head export_stream_list;
242         };
243 };
244
245 static inline u64
246 wim_resource_size(const struct wim_lookup_table_entry *lte)
247 {
248         return lte->resource_entry.original_size;
249 }
250
251 static inline u64
252 wim_resource_chunks(const struct wim_lookup_table_entry *lte)
253 {
254         return (wim_resource_size(lte) + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
255 }
256
257 static inline u64
258 wim_resource_compressed_size(const struct wim_lookup_table_entry *lte)
259 {
260         return lte->resource_entry.size;
261 }
262
263 /*
264  * XXX Probably should store the compression type directly in the lookup table
265  * entry
266  */
267 static inline int
268 wim_resource_compression_type(const struct wim_lookup_table_entry *lte)
269 {
270         if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
271             || lte->resource_location != RESOURCE_IN_WIM)
272                 return WIMLIB_COMPRESSION_TYPE_NONE;
273         return wimlib_get_compression_type(lte->wim);
274 }
275
276 static inline bool
277 lte_filename_valid(const struct wim_lookup_table_entry *lte)
278 {
279         return lte->resource_location == RESOURCE_IN_FILE_ON_DISK
280         #ifdef __WIN32__
281                 || lte->resource_location == RESOURCE_WIN32
282                 || lte->resource_location == RESOURCE_WIN32_ENCRYPTED
283         #endif
284         #ifdef WITH_FUSE
285                 || lte->resource_location == RESOURCE_IN_STAGING_FILE
286         #endif
287                 ;
288 }
289
290 extern struct wim_lookup_table *
291 new_lookup_table(size_t capacity);
292
293 extern int
294 read_lookup_table(WIMStruct *w);
295
296 extern int
297 write_lookup_table(WIMStruct *w, int image, struct resource_entry *out_res_entry);
298
299 extern void
300 free_lookup_table(struct wim_lookup_table *table);
301
302 extern void
303 lookup_table_insert(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte);
304
305 /* Unlinks a lookup table entry from the table; does not free it. */
306 static inline void
307 lookup_table_unlink(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte)
308 {
309         wimlib_assert(!lte->unhashed);
310         hlist_del(&lte->hash_list);
311         wimlib_assert(table->num_entries != 0);
312         table->num_entries--;
313 }
314
315 extern struct wim_lookup_table_entry *
316 new_lookup_table_entry();
317
318 extern struct wim_lookup_table_entry *
319 clone_lookup_table_entry(const struct wim_lookup_table_entry *lte);
320
321 extern void
322 print_lookup_table_entry(const struct wim_lookup_table_entry *entry,
323                          FILE *out);
324
325 extern void
326 free_lookup_table_entry(struct wim_lookup_table_entry *lte);
327
328 extern int
329 for_lookup_table_entry(struct wim_lookup_table *table,
330                        int (*visitor)(struct wim_lookup_table_entry *, void *),
331                        void *arg);
332
333 extern int
334 cmp_streams_by_wim_position(const void *p1, const void *p2);
335
336 extern int
337 for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
338                                   int (*visitor)(struct wim_lookup_table_entry *,
339                                                  void *),
340                                   void *arg);
341
342 extern struct wim_lookup_table_entry *
343 __lookup_resource(const struct wim_lookup_table *table, const u8 hash[]);
344
345 extern int
346 lookup_resource(WIMStruct *w, const tchar *path,
347                 int lookup_flags, struct wim_dentry **dentry_ret,
348                 struct wim_lookup_table_entry **lte_ret, u16 *stream_idx_ret);
349
350 extern void
351 lte_decrement_refcnt(struct wim_lookup_table_entry *lte,
352                      struct wim_lookup_table *table);
353 #ifdef WITH_FUSE
354 extern void
355 lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte);
356 #endif
357
358 extern int
359 lte_zero_out_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
360
361 extern int
362 lte_zero_real_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
363
364 extern int
365 lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *ignore);
366
367 extern void
368 inode_resolve_ltes(struct wim_inode *inode, struct wim_lookup_table *table);
369
370 extern void
371 inode_unresolve_ltes(struct wim_inode *inode);
372
373 extern int
374 write_lookup_table_entry(struct wim_lookup_table_entry *lte, void *__out);
375
376 static inline struct wim_lookup_table_entry *
377 inode_stream_lte_resolved(const struct wim_inode *inode, unsigned stream_idx)
378 {
379         wimlib_assert(inode->i_resolved);
380         wimlib_assert(stream_idx <= inode->i_num_ads);
381         if (stream_idx == 0)
382                 return inode->i_lte;
383         else
384                 return inode->i_ads_entries[stream_idx - 1].lte;
385 }
386
387 static inline struct wim_lookup_table_entry *
388 inode_stream_lte_unresolved(const struct wim_inode *inode, unsigned stream_idx,
389                             const struct wim_lookup_table *table)
390 {
391         wimlib_assert(!inode->i_resolved);
392         wimlib_assert(stream_idx <= inode->i_num_ads);
393         if (!table)
394                 return NULL;
395         if (stream_idx == 0)
396                 return __lookup_resource(table, inode->i_hash);
397         else
398                 return __lookup_resource(table,
399                                          inode->i_ads_entries[
400                                                 stream_idx - 1].hash);
401 }
402
403 extern struct wim_lookup_table_entry *
404 inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx,
405                  const struct wim_lookup_table *table);
406
407 static inline const u8 *
408 inode_stream_hash_unresolved(const struct wim_inode *inode, unsigned stream_idx)
409 {
410         wimlib_assert(!inode->i_resolved);
411         wimlib_assert(stream_idx <= inode->i_num_ads);
412         if (stream_idx == 0)
413                 return inode->i_hash;
414         else
415                 return inode->i_ads_entries[stream_idx - 1].hash;
416 }
417
418
419 static inline const u8 *
420 inode_stream_hash_resolved(const struct wim_inode *inode, unsigned stream_idx)
421 {
422         struct wim_lookup_table_entry *lte;
423         lte = inode_stream_lte_resolved(inode, stream_idx);
424         if (lte)
425                 return lte->hash;
426         else
427                 return zero_hash;
428 }
429
430 /*
431  * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
432  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
433  * alternate data stream.
434  *
435  * This works for both resolved and un-resolved dentries.
436  */
437 static inline const u8 *
438 inode_stream_hash(const struct wim_inode *inode, unsigned stream_idx)
439 {
440         if (inode->i_resolved)
441                 return inode_stream_hash_resolved(inode, stream_idx);
442         else
443                 return inode_stream_hash_unresolved(inode, stream_idx);
444 }
445
446 static inline u16
447 inode_stream_name_nbytes(const struct wim_inode *inode, unsigned stream_idx)
448 {
449         wimlib_assert(stream_idx <= inode->i_num_ads);
450         if (stream_idx == 0)
451                 return 0;
452         else
453                 return inode->i_ads_entries[stream_idx - 1].stream_name_nbytes;
454 }
455
456 static inline struct wim_lookup_table_entry *
457 inode_unnamed_lte_resolved(const struct wim_inode *inode)
458 {
459         wimlib_assert(inode->i_resolved);
460         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
461                 if (inode_stream_name_nbytes(inode, i) == 0 &&
462                     !is_zero_hash(inode_stream_hash_resolved(inode, i)))
463                 {
464                         return inode_stream_lte_resolved(inode, i);
465                 }
466         }
467         return NULL;
468 }
469
470 static inline struct wim_lookup_table_entry *
471 inode_unnamed_lte_unresolved(const struct wim_inode *inode,
472                              const struct wim_lookup_table *table)
473 {
474         wimlib_assert(!inode->i_resolved);
475         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
476                 if (inode_stream_name_nbytes(inode, i) == 0 &&
477                     !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
478                 {
479                         return inode_stream_lte_unresolved(inode, i, table);
480                 }
481         }
482         return NULL;
483 }
484
485 extern struct wim_lookup_table_entry *
486 inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
487
488 extern u64
489 lookup_table_total_stream_size(struct wim_lookup_table *table);
490
491
492 static inline void
493 lookup_table_insert_unhashed(struct wim_lookup_table *table,
494                              struct wim_lookup_table_entry *lte,
495                              struct wim_inode *back_inode,
496                              u32 back_stream_id)
497 {
498         lte->unhashed = 1;
499         lte->back_inode = back_inode;
500         lte->back_stream_id = back_stream_id;
501         list_add_tail(&lte->unhashed_list, table->unhashed_streams);
502 }
503
504 extern int
505 hash_unhashed_stream(struct wim_lookup_table_entry *lte,
506                      struct wim_lookup_table *lookup_table,
507                      struct wim_lookup_table_entry **lte_ret);
508
509 extern struct wim_lookup_table_entry **
510 retrieve_lte_pointer(struct wim_lookup_table_entry *lte);
511
512 #endif