wimlib.net Git - wimlib/blob - src/resource.c

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