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"
43 /** Private flag: Used to mark that we currently adding the root directory of
45 #define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000
47 void destroy_image_metadata(struct image_metadata *imd,struct lookup_table *lt)
49 free_dentry_tree(imd->root_dentry, lt);
50 free_security_data(imd->security_data);
51 free_link_group_table(imd->lgt);
53 /* Get rid of the lookup table entry for this image's metadata resource
56 lookup_table_remove(lt, imd->metadata_lte);
60 * Recursively builds a dentry tree from a directory tree on disk, outside the
63 * @root: A dentry that has already been created for the root of the dentry
65 * @root_disk_path: The path to the root of the tree on disk.
66 * @lookup_table: The lookup table for the WIM file. For each file added to the
67 * dentry tree being built, an entry is added to the lookup table,
68 * unless an identical file is already in the lookup table. These
69 * lookup table entries that are added point to the file on disk.
71 * @return: 0 on success, nonzero on failure. It is a failure if any of
72 * the files cannot be `stat'ed, or if any of the needed
73 * directories cannot be opened or read. Failure to add the files
74 * to the WIM may still occur later when trying to actually read
75 * the regular files in the tree into the WIM as file resources.
77 static int build_dentry_tree(struct dentry **root_ret, const char *root_disk_path,
78 struct lookup_table *lookup_table,
79 struct wim_security_data *sd,
80 const struct capture_config *config,
84 struct stat root_stbuf;
86 int (*stat_fn)(const char *restrict, struct stat *restrict);
89 if (exclude_path(root_disk_path, config, true)) {
90 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
91 printf("Excluding file `%s' from capture\n",
98 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE)
103 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
104 printf("Scanning `%s'\n", root_disk_path);
107 ret = (*stat_fn)(root_disk_path, &root_stbuf);
109 ERROR_WITH_ERRNO("Failed to stat `%s'", root_disk_path);
110 return WIMLIB_ERR_STAT;
113 if ((add_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) &&
114 !S_ISDIR(root_stbuf.st_mode)) {
115 ERROR("`%s' is not a directory", root_disk_path);
116 return WIMLIB_ERR_NOTDIR;
118 if (!S_ISREG(root_stbuf.st_mode) && !S_ISDIR(root_stbuf.st_mode)
119 && !S_ISLNK(root_stbuf.st_mode)) {
120 ERROR("`%s' is not a regular file, directory, or symbolic link.");
121 return WIMLIB_ERR_SPECIAL_FILE;
124 root = new_dentry(path_basename(root_disk_path));
126 return WIMLIB_ERR_NOMEM;
128 stbuf_to_dentry(&root_stbuf, root);
129 add_flags &= ~WIMLIB_ADD_IMAGE_FLAG_ROOT;
130 root->resolved = true;
132 if (dentry_is_directory(root)) {
133 /* Open the directory on disk */
136 struct dentry *child;
138 dir = opendir(root_disk_path);
140 ERROR_WITH_ERRNO("Failed to open the directory `%s'",
142 return WIMLIB_ERR_OPEN;
145 /* Buffer for names of files in directory. */
146 size_t len = strlen(root_disk_path);
147 char name[len + 1 + FILENAME_MAX + 1];
148 memcpy(name, root_disk_path, len);
151 /* Create a dentry for each entry in the directory on disk, and recurse
152 * to any subdirectories. */
153 while ((p = readdir(dir)) != NULL) {
154 if (p->d_name[0] == '.' && (p->d_name[1] == '\0'
155 || (p->d_name[1] == '.' && p->d_name[2] == '\0')))
157 strcpy(name + len + 1, p->d_name);
158 ret = build_dentry_tree(&child, name, lookup_table,
160 add_flags, extra_arg);
164 link_dentry(child, root);
167 } else if (dentry_is_symlink(root)) {
168 /* Archiving a symbolic link */
169 size_t symlink_buf_len;
170 char deref_name_buf[4096];
171 ssize_t deref_name_len;
173 deref_name_len = readlink(root_disk_path, deref_name_buf,
174 sizeof(deref_name_buf) - 1);
175 if (deref_name_len == -1) {
176 ERROR_WITH_ERRNO("Failed to read target of "
177 "symbolic link `%s'", root_disk_path);
178 return WIMLIB_ERR_READLINK;
180 deref_name_buf[deref_name_len] = '\0';
181 DEBUG("Read symlink `%s'", deref_name_buf);
182 ret = dentry_set_symlink(root, deref_name_buf,
186 struct lookup_table_entry *lte;
187 u8 hash[SHA1_HASH_SIZE];
189 /* For each regular file, we must check to see if the file is in
190 * the lookup table already; if it is, we increment its refcnt;
191 * otherwise, we create a new lookup table entry and insert it.
193 ret = sha1sum(root_disk_path, hash);
197 lte = __lookup_resource(lookup_table, hash);
200 DEBUG("Add lte reference %u for `%s'", lte->refcnt,
203 char *file_on_disk = STRDUP(root_disk_path);
205 ERROR("Failed to allocate memory for file path");
206 return WIMLIB_ERR_NOMEM;
208 lte = new_lookup_table_entry();
211 return WIMLIB_ERR_NOMEM;
213 lte->file_on_disk = file_on_disk;
214 lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
215 lte->resource_entry.original_size = root_stbuf.st_size;
216 lte->resource_entry.size = root_stbuf.st_size;
217 copy_hash(lte->hash, hash);
218 lookup_table_insert(lookup_table, lte);
232 * This function takes in a dentry that was previously located only in image(s)
233 * in @src_wim, but now is being added to @dest_wim. If there is in fact already a
234 * lookup table entry for this file in the lookup table of the destination WIM
235 * file, we simply increment its reference count. Otherwise, a new lookup table
236 * entry is created that references the location of the file resource in the
237 * source WIM file through the other_wim_fp field of the lookup table entry.
239 static int add_lte_to_dest_wim(struct dentry *dentry, void *arg)
241 WIMStruct *src_wim, *dest_wim;
243 src_wim = ((struct wim_pair*)arg)->src_wim;
244 dest_wim = ((struct wim_pair*)arg)->dest_wim;
246 wimlib_assert(!dentry->resolved);
248 for (unsigned i = 0; i < (unsigned)dentry->num_ads + 1; i++) {
249 struct lookup_table_entry *src_lte, *dest_lte;
250 src_lte = dentry_stream_lte_unresolved(dentry, i,
251 src_wim->lookup_table);
254 dest_lte = dentry_stream_lte_unresolved(dentry, i,
255 dest_wim->lookup_table);
259 dest_lte = new_lookup_table_entry();
261 return WIMLIB_ERR_NOMEM;
262 dest_lte->resource_location = RESOURCE_IN_WIM;
263 dest_lte->wim = src_wim;
264 memcpy(&dest_lte->resource_entry,
265 &src_lte->resource_entry,
266 sizeof(struct resource_entry));
267 copy_hash(dest_lte->hash,
268 dentry_stream_hash_unresolved(dentry, i));
269 lookup_table_insert(dest_wim->lookup_table, dest_lte);
276 * Adds an image (given by its dentry tree) to the image metadata array of a WIM
277 * file, adds an entry to the lookup table for the image metadata, updates the
278 * image count in the header, and selects the new image.
280 * Does not update the XML data.
282 * @w: The WIMStruct for the WIM file.
283 * @root_dentry: The root of the directory tree for the image.
285 static int add_new_dentry_tree(WIMStruct *w, struct dentry *root_dentry,
286 struct wim_security_data *sd)
288 struct lookup_table_entry *metadata_lte;
289 struct image_metadata *imd;
290 struct image_metadata *new_imd;
291 struct link_group_table *lgt;
293 DEBUG("Reallocating image metadata array for image_count = %u",
294 w->hdr.image_count + 1);
295 imd = CALLOC((w->hdr.image_count + 1), sizeof(struct image_metadata));
298 ERROR("Failed to allocate memory for new image metadata array");
299 return WIMLIB_ERR_NOMEM;
302 memcpy(imd, w->image_metadata,
303 w->hdr.image_count * sizeof(struct image_metadata));
305 metadata_lte = new_lookup_table_entry();
309 lgt = new_link_group_table(9001);
311 goto out_free_security_data;
313 metadata_lte->resource_entry.flags = WIM_RESHDR_FLAG_METADATA;
314 random_hash(metadata_lte->hash);
315 lookup_table_insert(w->lookup_table, metadata_lte);
317 new_imd = &imd[w->hdr.image_count];
319 new_imd->root_dentry = root_dentry;
320 new_imd->metadata_lte = metadata_lte;
321 new_imd->security_data = sd;
323 new_imd->modified = true;
325 FREE(w->image_metadata);
326 w->image_metadata = imd;
327 w->hdr.image_count++;
329 /* Change the current image to the new one. */
330 return wimlib_select_image(w, w->hdr.image_count);
331 out_free_security_data:
333 out_free_metadata_lte:
337 return WIMLIB_ERR_NOMEM;
342 * Copies an image, or all the images, from a WIM file, into another WIM file.
344 WIMLIBAPI int wimlib_export_image(WIMStruct *src_wim,
347 const char *dest_name,
348 const char *dest_description,
354 struct wim_pair wims;
355 struct wim_security_data *sd;
357 if (src_image == WIM_ALL_IMAGES) {
358 if (src_wim->hdr.image_count > 1) {
360 /* multi-image export. */
362 if ((flags & WIMLIB_EXPORT_FLAG_BOOT) &&
363 (src_wim->hdr.boot_idx == 0))
365 /* Specifying the boot flag on a multi-image
366 * source WIM makes the boot index default to
367 * the bootable image in the source WIM. It is
368 * an error if there is no such bootable image.
370 ERROR("Cannot specify `boot' flag when "
371 "exporting multiple images from a WIM "
372 "with no bootable images");
373 return WIMLIB_ERR_INVALID_PARAM;
375 if (dest_name || dest_description) {
376 ERROR("Image name or image description was "
377 "specified, but we are exporting "
379 return WIMLIB_ERR_INVALID_PARAM;
381 for (i = 1; i <= src_wim->hdr.image_count; i++) {
382 int export_flags = flags;
384 if (i != src_wim->hdr.boot_idx)
385 export_flags &= ~WIMLIB_EXPORT_FLAG_BOOT;
387 ret = wimlib_export_image(src_wim, i, dest_wim,
400 ret = wimlib_select_image(src_wim, src_image);
402 ERROR("Could not select image %d from the WIM `%s' "
403 "to export it", src_image, src_wim->filename);
408 dest_name = wimlib_get_image_name(src_wim, src_image);
409 DEBUG("Using name `%s' for source image %d",
410 dest_name, src_image);
413 DEBUG("Exporting image %d from `%s'", src_image, src_wim->filename);
415 if (wimlib_image_name_in_use(dest_wim, dest_name)) {
416 ERROR("There is already an image named `%s' in the "
417 "destination WIM", dest_name);
418 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
422 /* Cleaning up here on failure would be hard. For example, we could
423 * fail to allocate memory in add_lte_to_dest_wim(),
424 * leaving the lookup table entries in the destination WIM in an
425 * inconsistent state. Until these issues can be resolved,
426 * wimlib_export_image() is documented as leaving dest_wim is an
427 * indeterminate state. */
428 root = wim_root_dentry(src_wim);
429 sd = wim_security_data(src_wim);
430 for_dentry_in_tree(root, increment_dentry_refcnt, NULL);
431 wims.src_wim = src_wim;
432 wims.dest_wim = dest_wim;
433 ret = for_dentry_in_tree(root, add_lte_to_dest_wim, &wims);
436 ret = add_new_dentry_tree(dest_wim, root, sd);
441 if (flags & WIMLIB_EXPORT_FLAG_BOOT) {
442 DEBUG("Setting boot_idx to %d", dest_wim->hdr.image_count);
443 dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
446 return xml_export_image(src_wim->wim_info, src_image, &dest_wim->wim_info,
447 dest_name, dest_description);
451 * Deletes an image from the WIM.
453 WIMLIBAPI int wimlib_delete_image(WIMStruct *w, int image)
459 if (image == WIM_ALL_IMAGES) {
460 num_images = w->hdr.image_count;
461 for (i = 1; i <= num_images; i++) {
462 /* Always delete the first image, since by the end
463 * there won't be any more than that! */
464 ret = wimlib_delete_image(w, 1);
471 DEBUG("Deleting image %d", image);
473 /* Even if the dentry tree is not allocated, we must select it (and
474 * therefore allocate it) so that we can decrement the reference counts
475 * in the lookup table. */
476 ret = wimlib_select_image(w, image);
480 /* Free the dentry tree, any lookup table entries that have their
481 * refcnt decremented to 0, and the security data. */
482 destroy_image_metadata(wim_get_current_image_metadata(w),
485 /* Get rid of the empty slot in the image metadata array. */
486 memmove(&w->image_metadata[image - 1], &w->image_metadata[image],
487 (w->hdr.image_count - image) * sizeof(struct image_metadata));
489 /* Decrement the image count. */
490 if (--w->hdr.image_count == 0) {
491 FREE(w->image_metadata);
492 w->image_metadata = NULL;
495 /* Fix the boot index. */
496 if (w->hdr.boot_idx == image)
498 else if (w->hdr.boot_idx > image)
501 w->current_image = WIM_NO_IMAGE;
503 /* Remove the image from the XML information. */
504 xml_delete_image(&w->wim_info, image);
512 COMPRESSION_EXCLUSION_LIST,
516 static const char *default_config =
521 "\"\\System Volume Information\"\n"
525 "[CompressionExclusionList]\n"
529 "\\WINDOWS\\inf\\*.pnf\n";
531 static void destroy_pattern_list(struct pattern_list *list)
536 static void destroy_capture_config(struct capture_config *config)
538 destroy_pattern_list(&config->exclusion_list);
539 destroy_pattern_list(&config->exclusion_exception);
540 destroy_pattern_list(&config->compression_exclusion_list);
541 destroy_pattern_list(&config->alignment_list);
542 FREE(config->config_str);
543 FREE(config->prefix);
544 memset(config, 0, sizeof(*config));
547 static int pattern_list_add_pattern(struct pattern_list *list,
551 if (list->num_pats >= list->num_allocated_pats) {
552 pats = REALLOC(list->pats,
553 sizeof(list->pats[0]) * (list->num_allocated_pats + 8));
555 return WIMLIB_ERR_NOMEM;
556 list->num_allocated_pats += 8;
559 list->pats[list->num_pats++] = pattern;
563 static int init_capture_config(const char *_config_str, size_t config_len,
564 const char *_prefix, struct capture_config *config)
571 size_t next_bytes_remaining;
572 size_t bytes_remaining;
573 enum pattern_type type = NONE;
575 unsigned long line_no = 0;
577 DEBUG("config_len = %zu", config_len);
578 bytes_remaining = config_len;
579 memset(config, 0, sizeof(*config));
580 config_str = MALLOC(config_len);
582 ERROR("Could not duplicate capture config string");
583 return WIMLIB_ERR_NOMEM;
585 prefix = STRDUP(_prefix);
588 return WIMLIB_ERR_NOMEM;
591 memcpy(config_str, _config_str, config_len);
593 config->config_str = config_str;
594 config->prefix = prefix;
595 config->prefix_len = strlen(prefix);
596 while (bytes_remaining) {
599 eol = memchr(p, '\n', bytes_remaining);
601 ERROR("Expected end-of-line in capture config file on "
602 "line %lu", line_no);
603 ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
608 bytes_remaining -= (eol - p) + 1;
612 if (*(eol - 1) == '\r')
616 /* Translate backslash to forward slash */
617 for (char *pp = p; pp != eol; pp++)
621 /* Remove drive letter */
622 if (eol - p > 2 && isalpha(*p) && *(p + 1) == ':')
625 if (strcmp(p, "[ExclusionList]") == 0)
626 type = EXCLUSION_LIST;
627 else if (strcmp(p, "[ExclusionException]") == 0)
628 type = EXCLUSION_EXCEPTION;
629 else if (strcmp(p, "[CompressionExclusionList]") == 0)
630 type = COMPRESSION_EXCLUSION_LIST;
631 else if (strcmp(p, "[AlignmentList]") == 0)
632 type = ALIGNMENT_LIST;
635 DEBUG("Adding pattern \"%s\" to exclusion list", p);
636 ret = pattern_list_add_pattern(&config->exclusion_list, p);
638 case EXCLUSION_EXCEPTION:
639 DEBUG("Adding pattern \"%s\" to exclusion exception list", p);
640 ret = pattern_list_add_pattern(&config->exclusion_exception, p);
642 case COMPRESSION_EXCLUSION_LIST:
643 DEBUG("Adding pattern \"%s\" to compression exclusion list", p);
644 ret = pattern_list_add_pattern(&config->compression_exclusion_list, p);
647 DEBUG("Adding pattern \"%s\" to alignment list", p);
648 ret = pattern_list_add_pattern(&config->alignment_list, p);
651 ERROR("Line %lu of capture configuration is not "
652 "in a block (such as [ExclusionList])",
654 ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
662 destroy_capture_config(config);
666 static bool match_pattern(const char *path, const char *path_basename,
667 const struct pattern_list *list)
669 for (size_t i = 0; i < list->num_pats; i++) {
670 const char *pat = list->pats[i];
673 /* Absolute path from root of capture */
676 if (strchr(pat, '/'))
677 /* Relative path from root of capture */
680 /* A file name pattern */
681 string = path_basename;
683 if (fnmatch(pat, string, FNM_PATHNAME
689 DEBUG("`%s' matches the pattern \"%s\"",
697 static void print_pattern_list(const struct pattern_list *list)
699 for (size_t i = 0; i < list->num_pats; i++)
700 printf(" %s\n", list->pats[i]);
703 static void print_capture_config(const struct capture_config *config)
705 if (config->exclusion_list.num_pats) {
706 puts("Files or folders excluded from image capture:");
707 print_pattern_list(&config->exclusion_list);
712 bool exclude_path(const char *path, const struct capture_config *config,
715 const char *basename = path_basename(path);
716 if (exclude_prefix) {
717 wimlib_assert(strlen(path) >= config->prefix_len);
718 if (memcmp(config->prefix, path, config->prefix_len) == 0
719 && path[config->prefix_len] == '/')
720 path += config->prefix_len;
722 return match_pattern(path, basename, &config->exclusion_list) &&
723 !match_pattern(path, basename, &config->exclusion_exception);
729 int do_add_image(WIMStruct *w, const char *dir, const char *name,
730 const char *description, const char *flags_element,
731 const char *config_str, size_t config_len,
733 int (*capture_tree)(struct dentry **, const char *,
734 struct lookup_table *,
735 struct wim_security_data *,
736 const struct capture_config *,
740 struct dentry *root_dentry = NULL;
741 struct image_metadata *imd;
742 struct wim_security_data *sd;
743 struct capture_config config;
746 DEBUG("Adding dentry tree from dir `%s'.", dir);
748 if (!name || !*name) {
749 ERROR("Must specify a non-empty string for the image name");
750 return WIMLIB_ERR_INVALID_PARAM;
753 ERROR("Must specify the name of a directory");
754 return WIMLIB_ERR_INVALID_PARAM;
757 if (wimlib_image_name_in_use(w, name)) {
758 ERROR("There is already an image named \"%s\" in `%s'",
760 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
763 DEBUG("Initializing capture configuration");
765 DEBUG("Using default capture configuration");
766 config_str = default_config;
767 config_len = strlen(default_config);
769 ret = init_capture_config(config_str, config_len, dir, &config);
772 print_capture_config(&config);
774 DEBUG("Allocating security data");
776 sd = CALLOC(1, sizeof(struct wim_security_data));
778 goto out_destroy_config;
779 sd->total_length = 8;
782 DEBUG("Building dentry tree.");
783 ret = (*capture_tree)(&root_dentry, dir, w->lookup_table, sd,
784 &config, flags | WIMLIB_ADD_IMAGE_FLAG_ROOT,
786 destroy_capture_config(&config);
789 ERROR("Failed to build dentry tree for `%s'", dir);
790 goto out_free_dentry_tree;
793 DEBUG("Calculating full paths of dentries.");
794 ret = for_dentry_in_tree(root_dentry, calculate_dentry_full_path, NULL);
796 goto out_free_dentry_tree;
798 ret = add_new_dentry_tree(w, root_dentry, sd);
800 goto out_free_dentry_tree;
802 DEBUG("Inserting dentries into hard link group table");
803 ret = for_dentry_in_tree(root_dentry, link_group_table_insert,
804 w->image_metadata[w->hdr.image_count - 1].lgt);
806 goto out_destroy_imd;
807 DEBUG("Assigning hard link groups");
808 assign_link_groups(w->image_metadata[w->hdr.image_count - 1].lgt);
810 if (flags & WIMLIB_ADD_IMAGE_FLAG_BOOT)
811 wimlib_set_boot_idx(w, w->hdr.image_count);
813 ret = xml_add_image(w, root_dentry, name, description, flags_element);
815 goto out_destroy_imd;
819 destroy_image_metadata(&w->image_metadata[w->hdr.image_count - 1],
821 w->hdr.image_count--;
823 out_free_dentry_tree:
824 free_dentry_tree(root_dentry, w->lookup_table);
826 free_security_data(sd);
828 destroy_capture_config(&config);
833 * Adds an image to a WIM file from a directory tree on disk.
835 WIMLIBAPI int wimlib_add_image(WIMStruct *w, const char *dir,
836 const char *name, const char *description,
837 const char *flags_element,
838 const char *config_str,
839 size_t config_len, int flags)
841 return do_add_image(w, dir, name, description, flags_element,
842 config_str, config_len, flags,
843 build_dentry_tree, NULL);