6 * Copyright (C) 2012, 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
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
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.
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/.
27 #include "wimlib/dentry.h"
28 #include "wimlib/error.h"
29 #include "wimlib/file_io.h"
30 #include "wimlib/lookup_table.h"
31 #include "wimlib/metadata.h"
32 #include "wimlib/resource.h"
33 #include "wimlib/security.h"
36 * Reads a metadata resource for an image in the WIM file. The metadata
37 * resource consists of the security data, followed by the directory entry for
38 * the root directory, followed by all the other directory entries in the
39 * filesystem. The subdir_offset field of each directory entry gives the start
40 * of its child entries from the beginning of the metadata resource. An
41 * end-of-directory is signaled by a directory entry of length '0', really of
42 * length 8, because that's how long the 'length' field is.
44 * @w: Pointer to the WIMStruct for the WIM file.
46 * @imd: Pointer to the image metadata structure for the image whose
47 * metadata resource we are reading. Its `metadata_lte' member
48 * specifies the lookup table entry for the metadata resource. The
49 * rest of the image metadata entry will be filled in by this
52 * Returns: Zero on success, nonzero on failure.
55 read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)
60 struct wim_dentry *dentry;
61 const struct wim_lookup_table_entry *metadata_lte;
64 metadata_lte = imd->metadata_lte;
65 metadata_len = wim_resource_size(metadata_lte);
67 DEBUG("Reading metadata resource: original_size = %"PRIu64", "
68 "size = %"PRIu64", offset = %"PRIu64"",
69 metadata_lte->resource_entry.original_size,
70 metadata_lte->resource_entry.size,
71 metadata_lte->resource_entry.offset);
73 /* There is no way the metadata resource could possibly be less than (8
74 * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
75 * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
77 if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
78 ERROR("Expected at least %u bytes for the metadata resource",
79 8 + WIM_DENTRY_DISK_SIZE);
80 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
83 if (sizeof(size_t) < 8 && metadata_len > 0xffffffff) {
84 ERROR("Metadata resource is too large (%"PRIu64" bytes",
86 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
89 /* Allocate memory for the uncompressed metadata resource. */
90 buf = MALLOC(metadata_len);
93 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
94 "metadata resource", metadata_len);
95 return WIMLIB_ERR_NOMEM;
98 /* Read the metadata resource into memory. (It may be compressed.) */
99 ret = read_full_resource_into_buf(metadata_lte, buf);
103 DEBUG("Finished reading metadata resource into memory.");
105 /* The root directory entry starts after security data, aligned on an
106 * 8-byte boundary within the metadata resource.
108 * The security data starts with a 4-byte integer giving its total
109 * length, so if we round that up to an 8-byte boundary that gives us
110 * the offset of the root dentry.
112 * Here we read the security data into a wim_security_data structure,
113 * and if successful, go ahead and calculate the offset in the metadata
114 * resource of the root dentry. */
116 wimlib_assert(imd->security_data == NULL);
117 ret = read_wim_security_data(buf, metadata_len, &imd->security_data);
121 dentry_offset = (imd->security_data->total_length + 7) & ~7;
123 if (dentry_offset == 0) {
124 ERROR("Integer overflow while reading metadata resource");
125 ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
126 goto out_free_security_data;
129 DEBUG("Reading root dentry");
131 /* Allocate memory for the root dentry and read it into memory */
132 dentry = MALLOC(sizeof(struct wim_dentry));
134 ERROR("Failed to allocate %zu bytes for root dentry",
135 sizeof(struct wim_dentry));
136 ret = WIMLIB_ERR_NOMEM;
137 goto out_free_security_data;
140 ret = read_dentry(buf, metadata_len, dentry_offset, dentry);
142 /* This is the root dentry, so set its parent to itself. */
143 dentry->parent = dentry;
145 if (ret == 0 && dentry->length == 0) {
146 ERROR("Metadata resource cannot begin with end-of-directory entry!");
147 ret = WIMLIB_ERR_INVALID_DENTRY;
152 goto out_free_security_data;
155 inode_add_dentry(dentry, dentry->d_inode);
157 /* Now read the entire directory entry tree into memory. */
158 DEBUG("Reading dentry tree");
159 ret = read_dentry_tree(buf, metadata_len, dentry);
161 goto out_free_dentry_tree;
163 /* Build hash table that maps hard link group IDs to dentry sets */
164 ret = dentry_tree_fix_inodes(dentry, &imd->inode_list);
166 goto out_free_dentry_tree;
168 if (!w->all_images_verified) {
169 DEBUG("Running miscellaneous verifications on the dentry tree");
170 for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
171 ret = for_dentry_in_tree(dentry, verify_dentry, w);
173 goto out_free_dentry_tree;
176 DEBUG("Done reading image metadata");
178 imd->root_dentry = dentry;
179 INIT_LIST_HEAD(&imd->unhashed_streams);
181 out_free_dentry_tree:
182 free_dentry_tree(dentry, NULL);
183 out_free_security_data:
184 free_wim_security_data(imd->security_data);
185 imd->security_data = NULL;
192 recalculate_security_data_length(struct wim_security_data *sd)
194 u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
195 for (u32 i = 0; i < sd->num_entries; i++)
196 total_length += sd->sizes[i];
197 sd->total_length = (total_length + 7) & ~7;
200 /* Like write_wim_resource(), but the resource is specified by a buffer of
201 * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
202 * the buffer to @hash. */
204 write_wim_resource_from_buffer(const void *buf, size_t buf_size,
205 int out_fd, int out_ctype,
206 struct resource_entry *out_res_entry,
207 u8 hash[SHA1_HASH_SIZE])
209 /* Set up a temporary lookup table entry to provide to
210 * write_wim_resource(). */
211 struct wim_lookup_table_entry lte;
213 lte.resource_location = RESOURCE_IN_ATTACHED_BUFFER;
214 lte.attached_buffer = (void*)buf;
215 lte.resource_entry.original_size = buf_size;
216 lte.resource_entry.flags = 0;
218 ret = write_wim_resource(<e, out_fd, out_ctype, out_res_entry, 0);
220 copy_hash(hash, lte.hash);
224 /* Write the metadata resource for the current WIM image. */
226 write_metadata_resource(WIMStruct *w)
232 struct wim_dentry *root;
233 struct wim_lookup_table_entry *lte;
234 u64 metadata_original_size;
235 struct wim_security_data *sd;
236 struct wim_image_metadata *imd;
238 wimlib_assert(w->out_fd != -1);
239 wimlib_assert(w->current_image != WIMLIB_NO_IMAGE);
241 DEBUG("Writing metadata resource for image %d (offset = %"PRIu64")",
242 w->current_image, filedes_offset(w->out_fd));
244 imd = w->image_metadata[w->current_image - 1];
246 root = imd->root_dentry;
247 sd = imd->security_data;
250 /* Empty image; create a dummy root. */
251 ret = new_filler_directory(T(""), &root);
254 imd->root_dentry = root;
257 /* Offset of first child of the root dentry. It's equal to:
258 * - The total length of the security data, rounded to the next 8-byte
260 * - plus the total length of the root dentry,
261 * - plus 8 bytes for an end-of-directory entry following the root
262 * dentry (shouldn't really be needed, but just in case...)
264 recalculate_security_data_length(sd);
265 subdir_offset = (((u64)sd->total_length + 7) & ~7) +
266 dentry_correct_total_length(root) + 8;
268 /* Calculate the subdirectory offsets for the entire dentry tree. */
269 calculate_subdir_offsets(root, &subdir_offset);
271 /* Total length of the metadata resource (uncompressed) */
272 metadata_original_size = subdir_offset;
274 /* Allocate a buffer to contain the uncompressed metadata resource */
275 buf = MALLOC(metadata_original_size);
277 ERROR("Failed to allocate %"PRIu64" bytes for "
278 "metadata resource", metadata_original_size);
279 return WIMLIB_ERR_NOMEM;
282 /* Write the security data into the resource buffer */
283 p = write_wim_security_data(sd, buf);
285 /* Write the dentry tree into the resource buffer */
286 p = write_dentry_tree(root, p);
288 /* We MUST have exactly filled the buffer; otherwise we calculated its
289 * size incorrectly or wrote the data incorrectly. */
290 wimlib_assert(p - buf == metadata_original_size);
292 /* Get the lookup table entry for the metadata resource so we can update
294 lte = wim_get_current_image_metadata(w)->metadata_lte;
296 /* Write the metadata resource to the output WIM using the proper
297 * compression type. The lookup table entry for the metadata resource
299 ret = write_wim_resource_from_buffer(buf, metadata_original_size,
301 wimlib_get_compression_type(w),
302 <e->output_resource_entry,
304 /* Note that although the SHA1 message digest of the metadata resource
305 * is very likely to have changed, the corresponding lookup table entry
306 * is not actually located in the hash table, so it need not be
307 * re-inserted in the hash table. */
309 /* All the data has been written to the new WIM; no need for the buffer