Update dentry, security data reading
[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 #ifdef WITH_NTFS_3G
31 #include <ntfs-3g/attrib.h>
32 #include <ntfs-3g/inode.h>
33 #include <ntfs-3g/dir.h>
34 #endif
35
36 #include "wimlib_internal.h"
37 #include "lookup_table.h"
38 #include "io.h"
39 #include "lzx.h"
40 #include "xpress.h"
41 #include "sha1.h"
42 #include "dentry.h"
43 #include <unistd.h>
44 #include <errno.h>
45 #ifdef HAVE_ALLOCA_H
46 #include <alloca.h>
47 #endif
48
49
50 /*
51  * Reads all or part of a compressed resource into an in-memory buffer.
52  *
53  * @fp:                 The FILE* for the WIM file.
54  * @resource_compressed_size:    The compressed size of the resource.
55  * @resource_uncompressed_size:  The uncompressed size of the resource.
56  * @resource_offset:             The offset of the start of the resource from
57  *                                      the start of the stream @fp.
58  * @resource_ctype:     The compression type of the resource.
59  * @len:                The number of bytes of uncompressed data to read from
60  *                              the resource.
61  * @offset:             The offset of the bytes to read within the uncompressed
62  *                              resource.
63  * @contents_len:       An array into which the uncompressed data is written.
64  *                              It must be at least @len bytes long.
65  *
66  * Returns zero on success, nonzero on failure.
67  */
68 static int read_compressed_resource(FILE *fp, u64 resource_compressed_size,
69                                     u64 resource_uncompressed_size,
70                                     u64 resource_offset, int resource_ctype,
71                                     u64 len, u64 offset, u8  contents_ret[])
72 {
73
74         DEBUG2("comp size = %"PRIu64", uncomp size = %"PRIu64", "
75                "res offset = %"PRIu64"",
76                resource_compressed_size,
77                resource_uncompressed_size,
78                resource_offset);
79         DEBUG2("resource_ctype = %s, len = %"PRIu64", offset = %"PRIu64"",
80                wimlib_get_compression_type_string(resource_ctype), len, offset);
81         /* Trivial case */
82         if (len == 0)
83                 return 0;
84
85         int (*decompress)(const void *, uint, void *, uint);
86         /* Set the appropriate decompress function. */
87         if (resource_ctype == WIM_COMPRESSION_TYPE_LZX)
88                 decompress = lzx_decompress;
89         else
90                 decompress = xpress_decompress;
91
92         /* The structure of a compressed resource consists of a table of chunk
93          * offsets followed by the chunks themselves.  Each chunk consists of
94          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
95          * 32768 bytes of the uncompressed file, with the last chunk having any
96          * remaining bytes.
97          *
98          * The chunk offsets are measured relative to the end of the chunk
99          * table.  The first chunk is omitted from the table in the WIM file
100          * because its offset is implicitly given by the fact that it directly
101          * follows the chunk table and therefore must have an offset of 0.
102          */
103
104         /* Calculate how many chunks the resource conists of in its entirety. */
105         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
106                                                                 WIM_CHUNK_SIZE;
107         /* As mentioned, the first chunk has no entry in the chunk table. */
108         u64 num_chunk_entries = num_chunks - 1;
109
110
111         /* The index of the chunk that the read starts at. */
112         u64 start_chunk = offset / WIM_CHUNK_SIZE;
113         /* The byte offset at which the read starts, within the start chunk. */
114         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
115
116         /* The index of the chunk that contains the last byte of the read. */
117         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
118         /* The byte offset of the last byte of the read, within the end chunk */
119         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
120
121         /* Number of chunks that are actually needed to read the requested part
122          * of the file. */
123         u64 num_needed_chunks = end_chunk - start_chunk + 1;
124
125         /* If the end chunk is not the last chunk, an extra chunk entry is
126          * needed because we need to know the offset of the chunk after the last
127          * chunk read to figure out the size of the last read chunk. */
128         if (end_chunk != num_chunks - 1)
129                 num_needed_chunks++;
130
131         /* Declare the chunk table.  It will only contain offsets for the chunks
132          * that are actually needed for this read. */
133         u64 chunk_offsets[num_needed_chunks];
134
135         /* Set the implicit offset of the first chunk if it is included in the
136          * needed chunks.
137          *
138          * Note: M$'s documentation includes a picture that shows the first
139          * chunk starting right after the chunk entry table, labeled as offset
140          * 0x10.  However, in the actual file format, the offset is measured
141          * from the end of the chunk entry table, so the first chunk has an
142          * offset of 0. */
143         if (start_chunk == 0)
144                 chunk_offsets[0] = 0;
145
146         /* According to M$'s documentation, if the uncompressed size of
147          * the file is greater than 4 GB, the chunk entries are 8-byte
148          * integers.  Otherwise, they are 4-byte integers. */
149         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ?
150                                                                         8 : 4;
151
152         /* Size of the full chunk table in the WIM file. */
153         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
154
155         /* Read the needed chunk offsets from the table in the WIM file. */
156
157         /* Index, in the WIM file, of the first needed entry in the
158          * chunk table. */
159         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
160
161         /* Number of entries we need to actually read from the chunk
162          * table (excludes the implicit first chunk). */
163         u64 num_needed_chunk_entries = (start_chunk == 0) ?
164                                 num_needed_chunks - 1 : num_needed_chunks;
165
166         /* Skip over unneeded chunk table entries. */
167         u64 file_offset_of_needed_chunk_entries = resource_offset +
168                                 start_table_idx * chunk_entry_size;
169         if (fseeko(fp, file_offset_of_needed_chunk_entries, SEEK_SET) != 0) {
170                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
171                                  "chunk table of compressed resource",
172                                  file_offset_of_needed_chunk_entries);
173                 return WIMLIB_ERR_READ;
174         }
175
176         /* Number of bytes we need to read from the chunk table. */
177         size_t size = num_needed_chunk_entries * chunk_entry_size;
178
179         u8 chunk_tab_buf[size];
180
181         if (fread(chunk_tab_buf, 1, size, fp) != size)
182                 goto err;
183
184         /* Now fill in chunk_offsets from the entries we have read in
185          * chunk_tab_buf. */
186
187         u64 *chunk_tab_p = chunk_offsets;
188         if (start_chunk == 0)
189                 chunk_tab_p++;
190
191         if (chunk_entry_size == 4) {
192                 u32 *entries = (u32*)chunk_tab_buf;
193                 while (num_needed_chunk_entries--)
194                         *chunk_tab_p++ = le32_to_cpu(*entries++);
195         } else {
196                 u64 *entries = (u64*)chunk_tab_buf;
197                 while (num_needed_chunk_entries--)
198                         *chunk_tab_p++ = le64_to_cpu(*entries++);
199         }
200
201         /* Done with the chunk table now.  We must now seek to the first chunk
202          * that is needed for the read. */
203
204         u64 file_offset_of_first_needed_chunk = resource_offset +
205                                 chunk_table_size + chunk_offsets[0];
206         if (fseeko(fp, file_offset_of_first_needed_chunk, SEEK_SET) != 0) {
207                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
208                                  "first chunk of compressed resource",
209                                  file_offset_of_first_needed_chunk);
210                 return WIMLIB_ERR_READ;
211         }
212
213         /* Pointer to current position in the output buffer for uncompressed
214          * data. */
215         u8 *out_p = (u8*)contents_ret;
216
217         /* Buffer for compressed data.  While most compressed chunks will have a
218          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
219          * size in the worst-case.  This assumption is valid only if chunks that
220          * happen to compress to more than the uncompressed size (i.e. a
221          * sequence of random bytes) are always stored uncompressed. But this seems
222          * to be the case in M$'s WIM files, even though it is undocumented. */
223         u8 compressed_buf[WIM_CHUNK_SIZE - 1];
224
225
226         /* Decompress all the chunks. */
227         for (u64 i = start_chunk; i <= end_chunk; i++) {
228
229                 DEBUG2("Chunk %"PRIu64" (start %"PRIu64", end %"PRIu64").",
230                        i, start_chunk, end_chunk);
231
232                 /* Calculate the sizes of the compressed chunk and of the
233                  * uncompressed chunk. */
234                 uint compressed_chunk_size, 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 /*
424  * Reads some data from the resource corresponding to a WIM lookup table entry.
425  *
426  * @lte:        The WIM lookup table entry for the resource.
427  * @buf:        Buffer into which to write the data.
428  * @size:       Number of bytes to read.
429  * @offset:     Offset at which to start reading the resource.
430  * @raw:        If %true, compressed data is read literally rather than being
431  *                      decompressed first.
432  *
433  * Returns zero on success, nonzero on failure.
434  */
435 int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
436                       size_t size, u64 offset, bool raw)
437 {
438         int ctype;
439         int ret = 0;
440         FILE *fp;
441
442         /* We shouldn't be allowing read over-runs in any part of the library.
443          * */
444         if (raw)
445                 wimlib_assert(offset + size <= lte->resource_entry.size);
446         else
447                 wimlib_assert(offset + size <= lte->resource_entry.original_size);
448
449         switch (lte->resource_location) {
450         case RESOURCE_IN_WIM:
451                 /* The resource is in a WIM file, and its WIMStruct is given by
452                  * the lte->wim member.  The resource may be either compressed
453                  * or uncompressed. */
454                 wimlib_assert(lte->wim != NULL);
455                 wimlib_assert(lte->wim->fp != NULL);
456                 ctype = wim_resource_compression_type(lte);
457
458                 wimlib_assert(ctype != WIM_COMPRESSION_TYPE_NONE ||
459                               (lte->resource_entry.original_size ==
460                                lte->resource_entry.size));
461
462                 if (raw || ctype == WIM_COMPRESSION_TYPE_NONE)
463                         ret = read_uncompressed_resource(lte->wim->fp,
464                                                          lte->resource_entry.offset + offset,
465                                                          size, buf);
466                 else
467                         ret = read_compressed_resource(lte->wim->fp,
468                                                        lte->resource_entry.size,
469                                                        lte->resource_entry.original_size,
470                                                        lte->resource_entry.offset,
471                                                        ctype, size, offset, buf);
472                 break;
473         case RESOURCE_IN_STAGING_FILE:
474         case RESOURCE_IN_FILE_ON_DISK:
475                 /* The resource is in some file on the external filesystem and
476                  * needs to be read uncompressed */
477                 wimlib_assert(lte->file_on_disk);
478                 wimlib_assert(&lte->file_on_disk == &lte->staging_file_name);
479                 /* Use existing file pointer if available; otherwise open one
480                  * temporarily */
481                 if (lte->file_on_disk_fp) {
482                         fp = lte->file_on_disk_fp;
483                 } else {
484                         fp = fopen(lte->file_on_disk, "rb");
485                         if (!fp) {
486                                 ERROR_WITH_ERRNO("Failed to open the file "
487                                                  "`%s'", lte->file_on_disk);
488                                 ret = WIMLIB_ERR_OPEN;
489                                 break;
490                         }
491                 }
492                 ret = read_uncompressed_resource(fp, offset, size, buf);
493                 if (fp != lte->file_on_disk_fp)
494                         fclose(fp);
495                 break;
496         case RESOURCE_IN_ATTACHED_BUFFER:
497                 /* The resource is directly attached uncompressed in an
498                  * in-memory buffer. */
499                 wimlib_assert(lte->attached_buffer != NULL);
500                 memcpy(buf, lte->attached_buffer + offset, size);
501                 break;
502 #ifdef WITH_NTFS_3G
503         case RESOURCE_IN_NTFS_VOLUME:
504                 wimlib_assert(lte->ntfs_loc != NULL);
505                 wimlib_assert(lte->attr != NULL);
506                 {
507                         u64 adjusted_offset;
508                         if (lte->ntfs_loc->is_reparse_point)
509                                 adjusted_offset = offset + 8;
510                         else
511                                 adjusted_offset = offset;
512                         if (ntfs_attr_pread(lte->attr, offset, size, buf) != size) {
513                                 ERROR_WITH_ERRNO("Error reading NTFS attribute "
514                                                  "at `%s'",
515                                                  lte->ntfs_loc->path_utf8);
516                                 ret = WIMLIB_ERR_NTFS_3G;
517                         }
518                         break;
519                 }
520 #endif
521         default:
522                 wimlib_assert(0);
523                 ret = -1;
524                 break;
525         }
526         return ret;
527 }
528
529 /*
530  * Reads all the data from the resource corresponding to a WIM lookup table
531  * entry.
532  *
533  * @lte:        The WIM lookup table entry for the resource.
534  * @buf:        Buffer into which to write the data.  It must be at least
535  *              wim_resource_size(lte) bytes long.
536  *
537  * Returns 0 on success; nonzero on failure.
538  */
539 int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[])
540 {
541         return read_wim_resource(lte, buf, wim_resource_size(lte), 0, false);
542 }
543
544 /* Chunk table that's located at the beginning of each compressed resource in
545  * the WIM.  (This is not the on-disk format; the on-disk format just has an
546  * array of offsets.) */
547 struct chunk_table {
548         off_t file_offset;
549         u64 num_chunks;
550         u64 original_resource_size;
551         u64 bytes_per_chunk_entry;
552         u64 table_disk_size;
553         u64 cur_offset;
554         u64 *cur_offset_p;
555         u64 offsets[0];
556 };
557
558 /*
559  * Allocates and initializes a chunk table, and reserves space for it in the
560  * output file.
561  */
562 static int
563 begin_wim_resource_chunk_tab(const struct lookup_table_entry *lte,
564                              FILE *out_fp,
565                              off_t file_offset,
566                              struct chunk_table **chunk_tab_ret)
567 {
568         u64 size = wim_resource_size(lte);
569         u64 num_chunks = (size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
570         size_t alloc_size = sizeof(struct chunk_table) + num_chunks * sizeof(u64);
571         struct chunk_table *chunk_tab = CALLOC(1, alloc_size);
572         int ret;
573
574         if (!chunk_tab) {
575                 ERROR("Failed to allocate chunk table for %"PRIu64" byte "
576                       "resource", size);
577                 ret = WIMLIB_ERR_NOMEM;
578                 goto out;
579         }
580         chunk_tab->file_offset = file_offset;
581         chunk_tab->num_chunks = num_chunks;
582         chunk_tab->original_resource_size = size;
583         chunk_tab->bytes_per_chunk_entry = (size >= (1ULL << 32)) ? 8 : 4;
584         chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry *
585                                      (num_chunks - 1);
586         chunk_tab->cur_offset = 0;
587         chunk_tab->cur_offset_p = chunk_tab->offsets;
588
589         if (fwrite(chunk_tab, 1, chunk_tab->table_disk_size, out_fp) !=
590                    chunk_tab->table_disk_size) {
591                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
592                                  "file resource");
593                 ret = WIMLIB_ERR_WRITE;
594                 goto out;
595         }
596
597         ret = 0;
598 out:
599         *chunk_tab_ret = chunk_tab;
600         return ret;
601 }
602
603 /*
604  * Compresses a chunk of a WIM resource.
605  *
606  * @chunk:              Uncompressed data of the chunk.
607  * @chunk_size:         Size of the uncompressed chunk in bytes.
608  * @compressed_chunk:   Pointer to output buffer of size at least
609  *                              (@chunk_size - 1) bytes.
610  * @compressed_chunk_len_ret:   Pointer to an unsigned int into which the size
611  *                                      of the compressed chunk will be
612  *                                      returned.
613  * @ctype:      Type of compression to use.  Must be WIM_COMPRESSION_TYPE_LZX
614  *              or WIM_COMPRESSION_TYPE_XPRESS.
615  *
616  * Returns zero if compressed succeeded, and nonzero if the chunk could not be
617  * compressed to any smaller than @chunk_size.  This function cannot fail for
618  * any other reasons.
619  */
620 static int compress_chunk(const u8 chunk[], unsigned chunk_size,
621                           u8 compressed_chunk[],
622                           unsigned *compressed_chunk_len_ret,
623                           int ctype)
624 {
625         int (*compress)(const void *, unsigned, void *, unsigned *);
626         switch (ctype) {
627         case WIM_COMPRESSION_TYPE_LZX:
628                 compress = lzx_compress;
629                 break;
630         case WIM_COMPRESSION_TYPE_XPRESS:
631                 compress = xpress_compress;
632                 break;
633         default:
634                 wimlib_assert(0);
635                 break;
636         }
637         return (*compress)(chunk, chunk_size, compressed_chunk,
638                            compressed_chunk_len_ret);
639 }
640
641 /*
642  * Writes a chunk of a WIM resource to an output file.
643  *
644  * @chunk:        Uncompressed data of the chunk.
645  * @chunk_size:   Size of the chunk (<= WIM_CHUNK_SIZE)
646  * @out_fp:       FILE * to write tho chunk to.
647  * @out_ctype:    Compression type to use when writing the chunk (ignored if no
648  *                      chunk table provided)
649  * @chunk_tab:    Pointer to chunk table being created.  It is updated with the
650  *                      offset of the chunk we write.
651  *
652  * Returns 0 on success; nonzero on failure.
653  */
654 static int write_wim_resource_chunk(const u8 chunk[], unsigned chunk_size,
655                                     FILE *out_fp, int out_ctype,
656                                     struct chunk_table *chunk_tab)
657 {
658         const u8 *out_chunk;
659         unsigned out_chunk_size;
660
661         wimlib_assert(chunk_size <= WIM_CHUNK_SIZE);
662
663         if (!chunk_tab) {
664                 out_chunk = chunk;
665                 out_chunk_size = chunk_size;
666         } else {
667                 u8 *compressed_chunk = alloca(chunk_size);
668                 int ret;
669
670                 ret = compress_chunk(chunk, chunk_size, compressed_chunk,
671                                      &out_chunk_size, out_ctype);
672                 if (ret == 0) {
673                         out_chunk = compressed_chunk;
674                 } else {
675                         out_chunk = chunk;
676                         out_chunk_size = chunk_size;
677                 }
678                 *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
679                 chunk_tab->cur_offset += out_chunk_size;
680         }
681
682         if (fwrite(out_chunk, 1, out_chunk_size, out_fp) != out_chunk_size) {
683                 ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
684                 return WIMLIB_ERR_WRITE;
685         }
686         return 0;
687 }
688
689 /*
690  * Finishes a WIM chunk tale and writes it to the output file at the correct
691  * offset.
692  *
693  * The final size of the full compressed resource is returned in the
694  * @compressed_size_p.
695  */
696 static int
697 finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab,
698                               FILE *out_fp, u64 *compressed_size_p)
699 {
700         size_t bytes_written;
701         if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
702                 ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" of output "
703                                  "WIM file", chunk_tab->file_offset);
704                 return WIMLIB_ERR_WRITE;
705         }
706
707         if (chunk_tab->bytes_per_chunk_entry == 8) {
708                 array_cpu_to_le64(chunk_tab->offsets, chunk_tab->num_chunks);
709         } else {
710                 for (u64 i = 0; i < chunk_tab->num_chunks; i++)
711                         ((u32*)chunk_tab->offsets)[i] =
712                                 cpu_to_le32(chunk_tab->offsets[i]);
713         }
714         bytes_written = fwrite((u8*)chunk_tab->offsets +
715                                         chunk_tab->bytes_per_chunk_entry,
716                                1, chunk_tab->table_disk_size, out_fp);
717         if (bytes_written != chunk_tab->table_disk_size) {
718                 ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
719                                  "file resource");
720                 return WIMLIB_ERR_WRITE;
721         }
722         if (fseeko(out_fp, 0, SEEK_END) != 0) {
723                 ERROR_WITH_ERRNO("Failed to seek to end of output WIM file");
724                 return WIMLIB_ERR_WRITE;
725         }
726         *compressed_size_p = chunk_tab->cur_offset + chunk_tab->table_disk_size;
727         return 0;
728 }
729
730 /*
731  * Writes a WIM resource to a FILE * opened for writing.  The resource may be
732  * written uncompressed or compressed depending on the @out_ctype parameter.
733  *
734  * If by chance the resource compresses to more than the original size (this may
735  * happen with random data or files than are pre-compressed), the resource is
736  * instead written uncompressed (and this is reflected in the @out_res_entry by
737  * removing the WIM_RESHDR_FLAG_COMPRESSED flag).
738  *
739  * @lte:        The lookup table entry for the WIM resource.
740  * @out_fp:     The FILE * to write the resource to.
741  * @out_ctype:  The compression type of the resource to write.  Note: if this is
742  *                      the same as the compression type of the WIM resource we
743  *                      need to read, we simply copy the data (i.e. we do not
744  *                      uncompress it, then compress it again).
745  * @out_res_entry:  If non-NULL, a resource entry that is filled in with the
746  *                  offset, original size, compressed size, and compression flag
747  *                  of the output resource.
748  *
749  * Returns 0 on success; nonzero on failure.
750  */
751 static int write_wim_resource(struct lookup_table_entry *lte,
752                               FILE *out_fp, int out_ctype,
753                               struct resource_entry *out_res_entry)
754 {
755         u64 bytes_remaining;
756         u64 original_size;
757         u64 old_compressed_size;
758         u64 new_compressed_size;
759         u64 offset;
760         int ret;
761         struct chunk_table *chunk_tab = NULL;
762         bool raw;
763         off_t file_offset;
764 #ifdef WITH_NTFS_3G
765         ntfs_inode *ni = NULL;
766 #endif
767
768         wimlib_assert(lte);
769
770         /* Original size of the resource */
771         original_size = wim_resource_size(lte);
772
773         /* Compressed size of the resource (as it exists now) */
774         old_compressed_size = wim_resource_compressed_size(lte);
775
776         /* Current offset in output file */
777         file_offset = ftello(out_fp);
778         if (file_offset == -1) {
779                 ERROR_WITH_ERRNO("Failed to get offset in output "
780                                  "stream");
781                 return WIMLIB_ERR_WRITE;
782         }
783
784         /* Are the compression types the same?  If so, do a raw copy (copy
785          * without decompressing and recompressing the data). */
786         raw = (wim_resource_compression_type(lte) == out_ctype
787                && out_ctype != WIM_COMPRESSION_TYPE_NONE);
788         if (raw)
789                 bytes_remaining = old_compressed_size;
790         else
791                 bytes_remaining = original_size;
792
793         /* Empty resource; nothing needs to be done, so just return success. */
794         if (bytes_remaining == 0)
795                 return 0;
796
797         /* Buffer for reading chunks for the resource */
798         u8 buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
799
800         /* If we are writing a compressed resource and not doing a raw copy, we
801          * need to initialize the chunk table */
802         if (out_ctype != WIM_COMPRESSION_TYPE_NONE && !raw) {
803                 ret = begin_wim_resource_chunk_tab(lte, out_fp, file_offset,
804                                                    &chunk_tab);
805                 if (ret != 0)
806                         goto out;
807         }
808
809         /* If the WIM resource is in an external file, open a FILE * to it so we
810          * don't have to open a temporary one in read_wim_resource() for each
811          * chunk. */
812         if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK
813              && !lte->file_on_disk_fp)
814         {
815                 wimlib_assert(lte->file_on_disk);
816                 lte->file_on_disk_fp = fopen(lte->file_on_disk, "rb");
817                 if (!lte->file_on_disk_fp) {
818                         ERROR_WITH_ERRNO("Failed to open the file `%s' for "
819                                          "reading", lte->file_on_disk);
820                         ret = WIMLIB_ERR_OPEN;
821                         goto out;
822                 }
823         }
824 #ifdef WITH_NTFS_3G
825         else if (lte->resource_location == RESOURCE_IN_NTFS_VOLUME
826                   && !lte->attr)
827         {
828                 struct ntfs_location *loc = lte->ntfs_loc;
829                 wimlib_assert(loc);
830                 ni = ntfs_pathname_to_inode(*loc->ntfs_vol_p, NULL, loc->path_utf8);
831                 if (!ni) {
832                         ERROR_WITH_ERRNO("Failed to open inode `%s' in NTFS "
833                                          "volume", loc->path_utf8);
834                         ret = WIMLIB_ERR_NTFS_3G;
835                         goto out;
836                 }
837                 lte->attr = ntfs_attr_open(ni,
838                                            loc->is_reparse_point ? AT_REPARSE_POINT : AT_DATA,
839                                            (ntfschar*)loc->stream_name_utf16,
840                                            loc->stream_name_utf16_num_chars);
841                 if (!lte->attr) {
842                         ERROR_WITH_ERRNO("Failed to open attribute of `%s' in "
843                                          "NTFS volume", loc->path_utf8);
844                         ret = WIMLIB_ERR_NTFS_3G;
845                         goto out_fclose;
846                 }
847         }
848 #endif
849
850         /* If we aren't doing a raw copy, we will compute the SHA1 message
851          * digest of the resource as we read it, and verify it's the same as the
852          * hash given in the lookup table entry once we've finished reading the
853          * resource. */
854         SHA_CTX ctx;
855         if (!raw)
856                 sha1_init(&ctx);
857
858         /* While there are still bytes remaining in the WIM resource, read a
859          * chunk of the resource, update SHA1, then write that chunk using the
860          * desired compression type. */
861         offset = 0;
862         do {
863                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
864                 ret = read_wim_resource(lte, buf, to_read, offset, raw);
865                 if (ret != 0)
866                         goto out_fclose;
867                 if (!raw)
868                         sha1_update(&ctx, buf, to_read);
869                 ret = write_wim_resource_chunk(buf, to_read, out_fp,
870                                                out_ctype, chunk_tab);
871                 if (ret != 0)
872                         goto out_fclose;
873                 bytes_remaining -= to_read;
874                 offset += to_read;
875         } while (bytes_remaining);
876
877         /* Raw copy:  The new compressed size is the same as the old compressed
878          * size
879          *
880          * Using WIM_COMPRESSION_TYPE_NONE:  The new compressed size is the
881          * original size
882          *
883          * Using a different compression type:  Call
884          * finish_wim_resource_chunk_tab() and it will provide the new
885          * compressed size.
886          */
887         if (raw) {
888                 new_compressed_size = old_compressed_size;
889         } else {
890                 if (out_ctype == WIM_COMPRESSION_TYPE_NONE)
891                         new_compressed_size = original_size;
892                 else {
893                         ret = finish_wim_resource_chunk_tab(chunk_tab, out_fp,
894                                                             &new_compressed_size);
895                         if (ret != 0)
896                                 goto out_fclose;
897                 }
898         }
899
900         /* Verify SHA1 message digest of the resource, unless we are doing a raw
901          * write (in which case we never even saw the uncompressed data).  Or,
902          * if the hash we had before is all 0's, just re-set it to be the new
903          * hash. */
904         if (!raw) {
905                 u8 md[SHA1_HASH_SIZE];
906                 sha1_final(md, &ctx);
907                 if (is_zero_hash(lte->hash)) {
908                         copy_hash(lte->hash, md);
909                 } else if (!hashes_equal(md, lte->hash)) {
910                         ERROR("WIM resource has incorrect hash!");
911                         if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK) {
912                                 ERROR("We were reading it from `%s'; maybe it changed "
913                                       "while we were reading it.",
914                                       lte->file_on_disk);
915                         }
916                         ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
917                         goto out_fclose;
918                 }
919         }
920
921         if (!raw && new_compressed_size >= original_size &&
922             out_ctype != WIM_COMPRESSION_TYPE_NONE)
923         {
924                 /* Oops!  We compressed the resource to larger than the original
925                  * size.  Write the resource uncompressed instead. */
926                 if (fseeko(out_fp, file_offset, SEEK_SET) != 0) {
927                         ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" "
928                                          "of output WIM file", file_offset);
929                         ret = WIMLIB_ERR_WRITE;
930                         goto out_fclose;
931                 }
932                 ret = write_wim_resource(lte, out_fp, WIM_COMPRESSION_TYPE_NONE,
933                                          out_res_entry);
934                 if (ret != 0)
935                         goto out_fclose;
936                 if (fflush(out_fp) != 0) {
937                         ERROR_WITH_ERRNO("Failed to flush output WIM file");
938                         ret = WIMLIB_ERR_WRITE;
939                         goto out_fclose;
940                 }
941                 if (ftruncate(fileno(out_fp), file_offset + out_res_entry->size) != 0) {
942                         ERROR_WITH_ERRNO("Failed to truncate output WIM file");
943                         ret = WIMLIB_ERR_WRITE;
944                         goto out_fclose;
945                 }
946         } else {
947                 if (out_res_entry) {
948                         out_res_entry->size          = new_compressed_size;
949                         out_res_entry->original_size = original_size;
950                         out_res_entry->offset        = file_offset;
951                         out_res_entry->flags         = lte->resource_entry.flags
952                                                         & ~WIM_RESHDR_FLAG_COMPRESSED;
953                         if (out_ctype != WIM_COMPRESSION_TYPE_NONE)
954                                 out_res_entry->flags |= WIM_RESHDR_FLAG_COMPRESSED;
955                 }
956         }
957         ret = 0;
958 out_fclose:
959         if (lte->resource_location == RESOURCE_IN_FILE_ON_DISK
960             && lte->file_on_disk_fp) {
961                 fclose(lte->file_on_disk_fp);
962                 lte->file_on_disk_fp = NULL;
963         }
964 #ifdef WITH_NTFS_3G
965         else if (lte->resource_location == RESOURCE_IN_NTFS_VOLUME) {
966                 if (lte->attr) {
967                         ntfs_attr_close(lte->attr);
968                         lte->attr = NULL;
969                 }
970                 if (ni)
971                         ntfs_inode_close(ni);
972         }
973 #endif
974 out:
975         FREE(chunk_tab);
976         return ret;
977 }
978
979 /* Like write_wim_resource(), but the resource is specified by a buffer of
980  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
981  * the buffer to @hash.  */
982 static int write_wim_resource_from_buffer(const u8 *buf, u64 buf_size,
983                                           FILE *out_fp, int out_ctype,
984                                           struct resource_entry *out_res_entry,
985                                           u8 hash[SHA1_HASH_SIZE])
986 {
987         /* Set up a temporary lookup table entry to provide to
988          * write_wim_resource(). */
989         struct lookup_table_entry lte;
990         int ret;
991         lte.resource_entry.flags         = 0;
992         lte.resource_entry.original_size = buf_size;
993         lte.resource_entry.size          = buf_size;
994         lte.resource_entry.offset        = 0;
995         lte.resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
996         lte.attached_buffer              = (u8*)buf;
997
998         zero_out_hash(lte.hash);
999         ret = write_wim_resource(&lte, out_fp, out_ctype, out_res_entry);
1000         if (ret != 0)
1001                 return ret;
1002         copy_hash(hash, lte.hash);
1003         return 0;
1004 }
1005
1006 /*
1007  * Extracts the first @size bytes of the WIM resource specified by @lte to the
1008  * open file descriptor @fd.
1009  *
1010  * Returns 0 on success; nonzero on failure.
1011  */
1012 int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd,
1013                                u64 size)
1014 {
1015         u64 bytes_remaining = size;
1016         u8 buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
1017         u64 offset = 0;
1018         int ret = 0;
1019         u8 hash[SHA1_HASH_SIZE];
1020
1021         SHA_CTX ctx;
1022         sha1_init(&ctx);
1023
1024         while (bytes_remaining) {
1025                 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
1026                 ret = read_wim_resource(lte, buf, to_read, offset, false);
1027                 if (ret != 0)
1028                         break;
1029                 sha1_update(&ctx, buf, to_read);
1030                 if (full_write(fd, buf, to_read) < to_read) {
1031                         ERROR_WITH_ERRNO("Error extracting WIM resource");
1032                         return WIMLIB_ERR_WRITE;
1033                 }
1034                 bytes_remaining -= to_read;
1035                 offset += to_read;
1036         }
1037         sha1_final(hash, &ctx);
1038         if (!hashes_equal(hash, lte->hash)) {
1039                 ERROR("Invalid checksum on a WIM resource "
1040                       "(detected when extracting to external file)");
1041                 ERROR("The following WIM resource is invalid:");
1042                 print_lookup_table_entry(lte);
1043                 return WIMLIB_ERR_INVALID_RESOURCE_HASH;
1044         }
1045         return 0;
1046 }
1047
1048 /*
1049  * Extracts the WIM resource specified by @lte to the open file descriptor @fd.
1050  *
1051  * Returns 0 on success; nonzero on failure.
1052  */
1053 int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd)
1054 {
1055         return extract_wim_resource_to_fd(lte, fd, wim_resource_size(lte));
1056 }
1057
1058 /*
1059  * Copies the file resource specified by the lookup table entry @lte from the
1060  * input WIM to the output WIM that has its FILE * given by
1061  * ((WIMStruct*)wim)->out_fp.
1062  *
1063  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
1064  * updated.
1065  *
1066  * Metadata resources are not copied (they are handled elsewhere for joining and
1067  * splitting).
1068  */
1069 int copy_resource(struct lookup_table_entry *lte, void *wim)
1070 {
1071         WIMStruct *w = wim;
1072         int ret;
1073
1074         if ((lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) &&
1075             !w->write_metadata)
1076                 return 0;
1077
1078         ret = write_wim_resource(lte, w->out_fp,
1079                                  wim_resource_compression_type(lte),
1080                                  &lte->output_resource_entry);
1081         if (ret != 0)
1082                 return ret;
1083         lte->out_refcnt = lte->refcnt;
1084         lte->part_number = w->hdr.part_number;
1085         return 0;
1086 }
1087
1088 /*
1089  * Writes a dentry's resources, including the main file resource as well as all
1090  * alternate data streams, to the output file.
1091  *
1092  * @dentry:  The dentry for the file.
1093  * @wim_p:   A pointer to the WIMStruct containing @dentry.
1094  *
1095  * @return zero on success, nonzero on failure.
1096  */
1097 int write_dentry_resources(struct dentry *dentry, void *wim_p)
1098 {
1099         WIMStruct *w = wim_p;
1100         int ret = 0;
1101         struct lookup_table_entry *lte;
1102         int ctype = wimlib_get_compression_type(w);
1103
1104         if (w->write_flags & WIMLIB_WRITE_FLAG_VERBOSE) {
1105                 wimlib_assert(dentry->full_path_utf8);
1106                 printf("Writing streams for `%s'\n", dentry->full_path_utf8);
1107         }
1108
1109         for (unsigned i = 0; i <= dentry->d_inode->num_ads; i++) {
1110                 lte = inode_stream_lte(dentry->d_inode, i, w->lookup_table);
1111                 if (lte && ++lte->out_refcnt == 1) {
1112                         ret = write_wim_resource(lte, w->out_fp, ctype,
1113                                                  &lte->output_resource_entry);
1114                         if (ret != 0)
1115                                 break;
1116                 }
1117         }
1118         return ret;
1119 }
1120
1121 /*
1122  * Reads the metadata metadata resource from the WIM file.  The metadata
1123  * resource consists of the security data, followed by the directory entry for
1124  * the root directory, followed by all the other directory entries in the
1125  * filesystem.  The subdir_offset field of each directory entry gives the start
1126  * of its child entries from the beginning of the metadata resource.  An
1127  * end-of-directory is signaled by a directory entry of length '0', really of
1128  * length 8, because that's how long the 'length' field is.
1129  *
1130  * @fp:         The FILE* for the input WIM file.
1131  * @wim_ctype:  The compression type of the WIM file.
1132  * @imd:        Pointer to the image metadata structure.  Its `metadata_lte'
1133  *              member specifies the lookup table entry for the metadata
1134  *              resource.  The rest of the image metadata entry will be filled
1135  *              in by this function.
1136  *
1137  * @return:     Zero on success, nonzero on failure.
1138  */
1139 int read_metadata_resource(WIMStruct *w, struct image_metadata *imd)
1140 {
1141         u8 *buf;
1142         u32 dentry_offset;
1143         int ret;
1144         struct dentry *dentry;
1145         struct inode_table inode_tab;
1146         const struct lookup_table_entry *metadata_lte;
1147         u64 metadata_len;
1148         u64 metadata_offset;
1149         struct hlist_head inode_list;
1150
1151         metadata_lte = imd->metadata_lte;
1152         metadata_len = wim_resource_size(metadata_lte);
1153         metadata_offset = metadata_lte->resource_entry.offset;
1154
1155         DEBUG("Reading metadata resource: length = %"PRIu64", "
1156               "offset = %"PRIu64"", metadata_len, metadata_offset);
1157
1158         /* There is no way the metadata resource could possibly be less than (8
1159          * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
1160          * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
1161          * dentry. */
1162         if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
1163                 ERROR("Expected at least %u bytes for the metadata resource",
1164                       8 + WIM_DENTRY_DISK_SIZE);
1165                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
1166         }
1167
1168         if (sizeof(size_t) < 8 && metadata_len > 0xffffffff) {
1169                 ERROR("Metadata resource is too large (%"PRIu64" bytes",
1170                       metadata_len);
1171                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
1172         }
1173
1174         /* Allocate memory for the uncompressed metadata resource. */
1175         buf = MALLOC(metadata_len);
1176
1177         if (!buf) {
1178                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
1179                       "metadata resource", metadata_len);
1180                 return WIMLIB_ERR_NOMEM;
1181         }
1182
1183         /* Read the metadata resource into memory.  (It may be compressed.) */
1184         ret = read_full_wim_resource(metadata_lte, buf);
1185         if (ret != 0)
1186                 goto out_free_buf;
1187
1188         DEBUG("Finished reading metadata resource into memory.");
1189
1190         /* The root directory entry starts after security data, aligned on an
1191          * 8-byte boundary within the metadata resource.
1192          *
1193          * The security data starts with a 4-byte integer giving its total
1194          * length, so if we round that up to an 8-byte boundary that gives us
1195          * the offset of the root dentry.
1196          *
1197          * Here we read the security data into a wim_security_data structure,
1198          * and if successful, go ahead and calculate the offset in the metadata
1199          * resource of the root dentry. */
1200
1201         wimlib_assert(imd->security_data == NULL);
1202         ret = read_security_data(buf, metadata_len, &imd->security_data);
1203         if (ret != 0)
1204                 goto out_free_buf;
1205
1206         dentry_offset = imd->security_data->total_length + 7 & ~7;
1207
1208         if (dentry_offset == 0) {
1209                 ERROR("Integer overflow while reading metadata resource");
1210                 ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
1211                 goto out_free_security_data;
1212         }
1213
1214         /* Allocate memory for the root dentry and read it into memory */
1215         dentry = MALLOC(sizeof(struct dentry));
1216         if (!dentry) {
1217                 ERROR("Failed to allocate %zu bytes for root dentry",
1218                       sizeof(struct dentry));
1219                 ret = WIMLIB_ERR_NOMEM;
1220                 goto out_free_security_data;
1221         }
1222
1223         ret = read_dentry(buf, metadata_len, dentry_offset, dentry);
1224
1225         /* This is the root dentry, so set its pointers correctly. */
1226         dentry->parent = dentry;
1227         dentry->next   = dentry;
1228         dentry->prev   = dentry;
1229         if (ret != 0)
1230                 goto out_free_dentry_tree;
1231         inode_add_dentry(dentry, dentry->d_inode);
1232
1233         /* Now read the entire directory entry tree into memory. */
1234         DEBUG("Reading dentry tree");
1235         ret = read_dentry_tree(buf, metadata_len, dentry);
1236         if (ret != 0)
1237                 goto out_free_dentry_tree;
1238
1239         /* Calculate the full paths in the dentry tree. */
1240         DEBUG("Calculating dentry full paths");
1241         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
1242         if (ret != 0)
1243                 goto out_free_dentry_tree;
1244
1245         /* Build hash table that maps hard link group IDs to dentry sets */
1246         DEBUG("Building link group table");
1247         ret = init_inode_table(&inode_tab, 9001);
1248         if (ret != 0)
1249                 goto out_free_dentry_tree;
1250
1251         for_dentry_in_tree(dentry, inode_table_insert, &inode_tab);
1252
1253         DEBUG("Fixing inconsistencies in the hard link groups");
1254         ret = fix_inodes(&inode_tab, &inode_list);
1255         destroy_inode_table(&inode_tab);
1256         if (ret != 0)
1257                 goto out_free_dentry_tree;
1258
1259         DEBUG("Running miscellaneous verifications on the dentry tree");
1260         for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
1261         ret = for_dentry_in_tree(dentry, verify_dentry, w);
1262         if (ret != 0)
1263                 goto out_free_dentry_tree;
1264
1265         DEBUG("Done reading image metadata");
1266
1267         imd->root_dentry = dentry;
1268         imd->inode_list  = inode_list;
1269         goto out_free_buf;
1270 out_free_dentry_tree:
1271         free_dentry_tree(dentry, NULL);
1272 out_free_security_data:
1273         free_security_data(imd->security_data);
1274         imd->security_data = NULL;
1275 out_free_buf:
1276         FREE(buf);
1277         return ret;
1278 }
1279
1280 /* Write the metadata resource for the current WIM image. */
1281 int write_metadata_resource(WIMStruct *w)
1282 {
1283         u8 *buf;
1284         u8 *p;
1285         int ret;
1286         u64 subdir_offset;
1287         struct dentry *root;
1288         struct lookup_table_entry *lte;
1289         u64 metadata_original_size;
1290         const struct wim_security_data *sd;
1291         const unsigned random_tail_len = 20;
1292
1293         DEBUG("Writing metadata resource for image %d", w->current_image);
1294
1295         root = wim_root_dentry(w);
1296         sd = wim_security_data(w);
1297
1298         /* We do not allow the security data pointer to be NULL, although it may
1299          * point to an empty security data with no entries. */
1300         wimlib_assert(root != NULL);
1301         wimlib_assert(sd != NULL);
1302
1303         /* Offset of first child of the root dentry.  It's equal to:
1304          * - The total length of the security data, rounded to the next 8-byte
1305          *   boundary,
1306          * - plus the total length of the root dentry,
1307          * - plus 8 bytes for an end-of-directory entry following the root
1308          *   dentry (shouldn't really be needed, but just in case...)
1309          */
1310         subdir_offset = ((sd->total_length + 7) & ~7) +
1311                         dentry_correct_total_length(root) + 8;
1312
1313         /* Calculate the subdirectory offsets for the entire dentry tree. */
1314         calculate_subdir_offsets(root, &subdir_offset);
1315
1316         /* Total length of the metadata resource (uncompressed) */
1317         metadata_original_size = subdir_offset + random_tail_len;
1318
1319         /* Allocate a buffer to contain the uncompressed metadata resource */
1320         buf = MALLOC(metadata_original_size);
1321         if (!buf) {
1322                 ERROR("Failed to allocate %"PRIu64" bytes for "
1323                       "metadata resource", metadata_original_size);
1324                 return WIMLIB_ERR_NOMEM;
1325         }
1326
1327         /* Write the security data into the resource buffer */
1328         p = write_security_data(sd, buf);
1329
1330         /* Write the dentry tree into the resource buffer */
1331         p = write_dentry_tree(root, p);
1332
1333         /*
1334          * Append 20 random bytes to the metadata resource so that we don't have
1335          * identical metadata resources if we happen to append exactly the same
1336          * image twice without any changes in timestamps.  If this were to
1337          * happen, it would cause confusion about the number and order of images
1338          * in the WIM.
1339          */
1340         randomize_byte_array(p, random_tail_len);
1341
1342         /* We MUST have exactly filled the buffer; otherwise we calculated its
1343          * size incorrectly or wrote the data incorrectly. */
1344         wimlib_assert(p - buf + random_tail_len == metadata_original_size);
1345
1346         /* Get the lookup table entry for the metadata resource so we can update
1347          * it. */
1348         lte = wim_metadata_lookup_table_entry(w);
1349
1350         wimlib_assert(lte != NULL);
1351
1352         /* Write the metadata resource to the output WIM using the proper
1353          * compression type.  The lookup table entry for the metadata resource
1354          * is updated. */
1355         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
1356                                              w->out_fp,
1357                                              wimlib_get_compression_type(w),
1358                                              &lte->output_resource_entry,
1359                                              lte->hash);
1360         if (ret != 0)
1361                 goto out;
1362
1363         /* It's very likely the SHA1 message digest of the metadata resource
1364          * changed, so re-insert the lookup table entry into the lookup table.
1365          * */
1366         lookup_table_unlink(w->lookup_table, lte);
1367         lookup_table_insert(w->lookup_table, lte);
1368
1369         /* We do not allow a metadata resource to be referenced multiple times,
1370          * and the 20 random bytes appended to it should make it extremely
1371          * likely for each metadata resource to be unique, even if the exact
1372          * same image is captured. */
1373         wimlib_assert(lte->out_refcnt == 0);
1374         lte->out_refcnt = 1;
1375
1376         /* Make sure that the resource entry is written marked with the metadata
1377          * flag. */
1378         lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA;
1379 out:
1380         /* All the data has been written to the new WIM; no need for the buffer
1381          * anymore */
1382         FREE(buf);
1383         return ret;
1384 }