Code to handle some weird siutations and bad WIMs
[wimlib] / src / resource.c
1 /*
2  * resource.c
3  *
4  * Read uncompressed and compressed metadata and file resources.
5  */
6
7 /*
8  * Copyright (C) 2010 Carl Thijssen
9  * Copyright (C) 2012 Eric Biggers
10  *
11  * This file is part of wimlib, a library for working with WIM files.
12  *
13  * wimlib is free software; you can redistribute it and/or modify it under the
14  * terms of the GNU Lesser General Public License as published by the Free
15  * Software Foundation; either version 2.1 of the License, or (at your option)
16  * any later version.
17  *
18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20  * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21  * details.
22  *
23  * You should have received a copy of the GNU Lesser General Public License
24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
25  */
26
27 #include "wimlib_internal.h"
28 #include "lookup_table.h"
29 #include "io.h"
30 #include "lzx.h"
31 #include "xpress.h"
32 #include "sha1.h"
33 #include "dentry.h"
34 #include "config.h"
35 #include <unistd.h>
36 #include <errno.h>
37 #include <alloca.h>
38
39
40 /* 
41  * Reads all or part of a compressed resource into an in-memory buffer.
42  *
43  * @fp:                 The FILE* for the WIM file.
44  * @resource_compressed_size:    The compressed size of the resource.  
45  * @resource_uncompressed_size:  The uncompressed size of the resource.
46  * @resource_offset:             The offset of the start of the resource from
47  *                                      the start of the stream @fp.
48  * @resource_ctype:     The compression type of the resource. 
49  * @len:                The number of bytes of uncompressed data to read from
50  *                              the resource.
51  * @offset:             The offset of the bytes to read within the uncompressed
52  *                              resource.
53  * @contents_len:       An array into which the uncompressed data is written.
54  *                              It must be at least @len bytes long.
55  *
56  * Returns zero on success, nonzero on failure.
57  */
58 static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, 
59                                     u64 resource_uncompressed_size, 
60                                     u64 resource_offset, int resource_ctype, 
61                                     u64 len, u64 offset, u8  contents_ret[])
62 {
63
64         DEBUG2("comp size = %"PRIu64", uncomp size = %"PRIu64", "
65                "res offset = %"PRIu64"",
66                resource_compressed_size,
67                resource_uncompressed_size,
68                resource_offset);
69         DEBUG2("resource_ctype = %s, len = %"PRIu64", offset = %"PRIu64"",
70                wimlib_get_compression_type_string(resource_ctype), len, offset);
71         /* Trivial case */
72         if (len == 0)
73                 return 0;
74
75         int (*decompress)(const void *, uint, void *, uint);
76         /* Set the appropriate decompress function. */
77         if (resource_ctype == WIM_COMPRESSION_TYPE_LZX)
78                 decompress = lzx_decompress;
79         else
80                 decompress = xpress_decompress;
81
82         /* The structure of a compressed resource consists of a table of chunk
83          * offsets followed by the chunks themselves.  Each chunk consists of
84          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
85          * 32768 bytes of the uncompressed file, with the last chunk having any
86          * remaining bytes.
87          *
88          * The chunk offsets are measured relative to the end of the chunk
89          * table.  The first chunk is omitted from the table in the WIM file
90          * because its offset is implicitly given by the fact that it directly
91          * follows the chunk table and therefore must have an offset of 0. 
92          */
93
94         /* Calculate how many chunks the resource conists of in its entirety. */
95         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
96                                                                 WIM_CHUNK_SIZE;
97         /* As mentioned, the first chunk has no entry in the chunk table. */
98         u64 num_chunk_entries = num_chunks - 1;
99
100
101         /* The index of the chunk that the read starts at. */
102         u64 start_chunk = offset / WIM_CHUNK_SIZE;
103         /* The byte offset at which the read starts, within the start chunk. */
104         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
105
106         /* The index of the chunk that contains the last byte of the read. */
107         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
108         /* The byte offset of the last byte of the read, within the end chunk */
109         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
110
111         /* Number of chunks that are actually needed to read the requested part
112          * of the file. */
113         u64 num_needed_chunks = end_chunk - start_chunk + 1;
114
115         /* If the end chunk is not the last chunk, an extra chunk entry is
116          * needed because we need to know the offset of the chunk after the last
117          * chunk read to figure out the size of the last read chunk. */
118         if (end_chunk != num_chunks - 1)
119                 num_needed_chunks++;
120
121         /* Declare the chunk table.  It will only contain offsets for the chunks
122          * that are actually needed for this read. */
123         u64 chunk_offsets[num_needed_chunks];
124
125         /* Set the implicit offset of the first chunk if it is included in the
126          * needed chunks.
127          *
128          * Note: M$'s documentation includes a picture that shows the first
129          * chunk starting right after the chunk entry table, labeled as offset
130          * 0x10.  However, in the actual file format, the offset is measured
131          * from the end of the chunk entry table, so the first chunk has an
132          * offset of 0. */
133         if (start_chunk == 0)
134                 chunk_offsets[0] = 0;
135
136         /* According to M$'s documentation, if the uncompressed size of
137          * the file is greater than 4 GB, the chunk entries are 8-byte
138          * integers.  Otherwise, they are 4-byte integers. */
139         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ? 
140                                                                         8 : 4;
141
142         /* Size of the full chunk table in the WIM file. */
143         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
144
145         /* Read the needed chunk offsets from the table in the WIM file. */
146
147         /* Index, in the WIM file, of the first needed entry in the
148          * chunk table. */
149         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
150
151         /* Number of entries we need to actually read from the chunk
152          * table (excludes the implicit first chunk). */
153         u64 num_needed_chunk_entries = (start_chunk == 0) ? 
154                                 num_needed_chunks - 1 : num_needed_chunks;
155
156         /* Skip over unneeded chunk table entries. */
157         u64 file_offset_of_needed_chunk_entries = resource_offset + 
158                                 start_table_idx * chunk_entry_size;
159         if (fseeko(fp, file_offset_of_needed_chunk_entries, SEEK_SET) != 0) {
160                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
161                                  "chunk table of compressed resource",
162                                  file_offset_of_needed_chunk_entries);
163                 return WIMLIB_ERR_READ;
164         }
165
166         /* Number of bytes we need to read from the chunk table. */
167         size_t size = num_needed_chunk_entries * chunk_entry_size;
168
169         u8 chunk_tab_buf[size];
170
171         if (fread(chunk_tab_buf, 1, size, fp) != size)
172                 goto err;
173
174         /* Now fill in chunk_offsets from the entries we have read in
175          * chunk_tab_buf. */
176
177         u64 *chunk_tab_p = chunk_offsets;
178         if (start_chunk == 0)
179                 chunk_tab_p++;
180
181         if (chunk_entry_size == 4) {
182                 u32 *entries = (u32*)chunk_tab_buf;
183                 while (num_needed_chunk_entries--)
184                         *chunk_tab_p++ = to_le32(*entries++);
185         } else {
186                 u64 *entries = (u64*)chunk_tab_buf;
187                 while (num_needed_chunk_entries--)
188                         *chunk_tab_p++ = to_le64(*entries++);
189         }
190
191         /* Done with the chunk table now.  We must now seek to the first chunk
192          * that is needed for the read. */
193
194         u64 file_offset_of_first_needed_chunk = resource_offset + 
195                                 chunk_table_size + chunk_offsets[0];
196         if (fseeko(fp, file_offset_of_first_needed_chunk, SEEK_SET) != 0) {
197                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
198                                  "first chunk of compressed resource",
199                                  file_offset_of_first_needed_chunk);
200                 return WIMLIB_ERR_READ;
201         }
202
203         /* Pointer to current position in the output buffer for uncompressed
204          * data. */
205         u8 *out_p = (u8*)contents_ret;
206
207         /* Buffer for compressed data.  While most compressed chunks will have a
208          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
209          * size in the worst-case.  This assumption is valid only if chunks that
210          * happen to compress to more than the uncompressed size (i.e. a
211          * sequence of random bytes) are always stored uncompressed. But this seems
212          * to be the case in M$'s WIM files, even though it is undocumented. */
213         u8 compressed_buf[WIM_CHUNK_SIZE - 1];
214
215
216         /* Decompress all the chunks. */
217         for (u64 i = start_chunk; i <= end_chunk; i++) {
218
219                 DEBUG2("Chunk %"PRIu64" (start %"PRIu64", end %"PRIu64").",
220                        i, start_chunk, end_chunk);
221
222                 /* Calculate the sizes of the compressed chunk and of the
223                  * uncompressed chunk. */
224                 uint compressed_chunk_size, uncompressed_chunk_size;
225                 if (i != num_chunks - 1) {
226                         /* All the chunks except the last one in the resource
227                          * expand to WIM_CHUNK_SIZE uncompressed, and the amount
228                          * of compressed data for the chunk is given by the
229                          * difference of offsets in the chunk offset table. */
230                         compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] - 
231                                                 chunk_offsets[i - start_chunk];
232                         uncompressed_chunk_size = WIM_CHUNK_SIZE;
233                 } else {
234                         /* The last compressed chunk consists of the remaining
235                          * bytes in the file resource, and the last uncompressed
236                          * chunk has size equal to however many bytes are left-
237                          * that is, the remainder of the uncompressed size when
238                          * divided by WIM_CHUNK_SIZE. 
239                          *
240                          * Note that the resource_compressed_size includes the
241                          * chunk table, so the size of it must be subtracted. */
242                         compressed_chunk_size = resource_compressed_size - 
243                                                 chunk_table_size -
244                                                 chunk_offsets[i - start_chunk];
245
246                         uncompressed_chunk_size = resource_uncompressed_size % 
247                                                                 WIM_CHUNK_SIZE;
248
249                         /* If the remainder is 0, the last chunk actually
250                          * uncompresses to a full WIM_CHUNK_SIZE bytes. */
251                         if (uncompressed_chunk_size == 0)
252                                 uncompressed_chunk_size = WIM_CHUNK_SIZE;
253                 }
254
255                 DEBUG2("compressed_chunk_size = %u, "
256                        "uncompressed_chunk_size = %u",
257                        compressed_chunk_size, uncompressed_chunk_size);
258
259
260                 /* Figure out how much of this chunk we actually need to read */
261                 u64 start_offset;
262                 if (i == start_chunk)
263                         start_offset = start_chunk_offset;
264                 else
265                         start_offset = 0;
266                 u64 end_offset;
267                 if (i == end_chunk)
268                         end_offset = end_chunk_offset;
269                 else
270                         end_offset = WIM_CHUNK_SIZE - 1;
271
272                 u64 partial_chunk_size = end_offset + 1 - start_offset;
273                 bool is_partial_chunk = (partial_chunk_size != 
274                                                 uncompressed_chunk_size);
275
276                 DEBUG2("start_offset = %u, end_offset = %u", start_offset,
277                                         end_offset);
278                 DEBUG2("partial_chunk_size = %u", partial_chunk_size);
279
280                 /* This is undocumented, but chunks can be uncompressed.  This
281                  * appears to always be the case when the compressed chunk size
282                  * is equal to the uncompressed chunk size. */
283                 if (compressed_chunk_size == uncompressed_chunk_size) {
284                         /* Probably an uncompressed chunk */
285
286                         if (start_offset != 0) {
287                                 if (fseeko(fp, start_offset, SEEK_CUR) != 0) {
288                                         ERROR_WITH_ERRNO("Uncompressed partial "
289                                                          "chunk fseek() error");
290                                         return WIMLIB_ERR_READ;
291                                 }
292                         }
293                         if (fread(out_p, 1, partial_chunk_size, fp) != 
294                                         partial_chunk_size)
295                                 goto err;
296                 } else {
297                         /* Compressed chunk */
298                         int ret;
299
300                         /* Read the compressed data into compressed_buf. */
301                         if (fread(compressed_buf, 1, compressed_chunk_size, 
302                                                 fp) != compressed_chunk_size)
303                                 goto err;
304
305                         /* For partial chunks we must buffer the uncompressed
306                          * data because we don't need all of it. */
307                         if (is_partial_chunk) {
308                                 u8 uncompressed_buf[uncompressed_chunk_size];
309
310                                 ret = decompress(compressed_buf,
311                                                 compressed_chunk_size,
312                                                 uncompressed_buf, 
313                                                 uncompressed_chunk_size);
314                                 if (ret != 0)
315                                         return WIMLIB_ERR_DECOMPRESSION;
316                                 memcpy(out_p, uncompressed_buf + start_offset,
317                                                 partial_chunk_size);
318                         } else {
319                                 ret = decompress(compressed_buf,
320                                                 compressed_chunk_size,
321                                                 out_p,
322                                                 uncompressed_chunk_size);
323                                 if (ret != 0)
324                                         return WIMLIB_ERR_DECOMPRESSION;
325                         }
326                 }
327
328                 /* Advance the pointer into the uncompressed output data by the
329                  * number of uncompressed bytes that were written.  */
330                 out_p += partial_chunk_size;
331         }
332
333         return 0;
334
335 err:
336         if (feof(fp))
337                 ERROR("Unexpected EOF in compressed file resource");
338         else
339                 ERROR_WITH_ERRNO("Error reading compressed file resource");
340         return WIMLIB_ERR_READ;
341 }
342
343 /* 
344  * Reads uncompressed data from an open file stream.
345  */
346 int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
347                                u8 contents_ret[])
348 {
349         if (fseeko(fp, offset, SEEK_SET) != 0) {
350                 ERROR("Failed to seek to byte %"PRIu64" of input file "
351                       "to read uncompressed resource (len = %"PRIu64")",
352                       offset, len);
353                 return WIMLIB_ERR_READ;
354         }
355         if (fread(contents_ret, 1, len, fp) != len) {
356                 if (feof(fp)) {
357                         ERROR("Unexpected EOF in uncompressed file resource");
358                 } else {
359                         ERROR("Failed to read %"PRIu64" bytes from "
360                               "uncompressed resource at offset %"PRIu64,
361                               len, offset);
362                 }
363                 return WIMLIB_ERR_READ;
364         }
365         return 0;
366 }
367
368
369
370
371 /* Reads the contents of a struct resource_entry, as represented in the on-disk
372  * format, from the memory pointed to by @p, and fills in the fields of @entry.
373  * A pointer to the byte after the memory read at @p is returned. */
374 const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry)
375 {
376         u64 size;
377         u8 flags;
378
379         p = get_u56(p, &size);
380         p = get_u8(p, &flags);
381         entry->size = size;
382         entry->flags = flags;
383         p = get_u64(p, &entry->offset);
384         p = get_u64(p, &entry->original_size);
385         return p;
386 }
387
388 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
389  * on-disk format.  A pointer to the byte after the memory written at @p is
390  * returned. */
391 u8 *put_resource_entry(u8 *p, const struct resource_entry *entry)
392 {
393         p = put_u56(p, entry->size);
394         p = put_u8(p, entry->flags);
395         p = put_u64(p, entry->offset);
396         p = put_u64(p, entry->original_size);
397         return p;
398 }
399
400 /*
401  * Reads some data from the resource corresponding to a WIM lookup table entry.
402  *
403  * @lte:        The WIM lookup table entry for the resource.
404  * @buf:        Buffer into which to write the data.
405  * @size:       Number of bytes to read.
406  * @offset:     Offset at which to start reading the resource.
407  * @raw:        If %true, compressed data is read literally rather than being
408  *                      decompressed first.
409  *
410  * Returns zero on success, nonzero on failure.
411  */
412 int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
413                       size_t size, u64 offset, bool raw)
414 {
415         /* We shouldn't be allowing read over-runs in any part of the library.
416          * */
417         if (raw)
418                 wimlib_assert(offset + size <= lte->resource_entry.size);
419         else
420                 wimlib_assert(offset + size <= lte->resource_entry.original_size);
421
422         int ctype;
423         int ret;
424         FILE *fp;
425         switch (lte->resource_location) {
426         case RESOURCE_IN_WIM:
427                 /* The resource is in a WIM file, and its WIMStruct is given by
428                  * the lte->wim member.  The resource may be either compressed
429                  * or uncompressed. */
430                 wimlib_assert(lte->wim);
431                 wimlib_assert(lte->wim->fp);
432                 ctype = wim_resource_compression_type(lte);
433
434                 wimlib_assert(ctype != WIM_COMPRESSION_TYPE_NONE ||
435                               (lte->resource_entry.original_size ==
436                                lte->resource_entry.size));
437
438                 if (raw || ctype == WIM_COMPRESSION_TYPE_NONE)
439                         return read_uncompressed_resource(lte->wim->fp,
440                                                           lte->resource_entry.offset + offset,
441                                                           size, buf);
442                 else
443                         return read_compressed_resource(lte->wim->fp,
444                                                         lte->resource_entry.size,
445                                                         lte->resource_entry.original_size,
446                                                         lte->resource_entry.offset,
447                                                         ctype, size, offset, buf);
448                 break;
449         case RESOURCE_IN_STAGING_FILE:
450                 /* The WIM FUSE implementation needs to handle multiple open
451                  * file descriptors per lookup table entry so it does not
452                  * currently work with this function. */
453                 wimlib_assert(lte->staging_file_name);
454                 wimlib_assert(0);
455                 break;
456         case RESOURCE_IN_FILE_ON_DISK:
457                 /* The resource is in some file on the external filesystem and
458                  * needs to be read uncompressed */
459                 wimlib_assert(lte->file_on_disk);
460                 /* Use existing file pointer if available; otherwise open one
461                  * temporarily */
462                 if (lte->file_on_disk_fp) {
463                         fp = lte->file_on_disk_fp;
464                 } else {
465                         fp = fopen(lte->file_on_disk, "rb");
466                         if (!fp) {
467                                 ERROR_WITH_ERRNO("Failed to open the file "
468                                                  "`%s'", lte->file_on_disk);
469                         }
470                 }
471                 ret = read_uncompressed_resource(fp, offset, size, buf);
472                 if (fp != lte->file_on_disk_fp)
473                         fclose(fp);
474                 return ret;
475                 break;
476         case RESOURCE_IN_ATTACHED_BUFFER:
477                 /* The resource is directly attached uncompressed in an
478                  * in-memory buffer. */
479                 wimlib_assert(lte->attached_buffer);
480                 memcpy(buf, lte->attached_buffer + offset, size);
481                 return 0;
482                 break;
483         default:
484                 assert(0);
485         }
486 }
487
488 /* 
489  * Reads all the data from the resource corresponding to a WIM lookup table
490  * entry.
491  *
492  * @lte:        The WIM lookup table entry for the resource.
493  * @buf:        Buffer into which to write the data.  It must be at least
494  *              wim_resource_size(lte) bytes long.
495  *
496  * Returns 0 on success; nonzero on failure.
497  */
498 int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[])
499 {
500         return read_wim_resource(lte, buf, wim_resource_size(lte), 0, false);
501 }
502
503 /* Chunk table that's located at the beginning of each compressed resource in
504  * the WIM.  (This is not the on-disk format; the on-disk format just has an
505  * array of offsets.) */
506 struct chunk_table {
507         off_t file_offset;
508         u64 num_chunks;
509         u64 original_resource_size;
510         u64 bytes_per_chunk_entry;
511         u64 table_disk_size;
512         u64 cur_offset;
513         u64 *cur_offset_p;
514         u64 offsets[0];
515 };
516
517 /* 
518  * Allocates and initializes a chunk table, and reserves space for it in the
519  * output file.
520  */
521 static int
522 begin_wim_resource_chunk_tab(const struct lookup_table_entry *lte,
523                              FILE *out_fp,
524                              off_t file_offset,
525                              struct chunk_table **chunk_tab_ret)
526 {
527         u64 size = wim_resource_size(lte);
528         u64 num_chunks = (size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
529         struct chunk_table *chunk_tab = MALLOC(sizeof(struct chunk_table) +
530                                                num_chunks * sizeof(u64));
531         int ret = 0;
532
533         wimlib_assert(size != 0);
534
535         if (!chunk_tab) {
536                 ERROR("Failed to allocate chunk table for %"PRIu64" byte "
537                       "resource", size);
538                 ret = WIMLIB_ERR_NOMEM;
539                 goto out;
540         }
541         chunk_tab->file_offset = file_offset;
542         chunk_tab->num_chunks = num_chunks;
543         chunk_tab->original_resource_size = size;
544         chunk_tab->bytes_per_chunk_entry = (size >= (1ULL << 32)) ? 8 : 4;
545         chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry *
546                                      (num_chunks - 1);
547         chunk_tab->cur_offset = 0;
548         chunk_tab->cur_offset_p = chunk_tab->offsets;
549
550         if (fwrite(chunk_tab, 1, chunk_tab->table_disk_size, out_fp) !=
551                    chunk_tab->table_disk_size) {
552                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
553                                  "file resource");
554                 ret = WIMLIB_ERR_WRITE;
555                 goto out;
556         }
557
558         *chunk_tab_ret = chunk_tab;
559 out:
560         return ret;
561 }
562
563 /* 
564  * Compresses a chunk of a WIM resource.
565  *
566  * @chunk:              Uncompressed data of the chunk.
567  * @chunk_size:         Size of the uncompressed chunk in bytes.
568  * @compressed_chunk:   Pointer to output buffer of size at least
569  *                              (@chunk_size - 1) bytes.
570  * @compressed_chunk_len_ret:   Pointer to an unsigned int into which the size
571  *                                      of the compressed chunk will be
572  *                                      returned.
573  * @ctype:      Type of compression to use.  Must be WIM_COMPRESSION_TYPE_LZX
574  *              or WIM_COMPRESSION_TYPE_XPRESS.
575  *
576  * Returns zero if compressed succeeded, and nonzero if the chunk could not be
577  * compressed to any smaller than @chunk_size.  This function cannot fail for
578  * any other reasons.
579  */
580 static int compress_chunk(const u8 chunk[], unsigned chunk_size,
581                           u8 compressed_chunk[],
582                           unsigned *compressed_chunk_len_ret,
583                           int ctype)
584 {
585         unsigned compressed_chunk_sz;
586         int (*compress)(const void *, unsigned, void *, unsigned *);
587         switch (ctype) {
588         case WIM_COMPRESSION_TYPE_LZX:
589                 compress = lzx_compress;
590                 break;
591         case WIM_COMPRESSION_TYPE_XPRESS:
592                 compress = xpress_compress;
593                 break;
594         default:
595                 wimlib_assert(0);
596                 break;
597         }
598         return (*compress)(chunk, chunk_size, compressed_chunk,
599                            compressed_chunk_len_ret);
600 }
601
602 /*
603  * Writes a chunk of a WIM resource to an output file.
604  *
605  * @chunk:        Uncompressed data of the chunk.
606  * @chunk_size:   Size of the chunk (<= WIM_CHUNK_SIZE)
607  * @out_fp:       FILE * to write tho chunk to.
608  * @out_ctype:    Compression type to use when writing the chunk (ignored if no 
609  *                      chunk table provided)
610  * @chunk_tab:    Pointer to chunk table being created.  It is updated with the
611  *                      offset of the chunk we write.
612  *
613  * Returns 0 on success; nonzero on failure.
614  */
615 static int write_wim_resource_chunk(const u8 chunk[], unsigned chunk_size,
616                                     FILE *out_fp, int out_ctype,
617                                     struct chunk_table *chunk_tab)
618 {
619         const u8 *out_chunk;
620         unsigned out_chunk_size;
621
622         wimlib_assert(chunk_size <= WIM_CHUNK_SIZE);
623
624         if (!chunk_tab) {
625                 out_chunk = chunk;
626                 out_chunk_size = chunk_size;
627         } else {
628                 u8 *compressed_chunk = alloca(chunk_size);
629                 int ret;
630                 unsigned compressed_chunk_len;
631
632                 ret = compress_chunk(chunk, chunk_size, compressed_chunk,
633                                      &out_chunk_size, out_ctype);
634                 if (ret == 0) {
635                         out_chunk = compressed_chunk;
636                 } else {
637                         out_chunk = chunk;
638                         out_chunk_size = chunk_size;
639                 }
640                 *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
641                 chunk_tab->cur_offset += out_chunk_size;
642         }
643         
644         if (fwrite(out_chunk, 1, out_chunk_size, out_fp) != out_chunk_size) {
645                 ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
646                 return WIMLIB_ERR_WRITE;
647         }
648         return 0;
649 }
650
651 /* 
652  * Finishes a WIM chunk tale and writes it to the output file at the correct
653  * offset.
654  *
655  * The final size of the full compressed resource is returned in the
656  * @compressed_size_p.
657  */
658 static int
659 finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab,
660                               FILE *out_fp, u64 *compressed_size_p)
661 {
662         size_t bytes_written;
663         if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
664                 ERROR_WITH_ERRNO("Failed to seek to byte "PRIu64" of output "
665                                  "WIM file", chunk_tab->file_offset);
666                 return WIMLIB_ERR_WRITE;
667         }
668
669         if (chunk_tab->bytes_per_chunk_entry == 8) {
670                 array_to_le64(chunk_tab->offsets, chunk_tab->num_chunks);
671         } else {
672                 for (u64 i = 0; i < chunk_tab->num_chunks; i++)
673                         ((u32*)chunk_tab->offsets)[i] =
674                                 to_le32(chunk_tab->offsets[i]);
675         }
676         bytes_written = fwrite((u8*)chunk_tab->offsets +
677                                         chunk_tab->bytes_per_chunk_entry,
678                                1, chunk_tab->table_disk_size, out_fp);
679         if (bytes_written != chunk_tab->table_disk_size) {
680                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
681                                  "file resource");
682                 return WIMLIB_ERR_WRITE;
683         }
684         if (fseeko(out_fp, 0, SEEK_END) != 0) {
685                 ERROR_WITH_ERRNO("Failed to seek to end of output WIM file");
686                 return WIMLIB_ERR_WRITE;
687         }
688         *compressed_size_p = chunk_tab->cur_offset + chunk_tab->table_disk_size;
689         return 0;
690 }
691
692 /*
693  * Writes a WIM resource to a FILE * opened for writing.  The resource may be
694  * written uncompressed or compressed depending on the @out_ctype parameter.
695  *
696  * If by chance the resource compresses to more than the original size (this may
697  * happen with random data or files than are pre-compressed), the resource is
698  * instead written uncompressed (and this is reflected in the @out_res_entry by
699  * removing the WIM_RESHDR_FLAG_COMPRESSED flag).
700  *
701  * @lte:        The lookup table entry for the WIM resource.
702  * @out_fp:     The FILE * to write the resource to.
703  * @out_ctype:  The compression type of the resource to write.  Note: if this is
704  *                      the same as the compression type of the WIM resource we
705  *                      need to read, we simply copy the data (i.e. we do not
706  *                      uncompress it, then compress it again).
707  * @out_res_entry:  If non-NULL, a resource entry that is filled in with the 
708  *                  offset, original size, compressed size, and compression flag
709  *                  of the output resource.
710  *
711  * Returns 0 on success; nonzero on failure.
712  */
713 static int write_wim_resource(struct lookup_table_entry *lte,
714                               FILE *out_fp, int out_ctype,
715                               struct resource_entry *out_res_entry)
716 {
717         u64 bytes_remaining;
718         u64 original_size;
719         u64 old_compressed_size;
720         u64 new_compressed_size;
721         u64 offset = 0;
722         int ret = 0;
723         struct chunk_table *chunk_tab = NULL;
724         bool raw;
725         off_t file_offset;
726
727         /* Original size of the resource */
728         original_size = wim_resource_size(lte);
729
730         /* Compressed size of the resource (as it exists now) */
731         old_compressed_size = wim_resource_compressed_size(lte);
732
733         /* Current offset in output file */
734         file_offset = ftello(out_fp);
735         if (file_offset == -1) {
736                 ERROR_WITH_ERRNO("Failed to get offset in output "
737                                  "stream");
738                 return WIMLIB_ERR_WRITE;
739         }
740         
741         /* Are the compression types the same?  If so, do a raw copy (copy
742          * without decompressing and recompressing the data). */
743         raw = (wim_resource_compression_type(lte) == out_ctype
744                && out_ctype != WIM_COMPRESSION_TYPE_NONE);
745         if (raw)
746                 bytes_remaining = old_compressed_size;
747         else
748                 bytes_remaining = original_size;
749
750         /* Empty resource; nothing needs to be done, so just return success. */
751         if (bytes_remaining == 0)
752                 return 0;
753
754         /* Buffer for reading chunks for the resource */
755         char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
756
757         /* If we are writing a compressed resource and not doing a raw copy, we
758          * need to initialize the chunk table */
759         if (out_ctype != WIM_COMPRESSION_TYPE_NONE && !raw) {
760                 ret = begin_wim_resource_chunk_tab(lte, out_fp, file_offset,
761                                                    &chunk_tab);
762                 if (ret != 0)
763                         goto out;
764         }
765
766         /* If the WIM resource is in an external file, open a FILE * to it so we
767          * don't have to open a temporary one in read_wim_resource() for each
768          * chunk. */
769         if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK
770              && !lte->file_on_disk_fp)
771         {
772                 wimlib_assert(lte->file_on_disk);
773                 lte->file_on_disk_fp = fopen(lte->file_on_disk, "rb");
774                 if (!lte->file_on_disk_fp) {
775                         ERROR_WITH_ERRNO("Failed to open the file `%s' for "
776                                          "reading", lte->file_on_disk);
777                         ret = WIMLIB_ERR_OPEN;
778                         goto out;
779                 }
780         }
781
782         /* If we aren't doing a raw copy, we will compute the SHA1 message
783          * digest of the resource as we read it, and verify it's the same as the
784          * hash given in the lookup table entry once we've finished reading the
785          * resource. */
786         SHA_CTX ctx;
787         if (!raw)
788                 sha1_init(&ctx);
789
790         /* While there are still bytes remaining in the WIM resource, read a
791          * chunk of the resource, update SHA1, then write that chunk using the
792          * desired compression type. */
793         do {
794                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
795                 ret = read_wim_resource(lte, buf, to_read, offset, raw);
796                 if (ret != 0)
797                         goto out_fclose;
798                 if (!raw)
799                         sha1_update(&ctx, buf, to_read);
800                 ret = write_wim_resource_chunk(buf, to_read, out_fp,
801                                                out_ctype, chunk_tab);
802                 if (ret != 0)
803                         goto out_fclose;
804                 bytes_remaining -= to_read;
805                 offset += to_read;
806         } while (bytes_remaining);
807
808         /* If writing a compressed resource and not doing a raw copy, write the
809          * chunk table, and finish_wim_resource_chunk_tab() will provide the
810          * compressed size of the resource we wrote.  Otherwise, the compressed
811          * size of the written resource is the same as the compressed size of
812          * the existing resource. */
813         if (out_ctype != WIM_COMPRESSION_TYPE_NONE && !raw) {
814                 ret = finish_wim_resource_chunk_tab(chunk_tab, out_fp,
815                                                     &new_compressed_size);
816                 if (ret != 0)
817                         goto out_fclose;
818         } else {
819                 new_compressed_size = old_compressed_size;
820         }
821
822         /* Verify SHA1 message digest of the resource, unless we are doing a raw
823          * write (in which case we never even saw the uncompressed data).  Or,
824          * if the hash we had before is all 0's, just re-set it to be the new
825          * hash. */
826         if (!raw) {
827                 u8 md[SHA1_HASH_SIZE];
828                 sha1_final(md, &ctx);
829                 if (is_zero_hash(lte->hash)) {
830                         copy_hash(lte->hash, md);
831                 } else if (!hashes_equal(md, lte->hash)) {
832                         ERROR("WIM resource has incorrect hash!");
833                         if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK) {
834                                 ERROR("We were reading it from `%s'; maybe it changed "
835                                       "while we were reading it.",
836                                       lte->file_on_disk);
837                         }
838                         ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
839                         goto out_fclose;
840                 }
841         }
842
843         if (new_compressed_size > original_size) {
844                 /* Oops!  We compressed the resource to larger than the original
845                  * size.  Write the resource uncompressed instead. */
846                 if (fseeko(out_fp, file_offset, SEEK_SET) != 0) {
847                         ERROR_WITH_ERRNO("Failed to seek to byte "PRIu64" "
848                                          "of output WIM file", file_offset);
849                         ret = WIMLIB_ERR_WRITE;
850                         goto out_fclose;
851                 }
852                 ret = write_wim_resource(lte, out_fp, WIM_COMPRESSION_TYPE_NONE,
853                                          out_res_entry);
854                 if (ret != 0)
855                         goto out_fclose;
856                 if (fflush(out_fp) != 0) {
857                         ERROR_WITH_ERRNO("Failed to flush output WIM file");
858                         ret = WIMLIB_ERR_WRITE;
859                         goto out_fclose;
860                 }
861                 if (ftruncate(fileno(out_fp), file_offset + out_res_entry->size) != 0) {
862                         ERROR_WITH_ERRNO("Failed to truncate output WIM file");
863                         ret = WIMLIB_ERR_WRITE;
864                 }
865                 goto out_fclose;
866         }
867         wimlib_assert(new_compressed_size <= original_size);
868         if (out_res_entry) {
869                 out_res_entry->size          = new_compressed_size;
870                 out_res_entry->original_size = original_size;
871                 out_res_entry->offset        = file_offset;
872                 out_res_entry->flags         = lte->resource_entry.flags
873                                                 & ~WIM_RESHDR_FLAG_COMPRESSED;
874                 if (out_ctype != WIM_COMPRESSION_TYPE_NONE)
875                         out_res_entry->flags |= WIM_RESHDR_FLAG_COMPRESSED;
876         }
877 out_fclose:
878         if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK
879              && lte->file_on_disk_fp) {
880                 fclose(lte->file_on_disk_fp);
881                 lte->file_on_disk_fp = NULL;
882         }
883 out:
884         FREE(chunk_tab);
885         return ret;
886 }
887
888 /* Like write_wim_resource(), but the resource is specified by a buffer of
889  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
890  * the buffer to @hash.  */
891 static int write_wim_resource_from_buffer(const u8 *buf, u64 buf_size,
892                                           FILE *out_fp, int out_ctype,
893                                           struct resource_entry *out_res_entry,
894                                           u8 hash[SHA1_HASH_SIZE])
895 {
896         /* Set up a temporary lookup table entry that we provide to
897          * write_wim_resource(). */
898         struct lookup_table_entry lte;
899         int ret;
900         lte.resource_entry.flags         = 0;
901         lte.resource_entry.original_size = buf_size;
902         lte.resource_entry.size          = buf_size;
903         lte.resource_entry.offset        = 0;
904         lte.resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
905         lte.attached_buffer              = (u8*)buf;
906
907         zero_hash(lte.hash);
908         ret = write_wim_resource(&lte, out_fp, out_ctype, out_res_entry);
909         if (ret != 0)
910                 return ret;
911         copy_hash(hash, lte.hash);
912         return 0;
913 }
914
915 /* 
916  * Extracts the first @size bytes of the WIM resource specified by @lte to the
917  * open file descriptor @fd.
918  * 
919  * Returns 0 on success; nonzero on failure.
920  */
921 int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd,
922                                u64 size)
923 {
924         u64 bytes_remaining = size;
925         char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
926         u64 offset = 0;
927         int ret = 0;
928         u8 hash[SHA1_HASH_SIZE];
929
930         SHA_CTX ctx;
931         sha1_init(&ctx);
932
933         while (bytes_remaining) {
934                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
935                 ret = read_wim_resource(lte, buf, to_read, offset, false);
936                 if (ret != 0)
937                         break;
938                 sha1_update(&ctx, buf, to_read);
939                 if (full_write(fd, buf, to_read) < 0) {
940                         ERROR_WITH_ERRNO("Error extracting WIM resource");
941                         return WIMLIB_ERR_WRITE;
942                 }
943                 bytes_remaining -= to_read;
944                 offset += to_read;
945         }
946         sha1_final(hash, &ctx);
947         if (!hashes_equal(hash, lte->hash)) {
948                 ERROR("Invalid checksum on a WIM resource "
949                       "(detected when extracting to external file)");
950                 ERROR("The following WIM resource is invalid:");
951                 print_lookup_table_entry(lte);
952                 return WIMLIB_ERR_INVALID_RESOURCE_HASH;
953         }
954         return 0;
955 }
956
957 /* 
958  * Extracts the WIM resource specified by @lte to the open file descriptor @fd.
959  * 
960  * Returns 0 on success; nonzero on failure.
961  */
962 int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd)
963 {
964         return extract_wim_resource_to_fd(lte, fd, wim_resource_size(lte));
965 }
966
967 /* 
968  * Copies the file resource specified by the lookup table entry @lte from the
969  * input WIM to the output WIM that has its FILE * given by
970  * ((WIMStruct*)wim)->out_fp.
971  *
972  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
973  * updated.
974  *
975  * Metadata resources are not copied (they are handled elsewhere for joining and
976  * splitting).
977  */
978 int copy_resource(struct lookup_table_entry *lte, void *wim)
979 {
980         WIMStruct *w = wim;
981         int ret;
982
983         if ((lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) &&
984             !w->write_metadata)
985                 return 0;
986
987         ret = write_wim_resource(lte, w->out_fp,
988                                  wim_resource_compression_type(lte), 
989                                  &lte->output_resource_entry);
990         if (ret != 0)
991                 return ret;
992         lte->out_refcnt = lte->refcnt;
993         lte->part_number = w->hdr.part_number;
994         return 0;
995 }
996
997 /* 
998  * Writes a dentry's resources, including the main file resource as well as all
999  * alternate data streams, to the output file. 
1000  *
1001  * @dentry:  The dentry for the file.
1002  * @wim_p:   A pointer to the WIMStruct containing @dentry.
1003  *
1004  * @return zero on success, nonzero on failure. 
1005  */
1006 int write_dentry_resources(struct dentry *dentry, void *wim_p)
1007 {
1008         WIMStruct *w = wim_p;
1009         int ret = 0;
1010         struct lookup_table_entry *lte;
1011         int ctype = wimlib_get_compression_type(w);
1012
1013         if (w->write_flags & WIMLIB_WRITE_FLAG_VERBOSE) {
1014                 wimlib_assert(dentry->full_path_utf8);
1015                 printf("Writing streams for `%s'\n", dentry->full_path_utf8);
1016         }
1017
1018         for (unsigned i = 0; i <= dentry->num_ads; i++) {
1019                 lte = dentry_stream_lte(dentry, i, w->lookup_table);
1020                 if (lte && ++lte->out_refcnt == 1) {
1021                         ret = write_wim_resource(lte, w->out_fp, ctype,
1022                                                  &lte->output_resource_entry);
1023                         if (ret != 0)
1024                                 break;
1025                 }
1026         }
1027         return ret;
1028 }
1029
1030 /* 
1031  * Reads the metadata metadata resource from the WIM file.  The metadata
1032  * resource consists of the security data, followed by the directory entry for
1033  * the root directory, followed by all the other directory entries in the
1034  * filesystem.  The subdir_offset field of each directory entry gives the start
1035  * of its child entries from the beginning of the metadata resource.  An
1036  * end-of-directory is signaled by a directory entry of length '0', really of
1037  * length 8, because that's how long the 'length' field is.
1038  *
1039  * @fp:         The FILE* for the input WIM file.
1040  * @wim_ctype:  The compression type of the WIM file.
1041  * @imd:        Pointer to the image metadata structure.  Its `metadata_lte'
1042  *              member specifies the lookup table entry for the metadata
1043  *              resource.  The rest of the image metadata entry will be filled
1044  *              in by this function.
1045  *
1046  * @return:     Zero on success, nonzero on failure.
1047  */
1048 int read_metadata_resource(FILE *fp, int wim_ctype, struct image_metadata *imd)
1049 {
1050         u8 *buf;
1051         int ctype;
1052         u32 dentry_offset;
1053         int ret;
1054         struct dentry *dentry;
1055         struct wim_security_data *sd;
1056         struct link_group_table *lgt;
1057         const struct lookup_table_entry *metadata_lte;
1058         const struct resource_entry *res_entry;
1059
1060         metadata_lte = imd->metadata_lte;
1061         res_entry = &metadata_lte->resource_entry;
1062
1063         DEBUG("Reading metadata resource: length = %"PRIu64", "
1064               "offset = %"PRIu64"",
1065               res_entry->original_size, res_entry->offset);
1066
1067         if (res_entry->original_size < 8) {
1068                 ERROR("Expected at least 8 bytes for the metadata resource");
1069                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
1070         }
1071
1072         /* Allocate memory for the uncompressed metadata resource. */
1073         buf = MALLOC(res_entry->original_size);
1074
1075         if (!buf) {
1076                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
1077                       "metadata resource", res_entry->original_size);
1078                 return WIMLIB_ERR_NOMEM;
1079         }
1080
1081         /* Determine the compression type of the metadata resource. */
1082
1083         /* Read the metadata resource into memory.  (It may be compressed.) */
1084         ret = read_full_wim_resource(metadata_lte, buf);
1085         if (ret != 0)
1086                 goto out_free_buf;
1087
1088         DEBUG("Finished reading metadata resource into memory.");
1089
1090         /* The root directory entry starts after security data, on an 8-byte
1091          * aligned address. 
1092          *
1093          * The security data starts with a 4-byte integer giving its total
1094          * length. */
1095
1096         /* Read the security data into a wim_security_data structure. */
1097         ret = read_security_data(buf, res_entry->original_size, &sd);
1098         if (ret != 0)
1099                 goto out_free_buf;
1100
1101         dentry = MALLOC(sizeof(struct dentry));
1102         if (!dentry) {
1103                 ERROR("Failed to allocate %zu bytes for root dentry",
1104                       sizeof(struct dentry));
1105                 ret = WIMLIB_ERR_NOMEM;
1106                 goto out_free_security_data;
1107         }
1108
1109         get_u32(buf, &dentry_offset);
1110         if (dentry_offset == 0)
1111                 dentry_offset = 8;
1112         dentry_offset = (dentry_offset + 7) & ~7;
1113                 
1114         ret = read_dentry(buf, res_entry->original_size, dentry_offset, dentry);
1115         /* This is the root dentry, so set its pointers correctly. */
1116         dentry->parent = dentry;
1117         dentry->next   = dentry;
1118         dentry->prev   = dentry;
1119         if (ret != 0)
1120                 goto out_free_dentry_tree;
1121
1122         DEBUG("Reading dentry tree");
1123         /* Now read the entire directory entry tree. */
1124         ret = read_dentry_tree(buf, res_entry->original_size, dentry);
1125         if (ret != 0)
1126                 goto out_free_dentry_tree;
1127
1128         DEBUG("Calculating dentry full paths");
1129         /* Calculate the full paths in the dentry tree. */
1130         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
1131         if (ret != 0)
1132                 goto out_free_dentry_tree;
1133
1134         DEBUG("Building link group table");
1135         /* Build hash table that maps hard link group IDs to dentry sets */
1136         lgt = new_link_group_table(9001);
1137         if (!lgt)
1138                 goto out_free_dentry_tree;
1139         ret = for_dentry_in_tree(dentry, link_group_table_insert, lgt);
1140         if (ret != 0)
1141                 goto out_free_lgt;
1142
1143         DEBUG("Freeing duplicate ADS entries in link group table");
1144         ret = link_groups_free_duplicate_data(lgt);
1145         if (ret != 0)
1146                 goto out_free_lgt;
1147         DEBUG("Done reading image metadata");
1148
1149         imd->lgt           = lgt;
1150         imd->security_data = sd;
1151         imd->root_dentry   = dentry;
1152         goto out_free_buf;
1153 out_free_lgt:
1154         free_link_group_table(lgt);
1155 out_free_dentry_tree:
1156         free_dentry_tree(dentry, NULL);
1157 out_free_security_data:
1158         free_security_data(sd);
1159 out_free_buf:
1160         FREE(buf);
1161         return ret;
1162 }
1163
1164 /* Write the metadata resource for the current WIM image. */
1165 int write_metadata_resource(WIMStruct *w)
1166 {
1167         u8 *buf;
1168         u8 *p;
1169         int ret;
1170         u64 subdir_offset;
1171         struct dentry *root;
1172         struct lookup_table_entry *lte, *duplicate_lte;
1173         u64 metadata_original_size;
1174
1175         /* 
1176          * We append 20 random bytes to the metadata resource so that we don't
1177          * have identical metadata resources if we happen to append exactly the
1178          * same image twice without any changes in timestamps.  If this were to
1179          * happen, it would cause confusion about the number and order of images
1180          * in the WIM.
1181          */
1182         const unsigned random_tail_len = 20;
1183
1184         DEBUG("Writing metadata resource for image %d", w->current_image);
1185
1186         root = wim_root_dentry(w);
1187
1188         struct wim_security_data *sd = wim_security_data(w);
1189         if (sd)
1190                 subdir_offset = sd->total_length + root->length + 8;
1191         else
1192                 subdir_offset = 8 + root->length + 8;
1193         calculate_subdir_offsets(root, &subdir_offset);
1194         metadata_original_size = subdir_offset + random_tail_len;
1195         buf = MALLOC(metadata_original_size);
1196         if (!buf) {
1197                 ERROR("Failed to allocate %"PRIu64" bytes for "
1198                       "metadata resource", metadata_original_size);
1199                 return WIMLIB_ERR_NOMEM;
1200         }
1201
1202         p = write_security_data(sd, buf);
1203
1204         DEBUG("Writing dentry tree.");
1205         p = write_dentry_tree(root, p);
1206         randomize_byte_array(p, random_tail_len);
1207         wimlib_assert(p - buf + random_tail_len == metadata_original_size);
1208
1209         lte = wim_metadata_lookup_table_entry(w);
1210
1211         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
1212                                              w->out_fp,
1213                                              wimlib_get_compression_type(w),
1214                                              &lte->output_resource_entry,
1215                                              lte->hash);
1216         lookup_table_unlink(w->lookup_table, lte);
1217         lookup_table_insert(w->lookup_table, lte);
1218         wimlib_assert(lte->out_refcnt == 0);
1219         lte->out_refcnt++;
1220         lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA;
1221 out:
1222         FREE(buf);
1223         return ret;
1224 }