wimlib.net Git - wimlib/blob - src/metadata_resource.c

   1 /*
   2  * metadata_resource.c
   3  */
   4
   5 /*
   6  * Copyright (C) 2012, 2013 Eric Biggers
   7  *
   8  * This file is part of wimlib, a library for working with WIM files.
   9  *
  10  * wimlib is free software; you can redistribute it and/or modify it under the
  11  * terms of the GNU General Public License as published by the Free Software
  12  * Foundation; either version 3 of the License, or (at your option) any later
  13  * version.
  14  *
  15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17  * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along with
  20  * wimlib; if not, see http://www.gnu.org/licenses/.
  21  */
  22
  23 #include "wimlib_internal.h"
  24 #include "dentry.h"
  25 #include "lookup_table.h"
  26
  27 /*
  28  * Reads the metadata metadata resource from the WIM file.  The metadata
  29  * resource consists of the security data, followed by the directory entry for
  30  * the root directory, followed by all the other directory entries in the
  31  * filesystem.  The subdir_offset field of each directory entry gives the start
  32  * of its child entries from the beginning of the metadata resource.  An
  33  * end-of-directory is signaled by a directory entry of length '0', really of
  34  * length 8, because that's how long the 'length' field is.
  35  *
  36  * @fp:         The FILE* for the input WIM file.
  37  * @wim_ctype:  The compression type of the WIM file.
  38  * @imd:        Pointer to the image metadata structure.  Its `metadata_lte'
  39  *              member specifies the lookup table entry for the metadata
  40  *              resource.  The rest of the image metadata entry will be filled
  41  *              in by this function.
  42  *
  43  * @return:     Zero on success, nonzero on failure.
  44  */
  45 int
  46 read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)
  47 {
  48         u8 *buf;
  49         u32 dentry_offset;
  50         int ret;
  51         struct wim_dentry *dentry;
  52         const struct wim_lookup_table_entry *metadata_lte;
  53         u64 metadata_len;
  54
  55         metadata_lte = imd->metadata_lte;
  56         metadata_len = wim_resource_size(metadata_lte);
  57
  58         DEBUG("Reading metadata resource: length = %"PRIu64", "
  59               "offset = %"PRIu64"", metadata_len,
  60               metadata_lte->resource_entry.offset);
  61
  62         /* There is no way the metadata resource could possibly be less than (8
  63          * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
  64          * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
  65          * dentry. */
  66         if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
  67                 ERROR("Expected at least %u bytes for the metadata resource",
  68                       8 + WIM_DENTRY_DISK_SIZE);
  69                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
  70         }
  71
  72         if (sizeof(size_t) < 8 && metadata_len > 0xffffffff) {
  73                 ERROR("Metadata resource is too large (%"PRIu64" bytes",
  74                       metadata_len);
  75                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
  76         }
  77
  78         /* Allocate memory for the uncompressed metadata resource. */
  79         buf = MALLOC(metadata_len);
  80
  81         if (!buf) {
  82                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
  83                       "metadata resource", metadata_len);
  84                 return WIMLIB_ERR_NOMEM;
  85         }
  86
  87         /* Read the metadata resource into memory.  (It may be compressed.) */
  88         ret = read_full_resource_into_buf(metadata_lte, buf, false);
  89         if (ret)
  90                 goto out_free_buf;
  91
  92         DEBUG("Finished reading metadata resource into memory.");
  93
  94         /* The root directory entry starts after security data, aligned on an
  95          * 8-byte boundary within the metadata resource.
  96          *
  97          * The security data starts with a 4-byte integer giving its total
  98          * length, so if we round that up to an 8-byte boundary that gives us
  99          * the offset of the root dentry.
 100          *
 101          * Here we read the security data into a wim_security_data structure,
 102          * and if successful, go ahead and calculate the offset in the metadata
 103          * resource of the root dentry. */
 104
 105         wimlib_assert(imd->security_data == NULL);
 106         ret = read_security_data(buf, metadata_len, &imd->security_data);
 107         if (ret)
 108                 goto out_free_buf;
 109
 110         dentry_offset = (imd->security_data->total_length + 7) & ~7;
 111
 112         if (dentry_offset == 0) {
 113                 ERROR("Integer overflow while reading metadata resource");
 114                 ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
 115                 goto out_free_security_data;
 116         }
 117
 118         DEBUG("Reading root dentry");
 119
 120         /* Allocate memory for the root dentry and read it into memory */
 121         dentry = MALLOC(sizeof(struct wim_dentry));
 122         if (!dentry) {
 123                 ERROR("Failed to allocate %zu bytes for root dentry",
 124                       sizeof(struct wim_dentry));
 125                 ret = WIMLIB_ERR_NOMEM;
 126                 goto out_free_security_data;
 127         }
 128
 129         ret = read_dentry(buf, metadata_len, dentry_offset, dentry);
 130
 131         /* This is the root dentry, so set its parent to itself. */
 132         dentry->parent = dentry;
 133
 134         if (ret == 0 && dentry->length == 0) {
 135                 ERROR("Metadata resource cannot begin with end-of-directory entry!");
 136                 ret = WIMLIB_ERR_INVALID_DENTRY;
 137         }
 138
 139         if (ret != 0) {
 140                 FREE(dentry);
 141                 goto out_free_security_data;
 142         }
 143
 144         inode_add_dentry(dentry, dentry->d_inode);
 145
 146         /* Now read the entire directory entry tree into memory. */
 147         DEBUG("Reading dentry tree");
 148         ret = read_dentry_tree(buf, metadata_len, dentry);
 149         if (ret)
 150                 goto out_free_dentry_tree;
 151
 152         /* Build hash table that maps hard link group IDs to dentry sets */
 153         ret = dentry_tree_fix_inodes(dentry, &imd->inode_list);
 154         if (ret)
 155                 goto out_free_dentry_tree;
 156
 157         if (!w->all_images_verified) {
 158                 DEBUG("Running miscellaneous verifications on the dentry tree");
 159                 for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
 160                 ret = for_dentry_in_tree(dentry, verify_dentry, w);
 161                 if (ret)
 162                         goto out_free_dentry_tree;
 163         }
 164
 165         DEBUG("Done reading image metadata");
 166
 167         imd->root_dentry = dentry;
 168         INIT_LIST_HEAD(&imd->unhashed_streams);
 169         goto out_free_buf;
 170 out_free_dentry_tree:
 171         free_dentry_tree(dentry, NULL);
 172 out_free_security_data:
 173         free_security_data(imd->security_data);
 174         imd->security_data = NULL;
 175 out_free_buf:
 176         FREE(buf);
 177         return ret;
 178 }
 179
 180 static void
 181 recalculate_security_data_length(struct wim_security_data *sd)
 182 {
 183         u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
 184         for (u32 i = 0; i < sd->num_entries; i++)
 185                 total_length += sd->sizes[i];
 186         sd->total_length = total_length;
 187 }
 188
 189 /* Like write_wim_resource(), but the resource is specified by a buffer of
 190  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
 191  * the buffer to @hash.  */
 192 static int
 193 write_wim_resource_from_buffer(const void *buf, u64 buf_size,
 194                                FILE *out_fp, int out_ctype,
 195                                struct resource_entry *out_res_entry,
 196                                u8 hash[SHA1_HASH_SIZE])
 197 {
 198         /* Set up a temporary lookup table entry to provide to
 199          * write_wim_resource(). */
 200         struct wim_lookup_table_entry lte;
 201         int ret;
 202         lte.resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
 203         lte.attached_buffer              = (void*)buf;
 204         lte.resource_entry.original_size = buf_size;
 205         lte.resource_entry.flags         = 0;
 206         lte.unhashed                     = 1;
 207         ret = write_wim_resource(&lte, out_fp, out_ctype, out_res_entry, 0);
 208         if (ret == 0)
 209                 copy_hash(hash, lte.hash);
 210         return ret;
 211 }
 212
 213 /* Write the metadata resource for the current WIM image. */
 214 int
 215 write_metadata_resource(WIMStruct *w)
 216 {
 217         u8 *buf;
 218         u8 *p;
 219         int ret;
 220         u64 subdir_offset;
 221         struct wim_dentry *root;
 222         struct wim_lookup_table_entry *lte;
 223         u64 metadata_original_size;
 224         struct wim_security_data *sd;
 225
 226         wimlib_assert(w->out_fp != NULL);
 227         wimlib_assert(w->current_image != WIMLIB_NO_IMAGE);
 228
 229         DEBUG("Writing metadata resource for image %d (offset = %"PRIu64")",
 230               w->current_image, ftello(w->out_fp));
 231
 232
 233         root = wim_root_dentry(w);
 234         sd = wim_security_data(w);
 235
 236         /* Offset of first child of the root dentry.  It's equal to:
 237          * - The total length of the security data, rounded to the next 8-byte
 238          *   boundary,
 239          * - plus the total length of the root dentry,
 240          * - plus 8 bytes for an end-of-directory entry following the root
 241          *   dentry (shouldn't really be needed, but just in case...)
 242          */
 243         recalculate_security_data_length(sd);
 244         subdir_offset = (((u64)sd->total_length + 7) & ~7) +
 245                         dentry_correct_total_length(root) + 8;
 246
 247         /* Calculate the subdirectory offsets for the entire dentry tree. */
 248         calculate_subdir_offsets(root, &subdir_offset);
 249
 250         /* Total length of the metadata resource (uncompressed) */
 251         metadata_original_size = subdir_offset;
 252
 253         /* Allocate a buffer to contain the uncompressed metadata resource */
 254         buf = MALLOC(metadata_original_size);
 255         if (!buf) {
 256                 ERROR("Failed to allocate %"PRIu64" bytes for "
 257                       "metadata resource", metadata_original_size);
 258                 return WIMLIB_ERR_NOMEM;
 259         }
 260
 261         /* Write the security data into the resource buffer */
 262         p = write_security_data(sd, buf);
 263
 264         /* Write the dentry tree into the resource buffer */
 265         p = write_dentry_tree(root, p);
 266
 267         /* We MUST have exactly filled the buffer; otherwise we calculated its
 268          * size incorrectly or wrote the data incorrectly. */
 269         wimlib_assert(p - buf == metadata_original_size);
 270
 271         /* Get the lookup table entry for the metadata resource so we can update
 272          * it. */
 273         lte = wim_get_current_image_metadata(w)->metadata_lte;
 274
 275         /* Write the metadata resource to the output WIM using the proper
 276          * compression type.  The lookup table entry for the metadata resource
 277          * is updated. */
 278         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
 279                                              w->out_fp,
 280                                              wimlib_get_compression_type(w),
 281                                              &lte->output_resource_entry,
 282                                              lte->hash);
 283         if (ret)
 284                 goto out_free_buf;
 285
 286         /* Note that although the SHA1 message digest of the metadata resource
 287          * is very likely to have changed, the corresponding lookup table entry
 288          * is not actually located in the hash table, so it need not be
 289          * re-inserted in the hash table. */
 290         lte->out_refcnt = 1;
 291         lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA;
 292 out_free_buf:
 293         /* All the data has been written to the new WIM; no need for the buffer
 294          * anymore */
 295         FREE(buf);
 296         return ret;
 297 }