Implement multi-threaded compression
[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 "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 *, uint, void *, uint);
85         /* Set the appropriate decompress function. */
86         if (resource_ctype == WIM_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                 uint compressed_chunk_size, uncompressed_chunk_size;
234                 if (i != num_chunks - 1) {
235                         /* All the chunks except the last one in the resource
236                          * expand to WIM_CHUNK_SIZE uncompressed, and the amount
237                          * of compressed data for the chunk is given by the
238                          * difference of offsets in the chunk offset table. */
239                         compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] -
240                                                 chunk_offsets[i - start_chunk];
241                         uncompressed_chunk_size = WIM_CHUNK_SIZE;
242                 } else {
243                         /* The last compressed chunk consists of the remaining
244                          * bytes in the file resource, and the last uncompressed
245                          * chunk has size equal to however many bytes are left-
246                          * that is, the remainder of the uncompressed size when
247                          * divided by WIM_CHUNK_SIZE.
248                          *
249                          * Note that the resource_compressed_size includes the
250                          * chunk table, so the size of it must be subtracted. */
251                         compressed_chunk_size = resource_compressed_size -
252                                                 chunk_table_size -
253                                                 chunk_offsets[i - start_chunk];
254
255                         uncompressed_chunk_size = resource_uncompressed_size %
256                                                                 WIM_CHUNK_SIZE;
257
258                         /* If the remainder is 0, the last chunk actually
259                          * uncompresses to a full WIM_CHUNK_SIZE bytes. */
260                         if (uncompressed_chunk_size == 0)
261                                 uncompressed_chunk_size = WIM_CHUNK_SIZE;
262                 }
263
264                 DEBUG2("compressed_chunk_size = %u, "
265                        "uncompressed_chunk_size = %u",
266                        compressed_chunk_size, uncompressed_chunk_size);
267
268
269                 /* Figure out how much of this chunk we actually need to read */
270                 u64 start_offset;
271                 if (i == start_chunk)
272                         start_offset = start_chunk_offset;
273                 else
274                         start_offset = 0;
275                 u64 end_offset;
276                 if (i == end_chunk)
277                         end_offset = end_chunk_offset;
278                 else
279                         end_offset = WIM_CHUNK_SIZE - 1;
280
281                 u64 partial_chunk_size = end_offset + 1 - start_offset;
282                 bool is_partial_chunk = (partial_chunk_size !=
283                                                 uncompressed_chunk_size);
284
285                 DEBUG2("start_offset = %u, end_offset = %u", start_offset,
286                                         end_offset);
287                 DEBUG2("partial_chunk_size = %u", partial_chunk_size);
288
289                 /* This is undocumented, but chunks can be uncompressed.  This
290                  * appears to always be the case when the compressed chunk size
291                  * is equal to the uncompressed chunk size. */
292                 if (compressed_chunk_size == uncompressed_chunk_size) {
293                         /* Probably an uncompressed chunk */
294
295                         if (start_offset != 0) {
296                                 if (fseeko(fp, start_offset, SEEK_CUR) != 0) {
297                                         ERROR_WITH_ERRNO("Uncompressed partial "
298                                                          "chunk fseek() error");
299                                         return WIMLIB_ERR_READ;
300                                 }
301                         }
302                         if (fread(out_p, 1, partial_chunk_size, fp) !=
303                                         partial_chunk_size)
304                                 goto err;
305                 } else {
306                         /* Compressed chunk */
307                         int ret;
308
309                         /* Read the compressed data into compressed_buf. */
310                         if (fread(compressed_buf, 1, compressed_chunk_size,
311                                                 fp) != compressed_chunk_size)
312                                 goto err;
313
314                         /* For partial chunks we must buffer the uncompressed
315                          * data because we don't need all of it. */
316                         if (is_partial_chunk) {
317                                 u8 uncompressed_buf[uncompressed_chunk_size];
318
319                                 ret = decompress(compressed_buf,
320                                                 compressed_chunk_size,
321                                                 uncompressed_buf,
322                                                 uncompressed_chunk_size);
323                                 if (ret != 0)
324                                         return WIMLIB_ERR_DECOMPRESSION;
325                                 memcpy(out_p, uncompressed_buf + start_offset,
326                                                 partial_chunk_size);
327                         } else {
328                                 ret = decompress(compressed_buf,
329                                                 compressed_chunk_size,
330                                                 out_p,
331                                                 uncompressed_chunk_size);
332                                 if (ret != 0)
333                                         return WIMLIB_ERR_DECOMPRESSION;
334                         }
335                 }
336
337                 /* Advance the pointer into the uncompressed output data by the
338                  * number of uncompressed bytes that were written.  */
339                 out_p += partial_chunk_size;
340         }
341
342         return 0;
343
344 err:
345         if (feof(fp))
346                 ERROR("Unexpected EOF in compressed file resource");
347         else
348                 ERROR_WITH_ERRNO("Error reading compressed file resource");
349         return WIMLIB_ERR_READ;
350 }
351
352 /*
353  * Reads uncompressed data from an open file stream.
354  */
355 int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
356                                u8 contents_ret[])
357 {
358         if (fseeko(fp, offset, SEEK_SET) != 0) {
359                 ERROR("Failed to seek to byte %"PRIu64" of input file "
360                       "to read uncompressed resource (len = %"PRIu64")",
361                       offset, len);
362                 return WIMLIB_ERR_READ;
363         }
364         if (fread(contents_ret, 1, len, fp) != len) {
365                 if (feof(fp)) {
366                         ERROR("Unexpected EOF in uncompressed file resource");
367                 } else {
368                         ERROR("Failed to read %"PRIu64" bytes from "
369                               "uncompressed resource at offset %"PRIu64,
370                               len, offset);
371                 }
372                 return WIMLIB_ERR_READ;
373         }
374         return 0;
375 }
376
377
378
379
380 /* Reads the contents of a struct resource_entry, as represented in the on-disk
381  * format, from the memory pointed to by @p, and fills in the fields of @entry.
382  * A pointer to the byte after the memory read at @p is returned. */
383 const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry)
384 {
385         u64 size;
386         u8 flags;
387
388         p = get_u56(p, &size);
389         p = get_u8(p, &flags);
390         entry->size = size;
391         entry->flags = flags;
392
393         /* offset and original_size are truncated to 62 bits to avoid possible
394          * overflows, when converting to a signed 64-bit integer (off_t) or when
395          * adding size or original_size.  This is okay since no one would ever
396          * actually have a WIM bigger than 4611686018427387903 bytes... */
397         p = get_u64(p, &entry->offset);
398         if (entry->offset & 0xc000000000000000ULL) {
399                 WARNING("Truncating offset in resource entry");
400                 entry->offset &= 0x3fffffffffffffffULL;
401         }
402         p = get_u64(p, &entry->original_size);
403         if (entry->original_size & 0xc000000000000000ULL) {
404                 WARNING("Truncating original_size in resource entry");
405                 entry->original_size &= 0x3fffffffffffffffULL;
406         }
407         return p;
408 }
409
410 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
411  * on-disk format.  A pointer to the byte after the memory written at @p is
412  * returned. */
413 u8 *put_resource_entry(u8 *p, const struct resource_entry *entry)
414 {
415         p = put_u56(p, entry->size);
416         p = put_u8(p, entry->flags);
417         p = put_u64(p, entry->offset);
418         p = put_u64(p, entry->original_size);
419         return p;
420 }
421
422 static FILE *wim_get_fp(WIMStruct *w)
423 {
424         pthread_mutex_lock(&w->fp_tab_mutex);
425         FILE *fp;
426
427         wimlib_assert(w->filename != NULL);
428
429         for (size_t i = 0; i < w->num_allocated_fps; i++) {
430                 if (w->fp_tab[i]) {
431                         fp = w->fp_tab[i];
432                         w->fp_tab[i] = NULL;
433                         goto out;
434                 }
435         }
436         DEBUG("Opening extra file descriptor to `%s'", w->filename);
437         fp = fopen(w->filename, "rb");
438         if (!fp)
439                 ERROR_WITH_ERRNO("Failed to open `%s'", w->filename);
440 out:
441         pthread_mutex_unlock(&w->fp_tab_mutex);
442         return fp;
443 }
444
445 static int wim_release_fp(WIMStruct *w, FILE *fp)
446 {
447         int ret = 0;
448         FILE **fp_tab;
449
450         pthread_mutex_lock(&w->fp_tab_mutex);
451
452         for (size_t i = 0; i < w->num_allocated_fps; i++) {
453                 if (w->fp_tab[i] == NULL) {
454                         w->fp_tab[i] = fp;
455                         goto out;
456                 }
457         }
458
459         fp_tab = REALLOC(w->fp_tab, sizeof(FILE*) * (w->num_allocated_fps + 4));
460         if (!fp_tab) {
461                 ret = WIMLIB_ERR_NOMEM;
462                 goto out;
463         }
464         w->fp_tab = fp_tab;
465         memset(&w->fp_tab[w->num_allocated_fps], 0, 4 * sizeof(FILE*));
466         w->fp_tab[w->num_allocated_fps] = fp;
467         w->num_allocated_fps += 4;
468 out:
469         pthread_mutex_unlock(&w->fp_tab_mutex);
470         return ret;
471 }
472
473 /*
474  * Reads some data from the resource corresponding to a WIM lookup table entry.
475  *
476  * @lte:        The WIM lookup table entry for the resource.
477  * @buf:        Buffer into which to write the data.
478  * @size:       Number of bytes to read.
479  * @offset:     Offset at which to start reading the resource.
480  *
481  * Returns zero on success, nonzero on failure.
482  */
483 int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
484                       size_t size, u64 offset, int flags)
485 {
486         int ctype;
487         int ret = 0;
488         FILE *fp;
489
490         /* We shouldn't be allowing read over-runs in any part of the library.
491          * */
492         if (flags & WIMLIB_RESOURCE_FLAG_RAW)
493                 wimlib_assert(offset + size <= lte->resource_entry.size);
494         else
495                 wimlib_assert(offset + size <= lte->resource_entry.original_size);
496
497         switch (lte->resource_location) {
498         case RESOURCE_IN_WIM:
499                 /* The resource is in a WIM file, and its WIMStruct is given by
500                  * the lte->wim member.  The resource may be either compressed
501                  * or uncompressed. */
502                 wimlib_assert(lte->wim != NULL);
503
504                 if (flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED) {
505                         fp = wim_get_fp(lte->wim);
506                         if (!fp)
507                                 return WIMLIB_ERR_OPEN;
508                 } else {
509                         wimlib_assert(lte->wim->fp != NULL);
510                         fp = lte->wim->fp;
511                 }
512
513                 ctype = wim_resource_compression_type(lte);
514
515                 wimlib_assert(ctype != WIM_COMPRESSION_TYPE_NONE ||
516                               (lte->resource_entry.original_size ==
517                                lte->resource_entry.size));
518
519                 if ((flags & WIMLIB_RESOURCE_FLAG_RAW)
520                     || ctype == WIM_COMPRESSION_TYPE_NONE)
521                         ret = read_uncompressed_resource(fp,
522                                                          lte->resource_entry.offset + offset,
523                                                          size, buf);
524                 else
525                         ret = read_compressed_resource(fp,
526                                                        lte->resource_entry.size,
527                                                        lte->resource_entry.original_size,
528                                                        lte->resource_entry.offset,
529                                                        ctype, size, offset, buf);
530                 if (flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED) {
531                         int ret2 = wim_release_fp(lte->wim, fp);
532                         if (ret == 0)
533                                 ret = ret2;
534                 }
535                 break;
536         case RESOURCE_IN_STAGING_FILE:
537         case RESOURCE_IN_FILE_ON_DISK:
538                 /* The resource is in some file on the external filesystem and
539                  * needs to be read uncompressed */
540                 wimlib_assert(lte->file_on_disk);
541                 wimlib_assert(&lte->file_on_disk == &lte->staging_file_name);
542                 /* Use existing file pointer if available; otherwise open one
543                  * temporarily */
544                 if (lte->file_on_disk_fp) {
545                         fp = lte->file_on_disk_fp;
546                 } else {
547                         fp = fopen(lte->file_on_disk, "rb");
548                         if (!fp) {
549                                 ERROR_WITH_ERRNO("Failed to open the file "
550                                                  "`%s'", lte->file_on_disk);
551                                 ret = WIMLIB_ERR_OPEN;
552                                 break;
553                         }
554                 }
555                 ret = read_uncompressed_resource(fp, offset, size, buf);
556                 if (fp != lte->file_on_disk_fp)
557                         fclose(fp);
558                 break;
559         case RESOURCE_IN_ATTACHED_BUFFER:
560                 /* The resource is directly attached uncompressed in an
561                  * in-memory buffer. */
562                 wimlib_assert(lte->attached_buffer != NULL);
563                 memcpy(buf, lte->attached_buffer + offset, size);
564                 break;
565 #ifdef WITH_NTFS_3G
566         case RESOURCE_IN_NTFS_VOLUME:
567                 wimlib_assert(lte->ntfs_loc != NULL);
568                 wimlib_assert(lte->attr != NULL);
569                 {
570                         if (lte->ntfs_loc->is_reparse_point)
571                                 offset += 8;
572                         if (ntfs_attr_pread(lte->attr, offset, size, buf) != size) {
573                                 ERROR_WITH_ERRNO("Error reading NTFS attribute "
574                                                  "at `%s'",
575                                                  lte->ntfs_loc->path_utf8);
576                                 ret = WIMLIB_ERR_NTFS_3G;
577                         }
578                         break;
579                 }
580 #endif
581         default:
582                 wimlib_assert(0);
583                 ret = -1;
584                 break;
585         }
586         return ret;
587 }
588
589 /*
590  * Reads all the data from the resource corresponding to a WIM lookup table
591  * entry.
592  *
593  * @lte:        The WIM lookup table entry for the resource.
594  * @buf:        Buffer into which to write the data.  It must be at least
595  *              wim_resource_size(lte) bytes long.
596  *
597  * Returns 0 on success; nonzero on failure.
598  */
599 int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
600                            int flags)
601 {
602         return read_wim_resource(lte, buf, wim_resource_size(lte), 0, flags);
603 }
604
605 /* Like write_wim_resource(), but the resource is specified by a buffer of
606  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
607  * the buffer to @hash.  */
608 static int write_wim_resource_from_buffer(const u8 *buf, u64 buf_size,
609                                           FILE *out_fp, int out_ctype,
610                                           struct resource_entry *out_res_entry,
611                                           u8 hash[SHA1_HASH_SIZE])
612 {
613         /* Set up a temporary lookup table entry to provide to
614          * write_wim_resource(). */
615         struct lookup_table_entry lte;
616         int ret;
617         lte.resource_entry.flags         = 0;
618         lte.resource_entry.original_size = buf_size;
619         lte.resource_entry.size          = buf_size;
620         lte.resource_entry.offset        = 0;
621         lte.resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
622         lte.attached_buffer              = (u8*)buf;
623
624         zero_out_hash(lte.hash);
625         ret = write_wim_resource(&lte, out_fp, out_ctype, out_res_entry, 0);
626         if (ret != 0)
627                 return ret;
628         copy_hash(hash, lte.hash);
629         return 0;
630 }
631
632 /*
633  * Extracts the first @size bytes of the WIM resource specified by @lte to the
634  * open file descriptor @fd.
635  *
636  * Returns 0 on success; nonzero on failure.
637  */
638 int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd,
639                                u64 size)
640 {
641         u64 bytes_remaining = size;
642         u8 buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
643         u64 offset = 0;
644         int ret = 0;
645         u8 hash[SHA1_HASH_SIZE];
646
647         SHA_CTX ctx;
648         sha1_init(&ctx);
649
650         while (bytes_remaining) {
651                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
652                 ret = read_wim_resource(lte, buf, to_read, offset, 0);
653                 if (ret != 0)
654                         break;
655                 sha1_update(&ctx, buf, to_read);
656                 if (full_write(fd, buf, to_read) < to_read) {
657                         ERROR_WITH_ERRNO("Error extracting WIM resource");
658                         return WIMLIB_ERR_WRITE;
659                 }
660                 bytes_remaining -= to_read;
661                 offset += to_read;
662         }
663         sha1_final(hash, &ctx);
664         if (!hashes_equal(hash, lte->hash)) {
665                 ERROR("Invalid checksum on a WIM resource "
666                       "(detected when extracting to external file)");
667                 ERROR("The following WIM resource is invalid:");
668                 print_lookup_table_entry(lte);
669                 return WIMLIB_ERR_INVALID_RESOURCE_HASH;
670         }
671         return 0;
672 }
673
674 /*
675  * Extracts the WIM resource specified by @lte to the open file descriptor @fd.
676  *
677  * Returns 0 on success; nonzero on failure.
678  */
679 int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd)
680 {
681         return extract_wim_resource_to_fd(lte, fd, wim_resource_size(lte));
682 }
683
684 /*
685  * Copies the file resource specified by the lookup table entry @lte from the
686  * input WIM to the output WIM that has its FILE * given by
687  * ((WIMStruct*)wim)->out_fp.
688  *
689  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
690  * updated.
691  *
692  * Metadata resources are not copied (they are handled elsewhere for joining and
693  * splitting).
694  */
695 int copy_resource(struct lookup_table_entry *lte, void *wim)
696 {
697         WIMStruct *w = wim;
698         int ret;
699
700         if ((lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) &&
701             !w->write_metadata)
702                 return 0;
703
704         ret = write_wim_resource(lte, w->out_fp,
705                                  wim_resource_compression_type(lte),
706                                  &lte->output_resource_entry, 0);
707         if (ret != 0)
708                 return ret;
709         lte->out_refcnt = lte->refcnt;
710         lte->part_number = w->hdr.part_number;
711         return 0;
712 }
713
714 /*
715  * Reads the metadata metadata resource from the WIM file.  The metadata
716  * resource consists of the security data, followed by the directory entry for
717  * the root directory, followed by all the other directory entries in the
718  * filesystem.  The subdir_offset field of each directory entry gives the start
719  * of its child entries from the beginning of the metadata resource.  An
720  * end-of-directory is signaled by a directory entry of length '0', really of
721  * length 8, because that's how long the 'length' field is.
722  *
723  * @fp:         The FILE* for the input WIM file.
724  * @wim_ctype:  The compression type of the WIM file.
725  * @imd:        Pointer to the image metadata structure.  Its `metadata_lte'
726  *              member specifies the lookup table entry for the metadata
727  *              resource.  The rest of the image metadata entry will be filled
728  *              in by this function.
729  *
730  * @return:     Zero on success, nonzero on failure.
731  */
732 int read_metadata_resource(WIMStruct *w, struct image_metadata *imd)
733 {
734         u8 *buf;
735         u32 dentry_offset;
736         int ret;
737         struct dentry *dentry;
738         struct inode_table inode_tab;
739         const struct lookup_table_entry *metadata_lte;
740         u64 metadata_len;
741         u64 metadata_offset;
742         struct hlist_head inode_list;
743
744         metadata_lte = imd->metadata_lte;
745         metadata_len = wim_resource_size(metadata_lte);
746         metadata_offset = metadata_lte->resource_entry.offset;
747
748         DEBUG("Reading metadata resource: length = %"PRIu64", "
749               "offset = %"PRIu64"", metadata_len, metadata_offset);
750
751         /* There is no way the metadata resource could possibly be less than (8
752          * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
753          * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
754          * dentry. */
755         if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
756                 ERROR("Expected at least %u bytes for the metadata resource",
757                       8 + WIM_DENTRY_DISK_SIZE);
758                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
759         }
760
761         if (sizeof(size_t) < 8 && metadata_len > 0xffffffff) {
762                 ERROR("Metadata resource is too large (%"PRIu64" bytes",
763                       metadata_len);
764                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
765         }
766
767         /* Allocate memory for the uncompressed metadata resource. */
768         buf = MALLOC(metadata_len);
769
770         if (!buf) {
771                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
772                       "metadata resource", metadata_len);
773                 return WIMLIB_ERR_NOMEM;
774         }
775
776         /* Read the metadata resource into memory.  (It may be compressed.) */
777         ret = read_full_wim_resource(metadata_lte, buf, 0);
778         if (ret != 0)
779                 goto out_free_buf;
780
781         DEBUG("Finished reading metadata resource into memory.");
782
783         /* The root directory entry starts after security data, aligned on an
784          * 8-byte boundary within the metadata resource.
785          *
786          * The security data starts with a 4-byte integer giving its total
787          * length, so if we round that up to an 8-byte boundary that gives us
788          * the offset of the root dentry.
789          *
790          * Here we read the security data into a wim_security_data structure,
791          * and if successful, go ahead and calculate the offset in the metadata
792          * resource of the root dentry. */
793
794         wimlib_assert(imd->security_data == NULL);
795         ret = read_security_data(buf, metadata_len, &imd->security_data);
796         if (ret != 0)
797                 goto out_free_buf;
798
799         dentry_offset = (imd->security_data->total_length + 7) & ~7;
800
801         if (dentry_offset == 0) {
802                 ERROR("Integer overflow while reading metadata resource");
803                 ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
804                 goto out_free_security_data;
805         }
806
807         /* Allocate memory for the root dentry and read it into memory */
808         dentry = MALLOC(sizeof(struct dentry));
809         if (!dentry) {
810                 ERROR("Failed to allocate %zu bytes for root dentry",
811                       sizeof(struct dentry));
812                 ret = WIMLIB_ERR_NOMEM;
813                 goto out_free_security_data;
814         }
815
816         ret = read_dentry(buf, metadata_len, dentry_offset, dentry);
817
818         /* This is the root dentry, so set its parent to itself. */
819         dentry->parent = dentry;
820
821         if (ret != 0)
822                 goto out_free_dentry_tree;
823         inode_add_dentry(dentry, dentry->d_inode);
824
825         /* Now read the entire directory entry tree into memory. */
826         DEBUG("Reading dentry tree");
827         ret = read_dentry_tree(buf, metadata_len, dentry);
828         if (ret != 0)
829                 goto out_free_dentry_tree;
830
831         /* Calculate the full paths in the dentry tree. */
832         DEBUG("Calculating dentry full paths");
833         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
834         if (ret != 0)
835                 goto out_free_dentry_tree;
836
837         /* Build hash table that maps hard link group IDs to dentry sets */
838         DEBUG("Building link group table");
839         ret = init_inode_table(&inode_tab, 9001);
840         if (ret != 0)
841                 goto out_free_dentry_tree;
842
843         for_dentry_in_tree(dentry, inode_table_insert, &inode_tab);
844
845         DEBUG("Fixing inconsistencies in the hard link groups");
846         ret = fix_inodes(&inode_tab, &inode_list);
847         destroy_inode_table(&inode_tab);
848         if (ret != 0)
849                 goto out_free_dentry_tree;
850
851         DEBUG("Running miscellaneous verifications on the dentry tree");
852         for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
853         ret = for_dentry_in_tree(dentry, verify_dentry, w);
854         if (ret != 0)
855                 goto out_free_dentry_tree;
856
857         DEBUG("Done reading image metadata");
858
859         imd->root_dentry = dentry;
860         imd->inode_list  = inode_list;
861         goto out_free_buf;
862 out_free_dentry_tree:
863         free_dentry_tree(dentry, NULL);
864 out_free_security_data:
865         free_security_data(imd->security_data);
866         imd->security_data = NULL;
867 out_free_buf:
868         FREE(buf);
869         return ret;
870 }
871
872 /* Write the metadata resource for the current WIM image. */
873 int write_metadata_resource(WIMStruct *w)
874 {
875         u8 *buf;
876         u8 *p;
877         int ret;
878         u64 subdir_offset;
879         struct dentry *root;
880         struct lookup_table_entry *lte;
881         u64 metadata_original_size;
882         const struct wim_security_data *sd;
883
884         DEBUG("Writing metadata resource for image %d", w->current_image);
885
886         root = wim_root_dentry(w);
887         sd = wim_security_data(w);
888
889         /* We do not allow the security data pointer to be NULL, although it may
890          * point to an empty security data with no entries. */
891         wimlib_assert(root != NULL);
892         wimlib_assert(sd != NULL);
893
894         /* Offset of first child of the root dentry.  It's equal to:
895          * - The total length of the security data, rounded to the next 8-byte
896          *   boundary,
897          * - plus the total length of the root dentry,
898          * - plus 8 bytes for an end-of-directory entry following the root
899          *   dentry (shouldn't really be needed, but just in case...)
900          */
901         subdir_offset = ((sd->total_length + 7) & ~7) +
902                         dentry_correct_total_length(root) + 8;
903
904         /* Calculate the subdirectory offsets for the entire dentry tree. */
905         calculate_subdir_offsets(root, &subdir_offset);
906
907         /* Total length of the metadata resource (uncompressed) */
908         metadata_original_size = subdir_offset;
909
910         /* Allocate a buffer to contain the uncompressed metadata resource */
911         buf = MALLOC(metadata_original_size);
912         if (!buf) {
913                 ERROR("Failed to allocate %"PRIu64" bytes for "
914                       "metadata resource", metadata_original_size);
915                 return WIMLIB_ERR_NOMEM;
916         }
917
918         /* Write the security data into the resource buffer */
919         p = write_security_data(sd, buf);
920
921         /* Write the dentry tree into the resource buffer */
922         p = write_dentry_tree(root, p);
923
924         /* We MUST have exactly filled the buffer; otherwise we calculated its
925          * size incorrectly or wrote the data incorrectly. */
926         wimlib_assert(p - buf == metadata_original_size);
927
928         /* Get the lookup table entry for the metadata resource so we can update
929          * it. */
930         lte = wim_metadata_lookup_table_entry(w);
931
932         wimlib_assert(lte != NULL);
933
934         /* Write the metadata resource to the output WIM using the proper
935          * compression type.  The lookup table entry for the metadata resource
936          * is updated. */
937         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
938                                              w->out_fp,
939                                              wimlib_get_compression_type(w),
940                                              &lte->output_resource_entry,
941                                              lte->hash);
942         if (ret != 0)
943                 goto out;
944
945         /* It's very likely the SHA1 message digest of the metadata resource
946          * changed, so re-insert the lookup table entry into the lookup table.
947          *
948          * We do not check for other lookup table entries having the same SHA1
949          * message digest.  It's possible for 2 absolutely identical images to
950          * be added, therefore causing 2 identical metadata resources to be in
951          * the WIM.  However, in this case, it's expected for 2 separate lookup
952          * table entries to be created, even though this doesn't make a whole
953          * lot of sense since they will share the same SHA1 message digest.
954          * */
955         lookup_table_unlink(w->lookup_table, lte);
956         lookup_table_insert(w->lookup_table, lte);
957
958         wimlib_assert(lte->out_refcnt == 0);
959         lte->out_refcnt = 1;
960
961         /* Make sure that the resource entry is written marked with the metadata
962          * flag. */
963         lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA;
964 out:
965         /* All the data has been written to the new WIM; no need for the buffer
966          * anymore */
967         FREE(buf);
968         return ret;
969 }