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