X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fupdate_image.c;h=ef5328059be12fc45fc0ff750c484d8ddf8b75a3;hp=5a5ae69066f590f119fed933296a410c545be2bc;hb=b5b9681794d1f5f13350e3567f6f6e74f5c779cf;hpb=668c363a59c521f48eecbc4dd549c07a3e36179e diff --git a/src/update_image.c b/src/update_image.c index 5a5ae690..ef532805 100644 --- a/src/update_image.c +++ b/src/update_image.c @@ -3,7 +3,7 @@ */ /* - * Copyright (C) 2013 Eric Biggers + * Copyright (C) 2013, 2014 Eric Biggers * * This file is part of wimlib, a library for working with WIM files. * @@ -27,6 +27,7 @@ #include "wimlib/capture.h" #include "wimlib/dentry.h" +#include "wimlib/encoding.h" #include "wimlib/error.h" #include "wimlib/lookup_table.h" #include "wimlib/metadata.h" @@ -34,280 +35,861 @@ # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */ #endif #include "wimlib/paths.h" +#include "wimlib/progress.h" #include "wimlib/xml.h" #include +#include +#include -/* Overlays @branch onto @target, both of which must be directories. */ -static int -do_overlay(struct wim_dentry *target, struct wim_dentry *branch) -{ - struct rb_root *rb_root; +#ifdef HAVE_ALLOCA_H +# include +#endif - DEBUG("Doing overlay \"%"WS"\" => \"%"WS"\"", - branch->file_name, target->file_name); +/* Saved specification of a "primitive" update operation that was performed. */ +struct update_primitive { + enum { + /* Unlinked a dentry from its parent directory. */ + UNLINK_DENTRY, + + /* Linked a dentry into its parent directory. */ + LINK_DENTRY, + + /* Changed the file name of a dentry. */ + CHANGE_FILE_NAME, + + /* Changed the short name of a dentry. */ + CHANGE_SHORT_NAME, + } type; + + union { + /* For UNLINK_DENTRY and LINK_DENTRY operations */ + struct { + /* Dentry that was linked or unlinked. */ + struct wim_dentry *subject; + + /* For link operations, the directory into which + * @subject was linked, or NULL if @subject was set as + * the root of the image. + * + * For unlink operations, the directory from which + * @subject was unlinked, or NULL if @subject was unset + * as the root of the image. */ + struct wim_dentry *parent; + } link; + + /* For CHANGE_FILE_NAME and CHANGE_SHORT_NAME operations */ + struct { + /* Dentry that had its name changed. */ + struct wim_dentry *subject; + + /* The old name. */ + utf16lechar *old_name; + } name; + }; +}; - if (!dentry_is_directory(branch) || !dentry_is_directory(target)) { - ERROR("Cannot overlay \"%"WS"\" onto existing dentry: " - "is not directory-on-directory!", branch->file_name); - return WIMLIB_ERR_INVALID_OVERLAY; +/* Chronological list of primitive operations that were executed for a single + * logical update command, such as 'add', 'delete', or 'rename'. */ +struct update_primitive_list { + struct update_primitive *entries; + struct update_primitive inline_entries[4]; + size_t num_entries; + size_t num_alloc_entries; +}; + +/* Journal for managing the executing of zero or more logical update commands, + * such as 'add', 'delete', or 'rename'. This allows either committing or + * rolling back the commands. */ +struct update_command_journal { + /* Number of update commands this journal contains. */ + size_t num_cmds; + + /* Index of currently executing update command. */ + size_t cur_cmd; + + /* Location of the WIM image's root pointer. */ + struct wim_dentry **root_p; + + /* Pointer to the lookup table of the WIM (may needed for rollback) */ + struct wim_lookup_table *lookup_table; + + /* List of dentries that are currently unlinked from the WIM image. + * These must be freed when no longer needed for commit or rollback. */ + struct list_head orphans; + + /* Per-command logs. */ + struct update_primitive_list cmd_prims[]; +}; + +static void +init_update_primitive_list(struct update_primitive_list *l) +{ + l->entries = l->inline_entries; + l->num_entries = 0; + l->num_alloc_entries = ARRAY_LEN(l->inline_entries); +} + +/* Allocates a new journal for managing the execution of up to @num_cmds update + * commands. */ +static struct update_command_journal * +new_update_command_journal(size_t num_cmds, struct wim_dentry **root_p, + struct wim_lookup_table *lookup_table) +{ + struct update_command_journal *j; + + j = MALLOC(sizeof(*j) + num_cmds * sizeof(j->cmd_prims[0])); + if (j) { + j->num_cmds = num_cmds; + j->cur_cmd = 0; + j->root_p = root_p; + j->lookup_table = lookup_table; + INIT_LIST_HEAD(&j->orphans); + for (size_t i = 0; i < num_cmds; i++) + init_update_primitive_list(&j->cmd_prims[i]); } + return j; +} - rb_root = &branch->d_inode->i_children; - LIST_HEAD(moved_children); - while (rb_root->rb_node) { /* While @branch has children... */ - struct wim_dentry *child = rbnode_dentry(rb_root->rb_node); - struct wim_dentry *existing; +/* Don't call this directly; use commit_update() or rollback_update() instead. + */ +static void +free_update_command_journal(struct update_command_journal *j) +{ + struct wim_dentry *orphan; + + /* Free orphaned dentry trees */ + while (!list_empty(&j->orphans)) { + orphan = list_first_entry(&j->orphans, + struct wim_dentry, tmp_list); + list_del(&orphan->tmp_list); + free_dentry_tree(orphan, j->lookup_table); + } - /* Move @child to the directory @target */ - unlink_dentry(child); - existing = dentry_add_child(target, child); + for (size_t i = 0; i < j->num_cmds; i++) + if (j->cmd_prims[i].entries != j->cmd_prims[i].inline_entries) + FREE(j->cmd_prims[i].entries); + FREE(j); +} - /* File or directory with same name already exists */ - if (existing) { - int ret; - ret = do_overlay(existing, child); - if (ret) { - /* Overlay failed. Revert the changes. */ - dentry_add_child(branch, child); - list_for_each_entry(child, &moved_children, tmp_list) - { - unlink_dentry(child); - dentry_add_child(branch, child); - } - return ret; - } +/* Add the entry @prim to the update command journal @j. */ +static int +record_update_primitive(struct update_command_journal *j, + struct update_primitive prim) +{ + struct update_primitive_list *l; + + l = &j->cmd_prims[j->cur_cmd]; + + if (l->num_entries == l->num_alloc_entries) { + struct update_primitive *new_entries; + size_t new_num_alloc_entries; + size_t new_size; + + new_num_alloc_entries = l->num_alloc_entries * 2; + new_size = new_num_alloc_entries * sizeof(new_entries[0]); + if (l->entries == l->inline_entries) { + new_entries = MALLOC(new_size); + if (!new_entries) + return WIMLIB_ERR_NOMEM; + memcpy(new_entries, l->inline_entries, + sizeof(l->inline_entries)); } else { - list_add(&child->tmp_list, &moved_children); + new_entries = REALLOC(l->entries, new_size); + if (!new_entries) + return WIMLIB_ERR_NOMEM; } + l->entries = new_entries; + l->num_alloc_entries = new_num_alloc_entries; } - free_dentry(branch); + l->entries[l->num_entries++] = prim; return 0; } -/* Attach or overlay a branch onto the WIM image. +static void +do_unlink(struct wim_dentry *subject, struct wim_dentry *parent, + struct wim_dentry **root_p) +{ + if (parent) { + /* Unlink @subject from its @parent. */ + wimlib_assert(subject->parent == parent); + unlink_dentry(subject); + } else { + /* Unset @subject as the root of the image. */ + *root_p = NULL; + } + subject->parent = subject; +} + +static void +do_link(struct wim_dentry *subject, struct wim_dentry *parent, + struct wim_dentry **root_p) +{ + if (parent) { + /* Link @subject to its @parent */ + struct wim_dentry *existing; + + existing = dentry_add_child(parent, subject); + wimlib_assert(!existing); + } else { + /* Set @subject as root of the image */ + *root_p = subject; + } +} + +/* Undo a link operation. */ +static void +rollback_link(struct wim_dentry *subject, struct wim_dentry *parent, + struct wim_dentry **root_p, struct list_head *orphans) +{ + /* Unlink is the opposite of link */ + do_unlink(subject, parent, root_p); + + /* @subject is now unlinked. Add it to orphans. */ + list_add(&subject->tmp_list, orphans); + subject->is_orphan = 1; +} + +/* Undo an unlink operation. */ +static void +rollback_unlink(struct wim_dentry *subject, struct wim_dentry *parent, + struct wim_dentry **root_p) +{ + /* Link is the opposite of unlink */ + do_link(subject, parent, root_p); + + /* @subject is no longer unlinked. Delete it from orphans. */ + list_del(&subject->tmp_list); + subject->is_orphan = 0; +} + +/* Rollback a name change operation. */ +static void +rollback_name_change(utf16lechar *old_name, + utf16lechar **name_ptr, u16 *name_nbytes_ptr) +{ + /* Free the new name, then replace it with the old name. */ + FREE(*name_ptr); + if (old_name) { + *name_ptr = old_name; + *name_nbytes_ptr = utf16le_strlen(old_name); + } else { + *name_ptr = NULL; + *name_nbytes_ptr = 0; + } +} + +/* Rollback a primitive update operation. */ +static void +rollback_update_primitive(const struct update_primitive *prim, + struct wim_dentry **root_p, + struct list_head *orphans) +{ + switch (prim->type) { + case LINK_DENTRY: + rollback_link(prim->link.subject, prim->link.parent, root_p, + orphans); + break; + case UNLINK_DENTRY: + rollback_unlink(prim->link.subject, prim->link.parent, root_p); + break; + case CHANGE_FILE_NAME: + rollback_name_change(prim->name.old_name, + &prim->name.subject->file_name, + &prim->name.subject->file_name_nbytes); + break; + case CHANGE_SHORT_NAME: + rollback_name_change(prim->name.old_name, + &prim->name.subject->short_name, + &prim->name.subject->short_name_nbytes); + break; + } +} + +/* Rollback a logical update command */ +static void +rollback_update_command(const struct update_primitive_list *l, + struct wim_dentry **root_p, + struct list_head *orphans) +{ + size_t i = l->num_entries; + + /* Rollback each primitive operation, in reverse order. */ + while (i--) + rollback_update_primitive(&l->entries[i], root_p, orphans); +} + +/****************************************************************************/ + +/* Link @subject into the directory @parent; or, if @parent is NULL, set + * @subject as the root of the WIM image. * - * @root_p: - * Pointer to the root of the WIM image, or pointer to NULL if it has not - * been created yet. - * @branch - * Branch to add. - * @target_path: - * Path in the WIM image to add the branch, with leading and trailing - * slashes stripped. - */ + * This is the journaled version, so it can be rolled back. */ static int -attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch, - tchar *target_path, CASE_SENSITIVITY_TYPE case_type) +journaled_link(struct update_command_journal *j, + struct wim_dentry *subject, struct wim_dentry *parent) { - tchar *slash; - struct wim_dentry *dentry, *parent, *target; + struct update_primitive prim; int ret; - DEBUG("Attaching branch \"%"WS"\" => \"%"TS"\"", - branch->file_name, target_path); + prim.type = LINK_DENTRY; + prim.link.subject = subject; + prim.link.parent = parent; - if (*target_path == T('\0')) { - /* Target: root directory */ - if (*root_p) { - /* Overlay on existing root */ - return do_overlay(*root_p, branch); - } else { - if (!dentry_is_directory(branch)) { - ERROR("Cannot set non-directory as root of WIM image"); - return WIMLIB_ERR_NOTDIR; + ret = record_update_primitive(j, prim); + if (ret) + return ret; + + do_link(subject, parent, j->root_p); + + if (subject->is_orphan) { + list_del(&subject->tmp_list); + subject->is_orphan = 0; + } + return 0; +} + +/* Unlink @subject from the WIM image. + * + * This is the journaled version, so it can be rolled back. */ +static int +journaled_unlink(struct update_command_journal *j, struct wim_dentry *subject) +{ + struct wim_dentry *parent; + struct update_primitive prim; + int ret; + + if (dentry_is_root(subject)) + parent = NULL; + else + parent = subject->parent; + + prim.type = UNLINK_DENTRY; + prim.link.subject = subject; + prim.link.parent = parent; + + ret = record_update_primitive(j, prim); + if (ret) + return ret; + + do_unlink(subject, parent, j->root_p); + + list_add(&subject->tmp_list, &j->orphans); + subject->is_orphan = 1; + return 0; +} + +/* Change the name of @dentry to @new_name_tstr. + * + * This is the journaled version, so it can be rolled back. */ +static int +journaled_change_name(struct update_command_journal *j, + struct wim_dentry *dentry, const tchar *new_name_tstr) +{ + int ret; + utf16lechar *new_name; + size_t new_name_nbytes; + struct update_primitive prim; + + /* Set the long name. */ + ret = tstr_to_utf16le(new_name_tstr, + tstrlen(new_name_tstr) * sizeof(tchar), + &new_name, &new_name_nbytes); + if (ret) + return ret; + + prim.type = CHANGE_FILE_NAME; + prim.name.subject = dentry; + prim.name.old_name = dentry->file_name; + ret = record_update_primitive(j, prim); + if (ret) { + FREE(new_name); + return ret; + } + + dentry->file_name = new_name; + dentry->file_name_nbytes = new_name_nbytes; + + /* Clear the short name. */ + prim.type = CHANGE_SHORT_NAME; + prim.name.subject = dentry; + prim.name.old_name = dentry->short_name; + ret = record_update_primitive(j, prim); + if (ret) + return ret; + + dentry->short_name = NULL; + dentry->short_name_nbytes = 0; + return 0; +} + +static void +next_command(struct update_command_journal *j) +{ + j->cur_cmd++; +} + +static void +commit_update(struct update_command_journal *j) +{ + for (size_t i = 0; i < j->num_cmds; i++) + { + for (size_t k = 0; k < j->cmd_prims[i].num_entries; k++) + { + if (j->cmd_prims[i].entries[k].type == CHANGE_FILE_NAME || + j->cmd_prims[i].entries[k].type == CHANGE_SHORT_NAME) + { + FREE(j->cmd_prims[i].entries[k].name.old_name); } - /* Set as root */ - *root_p = branch; - return 0; } } + free_update_command_journal(j); +} + +static void +rollback_update(struct update_command_journal *j) +{ + /* Rollback each logical update command, in reverse order. */ + size_t i = j->cur_cmd; + if (i < j->num_cmds) + i++; + while (i--) + rollback_update_command(&j->cmd_prims[i], j->root_p, &j->orphans); + free_update_command_journal(j); +} + +static int +handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, + struct update_command_journal *j, + int add_flags, + wimlib_progress_func_t progfunc, void *progctx) +{ + bool branch_is_dir = dentry_is_directory(branch); + bool existing_is_dir = dentry_is_directory(existing); + + if (branch_is_dir != existing_is_dir) { + if (existing_is_dir) { + ERROR("\"%"TS"\" is a directory!\n" + " Specify the path at which " + "to place the file inside this directory.", + dentry_full_path(existing)); + return WIMLIB_ERR_IS_DIRECTORY; + } else { + ERROR("Can't place directory at \"%"TS"\" because " + "a nondirectory file already exists there!", + dentry_full_path(existing)); + return WIMLIB_ERR_NOTDIR; + } + } + + if (branch_is_dir) { + /* Directory overlay */ + while (dentry_has_children(branch)) { + struct wim_dentry *new_child; + struct wim_dentry *existing_child; + int ret; + + new_child = dentry_any_child(branch); + + existing_child = + get_dentry_child_with_utf16le_name(existing, + new_child->file_name, + new_child->file_name_nbytes, + WIMLIB_CASE_PLATFORM_DEFAULT); + unlink_dentry(new_child); + if (existing_child) { + ret = handle_conflict(new_child, existing_child, + j, add_flags, + progfunc, progctx); + } else { + ret = journaled_link(j, new_child, existing); + } + if (ret) { + dentry_add_child(branch, new_child); + return ret; + } + } + free_dentry(branch); + return 0; + } else if (add_flags & WIMLIB_ADD_FLAG_NO_REPLACE) { + /* Can't replace nondirectory file */ + ERROR("Refusing to overwrite nondirectory file \"%"TS"\"", + dentry_full_path(existing)); + return WIMLIB_ERR_INVALID_OVERLAY; + } else { + /* Replace nondirectory file */ + struct wim_dentry *parent; + int ret; + union wimlib_progress_info info; + + parent = existing->parent; + + ret = calculate_dentry_full_path(existing); + if (ret) + return ret; - /* Adding a non-root branch. Create root if it hasn't been created - * already. */ - if (!*root_p) { - ret = new_filler_directory(T(""), root_p); + ret = journaled_unlink(j, existing); if (ret) return ret; + + ret = journaled_link(j, branch, parent); + if (ret) + return ret; + + + info.replace.path_in_wim = existing->_full_path; + return call_progress(progfunc, + WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM, + &info, progctx); } +} + +static int +do_attach_branch(struct wim_dentry *branch, const utf16lechar *target, + struct update_command_journal *j, + int add_flags, wimlib_progress_func_t progfunc, void *progctx) +{ + struct wim_dentry *parent; + struct wim_dentry *existing; + const utf16lechar empty_name[1] = {0}; + const utf16lechar *cur_component_name; + size_t cur_component_nbytes; + const utf16lechar *next_component_name; + int ret; + + /* Attempt to create root directory before proceeding to the "real" + * first component */ + parent = NULL; + existing = *j->root_p; + cur_component_name = empty_name; + cur_component_nbytes = 0; - /* Walk the path to the branch, creating filler directories as needed. - * */ - parent = *root_p; - while ((slash = tstrchr(target_path, WIM_PATH_SEPARATOR))) { - *slash = T('\0'); - dentry = get_dentry_child_with_name(parent, target_path, - case_type); - if (!dentry) { - ret = new_filler_directory(target_path, &dentry); + /* Skip leading slashes */ + next_component_name = target; + while (*next_component_name == cpu_to_le16(WIM_PATH_SEPARATOR)) + next_component_name++; + + while (*next_component_name) { /* While not the last component ... */ + const utf16lechar *end; + + if (existing) { + /* Descend into existing directory */ + if (!dentry_is_directory(existing)) { + ERROR("\"%"TS"\" in the WIM image " + "is not a directory!", + dentry_full_path(existing)); + return WIMLIB_ERR_NOTDIR; + } + } else { + /* A parent directory of the target didn't exist. Make + * the way by creating a filler directory. */ + struct wim_dentry *filler; + + ret = new_filler_directory(&filler); if (ret) return ret; - dentry_add_child(parent, dentry); + ret = dentry_set_name_utf16le(filler, + cur_component_name, + cur_component_nbytes); + if (ret) { + free_dentry(filler); + return ret; + } + ret = journaled_link(j, filler, parent); + if (ret) { + free_dentry(filler); + return ret; + } + existing = filler; } - parent = dentry; - target_path = slash; - /* Skip over slashes. Note: this cannot overrun the length of - * the string because the last character cannot be a slash, as - * trailing slashes were tripped. */ - do { - ++target_path; - } while (*target_path == WIM_PATH_SEPARATOR); - } - - /* If the target path already existed, overlay the branch onto it. - * Otherwise, set the branch as the target path. */ - target = get_dentry_child_with_utf16le_name(parent, branch->file_name, - branch->file_name_nbytes, - case_type); - if (target) { - return do_overlay(target, branch); + + /* Advance to next component */ + + cur_component_name = next_component_name; + end = cur_component_name + 1; + while (*end && *end != cpu_to_le16(WIM_PATH_SEPARATOR)) + end++; + + next_component_name = end; + if (*end) { + /* There will still be more components after this. */ + do { + } while (*++next_component_name == cpu_to_le16(WIM_PATH_SEPARATOR)); + wimlib_assert(*next_component_name); /* No trailing slashes */ + } else { + /* This will be the last component */ + next_component_name = end; + } + parent = existing; + cur_component_nbytes = (end - cur_component_name) * sizeof(utf16lechar); + existing = get_dentry_child_with_utf16le_name( + parent, + cur_component_name, + cur_component_nbytes, + WIMLIB_CASE_PLATFORM_DEFAULT); + } + + /* Last component */ + if (existing) { + return handle_conflict(branch, existing, j, add_flags, + progfunc, progctx); } else { - dentry_add_child(parent, branch); - return 0; + return journaled_link(j, branch, parent); } } +/* + * Place the directory entry tree @branch at the path @target_tstr in the WIM + * image. + * + * @target_tstr cannot contain trailing slashes, and all path separators must be + * WIM_PATH_SEPARATOR. + * + * On success, @branch is committed to the journal @j. + * Otherwise @branch is freed. + * + * The relevant @add_flags are WIMLIB_ADD_FLAG_NO_REPLACE and + * WIMLIB_ADD_FLAG_VERBOSE. + */ static int -execute_add_command(WIMStruct *wim, +attach_branch(struct wim_dentry *branch, const tchar *target_tstr, + struct update_command_journal *j, int add_flags, + wimlib_progress_func_t progfunc, void *progctx) +{ + int ret; + const utf16lechar *target; + + ret = 0; + if (unlikely(!branch)) + goto out; + + ret = tstr_get_utf16le(target_tstr, &target); + if (ret) + goto out_free_branch; + + BUILD_BUG_ON(WIM_PATH_SEPARATOR != OS_PREFERRED_PATH_SEPARATOR); + ret = dentry_set_name(branch, path_basename(target_tstr)); + if (ret) + goto out_free_target; + + ret = do_attach_branch(branch, target, j, add_flags, progfunc, progctx); + if (ret) + goto out_free_target; + /* branch was successfully committed to the journal */ + branch = NULL; +out_free_target: + tstr_put_utf16le(target); +out_free_branch: + free_dentry_tree(branch, j->lookup_table); +out: + return ret; +} + +static const char wincfg[] = +"[ExclusionList]\n" +"/$ntfs.log\n" +"/hiberfil.sys\n" +"/pagefile.sys\n" +"/swapfile.sys\n" +"/System Volume Information\n" +"/RECYCLER\n" +"/Windows/CSC\n"; + +static const tchar *wimboot_cfgfile = + WIMLIB_WIM_PATH_SEPARATOR_STRING T("Windows") + WIMLIB_WIM_PATH_SEPARATOR_STRING T("System32") + WIMLIB_WIM_PATH_SEPARATOR_STRING T("WimBootCompress.ini"); + +static int +get_capture_config(const tchar *config_file, struct capture_config *config, + int add_flags, const tchar *fs_source_path) +{ + int ret; + tchar *tmp_config_file = NULL; + + memset(config, 0, sizeof(*config)); + + /* For WIMBoot capture, check for default capture configuration file + * unless one was explicitly specified. */ + if (!config_file && (add_flags & WIMLIB_ADD_FLAG_WIMBOOT)) { + + /* XXX: Handle loading file correctly when in NTFS volume. */ + + size_t len = tstrlen(fs_source_path) + + tstrlen(wimboot_cfgfile); + tmp_config_file = MALLOC((len + 1) * sizeof(tchar)); + struct stat st; + + tsprintf(tmp_config_file, T("%"TS"%"TS), + fs_source_path, wimboot_cfgfile); + if (!tstat(tmp_config_file, &st)) { + config_file = tmp_config_file; + add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG; + } else { + WARNING("\"%"TS"\" does not exist.\n" + " Using default capture configuration!", + tmp_config_file); + } + } + + if (add_flags & WIMLIB_ADD_FLAG_WINCONFIG) { + /* Use Windows default. */ + if (config_file) + return WIMLIB_ERR_INVALID_PARAM; + ret = read_capture_config(T("wincfg"), wincfg, + sizeof(wincfg) - 1, config); + } else if (config_file) { + /* Use the specified configuration file. */ + ret = read_capture_config(config_file, NULL, 0, config); + } else { + /* ... Or don't use any configuration file at all. No files + * will be excluded from capture, all files will be compressed, + * etc. */ + ret = 0; + } + FREE(tmp_config_file); + return ret; +} + +static int +execute_add_command(struct update_command_journal *j, + WIMStruct *wim, const struct wimlib_update_command *add_cmd, - wimlib_progress_func_t progress_func) + struct wim_inode_table *inode_table, + struct wim_sd_set *sd_set, + struct list_head *unhashed_streams) { int ret; int add_flags; tchar *fs_source_path; tchar *wim_target_path; - struct wim_image_metadata *imd; - struct list_head unhashed_streams; + const tchar *config_file; struct add_image_params params; - int (*capture_tree)(struct wim_dentry **, - const tchar *, - struct add_image_params *); - struct wimlib_capture_config *config; + struct capture_config config; + capture_tree_t capture_tree = platform_default_capture_tree; #ifdef WITH_NTFS_3G struct _ntfs_volume *ntfs_vol = NULL; #endif - void *extra_arg; + void *extra_arg = NULL; struct wim_dentry *branch; - bool rollback_sd = true; - - wimlib_assert(add_cmd->op == WIMLIB_UPDATE_OP_ADD); add_flags = add_cmd->add.add_flags; fs_source_path = add_cmd->add.fs_source_path; wim_target_path = add_cmd->add.wim_target_path; - config = add_cmd->add.config; + config_file = add_cmd->add.config_file; + DEBUG("fs_source_path=\"%"TS"\", wim_target_path=\"%"TS"\", add_flags=%#x", fs_source_path, wim_target_path, add_flags); memset(¶ms, 0, sizeof(params)); - imd = wim->image_metadata[wim->current_image - 1]; - +#ifdef WITH_NTFS_3G if (add_flags & WIMLIB_ADD_FLAG_NTFS) { - #ifdef WITH_NTFS_3G capture_tree = build_dentry_tree_ntfs; extra_arg = &ntfs_vol; - if (imd->ntfs_vol != NULL) { + if (wim_get_current_image_metadata(wim)->ntfs_vol != NULL) { ERROR("NTFS volume already set"); ret = WIMLIB_ERR_INVALID_PARAM; goto out; } - #else - ret = WIMLIB_ERR_INVALID_PARAM; - goto out; - #endif - } else { - #ifdef __WIN32__ - capture_tree = win32_build_dentry_tree; - #else - capture_tree = unix_build_dentry_tree; - #endif - extra_arg = NULL; } +#endif - - ret = init_inode_table(¶ms.inode_table, 9001); + ret = get_capture_config(config_file, &config, + add_flags, fs_source_path); if (ret) goto out; - ret = init_sd_set(¶ms.sd_set, imd->security_data); - if (ret) - goto out_destroy_inode_table; - - INIT_LIST_HEAD(&unhashed_streams); params.lookup_table = wim->lookup_table; - params.unhashed_streams = &unhashed_streams; - params.config = config; + params.unhashed_streams = unhashed_streams; + params.inode_table = inode_table; + params.sd_set = sd_set; + params.config = &config; params.add_flags = add_flags; params.extra_arg = extra_arg; - params.progress_func = progress_func; + params.progfunc = wim->progfunc; + params.progctx = wim->progctx; params.progress.scan.source = fs_source_path; params.progress.scan.wim_target_path = wim_target_path; - if (progress_func) - progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, ¶ms.progress); - if (config) { - config->_prefix = fs_source_path; - config->_prefix_num_tchars = tstrlen(fs_source_path); - } + ret = call_progress(params.progfunc, WIMLIB_PROGRESS_MSG_SCAN_BEGIN, + ¶ms.progress, params.progctx); + if (ret) + goto out_destroy_config; - if (wim_target_path[0] == T('\0')) + if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path)) params.add_flags |= WIMLIB_ADD_FLAG_ROOT; ret = (*capture_tree)(&branch, fs_source_path, ¶ms); if (ret) - goto out_destroy_sd_set; + goto out_destroy_config; + + ret = call_progress(params.progfunc, WIMLIB_PROGRESS_MSG_SCAN_END, + ¶ms.progress, params.progctx); + if (ret) { + free_dentry_tree(branch, wim->lookup_table); + goto out_cleanup_after_capture; + } - if (branch) { - /* Use the target name, not the source name, for - * the root of each branch from a capture - * source. (This will also set the root dentry - * of the entire image to be unnamed.) */ - ret = dentry_set_name(branch, - path_basename(wim_target_path)); + if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path) && + branch && !dentry_is_directory(branch)) + { + ERROR("\"%"TS"\" is not a directory!", fs_source_path); + ret = WIMLIB_ERR_NOTDIR; + free_dentry_tree(branch, wim->lookup_table); + goto out_cleanup_after_capture; + } + + ret = attach_branch(branch, wim_target_path, j, + add_flags, params.progfunc, params.progctx); + if (ret) + goto out_cleanup_after_capture; + + if (config_file && (add_flags & WIMLIB_ADD_FLAG_WIMBOOT) && + WIMLIB_IS_WIM_ROOT_PATH(wim_target_path)) + { + params.add_flags = 0; + params.progfunc = NULL; + params.config = NULL; + + /* If a capture configuration file was explicitly specified when + * capturing an image in WIMBoot mode, save it as + * /Windows/System32/WimBootCompress.ini in the WIM image. */ + ret = platform_default_capture_tree(&branch, config_file, ¶ms); if (ret) - goto out_ntfs_umount; + goto out_cleanup_after_capture; - ret = attach_branch(&imd->root_dentry, branch, wim_target_path, - WIMLIB_CASE_PLATFORM_DEFAULT); + ret = attach_branch(branch, wimboot_cfgfile, j, 0, NULL, NULL); if (ret) - goto out_ntfs_umount; + goto out_cleanup_after_capture; } - if (progress_func) - progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, ¶ms.progress); - list_splice_tail(&unhashed_streams, &imd->unhashed_streams); + #ifdef WITH_NTFS_3G - imd->ntfs_vol = ntfs_vol; + wim_get_current_image_metadata(wim)->ntfs_vol = ntfs_vol; #endif - inode_table_prepare_inode_list(¶ms.inode_table, &imd->inode_list); - ret = 0; - rollback_sd = false; if (add_flags & WIMLIB_ADD_FLAG_RPFIX) wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX; - goto out_destroy_sd_set; -out_ntfs_umount: + ret = 0; + goto out_destroy_config; +out_cleanup_after_capture: #ifdef WITH_NTFS_3G if (ntfs_vol) do_ntfs_umount(ntfs_vol); #endif - free_dentry_tree(branch, wim->lookup_table); -out_destroy_sd_set: - destroy_sd_set(¶ms.sd_set, rollback_sd); -out_destroy_inode_table: - destroy_inode_table(¶ms.inode_table); +out_destroy_config: + destroy_capture_config(&config); out: return ret; } static int -execute_delete_command(WIMStruct *wim, +execute_delete_command(struct update_command_journal *j, + WIMStruct *wim, const struct wimlib_update_command *delete_cmd) { int flags; const tchar *wim_path; struct wim_dentry *tree; - bool is_root; - wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE); flags = delete_cmd->delete_.delete_flags; wim_path = delete_cmd->delete_.wim_path; @@ -332,25 +914,126 @@ execute_delete_command(WIMStruct *wim, return WIMLIB_ERR_IS_DIRECTORY; } - is_root = dentry_is_root(tree); - unlink_dentry(tree); - free_dentry_tree(tree, wim->lookup_table); - if (is_root) - wim->image_metadata[wim->current_image - 1]->root_dentry = NULL; + return journaled_unlink(j, tree); +} + +static int +free_dentry_full_path(struct wim_dentry *dentry, void *_ignore) +{ + FREE(dentry->_full_path); + dentry->_full_path = NULL; + return 0; +} + +/* Is @d1 a (possibly nonproper) ancestor of @d2? */ +static bool +is_ancestor(const struct wim_dentry *d1, const struct wim_dentry *d2) +{ + for (;;) { + if (d2 == d1) + return true; + if (dentry_is_root(d2)) + return false; + d2 = d2->parent; + } +} + +/* Rename a file or directory in the WIM. + * + * This returns a -errno value. + * + * The journal @j is optional. + */ +int +rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to, + CASE_SENSITIVITY_TYPE case_type, + struct update_command_journal *j) +{ + struct wim_dentry *src; + struct wim_dentry *dst; + struct wim_dentry *parent_of_dst; + int ret; + + /* This rename() implementation currently only supports actual files + * (not alternate data streams) */ + + src = get_dentry(wim, from, case_type); + if (!src) + return -errno; + + dst = get_dentry(wim, to, case_type); + + if (dst) { + /* Destination file exists */ + + if (src == dst) /* Same file */ + return 0; + + if (!dentry_is_directory(src)) { + /* Cannot rename non-directory to directory. */ + if (dentry_is_directory(dst)) + return -EISDIR; + } else { + /* Cannot rename directory to a non-directory or a non-empty + * directory */ + if (!dentry_is_directory(dst)) + return -ENOTDIR; + if (dentry_has_children(dst)) + return -ENOTEMPTY; + } + parent_of_dst = dst->parent; + } else { + /* Destination does not exist */ + parent_of_dst = get_parent_dentry(wim, to, case_type); + if (!parent_of_dst) + return -errno; + + if (!dentry_is_directory(parent_of_dst)) + return -ENOTDIR; + } + + /* @src can't be an ancestor of @dst. Otherwise we're unlinking @src + * from the tree and creating a loop... */ + if (is_ancestor(src, parent_of_dst)) + return -EBUSY; + + if (j) { + if (dst) + if (journaled_unlink(j, dst)) + return -ENOMEM; + if (journaled_unlink(j, src)) + return -ENOMEM; + if (journaled_change_name(j, src, path_basename(to))) + return -ENOMEM; + if (journaled_link(j, src, parent_of_dst)) + return -ENOMEM; + } else { + ret = dentry_set_name(src, path_basename(to)); + if (ret) + return -ENOMEM; + if (dst) { + unlink_dentry(dst); + free_dentry_tree(dst, wim->lookup_table); + } + unlink_dentry(src); + dentry_add_child(parent_of_dst, src); + } + if (src->_full_path) + for_dentry_in_tree(src, free_dentry_full_path, NULL); return 0; } + static int -execute_rename_command(WIMStruct *wim, +execute_rename_command(struct update_command_journal *j, + WIMStruct *wim, const struct wimlib_update_command *rename_cmd) { int ret; - wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME); - ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path, rename_cmd->rename.wim_target_path, - WIMLIB_CASE_PLATFORM_DEFAULT); + WIMLIB_CASE_PLATFORM_DEFAULT, j); if (ret) { ret = -ret; errno = ret; @@ -365,6 +1048,9 @@ execute_rename_command(WIMStruct *wim, ret = WIMLIB_ERR_NOTDIR; break; case ENOTEMPTY: + case EBUSY: + /* XXX: EBUSY is returned when the rename would create a + * loop. It maybe should have its own error code. */ ret = WIMLIB_ERR_NOTEMPTY; break; case EISDIR: @@ -395,69 +1081,126 @@ update_op_to_str(int op) } } +static bool +have_command_type(const struct wimlib_update_command *cmds, size_t num_cmds, + enum wimlib_update_op op) +{ + for (size_t i = 0; i < num_cmds; i++) + if (cmds[i].op == op) + return true; + return false; +} + static int execute_update_commands(WIMStruct *wim, const struct wimlib_update_command *cmds, size_t num_cmds, - int update_flags, - wimlib_progress_func_t progress_func) + int update_flags) { - int ret = 0; + struct wim_inode_table *inode_table; + struct wim_sd_set *sd_set; + struct list_head unhashed_streams; + struct update_command_journal *j; union wimlib_progress_info info; + int ret; + + if (have_command_type(cmds, num_cmds, WIMLIB_UPDATE_OP_ADD)) { + /* If we have at least one "add" command, create the inode and + * security descriptor tables to index new inodes and new + * security descriptors, respectively. */ + inode_table = alloca(sizeof(struct wim_inode_table)); + sd_set = alloca(sizeof(struct wim_sd_set)); + + ret = init_inode_table(inode_table, 9001); + if (ret) + goto out; + + ret = init_sd_set(sd_set, wim_get_current_security_data(wim)); + if (ret) + goto out_destroy_inode_table; + + INIT_LIST_HEAD(&unhashed_streams); + } else { + inode_table = NULL; + sd_set = NULL; + } + + /* Start an in-memory journal to allow rollback if something goes wrong + */ + j = new_update_command_journal(num_cmds, + &wim_get_current_image_metadata(wim)->root_dentry, + wim->lookup_table); + if (!j) { + ret = WIMLIB_ERR_NOMEM; + goto out_destroy_sd_set; + } + info.update.completed_commands = 0; info.update.total_commands = num_cmds; + ret = 0; for (size_t i = 0; i < num_cmds; i++) { DEBUG("Executing update command %zu of %zu (op=%"TS")", i + 1, num_cmds, update_op_to_str(cmds[i].op)); - if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS && - progress_func) - { - info.update.command = &cmds[i]; - (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND, - &info); + info.update.command = &cmds[i]; + if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS) { + ret = call_progress(wim->progfunc, + WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND, + &info, wim->progctx); + if (ret) + goto rollback; } + + ret = WIMLIB_ERR_INVALID_PARAM; switch (cmds[i].op) { case WIMLIB_UPDATE_OP_ADD: - ret = execute_add_command(wim, &cmds[i], progress_func); + ret = execute_add_command(j, wim, &cmds[i], inode_table, + sd_set, &unhashed_streams); break; case WIMLIB_UPDATE_OP_DELETE: - ret = execute_delete_command(wim, &cmds[i]); + ret = execute_delete_command(j, wim, &cmds[i]); break; case WIMLIB_UPDATE_OP_RENAME: - ret = execute_rename_command(wim, &cmds[i]); + ret = execute_rename_command(j, wim, &cmds[i]); break; - default: - wimlib_assert(0); } - if (ret) - break; + if (unlikely(ret)) + goto rollback; info.update.completed_commands++; - if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS && - progress_func) - { - (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND, - &info); + if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS) { + ret = call_progress(wim->progfunc, + WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND, + &info, wim->progctx); + if (ret) + goto rollback; } + next_command(j); } - return ret; -} + commit_update(j); + if (inode_table) { + struct wim_image_metadata *imd; -tchar *winpats[] = { - T("/$ntfs.log"), - T("/hiberfil.sys"), - T("/pagefile.sys"), - T("/System Volume Information"), - T("/RECYCLER"), - T("/Windows/CSC"), -}; + imd = wim_get_current_image_metadata(wim); + + list_splice_tail(&unhashed_streams, &imd->unhashed_streams); + inode_table_prepare_inode_list(inode_table, &imd->inode_list); + } + goto out_destroy_sd_set; + +rollback: + if (sd_set) + rollback_new_security_descriptors(sd_set); + rollback_update(j); +out_destroy_sd_set: + if (sd_set) + destroy_sd_set(sd_set); +out_destroy_inode_table: + if (inode_table) + destroy_inode_table(inode_table); +out: + return ret; +} -static const struct wimlib_capture_config winconfig = { - .exclusion_pats = { - .num_pats = ARRAY_LEN(winpats), - .pats = winpats, - }, -}; static int check_add_command(struct wimlib_update_command *cmd, @@ -468,7 +1211,7 @@ check_add_command(struct wimlib_update_command *cmd, if (add_flags & ~(WIMLIB_ADD_FLAG_NTFS | WIMLIB_ADD_FLAG_DEREFERENCE | WIMLIB_ADD_FLAG_VERBOSE | - /* BOOT doesn't make sense for wimlib_update_image() */ + /* BOOT doesn't make sense for wimlib_update_image(). */ /*WIMLIB_ADD_FLAG_BOOT |*/ WIMLIB_ADD_FLAG_UNIX_DATA | WIMLIB_ADD_FLAG_NO_ACLS | @@ -477,23 +1220,24 @@ check_add_command(struct wimlib_update_command *cmd, WIMLIB_ADD_FLAG_RPFIX | WIMLIB_ADD_FLAG_NORPFIX | WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE | - WIMLIB_ADD_FLAG_WINCONFIG)) + WIMLIB_ADD_FLAG_WINCONFIG | + WIMLIB_ADD_FLAG_WIMBOOT | + WIMLIB_ADD_FLAG_NO_REPLACE)) return WIMLIB_ERR_INVALID_PARAM; - /* Are we adding the entire image or not? An empty wim_target_path - * indicates that the tree we're adding is to be placed in the root of - * the image. We consider this to be capturing the entire image, - * although it could potentially be an overlay on an existing root as - * well. */ - bool is_entire_image = cmd->add.wim_target_path[0] == T('\0'); + bool is_entire_image = WIMLIB_IS_WIM_ROOT_PATH(cmd->add.wim_target_path); -#ifdef __WIN32__ - /* Check for flags not supported on Windows */ +#ifndef WITH_NTFS_3G if (add_flags & WIMLIB_ADD_FLAG_NTFS) { - ERROR("wimlib was compiled without support for NTFS-3g, so"); - ERROR("we cannot capture a WIM image directly from a NTFS volume"); + ERROR("wimlib was compiled without support for NTFS-3g, so\n" + " we cannot capture a WIM image directly " + "from an NTFS volume"); return WIMLIB_ERR_UNSUPPORTED; } +#endif + +#ifdef __WIN32__ + /* Check for flags not supported on Windows */ if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) { ERROR("Capturing UNIX-specific data is not supported on Windows"); return WIMLIB_ERR_UNSUPPORTED; @@ -533,7 +1277,7 @@ check_add_command(struct wimlib_update_command *cmd, if (!is_entire_image) { if (add_flags & WIMLIB_ADD_FLAG_NTFS) { - ERROR("Cannot add directly from a NTFS volume " + ERROR("Cannot add directly from an NTFS volume " "when not capturing a full image!"); return WIMLIB_ERR_INVALID_PARAM; } @@ -602,9 +1346,7 @@ free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds) for (size_t i = 0; i < num_cmds; i++) { switch (cmds[i].op) { case WIMLIB_UPDATE_OP_ADD: - FREE(cmds[i].add.fs_source_path); FREE(cmds[i].add.wim_target_path); - free_capture_config(cmds[i].add.config); break; case WIMLIB_UPDATE_OP_DELETE: FREE(cmds[i].delete_.wim_path); @@ -626,7 +1368,6 @@ copy_update_commands(const struct wimlib_update_command *cmds, { int ret; struct wimlib_update_command *cmds_copy; - const struct wimlib_capture_config *config; cmds_copy = CALLOC(num_cmds, sizeof(cmds[0])); if (!cmds_copy) @@ -636,22 +1377,12 @@ copy_update_commands(const struct wimlib_update_command *cmds, cmds_copy[i].op = cmds[i].op; switch (cmds[i].op) { case WIMLIB_UPDATE_OP_ADD: - cmds_copy[i].add.fs_source_path = - canonicalize_fs_path(cmds[i].add.fs_source_path); + cmds_copy[i].add.fs_source_path = cmds[i].add.fs_source_path; cmds_copy[i].add.wim_target_path = canonicalize_wim_path(cmds[i].add.wim_target_path); - if (!cmds_copy[i].add.fs_source_path || - !cmds_copy[i].add.wim_target_path) + if (!cmds_copy[i].add.wim_target_path) goto oom; - config = cmds[i].add.config; - if (cmds[i].add.add_flags & WIMLIB_ADD_FLAG_WINCONFIG) - config = &winconfig; - if (config) { - ret = copy_and_canonicalize_capture_config(config, - &cmds_copy[i].add.config); - if (ret) - goto err; - } + cmds_copy[i].add.config_file = cmds[i].add.config_file; cmds_copy[i].add.add_flags = cmds[i].add.add_flags; break; case WIMLIB_UPDATE_OP_DELETE: @@ -693,23 +1424,17 @@ wimlib_update_image(WIMStruct *wim, int image, const struct wimlib_update_command *cmds, size_t num_cmds, - int update_flags, - wimlib_progress_func_t progress_func) + int update_flags) { int ret; struct wimlib_update_command *cmds_copy; - bool deletion_requested = false; if (update_flags & ~WIMLIB_UPDATE_FLAG_SEND_PROGRESS) return WIMLIB_ERR_INVALID_PARAM; DEBUG("Updating image %d with %zu commands", image, num_cmds); - for (size_t i = 0; i < num_cmds; i++) - if (cmds[i].op == WIMLIB_UPDATE_OP_DELETE) - deletion_requested = true; - - if (deletion_requested) + if (have_command_type(cmds, num_cmds, WIMLIB_UPDATE_OP_DELETE)) ret = can_delete_from_wim(wim); else ret = can_modify_wim(wim); @@ -722,11 +1447,6 @@ wimlib_update_image(WIMStruct *wim, if (ret) goto out; - /* Short circuit a successful return if no commands were specified. - * Avoids problems with trying to allocate 0 bytes of memory. */ - if (num_cmds == 0) - goto out; - DEBUG("Preparing %zu update commands", num_cmds); /* Make a copy of the update commands, in the process doing certain @@ -745,8 +1465,7 @@ wimlib_update_image(WIMStruct *wim, /* Actually execute the update commands. */ DEBUG("Executing %zu update commands", num_cmds); - ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags, - progress_func); + ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags); if (ret) goto out_free_cmds_copy; @@ -761,3 +1480,52 @@ out_free_cmds_copy: out: return ret; } + +static int +update1(WIMStruct *wim, int image, const struct wimlib_update_command *cmd) +{ + return wimlib_update_image(wim, image, cmd, 1, 0); +} + +WIMLIBAPI int +wimlib_delete_path(WIMStruct *wim, int image, + const tchar *path, int delete_flags) +{ + struct wimlib_update_command cmd; + + cmd.op = WIMLIB_UPDATE_OP_DELETE; + cmd.delete_.wim_path = (tchar *)path; + cmd.delete_.delete_flags = delete_flags; + + return update1(wim, image, &cmd); +} + +WIMLIBAPI int +wimlib_rename_path(WIMStruct *wim, int image, + const tchar *source_path, const tchar *dest_path) +{ + struct wimlib_update_command cmd; + + cmd.op = WIMLIB_UPDATE_OP_RENAME; + cmd.rename.wim_source_path = (tchar *)source_path; + cmd.rename.wim_target_path = (tchar *)dest_path; + cmd.rename.rename_flags = 0; + + return update1(wim, image, &cmd); +} + +WIMLIBAPI int +wimlib_add_tree(WIMStruct *wim, int image, + const tchar *fs_source_path, const tchar *wim_target_path, + int add_flags) +{ + struct wimlib_update_command cmd; + + cmd.op = WIMLIB_UPDATE_OP_ADD; + cmd.add.fs_source_path = (tchar *)fs_source_path; + cmd.add.wim_target_path = (tchar *)wim_target_path; + cmd.add.add_flags = add_flags; + cmd.add.config_file = NULL; + + return update1(wim, image, &cmd); +}