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