extract.c: Fix for running out of file handles
[wimlib] / src / resource.c
1 /*
2  * resource.c
3  *
4  * Code for reading streams and resources, including compressed WIM resources.
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free Software
14  * Foundation; either version 3 of the License, or (at your option) any later
15  * version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License along with
22  * wimlib; if not, see http://www.gnu.org/licenses/.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 #  include "config.h"
27 #endif
28
29 #include "wimlib.h"
30 #include "wimlib/assert.h"
31 #include "wimlib/endianness.h"
32 #include "wimlib/error.h"
33 #include "wimlib/file_io.h"
34 #include "wimlib/lookup_table.h"
35 #include "wimlib/resource.h"
36 #include "wimlib/sha1.h"
37 #include "wimlib/wim.h"
38
39 #ifdef __WIN32__
40 /* for read_winnt_file_prefix(), read_win32_encrypted_file_prefix() */
41 #  include "wimlib/win32.h"
42 #endif
43
44 #ifdef WITH_NTFS_3G
45 /* for read_ntfs_file_prefix() */
46 #  include "wimlib/ntfs_3g.h"
47 #endif
48
49 #ifdef HAVE_ALLOCA_H
50 #  include <alloca.h>
51 #endif
52 #include <errno.h>
53 #include <fcntl.h>
54 #include <stdlib.h>
55 #include <unistd.h>
56
57 /*
58  *                         Compressed WIM resources
59  *
60  * A compressed resource in a WIM consists of a number of compressed chunks,
61  * each of which decompresses to a fixed chunk size (given in the WIM header;
62  * usually 32768) except possibly the last, which always decompresses to any
63  * remaining bytes.  In addition, immediately before the chunks, a table (the
64  * "chunk table") provides the offset, in bytes relative to the end of the chunk
65  * table, of the start of each compressed chunk, except for the first chunk
66  * which is omitted as it always has an offset of 0.  Therefore, a compressed
67  * resource with N chunks will have a chunk table with N - 1 entries.
68  *
69  * Additional information:
70  *
71  * - Entries in the chunk table are 4 bytes each, except if the uncompressed
72  *   size of the resource is greater than 4 GiB, in which case the entries in
73  *   the chunk table are 8 bytes each.  In either case, the entries are unsigned
74  *   little-endian integers.
75  *
76  * - The chunk table is included in the compressed size of the resource provided
77  *   in the corresponding entry in the WIM's stream lookup table.
78  *
79  * - The compressed size of a chunk is never greater than the uncompressed size.
80  *   From the compressor's point of view, chunks that would have compressed to a
81  *   size greater than or equal to their original size are in fact stored
82  *   uncompressed.  From the decompresser's point of view, chunks with
83  *   compressed size equal to their uncompressed size are in fact uncompressed.
84  *
85  * Furthermore, wimlib supports its own "pipable" WIM format, and for this the
86  * structure of compressed resources was modified to allow piped reading and
87  * writing.  To make sequential writing possible, the chunk table is placed
88  * after the chunks rather than before the chunks, and to make sequential
89  * reading possible, each chunk is prefixed with a 4-byte header giving its
90  * compressed size as a 32-bit, unsigned, little-endian integer.  Otherwise the
91  * details are the same.
92  */
93
94
95 struct data_range {
96         u64 offset;
97         u64 size;
98 };
99
100 /*
101  * read_compressed_wim_resource() -
102  *
103  * Read data from a compressed WIM resource.
104  *
105  * @rspec
106  *      Specification of the compressed WIM resource to read from.
107  * @ranges
108  *      Nonoverlapping, nonempty ranges of the uncompressed resource data to
109  *      read, sorted by increasing offset.
110  * @num_ranges
111  *      Number of ranges in @ranges; must be at least 1.
112  * @cb
113  *      Callback function to feed the data being read.  Each call provides the
114  *      next chunk of the requested data, uncompressed.  Each chunk will be of
115  *      nonzero size and will not cross range boundaries, but otherwise will be
116  *      of unspecified size.
117  * @cb_ctx
118  *      Parameter to pass to @cb_ctx.
119  *
120  * Possible return values:
121  *
122  *      WIMLIB_ERR_SUCCESS (0)
123  *      WIMLIB_ERR_READ                   (errno set)
124  *      WIMLIB_ERR_UNEXPECTED_END_OF_FILE (errno set to 0)
125  *      WIMLIB_ERR_NOMEM                  (errno set to ENOMEM)
126  *      WIMLIB_ERR_DECOMPRESSION          (errno set to EINVAL)
127  *
128  *      or other error code returned by the @cb function.
129  */
130 static int
131 read_compressed_wim_resource(const struct wim_resource_spec * const rspec,
132                              const struct data_range * const ranges,
133                              const size_t num_ranges,
134                              const consume_data_callback_t cb,
135                              void * const cb_ctx)
136 {
137         int ret;
138         int errno_save;
139
140         u64 *chunk_offsets = NULL;
141         u8 *_ubuf = NULL;
142         u8 *ubuf = NULL;
143         void *cbuf = NULL;
144         bool chunk_offsets_malloced = false;
145         bool ubuf_malloced = false;
146         bool cbuf_malloced = false;
147         struct wimlib_decompressor *decompressor = NULL;
148
149         /* Sanity checks  */
150         wimlib_assert(rspec != NULL);
151         wimlib_assert(resource_is_compressed(rspec));
152         wimlib_assert(cb != NULL);
153         wimlib_assert(num_ranges != 0);
154         for (size_t i = 0; i < num_ranges; i++) {
155                 DEBUG("Range %zu/%zu: %"PRIu64"@+%"PRIu64" / %"PRIu64,
156                       i + 1, num_ranges, ranges[i].size, ranges[i].offset,
157                       rspec->uncompressed_size);
158                 wimlib_assert(ranges[i].size != 0);
159                 wimlib_assert(ranges[i].offset + ranges[i].size >= ranges[i].size);
160                 wimlib_assert(ranges[i].offset + ranges[i].size <= rspec->uncompressed_size);
161         }
162         for (size_t i = 0; i < num_ranges - 1; i++)
163                 wimlib_assert(ranges[i].offset + ranges[i].size <= ranges[i + 1].offset);
164
165         /* Get the offsets of the first and last bytes of the read.  */
166         const u64 first_offset = ranges[0].offset;
167         const u64 last_offset = ranges[num_ranges - 1].offset + ranges[num_ranges - 1].size - 1;
168
169         /* Get the file descriptor for the WIM.  */
170         struct filedes * const in_fd = &rspec->wim->in_fd;
171
172         /* Determine if we're reading a pipable resource from a pipe or not.  */
173         const bool is_pipe_read = (rspec->is_pipable && !filedes_is_seekable(in_fd));
174
175         /* Determine if the chunk table is in an alternate format.  */
176         const bool alt_chunk_table = (rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS)
177                                         && !is_pipe_read;
178
179         /* Get the maximum size of uncompressed chunks in this resource, which
180          * we require be a power of 2.  */
181         u64 cur_read_offset = rspec->offset_in_wim;
182         int ctype = rspec->compression_type;
183         u32 chunk_size = rspec->chunk_size;
184         if (alt_chunk_table) {
185                 /* Alternate chunk table format.  Its header specifies the chunk
186                  * size and compression format.  Note: it could be read here;
187                  * however, the relevant data was already loaded into @rspec by
188                  * read_wim_lookup_table().  */
189                 cur_read_offset += sizeof(struct alt_chunk_table_header_disk);
190         }
191
192         if (!is_power_of_2(chunk_size)) {
193                 ERROR("Invalid compressed resource: "
194                       "expected power-of-2 chunk size (got %"PRIu32")",
195                       chunk_size);
196                 ret = WIMLIB_ERR_INVALID_CHUNK_SIZE;
197                 errno = EINVAL;
198                 goto out_free_memory;
199         }
200
201         /* Get valid decompressor.  */
202         if (ctype == rspec->wim->decompressor_ctype &&
203             chunk_size == rspec->wim->decompressor_max_block_size)
204         {
205                 /* Cached decompressor.  */
206                 decompressor = rspec->wim->decompressor;
207                 rspec->wim->decompressor_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
208                 rspec->wim->decompressor = NULL;
209         } else {
210                 ret = wimlib_create_decompressor(ctype, chunk_size, NULL,
211                                                  &decompressor);
212                 if (ret) {
213                         if (ret != WIMLIB_ERR_NOMEM)
214                                 errno = EINVAL;
215                         goto out_free_memory;
216                 }
217         }
218
219         const u32 chunk_order = bsr32(chunk_size);
220
221         /* Calculate the total number of chunks the resource is divided into.  */
222         const u64 num_chunks = (rspec->uncompressed_size + chunk_size - 1) >> chunk_order;
223
224         /* Calculate the 0-based indices of the first and last chunks containing
225          * data that needs to be passed to the callback.  */
226         const u64 first_needed_chunk = first_offset >> chunk_order;
227         const u64 last_needed_chunk = last_offset >> chunk_order;
228
229         /* Calculate the 0-based index of the first chunk that actually needs to
230          * be read.  This is normally first_needed_chunk, but for pipe reads we
231          * must always start from the 0th chunk.  */
232         const u64 read_start_chunk = (is_pipe_read ? 0 : first_needed_chunk);
233
234         /* Calculate the number of chunk offsets that are needed for the chunks
235          * being read.  */
236         const u64 num_needed_chunk_offsets =
237                 last_needed_chunk - read_start_chunk + 1 +
238                 (last_needed_chunk < num_chunks - 1);
239
240         /* Calculate the number of entries in the chunk table.  Normally, it's
241          * one less than the number of chunks, since the first chunk has no
242          * entry.  But in the alternate chunk table format, the chunk entries
243          * contain chunk sizes, not offsets, and there is one per chunk.  */
244         const u64 num_chunk_entries = (alt_chunk_table ? num_chunks : num_chunks - 1);
245
246         /* Set the size of each chunk table entry based on the resource's
247          * uncompressed size.  */
248         const u64 chunk_entry_size = get_chunk_entry_size(rspec->uncompressed_size,
249                                                           alt_chunk_table);
250
251         /* Calculate the size of the chunk table in bytes.  */
252         const u64 chunk_table_size = num_chunk_entries * chunk_entry_size;
253
254         /* Calculate the size of the chunk table in bytes, including the header
255          * in the case of the alternate chunk table format.  */
256         const u64 chunk_table_full_size =
257                 (alt_chunk_table) ? chunk_table_size + sizeof(struct alt_chunk_table_header_disk)
258                                   : chunk_table_size;
259
260         if (!is_pipe_read) {
261                 /* Read the needed chunk table entries into memory and use them
262                  * to initialize the chunk_offsets array.  */
263
264                 u64 first_chunk_entry_to_read;
265                 u64 last_chunk_entry_to_read;
266
267                 if (alt_chunk_table) {
268                         /* The alternate chunk table contains chunk sizes, not
269                          * offsets, so we always must read all preceding entries
270                          * in order to determine offsets.  */
271                         first_chunk_entry_to_read = 0;
272                         last_chunk_entry_to_read = last_needed_chunk;
273                 } else {
274                         /* Here we must account for the fact that the first
275                          * chunk has no explicit chunk table entry.  */
276
277                         if (read_start_chunk == 0)
278                                 first_chunk_entry_to_read = 0;
279                         else
280                                 first_chunk_entry_to_read = read_start_chunk - 1;
281
282                         if (last_needed_chunk == 0)
283                                 last_chunk_entry_to_read = 0;
284                         else
285                                 last_chunk_entry_to_read = last_needed_chunk - 1;
286
287                         if (last_needed_chunk < num_chunks - 1)
288                                 last_chunk_entry_to_read++;
289                 }
290
291                 const u64 num_chunk_entries_to_read =
292                         last_chunk_entry_to_read - first_chunk_entry_to_read + 1;
293
294                 const u64 chunk_offsets_alloc_size =
295                         max(num_chunk_entries_to_read,
296                             num_needed_chunk_offsets) * sizeof(chunk_offsets[0]);
297
298                 if ((size_t)chunk_offsets_alloc_size != chunk_offsets_alloc_size)
299                         goto oom;
300
301                 if (chunk_offsets_alloc_size <= STACK_MAX) {
302                         chunk_offsets = alloca(chunk_offsets_alloc_size);
303                 } else {
304                         chunk_offsets = MALLOC(chunk_offsets_alloc_size);
305                         if (chunk_offsets == NULL)
306                                 goto oom;
307                         chunk_offsets_malloced = true;
308                 }
309
310                 const size_t chunk_table_size_to_read =
311                         num_chunk_entries_to_read * chunk_entry_size;
312
313                 const u64 file_offset_of_needed_chunk_entries =
314                         cur_read_offset
315                         + (first_chunk_entry_to_read * chunk_entry_size)
316                         + (rspec->is_pipable ? (rspec->size_in_wim - chunk_table_size) : 0);
317
318                 void * const chunk_table_data =
319                         (u8*)chunk_offsets +
320                         chunk_offsets_alloc_size -
321                         chunk_table_size_to_read;
322
323                 ret = full_pread(in_fd, chunk_table_data, chunk_table_size_to_read,
324                                  file_offset_of_needed_chunk_entries);
325                 if (ret)
326                         goto read_error;
327
328                 /* Now fill in chunk_offsets from the entries we have read in
329                  * chunk_tab_data.  We break aliasing rules here to avoid having
330                  * to allocate yet another array.  */
331                 typedef le64 __attribute__((may_alias)) aliased_le64_t;
332                 typedef le32 __attribute__((may_alias)) aliased_le32_t;
333                 u64 * chunk_offsets_p = chunk_offsets;
334
335                 if (alt_chunk_table) {
336                         u64 cur_offset = 0;
337                         aliased_le32_t *raw_entries = chunk_table_data;
338
339                         for (size_t i = 0; i < num_chunk_entries_to_read; i++) {
340                                 u32 entry = le32_to_cpu(raw_entries[i]);
341                                 if (i >= read_start_chunk)
342                                         *chunk_offsets_p++ = cur_offset;
343                                 cur_offset += entry;
344                         }
345                         if (last_needed_chunk < num_chunks - 1)
346                                 *chunk_offsets_p = cur_offset;
347                 } else {
348                         if (read_start_chunk == 0)
349                                 *chunk_offsets_p++ = 0;
350
351                         if (chunk_entry_size == 4) {
352                                 aliased_le32_t *raw_entries = chunk_table_data;
353                                 for (size_t i = 0; i < num_chunk_entries_to_read; i++)
354                                         *chunk_offsets_p++ = le32_to_cpu(raw_entries[i]);
355                         } else {
356                                 aliased_le64_t *raw_entries = chunk_table_data;
357                                 for (size_t i = 0; i < num_chunk_entries_to_read; i++)
358                                         *chunk_offsets_p++ = le64_to_cpu(raw_entries[i]);
359                         }
360                 }
361
362                 /* Set offset to beginning of first chunk to read.  */
363                 cur_read_offset += chunk_offsets[0];
364                 if (rspec->is_pipable)
365                         cur_read_offset += read_start_chunk * sizeof(struct pwm_chunk_hdr);
366                 else
367                         cur_read_offset += chunk_table_size;
368         }
369
370         /* Allocate buffer for holding the uncompressed data of each chunk.  */
371         if (chunk_size <= STACK_MAX) {
372                 _ubuf = alloca(chunk_size + 15);
373         } else {
374                 _ubuf = MALLOC(chunk_size + 15);
375                 if (_ubuf == NULL)
376                         goto oom;
377                 ubuf_malloced = true;
378         }
379         ubuf = (u8 *)(((uintptr_t)_ubuf + 15) & ~15);
380
381         /* Allocate a temporary buffer for reading compressed chunks, each of
382          * which can be at most @chunk_size - 1 bytes.  This excludes compressed
383          * chunks that are a full @chunk_size bytes, which are actually stored
384          * uncompressed.  */
385         if (chunk_size - 1 <= STACK_MAX) {
386                 cbuf = alloca(chunk_size - 1);
387         } else {
388                 cbuf = MALLOC(chunk_size - 1);
389                 if (cbuf == NULL)
390                         goto oom;
391                 cbuf_malloced = true;
392         }
393
394         /* Set current data range.  */
395         const struct data_range *cur_range = ranges;
396         const struct data_range * const end_range = &ranges[num_ranges];
397         u64 cur_range_pos = cur_range->offset;
398         u64 cur_range_end = cur_range->offset + cur_range->size;
399
400         /* Read and process each needed chunk.  */
401         for (u64 i = read_start_chunk; i <= last_needed_chunk; i++) {
402
403                 /* Calculate uncompressed size of next chunk.  */
404                 u32 chunk_usize;
405                 if ((i == num_chunks - 1) && (rspec->uncompressed_size & (chunk_size - 1)))
406                         chunk_usize = (rspec->uncompressed_size & (chunk_size - 1));
407                 else
408                         chunk_usize = chunk_size;
409
410                 /* Calculate compressed size of next chunk.  */
411                 u32 chunk_csize;
412                 if (is_pipe_read) {
413                         struct pwm_chunk_hdr chunk_hdr;
414
415                         ret = full_pread(in_fd, &chunk_hdr,
416                                          sizeof(chunk_hdr), cur_read_offset);
417                         if (ret)
418                                 goto read_error;
419                         chunk_csize = le32_to_cpu(chunk_hdr.compressed_size);
420                 } else {
421                         if (i == num_chunks - 1) {
422                                 chunk_csize = rspec->size_in_wim -
423                                               chunk_table_full_size -
424                                               chunk_offsets[i - read_start_chunk];
425                                 if (rspec->is_pipable)
426                                         chunk_csize -= num_chunks * sizeof(struct pwm_chunk_hdr);
427                         } else {
428                                 chunk_csize = chunk_offsets[i + 1 - read_start_chunk] -
429                                               chunk_offsets[i - read_start_chunk];
430                         }
431                 }
432                 if (chunk_csize == 0 || chunk_csize > chunk_usize) {
433                         ERROR("Invalid chunk size in compressed resource!");
434                         errno = EINVAL;
435                         ret = WIMLIB_ERR_DECOMPRESSION;
436                         goto out_free_memory;
437                 }
438                 if (rspec->is_pipable)
439                         cur_read_offset += sizeof(struct pwm_chunk_hdr);
440
441                 /* Offsets in the uncompressed resource at which this chunk
442                  * starts and ends.  */
443                 const u64 chunk_start_offset = i << chunk_order;
444                 const u64 chunk_end_offset = chunk_start_offset + chunk_usize;
445
446                 if (chunk_end_offset <= cur_range_pos) {
447
448                         /* The next range does not require data in this chunk,
449                          * so skip it.  */
450                         cur_read_offset += chunk_csize;
451                         if (is_pipe_read) {
452                                 u8 dummy;
453
454                                 ret = full_pread(in_fd, &dummy, 1, cur_read_offset - 1);
455                                 if (ret)
456                                         goto read_error;
457                         }
458                 } else {
459
460                         /* Read the chunk and feed data to the callback
461                          * function.  */
462                         u8 *read_buf;
463
464                         if (chunk_csize == chunk_usize)
465                                 read_buf = ubuf;
466                         else
467                                 read_buf = cbuf;
468
469                         ret = full_pread(in_fd,
470                                          read_buf,
471                                          chunk_csize,
472                                          cur_read_offset);
473                         if (ret)
474                                 goto read_error;
475
476                         if (read_buf == cbuf) {
477                                 DEBUG("Decompressing chunk %"PRIu64" "
478                                       "(csize=%"PRIu32" usize=%"PRIu32")",
479                                       i, chunk_csize, chunk_usize);
480                                 ret = wimlib_decompress(cbuf,
481                                                         chunk_csize,
482                                                         ubuf,
483                                                         chunk_usize,
484                                                         decompressor);
485                                 if (ret) {
486                                         ERROR("Failed to decompress data!");
487                                         ret = WIMLIB_ERR_DECOMPRESSION;
488                                         errno = EINVAL;
489                                         goto out_free_memory;
490                                 }
491                         }
492                         cur_read_offset += chunk_csize;
493
494                         /* At least one range requires data in this chunk.  */
495                         do {
496                                 size_t start, end, size;
497
498                                 /* Calculate how many bytes of data should be
499                                  * sent to the callback function, taking into
500                                  * account that data sent to the callback
501                                  * function must not overlap range boundaries.
502                                  */
503                                 start = cur_range_pos - chunk_start_offset;
504                                 end = min(cur_range_end, chunk_end_offset) - chunk_start_offset;
505                                 size = end - start;
506
507                                 ret = (*cb)(&ubuf[start], size, cb_ctx);
508
509                                 if (ret)
510                                         goto out_free_memory;
511
512                                 cur_range_pos += size;
513                                 if (cur_range_pos == cur_range_end) {
514                                         /* Advance to next range.  */
515                                         if (++cur_range == end_range) {
516                                                 cur_range_pos = ~0ULL;
517                                         } else {
518                                                 cur_range_pos = cur_range->offset;
519                                                 cur_range_end = cur_range->offset + cur_range->size;
520                                         }
521                                 }
522                         } while (cur_range_pos < chunk_end_offset);
523                 }
524         }
525
526         if (is_pipe_read &&
527             last_offset == rspec->uncompressed_size - 1 &&
528             chunk_table_size)
529         {
530                 u8 dummy;
531                 /* If reading a pipable resource from a pipe and the full data
532                  * was requested, skip the chunk table at the end so that the
533                  * file descriptor is fully clear of the resource after this
534                  * returns.  */
535                 cur_read_offset += chunk_table_size;
536                 ret = full_pread(in_fd, &dummy, 1, cur_read_offset - 1);
537                 if (ret)
538                         goto read_error;
539         }
540         ret = 0;
541
542 out_free_memory:
543         errno_save = errno;
544         if (decompressor) {
545                 wimlib_free_decompressor(rspec->wim->decompressor);
546                 rspec->wim->decompressor = decompressor;
547                 rspec->wim->decompressor_ctype = ctype;
548                 rspec->wim->decompressor_max_block_size = chunk_size;
549         }
550         if (chunk_offsets_malloced)
551                 FREE(chunk_offsets);
552         if (ubuf_malloced)
553                 FREE(_ubuf);
554         if (cbuf_malloced)
555                 FREE(cbuf);
556         errno = errno_save;
557         return ret;
558
559 oom:
560         ERROR("Not enough memory available to read size=%"PRIu64" bytes "
561               "from compressed WIM resource!", last_offset - first_offset + 1);
562         errno = ENOMEM;
563         ret = WIMLIB_ERR_NOMEM;
564         goto out_free_memory;
565
566 read_error:
567         ERROR_WITH_ERRNO("Error reading compressed WIM resource!");
568         goto out_free_memory;
569 }
570
571 static int
572 fill_zeroes(u64 size, consume_data_callback_t cb, void *cb_ctx)
573 {
574         if (unlikely(size)) {
575                 u8 buf[min(size, BUFFER_SIZE)];
576
577                 memset(buf, 0, sizeof(buf));
578
579                 do {
580                         size_t len;
581                         int ret;
582
583                         len = min(size, BUFFER_SIZE);
584                         ret = cb(buf, len, cb_ctx);
585                         if (ret)
586                                 return ret;
587                         size -= len;
588                 } while (size);
589         }
590         return 0;
591 }
592
593 /* Read raw data from a file descriptor at the specified offset, feeding the
594  * data it in chunks into the specified callback function.  */
595 static int
596 read_raw_file_data(struct filedes *in_fd, u64 offset, u64 size,
597                    consume_data_callback_t cb, void *cb_ctx)
598 {
599         u8 buf[BUFFER_SIZE];
600         size_t bytes_to_read;
601         int ret;
602
603         while (size) {
604                 bytes_to_read = min(sizeof(buf), size);
605                 ret = full_pread(in_fd, buf, bytes_to_read, offset);
606                 if (ret) {
607                         ERROR_WITH_ERRNO("Read error");
608                         return ret;
609                 }
610                 ret = cb(buf, bytes_to_read, cb_ctx);
611                 if (ret)
612                         return ret;
613                 size -= bytes_to_read;
614                 offset += bytes_to_read;
615         }
616         return 0;
617 }
618
619 /* A consume_data_callback_t implementation that simply concatenates all chunks
620  * into a buffer.  */
621 static int
622 bufferer_cb(const void *chunk, size_t size, void *_ctx)
623 {
624         u8 **buf_p = _ctx;
625
626         *buf_p = mempcpy(*buf_p, chunk, size);
627         return 0;
628 }
629
630 /*
631  * read_partial_wim_resource()-
632  *
633  * Read a range of data from an uncompressed or compressed resource in a WIM
634  * file.
635  *
636  * @rspec
637  *      Specification of the WIM resource to read from.
638  * @offset
639  *      Offset within the uncompressed resource at which to start reading.
640  * @size
641  *      Number of bytes to read.
642  * @cb
643  *      Callback function to feed the data being read.  Each call provides the
644  *      next chunk of the requested data, uncompressed.  Each chunk will be of
645  *      nonzero size and will not cross range boundaries, but otherwise will be
646  *      of unspecified size.
647  * @cb_ctx
648  *      Parameter to pass to @cb_ctx.
649  *
650  * Return values:
651  *      WIMLIB_ERR_SUCCESS (0)
652  *      WIMLIB_ERR_READ                   (errno set)
653  *      WIMLIB_ERR_UNEXPECTED_END_OF_FILE (errno set to 0)
654  *      WIMLIB_ERR_NOMEM                  (errno set to ENOMEM)
655  *      WIMLIB_ERR_DECOMPRESSION          (errno set to EINVAL)
656  *
657  *      or other error code returned by the @cb function.
658  */
659 static int
660 read_partial_wim_resource(const struct wim_resource_spec *rspec,
661                           u64 offset, u64 size,
662                           consume_data_callback_t cb, void *cb_ctx)
663 {
664         /* Sanity checks.  */
665         wimlib_assert(offset + size >= offset);
666         wimlib_assert(offset + size <= rspec->uncompressed_size);
667
668         DEBUG("Reading %"PRIu64" @ %"PRIu64" from WIM resource  "
669               "%"PRIu64" => %"PRIu64" @ %"PRIu64,
670               size, offset, rspec->uncompressed_size,
671               rspec->size_in_wim, rspec->offset_in_wim);
672
673         /* Trivial case.  */
674         if (size == 0)
675                 return 0;
676
677         if (resource_is_compressed(rspec)) {
678                 struct data_range range = {
679                         .offset = offset,
680                         .size = size,
681                 };
682                 return read_compressed_wim_resource(rspec, &range, 1,
683                                                     cb, cb_ctx);
684         } else {
685                 /* Reading uncompressed resource.  For completeness, handle the
686                  * weird case where size_in_wim < uncompressed_size.  */
687
688                 u64 read_size;
689                 u64 zeroes_size;
690                 int ret;
691
692                 if (likely(offset + size <= rspec->size_in_wim) ||
693                     rspec->is_pipable)
694                 {
695                         read_size = size;
696                         zeroes_size = 0;
697                 } else {
698                         if (offset >= rspec->size_in_wim) {
699                                 read_size = 0;
700                                 zeroes_size = size;
701                         } else {
702                                 read_size = rspec->size_in_wim - offset;
703                                 zeroes_size = offset + size - rspec->size_in_wim;
704                         }
705                 }
706
707                 ret = read_raw_file_data(&rspec->wim->in_fd,
708                                          rspec->offset_in_wim + offset,
709                                          read_size,
710                                          cb,
711                                          cb_ctx);
712                 if (ret)
713                         return ret;
714
715                 return fill_zeroes(zeroes_size, cb, cb_ctx);
716         }
717 }
718
719 /* Read the specified range of uncompressed data from the specified stream,
720  * which must be located into a WIM file, into the specified buffer.  */
721 int
722 read_partial_wim_stream_into_buf(const struct wim_lookup_table_entry *lte,
723                                  size_t size, u64 offset, void *_buf)
724 {
725         u8 *buf = _buf;
726
727         wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
728
729         return read_partial_wim_resource(lte->rspec,
730                                          lte->offset_in_res + offset,
731                                          size,
732                                          bufferer_cb,
733                                          &buf);
734 }
735
736 /* A consume_data_callback_t implementation that simply ignores the data
737  * received.  */
738 static int
739 skip_chunk_cb(const void *chunk, size_t size, void *_ctx)
740 {
741         return 0;
742 }
743
744 /* Skip over the data of the specified stream, which must correspond to a full
745  * WIM resource.  */
746 int
747 skip_wim_stream(struct wim_lookup_table_entry *lte)
748 {
749         wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
750         wimlib_assert(!(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS));
751         DEBUG("Skipping stream (size=%"PRIu64")", lte->size);
752         return read_partial_wim_resource(lte->rspec,
753                                          0,
754                                          lte->rspec->uncompressed_size,
755                                          skip_chunk_cb,
756                                          NULL);
757 }
758
759 static int
760 read_wim_stream_prefix(const struct wim_lookup_table_entry *lte, u64 size,
761                        consume_data_callback_t cb, void *cb_ctx)
762 {
763         return read_partial_wim_resource(lte->rspec, lte->offset_in_res, size,
764                                          cb, cb_ctx);
765 }
766
767 /* This function handles reading stream data that is located in an external
768  * file,  such as a file that has been added to the WIM image through execution
769  * of a wimlib_add_command.
770  *
771  * This assumes the file can be accessed using the standard POSIX open(),
772  * read(), and close().  On Windows this will not necessarily be the case (since
773  * the file may need FILE_FLAG_BACKUP_SEMANTICS to be opened, or the file may be
774  * encrypted), so Windows uses its own code for its equivalent case.  */
775 static int
776 read_file_on_disk_prefix(const struct wim_lookup_table_entry *lte, u64 size,
777                          consume_data_callback_t cb, void *cb_ctx)
778 {
779         int ret;
780         int raw_fd;
781         struct filedes fd;
782
783         wimlib_assert(size <= lte->size);
784
785         DEBUG("Reading %"PRIu64" bytes from \"%"TS"\"", size, lte->file_on_disk);
786
787         raw_fd = topen(lte->file_on_disk, O_BINARY | O_RDONLY);
788         if (raw_fd < 0) {
789                 ERROR_WITH_ERRNO("Can't open \"%"TS"\"", lte->file_on_disk);
790                 return WIMLIB_ERR_OPEN;
791         }
792         filedes_init(&fd, raw_fd);
793         ret = read_raw_file_data(&fd, 0, size, cb, cb_ctx);
794         filedes_close(&fd);
795         return ret;
796 }
797
798 #ifdef WITH_FUSE
799 static int
800 read_staging_file_prefix(const struct wim_lookup_table_entry *lte, u64 size,
801                          consume_data_callback_t cb, void *cb_ctx)
802 {
803         int raw_fd;
804         struct filedes fd;
805         int ret;
806
807         wimlib_assert(size <= lte->size);
808
809         DEBUG("Reading %"PRIu64" bytes from staging file \"%s\"",
810               size, lte->staging_file_name);
811
812         raw_fd = openat(lte->staging_dir_fd, lte->staging_file_name,
813                         O_RDONLY | O_NOFOLLOW);
814         if (raw_fd < 0) {
815                 ERROR_WITH_ERRNO("Can't open staging file \"%s\"",
816                                  lte->staging_file_name);
817                 return WIMLIB_ERR_OPEN;
818         }
819         filedes_init(&fd, raw_fd);
820         ret = read_raw_file_data(&fd, 0, size, cb, cb_ctx);
821         filedes_close(&fd);
822         return ret;
823 }
824 #endif
825
826 /* This function handles the trivial case of reading stream data that is, in
827  * fact, already located in an in-memory buffer.  */
828 static int
829 read_buffer_prefix(const struct wim_lookup_table_entry *lte,
830                    u64 size, consume_data_callback_t cb, void *cb_ctx)
831 {
832         wimlib_assert(size <= lte->size);
833         return (*cb)(lte->attached_buffer, size, cb_ctx);
834 }
835
836 typedef int (*read_stream_prefix_handler_t)(const struct wim_lookup_table_entry *lte,
837                                             u64 size,
838                                             consume_data_callback_t cb,
839                                             void *cb_ctx);
840
841 /*
842  * read_stream_prefix()-
843  *
844  * Reads the first @size bytes from a generic "stream", which may be located in
845  * any one of several locations, such as in a WIM file (compressed or
846  * uncompressed), in an external file, or directly in an in-memory buffer.
847  *
848  * This function feeds the data to a callback function @cb in chunks of
849  * unspecified size.
850  *
851  * Returns 0 on success; nonzero on error.  A nonzero value will be returned if
852  * the stream data cannot be successfully read (for a number of different
853  * reasons, depending on the stream location), or if @cb returned nonzero in
854  * which case that error code will be returned.
855  */
856 static int
857 read_stream_prefix(const struct wim_lookup_table_entry *lte, u64 size,
858                    consume_data_callback_t cb, void *cb_ctx)
859 {
860         static const read_stream_prefix_handler_t handlers[] = {
861                 [RESOURCE_IN_WIM]             = read_wim_stream_prefix,
862                 [RESOURCE_IN_FILE_ON_DISK]    = read_file_on_disk_prefix,
863                 [RESOURCE_IN_ATTACHED_BUFFER] = read_buffer_prefix,
864         #ifdef WITH_FUSE
865                 [RESOURCE_IN_STAGING_FILE]    = read_staging_file_prefix,
866         #endif
867         #ifdef WITH_NTFS_3G
868                 [RESOURCE_IN_NTFS_VOLUME]     = read_ntfs_file_prefix,
869         #endif
870         #ifdef __WIN32__
871                 [RESOURCE_IN_WINNT_FILE_ON_DISK] = read_winnt_file_prefix,
872                 [RESOURCE_WIN32_ENCRYPTED]    = read_win32_encrypted_file_prefix,
873         #endif
874         };
875         wimlib_assert(lte->resource_location < ARRAY_LEN(handlers)
876                       && handlers[lte->resource_location] != NULL);
877         return handlers[lte->resource_location](lte, size, cb, cb_ctx);
878 }
879
880 /* Read the full uncompressed data of the specified stream into the specified
881  * buffer, which must have space for at least lte->size bytes.  */
882 int
883 read_full_stream_into_buf(const struct wim_lookup_table_entry *lte, void *_buf)
884 {
885         u8 *buf = _buf;
886         return read_stream_prefix(lte, lte->size, bufferer_cb, &buf);
887 }
888
889 /* Retrieve the full uncompressed data of the specified stream.  A buffer large
890  * enough hold the data is allocated and returned in @buf_ret.  */
891 int
892 read_full_stream_into_alloc_buf(const struct wim_lookup_table_entry *lte,
893                                 void **buf_ret)
894 {
895         int ret;
896         void *buf;
897
898         if ((size_t)lte->size != lte->size) {
899                 ERROR("Can't read %"PRIu64" byte stream into "
900                       "memory", lte->size);
901                 return WIMLIB_ERR_NOMEM;
902         }
903
904         buf = MALLOC(lte->size);
905         if (buf == NULL)
906                 return WIMLIB_ERR_NOMEM;
907
908         ret = read_full_stream_into_buf(lte, buf);
909         if (ret) {
910                 FREE(buf);
911                 return ret;
912         }
913
914         *buf_ret = buf;
915         return 0;
916 }
917
918 /* Retrieve the full uncompressed data of the specified WIM resource.  A buffer
919  * large enough hold the data is allocated and returned in @buf_ret.  */
920 static int
921 wim_resource_spec_to_data(struct wim_resource_spec *rspec, void **buf_ret)
922 {
923         int ret;
924         struct wim_lookup_table_entry *lte;
925
926         lte = new_lookup_table_entry();
927         if (lte == NULL)
928                 return WIMLIB_ERR_NOMEM;
929
930         lte_bind_wim_resource_spec(lte, rspec);
931         lte->flags = rspec->flags;
932         lte->size = rspec->uncompressed_size;
933         lte->offset_in_res = 0;
934
935         ret = read_full_stream_into_alloc_buf(lte, buf_ret);
936
937         lte_unbind_wim_resource_spec(lte);
938         free_lookup_table_entry(lte);
939         return ret;
940 }
941
942 /* Retrieve the full uncompressed data of a WIM resource specified as a raw
943  * `wim_reshdr' and the corresponding WIM file.  A large enough hold the data is
944  * allocated and returned in @buf_ret.  */
945 int
946 wim_reshdr_to_data(const struct wim_reshdr *reshdr, WIMStruct *wim, void **buf_ret)
947 {
948         DEBUG("offset_in_wim=%"PRIu64", size_in_wim=%"PRIu64", "
949               "uncompressed_size=%"PRIu64,
950               reshdr->offset_in_wim, reshdr->size_in_wim,
951               reshdr->uncompressed_size);
952
953         struct wim_resource_spec rspec;
954         wim_res_hdr_to_spec(reshdr, wim, &rspec);
955         return wim_resource_spec_to_data(&rspec, buf_ret);
956 }
957
958 int
959 wim_reshdr_to_hash(const struct wim_reshdr *reshdr, WIMStruct *wim,
960                    u8 hash[SHA1_HASH_SIZE])
961 {
962         struct wim_resource_spec rspec;
963         int ret;
964         struct wim_lookup_table_entry *lte;
965
966         wim_res_hdr_to_spec(reshdr, wim, &rspec);
967
968         lte = new_lookup_table_entry();
969         if (lte == NULL)
970                 return WIMLIB_ERR_NOMEM;
971
972         lte_bind_wim_resource_spec(lte, &rspec);
973         lte->flags = rspec.flags;
974         lte->size = rspec.uncompressed_size;
975         lte->offset_in_res = 0;
976         lte->unhashed = 1;
977
978         ret = sha1_stream(lte);
979
980         lte_unbind_wim_resource_spec(lte);
981         copy_hash(hash, lte->hash);
982         free_lookup_table_entry(lte);
983         return ret;
984 }
985
986 struct streamifier_context {
987         struct read_stream_list_callbacks cbs;
988         struct wim_lookup_table_entry *cur_stream;
989         struct wim_lookup_table_entry *next_stream;
990         u64 cur_stream_offset;
991         struct wim_lookup_table_entry *final_stream;
992         size_t list_head_offset;
993 };
994
995 static struct wim_lookup_table_entry *
996 next_stream(struct wim_lookup_table_entry *lte, size_t list_head_offset)
997 {
998         struct list_head *cur;
999
1000         cur = (struct list_head*)((u8*)lte + list_head_offset);
1001
1002         return (struct wim_lookup_table_entry*)((u8*)cur->next - list_head_offset);
1003 }
1004
1005 /* A consume_data_callback_t implementation that translates raw resource data
1006  * into streams, calling the begin_stream, consume_chunk, and end_stream
1007  * callback functions as appropriate.  */
1008 static int
1009 streamifier_cb(const void *chunk, size_t size, void *_ctx)
1010 {
1011         struct streamifier_context *ctx = _ctx;
1012         int ret;
1013
1014         DEBUG("%zu bytes passed to streamifier", size);
1015
1016         wimlib_assert(ctx->cur_stream != NULL);
1017         wimlib_assert(size <= ctx->cur_stream->size - ctx->cur_stream_offset);
1018
1019         if (ctx->cur_stream_offset == 0) {
1020                 u32 flags;
1021
1022                 /* Starting a new stream.  */
1023                 DEBUG("Begin new stream (size=%"PRIu64").",
1024                       ctx->cur_stream->size);
1025
1026                 flags = BEGIN_STREAM_FLAG_PARTIAL_RESOURCE;
1027                 if (size == ctx->cur_stream->size)
1028                         flags |= BEGIN_STREAM_FLAG_WHOLE_STREAM;
1029                 ret = (*ctx->cbs.begin_stream)(ctx->cur_stream,
1030                                                flags,
1031                                                ctx->cbs.begin_stream_ctx);
1032                 if (ret)
1033                         return ret;
1034         }
1035
1036         /* Consume the chunk.  */
1037         ret = (*ctx->cbs.consume_chunk)(chunk, size,
1038                                         ctx->cbs.consume_chunk_ctx);
1039         ctx->cur_stream_offset += size;
1040         if (ret)
1041                 return ret;
1042
1043         if (ctx->cur_stream_offset == ctx->cur_stream->size) {
1044                 /* Finished reading all the data for a stream.  */
1045
1046                 ctx->cur_stream_offset = 0;
1047
1048                 DEBUG("End stream (size=%"PRIu64").", ctx->cur_stream->size);
1049                 ret = (*ctx->cbs.end_stream)(ctx->cur_stream, 0,
1050                                              ctx->cbs.end_stream_ctx);
1051                 if (ret)
1052                         return ret;
1053
1054                 /* Advance to next stream.  */
1055                 ctx->cur_stream = ctx->next_stream;
1056                 if (ctx->cur_stream != NULL) {
1057                         if (ctx->cur_stream != ctx->final_stream)
1058                                 ctx->next_stream = next_stream(ctx->cur_stream,
1059                                                                ctx->list_head_offset);
1060                         else
1061                                 ctx->next_stream = NULL;
1062                 }
1063         }
1064         return 0;
1065 }
1066
1067 struct hasher_context {
1068         SHA_CTX sha_ctx;
1069         int flags;
1070         struct read_stream_list_callbacks cbs;
1071 };
1072
1073 /* Callback for starting to read a stream while calculating its SHA1 message
1074  * digest.  */
1075 static int
1076 hasher_begin_stream(struct wim_lookup_table_entry *lte, u32 flags,
1077                     void *_ctx)
1078 {
1079         struct hasher_context *ctx = _ctx;
1080
1081         sha1_init(&ctx->sha_ctx);
1082
1083         if (ctx->cbs.begin_stream == NULL)
1084                 return 0;
1085         else
1086                 return (*ctx->cbs.begin_stream)(lte, flags,
1087                                                 ctx->cbs.begin_stream_ctx);
1088 }
1089
1090 /* A consume_data_callback_t implementation that continues calculating the SHA1
1091  * message digest of the stream being read, then optionally passes the data on
1092  * to another consume_data_callback_t implementation.  This allows checking the
1093  * SHA1 message digest of a stream being extracted, for example.  */
1094 static int
1095 hasher_consume_chunk(const void *chunk, size_t size, void *_ctx)
1096 {
1097         struct hasher_context *ctx = _ctx;
1098
1099         sha1_update(&ctx->sha_ctx, chunk, size);
1100         if (ctx->cbs.consume_chunk == NULL)
1101                 return 0;
1102         else
1103                 return (*ctx->cbs.consume_chunk)(chunk, size, ctx->cbs.consume_chunk_ctx);
1104 }
1105
1106 static void
1107 get_sha1_string(const u8 md[SHA1_HASH_SIZE], tchar *str)
1108 {
1109         for (size_t i = 0; i < SHA1_HASH_SIZE; i++)
1110                 str += tsprintf(str, T("%02x"), md[i]);
1111 }
1112
1113 /* Callback for finishing reading a stream while calculating its SHA1 message
1114  * digest.  */
1115 static int
1116 hasher_end_stream(struct wim_lookup_table_entry *lte, int status, void *_ctx)
1117 {
1118         struct hasher_context *ctx = _ctx;
1119         u8 hash[SHA1_HASH_SIZE];
1120         int ret;
1121
1122         if (status) {
1123                 /* Error occurred; the full stream may not have been read.  */
1124                 ret = status;
1125                 goto out_next_cb;
1126         }
1127
1128         /* Retrieve the final SHA1 message digest.  */
1129         sha1_final(hash, &ctx->sha_ctx);
1130
1131         if (lte->unhashed) {
1132                 if (ctx->flags & COMPUTE_MISSING_STREAM_HASHES) {
1133                         /* No SHA1 message digest was previously present for the
1134                          * stream.  Set it to the one just calculated.  */
1135                         DEBUG("Set SHA1 message digest for stream "
1136                               "(size=%"PRIu64").", lte->size);
1137                         copy_hash(lte->hash, hash);
1138                 }
1139         } else {
1140                 if (ctx->flags & VERIFY_STREAM_HASHES) {
1141                         /* The stream already had a SHA1 message digest present.  Verify
1142                          * that it is the same as the calculated value.  */
1143                         if (!hashes_equal(hash, lte->hash)) {
1144                                 if (wimlib_print_errors) {
1145                                         tchar expected_hashstr[SHA1_HASH_SIZE * 2 + 1];
1146                                         tchar actual_hashstr[SHA1_HASH_SIZE * 2 + 1];
1147                                         get_sha1_string(lte->hash, expected_hashstr);
1148                                         get_sha1_string(hash, actual_hashstr);
1149                                         ERROR("The stream is corrupted!\n"
1150                                               "        (Expected SHA1=%"TS",\n"
1151                                               "              got SHA1=%"TS")",
1152                                               expected_hashstr, actual_hashstr);
1153                                 }
1154                                 ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
1155                                 errno = EINVAL;
1156                                 goto out_next_cb;
1157                         }
1158                         DEBUG("SHA1 message digest okay for "
1159                               "stream (size=%"PRIu64").", lte->size);
1160                 }
1161         }
1162         ret = 0;
1163 out_next_cb:
1164         if (ctx->cbs.end_stream == NULL)
1165                 return ret;
1166         else
1167                 return (*ctx->cbs.end_stream)(lte, ret, ctx->cbs.end_stream_ctx);
1168 }
1169
1170 int
1171 read_full_stream_with_cbs(struct wim_lookup_table_entry *lte,
1172                           const struct read_stream_list_callbacks *cbs)
1173 {
1174         int ret;
1175
1176         ret = (*cbs->begin_stream)(lte, 0, cbs->begin_stream_ctx);
1177         if (ret)
1178                 return ret;
1179
1180         ret = read_stream_prefix(lte, lte->size, cbs->consume_chunk,
1181                                  cbs->consume_chunk_ctx);
1182
1183         return (*cbs->end_stream)(lte, ret, cbs->end_stream_ctx);
1184 }
1185
1186 /* Read the full data of the specified stream, passing the data into the
1187  * specified callbacks (all of which are optional) and either checking or
1188  * computing the SHA1 message digest of the stream.  */
1189 static int
1190 read_full_stream_with_sha1(struct wim_lookup_table_entry *lte,
1191                            const struct read_stream_list_callbacks *cbs)
1192 {
1193         struct hasher_context hasher_ctx = {
1194                 .flags = VERIFY_STREAM_HASHES | COMPUTE_MISSING_STREAM_HASHES,
1195                 .cbs = *cbs,
1196         };
1197         struct read_stream_list_callbacks hasher_cbs = {
1198                 .begin_stream           = hasher_begin_stream,
1199                 .begin_stream_ctx       = &hasher_ctx,
1200                 .consume_chunk          = hasher_consume_chunk,
1201                 .consume_chunk_ctx      = &hasher_ctx,
1202                 .end_stream             = hasher_end_stream,
1203                 .end_stream_ctx         = &hasher_ctx,
1204         };
1205         return read_full_stream_with_cbs(lte, &hasher_cbs);
1206 }
1207
1208 static int
1209 read_packed_streams(struct wim_lookup_table_entry *first_stream,
1210                     struct wim_lookup_table_entry *last_stream,
1211                     u64 stream_count,
1212                     size_t list_head_offset,
1213                     const struct read_stream_list_callbacks *sink_cbs)
1214 {
1215         struct data_range *ranges;
1216         bool ranges_malloced;
1217         struct wim_lookup_table_entry *cur_stream;
1218         size_t i;
1219         int ret;
1220         u64 ranges_alloc_size;
1221
1222         DEBUG("Reading %"PRIu64" streams combined in same WIM resource",
1223               stream_count);
1224
1225         /* Setup data ranges array (one range per stream to read); this way
1226          * read_compressed_wim_resource() does not need to be aware of streams.
1227          */
1228
1229         ranges_alloc_size = stream_count * sizeof(ranges[0]);
1230
1231         if (unlikely((size_t)ranges_alloc_size != ranges_alloc_size)) {
1232                 ERROR("Too many streams in one resource!");
1233                 return WIMLIB_ERR_NOMEM;
1234         }
1235         if (likely(ranges_alloc_size <= STACK_MAX)) {
1236                 ranges = alloca(ranges_alloc_size);
1237                 ranges_malloced = false;
1238         } else {
1239                 ranges = MALLOC(ranges_alloc_size);
1240                 if (ranges == NULL) {
1241                         ERROR("Too many streams in one resource!");
1242                         return WIMLIB_ERR_NOMEM;
1243                 }
1244                 ranges_malloced = true;
1245         }
1246
1247         for (i = 0, cur_stream = first_stream;
1248              i < stream_count;
1249              i++, cur_stream = next_stream(cur_stream, list_head_offset))
1250         {
1251                 ranges[i].offset = cur_stream->offset_in_res;
1252                 ranges[i].size = cur_stream->size;
1253         }
1254
1255         struct streamifier_context streamifier_ctx = {
1256                 .cbs                    = *sink_cbs,
1257                 .cur_stream             = first_stream,
1258                 .next_stream            = next_stream(first_stream, list_head_offset),
1259                 .cur_stream_offset      = 0,
1260                 .final_stream           = last_stream,
1261                 .list_head_offset       = list_head_offset,
1262         };
1263
1264         ret = read_compressed_wim_resource(first_stream->rspec,
1265                                            ranges,
1266                                            stream_count,
1267                                            streamifier_cb,
1268                                            &streamifier_ctx);
1269
1270         if (ranges_malloced)
1271                 FREE(ranges);
1272
1273         if (ret) {
1274                 if (streamifier_ctx.cur_stream_offset != 0) {
1275                         ret = (*streamifier_ctx.cbs.end_stream)
1276                                 (streamifier_ctx.cur_stream,
1277                                  ret,
1278                                  streamifier_ctx.cbs.end_stream_ctx);
1279                 }
1280         }
1281         return ret;
1282 }
1283
1284 /*
1285  * Read a list of streams, each of which may be in any supported location (e.g.
1286  * in a WIM or in an external file).  Unlike read_stream_prefix() or the
1287  * functions which call it, this function optimizes the case where multiple
1288  * streams are packed into a single compressed WIM resource and reads them all
1289  * consecutively, only decompressing the data one time.
1290  *
1291  * @stream_list
1292  *      List of streams (represented as `struct wim_lookup_table_entry's) to
1293  *      read.
1294  * @list_head_offset
1295  *      Offset of the `struct list_head' within each `struct
1296  *      wim_lookup_table_entry' that makes up the @stream_list.
1297  * @cbs
1298  *      Callback functions to accept the stream data.
1299  * @flags
1300  *      Bitwise OR of zero or more of the following flags:
1301  *
1302  *      VERIFY_STREAM_HASHES:
1303  *              For all streams being read that have already had SHA1 message
1304  *              digests computed, calculate the SHA1 message digest of the read
1305  *              data and compare it with the previously computed value.  If they
1306  *              do not match, return WIMLIB_ERR_INVALID_RESOURCE_HASH.
1307  *
1308  *      COMPUTE_MISSING_STREAM_HASHES
1309  *              For all streams being read that have not yet had their SHA1
1310  *              message digests computed, calculate and save their SHA1 message
1311  *              digests.
1312  *
1313  *      STREAM_LIST_ALREADY_SORTED
1314  *              @stream_list is already sorted in sequential order for reading.
1315  *
1316  * The callback functions are allowed to delete the current stream from the list
1317  * if necessary.
1318  *
1319  * Returns 0 on success; a nonzero error code on failure.  Failure can occur due
1320  * to an error reading the data or due to an error status being returned by any
1321  * of the callback functions.
1322  */
1323 int
1324 read_stream_list(struct list_head *stream_list,
1325                  size_t list_head_offset,
1326                  const struct read_stream_list_callbacks *cbs,
1327                  int flags)
1328 {
1329         int ret;
1330         struct list_head *cur, *next;
1331         struct wim_lookup_table_entry *lte;
1332         struct hasher_context *hasher_ctx;
1333         struct read_stream_list_callbacks *sink_cbs;
1334
1335         if (!(flags & STREAM_LIST_ALREADY_SORTED)) {
1336                 ret = sort_stream_list_by_sequential_order(stream_list, list_head_offset);
1337                 if (ret)
1338                         return ret;
1339         }
1340
1341         if (flags & (VERIFY_STREAM_HASHES | COMPUTE_MISSING_STREAM_HASHES)) {
1342                 hasher_ctx = alloca(sizeof(*hasher_ctx));
1343                 *hasher_ctx = (struct hasher_context) {
1344                         .flags  = flags,
1345                         .cbs    = *cbs,
1346                 };
1347                 sink_cbs = alloca(sizeof(*sink_cbs));
1348                 *sink_cbs = (struct read_stream_list_callbacks) {
1349                         .begin_stream           = hasher_begin_stream,
1350                         .begin_stream_ctx       = hasher_ctx,
1351                         .consume_chunk          = hasher_consume_chunk,
1352                         .consume_chunk_ctx      = hasher_ctx,
1353                         .end_stream             = hasher_end_stream,
1354                         .end_stream_ctx         = hasher_ctx,
1355                 };
1356         } else {
1357                 sink_cbs = (struct read_stream_list_callbacks*)cbs;
1358         }
1359
1360         for (cur = stream_list->next, next = cur->next;
1361              cur != stream_list;
1362              cur = next, next = cur->next)
1363         {
1364                 lte = (struct wim_lookup_table_entry*)((u8*)cur - list_head_offset);
1365
1366                 if (lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS &&
1367                     lte->size != lte->rspec->uncompressed_size)
1368                 {
1369
1370                         struct wim_lookup_table_entry *lte_next, *lte_last;
1371                         struct list_head *next2;
1372                         u64 stream_count;
1373
1374                         /* The next stream is a proper sub-sequence of a WIM
1375                          * resource.  See if there are other streams in the same
1376                          * resource that need to be read.  Since
1377                          * sort_stream_list_by_sequential_order() sorted the
1378                          * streams by offset in the WIM, this can be determined
1379                          * by simply scanning forward in the list.  */
1380
1381                         lte_last = lte;
1382                         stream_count = 1;
1383                         for (next2 = next;
1384                              next2 != stream_list
1385                              && (lte_next = (struct wim_lookup_table_entry*)
1386                                                 ((u8*)next2 - list_head_offset),
1387                                  lte_next->resource_location == RESOURCE_IN_WIM
1388                                  && lte_next->rspec == lte->rspec);
1389                              next2 = next2->next)
1390                         {
1391                                 lte_last = lte_next;
1392                                 stream_count++;
1393                         }
1394                         if (stream_count > 1) {
1395                                 /* Reading multiple streams combined into a
1396                                  * single WIM resource.  They are in the stream
1397                                  * list, sorted by offset; @lte specifies the
1398                                  * first stream in the resource that needs to be
1399                                  * read and @lte_last specifies the last stream
1400                                  * in the resource that needs to be read.  */
1401                                 next = next2;
1402                                 ret = read_packed_streams(lte, lte_last,
1403                                                           stream_count,
1404                                                           list_head_offset,
1405                                                           sink_cbs);
1406                                 if (ret)
1407                                         return ret;
1408                                 continue;
1409                         }
1410                 }
1411
1412                 ret = read_full_stream_with_cbs(lte, sink_cbs);
1413                 if (ret && ret != BEGIN_STREAM_STATUS_SKIP_STREAM)
1414                         return ret;
1415         }
1416         return 0;
1417 }
1418
1419 /* Extract the first @size bytes of the specified stream.
1420  *
1421  * If @size specifies the full uncompressed size of the stream, then the SHA1
1422  * message digest of the uncompressed stream is checked while being extracted.
1423  *
1424  * The uncompressed data of the resource is passed in chunks of unspecified size
1425  * to the @extract_chunk function, passing it @extract_chunk_arg.  */
1426 int
1427 extract_stream(struct wim_lookup_table_entry *lte, u64 size,
1428                consume_data_callback_t extract_chunk, void *extract_chunk_arg)
1429 {
1430         wimlib_assert(size <= lte->size);
1431         if (size == lte->size) {
1432                 /* Do SHA1.  */
1433                 struct read_stream_list_callbacks cbs = {
1434                         .consume_chunk          = extract_chunk,
1435                         .consume_chunk_ctx      = extract_chunk_arg,
1436                 };
1437                 return read_full_stream_with_sha1(lte, &cbs);
1438         } else {
1439                 /* Don't do SHA1.  */
1440                 return read_stream_prefix(lte, size, extract_chunk,
1441                                           extract_chunk_arg);
1442         }
1443 }
1444
1445 /* A consume_data_callback_t implementation that writes the chunk of data to a
1446  * file descriptor.  */
1447 int
1448 extract_chunk_to_fd(const void *chunk, size_t size, void *_fd_p)
1449 {
1450         struct filedes *fd = _fd_p;
1451
1452         int ret = full_write(fd, chunk, size);
1453         if (ret) {
1454                 ERROR_WITH_ERRNO("Error writing to file descriptor");
1455                 return ret;
1456         }
1457         return 0;
1458 }
1459
1460 /* Extract the first @size bytes of the specified stream to the specified file
1461  * descriptor.  */
1462 int
1463 extract_stream_to_fd(struct wim_lookup_table_entry *lte,
1464                      struct filedes *fd, u64 size)
1465 {
1466         return extract_stream(lte, size, extract_chunk_to_fd, fd);
1467 }
1468
1469 /* Extract the full uncompressed contents of the specified stream to the
1470  * specified file descriptor.  */
1471 int
1472 extract_full_stream_to_fd(struct wim_lookup_table_entry *lte,
1473                           struct filedes *fd)
1474 {
1475         return extract_stream_to_fd(lte, fd, lte->size);
1476 }
1477
1478 /* Calculate the SHA1 message digest of a stream and store it in @lte->hash.  */
1479 int
1480 sha1_stream(struct wim_lookup_table_entry *lte)
1481 {
1482         wimlib_assert(lte->unhashed);
1483         struct read_stream_list_callbacks cbs = {
1484         };
1485         return read_full_stream_with_sha1(lte, &cbs);
1486 }
1487
1488 /* Convert a short WIM resource header to a stand-alone WIM resource
1489  * specification.
1490  *
1491  * Note: for packed resources some fields still need to be overridden.
1492  */
1493 void
1494 wim_res_hdr_to_spec(const struct wim_reshdr *reshdr, WIMStruct *wim,
1495                     struct wim_resource_spec *rspec)
1496 {
1497         rspec->wim = wim;
1498         rspec->offset_in_wim = reshdr->offset_in_wim;
1499         rspec->size_in_wim = reshdr->size_in_wim;
1500         rspec->uncompressed_size = reshdr->uncompressed_size;
1501         INIT_LIST_HEAD(&rspec->stream_list);
1502         rspec->flags = reshdr->flags;
1503         rspec->is_pipable = wim_is_pipable(wim);
1504         if (rspec->flags & WIM_RESHDR_FLAG_COMPRESSED) {
1505                 rspec->compression_type = wim->compression_type;
1506                 rspec->chunk_size = wim->chunk_size;
1507         } else {
1508                 rspec->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
1509                 rspec->chunk_size = 0;
1510         }
1511 }
1512
1513 /* Convert a stand-alone resource specification to a WIM resource header.  */
1514 void
1515 wim_res_spec_to_hdr(const struct wim_resource_spec *rspec,
1516                     struct wim_reshdr *reshdr)
1517 {
1518         reshdr->offset_in_wim     = rspec->offset_in_wim;
1519         reshdr->size_in_wim       = rspec->size_in_wim;
1520         reshdr->flags             = rspec->flags;
1521         reshdr->uncompressed_size = rspec->uncompressed_size;
1522 }
1523
1524 /* Translates a WIM resource header from the on-disk format into an in-memory
1525  * format.  */
1526 void
1527 get_wim_reshdr(const struct wim_reshdr_disk *disk_reshdr,
1528                struct wim_reshdr *reshdr)
1529 {
1530         reshdr->offset_in_wim = le64_to_cpu(disk_reshdr->offset_in_wim);
1531         reshdr->size_in_wim = (((u64)disk_reshdr->size_in_wim[0] <<  0) |
1532                                ((u64)disk_reshdr->size_in_wim[1] <<  8) |
1533                                ((u64)disk_reshdr->size_in_wim[2] << 16) |
1534                                ((u64)disk_reshdr->size_in_wim[3] << 24) |
1535                                ((u64)disk_reshdr->size_in_wim[4] << 32) |
1536                                ((u64)disk_reshdr->size_in_wim[5] << 40) |
1537                                ((u64)disk_reshdr->size_in_wim[6] << 48));
1538         reshdr->uncompressed_size = le64_to_cpu(disk_reshdr->uncompressed_size);
1539         reshdr->flags = disk_reshdr->flags;
1540 }
1541
1542 /* Translates a WIM resource header from an in-memory format into the on-disk
1543  * format.  */
1544 void
1545 put_wim_reshdr(const struct wim_reshdr *reshdr,
1546                struct wim_reshdr_disk *disk_reshdr)
1547 {
1548         disk_reshdr->size_in_wim[0] = reshdr->size_in_wim  >>  0;
1549         disk_reshdr->size_in_wim[1] = reshdr->size_in_wim  >>  8;
1550         disk_reshdr->size_in_wim[2] = reshdr->size_in_wim  >> 16;
1551         disk_reshdr->size_in_wim[3] = reshdr->size_in_wim  >> 24;
1552         disk_reshdr->size_in_wim[4] = reshdr->size_in_wim  >> 32;
1553         disk_reshdr->size_in_wim[5] = reshdr->size_in_wim  >> 40;
1554         disk_reshdr->size_in_wim[6] = reshdr->size_in_wim  >> 48;
1555         disk_reshdr->flags = reshdr->flags;
1556         disk_reshdr->offset_in_wim = cpu_to_le64(reshdr->offset_in_wim);
1557         disk_reshdr->uncompressed_size = cpu_to_le64(reshdr->uncompressed_size);
1558 }