216565e1939b334f2e6c9ac576199683b9137045
[wimlib] / include / wimlib / lookup_table.h
1 #ifndef _WIMLIB_LOOKUP_TABLE_H
2 #define _WIMLIB_LOOKUP_TABLE_H
3
4 #include "wimlib/list.h"
5 #include "wimlib/resource.h"
6 #include "wimlib/sha1.h"
7 #include "wimlib/types.h"
8
9 /* An enumerated type that identifies where the stream corresponding to this
10  * lookup table entry is actually located.
11  *
12  * If we open a WIM and read its lookup table, the location is set to
13  * RESOURCE_IN_WIM since all the streams will initially be located in the WIM.
14  * However, to handle situations such as image capture and image mount, we allow
15  * the actual location of the stream to be somewhere else, such as an external
16  * file.  */
17 enum resource_location {
18         /* The lookup table entry does not yet correspond to a stream; this is a
19          * temporary state only.  */
20         RESOURCE_NONEXISTENT = 0,
21
22         /* The stream is located in a resource in a WIM file identified by the
23          * `struct wim_resource_spec' pointed to by @rspec.  @offset_in_res
24          * identifies the offset at which this particular stream begins in the
25          * uncompressed data of the resource; this is normally 0, but in general
26          * a WIM resource may be "packed" and potentially contain multiple
27          * streams.  */
28         RESOURCE_IN_WIM,
29
30         /* The stream is located in the external file named by @file_on_disk.
31          */
32         RESOURCE_IN_FILE_ON_DISK,
33
34         /* The stream is directly attached in the in-memory buffer pointed to by
35          * @attached_buffer.  */
36         RESOURCE_IN_ATTACHED_BUFFER,
37
38 #ifdef WITH_FUSE
39         /* The stream is located in the external file named by
40          * @staging_file_name, located in the staging directory for a read-write
41          * mount.  */
42         RESOURCE_IN_STAGING_FILE,
43 #endif
44
45 #ifdef WITH_NTFS_3G
46         /* The stream is located in an NTFS volume.  It is identified by volume,
47          * filename, data stream name, and by whether it is a reparse point or
48          * not.  @ntfs_loc points to a structure containing this information.
49          * */
50         RESOURCE_IN_NTFS_VOLUME,
51 #endif
52
53 #ifdef __WIN32__
54         /* Windows only: the stream is located in the external file named by
55          * @file_on_disk, which is in the Windows NT namespace and may specify a
56          * named data stream.  */
57         RESOURCE_IN_WINNT_FILE_ON_DISK,
58
59         /* Windows only: the stream is located in the external file named by
60          * @file_on_disk, but the file is encrypted and must be read using the
61          * appropriate Windows API.  */
62         RESOURCE_WIN32_ENCRYPTED,
63 #endif
64 };
65
66 struct stream_owner {
67         struct wim_inode *inode;
68         const utf16lechar *stream_name;
69 };
70
71 /* Specification for a stream, which may be the contents of a file (unnamed data
72  * stream), a named data stream, reparse point data, or a WIM metadata resource.
73  *
74  * One instance of this structure is created for each entry in the WIM's lookup
75  * table, hence the name of the struct.  Each of these entries contains the SHA1
76  * message digest of a stream and the location of the stream data in the WIM
77  * file (size, location, flags).  The in-memory lookup table is a map from SHA1
78  * message digests to stream locations.  */
79 struct wim_lookup_table_entry {
80
81         /* List node for a hash bucket of the lookup table.  */
82         struct hlist_node hash_list;
83
84         /* Uncompressed size of this stream.  */
85         u64 size;
86
87         /* Stream flags (WIM_RESHDR_FLAG_*).  */
88         u32 flags : 8;
89
90         /* One of the `enum resource_location' values documented above.  */
91         u32 resource_location : 4;
92
93         /* 1 if this stream has not had a SHA1 message digest calculated for it
94          * yet.  */
95         u32 unhashed : 1;
96
97         /* Temoorary fields used when writing streams; set as documented for
98          * prepare_stream_list_for_write().  */
99         u32 unique_size : 1;
100         u32 will_be_in_output_wim : 1;
101
102         /* Set to 1 when a metadata entry has its checksum changed; in such
103          * cases the hash cannot be used to verify the data if the metadata
104          * resource is read again.  (This could be avoided if we used separate
105          * fields for input/output checksum, but most stream entries wouldn't
106          * need this.)  */
107         u32 dont_check_metadata_hash : 1;
108
109         union {
110                 /* (On-disk field) SHA1 message digest of the stream referenced
111                  * by this lookup table entry.  */
112                 u8  hash[SHA1_HASH_SIZE];
113
114                 /* First 4 or 8 bytes of the SHA1 message digest, used for
115                  * inserting the entry into the hash table.  Since the SHA1
116                  * message digest can be considered random, we don't really need
117                  * the full 20 byte hash just to insert the entry in a hash
118                  * table.  */
119                 size_t hash_short;
120
121                 /* Unhashed entries only (unhashed == 1): these variables make
122                  * it possible to find the pointer to this 'struct
123                  * wim_lookup_table_entry' contained in either 'struct
124                  * wim_ads_entry' or 'struct wim_inode'.  There can be at most 1
125                  * such pointer, as we can only join duplicate streams after
126                  * they have been hashed.  */
127                 struct {
128                         struct wim_inode *back_inode;
129                         u32 back_stream_id;
130                 };
131         };
132
133         /* Number of times this lookup table entry is referenced by dentries in
134          * the WIM.  When a WIM's lookup table is read, this field is
135          * initialized from a corresponding entry; while it should be correct,
136          * in general it may not be.  wim_recalculate_refcnts() recalculates the
137          * reference counts for all streams and is run before doing any
138          * deletions.  */
139         u32 refcnt;
140
141         /* When a WIM file is written, this is set to the number of references
142          * (by dentries) to this stream in the output WIM file.
143          *
144          * During extraction, this is the number of slots in stream_owners (or
145          * inline_stream_owners) that have been filled.
146          *
147          * During image export, this is set to the number of references of this
148          * stream that originated from the source WIM.
149          *
150          * When mounting a WIM image read-write, this is set to the number of
151          * extra references to this stream preemptively taken to allow later
152          * saving the modified image as a new image and leaving the original
153          * image alone.  */
154         u32 out_refcnt;
155
156 #ifdef WITH_FUSE
157         /* Number of open file descriptors to this stream during a FUSE mount of
158          * the containing image.  */
159         u16 num_opened_fds;
160 #endif
161
162         /* Specification of where this stream is actually located.  Which member
163          * is valid is determined by the @resource_location field.  */
164         union {
165                 struct {
166                         struct wim_resource_spec *rspec;
167                         u64 offset_in_res;
168                 };
169                 tchar *file_on_disk;
170                 void *attached_buffer;
171         #ifdef WITH_FUSE
172                 tchar *staging_file_name;
173         #endif
174         #ifdef WITH_NTFS_3G
175                 struct ntfs_location *ntfs_loc;
176         #endif
177         };
178
179         /* Links together streams that share the same underlying WIM resource.
180          * The head is the `stream_list' member of `struct wim_resource_spec'.
181          */
182         struct list_head rspec_node;
183
184         /* Temporary fields  */
185         union {
186                 /* Fields used temporarily during WIM file writing.  */
187                 struct {
188                         union {
189                                 /* List node used for stream size table.  */
190                                 struct hlist_node hash_list_2;
191
192                                 /* Metadata for the underlying packed resource
193                                  * in the WIM being written (only valid if
194                                  * WIM_RESHDR_FLAG_PACKED_STREAMS set in
195                                  * out_reshdr.flags).  */
196                                 struct {
197                                         u64 out_res_offset_in_wim;
198                                         u64 out_res_size_in_wim;
199                                         u64 out_res_uncompressed_size;
200                                 };
201                         };
202
203                         /* Links streams being written to the WIM.  */
204                         struct list_head write_streams_list;
205
206                         /* Metadata for this stream in the WIM being written.
207                          */
208                         struct wim_reshdr out_reshdr;
209                 };
210
211                 /* Used temporarily during extraction.  This is an array of
212                  * pointers to the inodes being extracted that use this stream.
213                  */
214                 union {
215                         /* Inodes to extract that reference this stream.
216                          * out_refcnt tracks the number of slots filled.  */
217                         struct stream_owner inline_stream_owners[3];
218                         struct {
219                                 struct stream_owner *stream_owners;
220                                 u32 alloc_stream_owners;
221                         };
222                 };
223
224                 /* Actual reference count to this stream (only used while
225                  * verifying an image).  */
226                 u32 real_refcnt;
227         };
228
229         /* Temporary list fields.  */
230         union {
231                 /* Links streams for writing lookup table.  */
232                 struct list_head lookup_table_list;
233
234                 /* Links streams being extracted.  */
235                 struct list_head extraction_list;
236
237                 /* Links streams being exported.  */
238                 struct list_head export_stream_list;
239
240                 /* Links original list of streams in the read-write mounted image.  */
241                 struct list_head orig_stream_list;
242         };
243
244         /* Links streams that are still unhashed after being been added to a
245          * WIM.  */
246         struct list_head unhashed_list;
247 };
248
249 /* Functions to allocate and free lookup tables  */
250
251 extern struct wim_lookup_table *
252 new_lookup_table(size_t capacity) _malloc_attribute;
253
254 extern void
255 free_lookup_table(struct wim_lookup_table *table);
256
257 /* Functions to read or write the lookup table from/to a WIM file  */
258
259 extern int
260 read_wim_lookup_table(WIMStruct *wim);
261
262 extern int
263 write_wim_lookup_table_from_stream_list(struct list_head *stream_list,
264                                         struct filedes *out_fd,
265                                         u16 part_number,
266                                         struct wim_reshdr *out_reshdr,
267                                         int write_resource_flags);
268
269 /* Functions to create, clone, print, and free lookup table entries  */
270
271 extern struct wim_lookup_table_entry *
272 new_lookup_table_entry(void) _malloc_attribute;
273
274 extern struct wim_lookup_table_entry *
275 clone_lookup_table_entry(const struct wim_lookup_table_entry *lte)
276                         _malloc_attribute;
277
278 extern void
279 lte_decrement_refcnt(struct wim_lookup_table_entry *lte,
280                      struct wim_lookup_table *table);
281 #ifdef WITH_FUSE
282 extern void
283 lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte);
284 #endif
285
286 extern void
287 free_lookup_table_entry(struct wim_lookup_table_entry *lte);
288
289 /* Functions to insert and delete entries from a lookup table  */
290
291 extern void
292 lookup_table_insert(struct wim_lookup_table *table,
293                 struct wim_lookup_table_entry *lte);
294
295 extern void
296 lookup_table_unlink(struct wim_lookup_table *table,
297                     struct wim_lookup_table_entry *lte);
298
299 /* Function to lookup a stream by SHA1 message digest  */
300 extern struct wim_lookup_table_entry *
301 lookup_stream(const struct wim_lookup_table *table, const u8 hash[]);
302
303 /* Functions to iterate through the entries of a lookup table  */
304
305 extern int
306 for_lookup_table_entry(struct wim_lookup_table *table,
307                        int (*visitor)(struct wim_lookup_table_entry *, void *),
308                        void *arg);
309
310 extern int
311 for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
312                                   int (*visitor)(struct wim_lookup_table_entry *,
313                                                  void *),
314                                   void *arg);
315
316
317
318 /* Function to get a resource entry in stable format  */
319
320 struct wimlib_resource_entry;
321
322 extern void
323 lte_to_wimlib_resource_entry(const struct wim_lookup_table_entry *lte,
324                              struct wimlib_resource_entry *wentry);
325
326 /* Functions to sort a list of lookup table entries  */
327 extern int
328 sort_stream_list(struct list_head *stream_list,
329                  size_t list_head_offset,
330                  int (*compar)(const void *, const void*));
331
332 extern int
333 sort_stream_list_by_sequential_order(struct list_head *stream_list,
334                                      size_t list_head_offset);
335
336 /* Utility functions  */
337
338 extern int
339 lte_zero_out_refcnt(struct wim_lookup_table_entry *lte, void *ignore);
340
341 extern int
342 lte_zero_real_refcnt(struct wim_lookup_table_entry *lte, void *ignore);
343
344 static inline bool
345 lte_is_partial(const struct wim_lookup_table_entry * lte)
346 {
347         return lte->resource_location == RESOURCE_IN_WIM &&
348                lte->size != lte->rspec->uncompressed_size;
349 }
350
351 static inline bool
352 lte_filename_valid(const struct wim_lookup_table_entry *lte)
353 {
354         return     lte->resource_location == RESOURCE_IN_FILE_ON_DISK
355         #ifdef __WIN32__
356                 || lte->resource_location == RESOURCE_WIN32_ENCRYPTED
357         #endif
358         #ifdef WITH_FUSE
359                 || lte->resource_location == RESOURCE_IN_STAGING_FILE
360         #endif
361                 ;
362 }
363
364 static inline const struct stream_owner *
365 stream_owners(struct wim_lookup_table_entry *stream)
366 {
367         if (stream->out_refcnt <= ARRAY_LEN(stream->inline_stream_owners))
368                 return stream->inline_stream_owners;
369         else
370                 return stream->stream_owners;
371 }
372
373 static inline void
374 lte_bind_wim_resource_spec(struct wim_lookup_table_entry *lte,
375                            struct wim_resource_spec *rspec)
376 {
377         lte->resource_location = RESOURCE_IN_WIM;
378         lte->rspec = rspec;
379         list_add_tail(&lte->rspec_node, &rspec->stream_list);
380 }
381
382 static inline void
383 lte_unbind_wim_resource_spec(struct wim_lookup_table_entry *lte)
384 {
385         list_del(&lte->rspec_node);
386         lte->resource_location = RESOURCE_NONEXISTENT;
387 }
388
389 extern void
390 lte_put_resource(struct wim_lookup_table_entry *lte);
391
392 extern struct wim_lookup_table_entry *
393 new_stream_from_data_buffer(const void *buffer, size_t size,
394                             struct wim_lookup_table *lookup_table);
395
396 static inline void
397 add_unhashed_stream(struct wim_lookup_table_entry *lte,
398                     struct wim_inode *back_inode,
399                     u32 back_stream_id,
400                     struct list_head *unhashed_streams)
401 {
402         lte->unhashed = 1;
403         lte->back_inode = back_inode;
404         lte->back_stream_id = back_stream_id;
405         list_add_tail(&lte->unhashed_list, unhashed_streams);
406 }
407
408 extern int
409 hash_unhashed_stream(struct wim_lookup_table_entry *lte,
410                      struct wim_lookup_table *lookup_table,
411                      struct wim_lookup_table_entry **lte_ret);
412
413 extern struct wim_lookup_table_entry **
414 retrieve_lte_pointer(struct wim_lookup_table_entry *lte);
415
416 #endif /* _WIMLIB_LOOKUP_TABLE_H */