header.c, lookup_table.c: Read/write data from structures
[wimlib] / src / resource.c
1 /*
2  * resource.c
3  *
4  * Read uncompressed and compressed metadata and file resources from a WIM file.
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 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 #ifdef HAVE_CONFIG_H
26 #  include "config.h"
27 #endif
28
29 #include "wimlib.h"
30 #include "wimlib/dentry.h"
31 #include "wimlib/endianness.h"
32 #include "wimlib/error.h"
33 #include "wimlib/file_io.h"
34 #include "wimlib/lookup_table.h"
35 #include "wimlib/resource.h"
36 #include "wimlib/sha1.h"
37
38 #ifdef __WIN32__
39 /* for read_win32_file_prefix(), read_win32_encrypted_file_prefix() */
40 #  include "wimlib/win32.h"
41 #endif
42
43 #ifdef WITH_NTFS_3G
44 /* for read_ntfs_file_prefix() */
45 #  include "wimlib/ntfs_3g.h"
46 #endif
47
48 #ifdef HAVE_ALLOCA_H
49 #  include <alloca.h>
50 #endif
51 #include <errno.h>
52 #include <fcntl.h>
53 #include <stdarg.h>
54 #include <stdlib.h>
55 #include <unistd.h>
56
57 /*
58  * Reads all or part of a compressed WIM resource.
59  *
60  * Returns zero on success, nonzero on failure.
61  */
62 static int
63 read_compressed_resource(int in_fd,
64                          u64 resource_compressed_size,
65                          u64 resource_uncompressed_size,
66                          u64 resource_offset,
67                          int resource_ctype,
68                          u64 len,
69                          u64 offset,
70                          consume_data_callback_t cb,
71                          void *ctx_or_buf)
72 {
73         int ret;
74
75         /* Trivial case */
76         if (len == 0)
77                 return 0;
78
79         int (*decompress)(const void *, unsigned, void *, unsigned);
80         /* Set the appropriate decompress function. */
81         if (resource_ctype == WIMLIB_COMPRESSION_TYPE_LZX)
82                 decompress = wimlib_lzx_decompress;
83         else
84                 decompress = wimlib_xpress_decompress;
85
86         /* The structure of a compressed resource consists of a table of chunk
87          * offsets followed by the chunks themselves.  Each chunk consists of
88          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
89          * 32768 bytes of the uncompressed file, with the last chunk having any
90          * remaining bytes.
91          *
92          * The chunk offsets are measured relative to the end of the chunk
93          * table.  The first chunk is omitted from the table in the WIM file
94          * because its offset is implicitly given by the fact that it directly
95          * follows the chunk table and therefore must have an offset of 0.
96          */
97
98         /* Calculate how many chunks the resource consists of in its entirety.
99          * */
100         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
101                                                                 WIM_CHUNK_SIZE;
102         /* As mentioned, the first chunk has no entry in the chunk table. */
103         u64 num_chunk_entries = num_chunks - 1;
104
105
106         /* The index of the chunk that the read starts at. */
107         u64 start_chunk = offset / WIM_CHUNK_SIZE;
108         /* The byte offset at which the read starts, within the start chunk. */
109         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
110
111         /* The index of the chunk that contains the last byte of the read. */
112         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
113         /* The byte offset of the last byte of the read, within the end chunk */
114         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
115
116         /* Number of chunks that are actually needed to read the requested part
117          * of the file. */
118         u64 num_needed_chunks = end_chunk - start_chunk + 1;
119
120         /* If the end chunk is not the last chunk, an extra chunk entry is
121          * needed because we need to know the offset of the chunk after the last
122          * chunk read to figure out the size of the last read chunk. */
123         if (end_chunk != num_chunks - 1)
124                 num_needed_chunks++;
125
126         /* Allocate the chunk table.  It will only contain offsets for the
127          * chunks that are actually needed for this read. */
128         u64 *chunk_offsets;
129         bool chunk_offsets_malloced;
130         if (num_needed_chunks < 1000) {
131                 chunk_offsets = alloca(num_needed_chunks * sizeof(u64));
132                 chunk_offsets_malloced = false;
133         } else {
134                 chunk_offsets = malloc(num_needed_chunks * sizeof(u64));
135                 if (!chunk_offsets) {
136                         ERROR("Failed to allocate chunk table "
137                               "with %"PRIu64" entries", num_needed_chunks);
138                         return WIMLIB_ERR_NOMEM;
139                 }
140                 chunk_offsets_malloced = true;
141         }
142
143         /* Set the implicit offset of the first chunk if it is included in the
144          * needed chunks.
145          *
146          * Note: M$'s documentation includes a picture that shows the first
147          * chunk starting right after the chunk entry table, labeled as offset
148          * 0x10.  However, in the actual file format, the offset is measured
149          * from the end of the chunk entry table, so the first chunk has an
150          * offset of 0. */
151         if (start_chunk == 0)
152                 chunk_offsets[0] = 0;
153
154         /* According to M$'s documentation, if the uncompressed size of
155          * the file is greater than 4 GB, the chunk entries are 8-byte
156          * integers.  Otherwise, they are 4-byte integers. */
157         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ?
158                                                                         8 : 4;
159
160         /* Size of the full chunk table in the WIM file. */
161         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
162
163         /* Read the needed chunk offsets from the table in the WIM file. */
164
165         /* Index, in the WIM file, of the first needed entry in the
166          * chunk table. */
167         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
168
169         /* Number of entries we need to actually read from the chunk
170          * table (excludes the implicit first chunk). */
171         u64 num_needed_chunk_entries = (start_chunk == 0) ?
172                                 num_needed_chunks - 1 : num_needed_chunks;
173
174         /* Skip over unneeded chunk table entries. */
175         u64 file_offset_of_needed_chunk_entries = resource_offset +
176                                 start_table_idx * chunk_entry_size;
177
178         /* Number of bytes we need to read from the chunk table. */
179         size_t size = num_needed_chunk_entries * chunk_entry_size;
180
181         /* Read the raw data into the end of the chunk_offsets array to
182          * avoid allocating another array. */
183         void *chunk_tab_buf = (void*)&chunk_offsets[num_needed_chunks] - size;
184
185         if (full_pread(in_fd, chunk_tab_buf, size,
186                        file_offset_of_needed_chunk_entries) != size)
187                 goto read_error;
188
189         /* Now fill in chunk_offsets from the entries we have read in
190          * chunk_tab_buf. */
191
192         u64 *chunk_tab_p = chunk_offsets;
193         if (start_chunk == 0)
194                 chunk_tab_p++;
195
196         if (chunk_entry_size == 4) {
197                 u32 *entries = (u32*)chunk_tab_buf;
198                 while (num_needed_chunk_entries--)
199                         *chunk_tab_p++ = le32_to_cpu(*entries++);
200         } else {
201                 u64 *entries = (u64*)chunk_tab_buf;
202                 while (num_needed_chunk_entries--)
203                         *chunk_tab_p++ = le64_to_cpu(*entries++);
204         }
205
206         /* Done with the chunk table now.  We must now seek to the first chunk
207          * that is needed for the read. */
208
209         u64 cur_read_offset = resource_offset + chunk_table_size + chunk_offsets[0];
210
211         /* Pointer to current position in the output buffer for uncompressed
212          * data.  Alternatively, if using a callback function, we repeatedly
213          * fill a temporary buffer to feed data into the callback function.  */
214         u8 *out_p;
215         if (cb)
216                 out_p = alloca(WIM_CHUNK_SIZE);
217         else
218                 out_p = ctx_or_buf;
219
220         /* Buffer for compressed data.  While most compressed chunks will have a
221          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
222          * size in the worst-case.  This assumption is valid only if chunks that
223          * happen to compress to more than the uncompressed size (i.e. a
224          * sequence of random bytes) are always stored uncompressed. But this seems
225          * to be the case in M$'s WIM files, even though it is undocumented. */
226         void *compressed_buf = alloca(WIM_CHUNK_SIZE - 1);
227
228         /* Decompress all the chunks. */
229         for (u64 i = start_chunk; i <= end_chunk; i++) {
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                 /* Figure out how much of this chunk we actually need to read */
266                 u64 start_offset;
267                 if (i == start_chunk)
268                         start_offset = start_chunk_offset;
269                 else
270                         start_offset = 0;
271                 u64 end_offset;
272                 if (i == end_chunk)
273                         end_offset = end_chunk_offset;
274                 else
275                         end_offset = WIM_CHUNK_SIZE - 1;
276
277                 unsigned partial_chunk_size = end_offset + 1 - start_offset;
278                 bool is_partial_chunk = (partial_chunk_size != uncompressed_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                         /* Uncompressed chunk */
285                         if (full_pread(in_fd,
286                                        cb ? out_p + start_offset : out_p,
287                                        partial_chunk_size,
288                                        cur_read_offset + start_offset) != partial_chunk_size)
289                         {
290                                 goto read_error;
291                         }
292                 } else {
293                         /* Compressed chunk */
294
295                         /* Read the compressed data into compressed_buf. */
296                         if (full_pread(in_fd,
297                                        compressed_buf,
298                                        compressed_chunk_size,
299                                        cur_read_offset) != compressed_chunk_size)
300                         {
301                                 goto read_error;
302                         }
303
304                         /* For partial chunks and when writing directly to a
305                          * buffer, we must buffer the uncompressed data because
306                          * we don't need all of it. */
307                         if (is_partial_chunk && !cb) {
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) {
315                                         ret = WIMLIB_ERR_DECOMPRESSION;
316                                         goto out;
317                                 }
318                                 memcpy(out_p, uncompressed_buf + start_offset,
319                                        partial_chunk_size);
320                         } else {
321                                 ret = decompress(compressed_buf,
322                                                  compressed_chunk_size,
323                                                  out_p,
324                                                  uncompressed_chunk_size);
325                                 if (ret) {
326                                         ret = WIMLIB_ERR_DECOMPRESSION;
327                                         goto out;
328                                 }
329                         }
330                 }
331                 if (cb) {
332                         /* Feed the data to the callback function */
333                         ret = cb(out_p + start_offset,
334                                  partial_chunk_size, ctx_or_buf);
335                         if (ret)
336                                 goto out;
337                 } else {
338                         /* No callback function provided; we are writing
339                          * directly to a buffer.  Advance the pointer into this
340                          * buffer by the number of uncompressed bytes that were
341                          * written.  */
342                         out_p += partial_chunk_size;
343                 }
344                 cur_read_offset += compressed_chunk_size;
345         }
346
347         ret = 0;
348 out:
349         if (chunk_offsets_malloced)
350                 FREE(chunk_offsets);
351         return ret;
352
353 read_error:
354         ERROR_WITH_ERRNO("Error reading compressed file resource");
355         ret = WIMLIB_ERR_READ;
356         goto out;
357 }
358
359 /* Translates a WIM resource entry from the on-disk format to an in-memory
360  * format. */
361 void
362 get_resource_entry(const struct resource_entry_disk *disk_entry,
363                    struct resource_entry *entry)
364 {
365         /* Note: disk_entry may not be 8 byte aligned--- in that case, the
366          * offset and original_size members will be unaligned.  (This should be
367          * okay since `struct resource_entry_disk' is declared as packed.) */
368
369         /* Read the size and flags into a bitfield portably... */
370         entry->size = (((u64)disk_entry->size[0] <<  0) |
371                        ((u64)disk_entry->size[1] <<  8) |
372                        ((u64)disk_entry->size[2] << 16) |
373                        ((u64)disk_entry->size[3] << 24) |
374                        ((u64)disk_entry->size[4] << 32) |
375                        ((u64)disk_entry->size[5] << 40) |
376                        ((u64)disk_entry->size[6] << 48));
377         entry->flags = disk_entry->flags;
378         entry->offset = le64_to_cpu(disk_entry->offset);
379         entry->original_size = le64_to_cpu(disk_entry->original_size);
380
381         /* offset and original_size are truncated to 62 bits to avoid possible
382          * overflows, when converting to a signed 64-bit integer (off_t) or when
383          * adding size or original_size.  This is okay since no one would ever
384          * actually have a WIM bigger than 4611686018427387903 bytes... */
385         if (entry->offset & 0xc000000000000000ULL) {
386                 WARNING("Truncating offset in resource entry");
387                 entry->offset &= 0x3fffffffffffffffULL;
388         }
389         if (entry->original_size & 0xc000000000000000ULL) {
390                 WARNING("Truncating original_size in resource entry");
391                 entry->original_size &= 0x3fffffffffffffffULL;
392         }
393 }
394
395 /* Translates a WIM resource entry from an in-memory format into the on-disk
396  * format. */
397 void
398 put_resource_entry(const struct resource_entry *entry,
399                    struct resource_entry_disk *disk_entry)
400 {
401         /* Note: disk_entry may not be 8 byte aligned--- in that case, the
402          * offset and original_size members will be unaligned.  (This should be
403          * okay since `struct resource_entry_disk' is declared as packed.) */
404         u64 size = entry->size;
405
406         disk_entry->size[0] = size >>  0;
407         disk_entry->size[1] = size >>  8;
408         disk_entry->size[2] = size >> 16;
409         disk_entry->size[3] = size >> 24;
410         disk_entry->size[4] = size >> 32;
411         disk_entry->size[5] = size >> 40;
412         disk_entry->size[6] = size >> 48;
413         disk_entry->flags = entry->flags;
414         disk_entry->offset = cpu_to_le64(entry->offset);
415         disk_entry->original_size = cpu_to_le64(entry->original_size);
416 }
417
418 static int
419 read_partial_wim_resource(const struct wim_lookup_table_entry *lte,
420                           u64 size,
421                           consume_data_callback_t cb,
422                           void *ctx_or_buf,
423                           int flags,
424                           u64 offset)
425 {
426         WIMStruct *wim;
427         int in_fd;
428         int ret;
429
430         wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
431
432         wim = lte->wim;
433         in_fd = wim->in_fd;
434
435         if (lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED &&
436             !(flags & WIMLIB_RESOURCE_FLAG_RAW))
437         {
438                 ret = read_compressed_resource(in_fd,
439                                                lte->resource_entry.size,
440                                                lte->resource_entry.original_size,
441                                                lte->resource_entry.offset,
442                                                wimlib_get_compression_type(wim),
443                                                size,
444                                                offset,
445                                                cb,
446                                                ctx_or_buf);
447         } else {
448                 offset += lte->resource_entry.offset;
449                 if (cb) {
450                         /* Send data to callback function */
451                         u8 buf[min(WIM_CHUNK_SIZE, size)];
452                         while (size) {
453                                 size_t bytes_to_read = min(WIM_CHUNK_SIZE, size);
454                                 size_t bytes_read = full_pread(in_fd, buf,
455                                                                bytes_to_read, offset);
456                                 if (bytes_read != bytes_to_read)
457                                         goto read_error;
458                                 ret = cb(buf, bytes_read, ctx_or_buf);
459                                 if (ret)
460                                         goto out;
461                                 size -= bytes_read;
462                                 offset += bytes_read;
463                         }
464                 } else {
465                         /* Send data directly to a buffer */
466                         if (full_pread(in_fd, ctx_or_buf, size, offset) != size)
467                                 goto read_error;
468                 }
469                 ret = 0;
470         }
471         goto out;
472 read_error:
473         ERROR_WITH_ERRNO("Error reading data from WIM");
474         ret = WIMLIB_ERR_READ;
475 out:
476         if (ret) {
477                 if (errno == 0)
478                         errno = EIO;
479         }
480         return ret;
481 }
482
483
484 int
485 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
486                                    size_t size, u64 offset, void *buf)
487 {
488         return read_partial_wim_resource(lte, size, NULL, buf, 0, offset);
489 }
490
491 static int
492 read_wim_resource_prefix(const struct wim_lookup_table_entry *lte,
493                          u64 size,
494                          consume_data_callback_t cb,
495                          void *ctx_or_buf,
496                          int flags)
497 {
498         return read_partial_wim_resource(lte, size, cb, ctx_or_buf, flags, 0);
499 }
500
501
502 #ifndef __WIN32__
503 static int
504 read_file_on_disk_prefix(const struct wim_lookup_table_entry *lte,
505                          u64 size,
506                          consume_data_callback_t cb,
507                          void *ctx_or_buf,
508                          int _ignored_flags)
509 {
510         const tchar *filename = lte->file_on_disk;
511         int ret;
512         int fd;
513         size_t bytes_read;
514
515         fd = open(filename, O_RDONLY);
516         if (fd < 0) {
517                 ERROR_WITH_ERRNO("Can't open \"%"TS"\"", filename);
518                 return WIMLIB_ERR_OPEN;
519         }
520         if (cb) {
521                 /* Send data to callback function */
522                 u8 buf[min(WIM_CHUNK_SIZE, size)];
523                 size_t bytes_to_read;
524                 while (size) {
525                         bytes_to_read = min(WIM_CHUNK_SIZE, size);
526                         bytes_read = full_read(fd, buf, bytes_to_read);
527                         if (bytes_read != bytes_to_read)
528                                 goto read_error;
529                         ret = cb(buf, bytes_read, ctx_or_buf);
530                         if (ret)
531                                 goto out_close;
532                         size -= bytes_read;
533                 }
534         } else {
535                 /* Send data directly to a buffer */
536                 bytes_read = full_read(fd, ctx_or_buf, size);
537                 if (bytes_read != size)
538                         goto read_error;
539         }
540         ret = 0;
541         goto out_close;
542 read_error:
543         ERROR_WITH_ERRNO("Error reading \"%"TS"\"", filename);
544         ret = WIMLIB_ERR_READ;
545 out_close:
546         close(fd);
547         return ret;
548 }
549 #endif /* !__WIN32__ */
550
551 static int
552 read_buffer_prefix(const struct wim_lookup_table_entry *lte,
553                    u64 size, consume_data_callback_t cb,
554                    void *ctx_or_buf, int _ignored_flags)
555 {
556         const void *inbuf = lte->attached_buffer;
557         int ret;
558
559         if (cb) {
560                 while (size) {
561                         size_t chunk_size = min(WIM_CHUNK_SIZE, size);
562                         ret = cb(inbuf, chunk_size, ctx_or_buf);
563                         if (ret)
564                                 return ret;
565                         size -= chunk_size;
566                         inbuf += chunk_size;
567                 }
568         } else {
569                 memcpy(ctx_or_buf, inbuf, size);
570         }
571         return 0;
572 }
573
574 typedef int (*read_resource_prefix_handler_t)(const struct wim_lookup_table_entry *lte,
575                                               u64 size,
576                                               consume_data_callback_t cb,
577                                               void *ctx_or_buf,
578                                               int flags);
579
580 /*
581  * Read the first @size bytes from a generic "resource", which may be located in
582  * the WIM (compressed or uncompressed), in an external file, or directly in an
583  * in-memory buffer.
584  *
585  * Feed the data either to a callback function (cb != NULL, passing it
586  * ctx_or_buf), or write it directly into a buffer (cb == NULL, ctx_or_buf
587  * specifies the buffer, which must have room for @size bytes).
588  *
589  * When using a callback function, it is called with chunks up to 32768 bytes in
590  * size until the resource is exhausted.
591  *
592  * If the resource is located in a WIM file, @flags can be:
593  *   * WIMLIB_RESOURCE_FLAG_RAW if the raw compressed data is to be supplied
594  *     instead of the uncompressed data.
595  * Otherwise, the @flags are ignored.
596  */
597 int
598 read_resource_prefix(const struct wim_lookup_table_entry *lte,
599                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
600                      int flags)
601 {
602         static const read_resource_prefix_handler_t handlers[] = {
603                 [RESOURCE_IN_WIM]             = read_wim_resource_prefix,
604         #ifndef __WIN32__
605                 [RESOURCE_IN_FILE_ON_DISK]    = read_file_on_disk_prefix,
606         #endif
607                 [RESOURCE_IN_ATTACHED_BUFFER] = read_buffer_prefix,
608         #ifdef WITH_FUSE
609                 [RESOURCE_IN_STAGING_FILE]    = read_file_on_disk_prefix,
610         #endif
611         #ifdef WITH_NTFS_3G
612                 [RESOURCE_IN_NTFS_VOLUME]     = read_ntfs_file_prefix,
613         #endif
614         #ifdef __WIN32__
615                 [RESOURCE_WIN32]              = read_win32_file_prefix,
616                 [RESOURCE_WIN32_ENCRYPTED]    = read_win32_encrypted_file_prefix,
617         #endif
618         };
619         wimlib_assert(lte->resource_location < ARRAY_LEN(handlers)
620                       && handlers[lte->resource_location] != NULL);
621         return handlers[lte->resource_location](lte, size, cb, ctx_or_buf, flags);
622 }
623
624 int
625 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte,
626                             void *buf)
627 {
628         return read_resource_prefix(lte, wim_resource_size(lte), NULL, buf, 0);
629 }
630
631 struct extract_ctx {
632         SHA_CTX sha_ctx;
633         consume_data_callback_t extract_chunk;
634         void *extract_chunk_arg;
635 };
636
637 static int
638 extract_chunk_sha1_wrapper(const void *chunk, size_t chunk_size,
639                            void *_ctx)
640 {
641         struct extract_ctx *ctx = _ctx;
642
643         sha1_update(&ctx->sha_ctx, chunk, chunk_size);
644         return ctx->extract_chunk(chunk, chunk_size, ctx->extract_chunk_arg);
645 }
646
647 /* Extracts the first @size bytes of a WIM resource to somewhere.  In the
648  * process, the SHA1 message digest of the resource is checked if the full
649  * resource is being extracted.
650  *
651  * @extract_chunk is a function that is called to extract each chunk of the
652  * resource. */
653 int
654 extract_wim_resource(const struct wim_lookup_table_entry *lte,
655                      u64 size,
656                      consume_data_callback_t extract_chunk,
657                      void *extract_chunk_arg)
658 {
659         int ret;
660         if (size == wim_resource_size(lte)) {
661                 /* Do SHA1 */
662                 struct extract_ctx ctx;
663                 ctx.extract_chunk = extract_chunk;
664                 ctx.extract_chunk_arg = extract_chunk_arg;
665                 sha1_init(&ctx.sha_ctx);
666                 ret = read_resource_prefix(lte, size,
667                                            extract_chunk_sha1_wrapper,
668                                            &ctx, 0);
669                 if (ret == 0) {
670                         u8 hash[SHA1_HASH_SIZE];
671                         sha1_final(hash, &ctx.sha_ctx);
672                         if (!hashes_equal(hash, lte->hash)) {
673                         #ifdef ENABLE_ERROR_MESSAGES
674                                 ERROR("Invalid SHA1 message digest "
675                                       "on the following WIM resource:");
676                                 print_lookup_table_entry(lte, stderr);
677                                 if (lte->resource_location == RESOURCE_IN_WIM)
678                                         ERROR("The WIM file appears to be corrupt!");
679                         #endif
680                                 ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
681                         }
682                 }
683         } else {
684                 /* Don't do SHA1 */
685                 ret = read_resource_prefix(lte, size, extract_chunk,
686                                            extract_chunk_arg, 0);
687         }
688         return ret;
689 }
690
691 static int
692 extract_wim_chunk_to_fd(const void *buf, size_t len, void *_fd_p)
693 {
694         int fd = *(int*)_fd_p;
695         ssize_t ret = full_write(fd, buf, len);
696         if (ret < len) {
697                 ERROR_WITH_ERRNO("Error writing to file descriptor");
698                 return WIMLIB_ERR_WRITE;
699         } else {
700                 return 0;
701         }
702 }
703
704 int
705 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
706                            int fd, u64 size)
707 {
708         return extract_wim_resource(lte, size, extract_wim_chunk_to_fd, &fd);
709 }
710
711
712 static int
713 sha1_chunk(const void *buf, size_t len, void *ctx)
714 {
715         sha1_update(ctx, buf, len);
716         return 0;
717 }
718
719 /* Calculate the SHA1 message digest of a stream. */
720 int
721 sha1_resource(struct wim_lookup_table_entry *lte)
722 {
723         int ret;
724         SHA_CTX sha_ctx;
725
726         sha1_init(&sha_ctx);
727         ret = read_resource_prefix(lte, wim_resource_size(lte),
728                                    sha1_chunk, &sha_ctx, 0);
729         if (ret == 0)
730                 sha1_final(lte->hash, &sha_ctx);
731         return ret;
732 }
733
734 /*
735  * Copies the file resource specified by the lookup table entry @lte from the
736  * input WIM to the output WIM that has its FILE * given by
737  * ((WIMStruct*)wim)->out_fp.
738  *
739  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
740  * updated.
741  *
742  * (This function is confusing and should be refactored somehow.)
743  */
744 int
745 copy_resource(struct wim_lookup_table_entry *lte, void *wim)
746 {
747         WIMStruct *w = wim;
748         int ret;
749
750         ret = write_wim_resource(lte, w->out_fd,
751                                  wim_resource_compression_type(lte),
752                                  &lte->output_resource_entry, 0);
753         if (ret == 0) {
754                 lte->out_refcnt = lte->refcnt;
755                 lte->part_number = w->hdr.part_number;
756         }
757         return ret;
758 }