4 * Code for reading streams and resources, including compressed WIM resources.
8 * Copyright (C) 2012, 2013 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
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
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.
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/.
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"
40 /* for read_win32_file_prefix(), read_win32_encrypted_file_prefix() */
41 # include "wimlib/win32.h"
45 /* for read_ntfs_file_prefix() */
46 # include "wimlib/ntfs_3g.h"
58 * Compressed WIM resources
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.
69 * Additional information:
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.
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.
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.
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.
101 * read_compressed_wim_resource() -
103 * Read data from a compressed WIM resource.
106 * Specification of the compressed WIM resource to read from.
108 * Nonoverlapping, nonempty ranges of the uncompressed resource data to
109 * read, sorted by increasing offset.
111 * Number of ranges in @ranges; must be at least 1.
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.
118 * Parameter to pass to @cb_ctx.
120 * Possible return values:
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)
128 * or other error code returned by the @cb function.
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,
140 u64 *chunk_offsets = NULL;
143 bool chunk_offsets_malloced = false;
144 bool ubuf_malloced = false;
145 bool cbuf_malloced = false;
146 struct wimlib_decompressor *decompressor = NULL;
149 wimlib_assert(rspec != NULL);
150 wimlib_assert(resource_is_compressed(rspec));
151 wimlib_assert(cb != NULL);
152 wimlib_assert(num_ranges != 0);
153 for (size_t i = 0; i < num_ranges; i++) {
154 DEBUG("Range %zu/%zu: %"PRIu64"@+%"PRIu64" / %"PRIu64,
155 i + 1, num_ranges, ranges[i].size, ranges[i].offset,
156 rspec->uncompressed_size);
157 wimlib_assert(ranges[i].size != 0);
158 wimlib_assert(ranges[i].offset + ranges[i].size >= ranges[i].size);
159 wimlib_assert(ranges[i].offset + ranges[i].size <= rspec->uncompressed_size);
161 for (size_t i = 0; i < num_ranges - 1; i++)
162 wimlib_assert(ranges[i].offset + ranges[i].size <= ranges[i + 1].offset);
164 /* Get the offsets of the first and last bytes of the read. */
165 const u64 first_offset = ranges[0].offset;
166 const u64 last_offset = ranges[num_ranges - 1].offset + ranges[num_ranges - 1].size - 1;
168 /* Get the file descriptor for the WIM. */
169 struct filedes * const in_fd = &rspec->wim->in_fd;
171 /* Determine if we're reading a pipable resource from a pipe or not. */
172 const bool is_pipe_read = !filedes_is_seekable(in_fd);
174 /* Determine if the chunk table is in an altenate format. */
175 const bool alt_chunk_table = (rspec->flags & WIM_RESHDR_FLAG_PACKED_STREAMS)
178 /* Get the maximum size of uncompressed chunks in this resource, which
179 * we require be a power of 2. */
180 u64 cur_read_offset = rspec->offset_in_wim;
181 int ctype = rspec->compression_type;
182 u32 chunk_size = rspec->chunk_size;
183 if (alt_chunk_table) {
184 /* Alternate chunk table format. Its header specifies the chunk
185 * size and compression format. Note: it could be read here;
186 * however, the relevant data was already loaded into @rspec by
187 * read_wim_lookup_table(). */
188 cur_read_offset += sizeof(struct alt_chunk_table_header_disk);
191 if (!is_power_of_2(chunk_size)) {
192 ERROR("Invalid compressed resource: "
193 "expected power-of-2 chunk size (got %"PRIu32")",
195 ret = WIMLIB_ERR_INVALID_CHUNK_SIZE;
196 goto out_free_memory;
199 /* Get valid decompressor. */
200 if (ctype == rspec->wim->decompressor_ctype &&
201 chunk_size == rspec->wim->decompressor_max_block_size)
203 /* Cached decompressor. */
204 decompressor = rspec->wim->decompressor;
205 rspec->wim->decompressor_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
206 rspec->wim->decompressor = NULL;
208 ret = wimlib_create_decompressor(ctype, chunk_size, NULL,
211 goto out_free_memory;
214 const u32 chunk_order = bsr32(chunk_size);
216 /* Calculate the total number of chunks the resource is divided into. */
217 const u64 num_chunks = (rspec->uncompressed_size + chunk_size - 1) >> chunk_order;
219 /* Calculate the 0-based indices of the first and last chunks containing
220 * data that needs to be passed to the callback. */
221 const u64 first_needed_chunk = first_offset >> chunk_order;
222 const u64 last_needed_chunk = last_offset >> chunk_order;
224 /* Calculate the 0-based index of the first chunk that actually needs to
225 * be read. This is normally first_needed_chunk, but for pipe reads we
226 * must always start from the 0th chunk. */
227 const u64 read_start_chunk = (is_pipe_read ? 0 : first_needed_chunk);
229 /* Calculate the number of chunk offsets that are needed for the chunks
231 const u64 num_needed_chunk_offsets =
232 last_needed_chunk - read_start_chunk + 1 +
233 (last_needed_chunk < num_chunks - 1);
235 /* Calculate the number of entries in the chunk table. Normally, it's
236 * one less than the number of chunks, since the first chunk has no
237 * entry. But in the alternate chunk table format, the chunk entries
238 * contain chunk sizes, not offsets, and there is one per chunk. */
239 const u64 num_chunk_entries = (alt_chunk_table ? num_chunks : num_chunks - 1);
241 /* Set the size of each chunk table entry based on the resource's
242 * uncompressed size. */
243 const u64 chunk_entry_size = get_chunk_entry_size(rspec->uncompressed_size,
246 /* Calculate the size of the chunk table in bytes. */
247 const u64 chunk_table_size = num_chunk_entries * chunk_entry_size;
249 /* Calculate the size of the chunk table in bytes, including the header
250 * in the case of the alternate chunk table format. */
251 const u64 chunk_table_full_size =
252 (alt_chunk_table) ? chunk_table_size + sizeof(struct alt_chunk_table_header_disk)
256 /* Read the needed chunk table entries into memory and use them
257 * to initialize the chunk_offsets array. */
259 u64 first_chunk_entry_to_read;
260 u64 last_chunk_entry_to_read;
262 if (alt_chunk_table) {
263 /* The alternate chunk table contains chunk sizes, not
264 * offsets, so we always must read all preceding entries
265 * in order to determine offsets. */
266 first_chunk_entry_to_read = 0;
267 last_chunk_entry_to_read = last_needed_chunk;
269 /* Here we must account for the fact that the first
270 * chunk has no explicit chunk table entry. */
272 if (read_start_chunk == 0)
273 first_chunk_entry_to_read = 0;
275 first_chunk_entry_to_read = read_start_chunk - 1;
277 if (last_needed_chunk == 0)
278 last_chunk_entry_to_read = 0;
280 last_chunk_entry_to_read = last_needed_chunk - 1;
282 if (last_needed_chunk < num_chunks - 1)
283 last_chunk_entry_to_read++;
286 const u64 num_chunk_entries_to_read =
287 last_chunk_entry_to_read - first_chunk_entry_to_read + 1;
289 const u64 chunk_offsets_alloc_size =
290 max(num_chunk_entries_to_read,
291 num_needed_chunk_offsets) * sizeof(chunk_offsets[0]);
293 if ((size_t)chunk_offsets_alloc_size != chunk_offsets_alloc_size)
296 if (chunk_offsets_alloc_size <= STACK_MAX) {
297 chunk_offsets = alloca(chunk_offsets_alloc_size);
299 chunk_offsets = MALLOC(chunk_offsets_alloc_size);
300 if (chunk_offsets == NULL)
302 chunk_offsets_malloced = true;
305 const size_t chunk_table_size_to_read =
306 num_chunk_entries_to_read * chunk_entry_size;
308 const u64 file_offset_of_needed_chunk_entries =
310 + (first_chunk_entry_to_read * chunk_entry_size)
311 + (rspec->is_pipable ? (rspec->size_in_wim - chunk_table_size) : 0);
313 void * const chunk_table_data =
315 chunk_offsets_alloc_size -
316 chunk_table_size_to_read;
318 ret = full_pread(in_fd, chunk_table_data, chunk_table_size_to_read,
319 file_offset_of_needed_chunk_entries);
323 /* Now fill in chunk_offsets from the entries we have read in
324 * chunk_tab_data. We break aliasing rules here to avoid having
325 * to allocate yet another array. */
326 typedef le64 __attribute__((may_alias)) aliased_le64_t;
327 typedef le32 __attribute__((may_alias)) aliased_le32_t;
328 u64 * chunk_offsets_p = chunk_offsets;
330 if (alt_chunk_table) {
332 aliased_le32_t *raw_entries = chunk_table_data;
334 for (size_t i = 0; i < num_chunk_entries_to_read; i++) {
335 u32 entry = le32_to_cpu(raw_entries[i]);
336 if (i >= read_start_chunk)
337 *chunk_offsets_p++ = cur_offset;
340 if (last_needed_chunk < num_chunks - 1)
341 *chunk_offsets_p = cur_offset;
343 if (read_start_chunk == 0)
344 *chunk_offsets_p++ = 0;
346 if (chunk_entry_size == 4) {
347 aliased_le32_t *raw_entries = chunk_table_data;
348 for (size_t i = 0; i < num_chunk_entries_to_read; i++)
349 *chunk_offsets_p++ = le32_to_cpu(raw_entries[i]);
351 aliased_le64_t *raw_entries = chunk_table_data;
352 for (size_t i = 0; i < num_chunk_entries_to_read; i++)
353 *chunk_offsets_p++ = le64_to_cpu(raw_entries[i]);
357 /* Set offset to beginning of first chunk to read. */
358 cur_read_offset += chunk_offsets[0];
359 if (rspec->is_pipable)
360 cur_read_offset += read_start_chunk * sizeof(struct pwm_chunk_hdr);
362 cur_read_offset += chunk_table_size;
365 /* Allocate buffer for holding the uncompressed data of each chunk. */
366 if (chunk_size <= STACK_MAX) {
367 ubuf = alloca(chunk_size);
369 ubuf = MALLOC(chunk_size);
372 ubuf_malloced = true;
375 /* Allocate a temporary buffer for reading compressed chunks, each of
376 * which can be at most @chunk_size - 1 bytes. This excludes compressed
377 * chunks that are a full @chunk_size bytes, which are actually stored
379 if (chunk_size - 1 <= STACK_MAX) {
380 cbuf = alloca(chunk_size - 1);
382 cbuf = MALLOC(chunk_size - 1);
385 cbuf_malloced = true;
388 /* Set current data range. */
389 const struct data_range *cur_range = ranges;
390 const struct data_range * const end_range = &ranges[num_ranges];
391 u64 cur_range_pos = cur_range->offset;
392 u64 cur_range_end = cur_range->offset + cur_range->size;
394 /* Read and process each needed chunk. */
395 for (u64 i = read_start_chunk; i <= last_needed_chunk; i++) {
397 /* Calculate uncompressed size of next chunk. */
399 if ((i == num_chunks - 1) && (rspec->uncompressed_size & (chunk_size - 1)))
400 chunk_usize = (rspec->uncompressed_size & (chunk_size - 1));
402 chunk_usize = chunk_size;
404 /* Calculate compressed size of next chunk. */
407 struct pwm_chunk_hdr chunk_hdr;
409 ret = full_pread(in_fd, &chunk_hdr,
410 sizeof(chunk_hdr), cur_read_offset);
413 chunk_csize = le32_to_cpu(chunk_hdr.compressed_size);
415 if (i == num_chunks - 1) {
416 chunk_csize = rspec->size_in_wim -
417 chunk_table_full_size -
418 chunk_offsets[i - read_start_chunk];
419 if (rspec->is_pipable)
420 chunk_csize -= num_chunks * sizeof(struct pwm_chunk_hdr);
422 chunk_csize = chunk_offsets[i + 1 - read_start_chunk] -
423 chunk_offsets[i - read_start_chunk];
426 if (chunk_csize == 0 || chunk_csize > chunk_usize) {
427 ERROR("Invalid chunk size in compressed resource!");
429 ret = WIMLIB_ERR_DECOMPRESSION;
430 goto out_free_memory;
432 if (rspec->is_pipable)
433 cur_read_offset += sizeof(struct pwm_chunk_hdr);
435 /* Offsets in the uncompressed resource at which this chunk
436 * starts and ends. */
437 const u64 chunk_start_offset = i << chunk_order;
438 const u64 chunk_end_offset = chunk_start_offset + chunk_usize;
440 if (chunk_end_offset <= cur_range_pos) {
442 /* The next range does not require data in this chunk,
444 cur_read_offset += chunk_csize;
448 ret = full_pread(in_fd, &dummy, 1, cur_read_offset - 1);
454 /* Read the chunk and feed data to the callback
458 if (chunk_csize == chunk_usize)
463 ret = full_pread(in_fd,
470 if (read_buf == cbuf) {
471 DEBUG("Decompressing chunk %"PRIu64" "
472 "(csize=%"PRIu32" usize=%"PRIu32")",
473 i, chunk_csize, chunk_usize);
474 ret = wimlib_decompress(cbuf,
480 ERROR("Failed to decompress data!");
481 ret = WIMLIB_ERR_DECOMPRESSION;
483 goto out_free_memory;
486 cur_read_offset += chunk_csize;
488 /* At least one range requires data in this chunk. */
490 size_t start, end, size;
492 /* Calculate how many bytes of data should be
493 * sent to the callback function, taking into
494 * account that data sent to the callback
495 * function must not overlap range boundaries.
497 start = cur_range_pos - chunk_start_offset;
498 end = min(cur_range_end, chunk_end_offset) - chunk_start_offset;
501 ret = (*cb)(&ubuf[start], size, cb_ctx);
504 goto out_free_memory;
506 cur_range_pos += size;
507 if (cur_range_pos == cur_range_end) {
508 /* Advance to next range. */
509 if (++cur_range == end_range) {
510 cur_range_pos = ~0ULL;
512 cur_range_pos = cur_range->offset;
513 cur_range_end = cur_range->offset + cur_range->size;
516 } while (cur_range_pos < chunk_end_offset);
521 last_offset == rspec->uncompressed_size - 1 &&
525 /* If reading a pipable resource from a pipe and the full data
526 * was requested, skip the chunk table at the end so that the
527 * file descriptor is fully clear of the resource after this
529 cur_read_offset += chunk_table_size;
530 ret = full_pread(in_fd, &dummy, 1, cur_read_offset - 1);
539 wimlib_free_decompressor(rspec->wim->decompressor);
540 rspec->wim->decompressor = decompressor;
541 rspec->wim->decompressor_ctype = ctype;
542 rspec->wim->decompressor_max_block_size = chunk_size;
544 if (chunk_offsets_malloced)
554 ERROR("Not enough memory available to read size=%"PRIu64" bytes "
555 "from compressed WIM resource!", last_offset - first_offset + 1);
557 ret = WIMLIB_ERR_NOMEM;
558 goto out_free_memory;
561 ERROR_WITH_ERRNO("Error reading compressed WIM resource!");
562 goto out_free_memory;
566 fill_zeroes(u64 size, consume_data_callback_t cb, void *cb_ctx)
568 if (unlikely(size)) {
569 u8 buf[min(size, BUFFER_SIZE)];
571 memset(buf, 0, sizeof(buf));
577 len = min(size, BUFFER_SIZE);
578 ret = cb(buf, len, cb_ctx);
587 /* Read raw data from a file descriptor at the specified offset, feeding the
588 * data it in chunks into the specified callback function. */
590 read_raw_file_data(struct filedes *in_fd, u64 offset, u64 size,
591 consume_data_callback_t cb, void *cb_ctx)
594 size_t bytes_to_read;
598 bytes_to_read = min(sizeof(buf), size);
599 ret = full_pread(in_fd, buf, bytes_to_read, offset);
601 ERROR_WITH_ERRNO("Read error");
604 ret = cb(buf, bytes_to_read, cb_ctx);
607 size -= bytes_to_read;
608 offset += bytes_to_read;
613 /* A consume_data_callback_t implementation that simply concatenates all chunks
616 bufferer_cb(const void *chunk, size_t size, void *_ctx)
620 *buf_p = mempcpy(*buf_p, chunk, size);
625 * read_partial_wim_resource()-
627 * Read a range of data from an uncompressed or compressed resource in a WIM
631 * Specification of the WIM resource to read from.
633 * Offset within the uncompressed resource at which to start reading.
635 * Number of bytes to read.
637 * Callback function to feed the data being read. Each call provides the
638 * next chunk of the requested data, uncompressed. Each chunk will be of
639 * nonzero size and will not cross range boundaries, but otherwise will be
640 * of unspecified size.
642 * Parameter to pass to @cb_ctx.
645 * WIMLIB_ERR_SUCCESS (0)
646 * WIMLIB_ERR_READ (errno set)
647 * WIMLIB_ERR_UNEXPECTED_END_OF_FILE (errno set to 0)
648 * WIMLIB_ERR_NOMEM (errno set to ENOMEM)
649 * WIMLIB_ERR_DECOMPRESSION (errno set to EINVAL)
651 * or other error code returned by the @cb function.
654 read_partial_wim_resource(const struct wim_resource_spec *rspec,
655 u64 offset, u64 size,
656 consume_data_callback_t cb, void *cb_ctx)
659 wimlib_assert(offset + size >= offset);
660 wimlib_assert(offset + size <= rspec->uncompressed_size);
662 DEBUG("Reading %"PRIu64" @ %"PRIu64" from WIM resource "
663 "%"PRIu64" => %"PRIu64" @ %"PRIu64,
664 size, offset, rspec->uncompressed_size,
665 rspec->size_in_wim, rspec->offset_in_wim);
671 if (resource_is_compressed(rspec)) {
672 struct data_range range = {
676 return read_compressed_wim_resource(rspec, &range, 1,
679 /* Reading uncompressed resource. For completeness, handle the
680 * weird case where size_in_wim < uncompressed_size. */
686 if (likely(offset + size <= rspec->size_in_wim) ||
692 if (offset >= rspec->size_in_wim) {
696 read_size = rspec->size_in_wim - offset;
697 zeroes_size = offset + size - rspec->size_in_wim;
701 ret = read_raw_file_data(&rspec->wim->in_fd,
702 rspec->offset_in_wim + offset,
709 return fill_zeroes(zeroes_size, cb, cb_ctx);
713 /* Read the specified range of uncompressed data from the specified stream,
714 * which must be located into a WIM file, into the specified buffer. */
716 read_partial_wim_stream_into_buf(const struct wim_lookup_table_entry *lte,
717 size_t size, u64 offset, void *_buf)
721 wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
723 return read_partial_wim_resource(lte->rspec,
724 lte->offset_in_res + offset,
730 /* A consume_data_callback_t implementation that simply ignores the data
733 skip_chunk_cb(const void *chunk, size_t size, void *_ctx)
738 /* Skip over the data of the specified stream, which must correspond to a full
741 skip_wim_stream(struct wim_lookup_table_entry *lte)
743 wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
744 wimlib_assert(!(lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS));
745 DEBUG("Skipping stream (size=%"PRIu64")", lte->size);
746 return read_partial_wim_resource(lte->rspec,
748 lte->rspec->uncompressed_size,
754 read_wim_stream_prefix(const struct wim_lookup_table_entry *lte, u64 size,
755 consume_data_callback_t cb, void *cb_ctx)
757 return read_partial_wim_resource(lte->rspec, lte->offset_in_res, size,
762 /* This function handles reading stream data that is located in an external
763 * file, such as a file that has been added to the WIM image through execution
764 * of a wimlib_add_command.
766 * This assumes the file can be accessed using the standard POSIX open(),
767 * read(), and close(). On Windows this will not necessarily be the case (since
768 * the file may need FILE_FLAG_BACKUP_SEMANTICS to be opened, or the file may be
769 * encrypted), so Windows uses its own code for its equivalent case. */
771 read_file_on_disk_prefix(const struct wim_lookup_table_entry *lte, u64 size,
772 consume_data_callback_t cb, void *cb_ctx)
778 wimlib_assert(size <= lte->size);
780 DEBUG("Reading %"PRIu64" bytes from \"%"TS"\"", size, lte->file_on_disk);
782 raw_fd = open(lte->file_on_disk, O_BINARY | O_RDONLY);
784 ERROR_WITH_ERRNO("Can't open \"%"TS"\"", lte->file_on_disk);
785 return WIMLIB_ERR_OPEN;
787 filedes_init(&fd, raw_fd);
788 ret = read_raw_file_data(&fd, 0, size, cb, cb_ctx);
792 #endif /* !__WIN32__ */
794 /* This function handles the trivial case of reading stream data that is, in
795 * fact, already located in an in-memory buffer. */
797 read_buffer_prefix(const struct wim_lookup_table_entry *lte,
798 u64 size, consume_data_callback_t cb, void *cb_ctx)
800 wimlib_assert(size <= lte->size);
801 return (*cb)(lte->attached_buffer, size, cb_ctx);
804 typedef int (*read_stream_prefix_handler_t)(const struct wim_lookup_table_entry *lte,
806 consume_data_callback_t cb,
810 * read_stream_prefix()-
812 * Reads the first @size bytes from a generic "stream", which may be located in
813 * any one of several locations, such as in a WIM file (compressed or
814 * uncompressed), in an external file, or directly in an in-memory buffer.
816 * This function feeds the data to a callback function @cb in chunks of
819 * Returns 0 on success; nonzero on error. A nonzero value will be returned if
820 * the stream data cannot be successfully read (for a number of different
821 * reasons, depending on the stream location), or if @cb returned nonzero in
822 * which case that error code will be returned.
825 read_stream_prefix(const struct wim_lookup_table_entry *lte, u64 size,
826 consume_data_callback_t cb, void *cb_ctx)
828 static const read_stream_prefix_handler_t handlers[] = {
829 [RESOURCE_IN_WIM] = read_wim_stream_prefix,
831 [RESOURCE_IN_FILE_ON_DISK] = read_win32_file_prefix,
833 [RESOURCE_IN_FILE_ON_DISK] = read_file_on_disk_prefix,
835 [RESOURCE_IN_ATTACHED_BUFFER] = read_buffer_prefix,
837 [RESOURCE_IN_STAGING_FILE] = read_file_on_disk_prefix,
840 [RESOURCE_IN_NTFS_VOLUME] = read_ntfs_file_prefix,
843 [RESOURCE_WIN32_ENCRYPTED] = read_win32_encrypted_file_prefix,
846 wimlib_assert(lte->resource_location < ARRAY_LEN(handlers)
847 && handlers[lte->resource_location] != NULL);
848 return handlers[lte->resource_location](lte, size, cb, cb_ctx);
851 /* Read the full uncompressed data of the specified stream into the specified
852 * buffer, which must have space for at least lte->size bytes. */
854 read_full_stream_into_buf(const struct wim_lookup_table_entry *lte, void *_buf)
857 return read_stream_prefix(lte, lte->size, bufferer_cb, &buf);
860 /* Retrieve the full uncompressed data of the specified stream. A buffer large
861 * enough hold the data is allocated and returned in @buf_ret. */
863 read_full_stream_into_alloc_buf(const struct wim_lookup_table_entry *lte,
869 if ((size_t)lte->size != lte->size) {
870 ERROR("Can't read %"PRIu64" byte stream into "
871 "memory", lte->size);
872 return WIMLIB_ERR_NOMEM;
875 buf = MALLOC(lte->size);
877 return WIMLIB_ERR_NOMEM;
879 ret = read_full_stream_into_buf(lte, buf);
889 /* Retrieve the full uncompressed data of the specified WIM resource. A buffer
890 * large enough hold the data is allocated and returned in @buf_ret. */
892 wim_resource_spec_to_data(struct wim_resource_spec *rspec, void **buf_ret)
895 struct wim_lookup_table_entry *lte;
897 lte = new_lookup_table_entry();
899 return WIMLIB_ERR_NOMEM;
901 lte_bind_wim_resource_spec(lte, rspec);
902 lte->flags = rspec->flags;
903 lte->size = rspec->uncompressed_size;
904 lte->offset_in_res = 0;
906 ret = read_full_stream_into_alloc_buf(lte, buf_ret);
908 lte_unbind_wim_resource_spec(lte);
909 free_lookup_table_entry(lte);
913 /* Retrieve the full uncompressed data of a WIM resource specified as a raw
914 * `wim_reshdr' and the corresponding WIM file. A large enough hold the data is
915 * allocated and returned in @buf_ret. */
917 wim_reshdr_to_data(const struct wim_reshdr *reshdr, WIMStruct *wim, void **buf_ret)
919 DEBUG("offset_in_wim=%"PRIu64", size_in_wim=%"PRIu64", "
920 "uncompressed_size=%"PRIu64,
921 reshdr->offset_in_wim, reshdr->size_in_wim,
922 reshdr->uncompressed_size);
924 struct wim_resource_spec rspec;
925 wim_res_hdr_to_spec(reshdr, wim, &rspec);
926 return wim_resource_spec_to_data(&rspec, buf_ret);
930 wim_reshdr_to_hash(const struct wim_reshdr *reshdr, WIMStruct *wim,
931 u8 hash[SHA1_HASH_SIZE])
933 struct wim_resource_spec rspec;
935 struct wim_lookup_table_entry *lte;
937 wim_res_hdr_to_spec(reshdr, wim, &rspec);
939 lte = new_lookup_table_entry();
941 return WIMLIB_ERR_NOMEM;
943 lte_bind_wim_resource_spec(lte, &rspec);
944 lte->flags = rspec.flags;
945 lte->size = rspec.uncompressed_size;
946 lte->offset_in_res = 0;
949 ret = sha1_stream(lte);
951 lte_unbind_wim_resource_spec(lte);
952 copy_hash(hash, lte->hash);
953 free_lookup_table_entry(lte);
957 struct streamifier_context {
958 struct read_stream_list_callbacks cbs;
959 struct wim_lookup_table_entry *cur_stream;
960 struct wim_lookup_table_entry *next_stream;
961 u64 cur_stream_offset;
962 struct wim_lookup_table_entry *final_stream;
963 size_t list_head_offset;
966 static struct wim_lookup_table_entry *
967 next_stream(struct wim_lookup_table_entry *lte, size_t list_head_offset)
969 struct list_head *cur;
971 cur = (struct list_head*)((u8*)lte + list_head_offset);
973 return (struct wim_lookup_table_entry*)((u8*)cur->next - list_head_offset);
976 /* A consume_data_callback_t implementation that translates raw resource data
977 * into streams, calling the begin_stream, consume_chunk, and end_stream
978 * callback functions as appropriate. */
980 streamifier_cb(const void *chunk, size_t size, void *_ctx)
982 struct streamifier_context *ctx = _ctx;
985 DEBUG("%zu bytes passed to streamifier", size);
987 wimlib_assert(ctx->cur_stream != NULL);
988 wimlib_assert(size <= ctx->cur_stream->size - ctx->cur_stream_offset);
990 if (ctx->cur_stream_offset == 0) {
993 /* Starting a new stream. */
994 DEBUG("Begin new stream (size=%"PRIu64").",
995 ctx->cur_stream->size);
997 flags = BEGIN_STREAM_FLAG_PARTIAL_RESOURCE;
998 if (size == ctx->cur_stream->size)
999 flags |= BEGIN_STREAM_FLAG_WHOLE_STREAM;
1000 ret = (*ctx->cbs.begin_stream)(ctx->cur_stream,
1002 ctx->cbs.begin_stream_ctx);
1007 /* Consume the chunk. */
1008 ret = (*ctx->cbs.consume_chunk)(chunk, size,
1009 ctx->cbs.consume_chunk_ctx);
1012 ctx->cur_stream_offset += size;
1014 if (ctx->cur_stream_offset == ctx->cur_stream->size) {
1015 /* Finished reading all the data for a stream. */
1017 ctx->cur_stream_offset = 0;
1019 DEBUG("End stream (size=%"PRIu64").", ctx->cur_stream->size);
1020 ret = (*ctx->cbs.end_stream)(ctx->cur_stream, 0,
1021 ctx->cbs.end_stream_ctx);
1025 /* Advance to next stream. */
1026 ctx->cur_stream = ctx->next_stream;
1027 if (ctx->cur_stream != NULL) {
1028 if (ctx->cur_stream != ctx->final_stream)
1029 ctx->next_stream = next_stream(ctx->cur_stream,
1030 ctx->list_head_offset);
1032 ctx->next_stream = NULL;
1038 struct hasher_context {
1041 struct read_stream_list_callbacks cbs;
1044 /* Callback for starting to read a stream while calculating its SHA1 message
1047 hasher_begin_stream(struct wim_lookup_table_entry *lte, u32 flags,
1050 struct hasher_context *ctx = _ctx;
1052 sha1_init(&ctx->sha_ctx);
1054 if (ctx->cbs.begin_stream == NULL)
1057 return (*ctx->cbs.begin_stream)(lte, flags,
1058 ctx->cbs.begin_stream_ctx);
1061 /* A consume_data_callback_t implementation that continues calculating the SHA1
1062 * message digest of the stream being read, then optionally passes the data on
1063 * to another consume_data_callback_t implementation. This allows checking the
1064 * SHA1 message digest of a stream being extracted, for example. */
1066 hasher_consume_chunk(const void *chunk, size_t size, void *_ctx)
1068 struct hasher_context *ctx = _ctx;
1070 sha1_update(&ctx->sha_ctx, chunk, size);
1071 if (ctx->cbs.consume_chunk == NULL)
1074 return (*ctx->cbs.consume_chunk)(chunk, size, ctx->cbs.consume_chunk_ctx);
1078 get_sha1_string(const u8 md[SHA1_HASH_SIZE], tchar *str)
1080 for (size_t i = 0; i < SHA1_HASH_SIZE; i++)
1081 str += tsprintf(str, T("%02x"), md[i]);
1084 /* Callback for finishing reading a stream while calculating its SHA1 message
1087 hasher_end_stream(struct wim_lookup_table_entry *lte, int status, void *_ctx)
1089 struct hasher_context *ctx = _ctx;
1090 u8 hash[SHA1_HASH_SIZE];
1094 /* Error occurred; the full stream may not have been read. */
1099 /* Retrieve the final SHA1 message digest. */
1100 sha1_final(hash, &ctx->sha_ctx);
1102 if (lte->unhashed) {
1103 if (ctx->flags & COMPUTE_MISSING_STREAM_HASHES) {
1104 /* No SHA1 message digest was previously present for the
1105 * stream. Set it to the one just calculated. */
1106 DEBUG("Set SHA1 message digest for stream "
1107 "(size=%"PRIu64").", lte->size);
1108 copy_hash(lte->hash, hash);
1111 if (ctx->flags & VERIFY_STREAM_HASHES) {
1112 /* The stream already had a SHA1 message digest present. Verify
1113 * that it is the same as the calculated value. */
1114 if (!hashes_equal(hash, lte->hash)) {
1115 if (wimlib_print_errors) {
1116 tchar expected_hashstr[SHA1_HASH_SIZE * 2 + 1];
1117 tchar actual_hashstr[SHA1_HASH_SIZE * 2 + 1];
1118 get_sha1_string(lte->hash, expected_hashstr);
1119 get_sha1_string(hash, actual_hashstr);
1120 ERROR("The stream is corrupted!\n"
1121 " (Expected SHA1=%"TS",\n"
1123 expected_hashstr, actual_hashstr);
1125 ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
1129 DEBUG("SHA1 message digest okay for "
1130 "stream (size=%"PRIu64").", lte->size);
1135 if (ctx->cbs.end_stream == NULL)
1138 return (*ctx->cbs.end_stream)(lte, ret, ctx->cbs.end_stream_ctx);
1142 read_full_stream_with_cbs(struct wim_lookup_table_entry *lte,
1143 const struct read_stream_list_callbacks *cbs)
1147 ret = (*cbs->begin_stream)(lte, 0, cbs->begin_stream_ctx);
1151 ret = read_stream_prefix(lte, lte->size, cbs->consume_chunk,
1152 cbs->consume_chunk_ctx);
1154 return (*cbs->end_stream)(lte, ret, cbs->end_stream_ctx);
1157 /* Read the full data of the specified stream, passing the data into the
1158 * specified callbacks (all of which are optional) and either checking or
1159 * computing the SHA1 message digest of the stream. */
1161 read_full_stream_with_sha1(struct wim_lookup_table_entry *lte,
1162 const struct read_stream_list_callbacks *cbs)
1164 struct hasher_context hasher_ctx = {
1165 .flags = VERIFY_STREAM_HASHES | COMPUTE_MISSING_STREAM_HASHES,
1168 struct read_stream_list_callbacks hasher_cbs = {
1169 .begin_stream = hasher_begin_stream,
1170 .begin_stream_ctx = &hasher_ctx,
1171 .consume_chunk = hasher_consume_chunk,
1172 .consume_chunk_ctx = &hasher_ctx,
1173 .end_stream = hasher_end_stream,
1174 .end_stream_ctx = &hasher_ctx,
1176 return read_full_stream_with_cbs(lte, &hasher_cbs);
1180 read_packed_streams(struct wim_lookup_table_entry *first_stream,
1181 struct wim_lookup_table_entry *last_stream,
1183 size_t list_head_offset,
1184 const struct read_stream_list_callbacks *sink_cbs)
1186 struct data_range *ranges;
1187 bool ranges_malloced;
1188 struct wim_lookup_table_entry *cur_stream;
1191 u64 ranges_alloc_size;
1193 DEBUG("Reading %"PRIu64" streams combined in same WIM resource",
1196 /* Setup data ranges array (one range per stream to read); this way
1197 * read_compressed_wim_resource() does not need to be aware of streams.
1200 ranges_alloc_size = stream_count * sizeof(ranges[0]);
1202 if (unlikely((size_t)ranges_alloc_size != ranges_alloc_size)) {
1203 ERROR("Too many streams in one resource!");
1204 return WIMLIB_ERR_NOMEM;
1206 if (likely(ranges_alloc_size <= STACK_MAX)) {
1207 ranges = alloca(ranges_alloc_size);
1208 ranges_malloced = false;
1210 ranges = MALLOC(ranges_alloc_size);
1211 if (ranges == NULL) {
1212 ERROR("Too many streams in one resource!");
1213 return WIMLIB_ERR_NOMEM;
1215 ranges_malloced = true;
1218 for (i = 0, cur_stream = first_stream;
1220 i++, cur_stream = next_stream(cur_stream, list_head_offset))
1222 ranges[i].offset = cur_stream->offset_in_res;
1223 ranges[i].size = cur_stream->size;
1226 struct streamifier_context streamifier_ctx = {
1228 .cur_stream = first_stream,
1229 .next_stream = next_stream(first_stream, list_head_offset),
1230 .cur_stream_offset = 0,
1231 .final_stream = last_stream,
1232 .list_head_offset = list_head_offset,
1235 ret = read_compressed_wim_resource(first_stream->rspec,
1241 if (ranges_malloced)
1245 if (streamifier_ctx.cur_stream_offset != 0) {
1246 ret = (*streamifier_ctx.cbs.end_stream)
1247 (streamifier_ctx.cur_stream,
1249 streamifier_ctx.cbs.end_stream_ctx);
1256 * Read a list of streams, each of which may be in any supported location (e.g.
1257 * in a WIM or in an external file). Unlike read_stream_prefix() or the
1258 * functions which call it, this function optimizes the case where multiple
1259 * streams are packed into a single compressed WIM resource and reads them all
1260 * consecutively, only decompressing the data one time.
1263 * List of streams (represented as `struct wim_lookup_table_entry's) to
1266 * Offset of the `struct list_head' within each `struct
1267 * wim_lookup_table_entry' that makes up the @stream_list.
1269 * Callback functions to accept the stream data.
1271 * Bitwise OR of zero or more of the following flags:
1273 * VERIFY_STREAM_HASHES:
1274 * For all streams being read that have already had SHA1 message
1275 * digests computed, calculate the SHA1 message digest of the read
1276 * data and compare it with the previously computed value. If they
1277 * do not match, return WIMLIB_ERR_INVALID_RESOURCE_HASH.
1279 * COMPUTE_MISSING_STREAM_HASHES
1280 * For all streams being read that have not yet had their SHA1
1281 * message digests computed, calculate and save their SHA1 message
1284 * STREAM_LIST_ALREADY_SORTED
1285 * @stream_list is already sorted in sequential order for reading.
1287 * The callback functions are allowed to delete the current stream from the list
1290 * Returns 0 on success; a nonzero error code on failure. Failure can occur due
1291 * to an error reading the data or due to an error status being returned by any
1292 * of the callback functions.
1295 read_stream_list(struct list_head *stream_list,
1296 size_t list_head_offset,
1297 const struct read_stream_list_callbacks *cbs,
1301 struct list_head *cur, *next;
1302 struct wim_lookup_table_entry *lte;
1303 struct hasher_context *hasher_ctx;
1304 struct read_stream_list_callbacks *sink_cbs;
1306 if (!(flags & STREAM_LIST_ALREADY_SORTED)) {
1307 ret = sort_stream_list_by_sequential_order(stream_list, list_head_offset);
1312 if (flags & (VERIFY_STREAM_HASHES | COMPUTE_MISSING_STREAM_HASHES)) {
1313 hasher_ctx = alloca(sizeof(*hasher_ctx));
1314 *hasher_ctx = (struct hasher_context) {
1318 sink_cbs = alloca(sizeof(*sink_cbs));
1319 *sink_cbs = (struct read_stream_list_callbacks) {
1320 .begin_stream = hasher_begin_stream,
1321 .begin_stream_ctx = hasher_ctx,
1322 .consume_chunk = hasher_consume_chunk,
1323 .consume_chunk_ctx = hasher_ctx,
1324 .end_stream = hasher_end_stream,
1325 .end_stream_ctx = hasher_ctx,
1328 sink_cbs = (struct read_stream_list_callbacks*)cbs;
1331 for (cur = stream_list->next, next = cur->next;
1333 cur = next, next = cur->next)
1335 lte = (struct wim_lookup_table_entry*)((u8*)cur - list_head_offset);
1337 if (lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS &&
1338 lte->size != lte->rspec->uncompressed_size)
1341 struct wim_lookup_table_entry *lte_next, *lte_last;
1342 struct list_head *next2;
1345 /* The next stream is a proper sub-sequence of a WIM
1346 * resource. See if there are other streams in the same
1347 * resource that need to be read. Since
1348 * sort_stream_list_by_sequential_order() sorted the
1349 * streams by offset in the WIM, this can be determined
1350 * by simply scanning forward in the list. */
1355 next2 != stream_list
1356 && (lte_next = (struct wim_lookup_table_entry*)
1357 ((u8*)next2 - list_head_offset),
1358 lte_next->resource_location == RESOURCE_IN_WIM
1359 && lte_next->rspec == lte->rspec);
1360 next2 = next2->next)
1362 lte_last = lte_next;
1365 if (stream_count > 1) {
1366 /* Reading multiple streams combined into a
1367 * single WIM resource. They are in the stream
1368 * list, sorted by offset; @lte specifies the
1369 * first stream in the resource that needs to be
1370 * read and @lte_last specifies the last stream
1371 * in the resource that needs to be read. */
1373 ret = read_packed_streams(lte, lte_last,
1383 ret = read_full_stream_with_cbs(lte, sink_cbs);
1384 if (ret && ret != BEGIN_STREAM_STATUS_SKIP_STREAM)
1390 /* Extract the first @size bytes of the specified stream.
1392 * If @size specifies the full uncompressed size of the stream, then the SHA1
1393 * message digest of the uncompressed stream is checked while being extracted.
1395 * The uncompressed data of the resource is passed in chunks of unspecified size
1396 * to the @extract_chunk function, passing it @extract_chunk_arg. */
1398 extract_stream(struct wim_lookup_table_entry *lte, u64 size,
1399 consume_data_callback_t extract_chunk, void *extract_chunk_arg)
1401 wimlib_assert(size <= lte->size);
1402 if (size == lte->size) {
1404 struct read_stream_list_callbacks cbs = {
1405 .consume_chunk = extract_chunk,
1406 .consume_chunk_ctx = extract_chunk_arg,
1408 return read_full_stream_with_sha1(lte, &cbs);
1410 /* Don't do SHA1. */
1411 return read_stream_prefix(lte, size, extract_chunk,
1416 /* A consume_data_callback_t implementation that writes the chunk of data to a
1417 * file descriptor. */
1419 extract_chunk_to_fd(const void *chunk, size_t size, void *_fd_p)
1421 struct filedes *fd = _fd_p;
1423 int ret = full_write(fd, chunk, size);
1425 ERROR_WITH_ERRNO("Error writing to file descriptor");
1431 /* Extract the first @size bytes of the specified stream to the specified file
1434 extract_stream_to_fd(struct wim_lookup_table_entry *lte,
1435 struct filedes *fd, u64 size)
1437 return extract_stream(lte, size, extract_chunk_to_fd, fd);
1440 /* Extract the full uncompressed contents of the specified stream to the
1441 * specified file descriptor. */
1443 extract_full_stream_to_fd(struct wim_lookup_table_entry *lte,
1446 return extract_stream_to_fd(lte, fd, lte->size);
1449 /* Calculate the SHA1 message digest of a stream and store it in @lte->hash. */
1451 sha1_stream(struct wim_lookup_table_entry *lte)
1453 wimlib_assert(lte->unhashed);
1454 struct read_stream_list_callbacks cbs = {
1456 return read_full_stream_with_sha1(lte, &cbs);
1459 /* Convert a short WIM resource header to a stand-alone WIM resource
1462 * Note: for packed resources some fields still need to be overridden.
1465 wim_res_hdr_to_spec(const struct wim_reshdr *reshdr, WIMStruct *wim,
1466 struct wim_resource_spec *rspec)
1469 rspec->offset_in_wim = reshdr->offset_in_wim;
1470 rspec->size_in_wim = reshdr->size_in_wim;
1471 rspec->uncompressed_size = reshdr->uncompressed_size;
1472 INIT_LIST_HEAD(&rspec->stream_list);
1473 rspec->flags = reshdr->flags;
1474 rspec->is_pipable = wim_is_pipable(wim);
1475 if (rspec->flags & WIM_RESHDR_FLAG_COMPRESSED) {
1476 rspec->compression_type = wim->compression_type;
1477 rspec->chunk_size = wim->chunk_size;
1479 rspec->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
1480 rspec->chunk_size = 0;
1484 /* Convert a stand-alone resource specification to a WIM resource header. */
1486 wim_res_spec_to_hdr(const struct wim_resource_spec *rspec,
1487 struct wim_reshdr *reshdr)
1489 reshdr->offset_in_wim = rspec->offset_in_wim;
1490 reshdr->size_in_wim = rspec->size_in_wim;
1491 reshdr->flags = rspec->flags;
1492 reshdr->uncompressed_size = rspec->uncompressed_size;
1495 /* Translates a WIM resource header from the on-disk format into an in-memory
1498 get_wim_reshdr(const struct wim_reshdr_disk *disk_reshdr,
1499 struct wim_reshdr *reshdr)
1501 reshdr->offset_in_wim = le64_to_cpu(disk_reshdr->offset_in_wim);
1502 reshdr->size_in_wim = (((u64)disk_reshdr->size_in_wim[0] << 0) |
1503 ((u64)disk_reshdr->size_in_wim[1] << 8) |
1504 ((u64)disk_reshdr->size_in_wim[2] << 16) |
1505 ((u64)disk_reshdr->size_in_wim[3] << 24) |
1506 ((u64)disk_reshdr->size_in_wim[4] << 32) |
1507 ((u64)disk_reshdr->size_in_wim[5] << 40) |
1508 ((u64)disk_reshdr->size_in_wim[6] << 48));
1509 reshdr->uncompressed_size = le64_to_cpu(disk_reshdr->uncompressed_size);
1510 reshdr->flags = disk_reshdr->flags;
1513 /* Translates a WIM resource header from an in-memory format into the on-disk
1516 put_wim_reshdr(const struct wim_reshdr *reshdr,
1517 struct wim_reshdr_disk *disk_reshdr)
1519 disk_reshdr->size_in_wim[0] = reshdr->size_in_wim >> 0;
1520 disk_reshdr->size_in_wim[1] = reshdr->size_in_wim >> 8;
1521 disk_reshdr->size_in_wim[2] = reshdr->size_in_wim >> 16;
1522 disk_reshdr->size_in_wim[3] = reshdr->size_in_wim >> 24;
1523 disk_reshdr->size_in_wim[4] = reshdr->size_in_wim >> 32;
1524 disk_reshdr->size_in_wim[5] = reshdr->size_in_wim >> 40;
1525 disk_reshdr->size_in_wim[6] = reshdr->size_in_wim >> 48;
1526 disk_reshdr->flags = reshdr->flags;
1527 disk_reshdr->offset_in_wim = cpu_to_le64(reshdr->offset_in_wim);
1528 disk_reshdr->uncompressed_size = cpu_to_le64(reshdr->uncompressed_size);