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