1 #ifndef _WIMLIB_BLOB_TABLE_H
2 #define _WIMLIB_BLOB_TABLE_H
4 #include "wimlib/list.h"
5 #include "wimlib/resource.h"
6 #include "wimlib/sha1.h"
7 #include "wimlib/types.h"
9 /* An enumerated type that identifies where a blob's data is located. */
12 /* The blob's data does not exist. This is a temporary state only. */
15 /* The blob's data is available in the WIM resource identified by the
16 * `struct wim_resource_descriptor' pointed to by @rdesc.
17 * @offset_in_res identifies the offset at which this particular blob
18 * begins in the uncompressed data of the resource. */
21 /* The blob's data is available as the contents of the file named by
25 /* The blob's data is available as the contents of the in-memory buffer
26 * pointed to by @attached_buffer. */
27 BLOB_IN_ATTACHED_BUFFER,
30 /* The blob's data is available as the contents of the file with name
31 * @staging_file_name relative to the open directory file descriptor
37 /* The blob's data is available as the contents of an NTFS attribute
38 * accessible through libntfs-3g. @ntfs_loc points to a structure which
39 * identifies the attribute. */
44 /* Windows only: the blob's data is available as the contents of the
45 * data stream named by @file_on_disk. @file_on_disk is an NT namespace
46 * path that may be longer than the Win32-level MAX_PATH. Furthermore,
47 * the stream may require "backup semantics" to access. */
48 BLOB_IN_WINNT_FILE_ON_DISK,
50 /* Windows only: the blob's data is available as the raw encrypted data
51 * of the external file named by @file_on_disk. @file_on_disk is a
52 * Win32 namespace path. */
57 /* A "blob extraction target" is a stream, and the inode to which that stream
58 * belongs, to which a blob needs to be extracted as part of an extraction
59 * operation. Since blobs are single-instanced, a blob may have multiple
60 * extraction targets. */
61 struct blob_extraction_target {
62 struct wim_inode *inode;
63 struct wim_inode_stream *stream;
67 * Descriptor for a "blob", which is a known length sequence of binary data.
69 * Within a WIM file, blobs are single instanced and are identified by SHA-1
72 struct blob_descriptor {
74 /* List node for a hash bucket of the blob table */
75 struct hlist_node hash_list;
77 /* Uncompressed size of this blob */
82 * For unhashed == 0: 'hash' is the SHA-1 message digest of the
83 * blob's data. 'hash_short' allows accessing just a prefix of
84 * the SHA-1 message digest, which is useful for getting a "hash
85 * code" for hash table lookup/insertion.
87 u8 hash[SHA1_HASH_SIZE];
90 /* For unhashed == 1: these variables make it possible to find
91 * the stream that references this blob. There can be at most
92 * one such reference, since duplicate blobs can only be joined
93 * after they have been hashed. */
95 struct wim_inode *back_inode;
100 /* Number of times this blob is referenced by file streams in WIM
101 * images. See blob_decrement_refcnt() for information about the
102 * limitations of this field. */
106 * When a WIM file is written, this is set to the number of references
107 * (from file streams) to this blob in the output WIM file.
109 * During extraction, this is set to the number of targets to which this
110 * blob is being extracted.
112 * During image export, this is set to the number of references of this
113 * blob that originated from the source WIM.
115 * When mounting a WIM image read-write, this is set to the number of
116 * extra references to this blob preemptively taken to allow later
117 * saving the modified image as a new image and leaving the original
123 /* Number of open file descriptors to this blob during a FUSE mount of
128 /* One of the `enum blob_location' values documented above. */
129 u16 blob_location : 4;
131 /* 1 iff this blob contains "metadata" as opposed to data. */
134 /* 1 iff the SHA-1 message digest of this blob is unknown. */
137 /* Temporary fields used when writing blobs; set as documented for
138 * prepare_blob_list_for_write(). */
140 u16 will_be_in_output_wim : 1;
142 /* Set to 1 if this blob represents a metadata resource that has been
143 * changed. In such cases, the hash cannot be used to verify the data
144 * if the metadata resource is read again. (This could be avoided if we
145 * used separate fields for input/output checksum, but most blobs
146 * wouldn't need this.) */
147 u16 dont_check_metadata_hash : 1;
149 u16 may_send_done_with_file : 1;
151 /* Only used by wimlib_export_image() */
152 u16 was_exported : 1;
154 /* Specification of where this blob's data is located. Which member of
155 * this union is valid is determined by the @blob_location field. */
159 struct wim_resource_descriptor *rdesc;
162 /* Links together blobs that share the same underlying
163 * WIM resource. The head is rdesc->blob_list. */
164 struct list_head rdesc_node;
171 /* BLOB_IN_FILE_ON_DISK
172 * BLOB_IN_WINNT_FILE_ON_DISK
173 * BLOB_WIN32_ENCRYPTED */
176 struct wim_inode *file_inode;
182 /* BLOB_IN_ATTACHED_BUFFER */
183 void *attached_buffer;
186 /* BLOB_IN_STAGING_FILE */
188 char *staging_file_name;
194 /* BLOB_IN_NTFS_VOLUME */
195 struct ntfs_location *ntfs_loc;
199 /* List link for per-WIM-image list of unhashed blobs */
200 struct list_head unhashed_list;
204 /* Temporary fields */
206 /* Fields used temporarily during WIM file writing. */
209 /* List node used for blob size table. */
210 struct hlist_node hash_list_2;
212 /* Metadata for the underlying solid resource in
213 * the WIM being written (only valid if
214 * WIM_RESHDR_FLAG_SOLID set in
215 * out_reshdr.flags). */
217 u64 out_res_offset_in_wim;
218 u64 out_res_size_in_wim;
219 u64 out_res_uncompressed_size;
223 /* Links blobs being written to the WIM. */
224 struct list_head write_blobs_list;
227 /* Metadata for this blob in the WIM being
229 struct wim_reshdr out_reshdr;
232 /* Name under which this blob is being
233 * sorted; used only when sorting blobs
234 * for solid compression. */
235 utf16lechar *solid_sort_name;
236 size_t solid_sort_name_nbytes;
241 /* Used temporarily during extraction. This is an array of
242 * references to the streams being extracted that use this blob.
243 * out_refcnt tracks the number of slots filled. */
245 struct blob_extraction_target inline_blob_extraction_targets[3];
247 struct blob_extraction_target *blob_extraction_targets;
248 u32 alloc_blob_extraction_targets;
253 /* Temporary list fields. */
255 /* Links blobs for writing blob table. */
256 struct list_head blob_table_list;
258 /* Links blobs being extracted. */
259 struct list_head extraction_list;
261 /* Links blobs being exported. */
262 struct list_head export_blob_list;
264 /* Links original list of blobs in the read-write mounted image. */
265 struct list_head orig_blob_list;
269 extern struct blob_table *
270 new_blob_table(size_t capacity) _malloc_attribute;
273 free_blob_table(struct blob_table *table);
276 read_blob_table(WIMStruct *wim);
279 write_blob_table_from_blob_list(struct list_head *blob_list,
280 struct filedes *out_fd,
282 struct wim_reshdr *out_reshdr,
283 int write_resource_flags);
285 extern struct blob_descriptor *
286 new_blob_descriptor(void) _malloc_attribute;
288 extern struct blob_descriptor *
289 clone_blob_descriptor(const struct blob_descriptor *blob) _malloc_attribute;
292 blob_decrement_refcnt(struct blob_descriptor *blob, struct blob_table *table);
295 blob_subtract_refcnt(struct blob_descriptor *blob, struct blob_table *table,
300 blob_decrement_num_opened_fds(struct blob_descriptor *blob);
304 free_blob_descriptor(struct blob_descriptor *blob);
307 blob_table_insert(struct blob_table *table, struct blob_descriptor *blob);
310 blob_table_unlink(struct blob_table *table, struct blob_descriptor *blob);
312 extern struct blob_descriptor *
313 lookup_blob(const struct blob_table *table, const u8 *hash);
316 for_blob_in_table(struct blob_table *table,
317 int (*visitor)(struct blob_descriptor *, void *), void *arg);
320 for_blob_in_table_sorted_by_sequential_order(struct blob_table *table,
321 int (*visitor)(struct blob_descriptor *, void *),
324 struct wimlib_resource_entry;
327 blob_to_wimlib_resource_entry(const struct blob_descriptor *blob,
328 struct wimlib_resource_entry *wentry);
331 sort_blob_list(struct list_head *blob_list,
332 size_t list_head_offset,
333 int (*compar)(const void *, const void*));
336 sort_blob_list_by_sequential_order(struct list_head *blob_list,
337 size_t list_head_offset);
340 cmp_blobs_by_sequential_order(const void *p1, const void *p2);
342 static inline const struct blob_extraction_target *
343 blob_extraction_targets(struct blob_descriptor *blob)
345 if (blob->out_refcnt <= ARRAY_LEN(blob->inline_blob_extraction_targets))
346 return blob->inline_blob_extraction_targets;
348 return blob->blob_extraction_targets;
352 * Declare that the specified blob is located in the specified WIM resource at
353 * the specified offset. The caller is expected to set blob->size if required.
356 blob_set_is_located_in_wim_resource(struct blob_descriptor *blob,
357 struct wim_resource_descriptor *rdesc,
360 blob->blob_location = BLOB_IN_WIM;
362 list_add_tail(&blob->rdesc_node, &rdesc->blob_list);
363 blob->offset_in_res = offset_in_res;
367 * Declare that the specified blob is located in the specified non-solid WIM
368 * resource. In this case, the blob data is the entire uncompressed resource.
371 blob_set_is_located_in_nonsolid_wim_resource(struct blob_descriptor *blob,
372 struct wim_resource_descriptor *rdesc)
374 blob_set_is_located_in_wim_resource(blob, rdesc, 0);
375 blob->size = rdesc->uncompressed_size;
379 blob_unset_is_located_in_wim_resource(struct blob_descriptor *blob)
381 list_del(&blob->rdesc_node);
382 blob->blob_location = BLOB_NONEXISTENT;
386 blob_set_is_located_in_attached_buffer(struct blob_descriptor *blob,
387 void *buffer, size_t size)
389 blob->blob_location = BLOB_IN_ATTACHED_BUFFER;
390 blob->attached_buffer = buffer;
394 extern struct blob_descriptor *
395 new_blob_from_data_buffer(const void *buffer, size_t size,
396 struct blob_table *blob_table);
398 extern struct blob_descriptor *
399 after_blob_hashed(struct blob_descriptor *blob,
400 struct blob_descriptor **back_ptr,
401 struct blob_table *blob_table);
404 hash_unhashed_blob(struct blob_descriptor *blob,
405 struct blob_table *blob_table,
406 struct blob_descriptor **blob_ret);
408 extern struct blob_descriptor **
409 retrieve_pointer_to_unhashed_blob(struct blob_descriptor *blob);
412 prepare_unhashed_blob(struct blob_descriptor *blob,
413 struct wim_inode *back_inode, u32 stream_id,
414 struct list_head *unhashed_blobs)
419 blob->back_inode = back_inode;
420 blob->back_stream_id = stream_id;
421 list_add_tail(&blob->unhashed_list, unhashed_blobs);
424 #endif /* _WIMLIB_BLOB_TABLE_H */