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         struct hlist_head inode_list;
  55
  56         metadata_lte = imd->metadata_lte;
  57         metadata_len = wim_resource_size(metadata_lte);
  58
  59         DEBUG("Reading metadata resource: length = %"PRIu64", "
  60               "offset = %"PRIu64"", metadata_len,
  61               metadata_lte->resource_entry.offset);
  62
  63         /* There is no way the metadata resource could possibly be less than (8
  64          * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
  65          * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
  66          * dentry. */
  67         if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
  68                 ERROR("Expected at least %u bytes for the metadata resource",
  69                       8 + WIM_DENTRY_DISK_SIZE);
  70                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
  71         }
  72
  73         if (sizeof(size_t) < 8 && metadata_len > 0xffffffff) {
  74                 ERROR("Metadata resource is too large (%"PRIu64" bytes",
  75                       metadata_len);
  76                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
  77         }
  78
  79         /* Allocate memory for the uncompressed metadata resource. */
  80         buf = MALLOC(metadata_len);
  81
  82         if (!buf) {
  83                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
  84                       "metadata resource", metadata_len);
  85                 return WIMLIB_ERR_NOMEM;
  86         }
  87
  88         /* Read the metadata resource into memory.  (It may be compressed.) */
  89         ret = read_full_wim_resource(metadata_lte, buf, 0);
  90         if (ret != 0)
  91                 goto out_free_buf;
  92
  93         DEBUG("Finished reading metadata resource into memory.");
  94
  95         /* The root directory entry starts after security data, aligned on an
  96          * 8-byte boundary within the metadata resource.
  97          *
  98          * The security data starts with a 4-byte integer giving its total
  99          * length, so if we round that up to an 8-byte boundary that gives us
 100          * the offset of the root dentry.
 101          *
 102          * Here we read the security data into a wim_security_data structure,
 103          * and if successful, go ahead and calculate the offset in the metadata
 104          * resource of the root dentry. */
 105
 106         wimlib_assert(imd->security_data == NULL);
 107         ret = read_security_data(buf, metadata_len, &imd->security_data);
 108         if (ret != 0)
 109                 goto out_free_buf;
 110
 111         dentry_offset = (imd->security_data->total_length + 7) & ~7;
 112
 113         if (dentry_offset == 0) {
 114                 ERROR("Integer overflow while reading metadata resource");
 115                 ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
 116                 goto out_free_security_data;
 117         }
 118
 119         DEBUG("Reading root dentry");
 120
 121         /* Allocate memory for the root dentry and read it into memory */
 122         dentry = MALLOC(sizeof(struct wim_dentry));
 123         if (!dentry) {
 124                 ERROR("Failed to allocate %zu bytes for root dentry",
 125                       sizeof(struct wim_dentry));
 126                 ret = WIMLIB_ERR_NOMEM;
 127                 goto out_free_security_data;
 128         }
 129
 130         ret = read_dentry(buf, metadata_len, dentry_offset, dentry);
 131
 132         /* This is the root dentry, so set its parent to itself. */
 133         dentry->parent = dentry;
 134
 135         if (ret == 0 && dentry->length == 0) {
 136                 ERROR("Metadata resource cannot begin with end-of-directory entry!");
 137                 ret = WIMLIB_ERR_INVALID_DENTRY;
 138         }
 139
 140         if (ret != 0) {
 141                 FREE(dentry);
 142                 goto out_free_security_data;
 143         }
 144
 145         inode_add_dentry(dentry, dentry->d_inode);
 146
 147         /* Now read the entire directory entry tree into memory. */
 148         DEBUG("Reading dentry tree");
 149         ret = read_dentry_tree(buf, metadata_len, dentry);
 150         if (ret != 0)
 151                 goto out_free_dentry_tree;
 152
 153         /* Calculate the full paths in the dentry tree. */
 154         DEBUG("Calculating dentry full paths");
 155         ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL);
 156         if (ret != 0)
 157                 goto out_free_dentry_tree;
 158
 159         /* Build hash table that maps hard link group IDs to dentry sets */
 160         ret = dentry_tree_fix_inodes(dentry, &inode_list);
 161         if (ret != 0)
 162                 goto out_free_dentry_tree;
 163
 164         if (!w->all_images_verified) {
 165                 DEBUG("Running miscellaneous verifications on the dentry tree");
 166                 for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
 167                 ret = for_dentry_in_tree(dentry, verify_dentry, w);
 168                 if (ret != 0)
 169                         goto out_free_dentry_tree;
 170         }
 171
 172         DEBUG("Done reading image metadata");
 173
 174         imd->root_dentry = dentry;
 175         imd->inode_list  = inode_list;
 176         if (imd->inode_list.first)
 177                 imd->inode_list.first->pprev = &imd->inode_list.first;
 178         goto out_free_buf;
 179 out_free_dentry_tree:
 180         free_dentry_tree(dentry, NULL);
 181 out_free_security_data:
 182         free_security_data(imd->security_data);
 183         imd->security_data = NULL;
 184 out_free_buf:
 185         FREE(buf);
 186         return ret;
 187 }
 188
 189 static void
 190 recalculate_security_data_length(struct wim_security_data *sd)
 191 {
 192         u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
 193         for (u32 i = 0; i < sd->num_entries; i++)
 194                 total_length += sd->sizes[i];
 195         sd->total_length = total_length;
 196 }
 197
 198 /* Like write_wim_resource(), but the resource is specified by a buffer of
 199  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
 200  * the buffer to @hash.  */
 201 static int
 202 write_wim_resource_from_buffer(const u8 *buf, u64 buf_size,
 203                                FILE *out_fp, int out_ctype,
 204                                struct resource_entry *out_res_entry,
 205                                u8 hash[SHA1_HASH_SIZE])
 206 {
 207         /* Set up a temporary lookup table entry to provide to
 208          * write_wim_resource(). */
 209         struct wim_lookup_table_entry lte;
 210         int ret;
 211         lte.resource_entry.flags         = 0;
 212         lte.resource_entry.original_size = buf_size;
 213         lte.resource_entry.size          = buf_size;
 214         lte.resource_entry.offset        = 0;
 215         lte.resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
 216         lte.attached_buffer              = buf;
 217
 218         zero_out_hash(lte.hash);
 219         ret = write_wim_resource(&lte, out_fp, out_ctype, out_res_entry, 0);
 220         if (ret != 0)
 221                 return ret;
 222         copy_hash(hash, lte.hash);
 223         return 0;
 224 }
 225
 226 /* Write the metadata resource for the current WIM image. */
 227 int
 228 write_metadata_resource(WIMStruct *w)
 229 {
 230         u8 *buf;
 231         u8 *p;
 232         int ret;
 233         u64 subdir_offset;
 234         struct wim_dentry *root;
 235         struct wim_lookup_table_entry *lte;
 236         u64 metadata_original_size;
 237         struct wim_security_data *sd;
 238
 239         DEBUG("Writing metadata resource for image %d (offset = %"PRIu64")",
 240               w->current_image, ftello(w->out_fp));
 241
 242         root = wim_root_dentry(w);
 243         sd = wim_security_data(w);
 244
 245         /* Offset of first child of the root dentry.  It's equal to:
 246          * - The total length of the security data, rounded to the next 8-byte
 247          *   boundary,
 248          * - plus the total length of the root dentry,
 249          * - plus 8 bytes for an end-of-directory entry following the root
 250          *   dentry (shouldn't really be needed, but just in case...)
 251          */
 252         recalculate_security_data_length(sd);
 253         subdir_offset = (((u64)sd->total_length + 7) & ~7) +
 254                         dentry_correct_total_length(root) + 8;
 255
 256         /* Calculate the subdirectory offsets for the entire dentry tree. */
 257         calculate_subdir_offsets(root, &subdir_offset);
 258
 259         /* Total length of the metadata resource (uncompressed) */
 260         metadata_original_size = subdir_offset;
 261
 262         /* Allocate a buffer to contain the uncompressed metadata resource */
 263         buf = MALLOC(metadata_original_size);
 264         if (!buf) {
 265                 ERROR("Failed to allocate %"PRIu64" bytes for "
 266                       "metadata resource", metadata_original_size);
 267                 return WIMLIB_ERR_NOMEM;
 268         }
 269
 270         /* Write the security data into the resource buffer */
 271         p = write_security_data(sd, buf);
 272
 273         /* Write the dentry tree into the resource buffer */
 274         p = write_dentry_tree(root, p);
 275
 276         /* We MUST have exactly filled the buffer; otherwise we calculated its
 277          * size incorrectly or wrote the data incorrectly. */
 278         wimlib_assert(p - buf == metadata_original_size);
 279
 280         /* Get the lookup table entry for the metadata resource so we can update
 281          * it. */
 282         lte = w->image_metadata[w->current_image - 1].metadata_lte;
 283
 284         /* Write the metadata resource to the output WIM using the proper
 285          * compression type.  The lookup table entry for the metadata resource
 286          * is updated. */
 287         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
 288                                              w->out_fp,
 289                                              wimlib_get_compression_type(w),
 290                                              &lte->output_resource_entry,
 291                                              lte->hash);
 292         if (ret != 0)
 293                 goto out;
 294
 295         /* It's very likely the SHA1 message digest of the metadata resource
 296          * changed, so re-insert the lookup table entry into the lookup table.
 297          *
 298          * We do not check for other lookup table entries having the same SHA1
 299          * message digest.  It's possible for 2 absolutely identical images to
 300          * be added, therefore causing 2 identical metadata resources to be in
 301          * the WIM.  However, in this case, it's expected for 2 separate lookup
 302          * table entries to be created, even though this doesn't make a whole
 303          * lot of sense since they will share the same SHA1 message digest.
 304          * */
 305         lookup_table_unlink(w->lookup_table, lte);
 306         lookup_table_insert(w->lookup_table, lte);
 307         lte->out_refcnt = 1;
 308
 309         /* Make sure that the lookup table entry for this metadata resource is
 310          * marked with the metadata flag. */
 311         lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA;
 312 out:
 313         /* All the data has been written to the new WIM; no need for the buffer
 314          * anymore */
 315         FREE(buf);
 316         return ret;
 317 }