X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fupdate_image.c;h=b973c21d8a896ac1d4b28ba570f9bf197c144fb3;hb=8895e346ab7a4df65c980ba435d1e5d1c2654d3f;hp=cda3797d53350f36c3cfc84c1155ee591c508847;hpb=147ac5db9840bcca2c35f37b90289621063551ed;p=wimlib diff --git a/src/update_image.c b/src/update_image.c index cda3797d..b973c21d 100644 --- a/src/update_image.c +++ b/src/update_image.c @@ -1,33 +1,64 @@ /* - * update_image.c - Update a WIM image. + * update_image.c - see description below */ /* * Copyright (C) 2013, 2014 Eric Biggers * - * This file is part of wimlib, a library for working with WIM files. + * This file 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 3 of the License, or (at your option) any + * later version. * - * wimlib is free software; you can redistribute it and/or modify it under the - * 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 General Public License for more + * This file 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 * details. * - * You should have received a copy of the GNU General Public License - * along with wimlib; if not, see http://www.gnu.org/licenses/. + * You should have received a copy of the GNU Lesser General Public License + * along with this file; if not, see http://www.gnu.org/licenses/. + */ + +/* + * This file contains the implementation of wimlib_update_image(), which is one + * of the two ways by which library users can make changes to a WIM image. (The + * other way is by mounting an image read-write.) wimlib_update_image() is also + * used in the implementation of wimlib_add_image(), since "create a WIM image + * from this directory tree" is equivalent to "create an empty WIM image, then + * update it to add this directory tree as the root". + * + * wimlib_update_image() processes a list of commands passed to it. Currently, + * the following types of commands are supported: + * + * - Add a directory tree from an external source (filesystem or NTFS volume). + * This can be used to add new files or to replace existing files. + * - Delete a file or directory tree. + * - Rename a file or directory tree. + * + * Not supported are creating links to existing files or changing metadata of + * existing files. + * + * wimlib_update_image() is atomic. If it cannot complete successfully, then + * all changes are rolled back and the WIMStruct is left unchanged. Rollback is + * implemented by breaking the commands into primitive operations such as "link + * this dentry tree here" which can be undone by doing the opposite operations + * in reverse order. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif +#include +#include +#include + +#include "wimlib/alloca.h" +#include "wimlib/assert.h" #include "wimlib/capture.h" #include "wimlib/dentry.h" #include "wimlib/encoding.h" +#include "wimlib/endianness.h" #include "wimlib/error.h" #include "wimlib/lookup_table.h" #include "wimlib/metadata.h" @@ -35,16 +66,9 @@ # 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 - -#ifdef HAVE_ALLOCA_H -# include -#endif - /* Saved specification of a "primitive" update operation that was performed. */ struct update_primitive { enum { @@ -211,13 +235,13 @@ do_unlink(struct wim_dentry *subject, struct wim_dentry *parent, { if (parent) { /* Unlink @subject from its @parent. */ - wimlib_assert(subject->parent == parent); + wimlib_assert(subject->d_parent == parent); unlink_dentry(subject); } else { /* Unset @subject as the root of the image. */ *root_p = NULL; } - subject->parent = subject; + subject->d_parent = subject; } static void @@ -361,7 +385,7 @@ journaled_unlink(struct update_command_journal *j, struct wim_dentry *subject) if (dentry_is_root(subject)) parent = NULL; else - parent = subject->parent; + parent = subject->d_parent; prim.type = UNLINK_DENTRY; prim.link.subject = subject; @@ -401,8 +425,10 @@ journaled_change_name(struct update_command_journal *j, prim.name.subject = dentry; prim.name.old_name = dentry->file_name; ret = record_update_primitive(j, prim); - if (ret) + if (ret) { + FREE(new_name); return ret; + } dentry->file_name = new_name; dentry->file_name_nbytes = new_name_nbytes; @@ -458,7 +484,8 @@ rollback_update(struct 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 progress_func) + 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); @@ -495,7 +522,8 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, unlink_dentry(new_child); if (existing_child) { ret = handle_conflict(new_child, existing_child, - j, add_flags, progress_func); + j, add_flags, + progfunc, progctx); } else { ret = journaled_link(j, new_child, existing); } @@ -504,7 +532,7 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, return ret; } } - free_dentry(branch); + free_dentry_tree(branch, j->lookup_table); return 0; } else if (add_flags & WIMLIB_ADD_FLAG_NO_REPLACE) { /* Can't replace nondirectory file */ @@ -516,34 +544,35 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, struct wim_dentry *parent; int ret; - parent = existing->parent; + parent = existing->d_parent; ret = calculate_dentry_full_path(existing); if (ret) return ret; - ret = journaled_unlink(j, existing); - if (ret) - return ret; - - ret = journaled_link(j, branch, parent); - if (ret) - return ret; - - if (progress_func && (add_flags & WIMLIB_ADD_FLAG_VERBOSE)) { + if (add_flags & WIMLIB_ADD_FLAG_VERBOSE) { union wimlib_progress_info info; info.replace.path_in_wim = existing->_full_path; - progress_func(WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM, &info); + ret = call_progress(progfunc, + WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM, + &info, progctx); + if (ret) + return ret; } - return 0; + + ret = journaled_unlink(j, existing); + if (ret) + return ret; + + return journaled_link(j, branch, parent); } } static int do_attach_branch(struct wim_dentry *branch, const utf16lechar *target, struct update_command_journal *j, - int add_flags, wimlib_progress_func_t progress_func) + int add_flags, wimlib_progress_func_t progfunc, void *progctx) { struct wim_dentry *parent; struct wim_dentry *existing; @@ -627,8 +656,8 @@ do_attach_branch(struct wim_dentry *branch, const utf16lechar *target, /* Last component */ if (existing) { - return handle_conflict(branch, existing, j, - add_flags, progress_func); + return handle_conflict(branch, existing, j, add_flags, + progfunc, progctx); } else { return journaled_link(j, branch, parent); } @@ -649,8 +678,8 @@ do_attach_branch(struct wim_dentry *branch, const utf16lechar *target, */ static int attach_branch(struct wim_dentry *branch, const tchar *target_tstr, - struct update_command_journal *j, - int add_flags, wimlib_progress_func_t progress_func) + struct update_command_journal *j, int add_flags, + wimlib_progress_func_t progfunc, void *progctx) { int ret; const utf16lechar *target; @@ -668,7 +697,7 @@ attach_branch(struct wim_dentry *branch, const tchar *target_tstr, if (ret) goto out_free_target; - ret = do_attach_branch(branch, target, j, add_flags, progress_func); + ret = do_attach_branch(branch, target, j, add_flags, progfunc, progctx); if (ret) goto out_free_target; /* branch was successfully committed to the journal */ @@ -753,15 +782,14 @@ execute_add_command(struct update_command_journal *j, const struct wimlib_update_command *add_cmd, struct wim_inode_table *inode_table, struct wim_sd_set *sd_set, - struct list_head *unhashed_streams, - wimlib_progress_func_t progress_func) + struct list_head *unhashed_streams) { int ret; int add_flags; tchar *fs_source_path; tchar *wim_target_path; const tchar *config_file; - struct add_image_params params; + struct capture_params params; struct capture_config config; capture_tree_t capture_tree = platform_default_capture_tree; #ifdef WITH_NTFS_3G @@ -805,11 +833,14 @@ execute_add_command(struct update_command_journal *j, 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); + ret = call_progress(params.progfunc, WIMLIB_PROGRESS_MSG_SCAN_BEGIN, + ¶ms.progress, params.progctx); + if (ret) + goto out_destroy_config; if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path)) params.add_flags |= WIMLIB_ADD_FLAG_ROOT; @@ -817,8 +848,12 @@ execute_add_command(struct update_command_journal *j, if (ret) goto out_destroy_config; - if (progress_func) - progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, ¶ms.progress); + 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 (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path) && branch && !dentry_is_directory(branch)) @@ -830,7 +865,7 @@ execute_add_command(struct update_command_journal *j, } ret = attach_branch(branch, wim_target_path, j, - add_flags, params.progress_func); + add_flags, params.progfunc, params.progctx); if (ret) goto out_cleanup_after_capture; @@ -838,7 +873,7 @@ execute_add_command(struct update_command_journal *j, WIMLIB_IS_WIM_ROOT_PATH(wim_target_path)) { params.add_flags = 0; - params.progress_func = NULL; + params.progfunc = NULL; params.config = NULL; /* If a capture configuration file was explicitly specified when @@ -848,7 +883,7 @@ execute_add_command(struct update_command_journal *j, if (ret) goto out_cleanup_after_capture; - ret = attach_branch(branch, wimboot_cfgfile, j, 0, NULL); + ret = attach_branch(branch, wimboot_cfgfile, j, 0, NULL, NULL); if (ret) goto out_cleanup_after_capture; } @@ -856,8 +891,6 @@ execute_add_command(struct update_command_journal *j, #ifdef WITH_NTFS_3G wim_get_current_image_metadata(wim)->ntfs_vol = ntfs_vol; #endif - if (add_flags & WIMLIB_ADD_FLAG_RPFIX) - wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX; ret = 0; goto out_destroy_config; out_cleanup_after_capture: @@ -917,14 +950,14 @@ free_dentry_full_path(struct wim_dentry *dentry, void *_ignore) /* Is @d1 a (possibly nonproper) ancestor of @d2? */ static bool -is_ancestor(struct wim_dentry *d1, struct wim_dentry *d2) +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; + d2 = d2->d_parent; } } @@ -971,7 +1004,7 @@ rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to, if (dentry_has_children(dst)) return -ENOTEMPTY; } - parent_of_dst = dst->parent; + parent_of_dst = dst->d_parent; } else { /* Destination does not exist */ parent_of_dst = get_parent_dentry(wim, to, case_type); @@ -1085,8 +1118,7 @@ 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) { struct wim_inode_table *inode_table; struct wim_sd_set *sd_set; @@ -1132,19 +1164,19 @@ execute_update_commands(WIMStruct *wim, 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(j, wim, &cmds[i], inode_table, - sd_set, &unhashed_streams, - progress_func); + sd_set, &unhashed_streams); break; case WIMLIB_UPDATE_OP_DELETE: ret = execute_delete_command(j, wim, &cmds[i]); @@ -1156,11 +1188,12 @@ execute_update_commands(WIMStruct *wim, 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); } @@ -1211,7 +1244,8 @@ check_add_command(struct wimlib_update_command *cmd, WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE | WIMLIB_ADD_FLAG_WINCONFIG | WIMLIB_ADD_FLAG_WIMBOOT | - WIMLIB_ADD_FLAG_NO_REPLACE)) + WIMLIB_ADD_FLAG_NO_REPLACE | + WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION)) return WIMLIB_ERR_INVALID_PARAM; bool is_entire_image = WIMLIB_IS_WIM_ROOT_PATH(cmd->add.wim_target_path); @@ -1266,7 +1300,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; } @@ -1413,8 +1447,7 @@ 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; @@ -1424,14 +1457,6 @@ wimlib_update_image(WIMStruct *wim, DEBUG("Updating image %d with %zu commands", image, num_cmds); - if (have_command_type(cmds, num_cmds, WIMLIB_UPDATE_OP_DELETE)) - ret = can_delete_from_wim(wim); - else - ret = can_modify_wim(wim); - - if (ret) - goto out; - /* Load the metadata for the image to modify (if not loaded already) */ ret = select_wim_image(wim, image); if (ret) @@ -1455,8 +1480,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; @@ -1466,18 +1490,17 @@ wimlib_update_image(WIMStruct *wim, * directories, may have changed. Call xml_update_image_info() to * recalculate these statistics. */ xml_update_image_info(wim, image); + + for (size_t i = 0; i < num_cmds; i++) + if (cmds_copy[i].op == WIMLIB_UPDATE_OP_ADD && + cmds_copy[i].add.add_flags & WIMLIB_ADD_FLAG_RPFIX) + wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX; out_free_cmds_copy: free_update_commands(cmds_copy, num_cmds); 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, NULL); -} - WIMLIBAPI int wimlib_delete_path(WIMStruct *wim, int image, const tchar *path, int delete_flags) @@ -1488,7 +1511,7 @@ wimlib_delete_path(WIMStruct *wim, int image, cmd.delete_.wim_path = (tchar *)path; cmd.delete_.delete_flags = delete_flags; - return update1(wim, image, &cmd); + return wimlib_update_image(wim, image, &cmd, 1, 0); } WIMLIBAPI int @@ -1502,7 +1525,7 @@ wimlib_rename_path(WIMStruct *wim, int image, cmd.rename.wim_target_path = (tchar *)dest_path; cmd.rename.rename_flags = 0; - return update1(wim, image, &cmd); + return wimlib_update_image(wim, image, &cmd, 1, 0); } WIMLIBAPI int @@ -1518,5 +1541,5 @@ wimlib_add_tree(WIMStruct *wim, int image, cmd.add.add_flags = add_flags; cmd.add.config_file = NULL; - return update1(wim, image, &cmd); + return wimlib_update_image(wim, image, &cmd, 1, 0); }