X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fmodify.c;h=d5553dc8a2ba1838608f0df89fa2d897724a84fe;hp=2ad0357602134deea224fc7579aebaf7421d1fdc;hb=942bf22cf6306daf53df4b59ec589f8e294a57d0;hpb=6f77434ea6ff1407603410e28d1edb966c40e568 diff --git a/src/modify.c b/src/modify.c index 2ad03576..d5553dc8 100644 --- a/src/modify.c +++ b/src/modify.c @@ -2,7 +2,7 @@ * modify.c * * Support for modifying WIM files with image-level operations (delete an image, - * add an image, export an imagex from one WIM to another.) There is nothing + * add an image, export an image from one WIM to another.) There is nothing * here that lets you change individual files in the WIM; for that you will need * to look at the filesystem implementation in mount.c. */ @@ -13,16 +13,16 @@ * This file is part of wimlib, a library for working with WIM files. * * wimlib is free software; you can redistribute it and/or modify it under the - * terms of the GNU Lesser General Public License as published by the Free - * Software Foundation; either version 2.1 of the License, or (at your option) + * terms of the GNU General Public License as published by the Free + * Software Foundation; either version 3 of the License, or (at your option) * any later version. * * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more + * A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * - * You should have received a copy of the GNU Lesser General Public License + * You should have received a copy of the GNU General Public License * along with wimlib; if not, see http://www.gnu.org/licenses/. */ @@ -32,169 +32,393 @@ #include "dentry.h" #include "xml.h" #include "lookup_table.h" +#include "timestamp.h" #include #include #include #include +#include +#include +#include -/* +/** Private flag: Used to mark that we currently adding the root directory of + * the WIM image. */ +#define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000 + +void destroy_image_metadata(struct image_metadata *imd, + struct lookup_table *table) +{ + free_dentry_tree(imd->root_dentry, table); + free_security_data(imd->security_data); + + /* Get rid of the lookup table entry for this image's metadata resource + * */ + if (table) { + lookup_table_unlink(table, imd->metadata_lte); + free_lookup_table_entry(imd->metadata_lte); + } +} + +/* * Recursively builds a dentry tree from a directory tree on disk, outside the * WIM file. * - * @root: A dentry that has already been created for the root of the dentry - * tree. - * @source_path: The path to the root of the tree on disk. - * @root_stat: A pointer to a `struct stat' that contains the metadata for the - * root of the tree on disk. + * @root_ret: Place to return a pointer to the root of the dentry tree. Only + * modified if successful. NULL if the file or directory was + * excluded from capture. + * + * @root_disk_path: The path to the root of the directory tree on disk. + * * @lookup_table: The lookup table for the WIM file. For each file added to the - * dentry tree being built, an entry is added to the lookup table, - * unless an identical file is already in the lookup table. These - * lookup table entries that are added point to the file on disk. + * dentry tree being built, an entry is added to the lookup table, + * unless an identical stream is already in the lookup table. + * These lookup table entries that are added point to the path of + * the file on disk. + * + * @sd: Ignored. (Security data only captured in NTFS mode.) + * + * @capture_config: + * Configuration for files to be excluded from capture. + * + * @add_flags: Bitwise or of WIMLIB_ADD_IMAGE_FLAG_* + * + * @extra_arg: Ignored. (Only used in NTFS mode.) * * @return: 0 on success, nonzero on failure. It is a failure if any of * the files cannot be `stat'ed, or if any of the needed * directories cannot be opened or read. Failure to add the files - * to the WIM may still occur later when trying to actually read - * the regular files in the tree into the WIM as file resources. + * to the WIM may still occur later when trying to actually read + * the on-disk files during a call to wimlib_write() or + * wimlib_overwrite(). */ -static int build_dentry_tree(struct dentry *root, const char *source_path, - struct stat *root_stat, struct lookup_table* lookup_table) +static int build_dentry_tree(struct dentry **root_ret, + const char *root_disk_path, + struct lookup_table *lookup_table, + struct wim_security_data *sd, + const struct capture_config *config, + int add_image_flags, + wimlib_progress_func_t progress_func, + void *extra_arg) { + struct stat root_stbuf; int ret = 0; + int (*stat_fn)(const char *restrict, struct stat *restrict); + struct dentry *root; + const char *filename; + struct inode *inode; + + if (exclude_path(root_disk_path, config, true)) { + if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) { + ERROR("Cannot exclude the root directory from capture"); + return WIMLIB_ERR_INVALID_CAPTURE_CONFIG; + } + if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE) + && progress_func) + { + union wimlib_progress_info info; + info.scan.cur_path = root_disk_path; + info.scan.excluded = true; + progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info); + } + *root_ret = NULL; + return 0; + } + + if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE) + && progress_func) + { + union wimlib_progress_info info; + info.scan.cur_path = root_disk_path; + info.scan.excluded = false; + progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info); + } + + if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE) + stat_fn = stat; + else + stat_fn = lstat; + + ret = (*stat_fn)(root_disk_path, &root_stbuf); + if (ret != 0) { + ERROR_WITH_ERRNO("Failed to stat `%s'", root_disk_path); + return WIMLIB_ERR_STAT; + } + + if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) && + !S_ISDIR(root_stbuf.st_mode)) { + ERROR("`%s' is not a directory", root_disk_path); + return WIMLIB_ERR_NOTDIR; + } + if (!S_ISREG(root_stbuf.st_mode) && !S_ISDIR(root_stbuf.st_mode) + && !S_ISLNK(root_stbuf.st_mode)) { + ERROR("`%s' is not a regular file, directory, or symbolic link.", + root_disk_path); + return WIMLIB_ERR_SPECIAL_FILE; + } + + if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) + filename = ""; + else + filename = path_basename(root_disk_path); + + root = new_dentry_with_timeless_inode(filename); + if (!root) + return WIMLIB_ERR_NOMEM; + + inode = root->d_inode; + +#ifdef HAVE_STAT_NANOSECOND_PRECISION + inode->creation_time = timespec_to_wim_timestamp(&root_stbuf.st_mtim); + inode->last_write_time = timespec_to_wim_timestamp(&root_stbuf.st_mtim); + inode->last_access_time = timespec_to_wim_timestamp(&root_stbuf.st_atim); +#else + inode->creation_time = unix_timestamp_to_wim(root_stbuf.st_mtime); + inode->last_write_time = unix_timestamp_to_wim(root_stbuf.st_mtime); + inode->last_access_time = unix_timestamp_to_wim(root_stbuf.st_atime); +#endif + if (sizeof(ino_t) >= 8) + inode->ino = (u64)root_stbuf.st_ino; + else + inode->ino = (u64)root_stbuf.st_ino | + ((u64)root_stbuf.st_dev << ((sizeof(ino_t) * 8) & 63)); + + add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_ROOT; + inode->resolved = true; + + if (S_ISREG(root_stbuf.st_mode)) { /* Archiving a regular file */ + + struct lookup_table_entry *lte; + u8 hash[SHA1_HASH_SIZE]; + + inode->attributes = FILE_ATTRIBUTE_NORMAL; + + /* Empty files do not have to have a lookup table entry. */ + if (root_stbuf.st_size == 0) + goto out; + + /* For each regular file, we must check to see if the file is in + * the lookup table already; if it is, we increment its refcnt; + * otherwise, we create a new lookup table entry and insert it. + * */ + + ret = sha1sum(root_disk_path, hash); + if (ret != 0) + goto out; + + lte = __lookup_resource(lookup_table, hash); + if (lte) { + lte->refcnt++; + DEBUG("Add lte reference %u for `%s'", lte->refcnt, + root_disk_path); + } else { + char *file_on_disk = STRDUP(root_disk_path); + if (!file_on_disk) { + ERROR("Failed to allocate memory for file path"); + ret = WIMLIB_ERR_NOMEM; + goto out; + } + lte = new_lookup_table_entry(); + if (!lte) { + FREE(file_on_disk); + ret = WIMLIB_ERR_NOMEM; + goto out; + } + lte->file_on_disk = file_on_disk; + lte->resource_location = RESOURCE_IN_FILE_ON_DISK; + lte->resource_entry.original_size = root_stbuf.st_size; + lte->resource_entry.size = root_stbuf.st_size; + copy_hash(lte->hash, hash); + lookup_table_insert(lookup_table, lte); + } + root->d_inode->lte = lte; + } else if (S_ISDIR(root_stbuf.st_mode)) { /* Archiving a directory */ + + inode->attributes = FILE_ATTRIBUTE_DIRECTORY; - stbuf_to_dentry(root_stat, root); - if (dentry_is_directory(root)) { - /* Open the directory on disk */ DIR *dir; - struct dirent *p; - struct stat child_stat; + struct dirent entry, *result; struct dentry *child; - dir = opendir(source_path); + dir = opendir(root_disk_path); if (!dir) { - ERROR("Failed to open the directory `%s': %m\n", - source_path); - return WIMLIB_ERR_OPEN; + ERROR_WITH_ERRNO("Failed to open the directory `%s'", + root_disk_path); + ret = WIMLIB_ERR_OPEN; + goto out; } /* Buffer for names of files in directory. */ - size_t len = strlen(source_path); + size_t len = strlen(root_disk_path); char name[len + 1 + FILENAME_MAX + 1]; - memcpy(name, source_path, len); + memcpy(name, root_disk_path, len); name[len] = '/'; - errno = 0; /* Create a dentry for each entry in the directory on disk, and recurse * to any subdirectories. */ - while ((p = readdir(dir)) != NULL) { - if (p->d_name[0] == '.' && (p->d_name[1] == '\0' - || (p->d_name[1] == '.' && p->d_name[2] == '\0'))) - continue; - strcpy(name + len + 1, p->d_name); - if (stat(name, &child_stat) != 0) { - ERROR("cannot stat `%s': %m\n", name); - ret = WIMLIB_ERR_STAT; + while (1) { + errno = 0; + ret = readdir_r(dir, &entry, &result); + if (ret != 0) { + ret = WIMLIB_ERR_READ; + ERROR_WITH_ERRNO("Error reading the " + "directory `%s'", + root_disk_path); break; } - child = new_dentry(p->d_name); - ret = build_dentry_tree(child, name, &child_stat, - lookup_table); + if (result == NULL) + break; + if (result->d_name[0] == '.' && (result->d_name[1] == '\0' + || (result->d_name[1] == '.' && result->d_name[2] == '\0'))) + continue; + strcpy(name + len + 1, result->d_name); + ret = build_dentry_tree(&child, name, lookup_table, + NULL, config, add_image_flags, + progress_func, NULL); if (ret != 0) break; - link_dentry(child, root); + if (child) + dentry_add_child(root, child); } closedir(dir); - } else { - struct lookup_table_entry *lte; + } else { /* Archiving a symbolic link */ + inode->attributes = FILE_ATTRIBUTE_REPARSE_POINT; + inode->reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK; - /* For each non-directory, we must check to see if the file is - * in the lookup table already; if it is, we increment its - * refcnt; otherwise, we create a new lookup table entry and - * insert it. */ - ret = sha1sum(source_path, root->hash); - if (ret != 0) { - ERROR("Failed to calculate sha1sum for file `%s'\n", - source_path); - return ret; - } + /* The idea here is to call readlink() to get the UNIX target of + * the symbolic link, then turn the target into a reparse point + * data buffer that contains a relative or absolute symbolic + * link (NOT a junction point or *full* path symbolic link with + * drive letter). + */ - lte = lookup_resource(lookup_table, root->hash); - if (lte) { - lte->refcnt++; - } else { - char *file_on_disk = STRDUP(source_path); - if (!file_on_disk) { - ERROR("Failed to allocate memory for file " - "path!\n"); - return WIMLIB_ERR_NOMEM; - } - lte = new_lookup_table_entry(); - if (!lte) { - ERROR("Failed to allocate memory for new " - "lookup table entry!\n"); - FREE(file_on_disk); - return WIMLIB_ERR_NOMEM; + char deref_name_buf[4096]; + ssize_t deref_name_len; + + deref_name_len = readlink(root_disk_path, deref_name_buf, + sizeof(deref_name_buf) - 1); + if (deref_name_len >= 0) { + deref_name_buf[deref_name_len] = '\0'; + DEBUG("Read symlink `%s'", deref_name_buf); + ret = inode_set_symlink(root->d_inode, deref_name_buf, + lookup_table, NULL); + if (ret == 0) { + /* + * Unfortunately, Windows seems to have the + * concept of "file" symbolic links as being + * different from "directory" symbolic links... + * so FILE_ATTRIBUTE_DIRECTORY needs to be set + * on the symbolic link if the *target* of the + * symbolic link is a directory. + */ + struct stat stbuf; + if (stat(root_disk_path, &stbuf) == 0 && + S_ISDIR(stbuf.st_mode)) + { + inode->attributes |= FILE_ATTRIBUTE_DIRECTORY; + } } - lte->file_on_disk = file_on_disk; - lte->resource_entry.flags = 0; - lte->refcnt = 1; - lte->part_number = 1; - lte->resource_entry.original_size = root_stat->st_size; - lte->resource_entry.size = root_stat->st_size; - memcpy(lte->hash, root->hash, WIM_HASH_SIZE); - lookup_table_insert(lookup_table, lte); + } else { + ERROR_WITH_ERRNO("Failed to read target of " + "symbolic link `%s'", root_disk_path); + ret = WIMLIB_ERR_READLINK; } } +out: + if (ret == 0) + *root_ret = root; + else + free_dentry_tree(root, lookup_table); return ret; } struct wim_pair { WIMStruct *src_wim; WIMStruct *dest_wim; + struct list_head lte_list_head; }; -/* +static int allocate_lte_if_needed(struct dentry *dentry, void *arg) +{ + const WIMStruct *src_wim, *dest_wim; + struct list_head *lte_list_head; + struct inode *inode; + + src_wim = ((struct wim_pair*)arg)->src_wim; + dest_wim = ((struct wim_pair*)arg)->dest_wim; + lte_list_head = &((struct wim_pair*)arg)->lte_list_head; + inode = dentry->d_inode; + + wimlib_assert(!inode->resolved); + + for (unsigned i = 0; i <= inode->num_ads; i++) { + struct lookup_table_entry *src_lte, *dest_lte; + src_lte = inode_stream_lte_unresolved(inode, i, + src_wim->lookup_table); + + if (src_lte && ++src_lte->out_refcnt == 1) { + dest_lte = inode_stream_lte_unresolved(inode, i, + dest_wim->lookup_table); + + if (!dest_lte) { + dest_lte = clone_lookup_table_entry(src_lte); + if (!dest_lte) + return WIMLIB_ERR_NOMEM; + list_add_tail(&dest_lte->staging_list, lte_list_head); + } + } + } + return 0; +} + +/* * This function takes in a dentry that was previously located only in image(s) - * in @src_wim, but now is being added to @dest_wim. If there is in fact already a - * lookup table entry for this file in the lookup table of the destination WIM - * file, we simply increment its reference count. Otherwise, a new lookup table - * entry is created that references the location of the file resource in the - * source WIM file through the other_wim_fp field of the lookup table entry. + * in @src_wim, but now is being added to @dest_wim. For each stream associated + * with the dentry, if there is already a lookup table entry for that stream in + * the lookup table of the destination WIM file, its reference count is + * incrementej. Otherwise, a new lookup table entry is created that points back + * to the stream in the source WIM file (through the @hash field combined with + * the @wim field of the lookup table entry.) */ -static int add_lookup_table_entry_to_dest_wim(struct dentry *dentry, void *arg) +static int add_lte_to_dest_wim(struct dentry *dentry, void *arg) { WIMStruct *src_wim, *dest_wim; - struct lookup_table_entry *src_table_entry; - struct lookup_table_entry *dest_table_entry; + struct inode *inode; src_wim = ((struct wim_pair*)arg)->src_wim; dest_wim = ((struct wim_pair*)arg)->dest_wim; + inode = dentry->d_inode; - if (dentry_is_directory(dentry)) - return 0; + wimlib_assert(!inode->resolved); - src_table_entry = wim_lookup_resource(src_wim, dentry); - if (!src_table_entry) - return 0; + for (unsigned i = 0; i <= inode->num_ads; i++) { + struct lookup_table_entry *src_lte, *dest_lte; + src_lte = inode_stream_lte_unresolved(inode, i, + src_wim->lookup_table); - dest_table_entry = wim_lookup_resource(dest_wim, dentry); - if (dest_table_entry) { - dest_table_entry->refcnt++; - } else { - dest_table_entry = new_lookup_table_entry(); - if (!dest_table_entry) { - ERROR("Could not allocate lookup table entry!\n"); - return WIMLIB_ERR_NOMEM; + if (!src_lte) /* Empty or nonexistent stream. */ + continue; + + dest_lte = inode_stream_lte_unresolved(inode, i, + dest_wim->lookup_table); + if (dest_lte) { + dest_lte->refcnt++; + } else { + struct list_head *lte_list_head; + struct list_head *next; + + lte_list_head = &((struct wim_pair*)arg)->lte_list_head; + wimlib_assert(!list_empty(lte_list_head)); + + next = lte_list_head->next; + list_del(next); + dest_lte = container_of(next, struct lookup_table_entry, + staging_list); + dest_lte->part_number = 1; + dest_lte->refcnt = 1; + wimlib_assert(hashes_equal(dest_lte->hash, src_lte->hash)); + + lookup_table_insert(dest_wim->lookup_table, dest_lte); } - dest_table_entry->other_wim_fp = src_wim->fp; - dest_table_entry->other_wim_ctype = - wimlib_get_compression_type(src_wim); - dest_table_entry->refcnt = 1; - memcpy(&dest_table_entry->resource_entry, - &src_table_entry->resource_entry, - sizeof(struct resource_entry)); - memcpy(dest_table_entry->hash, dentry->hash, WIM_HASH_SIZE); - lookup_table_insert(dest_wim->lookup_table, dest_table_entry); } return 0; } @@ -202,216 +426,343 @@ static int add_lookup_table_entry_to_dest_wim(struct dentry *dentry, void *arg) /* * Adds an image (given by its dentry tree) to the image metadata array of a WIM * file, adds an entry to the lookup table for the image metadata, updates the - * image count in the header, and selects the new image. + * image count in the header, and selects the new image. * * Does not update the XML data. * + * On failure, WIMLIB_ERR_NOMEM is returned and no changes are made. Otherwise, + * 0 is returned and the image metadata array of @w is modified. + * * @w: The WIMStruct for the WIM file. * @root_dentry: The root of the directory tree for the image. + * @sd: The security data for the image. */ -static int add_new_dentry_tree(WIMStruct *w, struct dentry *root_dentry) +static int add_new_dentry_tree(WIMStruct *w, struct dentry *root_dentry, + struct wim_security_data *sd) { - struct lookup_table_entry *imd_lookup_entry; + struct lookup_table_entry *metadata_lte; struct image_metadata *imd; struct image_metadata *new_imd; + int ret; + + wimlib_assert(root_dentry != NULL); - DEBUG("Reallocing image metadata array for image_count = %u\n", - w->hdr.image_count + 1); + DEBUG("Reallocating image metadata array for image_count = %u", + w->hdr.image_count + 1); imd = CALLOC((w->hdr.image_count + 1), sizeof(struct image_metadata)); if (!imd) { - ERROR("Failed to allocate memory for new image metadata " - "array!\n"); - return WIMLIB_ERR_NOMEM; + ERROR("Failed to allocate memory for new image metadata array"); + goto err; } - memcpy(imd, w->image_metadata, + memcpy(imd, w->image_metadata, w->hdr.image_count * sizeof(struct image_metadata)); - - imd_lookup_entry = new_lookup_table_entry(); - if (!imd_lookup_entry) { - ERROR("Failed to allocate new lookup table entry!\n"); - FREE(imd); - return WIMLIB_ERR_NOMEM; - } - imd_lookup_entry->resource_entry.flags = WIM_RESHDR_FLAG_METADATA; - randomize_byte_array(imd_lookup_entry->hash, WIM_HASH_SIZE); - lookup_table_insert(w->lookup_table, imd_lookup_entry); + metadata_lte = new_lookup_table_entry(); + if (!metadata_lte) + goto err_free_imd; + + metadata_lte->resource_entry.flags = WIM_RESHDR_FLAG_METADATA; + random_hash(metadata_lte->hash); + lookup_table_insert(w->lookup_table, metadata_lte); + + new_imd = &imd[w->hdr.image_count]; + + new_imd->root_dentry = root_dentry; + new_imd->metadata_lte = metadata_lte; + new_imd->security_data = sd; + new_imd->modified = true; + FREE(w->image_metadata); + w->image_metadata = imd; w->hdr.image_count++; - new_imd = &imd[w->hdr.image_count - 1]; - new_imd->lookup_table_entry = imd_lookup_entry; - new_imd->modified = true; - new_imd->root_dentry = root_dentry; - w->image_metadata = imd; + /* Change the current image to the new one. There should not be any + * ways for this to fail, since the image is valid and the dentry tree + * is already in memory. */ + ret = select_wim_image(w, w->hdr.image_count); + wimlib_assert(ret == 0); + return ret; +err_free_imd: + FREE(imd); +err: + return WIMLIB_ERR_NOMEM; - /* Change the current image to the new one. */ - return wimlib_select_image(w, w->hdr.image_count); } /* * Copies an image, or all the images, from a WIM file, into another WIM file. */ -WIMLIBAPI int wimlib_export_image(WIMStruct *src_wim, - int src_image, - WIMStruct *dest_wim, - const char *dest_name, - const char *dest_description, - int flags) +WIMLIBAPI int wimlib_export_image(WIMStruct *src_wim, + int src_image, + WIMStruct *dest_wim, + const char *dest_name, + const char *dest_description, + int export_flags, + WIMStruct **additional_swms, + unsigned num_additional_swms, + wimlib_progress_func_t progress_func) { - int boot_idx; int i; int ret; struct dentry *root; struct wim_pair wims; + struct wim_security_data *sd; + struct lookup_table *joined_tab, *src_wim_tab_save; + + if (dest_wim->hdr.total_parts != 1) { + ERROR("Exporting an image to a split WIM is " + "unsupported"); + return WIMLIB_ERR_SPLIT_UNSUPPORTED; + } - if (src_image == WIM_ALL_IMAGES) { + if (src_image == WIMLIB_ALL_IMAGES) { if (src_wim->hdr.image_count > 1) { /* multi-image export. */ - if (flags & WIMLIB_EXPORT_FLAG_BOOT) { - + if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) && + (src_wim->hdr.boot_idx == 0)) + { /* Specifying the boot flag on a multi-image * source WIM makes the boot index default to * the bootable image in the source WIM. It is * an error if there is no such bootable image. * */ - - if (src_wim->hdr.boot_idx == 0) { - ERROR("Cannot specify `boot' flag " - "when exporting multiple " - "images from a WIM with no " - "bootable images!\n"); - return WIMLIB_ERR_INVALID_PARAM; - } else { - boot_idx = src_wim->hdr.boot_idx; - } + ERROR("Cannot specify `boot' flag when " + "exporting multiple images from a WIM " + "with no bootable images"); + return WIMLIB_ERR_INVALID_PARAM; } if (dest_name || dest_description) { - ERROR("Image name or image description " - "was specified, but we are exporting " - "multiple images!\n"); + ERROR("Image name or image description was " + "specified, but we are exporting " + "multiple images"); return WIMLIB_ERR_INVALID_PARAM; } for (i = 1; i <= src_wim->hdr.image_count; i++) { - int export_flags = flags; + int new_flags = export_flags; - if (i != boot_idx) - export_flags &= ~WIMLIB_EXPORT_FLAG_BOOT; + if (i != src_wim->hdr.boot_idx) + new_flags &= ~WIMLIB_EXPORT_FLAG_BOOT; - ret = wimlib_export_image(src_wim, i, dest_wim, - NULL, dest_description, - export_flags); + ret = wimlib_export_image(src_wim, i, dest_wim, + NULL, NULL, + new_flags, + additional_swms, + num_additional_swms, + progress_func); if (ret != 0) return ret; } return 0; + } else if (src_wim->hdr.image_count == 1) { + src_image = 1; } else { - src_image = 1; + return 0; } } - ret = wimlib_select_image(src_wim, src_image); - if (ret != 0) { - ERROR("Could not select image %d from the WIM `%s' " - "to export it!\n", src_image, src_wim->filename); - return ret; - } - if (!dest_name) { dest_name = wimlib_get_image_name(src_wim, src_image); - DEBUG("Using name `%s' for source image %d\n", - dest_name, src_image); + DEBUG("Using name `%s' for source image %d", + dest_name, src_image); + } + + if (!dest_description) { + dest_description = wimlib_get_image_description(src_wim, + src_image); + DEBUG("Using description `%s' for source image %d", + dest_description, src_image); } - DEBUG("Exporting image %d from `%s'\n", src_image, src_wim->filename); + DEBUG("Exporting image %d from `%s'", src_image, src_wim->filename); if (wimlib_image_name_in_use(dest_wim, dest_name)) { - ERROR("There is already an image named `%s' " - "in the destination WIM!\n", dest_name); + ERROR("There is already an image named `%s' in the " + "destination WIM", dest_name); return WIMLIB_ERR_IMAGE_NAME_COLLISION; } + ret = verify_swm_set(src_wim, additional_swms, num_additional_swms); + if (ret != 0) + return ret; - root = wim_root_dentry(src_wim); - for_dentry_in_tree(root, increment_dentry_refcnt, NULL); + if (num_additional_swms) { + ret = new_joined_lookup_table(src_wim, additional_swms, + num_additional_swms, + &joined_tab); + if (ret != 0) + return ret; + src_wim_tab_save = src_wim->lookup_table; + src_wim->lookup_table = joined_tab; + } + + ret = select_wim_image(src_wim, src_image); + if (ret != 0) { + ERROR("Could not select image %d from the WIM `%s' " + "to export it", src_image, src_wim->filename); + goto out; + } + + /* Pre-allocate the new lookup table entries that will be needed. This + * way, it's not possible to run out of memory part-way through + * modifying the lookup table of the destination WIM. */ wims.src_wim = src_wim; wims.dest_wim = dest_wim; - for_dentry_in_tree(root, add_lookup_table_entry_to_dest_wim, &wims); - ret = add_new_dentry_tree(dest_wim, root); -#ifdef ENABLE_SECURITY_DATA - struct wim_security_data *sd = wim_security_data(src_wim); - struct image_metadata *new_imd = wim_get_current_image_metadata(dest_wim); - new_imd->security_data = sd; - if (sd) - sd->refcnt++; -#endif + INIT_LIST_HEAD(&wims.lte_list_head); + for_lookup_table_entry(src_wim->lookup_table, lte_zero_out_refcnt, NULL); + root = wim_root_dentry(src_wim); + for_dentry_in_tree(root, dentry_unresolve_ltes, NULL); + ret = for_dentry_in_tree(root, allocate_lte_if_needed, &wims); if (ret != 0) - return ret; + goto out_free_ltes; + + ret = xml_export_image(src_wim->wim_info, src_image, + &dest_wim->wim_info, dest_name, dest_description); + if (ret != 0) + goto out_free_ltes; + + sd = wim_security_data(src_wim); + ret = add_new_dentry_tree(dest_wim, root, sd); + if (ret != 0) + goto out_xml_delete_image; + + + /* All memory allocations have been taken care of, so it's no longer + * possible for this function to fail. Go ahead and increment the + * reference counts of the dentry tree and security data, then update + * the lookup table of the destination WIM and the boot index, if + * needed. */ + for_dentry_in_tree(root, increment_dentry_refcnt, NULL); + sd->refcnt++; + for_dentry_in_tree(root, add_lte_to_dest_wim, &wims); + wimlib_assert(list_empty(&wims.lte_list_head)); + + if (export_flags & WIMLIB_EXPORT_FLAG_BOOT) { + DEBUG("Setting boot_idx to %d", dest_wim->hdr.image_count); + wimlib_set_boot_idx(dest_wim, dest_wim->hdr.image_count); + } + ret = 0; + goto out; - if (flags & WIMLIB_EXPORT_FLAG_BOOT) { - DEBUG("Setting boot_idx to %d\n", dest_wim->hdr.image_count); - dest_wim->hdr.boot_idx = dest_wim->hdr.image_count; +out_xml_delete_image: + xml_delete_image(&dest_wim->wim_info, dest_wim->hdr.image_count); +out_free_ltes: + { + struct lookup_table_entry *lte, *tmp; + list_for_each_entry_safe(lte, tmp, &wims.lte_list_head, staging_list) + free_lookup_table_entry(lte); } - return xml_export_image(src_wim->wim_info, src_image, &dest_wim->wim_info, - dest_name, dest_description); +out: + if (num_additional_swms) { + free_lookup_table(src_wim->lookup_table); + src_wim->lookup_table = src_wim_tab_save; + } + return ret; } -/* - * Deletes an image from the WIM. +static int image_run_full_verifications(WIMStruct *w) +{ + return for_dentry_in_tree(wim_root_dentry(w), verify_dentry, w); +} + +static int lte_fix_refcnt(struct lookup_table_entry *lte, void *ctr) +{ + if (lte->refcnt != lte->real_refcnt) { + WARNING("The following lookup table entry has a reference " + "count of %u, but", lte->refcnt); + WARNING("We found %u references to it", + lte->real_refcnt); + print_lookup_table_entry(lte); + lte->refcnt = lte->real_refcnt; + ++*(unsigned long *)ctr; + } + return 0; +} + +/* Ideally this would be unnecessary... however, the WIMs for Windows 8 are + * screwed up because some lookup table entries are referenced more times than + * their stated reference counts. So theoretically, if we do the delete all the + * references to a stream and then remove it, it might still be referenced + * somewhere else... So, work around this problem by looking at ALL the images + * to re-calculate the reference count of EVERY lookup table entry. */ +int wim_run_full_verifications(WIMStruct *w) +{ + int ret; + + for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL); + w->all_images_verified = true; + w->full_verification_in_progress = true; + ret = for_image(w, WIMLIB_ALL_IMAGES, image_run_full_verifications); + w->full_verification_in_progress = false; + if (ret == 0) { + unsigned long num_ltes_with_bogus_refcnt = 0; + for (int i = 0; i < w->hdr.image_count; i++) + w->image_metadata[i].metadata_lte->real_refcnt++; + for_lookup_table_entry(w->lookup_table, lte_fix_refcnt, + &num_ltes_with_bogus_refcnt); + if (num_ltes_with_bogus_refcnt != 0) { + WARNING("A total of %lu entries in the WIM's stream " + "lookup table had to have\n" + " their reference counts fixed.", + num_ltes_with_bogus_refcnt); + } + } else { + w->all_images_verified = false; + } + return ret; +} + +/* + * Deletes an image from the WIM. */ WIMLIBAPI int wimlib_delete_image(WIMStruct *w, int image) { - int num_images; int i; int ret; - struct image_metadata *imd; - if (image == WIM_ALL_IMAGES) { - num_images = w->hdr.image_count; - for (i = 1; i <= num_images; i++) { - /* Always delete the first image, since by the end - * there won't be any more than that! */ - ret = wimlib_delete_image(w, 1); + if (w->hdr.total_parts != 1) { + ERROR("Deleting an image from a split WIM is not supported."); + return WIMLIB_ERR_SPLIT_UNSUPPORTED; + } + + if (image == WIMLIB_ALL_IMAGES) { + for (i = w->hdr.image_count; i >= 1; i--) { + ret = wimlib_delete_image(w, i); if (ret != 0) return ret; } return 0; } - DEBUG("Deleting image %d\n", image); + if (!w->all_images_verified) { + ret = wim_run_full_verifications(w); + if (ret != 0) + return ret; + } + + DEBUG("Deleting image %d", image); /* Even if the dentry tree is not allocated, we must select it (and * therefore allocate it) so that we can decrement the reference counts * in the lookup table. */ - ret = wimlib_select_image(w, image); + ret = select_wim_image(w, image); if (ret != 0) return ret; /* Free the dentry tree, any lookup table entries that have their * refcnt decremented to 0, and the security data. */ - imd = wim_get_current_image_metadata(w); - free_dentry_tree(imd->root_dentry, w->lookup_table, true); -#ifdef ENABLE_SECURITY_DATA - free_security_data(imd->security_data); -#endif - - /* Get rid of the lookup table entry for this image's metadata resource - * */ - lookup_table_remove(w->lookup_table, imd->lookup_table_entry); + destroy_image_metadata(&w->image_metadata[image - 1], w->lookup_table); /* Get rid of the empty slot in the image metadata array. */ - for (i = image - 1; i < w->hdr.image_count - 1; i++) - memcpy(&w->image_metadata[i], &w->image_metadata[i + 1], - sizeof(struct image_metadata)); + memmove(&w->image_metadata[image - 1], &w->image_metadata[image], + (w->hdr.image_count - image) * sizeof(struct image_metadata)); /* Decrement the image count. */ - w->hdr.image_count--; - if (w->hdr.image_count == 0) { + if (--w->hdr.image_count == 0) { FREE(w->image_metadata); w->image_metadata = NULL; } @@ -422,92 +773,394 @@ WIMLIBAPI int wimlib_delete_image(WIMStruct *w, int image) else if (w->hdr.boot_idx > image) w->hdr.boot_idx--; - w->current_image = WIM_NO_IMAGE; + w->current_image = WIMLIB_NO_IMAGE; /* Remove the image from the XML information. */ xml_delete_image(&w->wim_info, image); + + w->deletion_occurred = true; return 0; } -/* - * Adds an image to a WIM file from a directory tree on disk. +enum pattern_type { + NONE = 0, + EXCLUSION_LIST, + EXCLUSION_EXCEPTION, + COMPRESSION_EXCLUSION_LIST, + ALIGNMENT_LIST, +}; + +/* Default capture configuration file when none is specified. */ +static const char *default_config = +"[ExclusionList]\n" +"\\$ntfs.log\n" +"\\hiberfil.sys\n" +"\\pagefile.sys\n" +"\\System Volume Information\n" +"\\RECYCLER\n" +"\\Windows\\CSC\n" +"\n" +"[CompressionExclusionList]\n" +"*.mp3\n" +"*.zip\n" +"*.cab\n" +"\\WINDOWS\\inf\\*.pnf\n"; + +static void destroy_pattern_list(struct pattern_list *list) +{ + FREE(list->pats); +} + +static void destroy_capture_config(struct capture_config *config) +{ + destroy_pattern_list(&config->exclusion_list); + destroy_pattern_list(&config->exclusion_exception); + destroy_pattern_list(&config->compression_exclusion_list); + destroy_pattern_list(&config->alignment_list); + FREE(config->config_str); + FREE(config->prefix); + memset(config, 0, sizeof(*config)); +} + +static int pattern_list_add_pattern(struct pattern_list *list, + const char *pattern) +{ + const char **pats; + if (list->num_pats >= list->num_allocated_pats) { + pats = REALLOC(list->pats, + sizeof(list->pats[0]) * (list->num_allocated_pats + 8)); + if (!pats) + return WIMLIB_ERR_NOMEM; + list->num_allocated_pats += 8; + list->pats = pats; + } + list->pats[list->num_pats++] = pattern; + return 0; +} + +/* Parses the contents of the image capture configuration file and fills in a + * `struct capture_config'. */ +static int init_capture_config(const char *_config_str, size_t config_len, + const char *_prefix, struct capture_config *config) +{ + char *config_str; + char *prefix; + char *p; + char *eol; + char *next_p; + size_t bytes_remaining; + enum pattern_type type = NONE; + int ret; + unsigned long line_no = 0; + + DEBUG("config_len = %zu", config_len); + bytes_remaining = config_len; + memset(config, 0, sizeof(*config)); + config_str = MALLOC(config_len); + if (!config_str) { + ERROR("Could not duplicate capture config string"); + return WIMLIB_ERR_NOMEM; + } + prefix = STRDUP(_prefix); + if (!prefix) { + FREE(config_str); + return WIMLIB_ERR_NOMEM; + } + + memcpy(config_str, _config_str, config_len); + next_p = config_str; + config->config_str = config_str; + config->prefix = prefix; + config->prefix_len = strlen(prefix); + while (bytes_remaining) { + line_no++; + p = next_p; + eol = memchr(p, '\n', bytes_remaining); + if (!eol) { + ERROR("Expected end-of-line in capture config file on " + "line %lu", line_no); + ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG; + goto out_destroy; + } + + next_p = eol + 1; + bytes_remaining -= (next_p - p); + if (eol == p) + continue; + + if (*(eol - 1) == '\r') + eol--; + *eol = '\0'; + + /* Translate backslash to forward slash */ + for (char *pp = p; pp != eol; pp++) + if (*pp == '\\') + *pp = '/'; + + /* Remove drive letter */ + if (eol - p > 2 && isalpha(*p) && *(p + 1) == ':') + p += 2; + + ret = 0; + if (strcmp(p, "[ExclusionList]") == 0) + type = EXCLUSION_LIST; + else if (strcmp(p, "[ExclusionException]") == 0) + type = EXCLUSION_EXCEPTION; + else if (strcmp(p, "[CompressionExclusionList]") == 0) + type = COMPRESSION_EXCLUSION_LIST; + else if (strcmp(p, "[AlignmentList]") == 0) + type = ALIGNMENT_LIST; + else if (p[0] == '[' && strrchr(p, ']')) { + ERROR("Unknown capture configuration section `%s'", p); + ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG; + } else switch (type) { + case EXCLUSION_LIST: + DEBUG("Adding pattern \"%s\" to exclusion list", p); + ret = pattern_list_add_pattern(&config->exclusion_list, p); + break; + case EXCLUSION_EXCEPTION: + DEBUG("Adding pattern \"%s\" to exclusion exception list", p); + ret = pattern_list_add_pattern(&config->exclusion_exception, p); + break; + case COMPRESSION_EXCLUSION_LIST: + DEBUG("Adding pattern \"%s\" to compression exclusion list", p); + ret = pattern_list_add_pattern(&config->compression_exclusion_list, p); + break; + case ALIGNMENT_LIST: + DEBUG("Adding pattern \"%s\" to alignment list", p); + ret = pattern_list_add_pattern(&config->alignment_list, p); + break; + default: + ERROR("Line %lu of capture configuration is not " + "in a block (such as [ExclusionList])", + line_no); + ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG; + break; + } + if (ret != 0) + goto out_destroy; + } + return 0; +out_destroy: + destroy_capture_config(config); + return ret; +} + +static bool match_pattern(const char *path, const char *path_basename, + const struct pattern_list *list) +{ + for (size_t i = 0; i < list->num_pats; i++) { + const char *pat = list->pats[i]; + const char *string; + if (pat[0] == '/') + /* Absolute path from root of capture */ + string = path; + else { + if (strchr(pat, '/')) + /* Relative path from root of capture */ + string = path + 1; + else + /* A file name pattern */ + string = path_basename; + } + if (fnmatch(pat, string, FNM_PATHNAME + #ifdef FNM_CASEFOLD + | FNM_CASEFOLD + #endif + ) == 0) + { + DEBUG("`%s' matches the pattern \"%s\"", + string, pat); + return true; + } + } + return false; +} + +static void print_pattern_list(const struct pattern_list *list) +{ + for (size_t i = 0; i < list->num_pats; i++) + printf(" %s\n", list->pats[i]); +} + +static void print_capture_config(const struct capture_config *config) +{ + if (config->exclusion_list.num_pats) { + puts("Files or folders excluded from image capture:"); + print_pattern_list(&config->exclusion_list); + putchar('\n'); + } +} + +/* Return true if the image capture configuration file indicates we should + * exclude the filename @path from capture. + * + * If @exclude_prefix is %true, the part of the path up and including the name + * of the directory being captured is not included in the path for matching + * purposes. This allows, for example, a pattern like /hiberfil.sys to match a + * file /mnt/windows7/hiberfil.sys if we are capturing the /mnt/windows7 + * directory. */ -WIMLIBAPI int wimlib_add_image(WIMStruct *w, const char *dir, - const char *name, const char *description, - const char *flags_element, int flags) +bool exclude_path(const char *path, const struct capture_config *config, + bool exclude_prefix) { - struct dentry *root_dentry; - struct stat root_stat; + const char *basename = path_basename(path); + if (exclude_prefix) { + wimlib_assert(strlen(path) >= config->prefix_len); + if (memcmp(config->prefix, path, config->prefix_len) == 0 + && path[config->prefix_len] == '/') + path += config->prefix_len; + } + return match_pattern(path, basename, &config->exclusion_list) && + !match_pattern(path, basename, &config->exclusion_exception); + +} + +WIMLIBAPI int wimlib_add_image(WIMStruct *w, const char *source, + const char *name, const char *config_str, + size_t config_len, int add_image_flags, + wimlib_progress_func_t progress_func) +{ + int (*capture_tree)(struct dentry **, const char *, + struct lookup_table *, + struct wim_security_data *, + const struct capture_config *, + int, wimlib_progress_func_t, void *); + void *extra_arg; + + struct dentry *root_dentry = NULL; + struct wim_security_data *sd; + struct capture_config config; + struct inode_table inode_tab; + struct hlist_head inode_list; int ret; - DEBUG("Adding dentry tree from dir `%s'\n", dir); + if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) { +#ifdef WITH_NTFS_3G + if (add_image_flags & (WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE)) { + ERROR("Cannot dereference files when capturing directly from NTFS"); + return WIMLIB_ERR_INVALID_PARAM; + } + capture_tree = build_dentry_tree_ntfs; + extra_arg = &w->ntfs_vol; +#else + ERROR("wimlib was compiled without support for NTFS-3g, so\n" + " cannot capture a WIM image directly from a NTFS volume!"); + return WIMLIB_ERR_UNSUPPORTED; +#endif + } else { + capture_tree = build_dentry_tree; + extra_arg = NULL; + } + + DEBUG("Adding dentry tree from directory or NTFS volume `%s'.", source); if (!name || !*name) { - ERROR("Must specify a non-empty string for the image name!\n"); + ERROR("Must specify a non-empty string for the image name"); return WIMLIB_ERR_INVALID_PARAM; } - if (!dir) { - ERROR("Must specify the name of a directory!\n"); + if (!source) { + ERROR("Must specify the name of a directory or NTFS volume"); return WIMLIB_ERR_INVALID_PARAM; } + if (w->hdr.total_parts != 1) { + ERROR("Cannot add an image to a split WIM"); + return WIMLIB_ERR_SPLIT_UNSUPPORTED; + } + if (wimlib_image_name_in_use(w, name)) { - ERROR("There is already an image named `%s' in %s!\n", - name, w->filename); + ERROR("There is already an image named \"%s\" in `%s'", + name, w->filename); return WIMLIB_ERR_IMAGE_NAME_COLLISION; } - DEBUG("Creating root dentry.\n"); - - root_dentry = new_dentry(""); - ret = calculate_dentry_full_path(root_dentry, NULL); + DEBUG("Initializing capture configuration"); + if (!config_str) { + DEBUG("Using default capture configuration"); + config_str = default_config; + config_len = strlen(default_config); + } + ret = init_capture_config(config_str, config_len, source, &config); if (ret != 0) return ret; - root_dentry->attributes |= WIM_FILE_ATTRIBUTE_DIRECTORY; + print_capture_config(&config); - /* Construct the dentry tree from the outside filesystem. */ - if (stat(dir, &root_stat) != 0) { - ERROR("Failed to stat `%s': %m\n", dir); - return WIMLIB_ERR_STAT; + DEBUG("Allocating security data"); + + sd = CALLOC(1, sizeof(struct wim_security_data)); + if (!sd) { + ret = WIMLIB_ERR_NOMEM; + goto out_destroy_config; } - if (!S_ISDIR(root_stat.st_mode)) { - ERROR("`%s' is not a directory!\n", dir); - return WIMLIB_ERR_NOTDIR; + sd->total_length = 8; + sd->refcnt = 1; + + if (progress_func) { + union wimlib_progress_info progress; + progress.scan.source = source; + progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &progress); } - DEBUG("Building dentry tree.\n"); - ret = build_dentry_tree(root_dentry, dir, &root_stat, - w->lookup_table); + + DEBUG("Building dentry tree."); + ret = (*capture_tree)(&root_dentry, source, w->lookup_table, sd, + &config, add_image_flags | WIMLIB_ADD_IMAGE_FLAG_ROOT, + progress_func, extra_arg); + destroy_capture_config(&config); if (ret != 0) { - ERROR("Failed to build dentry tree for `%s'!\n", dir); - goto err1; + ERROR("Failed to build dentry tree for `%s'", source); + goto out_free_security_data; } - DEBUG("Recalculating full paths of dentries.\n"); - ret = for_dentry_in_tree(root_dentry, - calculate_dentry_full_path, NULL); - if (ret != 0) { - ERROR("Failed to calculate full paths of dentry tree.\n"); - goto err1; + if (progress_func) { + union wimlib_progress_info progress; + progress.scan.source = source; + progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &progress); } - ret = add_new_dentry_tree(w, root_dentry); + DEBUG("Calculating full paths of dentries."); + ret = for_dentry_in_tree(root_dentry, calculate_dentry_full_path, NULL); if (ret != 0) - goto err1; + goto out_free_dentry_tree; - if (flags & WIMLIB_ADD_IMAGE_FLAG_BOOT) { - /* Call wimlib_set_boot_idx rather than set boot_idx directly so - * that the boot metadata resource entry in the header gets - * updated. */ - wimlib_set_boot_idx(w, w->hdr.image_count); - } + ret = add_new_dentry_tree(w, root_dentry, sd); + if (ret != 0) + goto out_free_dentry_tree; + + DEBUG("Inserting dentries into inode table"); + ret = init_inode_table(&inode_tab, 9001); + if (ret != 0) + goto out_destroy_imd; + + for_dentry_in_tree(root_dentry, inode_table_insert, &inode_tab); + + DEBUG("Cleaning up the hard link groups"); + ret = fix_inodes(&inode_tab, &inode_list); + destroy_inode_table(&inode_tab); + if (ret != 0) + goto out_destroy_imd; - ret = xml_add_image(w, root_dentry, name, description, flags_element); + DEBUG("Assigning hard link group IDs"); + assign_inode_numbers(&inode_list); + + ret = xml_add_image(w, name); if (ret != 0) - goto err1; + goto out_destroy_imd; + if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_BOOT) + wimlib_set_boot_idx(w, w->hdr.image_count); return 0; -err1: - free_dentry_tree(root_dentry, w->lookup_table, true); +out_destroy_imd: + destroy_image_metadata(&w->image_metadata[w->hdr.image_count - 1], + w->lookup_table); + w->hdr.image_count--; + return ret; +out_free_dentry_tree: + free_dentry_tree(root_dentry, w->lookup_table); +out_free_security_data: + free_security_data(sd); +out_destroy_config: + destroy_capture_config(&config); return ret; }