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

   1 /*
   2  * resource.c
   3  *
   4  * Read uncompressed and compressed metadata and file resources from a WIM file.
   5  */
   6
   7 /*
   8  * Copyright (C) 2012, 2013 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free Software
  14  * Foundation; either version 3 of the License, or (at your option) any later
  15  * version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along with
  22  * wimlib; if not, see http://www.gnu.org/licenses/.
  23  */
  24
  25 #include "wimlib_internal.h"
  26 #include "dentry.h"
  27 #include "lookup_table.h"
  28 #include "buffer_io.h"
  29 #include "lzx.h"
  30 #include "xpress.h"
  31 #include "sha1.h"
  32
  33 #ifdef __WIN32__
  34 #  include "win32.h"
  35 #endif
  36
  37 #include <errno.h>
  38 #include <stdarg.h>
  39 #include <stdlib.h>
  40 #include <unistd.h>
  41
  42 #ifdef WITH_NTFS_3G
  43 #  include <time.h>
  44 #  include <ntfs-3g/attrib.h>
  45 #  include <ntfs-3g/inode.h>
  46 #  include <ntfs-3g/dir.h>
  47 #endif
  48
  49 #if defined(__WIN32__) && !defined(INVALID_HANDLE_VALUE)
  50 #  define INVALID_HANDLE_VALUE ((HANDLE)(-1))
  51 #endif
  52
  53 /*
  54  * Reads all or part of a compressed resource into an in-memory buffer.
  55  *
  56  * @fp:                 The FILE* for the WIM file.
  57  * @resource_compressed_size:    The compressed size of the resource.
  58  * @resource_uncompressed_size:  The uncompressed size of the resource.
  59  * @resource_offset:             The offset of the start of the resource from
  60  *                                      the start of the stream @fp.
  61  * @resource_ctype:     The compression type of the resource.
  62  * @len:                The number of bytes of uncompressed data to read from
  63  *                              the resource.
  64  * @offset:             The offset of the bytes to read within the uncompressed
  65  *                              resource.
  66  * @contents_len:       An array into which the uncompressed data is written.
  67  *                              It must be at least @len bytes long.
  68  *
  69  * Returns zero on success, nonzero on failure.
  70  */
  71 static int
  72 read_compressed_resource(FILE *fp, u64 resource_compressed_size,
  73                          u64 resource_uncompressed_size,
  74                          u64 resource_offset, int resource_ctype,
  75                          u64 len, u64 offset, void *contents_ret)
  76 {
  77
  78         DEBUG2("comp size = %"PRIu64", uncomp size = %"PRIu64", "
  79                "res offset = %"PRIu64"",
  80                resource_compressed_size,
  81                resource_uncompressed_size,
  82                resource_offset);
  83         DEBUG2("resource_ctype = %"TS", len = %"PRIu64", offset = %"PRIu64"",
  84                wimlib_get_compression_type_string(resource_ctype), len, offset);
  85         /* Trivial case */
  86         if (len == 0)
  87                 return 0;
  88
  89         int (*decompress)(const void *, unsigned, void *, unsigned);
  90         /* Set the appropriate decompress function. */
  91         if (resource_ctype == WIMLIB_COMPRESSION_TYPE_LZX)
  92                 decompress = lzx_decompress;
  93         else
  94                 decompress = xpress_decompress;
  95
  96         /* The structure of a compressed resource consists of a table of chunk
  97          * offsets followed by the chunks themselves.  Each chunk consists of
  98          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
  99          * 32768 bytes of the uncompressed file, with the last chunk having any
 100          * remaining bytes.
 101          *
 102          * The chunk offsets are measured relative to the end of the chunk
 103          * table.  The first chunk is omitted from the table in the WIM file
 104          * because its offset is implicitly given by the fact that it directly
 105          * follows the chunk table and therefore must have an offset of 0.
 106          */
 107
 108         /* Calculate how many chunks the resource conists of in its entirety. */
 109         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
 110                                                                 WIM_CHUNK_SIZE;
 111         /* As mentioned, the first chunk has no entry in the chunk table. */
 112         u64 num_chunk_entries = num_chunks - 1;
 113
 114
 115         /* The index of the chunk that the read starts at. */
 116         u64 start_chunk = offset / WIM_CHUNK_SIZE;
 117         /* The byte offset at which the read starts, within the start chunk. */
 118         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
 119
 120         /* The index of the chunk that contains the last byte of the read. */
 121         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
 122         /* The byte offset of the last byte of the read, within the end chunk */
 123         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
 124
 125         /* Number of chunks that are actually needed to read the requested part
 126          * of the file. */
 127         u64 num_needed_chunks = end_chunk - start_chunk + 1;
 128
 129         /* If the end chunk is not the last chunk, an extra chunk entry is
 130          * needed because we need to know the offset of the chunk after the last
 131          * chunk read to figure out the size of the last read chunk. */
 132         if (end_chunk != num_chunks - 1)
 133                 num_needed_chunks++;
 134
 135         /* Declare the chunk table.  It will only contain offsets for the chunks
 136          * that are actually needed for this read. */
 137         u64 chunk_offsets[num_needed_chunks];
 138
 139         /* Set the implicit offset of the first chunk if it is included in the
 140          * needed chunks.
 141          *
 142          * Note: M$'s documentation includes a picture that shows the first
 143          * chunk starting right after the chunk entry table, labeled as offset
 144          * 0x10.  However, in the actual file format, the offset is measured
 145          * from the end of the chunk entry table, so the first chunk has an
 146          * offset of 0. */
 147         if (start_chunk == 0)
 148                 chunk_offsets[0] = 0;
 149
 150         /* According to M$'s documentation, if the uncompressed size of
 151          * the file is greater than 4 GB, the chunk entries are 8-byte
 152          * integers.  Otherwise, they are 4-byte integers. */
 153         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ?
 154                                                                         8 : 4;
 155
 156         /* Size of the full chunk table in the WIM file. */
 157         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
 158
 159         /* Read the needed chunk offsets from the table in the WIM file. */
 160
 161         /* Index, in the WIM file, of the first needed entry in the
 162          * chunk table. */
 163         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
 164
 165         /* Number of entries we need to actually read from the chunk
 166          * table (excludes the implicit first chunk). */
 167         u64 num_needed_chunk_entries = (start_chunk == 0) ?
 168                                 num_needed_chunks - 1 : num_needed_chunks;
 169
 170         /* Skip over unneeded chunk table entries. */
 171         u64 file_offset_of_needed_chunk_entries = resource_offset +
 172                                 start_table_idx * chunk_entry_size;
 173         if (fseeko(fp, file_offset_of_needed_chunk_entries, SEEK_SET) != 0) {
 174                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
 175                                  "chunk table of compressed resource",
 176                                  file_offset_of_needed_chunk_entries);
 177                 return WIMLIB_ERR_READ;
 178         }
 179
 180         /* Number of bytes we need to read from the chunk table. */
 181         size_t size = num_needed_chunk_entries * chunk_entry_size;
 182
 183         u8 chunk_tab_buf[size];
 184
 185         if (fread(chunk_tab_buf, 1, size, fp) != size)
 186                 goto err;
 187
 188         /* Now fill in chunk_offsets from the entries we have read in
 189          * chunk_tab_buf. */
 190
 191         u64 *chunk_tab_p = chunk_offsets;
 192         if (start_chunk == 0)
 193                 chunk_tab_p++;
 194
 195         if (chunk_entry_size == 4) {
 196                 u32 *entries = (u32*)chunk_tab_buf;
 197                 while (num_needed_chunk_entries--)
 198                         *chunk_tab_p++ = le32_to_cpu(*entries++);
 199         } else {
 200                 u64 *entries = (u64*)chunk_tab_buf;
 201                 while (num_needed_chunk_entries--)
 202                         *chunk_tab_p++ = le64_to_cpu(*entries++);
 203         }
 204
 205         /* Done with the chunk table now.  We must now seek to the first chunk
 206          * that is needed for the read. */
 207
 208         u64 file_offset_of_first_needed_chunk = resource_offset +
 209                                 chunk_table_size + chunk_offsets[0];
 210         if (fseeko(fp, file_offset_of_first_needed_chunk, SEEK_SET) != 0) {
 211                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
 212                                  "first chunk of compressed resource",
 213                                  file_offset_of_first_needed_chunk);
 214                 return WIMLIB_ERR_READ;
 215         }
 216
 217         /* Pointer to current position in the output buffer for uncompressed
 218          * data. */
 219         u8 *out_p = contents_ret;
 220
 221         /* Buffer for compressed data.  While most compressed chunks will have a
 222          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
 223          * size in the worst-case.  This assumption is valid only if chunks that
 224          * happen to compress to more than the uncompressed size (i.e. a
 225          * sequence of random bytes) are always stored uncompressed. But this seems
 226          * to be the case in M$'s WIM files, even though it is undocumented. */
 227         u8 compressed_buf[WIM_CHUNK_SIZE - 1];
 228
 229
 230         /* Decompress all the chunks. */
 231         for (u64 i = start_chunk; i <= end_chunk; i++) {
 232
 233                 DEBUG2("Chunk %"PRIu64" (start %"PRIu64", end %"PRIu64").",
 234                        i, start_chunk, end_chunk);
 235
 236                 /* Calculate the sizes of the compressed chunk and of the
 237                  * uncompressed chunk. */
 238                 unsigned compressed_chunk_size;
 239                 unsigned uncompressed_chunk_size;
 240                 if (i != num_chunks - 1) {
 241                         /* All the chunks except the last one in the resource
 242                          * expand to WIM_CHUNK_SIZE uncompressed, and the amount
 243                          * of compressed data for the chunk is given by the
 244                          * difference of offsets in the chunk offset table. */
 245                         compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] -
 246                                                 chunk_offsets[i - start_chunk];
 247                         uncompressed_chunk_size = WIM_CHUNK_SIZE;
 248                 } else {
 249                         /* The last compressed chunk consists of the remaining
 250                          * bytes in the file resource, and the last uncompressed
 251                          * chunk has size equal to however many bytes are left-
 252                          * that is, the remainder of the uncompressed size when
 253                          * divided by WIM_CHUNK_SIZE.
 254                          *
 255                          * Note that the resource_compressed_size includes the
 256                          * chunk table, so the size of it must be subtracted. */
 257                         compressed_chunk_size = resource_compressed_size -
 258                                                 chunk_table_size -
 259                                                 chunk_offsets[i - start_chunk];
 260
 261                         uncompressed_chunk_size = resource_uncompressed_size %
 262                                                                 WIM_CHUNK_SIZE;
 263
 264                         /* If the remainder is 0, the last chunk actually
 265                          * uncompresses to a full WIM_CHUNK_SIZE bytes. */
 266                         if (uncompressed_chunk_size == 0)
 267                                 uncompressed_chunk_size = WIM_CHUNK_SIZE;
 268                 }
 269
 270                 DEBUG2("compressed_chunk_size = %u, "
 271                        "uncompressed_chunk_size = %u",
 272                        compressed_chunk_size, uncompressed_chunk_size);
 273
 274
 275                 /* Figure out how much of this chunk we actually need to read */
 276                 u64 start_offset;
 277                 if (i == start_chunk)
 278                         start_offset = start_chunk_offset;
 279                 else
 280                         start_offset = 0;
 281                 u64 end_offset;
 282                 if (i == end_chunk)
 283                         end_offset = end_chunk_offset;
 284                 else
 285                         end_offset = WIM_CHUNK_SIZE - 1;
 286
 287                 u64 partial_chunk_size = end_offset + 1 - start_offset;
 288                 bool is_partial_chunk = (partial_chunk_size !=
 289                                                 uncompressed_chunk_size);
 290
 291                 DEBUG2("start_offset = %"PRIu64", end_offset = %"PRIu64"",
 292                        start_offset, end_offset);
 293                 DEBUG2("partial_chunk_size = %"PRIu64"", partial_chunk_size);
 294
 295                 /* This is undocumented, but chunks can be uncompressed.  This
 296                  * appears to always be the case when the compressed chunk size
 297                  * is equal to the uncompressed chunk size. */
 298                 if (compressed_chunk_size == uncompressed_chunk_size) {
 299                         /* Probably an uncompressed chunk */
 300
 301                         if (start_offset != 0) {
 302                                 if (fseeko(fp, start_offset, SEEK_CUR) != 0) {
 303                                         ERROR_WITH_ERRNO("Uncompressed partial "
 304                                                          "chunk fseek() error");
 305                                         return WIMLIB_ERR_READ;
 306                                 }
 307                         }
 308                         if (fread(out_p, 1, partial_chunk_size, fp) !=
 309                                         partial_chunk_size)
 310                                 goto err;
 311                 } else {
 312                         /* Compressed chunk */
 313                         int ret;
 314
 315                         /* Read the compressed data into compressed_buf. */
 316                         if (fread(compressed_buf, 1, compressed_chunk_size,
 317                                                 fp) != compressed_chunk_size)
 318                                 goto err;
 319
 320                         /* For partial chunks we must buffer the uncompressed
 321                          * data because we don't need all of it. */
 322                         if (is_partial_chunk) {
 323                                 u8 uncompressed_buf[uncompressed_chunk_size];
 324
 325                                 ret = decompress(compressed_buf,
 326                                                 compressed_chunk_size,
 327                                                 uncompressed_buf,
 328                                                 uncompressed_chunk_size);
 329                                 if (ret != 0)
 330                                         return WIMLIB_ERR_DECOMPRESSION;
 331                                 memcpy(out_p, uncompressed_buf + start_offset,
 332                                                 partial_chunk_size);
 333                         } else {
 334                                 ret = decompress(compressed_buf,
 335                                                 compressed_chunk_size,
 336                                                 out_p,
 337                                                 uncompressed_chunk_size);
 338                                 if (ret != 0)
 339                                         return WIMLIB_ERR_DECOMPRESSION;
 340                         }
 341                 }
 342
 343                 /* Advance the pointer into the uncompressed output data by the
 344                  * number of uncompressed bytes that were written.  */
 345                 out_p += partial_chunk_size;
 346         }
 347
 348         return 0;
 349
 350 err:
 351         if (feof(fp))
 352                 ERROR("Unexpected EOF in compressed file resource");
 353         else
 354                 ERROR_WITH_ERRNO("Error reading compressed file resource");
 355         return WIMLIB_ERR_READ;
 356 }
 357
 358 /*
 359  * Reads uncompressed data from an open file stream.
 360  */
 361 int
 362 read_uncompressed_resource(FILE *fp, u64 offset, u64 len, void *contents_ret)
 363 {
 364         if (fseeko(fp, offset, SEEK_SET) != 0) {
 365                 ERROR("Failed to seek to byte %"PRIu64" of input file "
 366                       "to read uncompressed resource (len = %"PRIu64")",
 367                       offset, len);
 368                 return WIMLIB_ERR_READ;
 369         }
 370         if (fread(contents_ret, 1, len, fp) != len) {
 371                 if (feof(fp)) {
 372                         ERROR("Unexpected EOF in uncompressed file resource");
 373                 } else {
 374                         ERROR("Failed to read %"PRIu64" bytes from "
 375                               "uncompressed resource at offset %"PRIu64,
 376                               len, offset);
 377                 }
 378                 return WIMLIB_ERR_READ;
 379         }
 380         return 0;
 381 }
 382
 383 /* Reads the contents of a struct resource_entry, as represented in the on-disk
 384  * format, from the memory pointed to by @p, and fills in the fields of @entry.
 385  * A pointer to the byte after the memory read at @p is returned. */
 386 const u8 *
 387 get_resource_entry(const u8 *p, struct resource_entry *entry)
 388 {
 389         u64 size;
 390         u8 flags;
 391
 392         p = get_u56(p, &size);
 393         p = get_u8(p, &flags);
 394         entry->size = size;
 395         entry->flags = flags;
 396
 397         /* offset and original_size are truncated to 62 bits to avoid possible
 398          * overflows, when converting to a signed 64-bit integer (off_t) or when
 399          * adding size or original_size.  This is okay since no one would ever
 400          * actually have a WIM bigger than 4611686018427387903 bytes... */
 401         p = get_u64(p, &entry->offset);
 402         if (entry->offset & 0xc000000000000000ULL) {
 403                 WARNING("Truncating offset in resource entry");
 404                 entry->offset &= 0x3fffffffffffffffULL;
 405         }
 406         p = get_u64(p, &entry->original_size);
 407         if (entry->original_size & 0xc000000000000000ULL) {
 408                 WARNING("Truncating original_size in resource entry");
 409                 entry->original_size &= 0x3fffffffffffffffULL;
 410         }
 411         return p;
 412 }
 413
 414 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
 415  * on-disk format.  A pointer to the byte after the memory written at @p is
 416  * returned. */
 417 u8 *
 418 put_resource_entry(u8 *p, const struct resource_entry *entry)
 419 {
 420         p = put_u56(p, entry->size);
 421         p = put_u8(p, entry->flags);
 422         p = put_u64(p, entry->offset);
 423         p = put_u64(p, entry->original_size);
 424         return p;
 425 }
 426
 427 #ifdef WITH_FUSE
 428 static FILE *
 429 wim_get_fp(WIMStruct *w)
 430 {
 431         pthread_mutex_lock(&w->fp_tab_mutex);
 432         FILE *fp;
 433
 434         wimlib_assert(w->filename != NULL);
 435
 436         for (size_t i = 0; i < w->num_allocated_fps; i++) {
 437                 if (w->fp_tab[i]) {
 438                         fp = w->fp_tab[i];
 439                         w->fp_tab[i] = NULL;
 440                         goto out;
 441                 }
 442         }
 443         DEBUG("Opening extra file descriptor to `%"TS"'", w->filename);
 444         fp = tfopen(w->filename, T("rb"));
 445         if (!fp)
 446                 ERROR_WITH_ERRNO("Failed to open `%"TS"'", w->filename);
 447 out:
 448         pthread_mutex_unlock(&w->fp_tab_mutex);
 449         return fp;
 450 }
 451
 452 static int
 453 wim_release_fp(WIMStruct *w, FILE *fp)
 454 {
 455         int ret = 0;
 456         FILE **fp_tab;
 457
 458         pthread_mutex_lock(&w->fp_tab_mutex);
 459
 460         for (size_t i = 0; i < w->num_allocated_fps; i++) {
 461                 if (w->fp_tab[i] == NULL) {
 462                         w->fp_tab[i] = fp;
 463                         goto out;
 464                 }
 465         }
 466
 467         fp_tab = REALLOC(w->fp_tab, sizeof(FILE*) * (w->num_allocated_fps + 4));
 468         if (!fp_tab) {
 469                 ret = WIMLIB_ERR_NOMEM;
 470                 goto out;
 471         }
 472         w->fp_tab = fp_tab;
 473         memset(&w->fp_tab[w->num_allocated_fps], 0, 4 * sizeof(FILE*));
 474         w->fp_tab[w->num_allocated_fps] = fp;
 475         w->num_allocated_fps += 4;
 476 out:
 477         pthread_mutex_unlock(&w->fp_tab_mutex);
 478         return ret;
 479 }
 480 #endif /* !WITH_FUSE */
 481
 482 /*
 483  * Reads some data from the resource corresponding to a WIM lookup table entry.
 484  *
 485  * @lte:        The WIM lookup table entry for the resource.
 486  * @buf:        Buffer into which to write the data.
 487  * @size:       Number of bytes to read.
 488  * @offset:     Offset at which to start reading the resource.
 489  *
 490  * Returns zero on success, nonzero on failure.
 491  */
 492 int
 493 read_wim_resource(const struct wim_lookup_table_entry *lte, void *buf,
 494                   size_t size, u64 offset, int flags)
 495 {
 496         int ctype;
 497         int ret = 0;
 498         FILE *fp;
 499
 500         /* We shouldn't be allowing read over-runs in any part of the library.
 501          * */
 502         if (flags & WIMLIB_RESOURCE_FLAG_RAW)
 503                 wimlib_assert(offset + size <= lte->resource_entry.size);
 504         else
 505                 wimlib_assert(offset + size <= lte->resource_entry.original_size);
 506
 507         switch (lte->resource_location) {
 508         case RESOURCE_IN_WIM:
 509                 /* The resource is in a WIM file, and its WIMStruct is given by
 510                  * the lte->wim member.  The resource may be either compressed
 511                  * or uncompressed. */
 512                 wimlib_assert(lte->wim != NULL);
 513
 514                 #ifdef WITH_FUSE
 515                 if (flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED) {
 516                         fp = wim_get_fp(lte->wim);
 517                         if (!fp)
 518                                 return WIMLIB_ERR_OPEN;
 519                 } else
 520                 #endif
 521                 {
 522                         wimlib_assert(!(flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED));
 523                         wimlib_assert(lte->wim->fp != NULL);
 524                         fp = lte->wim->fp;
 525                 }
 526
 527                 ctype = wim_resource_compression_type(lte);
 528
 529                 wimlib_assert(ctype != WIMLIB_COMPRESSION_TYPE_NONE ||
 530                               (lte->resource_entry.original_size ==
 531                                lte->resource_entry.size));
 532
 533                 if ((flags & WIMLIB_RESOURCE_FLAG_RAW)
 534                     || ctype == WIMLIB_COMPRESSION_TYPE_NONE)
 535                         ret = read_uncompressed_resource(fp,
 536                                                          lte->resource_entry.offset + offset,
 537                                                          size, buf);
 538                 else
 539                         ret = read_compressed_resource(fp,
 540                                                        lte->resource_entry.size,
 541                                                        lte->resource_entry.original_size,
 542                                                        lte->resource_entry.offset,
 543                                                        ctype, size, offset, buf);
 544         #ifdef WITH_FUSE
 545                 if (flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED) {
 546                         int ret2 = wim_release_fp(lte->wim, fp);
 547                         if (ret == 0)
 548                                 ret = ret2;
 549                 }
 550         #endif
 551                 break;
 552         case RESOURCE_IN_STAGING_FILE:
 553         case RESOURCE_IN_FILE_ON_DISK:
 554                 /* The resource is in some file on the external filesystem and
 555                  * needs to be read uncompressed */
 556                 wimlib_assert(lte->file_on_disk != NULL);
 557                 BUILD_BUG_ON(&lte->file_on_disk != &lte->staging_file_name);
 558                 /* Use existing file pointer if available; otherwise open one
 559                  * temporarily */
 560                 if (lte->file_on_disk_fp) {
 561                         fp = lte->file_on_disk_fp;
 562                 } else {
 563                         fp = tfopen(lte->file_on_disk, T("rb"));
 564                         if (!fp) {
 565                                 ERROR_WITH_ERRNO("Failed to open the file "
 566                                                  "`%"TS"'", lte->file_on_disk);
 567                                 ret = WIMLIB_ERR_OPEN;
 568                                 break;
 569                         }
 570                 }
 571                 ret = read_uncompressed_resource(fp, offset, size, buf);
 572                 if (fp != lte->file_on_disk_fp)
 573                         fclose(fp);
 574                 break;
 575 #ifdef __WIN32__
 576         case RESOURCE_WIN32:
 577                 wimlib_assert(lte->win32_file_on_disk_fp != INVALID_HANDLE_VALUE);
 578                 ret = win32_read_file(lte->file_on_disk,
 579                                       lte->win32_file_on_disk_fp, offset,
 580                                       size, buf);
 581                 break;
 582 #endif
 583         case RESOURCE_IN_ATTACHED_BUFFER:
 584                 /* The resource is directly attached uncompressed in an
 585                  * in-memory buffer. */
 586                 wimlib_assert(lte->attached_buffer != NULL);
 587                 memcpy(buf, lte->attached_buffer + offset, size);
 588                 break;
 589 #ifdef WITH_NTFS_3G
 590         case RESOURCE_IN_NTFS_VOLUME:
 591                 wimlib_assert(lte->ntfs_loc != NULL);
 592                 wimlib_assert(lte->attr != NULL);
 593                 if (lte->ntfs_loc->is_reparse_point)
 594                         offset += 8;
 595                 if (ntfs_attr_pread(lte->attr, offset, size, buf) != size) {
 596                         ERROR_WITH_ERRNO("Error reading NTFS attribute "
 597                                          "at `%"TS"'",
 598                                          lte->ntfs_loc->path);
 599                         ret = WIMLIB_ERR_NTFS_3G;
 600                 }
 601                 break;
 602 #endif
 603         default:
 604                 wimlib_assert(0);
 605                 ret = -1;
 606                 break;
 607         }
 608         return ret;
 609 }
 610
 611 /*
 612  * Reads all the data from the resource corresponding to a WIM lookup table
 613  * entry.
 614  *
 615  * @lte:        The WIM lookup table entry for the resource.
 616  * @buf:        Buffer into which to write the data.  It must be at least
 617  *              wim_resource_size(lte) bytes long.
 618  *
 619  * Returns 0 on success; nonzero on failure.
 620  */
 621 int
 622 read_full_wim_resource(const struct wim_lookup_table_entry *lte,
 623                        void *buf, int flags)
 624 {
 625         return read_wim_resource(lte, buf, wim_resource_size(lte), 0, flags);
 626 }
 627
 628 /* Extracts the first @size bytes of a WIM resource to somewhere.  In the
 629  * process, the SHA1 message digest of the resource is checked if the full
 630  * resource is being extracted.
 631  *
 632  * @extract_chunk is a function that is called to extract each chunk of the
 633  * resource. */
 634 int
 635 extract_wim_resource(const struct wim_lookup_table_entry *lte,
 636                      u64 size,
 637                      extract_chunk_func_t extract_chunk,
 638                      void *extract_chunk_arg)
 639 {
 640         u64 bytes_remaining = size;
 641         u8 buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
 642         u64 offset = 0;
 643         int ret = 0;
 644         u8 hash[SHA1_HASH_SIZE];
 645         bool check_hash = (size == wim_resource_size(lte));
 646         SHA_CTX ctx;
 647
 648         if (check_hash)
 649                 sha1_init(&ctx);
 650
 651         while (bytes_remaining) {
 652                 u64 to_read = min(bytes_remaining, sizeof(buf));
 653                 ret = read_wim_resource(lte, buf, to_read, offset, 0);
 654                 if (ret != 0)
 655                         return ret;
 656                 if (check_hash)
 657                         sha1_update(&ctx, buf, to_read);
 658                 ret = extract_chunk(buf, to_read, offset, extract_chunk_arg);
 659                 if (ret != 0) {
 660                         ERROR_WITH_ERRNO("Error extracting WIM resource");
 661                         return ret;
 662                 }
 663                 bytes_remaining -= to_read;
 664                 offset += to_read;
 665         }
 666         if (check_hash) {
 667                 sha1_final(hash, &ctx);
 668                 if (!hashes_equal(hash, lte->hash)) {
 669                 #ifdef ENABLE_ERROR_MESSAGES
 670                         ERROR("Invalid checksum on the following WIM resource:");
 671                         print_lookup_table_entry(lte, stderr);
 672                 #endif
 673                         return WIMLIB_ERR_INVALID_RESOURCE_HASH;
 674                 }
 675         }
 676         return 0;
 677 }
 678
 679 /* Write @n bytes from @buf to the file descriptor @fd, retrying on internupt
 680  * and on short writes.
 681  *
 682  * Returns short count and set errno on failure. */
 683 static ssize_t
 684 full_write(int fd, const void *buf, size_t n)
 685 {
 686         const void *p = buf;
 687         ssize_t ret;
 688         ssize_t total = 0;
 689
 690         while (total != n) {
 691                 ret = write(fd, p, n);
 692                 if (ret < 0) {
 693                         if (errno == EINTR)
 694                                 continue;
 695                         else
 696                                 break;
 697                 }
 698                 total += ret;
 699                 p += ret;
 700         }
 701         return total;
 702 }
 703
 704 int
 705 extract_wim_chunk_to_fd(const void *buf, size_t len, u64 offset, void *arg)
 706 {
 707         int fd = *(int*)arg;
 708         ssize_t ret = full_write(fd, buf, len);
 709         if (ret < len) {
 710                 ERROR_WITH_ERRNO("Error writing to file descriptor");
 711                 return WIMLIB_ERR_WRITE;
 712         } else {
 713                 return 0;
 714         }
 715 }
 716
 717 /*
 718  * Copies the file resource specified by the lookup table entry @lte from the
 719  * input WIM to the output WIM that has its FILE * given by
 720  * ((WIMStruct*)wim)->out_fp.
 721  *
 722  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
 723  * updated.
 724  *
 725  * (This function is confusing and should be refactored somehow.)
 726  */
 727 int
 728 copy_resource(struct wim_lookup_table_entry *lte, void *wim)
 729 {
 730         WIMStruct *w = wim;
 731         int ret;
 732
 733         ret = write_wim_resource(lte, w->out_fp,
 734                                  wim_resource_compression_type(lte),
 735                                  &lte->output_resource_entry, 0);
 736         if (ret == 0) {
 737                 lte->out_refcnt = lte->refcnt;
 738                 lte->part_number = w->hdr.part_number;
 739         }
 740         return ret;
 741 }