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 /** Private flag: Used to mark that we currently adding the root directory of
43 #define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000
45 void destroy_image_metadata(struct image_metadata *imd,struct lookup_table *lt)
47 free_dentry_tree(imd->root_dentry, lt);
48 free_security_data(imd->security_data);
49 free_link_group_table(imd->lgt);
51 /* Get rid of the lookup table entry for this image's metadata resource
54 lookup_table_remove(lt, imd->metadata_lte);
58 * Recursively builds a dentry tree from a directory tree on disk, outside the
61 * @root: A dentry that has already been created for the root of the dentry
63 * @root_disk_path: The path to the root of the tree on disk.
64 * @lookup_table: The lookup table for the WIM file. For each file added to the
65 * dentry tree being built, an entry is added to the lookup table,
66 * unless an identical file is already in the lookup table. These
67 * lookup table entries that are added point to the file on disk.
69 * @return: 0 on success, nonzero on failure. It is a failure if any of
70 * the files cannot be `stat'ed, or if any of the needed
71 * directories cannot be opened or read. Failure to add the files
72 * to the WIM may still occur later when trying to actually read
73 * the regular files in the tree into the WIM as file resources.
75 static int build_dentry_tree(struct dentry *root, const char *root_disk_path,
76 struct lookup_table *lookup_table,
77 struct wim_security_data *sd,
81 DEBUG("%s", root_disk_path);
82 struct stat root_stbuf;
84 int (*stat_fn)(const char *restrict, struct stat *restrict);
86 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE)
91 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
92 printf("Scanning `%s'\n", root_disk_path);
95 ret = (*stat_fn)(root_disk_path, &root_stbuf);
97 ERROR_WITH_ERRNO("Failed to stat `%s'", root_disk_path);
98 return WIMLIB_ERR_STAT;
101 if ((add_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) &&
102 !S_ISDIR(root_stbuf.st_mode)) {
103 ERROR("`%s' is not a directory", root_disk_path);
104 return WIMLIB_ERR_NOTDIR;
106 if (!S_ISREG(root_stbuf.st_mode) && !S_ISDIR(root_stbuf.st_mode)
107 && !S_ISLNK(root_stbuf.st_mode)) {
108 ERROR("`%s' is not a regular file, directory, or symbolic link.");
109 return WIMLIB_ERR_SPECIAL_FILE;
111 stbuf_to_dentry(&root_stbuf, root);
112 add_flags &= ~WIMLIB_ADD_IMAGE_FLAG_ROOT;
113 root->resolved = true;
115 if (dentry_is_directory(root)) {
116 /* Open the directory on disk */
119 struct dentry *child;
121 dir = opendir(root_disk_path);
123 ERROR_WITH_ERRNO("Failed to open the directory `%s'",
125 return WIMLIB_ERR_OPEN;
128 /* Buffer for names of files in directory. */
129 size_t len = strlen(root_disk_path);
130 char name[len + 1 + FILENAME_MAX + 1];
131 memcpy(name, root_disk_path, len);
134 /* Create a dentry for each entry in the directory on disk, and recurse
135 * to any subdirectories. */
136 while ((p = readdir(dir)) != NULL) {
137 if (p->d_name[0] == '.' && (p->d_name[1] == '\0'
138 || (p->d_name[1] == '.' && p->d_name[2] == '\0')))
140 strcpy(name + len + 1, p->d_name);
141 child = new_dentry(p->d_name);
143 return WIMLIB_ERR_NOMEM;
144 ret = build_dentry_tree(child, name, lookup_table,
145 sd, add_flags, extra_arg);
146 link_dentry(child, root);
151 } else if (dentry_is_symlink(root)) {
152 /* Archiving a symbolic link */
153 size_t symlink_buf_len;
154 char deref_name_buf[4096];
155 ssize_t deref_name_len;
157 deref_name_len = readlink(root_disk_path, deref_name_buf,
158 sizeof(deref_name_buf) - 1);
159 if (deref_name_len == -1) {
160 ERROR_WITH_ERRNO("Failed to read target of "
161 "symbolic link `%s'", root_disk_path);
162 return WIMLIB_ERR_READLINK;
164 deref_name_buf[deref_name_len] = '\0';
165 DEBUG("Read symlink `%s'", deref_name_buf);
166 ret = dentry_set_symlink(root, deref_name_buf,
170 struct lookup_table_entry *lte;
171 u8 hash[SHA1_HASH_SIZE];
173 /* For each regular file, we must check to see if the file is in
174 * the lookup table already; if it is, we increment its refcnt;
175 * otherwise, we create a new lookup table entry and insert it.
177 ret = sha1sum(root_disk_path, hash);
181 lte = __lookup_resource(lookup_table, hash);
184 DEBUG("Add lte reference %u for `%s'", lte->refcnt,
187 char *file_on_disk = STRDUP(root_disk_path);
189 ERROR("Failed to allocate memory for file path");
190 return WIMLIB_ERR_NOMEM;
192 lte = new_lookup_table_entry();
195 return WIMLIB_ERR_NOMEM;
197 lte->file_on_disk = file_on_disk;
198 lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
199 lte->resource_entry.original_size = root_stbuf.st_size;
200 lte->resource_entry.size = root_stbuf.st_size;
201 copy_hash(lte->hash, hash);
202 lookup_table_insert(lookup_table, lte);
215 * This function takes in a dentry that was previously located only in image(s)
216 * in @src_wim, but now is being added to @dest_wim. If there is in fact already a
217 * lookup table entry for this file in the lookup table of the destination WIM
218 * file, we simply increment its reference count. Otherwise, a new lookup table
219 * entry is created that references the location of the file resource in the
220 * source WIM file through the other_wim_fp field of the lookup table entry.
222 static int add_lte_to_dest_wim(struct dentry *dentry, void *arg)
224 WIMStruct *src_wim, *dest_wim;
226 src_wim = ((struct wim_pair*)arg)->src_wim;
227 dest_wim = ((struct wim_pair*)arg)->dest_wim;
229 wimlib_assert(!dentry->resolved);
231 for (unsigned i = 0; i < (unsigned)dentry->num_ads + 1; i++) {
232 struct lookup_table_entry *src_lte, *dest_lte;
233 src_lte = dentry_stream_lte_unresolved(dentry, i,
234 src_wim->lookup_table);
237 dest_lte = dentry_stream_lte_unresolved(dentry, i,
238 dest_wim->lookup_table);
242 dest_lte = new_lookup_table_entry();
244 return WIMLIB_ERR_NOMEM;
245 dest_lte->resource_location = RESOURCE_IN_WIM;
246 dest_lte->wim = src_wim;
247 memcpy(&dest_lte->resource_entry,
248 &src_lte->resource_entry,
249 sizeof(struct resource_entry));
250 copy_hash(dest_lte->hash,
251 dentry_stream_hash_unresolved(dentry, i));
252 lookup_table_insert(dest_wim->lookup_table, dest_lte);
259 * Adds an image (given by its dentry tree) to the image metadata array of a WIM
260 * file, adds an entry to the lookup table for the image metadata, updates the
261 * image count in the header, and selects the new image.
263 * Does not update the XML data.
265 * @w: The WIMStruct for the WIM file.
266 * @root_dentry: The root of the directory tree for the image.
268 static int add_new_dentry_tree(WIMStruct *w, struct dentry *root_dentry,
269 struct wim_security_data *sd)
271 struct lookup_table_entry *metadata_lte;
272 struct image_metadata *imd;
273 struct image_metadata *new_imd;
274 struct link_group_table *lgt;
276 DEBUG("Reallocating image metadata array for image_count = %u",
277 w->hdr.image_count + 1);
278 imd = CALLOC((w->hdr.image_count + 1), sizeof(struct image_metadata));
281 ERROR("Failed to allocate memory for new image metadata array");
282 return WIMLIB_ERR_NOMEM;
285 memcpy(imd, w->image_metadata,
286 w->hdr.image_count * sizeof(struct image_metadata));
288 metadata_lte = new_lookup_table_entry();
292 lgt = new_link_group_table(9001);
294 goto out_free_security_data;
296 metadata_lte->resource_entry.flags = WIM_RESHDR_FLAG_METADATA;
297 random_hash(metadata_lte->hash);
298 lookup_table_insert(w->lookup_table, metadata_lte);
300 new_imd = &imd[w->hdr.image_count];
302 new_imd->root_dentry = root_dentry;
303 new_imd->metadata_lte = metadata_lte;
304 new_imd->security_data = sd;
306 new_imd->modified = true;
308 FREE(w->image_metadata);
309 w->image_metadata = imd;
310 w->hdr.image_count++;
312 /* Change the current image to the new one. */
313 return wimlib_select_image(w, w->hdr.image_count);
314 out_free_security_data:
316 out_free_metadata_lte:
320 return WIMLIB_ERR_NOMEM;
325 * Copies an image, or all the images, from a WIM file, into another WIM file.
327 WIMLIBAPI int wimlib_export_image(WIMStruct *src_wim,
330 const char *dest_name,
331 const char *dest_description,
337 struct wim_pair wims;
338 struct wim_security_data *sd;
340 if (src_image == WIM_ALL_IMAGES) {
341 if (src_wim->hdr.image_count > 1) {
343 /* multi-image export. */
345 if ((flags & WIMLIB_EXPORT_FLAG_BOOT) &&
346 (src_wim->hdr.boot_idx == 0))
348 /* Specifying the boot flag on a multi-image
349 * source WIM makes the boot index default to
350 * the bootable image in the source WIM. It is
351 * an error if there is no such bootable image.
353 ERROR("Cannot specify `boot' flag when "
354 "exporting multiple images from a WIM "
355 "with no bootable images");
356 return WIMLIB_ERR_INVALID_PARAM;
358 if (dest_name || dest_description) {
359 ERROR("Image name or image description was "
360 "specified, but we are exporting "
362 return WIMLIB_ERR_INVALID_PARAM;
364 for (i = 1; i <= src_wim->hdr.image_count; i++) {
365 int export_flags = flags;
367 if (i != src_wim->hdr.boot_idx)
368 export_flags &= ~WIMLIB_EXPORT_FLAG_BOOT;
370 ret = wimlib_export_image(src_wim, i, dest_wim,
383 ret = wimlib_select_image(src_wim, src_image);
385 ERROR("Could not select image %d from the WIM `%s' "
386 "to export it", src_image, src_wim->filename);
391 dest_name = wimlib_get_image_name(src_wim, src_image);
392 DEBUG("Using name `%s' for source image %d",
393 dest_name, src_image);
396 DEBUG("Exporting image %d from `%s'", src_image, src_wim->filename);
398 if (wimlib_image_name_in_use(dest_wim, dest_name)) {
399 ERROR("There is already an image named `%s' in the "
400 "destination WIM", dest_name);
401 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
405 /* Cleaning up here on failure would be hard. For example, we could
406 * fail to allocate memory in add_lte_to_dest_wim(),
407 * leaving the lookup table entries in the destination WIM in an
408 * inconsistent state. Until these issues can be resolved,
409 * wimlib_export_image() is documented as leaving dest_wim is an
410 * indeterminate state. */
411 root = wim_root_dentry(src_wim);
412 sd = wim_security_data(src_wim);
413 for_dentry_in_tree(root, increment_dentry_refcnt, NULL);
414 wims.src_wim = src_wim;
415 wims.dest_wim = dest_wim;
416 ret = for_dentry_in_tree(root, add_lte_to_dest_wim, &wims);
419 ret = add_new_dentry_tree(dest_wim, root, sd);
424 if (flags & WIMLIB_EXPORT_FLAG_BOOT) {
425 DEBUG("Setting boot_idx to %d", dest_wim->hdr.image_count);
426 dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
429 return xml_export_image(src_wim->wim_info, src_image, &dest_wim->wim_info,
430 dest_name, dest_description);
434 * Deletes an image from the WIM.
436 WIMLIBAPI int wimlib_delete_image(WIMStruct *w, int image)
442 if (image == WIM_ALL_IMAGES) {
443 num_images = w->hdr.image_count;
444 for (i = 1; i <= num_images; i++) {
445 /* Always delete the first image, since by the end
446 * there won't be any more than that! */
447 ret = wimlib_delete_image(w, 1);
454 DEBUG("Deleting image %d", image);
456 /* Even if the dentry tree is not allocated, we must select it (and
457 * therefore allocate it) so that we can decrement the reference counts
458 * in the lookup table. */
459 ret = wimlib_select_image(w, image);
463 /* Free the dentry tree, any lookup table entries that have their
464 * refcnt decremented to 0, and the security data. */
465 destroy_image_metadata(wim_get_current_image_metadata(w),
468 /* Get rid of the empty slot in the image metadata array. */
469 memmove(&w->image_metadata[image - 1], &w->image_metadata[image],
470 (w->hdr.image_count - image) * sizeof(struct image_metadata));
472 /* Decrement the image count. */
473 if (--w->hdr.image_count == 0) {
474 FREE(w->image_metadata);
475 w->image_metadata = NULL;
478 /* Fix the boot index. */
479 if (w->hdr.boot_idx == image)
481 else if (w->hdr.boot_idx > image)
484 w->current_image = WIM_NO_IMAGE;
486 /* Remove the image from the XML information. */
487 xml_delete_image(&w->wim_info, image);
491 int do_add_image(WIMStruct *w, const char *dir, const char *name,
492 const char *description, const char *flags_element,
494 int (*capture_tree)(struct dentry *, const char *,
495 struct lookup_table *,
496 struct wim_security_data *, int, void *),
499 struct dentry *root_dentry;
500 struct image_metadata *imd;
501 struct wim_security_data *sd;
504 DEBUG("Adding dentry tree from dir `%s'.", dir);
506 if (!name || !*name) {
507 ERROR("Must specify a non-empty string for the image name");
508 return WIMLIB_ERR_INVALID_PARAM;
511 ERROR("Must specify the name of a directory");
512 return WIMLIB_ERR_INVALID_PARAM;
515 if (wimlib_image_name_in_use(w, name)) {
516 ERROR("There is already an image named \"%s\" in `%s'",
518 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
521 DEBUG("Creating root dentry.");
523 root_dentry = new_dentry("");
525 return WIMLIB_ERR_NOMEM;
528 sd = CALLOC(1, sizeof(struct wim_security_data));
530 goto out_free_dentry_tree;
531 sd->total_length = 8;
534 DEBUG("Building dentry tree.");
535 ret = (*capture_tree)(root_dentry, dir, w->lookup_table, sd,
536 flags | WIMLIB_ADD_IMAGE_FLAG_ROOT,
540 ERROR("Failed to build dentry tree for `%s'", dir);
544 DEBUG("Calculating full paths of dentries.");
545 ret = for_dentry_in_tree(root_dentry, calculate_dentry_full_path, NULL);
549 ret = add_new_dentry_tree(w, root_dentry, sd);
553 DEBUG("Inserting dentries into hard link group table");
554 ret = for_dentry_in_tree(root_dentry, link_group_table_insert,
555 w->image_metadata[w->hdr.image_count - 1].lgt);
557 goto out_destroy_imd;
558 DEBUG("Assigning hard link groups");
559 assign_link_groups(w->image_metadata[w->hdr.image_count - 1].lgt);
561 if (flags & WIMLIB_ADD_IMAGE_FLAG_BOOT)
562 wimlib_set_boot_idx(w, w->hdr.image_count);
564 ret = xml_add_image(w, root_dentry, name, description, flags_element);
566 goto out_destroy_imd;
570 destroy_image_metadata(&w->image_metadata[w->hdr.image_count - 1],
572 w->hdr.image_count--;
575 free_security_data(sd);
576 out_free_dentry_tree:
577 free_dentry_tree(root_dentry, w->lookup_table);
582 * Adds an image to a WIM file from a directory tree on disk.
584 WIMLIBAPI int wimlib_add_image(WIMStruct *w, const char *dir,
585 const char *name, const char *description,
586 const char *flags_element, int flags)
588 return do_add_image(w, dir, name, description, flags_element, flags,
589 build_dentry_tree, NULL);