39193b42651dde1fee6eaf54236f8d7732b5ba2d
[wimlib] / src / blob_table.c
1 /*
2  * blob_table.c
3  *
4  * A blob table maps SHA-1 message digests to "blobs", which are nonempty
5  * sequences of binary data.  Within a WIM file, blobs are single-instanced.
6  *
7  * This file also contains code to read and write the corresponding on-disk
8  * representation of this table in the WIM file format.
9  */
10
11 /*
12  * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
13  *
14  * This file is free software; you can redistribute it and/or modify it under
15  * the terms of the GNU Lesser General Public License as published by the Free
16  * Software Foundation; either version 3 of the License, or (at your option) any
17  * later version.
18  *
19  * This file is distributed in the hope that it will be useful, but WITHOUT
20  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
22  * details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with this file; if not, see http://www.gnu.org/licenses/.
26  */
27
28 #ifdef HAVE_CONFIG_H
29 #  include "config.h"
30 #endif
31
32 #include <stdlib.h>
33 #include <string.h>
34 #include <unistd.h> /* for unlink()  */
35
36 #include "wimlib/assert.h"
37 #include "wimlib/bitops.h"
38 #include "wimlib/blob_table.h"
39 #include "wimlib/encoding.h"
40 #include "wimlib/endianness.h"
41 #include "wimlib/error.h"
42 #include "wimlib/metadata.h"
43 #include "wimlib/ntfs_3g.h"
44 #include "wimlib/resource.h"
45 #include "wimlib/unaligned.h"
46 #include "wimlib/util.h"
47 #include "wimlib/write.h"
48
49 /* A hash table mapping SHA-1 message digests to blob descriptors  */
50 struct blob_table {
51         struct hlist_head *array;
52         size_t num_blobs;
53         size_t mask; /* capacity - 1; capacity is a power of 2  */
54 };
55
56 static size_t
57 next_power_of_2(size_t n)
58 {
59         if (n <= 1)
60                 return 1;
61         return (size_t)1 << (1 + flsw(n - 1));
62 }
63
64 struct blob_table *
65 new_blob_table(size_t capacity)
66 {
67         struct blob_table *table;
68         struct hlist_head *array;
69
70         capacity = next_power_of_2(capacity);
71
72         table = MALLOC(sizeof(struct blob_table));
73         if (table == NULL)
74                 goto oom;
75
76         array = CALLOC(capacity, sizeof(array[0]));
77         if (array == NULL) {
78                 FREE(table);
79                 goto oom;
80         }
81
82         table->num_blobs = 0;
83         table->mask = capacity - 1;
84         table->array = array;
85         return table;
86
87 oom:
88         ERROR("Failed to allocate memory for blob table "
89               "with capacity %zu", capacity);
90         return NULL;
91 }
92
93 static int
94 do_free_blob_descriptor(struct blob_descriptor *blob, void *_ignore)
95 {
96         free_blob_descriptor(blob);
97         return 0;
98 }
99
100 void
101 free_blob_table(struct blob_table *table)
102 {
103         if (table) {
104                 for_blob_in_table(table, do_free_blob_descriptor, NULL);
105                 FREE(table->array);
106                 FREE(table);
107         }
108 }
109
110 struct blob_descriptor *
111 new_blob_descriptor(void)
112 {
113         STATIC_ASSERT(BLOB_NONEXISTENT == 0);
114         return CALLOC(1, sizeof(struct blob_descriptor));
115 }
116
117 struct blob_descriptor *
118 clone_blob_descriptor(const struct blob_descriptor *old)
119 {
120         struct blob_descriptor *new;
121
122         new = memdup(old, sizeof(struct blob_descriptor));
123         if (new == NULL)
124                 return NULL;
125
126         switch (new->blob_location) {
127         case BLOB_IN_WIM:
128                 list_add(&new->rdesc_node, &new->rdesc->blob_list);
129                 break;
130
131         case BLOB_IN_FILE_ON_DISK:
132 #ifdef __WIN32__
133         case BLOB_IN_WINNT_FILE_ON_DISK:
134         case BLOB_WIN32_ENCRYPTED:
135 #endif
136 #ifdef WITH_FUSE
137         case BLOB_IN_STAGING_FILE:
138                 STATIC_ASSERT((void*)&old->file_on_disk ==
139                               (void*)&old->staging_file_name);
140 #endif
141                 new->file_on_disk = TSTRDUP(old->file_on_disk);
142                 if (new->file_on_disk == NULL)
143                         goto out_free;
144                 break;
145         case BLOB_IN_ATTACHED_BUFFER:
146                 new->attached_buffer = memdup(old->attached_buffer, old->size);
147                 if (new->attached_buffer == NULL)
148                         goto out_free;
149                 break;
150 #ifdef WITH_NTFS_3G
151         case BLOB_IN_NTFS_VOLUME:
152                 new->ntfs_loc = clone_ntfs_location(old->ntfs_loc);
153                 if (!new->ntfs_loc)
154                         goto out_free;
155                 break;
156 #endif
157         }
158         return new;
159
160 out_free:
161         free_blob_descriptor(new);
162         return NULL;
163 }
164
165 /* Release a blob descriptor from its location, if any, and set its new location
166  * to BLOB_NONEXISTENT.  */
167 void
168 blob_release_location(struct blob_descriptor *blob)
169 {
170         switch (blob->blob_location) {
171         case BLOB_IN_WIM:
172                 list_del(&blob->rdesc_node);
173                 if (list_empty(&blob->rdesc->blob_list))
174                         FREE(blob->rdesc);
175                 break;
176         case BLOB_IN_FILE_ON_DISK:
177 #ifdef __WIN32__
178         case BLOB_IN_WINNT_FILE_ON_DISK:
179         case BLOB_WIN32_ENCRYPTED:
180 #endif
181 #ifdef WITH_FUSE
182         case BLOB_IN_STAGING_FILE:
183                 STATIC_ASSERT((void*)&blob->file_on_disk ==
184                               (void*)&blob->staging_file_name);
185 #endif
186         case BLOB_IN_ATTACHED_BUFFER:
187                 STATIC_ASSERT((void*)&blob->file_on_disk ==
188                               (void*)&blob->attached_buffer);
189                 FREE(blob->file_on_disk);
190                 break;
191 #ifdef WITH_NTFS_3G
192         case BLOB_IN_NTFS_VOLUME:
193                 if (blob->ntfs_loc)
194                         free_ntfs_location(blob->ntfs_loc);
195                 break;
196 #endif
197         }
198         blob->blob_location = BLOB_NONEXISTENT;
199 }
200
201 void
202 free_blob_descriptor(struct blob_descriptor *blob)
203 {
204         if (blob) {
205                 blob_release_location(blob);
206                 FREE(blob);
207         }
208 }
209
210 /* Should this blob be retained even if it has no references?  */
211 static bool
212 should_retain_blob(const struct blob_descriptor *blob)
213 {
214         return blob->blob_location == BLOB_IN_WIM;
215 }
216
217 static void
218 finalize_blob(struct blob_descriptor *blob)
219 {
220         if (!should_retain_blob(blob))
221                 free_blob_descriptor(blob);
222 }
223
224 /*
225  * Decrements the reference count of the specified blob, which must be either
226  * (a) unhashed, or (b) inserted in the specified blob table.
227  *
228  * If the blob's reference count reaches 0, we may unlink it from @table and
229  * free it.  However, we retain blobs with 0 reference count that originated
230  * from WIM files (BLOB_IN_WIM).  We do this for two reasons:
231  *
232  * 1. This prevents information about valid blobs in a WIM file --- blobs which
233  *    will continue to be present after appending to the WIM file --- from being
234  *    lost merely because we dropped all references to them.
235  *
236  * 2. Blob reference counts we read from WIM files can't be trusted.  It's
237  *    possible that a WIM has reference counts that are too low; WIMGAPI
238  *    sometimes creates WIMs where this is the case.  It's also possible that
239  *    blobs have been referenced from an external WIM; those blobs can
240  *    potentially have any reference count at all, either lower or higher than
241  *    would be expected for this WIM ("this WIM" meaning the owner of @table) if
242  *    it were a standalone WIM.
243  *
244  * So we can't take the reference counts too seriously.  But at least, we do
245  * recalculate by default when writing a new WIM file.
246  */
247 void
248 blob_decrement_refcnt(struct blob_descriptor *blob, struct blob_table *table)
249 {
250         blob_subtract_refcnt(blob, table, 1);
251 }
252
253 void
254 blob_subtract_refcnt(struct blob_descriptor *blob, struct blob_table *table,
255                      u32 count)
256 {
257         if (unlikely(blob->refcnt < count)) {
258                 blob->refcnt = 0; /* See comment above  */
259                 return;
260         }
261
262         blob->refcnt -= count;
263
264         if (blob->refcnt != 0)
265                 return;
266
267         if (blob->unhashed) {
268                 list_del(&blob->unhashed_list);
269         #ifdef WITH_FUSE
270                 /* If the blob has been extracted to a staging file for a FUSE
271                  * mount, unlink the staging file.  (Note that there still may
272                  * be open file descriptors to it.)  */
273                 if (blob->blob_location == BLOB_IN_STAGING_FILE)
274                         unlinkat(blob->staging_dir_fd,
275                                  blob->staging_file_name, 0);
276         #endif
277         } else {
278                 if (!should_retain_blob(blob))
279                         blob_table_unlink(table, blob);
280         }
281
282         /* If FUSE mounts are enabled, then don't actually free the blob
283          * descriptor until the last file descriptor to it has been closed.  */
284 #ifdef WITH_FUSE
285         if (blob->num_opened_fds == 0)
286 #endif
287                 finalize_blob(blob);
288 }
289
290 #ifdef WITH_FUSE
291 void
292 blob_decrement_num_opened_fds(struct blob_descriptor *blob)
293 {
294         wimlib_assert(blob->num_opened_fds != 0);
295
296         if (--blob->num_opened_fds == 0 && blob->refcnt == 0)
297                 finalize_blob(blob);
298 }
299 #endif
300
301 static void
302 blob_table_insert_raw(struct blob_table *table, struct blob_descriptor *blob)
303 {
304         size_t i = blob->hash_short & table->mask;
305
306         hlist_add_head(&blob->hash_list, &table->array[i]);
307 }
308
309 static void
310 enlarge_blob_table(struct blob_table *table)
311 {
312         size_t old_capacity, new_capacity;
313         struct hlist_head *old_array, *new_array;
314         struct blob_descriptor *blob;
315         struct hlist_node *tmp;
316         size_t i;
317
318         old_capacity = table->mask + 1;
319         new_capacity = old_capacity * 2;
320         new_array = CALLOC(new_capacity, sizeof(struct hlist_head));
321         if (new_array == NULL)
322                 return;
323         old_array = table->array;
324         table->array = new_array;
325         table->mask = new_capacity - 1;
326
327         for (i = 0; i < old_capacity; i++)
328                 hlist_for_each_entry_safe(blob, tmp, &old_array[i], hash_list)
329                         blob_table_insert_raw(table, blob);
330         FREE(old_array);
331 }
332
333 /* Insert a blob descriptor into the blob table.  */
334 void
335 blob_table_insert(struct blob_table *table, struct blob_descriptor *blob)
336 {
337         blob_table_insert_raw(table, blob);
338         if (table->num_blobs++ > table->mask)
339                 enlarge_blob_table(table);
340 }
341
342 /* Unlinks a blob descriptor from the blob table; does not free it.  */
343 void
344 blob_table_unlink(struct blob_table *table, struct blob_descriptor *blob)
345 {
346         wimlib_assert(!blob->unhashed);
347         wimlib_assert(table->num_blobs != 0);
348
349         hlist_del(&blob->hash_list);
350         table->num_blobs--;
351 }
352
353 /* Given a SHA-1 message digest, return the corresponding blob descriptor from
354  * the specified blob table, or NULL if there is none.  */
355 struct blob_descriptor *
356 lookup_blob(const struct blob_table *table, const u8 *hash)
357 {
358         size_t i;
359         struct blob_descriptor *blob;
360
361         i = load_size_t_unaligned(hash) & table->mask;
362         hlist_for_each_entry(blob, &table->array[i], hash_list)
363                 if (hashes_equal(hash, blob->hash))
364                         return blob;
365         return NULL;
366 }
367
368 /* Call a function on all blob descriptors in the specified blob table.  Stop
369  * early and return nonzero if any call to the function returns nonzero.  */
370 int
371 for_blob_in_table(struct blob_table *table,
372                   int (*visitor)(struct blob_descriptor *, void *), void *arg)
373 {
374         struct blob_descriptor *blob;
375         struct hlist_node *tmp;
376         int ret;
377
378         for (size_t i = 0; i <= table->mask; i++) {
379                 hlist_for_each_entry_safe(blob, tmp, &table->array[i],
380                                           hash_list)
381                 {
382                         ret = visitor(blob, arg);
383                         if (ret)
384                                 return ret;
385                 }
386         }
387         return 0;
388 }
389
390 /*
391  * This is a qsort() callback that sorts blobs into an order optimized for
392  * reading.  Sorting is done primarily by blob location, then secondarily by a
393  * location-dependent order.  For example, blobs in WIM resources are sorted
394  * such that the underlying WIM files will be read sequentially.  This is
395  * especially important for WIM files containing solid resources.
396  */
397 int
398 cmp_blobs_by_sequential_order(const void *p1, const void *p2)
399 {
400         const struct blob_descriptor *blob1, *blob2;
401         int v;
402         WIMStruct *wim1, *wim2;
403
404         blob1 = *(const struct blob_descriptor**)p1;
405         blob2 = *(const struct blob_descriptor**)p2;
406
407         v = (int)blob1->blob_location - (int)blob2->blob_location;
408
409         /* Different locations?  Note: "unsafe compaction mode" requires that
410          * blobs in WIMs sort before all others.  For the logic here to ensure
411          * this, BLOB_IN_WIM must have the lowest value among all defined
412          * blob_locations.  Statically verify that the enum values haven't
413          * changed.  */
414         STATIC_ASSERT(BLOB_NONEXISTENT == 0 && BLOB_IN_WIM == 1);
415         if (v)
416                 return v;
417
418         switch (blob1->blob_location) {
419         case BLOB_IN_WIM:
420                 wim1 = blob1->rdesc->wim;
421                 wim2 = blob2->rdesc->wim;
422
423                 /* Different WIM files?  */
424                 if (wim1 != wim2) {
425
426                         /* Resources from the WIM file currently being compacted
427                          * (if any) must always sort first.  */
428                         v = (int)wim2->being_compacted - (int)wim1->being_compacted;
429                         if (v)
430                                 return v;
431
432                         /* Different split WIMs?  */
433                         v = cmp_guids(wim1->hdr.guid, wim2->hdr.guid);
434                         if (v)
435                                 return v;
436
437                         /* Different part numbers in the same split WIM?  */
438                         v = (int)wim1->hdr.part_number - (int)wim2->hdr.part_number;
439                         if (v)
440                                 return v;
441
442                         /* Probably two WIMStructs for the same on-disk file.
443                          * Just sort by pointer.  */
444                         return wim1 < wim2 ? -1 : 1;
445                 }
446
447                 /* Same WIM file  */
448
449                 /* Sort by increasing resource offset  */
450                 if (blob1->rdesc->offset_in_wim != blob2->rdesc->offset_in_wim)
451                         return cmp_u64(blob1->rdesc->offset_in_wim,
452                                        blob2->rdesc->offset_in_wim);
453
454                 /* The blobs are in the same solid resource.  Sort by increasing
455                  * offset in the resource.  */
456                 return cmp_u64(blob1->offset_in_res, blob2->offset_in_res);
457
458         case BLOB_IN_FILE_ON_DISK:
459 #ifdef WITH_FUSE
460         case BLOB_IN_STAGING_FILE:
461 #endif
462 #ifdef __WIN32__
463         case BLOB_IN_WINNT_FILE_ON_DISK:
464         case BLOB_WIN32_ENCRYPTED:
465                 /* Windows: compare by starting LCN (logical cluster number)  */
466                 v = cmp_u64(blob1->sort_key, blob2->sort_key);
467                 if (v)
468                         return v;
469 #endif
470                 /* Compare files by path: just a heuristic that will place files
471                  * in the same directory next to each other.  */
472                 return tstrcmp(blob1->file_on_disk, blob2->file_on_disk);
473 #ifdef WITH_NTFS_3G
474         case BLOB_IN_NTFS_VOLUME:
475                 return cmp_ntfs_locations(blob1->ntfs_loc, blob2->ntfs_loc);
476 #endif
477         default:
478                 /* No additional sorting order defined for this resource
479                  * location (e.g. BLOB_IN_ATTACHED_BUFFER); simply compare
480                  * everything equal to each other.  */
481                 return 0;
482         }
483 }
484
485 int
486 sort_blob_list(struct list_head *blob_list, size_t list_head_offset,
487                int (*compar)(const void *, const void*))
488 {
489         struct list_head *cur;
490         struct blob_descriptor **array;
491         size_t i;
492         size_t array_size;
493         size_t num_blobs = 0;
494
495         list_for_each(cur, blob_list)
496                 num_blobs++;
497
498         if (num_blobs <= 1)
499                 return 0;
500
501         array_size = num_blobs * sizeof(array[0]);
502         array = MALLOC(array_size);
503         if (array == NULL)
504                 return WIMLIB_ERR_NOMEM;
505
506         cur = blob_list->next;
507         for (i = 0; i < num_blobs; i++) {
508                 array[i] = (struct blob_descriptor*)((u8*)cur - list_head_offset);
509                 cur = cur->next;
510         }
511
512         qsort(array, num_blobs, sizeof(array[0]), compar);
513
514         INIT_LIST_HEAD(blob_list);
515         for (i = 0; i < num_blobs; i++) {
516                 list_add_tail((struct list_head*)
517                                ((u8*)array[i] + list_head_offset), blob_list);
518         }
519         FREE(array);
520         return 0;
521 }
522
523 /* Sort the specified list of blobs in an order optimized for sequential
524  * reading.  */
525 int
526 sort_blob_list_by_sequential_order(struct list_head *blob_list,
527                                    size_t list_head_offset)
528 {
529         return sort_blob_list(blob_list, list_head_offset,
530                               cmp_blobs_by_sequential_order);
531 }
532
533 static int
534 add_blob_to_array(struct blob_descriptor *blob, void *_pp)
535 {
536         struct blob_descriptor ***pp = _pp;
537         *(*pp)++ = blob;
538         return 0;
539 }
540
541 /* Iterate through the blob descriptors in the specified blob table in an order
542  * optimized for sequential reading.  */
543 int
544 for_blob_in_table_sorted_by_sequential_order(struct blob_table *table,
545                                              int (*visitor)(struct blob_descriptor *, void *),
546                                              void *arg)
547 {
548         struct blob_descriptor **blob_array, **p;
549         size_t num_blobs = table->num_blobs;
550         int ret;
551
552         blob_array = MALLOC(num_blobs * sizeof(blob_array[0]));
553         if (!blob_array)
554                 return WIMLIB_ERR_NOMEM;
555         p = blob_array;
556         for_blob_in_table(table, add_blob_to_array, &p);
557
558         wimlib_assert(p == blob_array + num_blobs);
559
560         qsort(blob_array, num_blobs, sizeof(blob_array[0]),
561               cmp_blobs_by_sequential_order);
562         ret = 0;
563         for (size_t i = 0; i < num_blobs; i++) {
564                 ret = visitor(blob_array[i], arg);
565                 if (ret)
566                         break;
567         }
568         FREE(blob_array);
569         return ret;
570 }
571
572 /* On-disk format of a blob descriptor in a WIM file.
573  *
574  * Note: if the WIM file contains solid resource(s), then this structure is
575  * sometimes overloaded to describe a "resource" rather than a "blob".  See the
576  * code for details.  */
577 struct blob_descriptor_disk {
578
579         /* Size, offset, and flags of the blob.  */
580         struct wim_reshdr_disk reshdr;
581
582         /* Which part of the split WIM this blob is in; indexed from 1. */
583         le16 part_number;
584
585         /* Reference count of this blob over all WIM images.  (But see comment
586          * above blob_decrement_refcnt().)  */
587         le32 refcnt;
588
589         /* SHA-1 message digest of the uncompressed data of this blob, or all
590          * zeroes if this blob is of zero length.  */
591         u8 hash[SHA1_HASH_SIZE];
592 } _packed_attribute;
593
594 /* Given a nonempty run of consecutive blob descriptors with the SOLID flag set,
595  * count how many specify resources (as opposed to blobs within those
596  * resources).
597  *
598  * Returns the resulting count.  */
599 static size_t
600 count_solid_resources(const struct blob_descriptor_disk *entries, size_t max)
601 {
602         size_t count = 0;
603         do {
604                 struct wim_reshdr reshdr;
605
606                 get_wim_reshdr(&(entries++)->reshdr, &reshdr);
607
608                 if (!(reshdr.flags & WIM_RESHDR_FLAG_SOLID)) {
609                         /* Run was terminated by a stand-alone blob entry.  */
610                         break;
611                 }
612
613                 if (reshdr.uncompressed_size == SOLID_RESOURCE_MAGIC_NUMBER) {
614                         /* This is a resource entry.  */
615                         count++;
616                 }
617         } while (--max);
618         return count;
619 }
620
621 /*
622  * Given a run of consecutive blob descriptors with the SOLID flag set and
623  * having @num_rdescs resource entries, load resource information from them into
624  * the resource descriptors in the @rdescs array.
625  *
626  * Returns 0 on success, or a nonzero error code on failure.
627  */
628 static int
629 do_load_solid_info(WIMStruct *wim, struct wim_resource_descriptor **rdescs,
630                    size_t num_rdescs,
631                    const struct blob_descriptor_disk *entries)
632 {
633         for (size_t i = 0; i < num_rdescs; i++) {
634                 struct wim_reshdr reshdr;
635                 struct alt_chunk_table_header_disk hdr;
636                 struct wim_resource_descriptor *rdesc;
637                 int ret;
638
639                 /* Advance to next resource entry.  */
640
641                 do {
642                         get_wim_reshdr(&(entries++)->reshdr, &reshdr);
643                 } while (reshdr.uncompressed_size != SOLID_RESOURCE_MAGIC_NUMBER);
644
645                 rdesc = rdescs[i];
646
647                 wim_reshdr_to_desc(&reshdr, wim, rdesc);
648
649                 /* For solid resources, the uncompressed size, compression type,
650                  * and chunk size are stored in the resource itself, not in the
651                  * blob table.  */
652
653                 ret = full_pread(&wim->in_fd, &hdr,
654                                  sizeof(hdr), reshdr.offset_in_wim);
655                 if (ret) {
656                         ERROR("Failed to read header of solid resource "
657                               "(offset_in_wim=%"PRIu64")",
658                               reshdr.offset_in_wim);
659                         return ret;
660                 }
661
662                 rdesc->uncompressed_size = le64_to_cpu(hdr.res_usize);
663
664                 /* Compression format numbers must be the same as in
665                  * WIMGAPI to be compatible here.  */
666                 STATIC_ASSERT(WIMLIB_COMPRESSION_TYPE_NONE == 0);
667                 STATIC_ASSERT(WIMLIB_COMPRESSION_TYPE_XPRESS == 1);
668                 STATIC_ASSERT(WIMLIB_COMPRESSION_TYPE_LZX == 2);
669                 STATIC_ASSERT(WIMLIB_COMPRESSION_TYPE_LZMS == 3);
670                 rdesc->compression_type = le32_to_cpu(hdr.compression_format);
671                 rdesc->chunk_size = le32_to_cpu(hdr.chunk_size);
672         }
673         return 0;
674 }
675
676 /*
677  * Given a nonempty run of consecutive blob descriptors with the SOLID flag set,
678  * allocate a 'struct wim_resource_descriptor' for each resource within that
679  * run.
680  *
681  * Returns 0 on success, or a nonzero error code on failure.
682  * Returns the pointers and count in *rdescs_ret and *num_rdescs_ret.
683  */
684 static int
685 load_solid_info(WIMStruct *wim,
686                 const struct blob_descriptor_disk *entries,
687                 size_t num_remaining_entries,
688                 struct wim_resource_descriptor ***rdescs_ret,
689                 size_t *num_rdescs_ret)
690 {
691         size_t num_rdescs;
692         struct wim_resource_descriptor **rdescs;
693         size_t i;
694         int ret;
695
696         num_rdescs = count_solid_resources(entries, num_remaining_entries);
697         rdescs = CALLOC(num_rdescs, sizeof(rdescs[0]));
698         if (!rdescs)
699                 return WIMLIB_ERR_NOMEM;
700
701         for (i = 0; i < num_rdescs; i++) {
702                 rdescs[i] = MALLOC(sizeof(struct wim_resource_descriptor));
703                 if (!rdescs[i]) {
704                         ret = WIMLIB_ERR_NOMEM;
705                         goto out_free_rdescs;
706                 }
707         }
708
709         ret = do_load_solid_info(wim, rdescs, num_rdescs, entries);
710         if (ret)
711                 goto out_free_rdescs;
712
713         *rdescs_ret = rdescs;
714         *num_rdescs_ret = num_rdescs;
715         return 0;
716
717 out_free_rdescs:
718         for (i = 0; i < num_rdescs; i++)
719                 FREE(rdescs[i]);
720         FREE(rdescs);
721         return ret;
722 }
723
724 /* Given a 'struct blob_descriptor' allocated for an on-disk blob descriptor
725  * with the SOLID flag set, try to assign it to resource in the current solid
726  * run.  */
727 static int
728 assign_blob_to_solid_resource(const struct wim_reshdr *reshdr,
729                               struct blob_descriptor *blob,
730                               struct wim_resource_descriptor **rdescs,
731                               size_t num_rdescs)
732 {
733         u64 offset = reshdr->offset_in_wim;
734
735         /* XXX: This linear search will be slow in the degenerate case where the
736          * number of solid resources in the run is huge.  */
737         blob->size = reshdr->size_in_wim;
738         for (size_t i = 0; i < num_rdescs; i++) {
739                 if (offset + blob->size <= rdescs[i]->uncompressed_size) {
740                         blob_set_is_located_in_wim_resource(blob, rdescs[i], offset);
741                         return 0;
742                 }
743                 offset -= rdescs[i]->uncompressed_size;
744         }
745         ERROR("blob could not be assigned to a solid resource");
746         return WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
747 }
748
749 static void
750 free_solid_rdescs(struct wim_resource_descriptor **rdescs, size_t num_rdescs)
751 {
752         if (rdescs) {
753                 for (size_t i = 0; i < num_rdescs; i++)
754                         if (list_empty(&rdescs[i]->blob_list))
755                                 FREE(rdescs[i]);
756                 FREE(rdescs);
757         }
758 }
759
760 static int
761 cmp_blobs_by_offset_in_res(const void *p1, const void *p2)
762 {
763         const struct blob_descriptor *blob1, *blob2;
764
765         blob1 = *(const struct blob_descriptor**)p1;
766         blob2 = *(const struct blob_descriptor**)p2;
767
768         return cmp_u64(blob1->offset_in_res, blob2->offset_in_res);
769 }
770
771 /* Validate the size and location of a WIM resource.  */
772 static int
773 validate_resource(struct wim_resource_descriptor *rdesc)
774 {
775         struct blob_descriptor *blob;
776         bool out_of_order;
777         u64 expected_next_offset;
778         int ret;
779
780         /* Verify that the resource itself has a valid offset and size.  */
781         if (rdesc->offset_in_wim + rdesc->size_in_wim < rdesc->size_in_wim)
782                 goto invalid_due_to_overflow;
783
784         /* Verify that each blob in the resource has a valid offset and size.
785          */
786         expected_next_offset = 0;
787         out_of_order = false;
788         list_for_each_entry(blob, &rdesc->blob_list, rdesc_node) {
789                 if (blob->offset_in_res + blob->size < blob->size ||
790                     blob->offset_in_res + blob->size > rdesc->uncompressed_size)
791                         goto invalid_due_to_overflow;
792
793                 if (blob->offset_in_res >= expected_next_offset)
794                         expected_next_offset = blob->offset_in_res + blob->size;
795                 else
796                         out_of_order = true;
797         }
798
799         /* If the blobs were not located at strictly increasing positions (not
800          * allowing for overlap), sort them.  Then make sure that none overlap.
801          */
802         if (out_of_order) {
803                 ret = sort_blob_list(&rdesc->blob_list,
804                                      offsetof(struct blob_descriptor,
805                                               rdesc_node),
806                                      cmp_blobs_by_offset_in_res);
807                 if (ret)
808                         return ret;
809
810                 expected_next_offset = 0;
811                 list_for_each_entry(blob, &rdesc->blob_list, rdesc_node) {
812                         if (blob->offset_in_res >= expected_next_offset)
813                                 expected_next_offset = blob->offset_in_res + blob->size;
814                         else
815                                 goto invalid_due_to_overlap;
816                 }
817         }
818
819         return 0;
820
821 invalid_due_to_overflow:
822         ERROR("Invalid blob table (offset overflow)");
823         return WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
824
825 invalid_due_to_overlap:
826         ERROR("Invalid blob table (blobs in solid resource overlap)");
827         return WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
828 }
829
830 static int
831 finish_solid_rdescs(struct wim_resource_descriptor **rdescs, size_t num_rdescs)
832 {
833         int ret = 0;
834         for (size_t i = 0; i < num_rdescs; i++) {
835                 ret = validate_resource(rdescs[i]);
836                 if (ret)
837                         break;
838         }
839         free_solid_rdescs(rdescs, num_rdescs);
840         return ret;
841 }
842
843 /*
844  * read_blob_table() -
845  *
846  * Read the blob table from a WIM file.  Usually, each entry in this table
847  * describes a "blob", or equivalently a "resource", that the WIM file contains,
848  * along with its location and SHA-1 message digest.  Descriptors for
849  * non-metadata blobs will be saved in the in-memory blob table
850  * (wim->blob_table), whereas descriptors for metadata blobs will be saved in a
851  * special location per-image (the wim->image_metadata array).
852  *
853  * However, in WIM_VERSION_SOLID (3584) WIMs, a resource may contain multiple
854  * blobs that are compressed together.  Such a resource is called a "solid
855  * resource".  Solid resources are still described in the on-disk "blob table",
856  * although the format is not the most logical.  A consecutive sequence of
857  * entries that all have flag WIM_RESHDR_FLAG_SOLID (0x10) set is a "solid run".
858  * A solid run describes a set of solid resources, each of which contains a set
859  * of blobs.  In a solid run, a 'struct wim_reshdr_disk' with 'uncompressed_size
860  * = SOLID_RESOURCE_MAGIC_NUMBER (0x100000000)' specifies a solid resource,
861  * whereas any other 'struct wim_reshdr_disk' specifies a blob within a solid
862  * resource.  There are some oddities in how we need to determine which solid
863  * resource a blob is actually in; see the code for details.
864  *
865  * Possible return values:
866  *      WIMLIB_ERR_SUCCESS (0)
867  *      WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
868  *      WIMLIB_ERR_NOMEM
869  *
870  *      Or an error code caused by failure to read the blob table from the WIM
871  *      file.
872  */
873 int
874 read_blob_table(WIMStruct *wim)
875 {
876         int ret;
877         size_t num_entries;
878         void *buf = NULL;
879         struct blob_table *table = NULL;
880         struct blob_descriptor *cur_blob = NULL;
881         size_t num_duplicate_blobs = 0;
882         size_t num_empty_blobs = 0;
883         size_t num_wrong_part_blobs = 0;
884         u32 image_index = 0;
885         struct wim_resource_descriptor **cur_solid_rdescs = NULL;
886         size_t cur_num_solid_rdescs = 0;
887
888         /* Calculate the number of entries in the blob table.  */
889         num_entries = wim->hdr.blob_table_reshdr.uncompressed_size /
890                       sizeof(struct blob_descriptor_disk);
891
892         /* Read the blob table into a buffer.  */
893         ret = wim_reshdr_to_data(&wim->hdr.blob_table_reshdr, wim, &buf);
894         if (ret)
895                 goto out;
896
897         /* Allocate a hash table to map SHA-1 message digests into blob
898          * descriptors.  This is the in-memory "blob table".  */
899         table = new_blob_table(num_entries);
900         if (!table)
901                 goto oom;
902
903         /* Allocate and initalize blob descriptors from the raw blob table
904          * buffer.  */
905         for (size_t i = 0; i < num_entries; i++) {
906                 const struct blob_descriptor_disk *disk_entry =
907                         &((const struct blob_descriptor_disk*)buf)[i];
908                 struct wim_reshdr reshdr;
909                 u16 part_number;
910
911                 /* Get the resource header  */
912                 get_wim_reshdr(&disk_entry->reshdr, &reshdr);
913
914                 /* Ignore SOLID flag if it isn't supposed to be used in this WIM
915                  * version.  */
916                 if (wim->hdr.wim_version == WIM_VERSION_DEFAULT)
917                         reshdr.flags &= ~WIM_RESHDR_FLAG_SOLID;
918
919                 /* Allocate a new 'struct blob_descriptor'.  */
920                 cur_blob = new_blob_descriptor();
921                 if (!cur_blob)
922                         goto oom;
923
924                 /* Get the part number, reference count, and hash.  */
925                 part_number = le16_to_cpu(disk_entry->part_number);
926                 cur_blob->refcnt = le32_to_cpu(disk_entry->refcnt);
927                 copy_hash(cur_blob->hash, disk_entry->hash);
928
929                 if (reshdr.flags & WIM_RESHDR_FLAG_SOLID) {
930
931                         /* SOLID entry  */
932
933                         if (!cur_solid_rdescs) {
934                                 /* Starting new run  */
935                                 ret = load_solid_info(wim, disk_entry,
936                                                       num_entries - i,
937                                                       &cur_solid_rdescs,
938                                                       &cur_num_solid_rdescs);
939                                 if (ret)
940                                         goto out;
941                         }
942
943                         if (reshdr.uncompressed_size == SOLID_RESOURCE_MAGIC_NUMBER) {
944                                 /* Resource entry, not blob entry  */
945                                 goto free_cur_blob_and_continue;
946                         }
947
948                         /* Blob entry  */
949
950                         ret = assign_blob_to_solid_resource(&reshdr,
951                                                             cur_blob,
952                                                             cur_solid_rdescs,
953                                                             cur_num_solid_rdescs);
954                         if (ret)
955                                 goto out;
956
957                 } else {
958                         /* Normal blob/resource entry; SOLID not set.  */
959
960                         struct wim_resource_descriptor *rdesc;
961
962                         if (unlikely(cur_solid_rdescs)) {
963                                 /* This entry terminated a solid run.  */
964                                 ret = finish_solid_rdescs(cur_solid_rdescs,
965                                                           cur_num_solid_rdescs);
966                                 cur_solid_rdescs = NULL;
967                                 if (ret)
968                                         goto out;
969                         }
970
971                         if (unlikely(!(reshdr.flags & WIM_RESHDR_FLAG_COMPRESSED) &&
972                                      (reshdr.size_in_wim != reshdr.uncompressed_size)))
973                         {
974                                 ERROR("Uncompressed resource has "
975                                       "size_in_wim != uncompressed_size");
976                                 ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
977                                 goto out;
978                         }
979
980                         /* Set up a resource descriptor for this blob.  */
981
982                         rdesc = MALLOC(sizeof(struct wim_resource_descriptor));
983                         if (!rdesc)
984                                 goto oom;
985
986                         wim_reshdr_to_desc_and_blob(&reshdr, wim, rdesc, cur_blob);
987                 }
988
989                 /* cur_blob is now a blob bound to a resource.  */
990
991                 /* Ignore entries with all zeroes in the hash field.  */
992                 if (unlikely(is_zero_hash(cur_blob->hash)))
993                         goto free_cur_blob_and_continue;
994
995                 /* Verify that the blob has nonzero size.  */
996                 if (unlikely(cur_blob->size == 0)) {
997                         num_empty_blobs++;
998                         goto free_cur_blob_and_continue;
999                 }
1000
1001                 /* Verify that the part number matches that of the underlying
1002                  * WIM file.  */
1003                 if (unlikely(part_number != wim->hdr.part_number)) {
1004                         num_wrong_part_blobs++;
1005                         goto free_cur_blob_and_continue;
1006                 }
1007
1008                 if (reshdr.flags & WIM_RESHDR_FLAG_METADATA) {
1009
1010                         cur_blob->is_metadata = 1;
1011
1012                         /* Blob table entry for a metadata resource.  */
1013
1014                         /* Metadata entries with no references must be ignored.
1015                          * See, for example, the WinPE WIMs from the WAIK v2.1.
1016                          */
1017                         if (cur_blob->refcnt == 0)
1018                                 goto free_cur_blob_and_continue;
1019
1020                         if (cur_blob->refcnt != 1) {
1021                                 /* We don't currently support this case due to
1022                                  * the complications of multiple images sharing
1023                                  * the same metadata resource or a metadata
1024                                  * resource also being referenced by files.  */
1025                                 ERROR("Found metadata resource with refcnt != 1");
1026                                 ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
1027                                 goto out;
1028                         }
1029
1030                         if (reshdr.flags & WIM_RESHDR_FLAG_SOLID) {
1031                                 ERROR("Image metadata in solid resources "
1032                                       "is unsupported.");
1033                                 ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
1034                                 goto out;
1035                         }
1036
1037                         if (wim->hdr.part_number != 1) {
1038                                 WARNING("Ignoring metadata resource found in a "
1039                                         "non-first part of the split WIM");
1040                                 goto free_cur_blob_and_continue;
1041                         }
1042
1043                         /* The number of entries in the blob table with
1044                          * WIM_RESHDR_FLAG_METADATA set should be the same as
1045                          * the image_count field in the WIM header.  */
1046                         if (image_index == wim->hdr.image_count) {
1047                                 WARNING("Found more metadata resources than images");
1048                                 goto free_cur_blob_and_continue;
1049                         }
1050
1051                         /* Notice very carefully:  We are assigning the metadata
1052                          * resources to images in the same order in which their
1053                          * blob table entries occur on disk.  (This is also the
1054                          * behavior of Microsoft's software.)  In particular,
1055                          * this overrides the actual locations of the metadata
1056                          * resources themselves in the WIM file as well as any
1057                          * information written in the XML data.  */
1058                         wim->image_metadata[image_index++]->metadata_blob = cur_blob;
1059                 } else {
1060                         /* Blob table entry for a non-metadata blob.  */
1061
1062                         /* Ignore this blob if it's a duplicate.  */
1063                         if (lookup_blob(table, cur_blob->hash)) {
1064                                 num_duplicate_blobs++;
1065                                 goto free_cur_blob_and_continue;
1066                         }
1067
1068                         /* Insert the blob into the in-memory blob table, keyed
1069                          * by its SHA-1 message digest.  */
1070                         blob_table_insert(table, cur_blob);
1071                 }
1072
1073                 continue;
1074
1075         free_cur_blob_and_continue:
1076                 if (cur_solid_rdescs &&
1077                     cur_blob->blob_location == BLOB_IN_WIM)
1078                         blob_unset_is_located_in_wim_resource(cur_blob);
1079                 free_blob_descriptor(cur_blob);
1080         }
1081         cur_blob = NULL;
1082
1083         if (cur_solid_rdescs) {
1084                 /* End of blob table terminated a solid run.  */
1085                 ret = finish_solid_rdescs(cur_solid_rdescs, cur_num_solid_rdescs);
1086                 cur_solid_rdescs = NULL;
1087                 if (ret)
1088                         goto out;
1089         }
1090
1091         if (wim->hdr.part_number == 1 && image_index != wim->hdr.image_count) {
1092                 WARNING("Could not find metadata resources for all images");
1093                 for (u32 i = image_index; i < wim->hdr.image_count; i++)
1094                         put_image_metadata(wim->image_metadata[i], NULL);
1095                 wim->hdr.image_count = image_index;
1096         }
1097
1098         if (num_duplicate_blobs > 0)
1099                 WARNING("Ignoring %zu duplicate blobs", num_duplicate_blobs);
1100
1101         if (num_empty_blobs > 0)
1102                 WARNING("Ignoring %zu empty blobs", num_empty_blobs);
1103
1104         if (num_wrong_part_blobs > 0) {
1105                 WARNING("Ignoring %zu blobs with wrong part number",
1106                         num_wrong_part_blobs);
1107         }
1108
1109         wim->blob_table = table;
1110         ret = 0;
1111         goto out_free_buf;
1112
1113 oom:
1114         ERROR("Not enough memory to read blob table!");
1115         ret = WIMLIB_ERR_NOMEM;
1116 out:
1117         free_solid_rdescs(cur_solid_rdescs, cur_num_solid_rdescs);
1118         free_blob_descriptor(cur_blob);
1119         free_blob_table(table);
1120 out_free_buf:
1121         FREE(buf);
1122         return ret;
1123 }
1124
1125 static void
1126 write_blob_descriptor(struct blob_descriptor_disk *disk_entry,
1127                       const struct wim_reshdr *out_reshdr,
1128                       u16 part_number, u32 refcnt, const u8 *hash)
1129 {
1130         put_wim_reshdr(out_reshdr, &disk_entry->reshdr);
1131         disk_entry->part_number = cpu_to_le16(part_number);
1132         disk_entry->refcnt = cpu_to_le32(refcnt);
1133         copy_hash(disk_entry->hash, hash);
1134 }
1135
1136 /* Note: the list of blob descriptors must be sorted so that all entries for the
1137  * same solid resource are consecutive.  In addition, blob descriptors for
1138  * metadata resources must be in the same order as the indices of the underlying
1139  * images.  */
1140 int
1141 write_blob_table_from_blob_list(struct list_head *blob_list,
1142                                 struct filedes *out_fd,
1143                                 u16 part_number,
1144                                 struct wim_reshdr *out_reshdr,
1145                                 int write_resource_flags)
1146 {
1147         size_t table_size;
1148         struct blob_descriptor *blob;
1149         struct blob_descriptor_disk *table_buf;
1150         struct blob_descriptor_disk *table_buf_ptr;
1151         int ret;
1152         u64 prev_res_offset_in_wim = ~0ULL;
1153         u64 prev_uncompressed_size;
1154         u64 logical_offset;
1155
1156         table_size = 0;
1157         list_for_each_entry(blob, blob_list, blob_table_list) {
1158                 table_size += sizeof(struct blob_descriptor_disk);
1159
1160                 if (blob->out_reshdr.flags & WIM_RESHDR_FLAG_SOLID &&
1161                     blob->out_res_offset_in_wim != prev_res_offset_in_wim)
1162                 {
1163                         table_size += sizeof(struct blob_descriptor_disk);
1164                         prev_res_offset_in_wim = blob->out_res_offset_in_wim;
1165                 }
1166         }
1167
1168         table_buf = MALLOC(table_size);
1169         if (table_buf == NULL) {
1170                 ERROR("Failed to allocate %zu bytes for temporary blob table",
1171                       table_size);
1172                 return WIMLIB_ERR_NOMEM;
1173         }
1174         table_buf_ptr = table_buf;
1175
1176         prev_res_offset_in_wim = ~0ULL;
1177         prev_uncompressed_size = 0;
1178         logical_offset = 0;
1179         list_for_each_entry(blob, blob_list, blob_table_list) {
1180                 if (blob->out_reshdr.flags & WIM_RESHDR_FLAG_SOLID) {
1181                         struct wim_reshdr tmp_reshdr;
1182
1183                         /* Eww.  When WIMGAPI sees multiple solid resources, it
1184                          * expects the offsets to be adjusted as if there were
1185                          * really only one solid resource.  */
1186
1187                         if (blob->out_res_offset_in_wim != prev_res_offset_in_wim) {
1188                                 /* Put the resource entry for solid resource  */
1189                                 tmp_reshdr.offset_in_wim = blob->out_res_offset_in_wim;
1190                                 tmp_reshdr.size_in_wim = blob->out_res_size_in_wim;
1191                                 tmp_reshdr.uncompressed_size = SOLID_RESOURCE_MAGIC_NUMBER;
1192                                 tmp_reshdr.flags = WIM_RESHDR_FLAG_SOLID;
1193
1194                                 write_blob_descriptor(table_buf_ptr++, &tmp_reshdr,
1195                                                       part_number, 1, zero_hash);
1196
1197                                 logical_offset += prev_uncompressed_size;
1198
1199                                 prev_res_offset_in_wim = blob->out_res_offset_in_wim;
1200                                 prev_uncompressed_size = blob->out_res_uncompressed_size;
1201                         }
1202                         tmp_reshdr = blob->out_reshdr;
1203                         tmp_reshdr.offset_in_wim += logical_offset;
1204                         write_blob_descriptor(table_buf_ptr++, &tmp_reshdr,
1205                                               part_number, blob->out_refcnt, blob->hash);
1206                 } else {
1207                         write_blob_descriptor(table_buf_ptr++, &blob->out_reshdr,
1208                                               part_number, blob->out_refcnt, blob->hash);
1209                 }
1210
1211         }
1212         wimlib_assert((u8*)table_buf_ptr - (u8*)table_buf == table_size);
1213
1214         /* Write the blob table uncompressed.  Although wimlib can handle a
1215          * compressed blob table, MS software cannot.  */
1216         ret = write_wim_resource_from_buffer(table_buf,
1217                                              table_size,
1218                                              true,
1219                                              out_fd,
1220                                              WIMLIB_COMPRESSION_TYPE_NONE,
1221                                              0,
1222                                              out_reshdr,
1223                                              NULL,
1224                                              write_resource_flags);
1225         FREE(table_buf);
1226         return ret;
1227 }
1228
1229 /* Allocate a blob descriptor for the contents of the buffer, or re-use an
1230  * existing descriptor in @blob_table for an identical blob.  */
1231 struct blob_descriptor *
1232 new_blob_from_data_buffer(const void *buffer, size_t size,
1233                           struct blob_table *blob_table)
1234 {
1235         u8 hash[SHA1_HASH_SIZE];
1236         struct blob_descriptor *blob;
1237         void *buffer_copy;
1238
1239         sha1_buffer(buffer, size, hash);
1240
1241         blob = lookup_blob(blob_table, hash);
1242         if (blob)
1243                 return blob;
1244
1245         blob = new_blob_descriptor();
1246         if (!blob)
1247                 return NULL;
1248
1249         buffer_copy = memdup(buffer, size);
1250         if (!buffer_copy) {
1251                 free_blob_descriptor(blob);
1252                 return NULL;
1253         }
1254         blob_set_is_located_in_attached_buffer(blob, buffer_copy, size);
1255         copy_hash(blob->hash, hash);
1256         blob_table_insert(blob_table, blob);
1257         return blob;
1258 }
1259
1260 struct blob_descriptor *
1261 after_blob_hashed(struct blob_descriptor *blob,
1262                   struct blob_descriptor **back_ptr,
1263                   struct blob_table *blob_table)
1264 {
1265         struct blob_descriptor *duplicate_blob;
1266
1267         list_del(&blob->unhashed_list);
1268         blob->unhashed = 0;
1269
1270         /* Look for a duplicate blob  */
1271         duplicate_blob = lookup_blob(blob_table, blob->hash);
1272         if (duplicate_blob) {
1273                 /* We have a duplicate blob.  Transfer the reference counts from
1274                  * this blob to the duplicate and update the reference to this
1275                  * blob (from a stream) to point to the duplicate.  The caller
1276                  * is responsible for freeing @blob if needed.  */
1277                 wimlib_assert(duplicate_blob->size == blob->size);
1278                 duplicate_blob->refcnt += blob->refcnt;
1279                 blob->refcnt = 0;
1280                 *back_ptr = duplicate_blob;
1281                 return duplicate_blob;
1282         } else {
1283                 /* No duplicate blob, so we need to insert this blob into the
1284                  * blob table and treat it as a hashed blob.  */
1285                 blob_table_insert(blob_table, blob);
1286                 return blob;
1287         }
1288 }
1289
1290 /*
1291  * Calculate the SHA-1 message digest of a blob and move its descriptor from the
1292  * list of unhashed blobs to the blob table, possibly joining it with an
1293  * identical blob.
1294  *
1295  * @blob:
1296  *      The blob to hash
1297  * @blob_table:
1298  *      The blob table in which the blob needs to be indexed
1299  * @blob_ret:
1300  *      On success, a pointer to the resulting blob descriptor is written to
1301  *      this location.  This will be the same as @blob if it was inserted into
1302  *      the blob table, or different if a duplicate blob was found.
1303  *
1304  * Returns 0 on success; nonzero if there is an error reading the blob data.
1305  */
1306 int
1307 hash_unhashed_blob(struct blob_descriptor *blob, struct blob_table *blob_table,
1308                    struct blob_descriptor **blob_ret)
1309 {
1310         struct blob_descriptor **back_ptr;
1311         int ret;
1312
1313         back_ptr = retrieve_pointer_to_unhashed_blob(blob);
1314
1315         ret = sha1_blob(blob);
1316         if (ret)
1317                 return ret;
1318
1319         *blob_ret = after_blob_hashed(blob, back_ptr, blob_table);
1320         return 0;
1321 }
1322
1323 void
1324 blob_to_wimlib_resource_entry(const struct blob_descriptor *blob,
1325                               struct wimlib_resource_entry *wentry)
1326 {
1327         memset(wentry, 0, sizeof(*wentry));
1328
1329         wentry->uncompressed_size = blob->size;
1330         if (blob->blob_location == BLOB_IN_WIM) {
1331                 unsigned res_flags = blob->rdesc->flags;
1332
1333                 wentry->part_number = blob->rdesc->wim->hdr.part_number;
1334                 if (res_flags & WIM_RESHDR_FLAG_SOLID) {
1335                         wentry->offset = blob->offset_in_res;
1336                 } else {
1337                         wentry->compressed_size = blob->rdesc->size_in_wim;
1338                         wentry->offset = blob->rdesc->offset_in_wim;
1339                 }
1340                 wentry->raw_resource_offset_in_wim = blob->rdesc->offset_in_wim;
1341                 wentry->raw_resource_compressed_size = blob->rdesc->size_in_wim;
1342                 wentry->raw_resource_uncompressed_size = blob->rdesc->uncompressed_size;
1343
1344                 wentry->is_compressed = (res_flags & WIM_RESHDR_FLAG_COMPRESSED) != 0;
1345                 wentry->is_free = (res_flags & WIM_RESHDR_FLAG_FREE) != 0;
1346                 wentry->is_spanned = (res_flags & WIM_RESHDR_FLAG_SPANNED) != 0;
1347                 wentry->packed = (res_flags & WIM_RESHDR_FLAG_SOLID) != 0;
1348         }
1349         if (!blob->unhashed)
1350                 copy_hash(wentry->sha1_hash, blob->hash);
1351         wentry->reference_count = blob->refcnt;
1352         wentry->is_metadata = blob->is_metadata;
1353 }
1354
1355 struct iterate_blob_context {
1356         wimlib_iterate_lookup_table_callback_t cb;
1357         void *user_ctx;
1358 };
1359
1360 static int
1361 do_iterate_blob(struct blob_descriptor *blob, void *_ctx)
1362 {
1363         struct iterate_blob_context *ctx = _ctx;
1364         struct wimlib_resource_entry entry;
1365
1366         blob_to_wimlib_resource_entry(blob, &entry);
1367         return (*ctx->cb)(&entry, ctx->user_ctx);
1368 }
1369
1370 /* API function documented in wimlib.h  */
1371 WIMLIBAPI int
1372 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
1373                             wimlib_iterate_lookup_table_callback_t cb,
1374                             void *user_ctx)
1375 {
1376         if (flags != 0)
1377                 return WIMLIB_ERR_INVALID_PARAM;
1378
1379         struct iterate_blob_context ctx = {
1380                 .cb = cb,
1381                 .user_ctx = user_ctx,
1382         };
1383         if (wim_has_metadata(wim)) {
1384                 int ret;
1385                 for (int i = 0; i < wim->hdr.image_count; i++) {
1386                         struct blob_descriptor *blob;
1387                         struct wim_image_metadata *imd = wim->image_metadata[i];
1388
1389                         ret = do_iterate_blob(imd->metadata_blob, &ctx);
1390                         if (ret)
1391                                 return ret;
1392                         image_for_each_unhashed_blob(blob, imd) {
1393                                 ret = do_iterate_blob(blob, &ctx);
1394                                 if (ret)
1395                                         return ret;
1396                         }
1397                 }
1398         }
1399         return for_blob_in_table(wim->blob_table, do_iterate_blob, &ctx);
1400 }