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         DEBUG("fp = %p, offset = %lu, len = %lu, contents_ret = %p",
 350                         fp, offset, len, contents_ret);
 351         if (fseeko(fp, offset, SEEK_SET) != 0) {
 352                 ERROR("Failed to seek to byte %"PRIu64" of input file "
 353                       "to read uncompressed resource (len = %"PRIu64")",
 354                       offset, len);
 355                 return WIMLIB_ERR_READ;
 356         }
 357         if (fread(contents_ret, 1, len, fp) != len) {
 358                 if (feof(fp)) {
 359                         ERROR("Unexpected EOF in uncompressed file resource");
 360                 } else {
 361                         ERROR("Failed to read %"PRIu64" bytes from "
 362                               "uncompressed resource at offset %"PRIu64,
 363                               len, offset);
 364                 }
 365                 return WIMLIB_ERR_READ;
 366         }
 367         return 0;
 368 }
 369
 370
 371
 372
 373 /* Reads the contents of a struct resource_entry, as represented in the on-disk
 374  * format, from the memory pointed to by @p, and fills in the fields of @entry.
 375  * A pointer to the byte after the memory read at @p is returned. */
 376 const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry)
 377 {
 378         u64 size;
 379         u8 flags;
 380
 381         p = get_u56(p, &size);
 382         p = get_u8(p, &flags);
 383         entry->size = size;
 384         entry->flags = flags;
 385         p = get_u64(p, &entry->offset);
 386         p = get_u64(p, &entry->original_size);
 387         return p;
 388 }
 389
 390 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
 391  * on-disk format.  A pointer to the byte after the memory written at @p is
 392  * returned. */
 393 u8 *put_resource_entry(u8 *p, const struct resource_entry *entry)
 394 {
 395         p = put_u56(p, entry->size);
 396         p = put_u8(p, entry->flags);
 397         p = put_u64(p, entry->offset);
 398         p = put_u64(p, entry->original_size);
 399         return p;
 400 }
 401
 402 /*
 403  * Reads some data from a WIM resource.
 404  *
 405  * If %raw is true, compressed data is read literally rather than being
 406  * decompressed first.
 407  *
 408  * Returns zero on success, nonzero on failure.
 409  */
 410 static int __read_wim_resource(const struct lookup_table_entry *lte,
 411                                u8 buf[], size_t size, u64 offset, bool raw)
 412 {
 413         /* We shouldn't be allowing read over-runs in any part of the library.
 414          * */
 415         wimlib_assert(offset + size <= wim_resource_size(lte));
 416
 417         DEBUG("lte = %p, buf = %p, size = %zu, offset = %lu, raw = %d",
 418                         lte, buf, size, offset, raw);
 419         print_lookup_table_entry(lte);
 420
 421         int ctype;
 422         int ret;
 423         FILE *fp;
 424         switch (lte->resource_location) {
 425         case RESOURCE_IN_WIM:
 426                 /* The resource is in a WIM file, and its WIMStruct is given by
 427                  * the lte->wim member.  The resource may be either compressed
 428                  * or uncompressed. */
 429                 wimlib_assert(lte->wim);
 430                 wimlib_assert(lte->wim->fp);
 431                 ctype = wim_resource_compression_type(lte);
 432
 433                 /* XXX This check should be moved elsewhere */
 434                 if (ctype == WIM_COMPRESSION_TYPE_NONE &&
 435                      lte->resource_entry.original_size !=
 436                       lte->resource_entry.size) {
 437                         ERROR("WIM resource at offset %"PRIu64", size %"PRIu64
 438                               "has an original size of %"PRIu64", but is "
 439                               "uncompressed",
 440                               lte->resource_entry.offset,
 441                               lte->resource_entry.size,
 442                               lte->resource_entry.original_size);
 443                         return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
 444                 }
 445
 446                 if (raw || ctype == WIM_COMPRESSION_TYPE_NONE)
 447                         return read_uncompressed_resource(lte->wim->fp,
 448                                                           lte->resource_entry.offset,
 449                                                           size, buf);
 450                 else
 451                         return read_compressed_resource(lte->wim->fp,
 452                                                         lte->resource_entry.size,
 453                                                         lte->resource_entry.original_size,
 454                                                         lte->resource_entry.offset,
 455                                                         ctype, size, offset, buf);
 456                 break;
 457         case RESOURCE_IN_STAGING_FILE:
 458                 /* The WIM FUSE implementation needs to handle multiple open
 459                  * file descriptors per lookup table entry so it does not
 460                  * currently work with this function. */
 461                 wimlib_assert(lte->staging_file_name);
 462                 wimlib_assert(0);
 463                 break;
 464         case RESOURCE_IN_FILE_ON_DISK:
 465                 /* The resource is in some file on the external filesystem and
 466                  * needs to be read uncompressed */
 467                 wimlib_assert(lte->file_on_disk);
 468                 /* Use existing file pointer if available; otherwise open one
 469                  * temporarily */
 470                 if (lte->file_on_disk_fp) {
 471                         fp = lte->file_on_disk_fp;
 472                 } else {
 473                         fp = fopen(lte->file_on_disk, "rb");
 474                         if (!fp) {
 475                                 ERROR_WITH_ERRNO("Failed to open the file "
 476                                                  "`%s'", lte->file_on_disk);
 477                         }
 478                 }
 479                 ret = read_uncompressed_resource(fp, offset, size, buf);
 480                 if (fp != lte->file_on_disk_fp)
 481                         fclose(fp);
 482                 return ret;
 483                 break;
 484         case RESOURCE_IN_ATTACHED_BUFFER:
 485                 /* The resource is directly attached uncompressed in an
 486                  * in-memory buffer. */
 487                 wimlib_assert(lte->attached_buffer);
 488                 memcpy(buf, lte->attached_buffer + offset, size);
 489                 return 0;
 490                 break;
 491         default:
 492                 assert(0);
 493         }
 494 }
 495
 496 /*
 497  * Reads some data from the resource corresponding to a WIM lookup table entry.
 498  *
 499  * @lte:        The WIM lookup table entry for the resource.
 500  * @buf:        Buffer into which to write the data.
 501  * @size:       Number of bytes to read.
 502  * @offset:     Offset at which to start reading the resource.
 503  *
 504  * Returns 0 on success; nonzero on failure.
 505  */
 506 int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
 507                       size_t size, u64 offset)
 508 {
 509         return __read_wim_resource(lte, buf, size, offset, false);
 510 }
 511
 512 /*
 513  * Reads all the data from the resource corresponding to a WIM lookup table
 514  * entry.
 515  *
 516  * @lte:        The WIM lookup table entry for the resource.
 517  * @buf:        Buffer into which to write the data.  It must be at least
 518  *              wim_resource_size(lte) bytes long.
 519  *
 520  * Returns 0 on success; nonzero on failure.
 521  */
 522 int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[])
 523 {
 524         return __read_wim_resource(lte, buf, lte->resource_entry.original_size,
 525                                    0, false);
 526 }
 527
 528 struct chunk_table {
 529         off_t file_offset;
 530         u64 num_chunks;
 531         u64 original_resource_size;
 532         u64 bytes_per_chunk_entry;
 533         u64 table_disk_size;
 534         u64 cur_offset;
 535         u64 *cur_offset_p;
 536         u64 offsets[0];
 537 };
 538
 539 static int
 540 begin_wim_resource_chunk_tab(const struct lookup_table_entry *lte,
 541                              FILE *out_fp,
 542                              off_t file_offset,
 543                              struct chunk_table **chunk_tab_ret)
 544 {
 545         u64 size = wim_resource_size(lte);
 546         u64 num_chunks = (size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
 547         struct chunk_table *chunk_tab = MALLOC(sizeof(struct chunk_table) +
 548                                                num_chunks * sizeof(u64));
 549         int ret = 0;
 550
 551         if (!chunk_tab) {
 552                 ERROR("Failed to allocate chunk table for %"PRIu64" byte "
 553                       "resource", size);
 554                 ret = WIMLIB_ERR_NOMEM;
 555                 goto out;
 556         }
 557         chunk_tab->file_offset = file_offset;
 558         chunk_tab->num_chunks = num_chunks;
 559         chunk_tab->cur_offset_p = chunk_tab->offsets;
 560         chunk_tab->original_resource_size = lte->resource_entry.original_size;
 561         chunk_tab->bytes_per_chunk_entry =
 562                         (lte->resource_entry.original_size >= (1ULL << 32))
 563                                  ? 8 : 4;
 564         chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry *
 565                                      (num_chunks - 1);
 566
 567         if (fwrite(chunk_tab, 1, chunk_tab->table_disk_size, out_fp) !=
 568                    chunk_tab->table_disk_size)
 569         {
 570                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
 571                                  "file resource");
 572                 ret = WIMLIB_ERR_WRITE;
 573                 goto out;
 574         }
 575
 576         *chunk_tab_ret = chunk_tab;
 577 out:
 578         return ret;
 579 }
 580
 581 static int compress_chunk(const u8 chunk[], unsigned chunk_sz,
 582                           u8 compressed_chunk[],
 583                           unsigned *compressed_chunk_len_ret,
 584                           int ctype)
 585 {
 586         unsigned compressed_chunk_sz;
 587         int (*compress)(const void *, unsigned, void *, unsigned *);
 588         if (ctype == WIM_COMPRESSION_TYPE_LZX)
 589                 compress = lzx_compress;
 590         else
 591                 compress = xpress_compress;
 592         return (*compress)(chunk, chunk_sz, compressed_chunk,
 593                            compressed_chunk_len_ret);
 594 }
 595
 596 static int write_wim_resource_chunk(const u8 chunk[], unsigned chunk_size,
 597                                     FILE *out_fp, int out_ctype,
 598                                     struct chunk_table *chunk_tab)
 599 {
 600         const u8 *out_chunk;
 601         unsigned out_chunk_size;
 602
 603         if (out_ctype == WIM_COMPRESSION_TYPE_NONE) {
 604                 out_chunk = chunk;
 605                 out_chunk_size = chunk_size;
 606         } else {
 607                 u8 *compressed_chunk = alloca(chunk_size);
 608                 int ret;
 609                 unsigned compressed_chunk_len;
 610
 611                 wimlib_assert(chunk_tab != NULL);
 612
 613                 ret = compress_chunk(chunk, chunk_size, compressed_chunk,
 614                                      &out_chunk_size, out_ctype);
 615                 if (ret > 0)
 616                         return ret;
 617                 else if (ret < 0) {
 618                         out_chunk = chunk;
 619                         out_chunk_size = chunk_size;
 620                 } else {
 621                         out_chunk = compressed_chunk;
 622                 }
 623                 *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
 624                 chunk_tab->cur_offset += out_chunk_size;
 625         }
 626
 627         if (fwrite(out_chunk, 1, out_chunk_size, out_fp) != out_chunk_size) {
 628                 ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
 629                 return WIMLIB_ERR_WRITE;
 630         }
 631         return 0;
 632 }
 633
 634 static int
 635 finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab,
 636                               FILE *out_fp, u64 *compressed_size_p)
 637 {
 638         if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
 639                 ERROR_WITH_ERRNO("Failed to seet to byte "PRIu64" of output "
 640                                  "WIM file", chunk_tab->file_offset);
 641                 return WIMLIB_ERR_WRITE;
 642         }
 643
 644         if (chunk_tab->bytes_per_chunk_entry == 8) {
 645                 array_to_le64(chunk_tab->offsets, chunk_tab->num_chunks - 1);
 646         } else {
 647                 for (u64 i = 0; i < chunk_tab->num_chunks - 1; i++)
 648                         ((u32*)chunk_tab->offsets)[i] =
 649                                 to_le32(chunk_tab->offsets[i]);
 650         }
 651         if (fwrite(chunk_tab->offsets, 1, chunk_tab->table_disk_size, out_fp) !=
 652                    chunk_tab->table_disk_size)
 653         {
 654                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
 655                                  "file resource");
 656                 return WIMLIB_ERR_WRITE;
 657         }
 658         if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
 659                 ERROR_WITH_ERRNO("Failed to seet to byte "PRIu64" of output "
 660                                  "WIM file", chunk_tab->file_offset);
 661                 return WIMLIB_ERR_WRITE;
 662         }
 663         *compressed_size_p = chunk_tab->cur_offset;
 664         return 0;
 665 }
 666
 667 /*
 668  * Writes a WIM resource to a FILE * opened for writing.  The resource may be
 669  * written uncompressed or compressed depending on the @out_ctype parameter.
 670  *
 671  * @lte:        The lookup table entry for the WIM resource.
 672  * @out_fp:     The FILE * to write the resource to.
 673  * @out_ctype:  The compression type of the resource to write.  Note: if this is
 674  *                      the same as the compression type of the WIM resource we
 675  *                      need to read, we simply copy the data (i.e. we do not
 676  *                      uncompress it, then compress it again).
 677  * @out_res_entry:  If non-NULL, a resource entry that is filled in with the
 678  *                  offset, original size, compressed size, and compression flag
 679  *                  of the output resource.
 680  *
 681  * Returns 0 on success; nonzero on failure.
 682  */
 683 static int __write_wim_resource(const struct lookup_table_entry *lte,
 684                                 FILE *out_fp, int out_ctype,
 685                                 struct resource_entry *out_res_entry)
 686 {
 687         u64 size = wim_resource_size(lte);
 688         u64 bytes_remaining = size;
 689         char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
 690         u64 offset = 0;
 691         u64 compressed_size = bytes_remaining;
 692         int ret = 0;
 693         struct chunk_table *chunk_tab = NULL;
 694         bool raw;
 695         off_t file_offset;
 696
 697         if (out_res_entry) {
 698                 file_offset = ftello(out_fp);
 699                 if (file_offset == -1) {
 700                         ERROR_WITH_ERRNO("Failed to get offset in output "
 701                                          "stream");
 702                         return WIMLIB_ERR_WRITE;
 703                 }
 704         }
 705
 706         raw = (wim_resource_compression_type(lte) == out_ctype);
 707         if (raw)
 708                 out_ctype = WIM_COMPRESSION_TYPE_NONE;
 709
 710         if (out_ctype != WIM_COMPRESSION_TYPE_NONE) {
 711                 ret = begin_wim_resource_chunk_tab(lte, out_fp, file_offset,
 712                                                    &chunk_tab);
 713                 if (ret != 0)
 714                         goto out;
 715         }
 716
 717         while (bytes_remaining) {
 718                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
 719                 ret = __read_wim_resource(lte, buf, to_read, offset, raw);
 720                 if (ret != 0)
 721                         goto out;
 722                 ret = write_wim_resource_chunk(buf, to_read, out_fp,
 723                                                out_ctype, chunk_tab);
 724                 if (ret != 0)
 725                         goto out;
 726                 bytes_remaining -= to_read;
 727                 offset += to_read;
 728         }
 729         if (out_ctype != WIM_COMPRESSION_TYPE_NONE) {
 730                 ret = finish_wim_resource_chunk_tab(chunk_tab, out_fp,
 731                                                     &compressed_size);
 732                 if (ret != 0)
 733                         goto out;
 734         }
 735         if (out_res_entry) {
 736                 out_res_entry->size          = compressed_size;
 737                 out_res_entry->original_size = size;
 738                 out_res_entry->offset       = file_offset;
 739                 if (out_ctype == WIM_COMPRESSION_TYPE_NONE)
 740                         out_res_entry->flags = 0;
 741                 else
 742                         out_res_entry->flags = WIM_RESHDR_FLAG_COMPRESSED;
 743         }
 744 out:
 745         FREE(chunk_tab);
 746         return ret;
 747 }
 748
 749 static int write_wim_resource(struct lookup_table_entry *lte,
 750                               FILE *out_fp, int out_ctype)
 751 {
 752         return __write_wim_resource(lte, out_fp, out_ctype,
 753                                     &lte->output_resource_entry);
 754 }
 755
 756 static int write_wim_resource_from_buffer(const u8 *buf, u64 buf_size,
 757                                           FILE *out_fp, int out_ctype,
 758                                           struct resource_entry *out_res_entry)
 759 {
 760         struct lookup_table_entry lte;
 761         lte.resource_entry.flags = 0;
 762         lte.resource_entry.original_size = buf_size;
 763         lte.resource_entry.size = buf_size;
 764         lte.resource_entry.offset = 0;
 765         lte.resource_location = RESOURCE_IN_ATTACHED_BUFFER;
 766         lte.attached_buffer = (u8*)buf;
 767         return __write_wim_resource(&lte, out_fp, out_ctype, out_res_entry);
 768 }
 769
 770 /*
 771  * Extracts the first @size bytes of the resource specified by @lte to the open
 772  * file @fd.  Returns nonzero on error.
 773  */
 774 int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd,
 775                                u64 size)
 776 {
 777         u64 bytes_remaining = size;
 778         char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
 779         u64 offset = 0;
 780         int ret = 0;
 781
 782         while (bytes_remaining) {
 783                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
 784                 ret = read_wim_resource(lte, buf, to_read, offset);
 785                 if (ret != 0)
 786                         break;
 787                 if (full_write(fd, buf, to_read) < 0) {
 788                         ERROR_WITH_ERRNO("Error extracting WIM resource");
 789                         return WIMLIB_ERR_WRITE;
 790                 }
 791                 bytes_remaining -= to_read;
 792                 offset += to_read;
 793         }
 794         return 0;
 795 }
 796
 797 int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd)
 798 {
 799         return extract_wim_resource_to_fd(lte, fd,
 800                                           lte->resource_entry.original_size);
 801 }
 802
 803 /*
 804  * Copies the file resource specified by the lookup table entry @lte from the
 805  * input WIM, pointed to by the fp field of the WIMStruct, to the output WIM,
 806  * pointed to by the out_fp field of the WIMStruct.
 807  *
 808  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
 809  * updated.
 810  *
 811  * Metadata resources are not copied (they are handled elsewhere for joining and
 812  * splitting).
 813  */
 814 int copy_resource(struct lookup_table_entry *lte, void *wim)
 815 {
 816         WIMStruct *w = wim;
 817         int ret;
 818
 819         if ((lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) &&
 820             !w->write_metadata)
 821                 return 0;
 822
 823         ret = write_wim_resource(lte, w->out_fp, wimlib_get_compression_type(w));
 824         if (ret != 0)
 825                 return ret;
 826         lte->out_refcnt = lte->refcnt;
 827         lte->part_number = w->hdr.part_number;
 828         return 0;
 829 }
 830
 831 /*
 832  * Writes a dentry's resources, including the main file resource as well as all
 833  * alternate data streams, to the output file.
 834  *
 835  * @dentry:  The dentry for the file.
 836  * @wim_p:   A pointer to the WIMStruct.  The fields of interest to this
 837  *           function are the input and output file streams and the lookup
 838  *           table.
 839  *
 840  * @return zero on success, nonzero on failure.
 841  */
 842 int write_dentry_resources(struct dentry *dentry, void *wim_p)
 843 {
 844         WIMStruct *w = wim_p;
 845         int ret = 0;
 846         struct lookup_table_entry *lte;
 847         int ctype = wimlib_get_compression_type(w);
 848
 849         for (unsigned i = 0; i <= dentry->num_ads; i++) {
 850                 lte = dentry_stream_lte(dentry, i, w->lookup_table);
 851                 if (lte && ++lte->out_refcnt == 1) {
 852                         ret = write_wim_resource(lte, w->out_fp, ctype);
 853                         if (ret != 0)
 854                                 break;
 855                 }
 856         }
 857         return ret;
 858 }
 859
 860 /*
 861  * Reads the metadata metadata resource from the WIM file.  The metadata
 862  * resource consists of the security data, followed by the directory entry for
 863  * the root directory, followed by all the other directory entries in the
 864  * filesystem.  The subdir_offset field of each directory entry gives the start
 865  * of its child entries from the beginning of the metadata resource.  An
 866  * end-of-directory is signaled by a directory entry of length '0', really of
 867  * length 8, because that's how long the 'length' field is.
 868  *
 869  * @fp:         The FILE* for the input WIM file.
 870  * @wim_ctype:  The compression type of the WIM file.
 871  * @imd:        Pointer to the image metadata structure.  Its
 872  *              `lookup_table_entry' member specifies the lookup table entry for
 873  *              the metadata resource.  The rest of the image metadata entry
 874  *              will be filled in by this function.
 875  *
 876  * @return:     Zero on success, nonzero on failure.
 877  */
 878 int read_metadata_resource(FILE *fp, int wim_ctype, struct image_metadata *imd)
 879 {
 880         u8 *buf;
 881         int ctype;
 882         u32 dentry_offset;
 883         int ret;
 884         struct dentry *dentry;
 885         struct wim_security_data *sd;
 886         struct link_group_table *lgt;
 887         const struct lookup_table_entry *metadata_lte;
 888         const struct resource_entry *res_entry;
 889
 890         metadata_lte = imd->metadata_lte;
 891         res_entry = &metadata_lte->resource_entry;
 892
 893         DEBUG("Reading metadata resource: length = %"PRIu64", "
 894               "offset = %"PRIu64"",
 895               res_entry->original_size, res_entry->offset);
 896
 897         if (res_entry->original_size < 8) {
 898                 ERROR("Expected at least 8 bytes for the metadata resource");
 899                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
 900         }
 901
 902         /* Allocate memory for the uncompressed metadata resource. */
 903         buf = MALLOC(res_entry->original_size);
 904
 905         if (!buf) {
 906                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
 907                       "metadata resource", res_entry->original_size);
 908                 return WIMLIB_ERR_NOMEM;
 909         }
 910
 911         /* Determine the compression type of the metadata resource. */
 912
 913         /* Read the metadata resource into memory.  (It may be compressed.) */
 914         ret = read_full_wim_resource(metadata_lte, buf);
 915         if (ret != 0)
 916                 goto out_free_buf;
 917
 918         DEBUG("Finished reading metadata resource into memory.");
 919
 920         /* The root directory entry starts after security data, on an 8-byte
 921          * aligned address.
 922          *
 923          * The security data starts with a 4-byte integer giving its total
 924          * length. */
 925
 926         /* Read the security data into a wim_security_data structure. */
 927         ret = read_security_data(buf, res_entry->original_size, &sd);
 928         if (ret != 0)
 929                 goto out_free_buf;
 930
 931         dentry = MALLOC(sizeof(struct dentry));
 932         if (!dentry) {
 933                 ERROR("Failed to allocate %zu bytes for root dentry",
 934                       sizeof(struct dentry));
 935                 ret = WIMLIB_ERR_NOMEM;
 936                 goto out_free_security_data;
 937         }
 938
 939         get_u32(buf, &dentry_offset);
 940         if (dentry_offset == 0)
 941                 dentry_offset = 8;
 942         dentry_offset = (dentry_offset + 7) & ~7;
 943
 944         ret = read_dentry(buf, res_entry->original_size, dentry_offset, dentry);
 945         /* This is the root dentry, so set its pointers correctly. */
 946         dentry->parent = dentry;
 947         dentry->next   = dentry;
 948         dentry->prev   = dentry;
 949         if (ret != 0)
 950                 goto out_free_dentry_tree;
 951
 952         DEBUG("Reading dentry tree");
 953         /* Now read the entire directory entry tree. */
 954         ret = read_dentry_tree(buf, res_entry->original_size, dentry);
 955         if (ret != 0)
 956                 goto out_free_dentry_tree;
 957
 958         DEBUG("Calculating dentry full paths");
 959         /* Calculate the full paths in the dentry tree. */
 960         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
 961         if (ret != 0)
 962                 goto out_free_dentry_tree;
 963
 964         DEBUG("Building link group table");
 965         /* Build hash table that maps hard link group IDs to dentry sets */
 966         lgt = new_link_group_table(9001);
 967         if (!lgt)
 968                 goto out_free_dentry_tree;
 969         ret = for_dentry_in_tree(dentry, link_group_table_insert, lgt);
 970         if (ret != 0)
 971                 goto out_free_lgt;
 972
 973         DEBUG("Freeing duplicate ADS entries in link group table");
 974         ret = link_groups_free_duplicate_data(lgt);
 975         if (ret != 0)
 976                 goto out_free_lgt;
 977         DEBUG("Done reading image metadata");
 978
 979         imd->lgt           = lgt;
 980         imd->security_data = sd;
 981         imd->root_dentry   = dentry;
 982         goto out_free_buf;
 983 out_free_lgt:
 984         free_link_group_table(lgt);
 985 out_free_dentry_tree:
 986         free_dentry_tree(dentry, NULL);
 987 out_free_security_data:
 988         free_security_data(sd);
 989 out_free_buf:
 990         FREE(buf);
 991         return ret;
 992 }
 993
 994 /* Write the metadata resource for the current image. */
 995 int write_metadata_resource(WIMStruct *w)
 996 {
 997         FILE *out;
 998         u8 *buf;
 999         u8 *p;
1000         int ret;
1001         u64 subdir_offset;
1002         struct dentry *root;
1003         struct lookup_table_entry *lte;
1004         off_t metadata_offset;
1005         u64 metadata_original_size;
1006         u64 metadata_compressed_size;
1007         int metadata_ctype;
1008         u8  hash[SHA1_HASH_SIZE];
1009
1010         DEBUG("Writing metadata resource for image %d", w->current_image);
1011
1012         out = w->out_fp;
1013         root = wim_root_dentry(w);
1014         metadata_ctype = wimlib_get_compression_type(w);
1015         metadata_offset = ftello(out);
1016         if (metadata_offset == -1)
1017                 return WIMLIB_ERR_WRITE;
1018
1019         struct wim_security_data *sd = wim_security_data(w);
1020         if (sd)
1021                 subdir_offset = sd->total_length + root->length + 8;
1022         else
1023                 subdir_offset = 8 + root->length + 8;
1024         calculate_subdir_offsets(root, &subdir_offset);
1025         metadata_original_size = subdir_offset;
1026         buf = MALLOC(metadata_original_size);
1027         if (!buf) {
1028                 ERROR("Failed to allocate %"PRIu64" bytes for "
1029                       "metadata resource", metadata_original_size);
1030                 return WIMLIB_ERR_NOMEM;
1031         }
1032
1033         p = write_security_data(sd, buf);
1034
1035         DEBUG("Writing dentry tree.");
1036         p = write_dentry_tree(root, p);
1037
1038         /* Like file resources, the lookup table entry for a metadata resource
1039          * uses for the hash code a SHA1 message digest of its uncompressed
1040          * contents. */
1041         sha1_buffer(buf, metadata_original_size, hash);
1042
1043
1044         lte = wim_metadata_lookup_table_entry(w);
1045
1046         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
1047                                              out, metadata_ctype,
1048                                              &lte->output_resource_entry);
1049         FREE(buf);
1050         if (ret != 0)
1051                 return ret;
1052
1053         lte->out_refcnt++;
1054         lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA;
1055         lookup_table_unlink(w->lookup_table, lte);
1056         copy_hash(lte->hash, hash);
1057         lookup_table_insert(w->lookup_table, lte);
1058         return 0;
1059 }