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
  38
  39 /*
  40  * Reads all or part of a compressed resource into an in-memory buffer.
  41  *
  42  * @fp:                 The FILE* for the WIM file.
  43  * @resource_compressed_size:    The compressed size of the resource.
  44  * @resource_uncompressed_size:  The uncompressed size of the resource.
  45  * @resource_offset:             The offset of the start of the resource from
  46  *                                      the start of the stream @fp.
  47  * @resource_ctype:     The compression type of the resource.
  48  * @len:                The number of bytes of uncompressed data to read from
  49  *                              the resource.
  50  * @offset:             The offset of the bytes to read within the uncompressed
  51  *                              resource.
  52  * @contents_len:       An array into which the uncompressed data is written.
  53  *                              It must be at least @len bytes long.
  54  *
  55  * Returns zero on success, nonzero on failure.
  56  */
  57 static int read_compressed_resource(FILE *fp, u64 resource_compressed_size,
  58                                     u64 resource_uncompressed_size,
  59                                     u64 resource_offset, int resource_ctype,
  60                                     u64 len, u64 offset, u8  contents_ret[])
  61 {
  62
  63         DEBUG2("comp size = %"PRIu64", uncomp size = %"PRIu64", "
  64                "res offset = %"PRIu64"",
  65                resource_compressed_size,
  66                resource_uncompressed_size,
  67                resource_offset);
  68         DEBUG2("resource_ctype = %s, len = %"PRIu64", offset = %"PRIu64"",
  69                wimlib_get_compression_type_string(resource_ctype), len, offset);
  70         /* Trivial case */
  71         if (len == 0)
  72                 return 0;
  73
  74         int (*decompress)(const void *, uint, void *, uint);
  75         /* Set the appropriate decompress function. */
  76         if (resource_ctype == WIM_COMPRESSION_TYPE_LZX)
  77                 decompress = lzx_decompress;
  78         else
  79                 decompress = xpress_decompress;
  80
  81         /* The structure of a compressed resource consists of a table of chunk
  82          * offsets followed by the chunks themselves.  Each chunk consists of
  83          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
  84          * 32768 bytes of the uncompressed file, with the last chunk having any
  85          * remaining bytes.
  86          *
  87          * The chunk offsets are measured relative to the end of the chunk
  88          * table.  The first chunk is omitted from the table in the WIM file
  89          * because its offset is implicitly given by the fact that it directly
  90          * follows the chunk table and therefore must have an offset of 0.
  91          */
  92
  93         /* Calculate how many chunks the resource conists of in its entirety. */
  94         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
  95                                                                 WIM_CHUNK_SIZE;
  96         /* As mentioned, the first chunk has no entry in the chunk table. */
  97         u64 num_chunk_entries = num_chunks - 1;
  98
  99
 100         /* The index of the chunk that the read starts at. */
 101         u64 start_chunk = offset / WIM_CHUNK_SIZE;
 102         /* The byte offset at which the read starts, within the start chunk. */
 103         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
 104
 105         /* The index of the chunk that contains the last byte of the read. */
 106         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
 107         /* The byte offset of the last byte of the read, within the end chunk */
 108         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
 109
 110         /* Number of chunks that are actually needed to read the requested part
 111          * of the file. */
 112         u64 num_needed_chunks = end_chunk - start_chunk + 1;
 113
 114         /* If the end chunk is not the last chunk, an extra chunk entry is
 115          * needed because we need to know the offset of the chunk after the last
 116          * chunk read to figure out the size of the last read chunk. */
 117         if (end_chunk != num_chunks - 1)
 118                 num_needed_chunks++;
 119
 120         /* Declare the chunk table.  It will only contain offsets for the chunks
 121          * that are actually needed for this read. */
 122         u64 chunk_offsets[num_needed_chunks];
 123
 124         /* Set the implicit offset of the first chunk if it is included in the
 125          * needed chunks.
 126          *
 127          * Note: M$'s documentation includes a picture that shows the first
 128          * chunk starting right after the chunk entry table, labeled as offset
 129          * 0x10.  However, in the actual file format, the offset is measured
 130          * from the end of the chunk entry table, so the first chunk has an
 131          * offset of 0. */
 132         if (start_chunk == 0)
 133                 chunk_offsets[0] = 0;
 134
 135         /* According to M$'s documentation, if the uncompressed size of
 136          * the file is greater than 4 GB, the chunk entries are 8-byte
 137          * integers.  Otherwise, they are 4-byte integers. */
 138         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ?
 139                                                                         8 : 4;
 140
 141         /* Size of the full chunk table in the WIM file. */
 142         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
 143
 144         /* Read the needed chunk offsets from the table in the WIM file. */
 145
 146         /* Index, in the WIM file, of the first needed entry in the
 147          * chunk table. */
 148         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
 149
 150         /* Number of entries we need to actually read from the chunk
 151          * table (excludes the implicit first chunk). */
 152         u64 num_needed_chunk_entries = (start_chunk == 0) ?
 153                                 num_needed_chunks - 1 : num_needed_chunks;
 154
 155         /* Skip over unneeded chunk table entries. */
 156         u64 file_offset_of_needed_chunk_entries = resource_offset +
 157                                 start_table_idx * chunk_entry_size;
 158         if (fseeko(fp, file_offset_of_needed_chunk_entries, SEEK_SET) != 0) {
 159                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
 160                                  "chunk table of compressed resource",
 161                                  file_offset_of_needed_chunk_entries);
 162                 return WIMLIB_ERR_READ;
 163         }
 164
 165         /* Number of bytes we need to read from the chunk table. */
 166         size_t size = num_needed_chunk_entries * chunk_entry_size;
 167
 168         u8 chunk_tab_buf[size];
 169
 170         if (fread(chunk_tab_buf, 1, size, fp) != size)
 171                 goto err;
 172
 173         /* Now fill in chunk_offsets from the entries we have read in
 174          * chunk_tab_buf. */
 175
 176         u64 *chunk_tab_p = chunk_offsets;
 177         if (start_chunk == 0)
 178                 chunk_tab_p++;
 179
 180         if (chunk_entry_size == 4) {
 181                 u32 *entries = (u32*)chunk_tab_buf;
 182                 while (num_needed_chunk_entries--)
 183                         *chunk_tab_p++ = to_le32(*entries++);
 184         } else {
 185                 u64 *entries = (u64*)chunk_tab_buf;
 186                 while (num_needed_chunk_entries--)
 187                         *chunk_tab_p++ = to_le64(*entries++);
 188         }
 189
 190         /* Done with the chunk table now.  We must now seek to the first chunk
 191          * that is needed for the read. */
 192
 193         u64 file_offset_of_first_needed_chunk = resource_offset +
 194                                 chunk_table_size + chunk_offsets[0];
 195         if (fseeko(fp, file_offset_of_first_needed_chunk, SEEK_SET) != 0) {
 196                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
 197                                  "first chunk of compressed resource",
 198                                  file_offset_of_first_needed_chunk);
 199                 return WIMLIB_ERR_READ;
 200         }
 201
 202         /* Pointer to current position in the output buffer for uncompressed
 203          * data. */
 204         u8 *out_p = (u8*)contents_ret;
 205
 206         /* Buffer for compressed data.  While most compressed chunks will have a
 207          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
 208          * size in the worst-case.  This assumption is valid only if chunks that
 209          * happen to compress to more than the uncompressed size (i.e. a
 210          * sequence of random bytes) are always stored uncompressed. But this seems
 211          * to be the case in M$'s WIM files, even though it is undocumented. */
 212         u8 compressed_buf[WIM_CHUNK_SIZE - 1];
 213
 214
 215         /* Decompress all the chunks. */
 216         for (u64 i = start_chunk; i <= end_chunk; i++) {
 217
 218                 DEBUG2("Chunk %"PRIu64" (start %"PRIu64", end %"PRIu64").",
 219                        i, start_chunk, end_chunk);
 220
 221                 /* Calculate the sizes of the compressed chunk and of the
 222                  * uncompressed chunk. */
 223                 uint compressed_chunk_size, uncompressed_chunk_size;
 224                 if (i != num_chunks - 1) {
 225                         /* All the chunks except the last one in the resource
 226                          * expand to WIM_CHUNK_SIZE uncompressed, and the amount
 227                          * of compressed data for the chunk is given by the
 228                          * difference of offsets in the chunk offset table. */
 229                         compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] -
 230                                                 chunk_offsets[i - start_chunk];
 231                         uncompressed_chunk_size = WIM_CHUNK_SIZE;
 232                 } else {
 233                         /* The last compressed chunk consists of the remaining
 234                          * bytes in the file resource, and the last uncompressed
 235                          * chunk has size equal to however many bytes are left-
 236                          * that is, the remainder of the uncompressed size when
 237                          * divided by WIM_CHUNK_SIZE.
 238                          *
 239                          * Note that the resource_compressed_size includes the
 240                          * chunk table, so the size of it must be subtracted. */
 241                         compressed_chunk_size = resource_compressed_size -
 242                                                 chunk_table_size -
 243                                                 chunk_offsets[i - start_chunk];
 244
 245                         uncompressed_chunk_size = resource_uncompressed_size %
 246                                                                 WIM_CHUNK_SIZE;
 247
 248                         /* If the remainder is 0, the last chunk actually
 249                          * uncompresses to a full WIM_CHUNK_SIZE bytes. */
 250                         if (uncompressed_chunk_size == 0)
 251                                 uncompressed_chunk_size = WIM_CHUNK_SIZE;
 252                 }
 253
 254                 DEBUG2("compressed_chunk_size = %u, "
 255                        "uncompressed_chunk_size = %u",
 256                        compressed_chunk_size, uncompressed_chunk_size);
 257
 258
 259                 /* Figure out how much of this chunk we actually need to read */
 260                 u64 start_offset;
 261                 if (i == start_chunk)
 262                         start_offset = start_chunk_offset;
 263                 else
 264                         start_offset = 0;
 265                 u64 end_offset;
 266                 if (i == end_chunk)
 267                         end_offset = end_chunk_offset;
 268                 else
 269                         end_offset = WIM_CHUNK_SIZE - 1;
 270
 271                 u64 partial_chunk_size = end_offset + 1 - start_offset;
 272                 bool is_partial_chunk = (partial_chunk_size !=
 273                                                 uncompressed_chunk_size);
 274
 275                 DEBUG2("start_offset = %u, end_offset = %u", start_offset,
 276                                         end_offset);
 277                 DEBUG2("partial_chunk_size = %u", partial_chunk_size);
 278
 279                 /* This is undocumented, but chunks can be uncompressed.  This
 280                  * appears to always be the case when the compressed chunk size
 281                  * is equal to the uncompressed chunk size. */
 282                 if (compressed_chunk_size == uncompressed_chunk_size) {
 283                         /* Probably an uncompressed chunk */
 284
 285                         if (start_offset != 0) {
 286                                 if (fseeko(fp, start_offset, SEEK_CUR) != 0) {
 287                                         ERROR_WITH_ERRNO("Uncompressed partial "
 288                                                          "chunk fseek() error");
 289                                         return WIMLIB_ERR_READ;
 290                                 }
 291                         }
 292                         if (fread(out_p, 1, partial_chunk_size, fp) !=
 293                                         partial_chunk_size)
 294                                 goto err;
 295                 } else {
 296                         /* Compressed chunk */
 297                         int ret;
 298
 299                         /* Read the compressed data into compressed_buf. */
 300                         if (fread(compressed_buf, 1, compressed_chunk_size,
 301                                                 fp) != compressed_chunk_size)
 302                                 goto err;
 303
 304                         /* For partial chunks we must buffer the uncompressed
 305                          * data because we don't need all of it. */
 306                         if (is_partial_chunk) {
 307                                 u8 uncompressed_buf[uncompressed_chunk_size];
 308
 309                                 ret = decompress(compressed_buf,
 310                                                 compressed_chunk_size,
 311                                                 uncompressed_buf,
 312                                                 uncompressed_chunk_size);
 313                                 if (ret != 0)
 314                                         return WIMLIB_ERR_DECOMPRESSION;
 315                                 memcpy(out_p, uncompressed_buf + start_offset,
 316                                                 partial_chunk_size);
 317                         } else {
 318                                 ret = decompress(compressed_buf,
 319                                                 compressed_chunk_size,
 320                                                 out_p,
 321                                                 uncompressed_chunk_size);
 322                                 if (ret != 0)
 323                                         return WIMLIB_ERR_DECOMPRESSION;
 324                         }
 325                 }
 326
 327                 /* Advance the pointer into the uncompressed output data by the
 328                  * number of uncompressed bytes that were written.  */
 329                 out_p += partial_chunk_size;
 330         }
 331
 332         return 0;
 333
 334 err:
 335         if (feof(fp))
 336                 ERROR("Unexpected EOF in compressed file resource");
 337         else
 338                 ERROR_WITH_ERRNO("Error reading compressed file resource");
 339         return WIMLIB_ERR_READ;
 340 }
 341
 342 /*
 343  * Reads uncompressed data from an open file stream.
 344  */
 345 int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
 346                                         u8 contents_ret[])
 347 {
 348         if (fseeko(fp, offset, SEEK_SET) != 0) {
 349                 ERROR("Failed to seek to byte %"PRIu64" of input file "
 350                       "to read uncompressed resource (len = %"PRIu64")",
 351                       offset, len);
 352                 return WIMLIB_ERR_READ;
 353         }
 354         if (fread(contents_ret, 1, len, fp) != len) {
 355                 if (feof(fp)) {
 356                         ERROR("Unexpected EOF in uncompressed file resource");
 357                 } else {
 358                         ERROR("Failed to read %"PRIu64" bytes from "
 359                               "uncompressed resource at offset %"PRIu64,
 360                               len, offset);
 361                 }
 362                 return WIMLIB_ERR_READ;
 363         }
 364         return 0;
 365 }
 366
 367
 368 /*
 369  * Reads a WIM resource.
 370  *
 371  * @fp:                 The FILE* for the WIM file.
 372  * @resource_size:              The compressed size of the resource.
 373  * @resource_original_size:     The uncompressed size of the resource.
 374  * @resource_offset:            The offset of the resource in the stream @fp.
 375  * @resource_ctype:             The compression type of the resource.
 376  *                              (WIM_COMPRESSION_TYPE_*)
 377  * @len:                How many bytes of the resource should be read.
 378  * @offset:             The offset within the resource at which the read
 379  *                              will occur.
 380  *
 381  *                      To read the whole file resource, specify offset =
 382  *                      0 and len = resource_original_size, or call
 383  *                      read_full_resource().
 384  *
 385  * @contents_ret:       An array, that must have length at least @len,
 386  *                              into which the uncompressed contents of
 387  *                              the file resource starting at @offset and
 388  *                              continuing for @len bytes will be written.
 389  *
 390  * @return:             Zero on success, nonzero on failure. Failure may be due to
 391  *                      being unable to read the data from the WIM file at the
 392  *                      specified length and offset, or it may be due to the
 393  *                      compressed data (if the data is compressed) being
 394  *                      invalid.
 395  */
 396 int read_resource(FILE *fp, u64 resource_size, u64 resource_original_size,
 397                   u64 resource_offset, int resource_ctype, u64 len,
 398                   u64 offset, void *contents_ret)
 399 {
 400         if (resource_ctype == WIM_COMPRESSION_TYPE_NONE) {
 401                 if (resource_size != resource_original_size) {
 402                         ERROR("Resource with original size %"PRIu64" bytes is "
 403                               "marked as uncompressed, but its actual size is "
 404                               "%"PRIu64" bytes", resource_size);
 405                         return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
 406                 }
 407                 return read_uncompressed_resource(fp,
 408                                 resource_offset + offset,
 409                                 len, contents_ret);
 410         } else {
 411                 return read_compressed_resource(fp, resource_size,
 412                                 resource_original_size, resource_offset,
 413                                 resource_ctype, len, offset, contents_ret);
 414         }
 415 }
 416
 417
 418 /*
 419  * Extracts the first @size bytes file resource specified by @entry to the open
 420  * file @fd.  Returns nonzero on error.
 421  *
 422  * XXX
 423  * This function is somewhat redundant with uncompress_resource(). The
 424  * main difference is that this function writes to a file descriptor using
 425  * low-level calls to write() rather than to a FILE* with fwrite(); also this
 426  * function allows only up to @size bytes to be extracted.
 427  */
 428 int extract_resource_to_fd(WIMStruct *w, const struct resource_entry *entry,
 429                            int fd, u64 size)
 430 {
 431         u64 num_chunks;
 432         u64 n;
 433         u8 buf[min(size, WIM_CHUNK_SIZE)];
 434         int res_ctype;
 435         u64 offset;
 436         u64 i;
 437         int ret;
 438
 439         errno = 0;
 440
 441         num_chunks = (size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
 442         n = WIM_CHUNK_SIZE;
 443         res_ctype = wim_resource_compression_type(w, entry);
 444         offset = 0;
 445         for (i = 0; i < num_chunks; i++) {
 446                 if (i == num_chunks - 1) {
 447                         n = size % WIM_CHUNK_SIZE;
 448                         if (n == 0) {
 449                                 n = WIM_CHUNK_SIZE;
 450                         }
 451                 }
 452
 453                 ret = read_resource(w->fp, entry->size, entry->original_size,
 454                                     entry->offset, res_ctype, n, offset, buf);
 455                 if (ret != 0)
 456                         return ret;
 457
 458                 if (full_write(fd, buf, n) != n)
 459                         return WIMLIB_ERR_WRITE;
 460                 offset += n;
 461         }
 462         return ret;
 463 }
 464
 465 /*
 466  * Copies the file resource specified by the lookup table entry @lte from the
 467  * input WIM, pointed to by the fp field of the WIMStruct, to the output WIM,
 468  * pointed to by the out_fp field of the WIMStruct.
 469  *
 470  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
 471  * updated.
 472  *
 473  * Metadata resources are not copied (they are handled elsewhere for joining and
 474  * splitting).
 475  */
 476 int copy_resource(struct lookup_table_entry *lte, void *w)
 477 {
 478         if ((lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) &&
 479             !((WIMStruct*)w)->write_metadata) {
 480                 return 0;
 481         }
 482
 483         FILE *in_fp = ((WIMStruct*)w)->fp;
 484         FILE *out_fp = ((WIMStruct*)w)->out_fp;
 485         int ret;
 486         u64 size = lte->resource_entry.size;
 487         u64 offset = lte->resource_entry.offset;
 488         off_t new_offset = ftello(out_fp);
 489
 490         if (new_offset == -1)
 491                 return WIMLIB_ERR_WRITE;
 492
 493         ret = copy_between_files(in_fp, offset, out_fp, size);
 494         if (ret != 0)
 495                 return ret;
 496
 497         memcpy(&lte->output_resource_entry, &lte->resource_entry,
 498                         sizeof(struct resource_entry));
 499
 500         lte->output_resource_entry.offset = new_offset;
 501         lte->out_refcnt = lte->refcnt;
 502         lte->part_number = ((WIMStruct*)w)->hdr.part_number;
 503         return 0;
 504 }
 505
 506 /* Reads the contents of a struct resource_entry, as represented in the on-disk
 507  * format, from the memory pointed to by @p, and fills in the fields of @entry.
 508  * A pointer to the byte after the memory read at @p is returned. */
 509 const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry)
 510 {
 511         u64 size;
 512         u8 flags;
 513
 514         p = get_u56(p, &size);
 515         p = get_u8(p, &flags);
 516         entry->size = size;
 517         entry->flags = flags;
 518         p = get_u64(p, &entry->offset);
 519         p = get_u64(p, &entry->original_size);
 520         return p;
 521 }
 522
 523 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
 524  * on-disk format.  A pointer to the byte after the memory written at @p is
 525  * returned. */
 526 u8 *put_resource_entry(u8 *p, const struct resource_entry *entry)
 527 {
 528         p = put_u56(p, entry->size);
 529         p = put_u8(p, entry->flags);
 530         p = put_u64(p, entry->offset);
 531         p = put_u64(p, entry->original_size);
 532         return p;
 533 }
 534
 535 /* Given the compression type for the WIM file as a whole as the flags field of
 536  * a resource entry, returns the compression type for that resource entry. */
 537 int resource_compression_type(int wim_ctype, int reshdr_flags)
 538 {
 539         if (wim_ctype != WIM_COMPRESSION_TYPE_NONE &&
 540              (reshdr_flags & WIM_RESHDR_FLAG_COMPRESSED))
 541                 return wim_ctype;
 542         else
 543                 return WIM_COMPRESSION_TYPE_NONE;
 544 }
 545
 546
 547
 548 /*
 549  * Copies bytes between two file streams.
 550  *
 551  * Copies @len bytes from @in_fp to @out_fp, at the current position in @out_fp,
 552  * and at an offset of @in_offset in @in_fp.
 553  */
 554 int copy_between_files(FILE *in_fp, off_t in_offset, FILE *out_fp, size_t len)
 555 {
 556         u8 buf[BUFFER_SIZE];
 557         size_t n;
 558
 559         if (fseeko(in_fp, in_offset, SEEK_SET) != 0) {
 560                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" of "
 561                                  "input file", in_offset);
 562                 return WIMLIB_ERR_READ;
 563         }
 564         /* To reduce memory usage and improve speed, read and write BUFFER_SIZE
 565          * bytes at a time. */
 566         while (len != 0) {
 567                 n = min(len, BUFFER_SIZE);
 568                 if (fread(buf, 1, n, in_fp) != n) {
 569                         if (feof(in_fp)) {
 570                                 ERROR("Unexpected EOF when copying data "
 571                                       "between files");
 572                         } else {
 573                                 ERROR_WITH_ERRNO("Error copying data between "
 574                                                  "files");
 575                         }
 576                         return WIMLIB_ERR_READ;
 577                 }
 578
 579                 if (fwrite(buf, 1, n, out_fp) != n) {
 580                         ERROR_WITH_ERRNO("Error copying data between files");
 581                         return WIMLIB_ERR_WRITE;
 582                 }
 583                 len -= n;
 584         }
 585         return 0;
 586 }
 587
 588
 589 /*
 590  * Uncompresses a WIM file resource and writes it uncompressed to a file stream.
 591  *
 592  * @in_fp:          The file stream that contains the file resource.
 593  * @size:           The size of the resource in the input file.
 594  * @original_size:  The original (uncompressed) size of the resource.
 595  * @offset:         The offset of the start of the resource in @in.
 596  * @input_ctype:    The compression type of the resource in @in.
 597  * @out_fp:         The file stream to write the file resource to.
 598  */
 599 static int uncompress_resource(FILE *in_fp, u64 size, u64 original_size,
 600                                off_t offset, int input_ctype, FILE *out_fp)
 601 {
 602         int ret;
 603         u8 buf[WIM_CHUNK_SIZE];
 604         /* Determine how many compressed chunks the file is divided into. */
 605         u64 num_chunks;
 606         u64 i;
 607         u64 uncompressed_offset;
 608         u64 uncompressed_chunk_size;
 609
 610         num_chunks = (original_size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
 611
 612         for (i = 0; i < num_chunks; i++) {
 613
 614                 uncompressed_offset = i * WIM_CHUNK_SIZE;
 615                 uncompressed_chunk_size = min(WIM_CHUNK_SIZE, original_size -
 616                                               uncompressed_offset);
 617
 618                 ret = read_resource(in_fp, size, original_size, offset,
 619                                     input_ctype, uncompressed_chunk_size,
 620                                     uncompressed_offset, buf);
 621                 if (ret != 0)
 622                         return ret;
 623
 624                 if (fwrite(buf, 1, uncompressed_chunk_size, out_fp) !=
 625                       uncompressed_chunk_size)
 626                 {
 627                         ERROR_WITH_ERRNO("Failed to write file resource");
 628                         return WIMLIB_ERR_WRITE;
 629                 }
 630         }
 631         return 0;
 632 }
 633
 634 /*
 635  * Transfers a file resource between two files, writing it compressed.  The file
 636  * resource in the input file may be either compressed or uncompressed.
 637  * Alternatively, the input resource may be in-memory, but it must be
 638  * uncompressed.
 639  *
 640  * @in_fp:                  The file stream that contains the file resource.  Ignored
 641  *                      if uncompressed_resource != NULL.
 642  * @uncompressed_resource:      If this pointer is not NULL, it points to an
 643  *                                      array of @original_size bytes that are
 644  *                                      the uncompressed input resource.
 645  * @size:           The size of the resource in the input file.
 646  * @original_size:  The original (uncompressed) size of the resource.
 647  * @offset:         The offset of the start of the resource in @in.  Ignored
 648  *                      if uncompressed_resource != NULL.
 649  * @input_ctype:    The compression type of the resource in @in.  Ignored if
 650  *                      uncompressed_resource != NULL.
 651  * @out_fp:         The file stream to write the file resource to.
 652  * @output_type:    The compression type to use when writing the resource to
 653  *                      @out.
 654  * @new_size_ret:   A location into which the new compressed size of the file
 655  *                      resource in returned.
 656  */
 657 static int recompress_resource(FILE *in_fp, const u8 *uncompressed_resource,
 658                                u64 size, u64 original_size,
 659                                off_t offset, int input_ctype, FILE *out_fp,
 660                                int output_ctype, u64 *new_size_ret)
 661 {
 662         int ret;
 663         int (*compress)(const void *, uint, void *, uint *);
 664         if (output_ctype == WIM_COMPRESSION_TYPE_LZX)
 665                 compress = lzx_compress;
 666         else
 667                 compress = xpress_compress;
 668
 669         u8 uncompressed_buf[WIM_CHUNK_SIZE];
 670         u8 compressed_buf[WIM_CHUNK_SIZE - 1];
 671
 672         /* Determine how many compressed chunks the file needs to be divided
 673          * into. */
 674         u64 num_chunks = (original_size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
 675
 676         u64 num_chunk_entries = num_chunks - 1;
 677
 678         /* Size of the chunk entries--- 8 bytes for files over 4GB, otherwise 4
 679          * bytes */
 680         uint chunk_entry_size = (original_size >= (u64)1 << 32) ? 8 : 4;
 681
 682         /* Array in which to construct the chunk offset table. */
 683         u64 chunk_offsets[num_chunk_entries];
 684
 685         /* Offset of the start of the chunk table in the output file. */
 686         off_t chunk_tab_offset = ftello(out_fp);
 687
 688         if (chunk_tab_offset == -1) {
 689                 ERROR_WITH_ERRNO("Failed to get offset of output file");
 690                 return WIMLIB_ERR_WRITE;
 691         }
 692
 693         /* Total size of the chunk table (as written to the file) */
 694         u64 chunk_tab_size = chunk_entry_size * num_chunk_entries;
 695
 696         /* Reserve space for the chunk table. */
 697         if (fwrite(chunk_offsets, 1, chunk_tab_size, out_fp) !=
 698               chunk_tab_size)
 699         {
 700                 ERROR_WITH_ERRNO("Failed to write chunk offset table");
 701                 return WIMLIB_ERR_WRITE;
 702         }
 703
 704         /* Read each chunk of the file, compress it, write it to the output
 705          * file, and update th chunk offset table. */
 706         u64 cur_chunk_offset = 0;
 707         for (u64 i = 0; i < num_chunks; i++) {
 708
 709                 u64 uncompressed_offset = i * WIM_CHUNK_SIZE;
 710                 u64 uncompressed_chunk_size = min(WIM_CHUNK_SIZE,
 711                                         original_size - uncompressed_offset);
 712
 713                 const u8 *uncompressed_p;
 714                 if (uncompressed_resource != NULL) {
 715                         uncompressed_p = uncompressed_resource +
 716                                          uncompressed_offset;
 717
 718                 } else {
 719                         /* Read chunk i of the file into uncompressed_buf. */
 720                         ret = read_resource(in_fp, size, original_size, offset,
 721                                             input_ctype,
 722                                             uncompressed_chunk_size,
 723                                             uncompressed_offset,
 724                                             uncompressed_buf);
 725                         if (ret != 0)
 726                                 return ret;
 727                         uncompressed_p = uncompressed_buf;
 728                 }
 729
 730                 if (i != 0)
 731                         chunk_offsets[i - 1] = cur_chunk_offset;
 732
 733                 uint compressed_len;
 734
 735                 ret = compress(uncompressed_p, uncompressed_chunk_size,
 736                                compressed_buf, &compressed_len);
 737
 738                 /* if compress() returned nonzero, the compressed chunk would
 739                  * have been at least as large as the uncompressed chunk.  In
 740                  * this situation, the WIM format requires that the uncompressed
 741                  * chunk be written instead. */
 742                 const u8 *buf_to_write;
 743                 uint len_to_write;
 744                 if (ret == 0) {
 745                         buf_to_write = compressed_buf;
 746                         len_to_write = compressed_len;
 747                 } else {
 748                         buf_to_write = uncompressed_p;
 749                         len_to_write = uncompressed_chunk_size;
 750                 }
 751
 752                 if (fwrite(buf_to_write, 1, len_to_write, out_fp) !=
 753                       len_to_write)
 754                 {
 755                         ERROR_WITH_ERRNO("Failed to write compressed "
 756                                          "file resource");
 757                         return WIMLIB_ERR_WRITE;
 758                 }
 759                 cur_chunk_offset += len_to_write;
 760         }
 761
 762         /* The chunk offset after the last chunk, plus the size of the chunk
 763          * table, gives the total compressed size of the resource. */
 764         *new_size_ret = cur_chunk_offset + chunk_tab_size;
 765
 766         /* Now that all entries of the chunk table are determined, rewind the
 767          * stream to where the chunk table was, and write it back out. */
 768
 769         if (fseeko(out_fp, chunk_tab_offset, SEEK_SET) != 0) {
 770                 ERROR_WITH_ERRNO("Failed to seek to beginning of chunk table");
 771                 return WIMLIB_ERR_READ;
 772         }
 773
 774         if (chunk_entry_size == 8) {
 775                 array_to_le64(chunk_offsets, num_chunk_entries);
 776         } else {
 777                 for (u64 i = 0; i < num_chunk_entries; i++)
 778                         ((u32*)chunk_offsets)[i] = to_le32(chunk_offsets[i]);
 779         }
 780         if (fwrite(chunk_offsets, 1, chunk_tab_size, out_fp) != chunk_tab_size)
 781         {
 782                 ERROR_WITH_ERRNO("Failed to write chunk table");
 783                 return WIMLIB_ERR_WRITE;
 784         }
 785
 786         if (fseeko(out_fp, 0, SEEK_END) != 0) {
 787                 ERROR_WITH_ERRNO("Failed to seek to end of output file");
 788                 return WIMLIB_ERR_WRITE;
 789         }
 790
 791         return 0;
 792 }
 793
 794 int write_resource_from_memory(const u8 resource[], int out_ctype,
 795                                u64 resource_original_size, FILE *out_fp,
 796                                u64 *resource_size_ret)
 797 {
 798         if (out_ctype == WIM_COMPRESSION_TYPE_NONE) {
 799                 if (fwrite(resource, 1, resource_original_size, out_fp) !=
 800                       resource_original_size)
 801                 {
 802                         ERROR_WITH_ERRNO("Failed to write resource of length "
 803                                          "%"PRIu64, resource_original_size);
 804                         return WIMLIB_ERR_WRITE;
 805                 }
 806                 *resource_size_ret = resource_original_size;
 807                 return 0;
 808         } else {
 809                 return recompress_resource(NULL, resource,
 810                                            resource_original_size,
 811                                            resource_original_size, 0, 0, out_fp,
 812                                            out_ctype, resource_size_ret);
 813         }
 814 }
 815
 816
 817 /*
 818  * Transfers a file resource from a FILE* opened for reading to a FILE* opened
 819  * for writing, possibly changing the compression type.
 820  *
 821  * @in_fp:              The FILE* that contains the file resource.
 822  * @size:               The (compressed) size of the file resource.
 823  * @original_size:      The uncompressed size of the file resource.
 824  * @offset:             The offset of the file resource in the input file.
 825  * @input_ctype:        The compression type of the file resource in the input
 826  *                              file.
 827  * @out_fp:             The FILE* for the output file.  The file resource is
 828  *                              written at the current position of @out.
 829  * @output_ctype:       The compression type to which the file resource will be
 830  *                              converted.
 831  * @output_res_entry:   A pointer to a resource entry that, upon successful
 832  *                              return of this function,  will have the size,
 833  *                              original size, offset, and flags fields filled
 834  *                              in for the file resource written to the output
 835  *                              file.
 836  */
 837 static int transfer_file_resource(FILE *in_fp, u64 size, u64 original_size,
 838                                   off_t offset, int input_ctype, FILE *out_fp,
 839                                   int output_ctype,
 840                                   struct resource_entry *output_res_entry)
 841 {
 842         int ret;
 843
 844         /* Handle zero-length files */
 845         if (original_size == 0) {
 846                 memset(output_res_entry, 0, sizeof(*output_res_entry));
 847                 return 0;
 848         }
 849
 850         /* Get current offset in the output file. */
 851         off_t out_offset = ftello(out_fp);
 852         if (out_offset == -1) {
 853                 ERROR_WITH_ERRNO("Failed to get output position");
 854                 return WIMLIB_ERR_WRITE;
 855         }
 856         output_res_entry->offset = (u64)out_offset;
 857
 858         if (output_ctype == input_ctype) {
 859                 /* The same compression types; simply copy the resource. */
 860
 861                 ret = copy_between_files(in_fp, offset, out_fp, size);
 862                 if (ret != 0)
 863                         return ret;
 864                 output_res_entry->size = size;
 865         } else {
 866                 /* Different compression types. */
 867
 868                 if (output_ctype == WIM_COMPRESSION_TYPE_NONE) {
 869                         /* Uncompress a compressed file resource */
 870                         ret = uncompress_resource(in_fp, size,
 871                                                   original_size, offset,
 872                                                   input_ctype, out_fp);
 873                         if (ret != 0)
 874                                 return ret;
 875                         output_res_entry->size = original_size;
 876                 } else {
 877                         u64 new_size;
 878                         /* Compress an uncompressed file resource, or compress a
 879                          * compressed file resource using a different
 880                          * compression type */
 881                         ret = recompress_resource(in_fp, NULL, size,
 882                                                   original_size,
 883                                                   offset, input_ctype, out_fp,
 884                                                   output_ctype, &new_size);
 885                         if (ret != 0)
 886                                 return ret;
 887                         output_res_entry->size = new_size;
 888                 }
 889
 890         }
 891
 892         output_res_entry->original_size = original_size;
 893         if (output_ctype == WIM_COMPRESSION_TYPE_NONE)
 894                 output_res_entry->flags = 0;
 895         else
 896                 output_res_entry->flags = WIM_RESHDR_FLAG_COMPRESSED;
 897         return 0;
 898 }
 899
 900 /*
 901  * Reads the metadata metadata resource from the WIM file.  The metadata
 902  * resource consists of the security data, followed by the directory entry for
 903  * the root directory, followed by all the other directory entries in the
 904  * filesystem.  The subdir_offset field of each directory entry gives the start
 905  * of its child entries from the beginning of the metadata resource.  An
 906  * end-of-directory is signaled by a directory entry of length '0', really of
 907  * length 8, because that's how long the 'length' field is.
 908  *
 909  * @fp:         The FILE* for the input WIM file.
 910  * @wim_ctype:  The compression type of the WIM file.
 911  * @imd:        Pointer to the image metadata structure.  Its
 912  *              `lookup_table_entry' member specifies the lookup table entry for
 913  *              the metadata resource.  The rest of the image metadata entry
 914  *              will be filled in by this function.
 915  *
 916  * @return:     Zero on success, nonzero on failure.
 917  */
 918 int read_metadata_resource(FILE *fp, int wim_ctype, struct image_metadata *imd)
 919 {
 920         u8 *buf;
 921         int ctype;
 922         u32 dentry_offset;
 923         int ret;
 924         const struct resource_entry *res_entry;
 925         struct dentry *dentry;
 926 #ifdef ENABLE_SECURITY_DATA
 927         struct wim_security_data *sd;
 928 #endif
 929
 930         res_entry = &imd->metadata_lte->resource_entry;
 931
 932         DEBUG("Reading metadata resource: length = %"PRIu64", "
 933               "offset = %"PRIu64"",
 934               res_entry->original_size, res_entry->offset);
 935
 936         if (res_entry->original_size < 8) {
 937                 ERROR("Expected at least 8 bytes for the metadata resource");
 938                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
 939         }
 940
 941         /* Allocate memory for the uncompressed metadata resource. */
 942         buf = MALLOC(res_entry->original_size);
 943
 944         if (!buf) {
 945                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
 946                       "metadata resource", res_entry->original_size);
 947                 return WIMLIB_ERR_NOMEM;
 948         }
 949
 950         /* Determine the compression type of the metadata resource. */
 951         ctype = resource_compression_type(wim_ctype, res_entry->flags);
 952
 953         /* Read the metadata resource into memory.  (It may be compressed.) */
 954         ret = read_full_resource(fp, res_entry->size,
 955                                  res_entry->original_size, res_entry->offset,
 956                                  ctype, buf);
 957         if (ret != 0)
 958                 goto out_free_buf;
 959
 960         DEBUG("Finished reading metadata resource into memory.");
 961
 962         /* The root directory entry starts after security data, on an 8-byte
 963          * aligned address.
 964          *
 965          * The security data starts with a 4-byte integer giving its total
 966          * length. */
 967
 968 #ifdef ENABLE_SECURITY_DATA
 969         /* Read the security data into a wim_security_data structure. */
 970         ret = read_security_data(buf, res_entry->original_size, &sd);
 971         if (ret != 0)
 972                 goto out_free_buf;
 973 #endif
 974
 975         dentry = MALLOC(sizeof(struct dentry));
 976         if (!dentry) {
 977                 ERROR("Failed to allocate %zu bytes for root dentry",
 978                       sizeof(struct dentry));
 979                 ret = WIMLIB_ERR_NOMEM;
 980                 goto out_free_security_data;
 981         }
 982
 983         get_u32(buf, &dentry_offset);
 984         if (dentry_offset == 0)
 985                 dentry_offset = 8;
 986         dentry_offset = (dentry_offset + 7) & ~7;
 987
 988         ret = read_dentry(buf, res_entry->original_size, dentry_offset, dentry);
 989         /* This is the root dentry, so set its pointers correctly. */
 990         dentry->parent = dentry;
 991         dentry->next   = dentry;
 992         dentry->prev   = dentry;
 993         if (ret != 0)
 994                 goto out_free_dentry_tree;
 995
 996         /* Now read the entire directory entry tree. */
 997         ret = read_dentry_tree(buf, res_entry->original_size, dentry);
 998         if (ret != 0)
 999                 goto out_free_dentry_tree;
1000
1001         /* Calculate the full paths in the dentry tree. */
1002         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
1003         if (ret != 0)
1004                 goto out_free_dentry_tree;
1005
1006 #ifdef ENABLE_SECURITY_DATA
1007         imd->security_data = sd;
1008 #endif
1009         imd->root_dentry = dentry;
1010         goto out_free_buf;
1011 out_free_security_data:
1012 #ifdef ENABLE_SECURITY_DATA
1013         free_security_data(sd);
1014 #endif
1015 out_free_dentry_tree:
1016         free_dentry_tree(dentry, NULL, false);
1017 out_free_buf:
1018         FREE(buf);
1019         return ret;
1020 }
1021
1022 /* Write the metadata resource for the current image. */
1023 int write_metadata_resource(WIMStruct *w)
1024 {
1025         FILE *out;
1026         u8 *buf;
1027         u8 *p;
1028         int ret;
1029         u64 subdir_offset;
1030         struct dentry *root;
1031         struct lookup_table_entry *lte;
1032         struct resource_entry *res_entry;
1033         off_t metadata_offset;
1034         u64 metadata_original_size;
1035         u64 metadata_compressed_size;
1036         int metadata_ctype;
1037         u8  hash[WIM_HASH_SIZE];
1038
1039         DEBUG("Writing metadata resource for image %d", w->current_image);
1040
1041         out = w->out_fp;
1042         root = wim_root_dentry(w);
1043         metadata_ctype = wimlib_get_compression_type(w);
1044         metadata_offset = ftello(out);
1045         if (metadata_offset == -1)
1046                 return WIMLIB_ERR_WRITE;
1047
1048         #ifdef ENABLE_SECURITY_DATA
1049         struct wim_security_data *sd = wim_security_data(w);
1050         if (sd)
1051                 subdir_offset = sd->total_length + root->length + 8;
1052         else
1053         #endif
1054                 subdir_offset = 8 + root->length + 8;
1055         calculate_subdir_offsets(root, &subdir_offset);
1056         metadata_original_size = subdir_offset;
1057         buf = MALLOC(metadata_original_size);
1058         if (!buf) {
1059                 ERROR("Failed to allocate %"PRIu64" bytes for "
1060                       "metadata resource", metadata_original_size);
1061                 return WIMLIB_ERR_NOMEM;
1062         }
1063         #ifdef ENABLE_SECURITY_DATA
1064         /* Write the security data. */
1065         p = write_security_data(sd, buf);
1066         #else
1067         p = put_u32(buf, 8); /* Total length of security data. */
1068         p = put_u32(p, 0); /* Number of security data entries. */
1069         #endif
1070
1071         DEBUG("Writing dentry tree.");
1072         p = write_dentry_tree(root, p);
1073
1074         /* Like file resources, the lookup table entry for a metadata resource
1075          * uses for the hash code a SHA1 message digest of its uncompressed
1076          * contents. */
1077         sha1_buffer(buf, metadata_original_size, hash);
1078
1079         ret = write_resource_from_memory(buf,
1080                                          metadata_ctype,
1081                                          metadata_original_size,
1082                                          out,
1083                                          &metadata_compressed_size);
1084         FREE(buf);
1085         if (ret != 0)
1086                 return ret;
1087
1088         /* Update the lookup table entry, including the hash and output resource
1089          * entry fields, for this image's metadata resource.  */
1090         lte = wim_metadata_lookup_table_entry(w);
1091         res_entry = &lte->output_resource_entry;
1092         lte->out_refcnt++;
1093         if (memcmp(hash, lte->hash, WIM_HASH_SIZE) != 0) {
1094                 lookup_table_unlink(w->lookup_table, lte);
1095                 memcpy(lte->hash, hash, WIM_HASH_SIZE);
1096                 lookup_table_insert(w->lookup_table, lte);
1097         }
1098         res_entry->original_size = metadata_original_size;
1099         res_entry->offset        = metadata_offset;
1100         res_entry->size          = metadata_compressed_size;
1101         res_entry->flags         = WIM_RESHDR_FLAG_METADATA;
1102         if (metadata_ctype != WIM_COMPRESSION_TYPE_NONE)
1103                 res_entry->flags |= WIM_RESHDR_FLAG_COMPRESSED;
1104         return 0;
1105 }
1106
1107 /*
1108  * Writes a file resource to the output file.
1109  *
1110  * @dentry:  The dentry for the file resource.
1111  * @wim_p:   A pointer to the WIMStruct.  The fields of interest to this
1112  *           function are the input and output file streams and the lookup
1113  *           table.
1114  *
1115  * @return zero on success, nonzero on failure.
1116  */
1117 int write_file_resource(struct dentry *dentry, void *wim_p)
1118 {
1119         WIMStruct *w;
1120         FILE *out_fp;
1121         FILE *in_fp;
1122         struct lookup_table_entry *lte;
1123         int in_wim_ctype;
1124         int out_wim_ctype;
1125         struct resource_entry *output_res_entry;
1126         u64 len;
1127         int ret;
1128
1129         w = wim_p;
1130         out_fp = w->out_fp;
1131
1132         /* Directories don't need file resources. */
1133         if (dentry_is_directory(dentry))
1134                 return 0;
1135
1136         /* Get the lookup entry for the file resource. */
1137         lte = wim_lookup_resource(w, dentry);
1138         if (!lte)
1139                 return 0;
1140
1141         /* No need to write file resources twice.  (This indicates file
1142          * resources that are part of a hard link set.) */
1143         if (++lte->out_refcnt != 1)
1144                 return 0;
1145
1146         out_wim_ctype = wimlib_get_compression_type(w);
1147         output_res_entry = &lte->output_resource_entry;
1148
1149         /* do not write empty resources */
1150         if (lte->resource_entry.original_size == 0)
1151                 return 0;
1152
1153         /* Figure out if we can read the resource from the WIM file, or
1154          * if we have to read it from the filesystem outside. */
1155         if (lte->file_on_disk) {
1156
1157                 /* Read from disk (uncompressed) */
1158
1159                 len = lte->resource_entry.original_size;
1160
1161                 in_fp = fopen(lte->file_on_disk, "rb");
1162                 if (!in_fp) {
1163                         ERROR_WITH_ERRNO("Failed to open the file `%s'",
1164                                          lte->file_on_disk);
1165                         return WIMLIB_ERR_OPEN;
1166                 }
1167
1168                 if (w->verbose)
1169                         puts(lte->file_on_disk);
1170
1171                 ret = transfer_file_resource(in_fp, len, len, 0,
1172                                              WIM_COMPRESSION_TYPE_NONE, out_fp,
1173                                              out_wim_ctype, output_res_entry);
1174                 fclose(in_fp);
1175         } else {
1176
1177                 /* Read from input WIM (possibly compressed) */
1178
1179                 /* It may be a different WIM file, in the case of
1180                  * exporting images from one WIM file to another */
1181                 if (lte->other_wim_fp) {
1182                         /* Different WIM file. */
1183                         in_fp = lte->other_wim_fp;
1184                         in_wim_ctype = lte->other_wim_ctype;
1185                 } else {
1186                         /* Same WIM file. */
1187                         in_fp = w->fp;
1188                         in_wim_ctype = out_wim_ctype;
1189                 }
1190                 int input_res_ctype = resource_compression_type(
1191                                                 in_wim_ctype,
1192                                                 lte->resource_entry.flags);
1193
1194                 ret = transfer_file_resource(in_fp,
1195                                              lte->resource_entry.size,
1196                                              lte->resource_entry.original_size,
1197                                              lte->resource_entry.offset,
1198                                              input_res_ctype,
1199                                              out_fp,
1200                                              out_wim_ctype,
1201                                              output_res_entry);
1202         }
1203         return ret;
1204 }