4 * Support for modifying WIM files with image-level operations (delete an image,
5 * add an image, export an imagex from one WIM to another.) There is nothing
6 * here that lets you change individual files in the WIM; for that you will need
7 * to look at the filesystem implementation in mount.c.
11 * Copyright (C) 2012 Eric Biggers
13 * This file is part of wimlib, a library for working with WIM files.
15 * wimlib is free software; you can redistribute it and/or modify it under the
16 * terms of the GNU Lesser General Public License as published by the Free
17 * Software Foundation; either version 2.1 of the License, or (at your option)
20 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
21 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
22 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
25 * You should have received a copy of the GNU Lesser General Public License
26 * along with wimlib; if not, see http://www.gnu.org/licenses/.
29 #include "wimlib_internal.h"
34 #include "lookup_table.h"
41 * Recursively builds a dentry tree from a directory tree on disk, outside the
44 * @root: A dentry that has already been created for the root of the dentry
46 * @source_path: The path to the root of the tree on disk.
47 * @root_stat: A pointer to a `struct stat' that contains the metadata for the
48 * root of the tree on disk.
49 * @lookup_table: The lookup table for the WIM file. For each file added to the
50 * dentry tree being built, an entry is added to the lookup table,
51 * unless an identical file is already in the lookup table. These
52 * lookup table entries that are added point to the file on disk.
54 * @return: 0 on success, nonzero on failure. It is a failure if any of
55 * the files cannot be `stat'ed, or if any of the needed
56 * directories cannot be opened or read. Failure to add the files
57 * to the WIM may still occur later when trying to actually read
58 * the regular files in the tree into the WIM as file resources.
60 static int build_dentry_tree(struct dentry *root, const char *source_path,
61 struct stat *root_stat, struct lookup_table* lookup_table)
65 stbuf_to_dentry(root_stat, root);
66 if (dentry_is_directory(root)) {
67 /* Open the directory on disk */
70 struct stat child_stat;
73 dir = opendir(source_path);
75 ERROR("Failed to open the directory `%s': %m\n",
77 return WIMLIB_ERR_OPEN;
80 /* Buffer for names of files in directory. */
81 size_t len = strlen(source_path);
82 char name[len + 1 + FILENAME_MAX + 1];
83 memcpy(name, source_path, len);
87 /* Create a dentry for each entry in the directory on disk, and recurse
88 * to any subdirectories. */
89 while ((p = readdir(dir)) != NULL) {
90 if (p->d_name[0] == '.' && (p->d_name[1] == '\0'
91 || (p->d_name[1] == '.' && p->d_name[2] == '\0')))
93 strcpy(name + len + 1, p->d_name);
94 if (stat(name, &child_stat) != 0) {
95 ERROR("cannot stat `%s': %m\n", name);
96 ret = WIMLIB_ERR_STAT;
99 child = new_dentry(p->d_name);
100 ret = build_dentry_tree(child, name, &child_stat,
104 link_dentry(child, root);
108 struct lookup_table_entry *lte;
110 /* For each non-directory, we must check to see if the file is
111 * in the lookup table already; if it is, we increment its
112 * refcnt; otherwise, we create a new lookup table entry and
114 ret = sha1sum(source_path, root->hash);
116 ERROR("Failed to calculate sha1sum for file `%s'\n",
121 lte = lookup_resource(lookup_table, root->hash);
125 char *file_on_disk = STRDUP(source_path);
127 ERROR("Failed to allocate memory for file "
129 return WIMLIB_ERR_NOMEM;
131 lte = new_lookup_table_entry();
133 ERROR("Failed to allocate memory for new "
134 "lookup table entry!\n");
136 return WIMLIB_ERR_NOMEM;
138 lte->file_on_disk = file_on_disk;
139 lte->resource_entry.flags = 0;
141 lte->part_number = 1;
142 lte->resource_entry.original_size = root_stat->st_size;
143 lte->resource_entry.size = root_stat->st_size;
144 memcpy(lte->hash, root->hash, WIM_HASH_SIZE);
145 lookup_table_insert(lookup_table, lte);
157 * This function takes in a dentry that was previously located only in image(s)
158 * in @src_wim, but now is being added to @dest_wim. If there is in fact already a
159 * lookup table entry for this file in the lookup table of the destination WIM
160 * file, we simply increment its reference count. Otherwise, a new lookup table
161 * entry is created that references the location of the file resource in the
162 * source WIM file through the other_wim_fp field of the lookup table entry.
164 static int add_lookup_table_entry_to_dest_wim(struct dentry *dentry, void *arg)
166 WIMStruct *src_wim, *dest_wim;
167 struct lookup_table_entry *src_table_entry;
168 struct lookup_table_entry *dest_table_entry;
170 src_wim = ((struct wim_pair*)arg)->src_wim;
171 dest_wim = ((struct wim_pair*)arg)->dest_wim;
173 if (dentry_is_directory(dentry))
176 src_table_entry = wim_lookup_resource(src_wim, dentry);
177 if (!src_table_entry)
180 dest_table_entry = wim_lookup_resource(dest_wim, dentry);
181 if (dest_table_entry) {
182 dest_table_entry->refcnt++;
184 dest_table_entry = new_lookup_table_entry();
185 if (!dest_table_entry) {
186 ERROR("Could not allocate lookup table entry!\n");
187 return WIMLIB_ERR_NOMEM;
189 dest_table_entry->other_wim_fp = src_wim->fp;
190 dest_table_entry->other_wim_ctype =
191 wimlib_get_compression_type(src_wim);
192 dest_table_entry->refcnt = 1;
193 memcpy(&dest_table_entry->resource_entry,
194 &src_table_entry->resource_entry,
195 sizeof(struct resource_entry));
196 memcpy(dest_table_entry->hash, dentry->hash, WIM_HASH_SIZE);
197 lookup_table_insert(dest_wim->lookup_table, dest_table_entry);
203 * Adds an image (given by its dentry tree) to the image metadata array of a WIM
204 * file, adds an entry to the lookup table for the image metadata, updates the
205 * image count in the header, and selects the new image.
207 * Does not update the XML data.
209 * @w: The WIMStruct for the WIM file.
210 * @root_dentry: The root of the directory tree for the image.
212 static int add_new_dentry_tree(WIMStruct *w, struct dentry *root_dentry)
214 struct lookup_table_entry *imd_lookup_entry;
215 struct image_metadata *imd;
216 struct image_metadata *new_imd;
218 DEBUG("Reallocing image metadata array for image_count = %u\n",
219 w->hdr.image_count + 1);
220 imd = CALLOC((w->hdr.image_count + 1), sizeof(struct image_metadata));
223 ERROR("Failed to allocate memory for new image metadata "
225 return WIMLIB_ERR_NOMEM;
228 memcpy(imd, w->image_metadata,
229 w->hdr.image_count * sizeof(struct image_metadata));
231 imd_lookup_entry = new_lookup_table_entry();
232 if (!imd_lookup_entry) {
233 ERROR("Failed to allocate new lookup table entry!\n");
235 return WIMLIB_ERR_NOMEM;
238 imd_lookup_entry->resource_entry.flags = WIM_RESHDR_FLAG_METADATA;
239 randomize_byte_array(imd_lookup_entry->hash, WIM_HASH_SIZE);
240 lookup_table_insert(w->lookup_table, imd_lookup_entry);
242 w->hdr.image_count++;
244 new_imd = &imd[w->hdr.image_count - 1];
245 new_imd->lookup_table_entry = imd_lookup_entry;
246 new_imd->modified = true;
247 new_imd->root_dentry = root_dentry;
248 w->image_metadata = imd;
250 /* Change the current image to the new one. */
251 return wimlib_select_image(w, w->hdr.image_count);
255 * Copies an image, or all the images, from a WIM file, into another WIM file.
257 WIMLIBAPI int wimlib_export_image(WIMStruct *src_wim,
260 const char *dest_name,
261 const char *dest_description,
267 struct wim_pair wims;
269 if (src_image == WIM_ALL_IMAGES) {
270 if (src_wim->hdr.image_count > 1) {
272 /* multi-image export. */
274 if ((flags & WIMLIB_EXPORT_FLAG_BOOT) &&
275 (src_wim->hdr.boot_idx == 0))
277 /* Specifying the boot flag on a multi-image
278 * source WIM makes the boot index default to
279 * the bootable image in the source WIM. It is
280 * an error if there is no such bootable image.
282 ERROR("Cannot specify `boot' flag when "
283 "exporting multiple images from a WIM "
284 "with no bootable images!\n");
285 return WIMLIB_ERR_INVALID_PARAM;
287 if (dest_name || dest_description) {
288 ERROR("Image name or image description was "
289 "specified, but we are exporting "
290 "multiple images!\n");
291 return WIMLIB_ERR_INVALID_PARAM;
293 for (i = 1; i <= src_wim->hdr.image_count; i++) {
294 int export_flags = flags;
296 if (i != src_wim->hdr.boot_idx)
297 export_flags &= ~WIMLIB_EXPORT_FLAG_BOOT;
299 ret = wimlib_export_image(src_wim, i, dest_wim,
300 NULL, dest_description,
311 ret = wimlib_select_image(src_wim, src_image);
313 ERROR("Could not select image %d from the WIM `%s' "
314 "to export it!\n", src_image, src_wim->filename);
319 dest_name = wimlib_get_image_name(src_wim, src_image);
320 DEBUG("Using name `%s' for source image %d\n",
321 dest_name, src_image);
324 DEBUG("Exporting image %d from `%s'\n", src_image, src_wim->filename);
326 if (wimlib_image_name_in_use(dest_wim, dest_name)) {
327 ERROR("There is already an image named `%s' "
328 "in the destination WIM!\n", dest_name);
329 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
333 root = wim_root_dentry(src_wim);
334 for_dentry_in_tree(root, increment_dentry_refcnt, NULL);
335 wims.src_wim = src_wim;
336 wims.dest_wim = dest_wim;
337 for_dentry_in_tree(root, add_lookup_table_entry_to_dest_wim, &wims);
338 ret = add_new_dentry_tree(dest_wim, root);
339 #ifdef ENABLE_SECURITY_DATA
340 struct wim_security_data *sd = wim_security_data(src_wim);
341 struct image_metadata *new_imd = wim_get_current_image_metadata(dest_wim);
342 new_imd->security_data = sd;
349 if (flags & WIMLIB_EXPORT_FLAG_BOOT) {
350 DEBUG("Setting boot_idx to %d\n", dest_wim->hdr.image_count);
351 dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
354 return xml_export_image(src_wim->wim_info, src_image, &dest_wim->wim_info,
355 dest_name, dest_description);
359 * Deletes an image from the WIM.
361 WIMLIBAPI int wimlib_delete_image(WIMStruct *w, int image)
366 struct image_metadata *imd;
368 if (image == WIM_ALL_IMAGES) {
369 num_images = w->hdr.image_count;
370 for (i = 1; i <= num_images; i++) {
371 /* Always delete the first image, since by the end
372 * there won't be any more than that! */
373 ret = wimlib_delete_image(w, 1);
380 DEBUG("Deleting image %d\n", image);
382 /* Even if the dentry tree is not allocated, we must select it (and
383 * therefore allocate it) so that we can decrement the reference counts
384 * in the lookup table. */
385 ret = wimlib_select_image(w, image);
389 /* Free the dentry tree, any lookup table entries that have their
390 * refcnt decremented to 0, and the security data. */
391 imd = wim_get_current_image_metadata(w);
392 free_dentry_tree(imd->root_dentry, w->lookup_table, true);
393 #ifdef ENABLE_SECURITY_DATA
394 free_security_data(imd->security_data);
397 /* Get rid of the lookup table entry for this image's metadata resource
399 lookup_table_remove(w->lookup_table, imd->lookup_table_entry);
401 /* Get rid of the empty slot in the image metadata array. */
402 for (i = image - 1; i < w->hdr.image_count - 1; i++)
403 memcpy(&w->image_metadata[i], &w->image_metadata[i + 1],
404 sizeof(struct image_metadata));
406 /* Decrement the image count. */
407 w->hdr.image_count--;
408 if (w->hdr.image_count == 0) {
409 FREE(w->image_metadata);
410 w->image_metadata = NULL;
413 /* Fix the boot index. */
414 if (w->hdr.boot_idx == image)
416 else if (w->hdr.boot_idx > image)
419 w->current_image = WIM_NO_IMAGE;
421 /* Remove the image from the XML information. */
422 xml_delete_image(&w->wim_info, image);
427 * Adds an image to a WIM file from a directory tree on disk.
429 WIMLIBAPI int wimlib_add_image(WIMStruct *w, const char *dir,
430 const char *name, const char *description,
431 const char *flags_element, int flags)
433 struct dentry *root_dentry;
434 struct stat root_stat;
437 DEBUG("Adding dentry tree from dir `%s'\n", dir);
439 if (!name || !*name) {
440 ERROR("Must specify a non-empty string for the image name!\n");
441 return WIMLIB_ERR_INVALID_PARAM;
444 ERROR("Must specify the name of a directory!\n");
445 return WIMLIB_ERR_INVALID_PARAM;
448 if (wimlib_image_name_in_use(w, name)) {
449 ERROR("There is already an image named `%s' in %s!\n",
451 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
454 DEBUG("Creating root dentry.\n");
456 root_dentry = new_dentry("");
457 ret = calculate_dentry_full_path(root_dentry, NULL);
460 root_dentry->attributes |= WIM_FILE_ATTRIBUTE_DIRECTORY;
462 /* Construct the dentry tree from the outside filesystem. */
463 if (stat(dir, &root_stat) != 0) {
464 ERROR("Failed to stat `%s': %m\n", dir);
465 return WIMLIB_ERR_STAT;
467 if (!S_ISDIR(root_stat.st_mode)) {
468 ERROR("`%s' is not a directory!\n", dir);
469 return WIMLIB_ERR_NOTDIR;
471 DEBUG("Building dentry tree.\n");
472 ret = build_dentry_tree(root_dentry, dir, &root_stat,
476 ERROR("Failed to build dentry tree for `%s'!\n", dir);
480 DEBUG("Recalculating full paths of dentries.\n");
481 ret = for_dentry_in_tree(root_dentry,
482 calculate_dentry_full_path, NULL);
484 ERROR("Failed to calculate full paths of dentry tree.\n");
488 ret = add_new_dentry_tree(w, root_dentry);
492 if (flags & WIMLIB_ADD_IMAGE_FLAG_BOOT) {
493 /* Call wimlib_set_boot_idx rather than set boot_idx directly so
494 * that the boot metadata resource entry in the header gets
496 wimlib_set_boot_idx(w, w->hdr.image_count);
499 ret = xml_add_image(w, root_dentry, name, description, flags_element);
505 free_dentry_tree(root_dentry, w->lookup_table, true);