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

   1 /*
   2  * resource.c
   3  *
   4  * Read uncompressed and compressed metadata and file resources.
   5  */
   6
   7 /*
   8  * Copyright (C) 2010 Carl Thijssen
   9  * Copyright (C) 2012 Eric Biggers
  10  *
  11  * This file is part of wimlib, a library for working with WIM files.
  12  *
  13  * wimlib is free software; you can redistribute it and/or modify it under the
  14  * terms of the GNU Lesser General Public License as published by the Free
  15  * Software Foundation; either version 2.1 of the License, or (at your option)
  16  * any later version.
  17  *
  18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20  * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public License
  24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  25  */
  26
  27 #include "wimlib_internal.h"
  28 #include "lookup_table.h"
  29 #include "io.h"
  30 #include "lzx.h"
  31 #include "xpress.h"
  32 #include "sha1.h"
  33 #include "dentry.h"
  34 #include "config.h"
  35 #include <unistd.h>
  36 #include <errno.h>
  37 #include <alloca.h>
  38
  39
  40 /*
  41  * Reads all or part of a compressed resource into an in-memory buffer.
  42  *
  43  * @fp:                 The FILE* for the WIM file.
  44  * @resource_compressed_size:    The compressed size of the resource.
  45  * @resource_uncompressed_size:  The uncompressed size of the resource.
  46  * @resource_offset:             The offset of the start of the resource from
  47  *                                      the start of the stream @fp.
  48  * @resource_ctype:     The compression type of the resource.
  49  * @len:                The number of bytes of uncompressed data to read from
  50  *                              the resource.
  51  * @offset:             The offset of the bytes to read within the uncompressed
  52  *                              resource.
  53  * @contents_len:       An array into which the uncompressed data is written.
  54  *                              It must be at least @len bytes long.
  55  *
  56  * Returns zero on success, nonzero on failure.
  57  */
  58 static int read_compressed_resource(FILE *fp, u64 resource_compressed_size,
  59                                     u64 resource_uncompressed_size,
  60                                     u64 resource_offset, int resource_ctype,
  61                                     u64 len, u64 offset, u8  contents_ret[])
  62 {
  63
  64         DEBUG2("comp size = %"PRIu64", uncomp size = %"PRIu64", "
  65                "res offset = %"PRIu64"",
  66                resource_compressed_size,
  67                resource_uncompressed_size,
  68                resource_offset);
  69         DEBUG2("resource_ctype = %s, len = %"PRIu64", offset = %"PRIu64"",
  70                wimlib_get_compression_type_string(resource_ctype), len, offset);
  71         /* Trivial case */
  72         if (len == 0)
  73                 return 0;
  74
  75         int (*decompress)(const void *, uint, void *, uint);
  76         /* Set the appropriate decompress function. */
  77         if (resource_ctype == WIM_COMPRESSION_TYPE_LZX)
  78                 decompress = lzx_decompress;
  79         else
  80                 decompress = xpress_decompress;
  81
  82         /* The structure of a compressed resource consists of a table of chunk
  83          * offsets followed by the chunks themselves.  Each chunk consists of
  84          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
  85          * 32768 bytes of the uncompressed file, with the last chunk having any
  86          * remaining bytes.
  87          *
  88          * The chunk offsets are measured relative to the end of the chunk
  89          * table.  The first chunk is omitted from the table in the WIM file
  90          * because its offset is implicitly given by the fact that it directly
  91          * follows the chunk table and therefore must have an offset of 0.
  92          */
  93
  94         /* Calculate how many chunks the resource conists of in its entirety. */
  95         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
  96                                                                 WIM_CHUNK_SIZE;
  97         /* As mentioned, the first chunk has no entry in the chunk table. */
  98         u64 num_chunk_entries = num_chunks - 1;
  99
 100
 101         /* The index of the chunk that the read starts at. */
 102         u64 start_chunk = offset / WIM_CHUNK_SIZE;
 103         /* The byte offset at which the read starts, within the start chunk. */
 104         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
 105
 106         /* The index of the chunk that contains the last byte of the read. */
 107         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
 108         /* The byte offset of the last byte of the read, within the end chunk */
 109         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
 110
 111         /* Number of chunks that are actually needed to read the requested part
 112          * of the file. */
 113         u64 num_needed_chunks = end_chunk - start_chunk + 1;
 114
 115         /* If the end chunk is not the last chunk, an extra chunk entry is
 116          * needed because we need to know the offset of the chunk after the last
 117          * chunk read to figure out the size of the last read chunk. */
 118         if (end_chunk != num_chunks - 1)
 119                 num_needed_chunks++;
 120
 121         /* Declare the chunk table.  It will only contain offsets for the chunks
 122          * that are actually needed for this read. */
 123         u64 chunk_offsets[num_needed_chunks];
 124
 125         /* Set the implicit offset of the first chunk if it is included in the
 126          * needed chunks.
 127          *
 128          * Note: M$'s documentation includes a picture that shows the first
 129          * chunk starting right after the chunk entry table, labeled as offset
 130          * 0x10.  However, in the actual file format, the offset is measured
 131          * from the end of the chunk entry table, so the first chunk has an
 132          * offset of 0. */
 133         if (start_chunk == 0)
 134                 chunk_offsets[0] = 0;
 135
 136         /* According to M$'s documentation, if the uncompressed size of
 137          * the file is greater than 4 GB, the chunk entries are 8-byte
 138          * integers.  Otherwise, they are 4-byte integers. */
 139         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ?
 140                                                                         8 : 4;
 141
 142         /* Size of the full chunk table in the WIM file. */
 143         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
 144
 145         /* Read the needed chunk offsets from the table in the WIM file. */
 146
 147         /* Index, in the WIM file, of the first needed entry in the
 148          * chunk table. */
 149         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
 150
 151         /* Number of entries we need to actually read from the chunk
 152          * table (excludes the implicit first chunk). */
 153         u64 num_needed_chunk_entries = (start_chunk == 0) ?
 154                                 num_needed_chunks - 1 : num_needed_chunks;
 155
 156         /* Skip over unneeded chunk table entries. */
 157         u64 file_offset_of_needed_chunk_entries = resource_offset +
 158                                 start_table_idx * chunk_entry_size;
 159         if (fseeko(fp, file_offset_of_needed_chunk_entries, SEEK_SET) != 0) {
 160                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
 161                                  "chunk table of compressed resource",
 162                                  file_offset_of_needed_chunk_entries);
 163                 return WIMLIB_ERR_READ;
 164         }
 165
 166         /* Number of bytes we need to read from the chunk table. */
 167         size_t size = num_needed_chunk_entries * chunk_entry_size;
 168
 169         u8 chunk_tab_buf[size];
 170
 171         if (fread(chunk_tab_buf, 1, size, fp) != size)
 172                 goto err;
 173
 174         /* Now fill in chunk_offsets from the entries we have read in
 175          * chunk_tab_buf. */
 176
 177         u64 *chunk_tab_p = chunk_offsets;
 178         if (start_chunk == 0)
 179                 chunk_tab_p++;
 180
 181         if (chunk_entry_size == 4) {
 182                 u32 *entries = (u32*)chunk_tab_buf;
 183                 while (num_needed_chunk_entries--)
 184                         *chunk_tab_p++ = to_le32(*entries++);
 185         } else {
 186                 u64 *entries = (u64*)chunk_tab_buf;
 187                 while (num_needed_chunk_entries--)
 188                         *chunk_tab_p++ = to_le64(*entries++);
 189         }
 190
 191         /* Done with the chunk table now.  We must now seek to the first chunk
 192          * that is needed for the read. */
 193
 194         u64 file_offset_of_first_needed_chunk = resource_offset +
 195                                 chunk_table_size + chunk_offsets[0];
 196         if (fseeko(fp, file_offset_of_first_needed_chunk, SEEK_SET) != 0) {
 197                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
 198                                  "first chunk of compressed resource",
 199                                  file_offset_of_first_needed_chunk);
 200                 return WIMLIB_ERR_READ;
 201         }
 202
 203         /* Pointer to current position in the output buffer for uncompressed
 204          * data. */
 205         u8 *out_p = (u8*)contents_ret;
 206
 207         /* Buffer for compressed data.  While most compressed chunks will have a
 208          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
 209          * size in the worst-case.  This assumption is valid only if chunks that
 210          * happen to compress to more than the uncompressed size (i.e. a
 211          * sequence of random bytes) are always stored uncompressed. But this seems
 212          * to be the case in M$'s WIM files, even though it is undocumented. */
 213         u8 compressed_buf[WIM_CHUNK_SIZE - 1];
 214
 215
 216         /* Decompress all the chunks. */
 217         for (u64 i = start_chunk; i <= end_chunk; i++) {
 218
 219                 DEBUG2("Chunk %"PRIu64" (start %"PRIu64", end %"PRIu64").",
 220                        i, start_chunk, end_chunk);
 221
 222                 /* Calculate the sizes of the compressed chunk and of the
 223                  * uncompressed chunk. */
 224                 uint compressed_chunk_size, uncompressed_chunk_size;
 225                 if (i != num_chunks - 1) {
 226                         /* All the chunks except the last one in the resource
 227                          * expand to WIM_CHUNK_SIZE uncompressed, and the amount
 228                          * of compressed data for the chunk is given by the
 229                          * difference of offsets in the chunk offset table. */
 230                         compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] -
 231                                                 chunk_offsets[i - start_chunk];
 232                         uncompressed_chunk_size = WIM_CHUNK_SIZE;
 233                 } else {
 234                         /* The last compressed chunk consists of the remaining
 235                          * bytes in the file resource, and the last uncompressed
 236                          * chunk has size equal to however many bytes are left-
 237                          * that is, the remainder of the uncompressed size when
 238                          * divided by WIM_CHUNK_SIZE.
 239                          *
 240                          * Note that the resource_compressed_size includes the
 241                          * chunk table, so the size of it must be subtracted. */
 242                         compressed_chunk_size = resource_compressed_size -
 243                                                 chunk_table_size -
 244                                                 chunk_offsets[i - start_chunk];
 245
 246                         uncompressed_chunk_size = resource_uncompressed_size %
 247                                                                 WIM_CHUNK_SIZE;
 248
 249                         /* If the remainder is 0, the last chunk actually
 250                          * uncompresses to a full WIM_CHUNK_SIZE bytes. */
 251                         if (uncompressed_chunk_size == 0)
 252                                 uncompressed_chunk_size = WIM_CHUNK_SIZE;
 253                 }
 254
 255                 DEBUG2("compressed_chunk_size = %u, "
 256                        "uncompressed_chunk_size = %u",
 257                        compressed_chunk_size, uncompressed_chunk_size);
 258
 259
 260                 /* Figure out how much of this chunk we actually need to read */
 261                 u64 start_offset;
 262                 if (i == start_chunk)
 263                         start_offset = start_chunk_offset;
 264                 else
 265                         start_offset = 0;
 266                 u64 end_offset;
 267                 if (i == end_chunk)
 268                         end_offset = end_chunk_offset;
 269                 else
 270                         end_offset = WIM_CHUNK_SIZE - 1;
 271
 272                 u64 partial_chunk_size = end_offset + 1 - start_offset;
 273                 bool is_partial_chunk = (partial_chunk_size !=
 274                                                 uncompressed_chunk_size);
 275
 276                 DEBUG2("start_offset = %u, end_offset = %u", start_offset,
 277                                         end_offset);
 278                 DEBUG2("partial_chunk_size = %u", partial_chunk_size);
 279
 280                 /* This is undocumented, but chunks can be uncompressed.  This
 281                  * appears to always be the case when the compressed chunk size
 282                  * is equal to the uncompressed chunk size. */
 283                 if (compressed_chunk_size == uncompressed_chunk_size) {
 284                         /* Probably an uncompressed chunk */
 285
 286                         if (start_offset != 0) {
 287                                 if (fseeko(fp, start_offset, SEEK_CUR) != 0) {
 288                                         ERROR_WITH_ERRNO("Uncompressed partial "
 289                                                          "chunk fseek() error");
 290                                         return WIMLIB_ERR_READ;
 291                                 }
 292                         }
 293                         if (fread(out_p, 1, partial_chunk_size, fp) !=
 294                                         partial_chunk_size)
 295                                 goto err;
 296                 } else {
 297                         /* Compressed chunk */
 298                         int ret;
 299
 300                         /* Read the compressed data into compressed_buf. */
 301                         if (fread(compressed_buf, 1, compressed_chunk_size,
 302                                                 fp) != compressed_chunk_size)
 303                                 goto err;
 304
 305                         /* For partial chunks we must buffer the uncompressed
 306                          * data because we don't need all of it. */
 307                         if (is_partial_chunk) {
 308                                 u8 uncompressed_buf[uncompressed_chunk_size];
 309
 310                                 ret = decompress(compressed_buf,
 311                                                 compressed_chunk_size,
 312                                                 uncompressed_buf,
 313                                                 uncompressed_chunk_size);
 314                                 if (ret != 0)
 315                                         return WIMLIB_ERR_DECOMPRESSION;
 316                                 memcpy(out_p, uncompressed_buf + start_offset,
 317                                                 partial_chunk_size);
 318                         } else {
 319                                 ret = decompress(compressed_buf,
 320                                                 compressed_chunk_size,
 321                                                 out_p,
 322                                                 uncompressed_chunk_size);
 323                                 if (ret != 0)
 324                                         return WIMLIB_ERR_DECOMPRESSION;
 325                         }
 326                 }
 327
 328                 /* Advance the pointer into the uncompressed output data by the
 329                  * number of uncompressed bytes that were written.  */
 330                 out_p += partial_chunk_size;
 331         }
 332
 333         return 0;
 334
 335 err:
 336         if (feof(fp))
 337                 ERROR("Unexpected EOF in compressed file resource");
 338         else
 339                 ERROR_WITH_ERRNO("Error reading compressed file resource");
 340         return WIMLIB_ERR_READ;
 341 }
 342
 343 /*
 344  * Reads uncompressed data from an open file stream.
 345  */
 346 int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
 347                                u8 contents_ret[])
 348 {
 349         if (fseeko(fp, offset, SEEK_SET) != 0) {
 350                 ERROR("Failed to seek to byte %"PRIu64" of input file "
 351                       "to read uncompressed resource (len = %"PRIu64")",
 352                       offset, len);
 353                 return WIMLIB_ERR_READ;
 354         }
 355         if (fread(contents_ret, 1, len, fp) != len) {
 356                 if (feof(fp)) {
 357                         ERROR("Unexpected EOF in uncompressed file resource");
 358                 } else {
 359                         ERROR("Failed to read %"PRIu64" bytes from "
 360                               "uncompressed resource at offset %"PRIu64,
 361                               len, offset);
 362                 }
 363                 return WIMLIB_ERR_READ;
 364         }
 365         return 0;
 366 }
 367
 368
 369
 370
 371 /* Reads the contents of a struct resource_entry, as represented in the on-disk
 372  * format, from the memory pointed to by @p, and fills in the fields of @entry.
 373  * A pointer to the byte after the memory read at @p is returned. */
 374 const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry)
 375 {
 376         u64 size;
 377         u8 flags;
 378
 379         p = get_u56(p, &size);
 380         p = get_u8(p, &flags);
 381         entry->size = size;
 382         entry->flags = flags;
 383         p = get_u64(p, &entry->offset);
 384         p = get_u64(p, &entry->original_size);
 385         return p;
 386 }
 387
 388 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
 389  * on-disk format.  A pointer to the byte after the memory written at @p is
 390  * returned. */
 391 u8 *put_resource_entry(u8 *p, const struct resource_entry *entry)
 392 {
 393         p = put_u56(p, entry->size);
 394         p = put_u8(p, entry->flags);
 395         p = put_u64(p, entry->offset);
 396         p = put_u64(p, entry->original_size);
 397         return p;
 398 }
 399
 400 static int __read_wim_resource(const struct lookup_table_entry *lte,
 401                                u8 buf[], size_t size, u64 offset, bool raw)
 402 {
 403         wimlib_assert(offset + size <= wim_resource_size(lte));
 404         int ctype;
 405         int ret;
 406         FILE *fp;
 407         switch (lte->resource_location) {
 408         case RESOURCE_IN_WIM:
 409                 wimlib_assert(lte->wim);
 410                 wimlib_assert(lte->wim->fp);
 411                 ctype = wim_resource_compression_type(lte);
 412                 if (ctype == WIM_COMPRESSION_TYPE_NONE &&
 413                      lte->resource_entry.original_size !=
 414                       lte->resource_entry.size) {
 415                         ERROR("WIM resource at offset %"PRIu64", size %"PRIu64
 416                               "has an original size of %"PRIu64", but is "
 417                               "uncompressed",
 418                               lte->resource_entry.offset,
 419                               lte->resource_entry.size,
 420                               lte->resource_entry.original_size);
 421                         return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
 422                 }
 423                 if (raw || ctype == WIM_COMPRESSION_TYPE_NONE)
 424                         return read_uncompressed_resource(lte->wim->fp,
 425                                                           offset, size, buf);
 426                 else
 427                         return read_compressed_resource(lte->wim->fp,
 428                                                         lte->resource_entry.size,
 429                                                         lte->resource_entry.original_size,
 430                                                         lte->resource_entry.offset,
 431                                                         ctype, size, offset, buf);
 432                 break;
 433         case RESOURCE_IN_STAGING_FILE:
 434                 wimlib_assert(lte->staging_file_name);
 435                 wimlib_assert(0);
 436                 break;
 437         case RESOURCE_IN_FILE_ON_DISK:
 438                 wimlib_assert(lte->file_on_disk);
 439                 if (lte->file_on_disk_fp) {
 440                         fp = lte->file_on_disk_fp;
 441                 } else {
 442                         fp = fopen(lte->file_on_disk, "rb");
 443                         if (!fp) {
 444                                 ERROR_WITH_ERRNO("Failed to open the file "
 445                                                  "`%s'", lte->file_on_disk);
 446                         }
 447                 }
 448                 ret = read_uncompressed_resource(lte->file_on_disk_fp,
 449                                                  offset, size, buf);
 450                 if (fp != lte->file_on_disk_fp)
 451                         fclose(fp);
 452                 return ret;
 453                 break;
 454         case RESOURCE_IN_ATTACHED_BUFFER:
 455                 wimlib_assert(lte->attached_buffer);
 456                 memcpy(buf, lte->attached_buffer + offset, size);
 457                 return 0;
 458                 break;
 459         default:
 460                 assert(0);
 461         }
 462 }
 463
 464 int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
 465                       size_t size, u64 offset)
 466 {
 467         return __read_wim_resource(lte, buf, size, offset, false);
 468 }
 469
 470 int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[])
 471 {
 472         return __read_wim_resource(lte, buf, lte->resource_entry.original_size,
 473                                    0, false);
 474 }
 475
 476 struct chunk_table {
 477         off_t file_offset;
 478         u64 num_chunks;
 479         u64 original_resource_size;
 480         u64 bytes_per_chunk_entry;
 481         u64 table_disk_size;
 482         u64 cur_offset;
 483         u64 *cur_offset_p;
 484         u64 offsets[0];
 485 };
 486
 487 static int
 488 begin_wim_resource_chunk_tab(const struct lookup_table_entry *lte,
 489                              FILE *out_fp,
 490                              struct chunk_table **chunk_tab_ret)
 491 {
 492         u64 size = wim_resource_size(lte);
 493         u64 num_chunks = (size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
 494         struct chunk_table *chunk_tab = MALLOC(sizeof(struct chunk_table) +
 495                                                num_chunks * sizeof(u64));
 496         int ret = 0;
 497
 498         if (!chunk_tab) {
 499                 ERROR("Failed to allocate chunk table for %"PRIu64" byte "
 500                       "resource", size);
 501                 ret = WIMLIB_ERR_NOMEM;
 502                 goto out;
 503         }
 504         chunk_tab->file_offset = ftello(out_fp);
 505         if (chunk_tab->file_offset == -1) {
 506                 ERROR_WITH_ERRNO("Failed to get file offset in output WIM");
 507                 ret = WIMLIB_ERR_WRITE;
 508                 goto out;
 509         }
 510         chunk_tab->num_chunks = num_chunks;
 511         chunk_tab->cur_offset_p = chunk_tab->offsets;
 512         chunk_tab->original_resource_size = lte->resource_entry.original_size;
 513         chunk_tab->bytes_per_chunk_entry =
 514                         (lte->resource_entry.original_size >= (1ULL << 32))
 515                                  ? 8 : 4;
 516         chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry *
 517                                      (num_chunks - 1);
 518
 519         if (fwrite(chunk_tab, 1, chunk_tab->table_disk_size, out_fp) !=
 520                    chunk_tab->table_disk_size)
 521         {
 522                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
 523                                  "file resource");
 524                 ret = WIMLIB_ERR_WRITE;
 525                 goto out;
 526         }
 527
 528         *chunk_tab_ret = chunk_tab;
 529 out:
 530         return ret;
 531 }
 532
 533 static int compress_chunk(const u8 chunk[], unsigned chunk_sz,
 534                           u8 compressed_chunk[],
 535                           unsigned *compressed_chunk_len_ret,
 536                           int ctype)
 537 {
 538         unsigned compressed_chunk_sz;
 539         int (*compress)(const void *, unsigned, void *, unsigned *);
 540         if (ctype == WIM_COMPRESSION_TYPE_LZX)
 541                 compress = lzx_compress;
 542         else
 543                 compress = xpress_compress;
 544         return (*compress)(chunk, chunk_sz, compressed_chunk,
 545                            compressed_chunk_len_ret);
 546 }
 547
 548 static int write_wim_resource_chunk(const u8 chunk[], unsigned chunk_size,
 549                                     FILE *out_fp, int out_ctype,
 550                                     struct chunk_table *chunk_tab)
 551 {
 552         const u8 *out_chunk;
 553         unsigned out_chunk_size;
 554
 555         if (out_ctype == WIM_COMPRESSION_TYPE_NONE) {
 556                 out_chunk = chunk;
 557                 out_chunk_size = chunk_size;
 558         } else {
 559                 u8 *compressed_chunk = alloca(chunk_size);
 560                 int ret;
 561                 unsigned compressed_chunk_len;
 562
 563                 wimlib_assert(chunk_tab != NULL);
 564
 565                 ret = compress_chunk(chunk, chunk_size, compressed_chunk,
 566                                      &out_chunk_size, out_ctype);
 567                 if (ret > 0)
 568                         return ret;
 569                 else if (ret < 0) {
 570                         out_chunk = chunk;
 571                         out_chunk_size = chunk_size;
 572                 } else {
 573                         out_chunk = compressed_chunk;
 574                 }
 575                 *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
 576                 chunk_tab->cur_offset += out_chunk_size;
 577         }
 578
 579         if (fwrite(out_chunk, 1, out_chunk_size, out_fp) != out_chunk_size) {
 580                 ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
 581                 return WIMLIB_ERR_WRITE;
 582         }
 583         return 0;
 584 }
 585
 586 static int
 587 finish_wim_resource_chunk_tab(const struct chunk_table *chunk_tab,
 588                               FILE *out_fp)
 589 {
 590         if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
 591                 ERROR_WITH_ERRNO("Failed to seet to byte "PRIu64" of output "
 592                                  "WIM file", chunk_tab->file_offset);
 593                 return WIMLIB_ERR_WRITE;
 594         }
 595
 596         if (chunk_tab->bytes_per_chunk_entry == 8) {
 597                 array_to_le64(chunk_tab->offsets, chunk_tab->num_chunks - 1);
 598         } else {
 599                 for (u64 i = 0; i < chunk_tab->num_chunks - 1; i++)
 600                         ((u32*)chunk_tab->offsets)[i] =
 601                                 to_le32(chunk_tab->offsets[i]);
 602         }
 603         if (fwrite(chunk_tab->offsets, 1, chunk_tab->table_disk_size, out_fp) !=
 604                    chunk_tab->table_disk_size)
 605         {
 606                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
 607                                  "file resource");
 608                 return WIMLIB_ERR_WRITE;
 609         }
 610         if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
 611                 ERROR_WITH_ERRNO("Failed to seet to byte "PRIu64" of output "
 612                                  "WIM file", chunk_tab->file_offset);
 613                 return WIMLIB_ERR_WRITE;
 614         }
 615         return 0;
 616 }
 617
 618 static int write_wim_resource(const struct lookup_table_entry *lte,
 619                               FILE *out_fp, int out_ctype)
 620 {
 621         u64 bytes_remaining = wim_resource_size(lte);
 622         char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
 623         u64 offset = 0;
 624         int ret = 0;
 625         bool raw = wim_resource_compression_type(lte) == out_ctype;
 626         struct chunk_table *chunk_tab = NULL;
 627
 628         if (raw)
 629                 out_ctype = WIM_COMPRESSION_TYPE_NONE;
 630
 631         if (out_ctype != WIM_COMPRESSION_TYPE_NONE) {
 632                 ret = begin_wim_resource_chunk_tab(lte, out_fp,
 633                                                    &chunk_tab);
 634                 if (ret != 0)
 635                         return 0;
 636         }
 637
 638         while (bytes_remaining) {
 639                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
 640                 ret = __read_wim_resource(lte, buf, to_read, offset, raw);
 641                 if (ret != 0)
 642                         break;
 643                 ret = write_wim_resource_chunk(buf, to_read, out_fp,
 644                                                out_ctype, chunk_tab);
 645                 if (ret != 0)
 646                         break;
 647                 bytes_remaining -= to_read;
 648                 offset += to_read;
 649         }
 650         if (out_ctype != WIM_COMPRESSION_TYPE_NONE)
 651                 ret = finish_wim_resource_chunk_tab(chunk_tab, out_fp);
 652         return ret;
 653 }
 654
 655 static int write_wim_resource_from_buffer(const u8 *buf, u64 buf_size,
 656                                           FILE *out_fp, int out_ctype)
 657 {
 658         struct lookup_table_entry lte;
 659         lte.resource_entry.flags = 0;
 660         lte.resource_entry.original_size = buf_size;
 661         lte.resource_entry.size = buf_size;
 662         lte.resource_entry.offset = 0;
 663         lte.resource_location = RESOURCE_IN_ATTACHED_BUFFER;
 664         lte.attached_buffer = (u8*)buf;
 665         return write_wim_resource(&lte, out_fp, out_ctype);
 666 }
 667
 668 /*
 669  * Extracts the first @size bytes of the resource specified by @lte to the open
 670  * file @fd.  Returns nonzero on error.
 671  */
 672 int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd,
 673                                u64 size)
 674 {
 675         u64 bytes_remaining = size;
 676         char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
 677         u64 offset = 0;
 678         int ret = 0;
 679
 680         while (bytes_remaining) {
 681                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
 682                 ret = read_wim_resource(lte, buf, to_read, offset);
 683                 if (ret != 0)
 684                         break;
 685                 if (full_write(fd, buf, to_read) < 0) {
 686                         ERROR_WITH_ERRNO("Error extracting WIM resource");
 687                         return WIMLIB_ERR_WRITE;
 688                 }
 689                 bytes_remaining -= to_read;
 690                 offset += to_read;
 691         }
 692         return 0;
 693 }
 694
 695 int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd)
 696 {
 697         return extract_wim_resource_to_fd(lte, fd,
 698                                           lte->resource_entry.original_size);
 699 }
 700
 701 /*
 702  * Copies the file resource specified by the lookup table entry @lte from the
 703  * input WIM, pointed to by the fp field of the WIMStruct, to the output WIM,
 704  * pointed to by the out_fp field of the WIMStruct.
 705  *
 706  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
 707  * updated.
 708  *
 709  * Metadata resources are not copied (they are handled elsewhere for joining and
 710  * splitting).
 711  */
 712 int copy_resource(struct lookup_table_entry *lte, void *wim)
 713 {
 714         WIMStruct *w = wim;
 715         int ret;
 716         off_t new_offset;
 717
 718         if ((lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) &&
 719             !w->write_metadata)
 720                 return 0;
 721
 722         new_offset = ftello(w->out_fp);
 723         if (new_offset == -1) {
 724                 ERROR_WITH_ERRNO("Could not get offset in output WIM");
 725                 return WIMLIB_ERR_WRITE;
 726         }
 727
 728
 729         ret = write_wim_resource(lte, w->out_fp,
 730                                  wimlib_get_compression_type((WIMStruct*)w));
 731         if (ret != 0)
 732                 return ret;
 733
 734         memcpy(&lte->output_resource_entry, &lte->resource_entry,
 735                sizeof(struct resource_entry));
 736
 737         lte->output_resource_entry.offset = new_offset;
 738         lte->out_refcnt = lte->refcnt;
 739         lte->part_number = w->hdr.part_number;
 740         return 0;
 741 }
 742
 743 /*
 744  * Writes a dentry's resources, including the main file resource as well as all
 745  * alternate data streams, to the output file.
 746  *
 747  * @dentry:  The dentry for the file.
 748  * @wim_p:   A pointer to the WIMStruct.  The fields of interest to this
 749  *           function are the input and output file streams and the lookup
 750  *           table.
 751  *
 752  * @return zero on success, nonzero on failure.
 753  */
 754 int write_dentry_resources(struct dentry *dentry, void *wim_p)
 755 {
 756         WIMStruct *w = wim_p;
 757         int ret = 0;
 758         struct lookup_table_entry *lte;
 759         int ctype = wimlib_get_compression_type(w);
 760
 761         for (unsigned i = 0; i <= dentry->num_ads; i++) {
 762                 lte = dentry_stream_lte(dentry, i, w->lookup_table);
 763                 if (lte && ++lte->out_refcnt == 1) {
 764                         ret = write_wim_resource(lte, w->out_fp, ctype);
 765                         if (ret != 0)
 766                                 break;
 767                 }
 768         }
 769         return ret;
 770 }
 771
 772 /*
 773  * Reads the metadata metadata resource from the WIM file.  The metadata
 774  * resource consists of the security data, followed by the directory entry for
 775  * the root directory, followed by all the other directory entries in the
 776  * filesystem.  The subdir_offset field of each directory entry gives the start
 777  * of its child entries from the beginning of the metadata resource.  An
 778  * end-of-directory is signaled by a directory entry of length '0', really of
 779  * length 8, because that's how long the 'length' field is.
 780  *
 781  * @fp:         The FILE* for the input WIM file.
 782  * @wim_ctype:  The compression type of the WIM file.
 783  * @imd:        Pointer to the image metadata structure.  Its
 784  *              `lookup_table_entry' member specifies the lookup table entry for
 785  *              the metadata resource.  The rest of the image metadata entry
 786  *              will be filled in by this function.
 787  *
 788  * @return:     Zero on success, nonzero on failure.
 789  */
 790 int read_metadata_resource(FILE *fp, int wim_ctype, struct image_metadata *imd)
 791 {
 792         u8 *buf;
 793         int ctype;
 794         u32 dentry_offset;
 795         int ret;
 796         struct dentry *dentry;
 797         struct wim_security_data *sd;
 798         struct link_group_table *lgt;
 799         const struct lookup_table_entry *metadata_lte;
 800         const struct resource_entry *res_entry;
 801
 802         metadata_lte = imd->metadata_lte;
 803         res_entry = &metadata_lte->resource_entry;
 804
 805         DEBUG("Reading metadata resource: length = %"PRIu64", "
 806               "offset = %"PRIu64"",
 807               res_entry->original_size, res_entry->offset);
 808
 809         if (res_entry->original_size < 8) {
 810                 ERROR("Expected at least 8 bytes for the metadata resource");
 811                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
 812         }
 813
 814         /* Allocate memory for the uncompressed metadata resource. */
 815         buf = MALLOC(res_entry->original_size);
 816
 817         if (!buf) {
 818                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
 819                       "metadata resource", res_entry->original_size);
 820                 return WIMLIB_ERR_NOMEM;
 821         }
 822
 823         /* Determine the compression type of the metadata resource. */
 824
 825         /* Read the metadata resource into memory.  (It may be compressed.) */
 826         ret = read_full_wim_resource(metadata_lte, buf);
 827         if (ret != 0)
 828                 goto out_free_buf;
 829
 830         DEBUG("Finished reading metadata resource into memory.");
 831
 832         /* The root directory entry starts after security data, on an 8-byte
 833          * aligned address.
 834          *
 835          * The security data starts with a 4-byte integer giving its total
 836          * length. */
 837
 838         /* Read the security data into a wim_security_data structure. */
 839         ret = read_security_data(buf, res_entry->original_size, &sd);
 840         if (ret != 0)
 841                 goto out_free_buf;
 842
 843         dentry = MALLOC(sizeof(struct dentry));
 844         if (!dentry) {
 845                 ERROR("Failed to allocate %zu bytes for root dentry",
 846                       sizeof(struct dentry));
 847                 ret = WIMLIB_ERR_NOMEM;
 848                 goto out_free_security_data;
 849         }
 850
 851         get_u32(buf, &dentry_offset);
 852         if (dentry_offset == 0)
 853                 dentry_offset = 8;
 854         dentry_offset = (dentry_offset + 7) & ~7;
 855
 856         ret = read_dentry(buf, res_entry->original_size, dentry_offset, dentry);
 857         /* This is the root dentry, so set its pointers correctly. */
 858         dentry->parent = dentry;
 859         dentry->next   = dentry;
 860         dentry->prev   = dentry;
 861         if (ret != 0)
 862                 goto out_free_dentry_tree;
 863
 864         DEBUG("Reading dentry tree");
 865         /* Now read the entire directory entry tree. */
 866         ret = read_dentry_tree(buf, res_entry->original_size, dentry);
 867         if (ret != 0)
 868                 goto out_free_dentry_tree;
 869
 870         DEBUG("Calculating dentry full paths");
 871         /* Calculate the full paths in the dentry tree. */
 872         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
 873         if (ret != 0)
 874                 goto out_free_dentry_tree;
 875
 876         DEBUG("Building link group table");
 877         /* Build hash table that maps hard link group IDs to dentry sets */
 878         lgt = new_link_group_table(9001);
 879         if (!lgt)
 880                 goto out_free_dentry_tree;
 881         ret = for_dentry_in_tree(dentry, link_group_table_insert, lgt);
 882         if (ret != 0)
 883                 goto out_free_lgt;
 884
 885         DEBUG("Freeing duplicate ADS entries in link group table");
 886         ret = link_groups_free_duplicate_data(lgt);
 887         if (ret != 0)
 888                 goto out_free_lgt;
 889         DEBUG("Done reading image metadata");
 890
 891         imd->lgt           = lgt;
 892         imd->security_data = sd;
 893         imd->root_dentry   = dentry;
 894         goto out_free_buf;
 895 out_free_lgt:
 896         free_link_group_table(lgt);
 897 out_free_dentry_tree:
 898         free_dentry_tree(dentry, NULL);
 899 out_free_security_data:
 900         free_security_data(sd);
 901 out_free_buf:
 902         FREE(buf);
 903         return ret;
 904 }
 905
 906 /* Write the metadata resource for the current image. */
 907 int write_metadata_resource(WIMStruct *w)
 908 {
 909         FILE *out;
 910         u8 *buf;
 911         u8 *p;
 912         int ret;
 913         u64 subdir_offset;
 914         struct dentry *root;
 915         struct lookup_table_entry *lte;
 916         off_t metadata_offset;
 917         u64 metadata_original_size;
 918         u64 metadata_compressed_size;
 919         int metadata_ctype;
 920         u8  hash[SHA1_HASH_SIZE];
 921
 922         DEBUG("Writing metadata resource for image %d", w->current_image);
 923
 924         out = w->out_fp;
 925         root = wim_root_dentry(w);
 926         metadata_ctype = wimlib_get_compression_type(w);
 927         metadata_offset = ftello(out);
 928         if (metadata_offset == -1)
 929                 return WIMLIB_ERR_WRITE;
 930
 931         struct wim_security_data *sd = wim_security_data(w);
 932         if (sd)
 933                 subdir_offset = sd->total_length + root->length + 8;
 934         else
 935                 subdir_offset = 8 + root->length + 8;
 936         calculate_subdir_offsets(root, &subdir_offset);
 937         metadata_original_size = subdir_offset;
 938         buf = MALLOC(metadata_original_size);
 939         if (!buf) {
 940                 ERROR("Failed to allocate %"PRIu64" bytes for "
 941                       "metadata resource", metadata_original_size);
 942                 return WIMLIB_ERR_NOMEM;
 943         }
 944
 945         p = write_security_data(sd, buf);
 946
 947         DEBUG("Writing dentry tree.");
 948         p = write_dentry_tree(root, p);
 949
 950         /* Like file resources, the lookup table entry for a metadata resource
 951          * uses for the hash code a SHA1 message digest of its uncompressed
 952          * contents. */
 953         sha1_buffer(buf, metadata_original_size, hash);
 954
 955
 956         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
 957                                              out, metadata_ctype);
 958         FREE(buf);
 959         if (ret != 0)
 960                 return ret;
 961
 962         DEBUG("Updating metadata lookup table entry (size %zu)",
 963               metadata_original_size);
 964
 965         /* Update the lookup table entry, including the hash and output resource
 966          * entry fields, for this image's metadata resource.  */
 967         lte = wim_metadata_lookup_table_entry(w);
 968         lte->out_refcnt++;
 969         if (!hashes_equal(hash, lte->hash)) {
 970                 lookup_table_unlink(w->lookup_table, lte);
 971                 copy_hash(lte->hash, hash);
 972                 lookup_table_insert(w->lookup_table, lte);
 973         }
 974         lte->output_resource_entry.original_size = metadata_original_size;
 975         lte->output_resource_entry.offset        = metadata_offset;
 976         lte->output_resource_entry.size          = metadata_compressed_size;
 977         lte->output_resource_entry.flags         = WIM_RESHDR_FLAG_METADATA;
 978         if (metadata_ctype != WIM_COMPRESSION_TYPE_NONE)
 979                 lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_COMPRESSED;
 980         return 0;
 981 }