X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fupdate_image.c;h=c24ee1947ba498b9edd0fe0284d4f4580840af14;hp=81c17244141baf42f9a48890a7422a0b5835c59a;hb=fb38bf47c4be7488addb7f2767bb27ffc87e1ea3;hpb=3071e89c11d1be71cf45b694432e5908e0c4ded9 diff --git a/src/update_image.c b/src/update_image.c index 81c17244..c24ee194 100644 --- a/src/update_image.c +++ b/src/update_image.c @@ -1,5 +1,5 @@ /* - * update_image.c - Update a WIM image. + * update_image.c - see description below */ /* @@ -19,31 +19,52 @@ * 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/blob_table.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" -#ifdef WITH_NTFS_3G -# 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 +#include "wimlib/xml_windows.h" /* Saved specification of a "primitive" update operation that was performed. */ struct update_primitive { @@ -110,8 +131,8 @@ struct update_command_journal { /* 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; + /* Pointer to the blob table of the WIM (may needed for rollback) */ + struct blob_table *blob_table; /* List of dentries that are currently unlinked from the WIM image. * These must be freed when no longer needed for commit or rollback. */ @@ -133,7 +154,7 @@ init_update_primitive_list(struct update_primitive_list *l) * 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 blob_table *blob_table) { struct update_command_journal *j; @@ -142,7 +163,7 @@ new_update_command_journal(size_t num_cmds, struct wim_dentry **root_p, j->num_cmds = num_cmds; j->cur_cmd = 0; j->root_p = root_p; - j->lookup_table = lookup_table; + j->blob_table = blob_table; INIT_LIST_HEAD(&j->orphans); for (size_t i = 0; i < num_cmds; i++) init_update_primitive_list(&j->cmd_prims[i]); @@ -160,9 +181,9 @@ free_update_command_journal(struct update_command_journal *j) /* 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); + struct wim_dentry, d_tmp_list); + list_del(&orphan->d_tmp_list); + free_dentry_tree(orphan, j->blob_table); } for (size_t i = 0; i < j->num_cmds; i++) @@ -245,8 +266,8 @@ rollback_link(struct wim_dentry *subject, struct wim_dentry *parent, do_unlink(subject, parent, root_p); /* @subject is now unlinked. Add it to orphans. */ - list_add(&subject->tmp_list, orphans); - subject->is_orphan = 1; + list_add(&subject->d_tmp_list, orphans); + subject->d_is_orphan = 1; } /* Undo an unlink operation. */ @@ -258,8 +279,8 @@ rollback_unlink(struct wim_dentry *subject, struct wim_dentry *parent, do_link(subject, parent, root_p); /* @subject is no longer unlinked. Delete it from orphans. */ - list_del(&subject->tmp_list); - subject->is_orphan = 0; + list_del(&subject->d_tmp_list); + subject->d_is_orphan = 0; } /* Rollback a name change operation. */ @@ -271,7 +292,7 @@ rollback_name_change(utf16lechar *old_name, FREE(*name_ptr); if (old_name) { *name_ptr = old_name; - *name_nbytes_ptr = utf16le_strlen(old_name); + *name_nbytes_ptr = utf16le_len_bytes(old_name); } else { *name_ptr = NULL; *name_nbytes_ptr = 0; @@ -294,13 +315,13 @@ rollback_update_primitive(const struct update_primitive *prim, break; case CHANGE_FILE_NAME: rollback_name_change(prim->name.old_name, - &prim->name.subject->file_name, - &prim->name.subject->file_name_nbytes); + &prim->name.subject->d_name, + &prim->name.subject->d_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); + &prim->name.subject->d_short_name, + &prim->name.subject->d_short_name_nbytes); break; } } @@ -341,9 +362,9 @@ journaled_link(struct update_command_journal *j, do_link(subject, parent, j->root_p); - if (subject->is_orphan) { - list_del(&subject->tmp_list); - subject->is_orphan = 0; + if (subject->d_is_orphan) { + list_del(&subject->d_tmp_list); + subject->d_is_orphan = 0; } return 0; } @@ -373,8 +394,8 @@ journaled_unlink(struct update_command_journal *j, struct wim_dentry *subject) do_unlink(subject, parent, j->root_p); - list_add(&subject->tmp_list, &j->orphans); - subject->is_orphan = 1; + list_add(&subject->d_tmp_list, &j->orphans); + subject->d_is_orphan = 1; return 0; } @@ -399,26 +420,26 @@ journaled_change_name(struct update_command_journal *j, prim.type = CHANGE_FILE_NAME; prim.name.subject = dentry; - prim.name.old_name = dentry->file_name; + prim.name.old_name = dentry->d_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; + dentry->d_name = new_name; + dentry->d_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; + prim.name.old_name = dentry->d_short_name; ret = record_update_primitive(j, prim); if (ret) return ret; - dentry->short_name = NULL; - dentry->short_name_nbytes = 0; + dentry->d_short_name = NULL; + dentry->d_short_name_nbytes = 0; return 0; } @@ -492,8 +513,8 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, existing_child = get_dentry_child_with_utf16le_name(existing, - new_child->file_name, - new_child->file_name_nbytes, + new_child->d_name, + new_child->d_name_nbytes, WIMLIB_CASE_PLATFORM_DEFAULT); unlink_dentry(new_child); if (existing_child) { @@ -508,7 +529,7 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, return ret; } } - free_dentry(branch); + free_dentry_tree(branch, j->blob_table); return 0; } else if (add_flags & WIMLIB_ADD_FLAG_NO_REPLACE) { /* Can't replace nondirectory file */ @@ -529,7 +550,7 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing, if (add_flags & WIMLIB_ADD_FLAG_VERBOSE) { union wimlib_progress_info info; - info.replace.path_in_wim = existing->_full_path; + info.replace.path_in_wim = existing->d_full_path; ret = call_progress(progfunc, WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM, &info, progctx); @@ -668,7 +689,7 @@ attach_branch(struct wim_dentry *branch, const tchar *target_tstr, if (ret) goto out_free_branch; - BUILD_BUG_ON(WIM_PATH_SEPARATOR != OS_PREFERRED_PATH_SEPARATOR); + STATIC_ASSERT(WIM_PATH_SEPARATOR == OS_PREFERRED_PATH_SEPARATOR); ret = dentry_set_name(branch, path_basename(target_tstr)); if (ret) goto out_free_target; @@ -681,7 +702,7 @@ attach_branch(struct wim_dentry *branch, const tchar *target_tstr, out_free_target: tstr_put_utf16le(target); out_free_branch: - free_dentry_tree(branch, j->lookup_table); + free_dentry_tree(branch, j->blob_table); out: return ret; } @@ -758,20 +779,16 @@ 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) + struct list_head *unhashed_blobs) { 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 - struct _ntfs_volume *ntfs_vol = NULL; -#endif - void *extra_arg = NULL; struct wim_dentry *branch; add_flags = add_cmd->add.add_flags; @@ -779,21 +796,11 @@ execute_add_command(struct update_command_journal *j, wim_target_path = add_cmd->add.wim_target_path; 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)); #ifdef WITH_NTFS_3G - if (add_flags & WIMLIB_ADD_FLAG_NTFS) { - capture_tree = build_dentry_tree_ntfs; - extra_arg = &ntfs_vol; - if (wim_get_current_image_metadata(wim)->ntfs_vol != NULL) { - ERROR("NTFS volume already set"); - ret = WIMLIB_ERR_INVALID_PARAM; - goto out; - } - } + if (add_flags & WIMLIB_ADD_FLAG_NTFS) + capture_tree = ntfs_3g_build_dentry_tree; #endif ret = get_capture_config(config_file, &config, @@ -801,13 +808,12 @@ execute_add_command(struct update_command_journal *j, if (ret) goto out; - params.lookup_table = wim->lookup_table; - params.unhashed_streams = unhashed_streams; + params.blob_table = wim->blob_table; + params.unhashed_blobs = unhashed_blobs; params.inode_table = inode_table; params.sd_set = sd_set; params.config = &config; params.add_flags = add_flags; - params.extra_arg = extra_arg; params.progfunc = wim->progfunc; params.progctx = wim->progctx; @@ -827,8 +833,8 @@ execute_add_command(struct update_command_journal *j, 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; + free_dentry_tree(branch, wim->blob_table); + goto out_destroy_config; } if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path) && @@ -836,14 +842,14 @@ execute_add_command(struct update_command_journal *j, { 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; + free_dentry_tree(branch, wim->blob_table); + goto out_destroy_config; } ret = attach_branch(branch, wim_target_path, j, add_flags, params.progfunc, params.progctx); if (ret) - goto out_cleanup_after_capture; + goto out_destroy_config; if (config_file && (add_flags & WIMLIB_ADD_FLAG_WIMBOOT) && WIMLIB_IS_WIM_ROOT_PATH(wim_target_path)) @@ -857,23 +863,20 @@ execute_add_command(struct update_command_journal *j, * /Windows/System32/WimBootCompress.ini in the WIM image. */ ret = platform_default_capture_tree(&branch, config_file, ¶ms); if (ret) - goto out_cleanup_after_capture; + goto out_destroy_config; ret = attach_branch(branch, wimboot_cfgfile, j, 0, NULL, NULL); if (ret) - goto out_cleanup_after_capture; + goto out_destroy_config; + } + + if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path)) { + ret = set_windows_specific_info(wim); + if (ret) + goto out_destroy_config; } -#ifdef WITH_NTFS_3G - wim_get_current_image_metadata(wim)->ntfs_vol = ntfs_vol; -#endif ret = 0; - goto out_destroy_config; -out_cleanup_after_capture: -#ifdef WITH_NTFS_3G - if (ntfs_vol) - do_ntfs_umount(ntfs_vol); -#endif out_destroy_config: destroy_capture_config(&config); out: @@ -892,8 +895,6 @@ execute_delete_command(struct update_command_journal *j, flags = delete_cmd->delete_.delete_flags; wim_path = delete_cmd->delete_.wim_path; - DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags); - tree = get_dentry(wim, wim_path, WIMLIB_CASE_PLATFORM_DEFAULT); if (!tree) { /* Path to delete does not exist in the WIM. */ @@ -919,8 +920,8 @@ execute_delete_command(struct update_command_journal *j, static int free_dentry_full_path(struct wim_dentry *dentry, void *_ignore) { - FREE(dentry->_full_path); - dentry->_full_path = NULL; + FREE(dentry->d_full_path); + dentry->d_full_path = NULL; return 0; } @@ -1012,12 +1013,12 @@ rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to, return -ENOMEM; if (dst) { unlink_dentry(dst); - free_dentry_tree(dst, wim->lookup_table); + free_dentry_tree(dst, wim->blob_table); } unlink_dentry(src); dentry_add_child(parent_of_dst, src); } - if (src->_full_path) + if (src->d_full_path) for_dentry_in_tree(src, free_dentry_full_path, NULL); return 0; } @@ -1064,22 +1065,6 @@ execute_rename_command(struct update_command_journal *j, return ret; } -static inline const tchar * -update_op_to_str(int op) -{ - switch (op) { - case WIMLIB_UPDATE_OP_ADD: - return T("add"); - case WIMLIB_UPDATE_OP_DELETE: - return T("delete"); - case WIMLIB_UPDATE_OP_RENAME: - return T("rename"); - default: - wimlib_assert(0); - return NULL; - } -} - static bool have_command_type(const struct wimlib_update_command *cmds, size_t num_cmds, enum wimlib_update_op op) @@ -1098,7 +1083,7 @@ execute_update_commands(WIMStruct *wim, { struct wim_inode_table *inode_table; struct wim_sd_set *sd_set; - struct list_head unhashed_streams; + struct list_head unhashed_blobs; struct update_command_journal *j; union wimlib_progress_info info; int ret; @@ -1118,7 +1103,7 @@ execute_update_commands(WIMStruct *wim, if (ret) goto out_destroy_inode_table; - INIT_LIST_HEAD(&unhashed_streams); + INIT_LIST_HEAD(&unhashed_blobs); } else { inode_table = NULL; sd_set = NULL; @@ -1128,7 +1113,7 @@ execute_update_commands(WIMStruct *wim, */ j = new_update_command_journal(num_cmds, &wim_get_current_image_metadata(wim)->root_dentry, - wim->lookup_table); + wim->blob_table); if (!j) { ret = WIMLIB_ERR_NOMEM; goto out_destroy_sd_set; @@ -1138,8 +1123,6 @@ execute_update_commands(WIMStruct *wim, 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)); info.update.command = &cmds[i]; if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS) { ret = call_progress(wim->progfunc, @@ -1152,7 +1135,7 @@ execute_update_commands(WIMStruct *wim, switch (cmds[i].op) { case WIMLIB_UPDATE_OP_ADD: ret = execute_add_command(j, wim, &cmds[i], inode_table, - sd_set, &unhashed_streams); + sd_set, &unhashed_blobs); break; case WIMLIB_UPDATE_OP_DELETE: ret = execute_delete_command(j, wim, &cmds[i]); @@ -1180,7 +1163,7 @@ execute_update_commands(WIMStruct *wim, imd = wim_get_current_image_metadata(wim); - list_splice_tail(&unhashed_streams, &imd->unhashed_streams); + list_splice_tail(&unhashed_blobs, &imd->unhashed_blobs); inode_table_prepare_inode_list(inode_table, &imd->inode_list); } goto out_destroy_sd_set; @@ -1221,22 +1204,22 @@ check_add_command(struct wimlib_update_command *cmd, WIMLIB_ADD_FLAG_WINCONFIG | WIMLIB_ADD_FLAG_WIMBOOT | WIMLIB_ADD_FLAG_NO_REPLACE | - WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION)) + WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION | + WIMLIB_ADD_FLAG_SNAPSHOT)) return WIMLIB_ERR_INVALID_PARAM; bool is_entire_image = WIMLIB_IS_WIM_ROOT_PATH(cmd->add.wim_target_path); #ifndef WITH_NTFS_3G if (add_flags & WIMLIB_ADD_FLAG_NTFS) { - ERROR("wimlib was compiled without support for NTFS-3g, so\n" - " we cannot capture a WIM image directly " - "from an NTFS volume"); + ERROR("NTFS-3g capture mode is unsupported because wimlib " + "was compiled --without-ntfs-3g"); return WIMLIB_ERR_UNSUPPORTED; } #endif #ifdef __WIN32__ - /* Check for flags not supported on Windows */ + /* 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; @@ -1245,6 +1228,15 @@ check_add_command(struct wimlib_update_command *cmd, ERROR("Dereferencing symbolic links is not supported on Windows"); return WIMLIB_ERR_UNSUPPORTED; } +#else + /* Check for flags only supported on Windows. */ + + /* Currently, SNAPSHOT means Windows VSS. In the future, it perhaps + * could be implemented for other types of snapshots, such as btrfs. */ + if (add_flags & WIMLIB_ADD_FLAG_SNAPSHOT) { + ERROR("Snapshot mode is only supported on Windows, where it uses VSS."); + return WIMLIB_ERR_UNSUPPORTED; + } #endif /* VERBOSE implies EXCLUDE_VERBOSE */ @@ -1275,12 +1267,6 @@ check_add_command(struct wimlib_update_command *cmd, } if (!is_entire_image) { - if (add_flags & WIMLIB_ADD_FLAG_NTFS) { - ERROR("Cannot add directly from an NTFS volume " - "when not capturing a full image!"); - return WIMLIB_ERR_INVALID_PARAM; - } - if (add_flags & WIMLIB_ADD_FLAG_RPFIX) { ERROR("Cannot do reparse point fixups when " "not capturing a full image!"); @@ -1426,27 +1412,23 @@ wimlib_update_image(WIMStruct *wim, int update_flags) { int ret; + struct wim_image_metadata *imd; struct wimlib_update_command *cmds_copy; if (update_flags & ~WIMLIB_UPDATE_FLAG_SEND_PROGRESS) return WIMLIB_ERR_INVALID_PARAM; - 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) - goto out; + return ret; - DEBUG("Preparing %zu update commands", num_cmds); + imd = wim->image_metadata[image - 1]; + + /* Don't allow updating an image currently being shared by multiple + * WIMStructs (as a result of an export) */ + if (imd->refcnt > 1) + return WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES; /* Make a copy of the update commands, in the process doing certain * canonicalizations on paths (e.g. translating backslashes to forward @@ -1454,7 +1436,7 @@ wimlib_update_image(WIMStruct *wim, * commands. */ ret = copy_update_commands(cmds, num_cmds, &cmds_copy); if (ret) - goto out; + return ret; /* Perform additional checks on the update commands before we execute * them. */ @@ -1463,17 +1445,11 @@ wimlib_update_image(WIMStruct *wim, goto out_free_cmds_copy; /* Actually execute the update commands. */ - DEBUG("Executing %zu update commands", num_cmds); ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags); if (ret) goto out_free_cmds_copy; - wim->image_metadata[image - 1]->modified = 1; - - /* Statistics about the WIM image, such as the numbers of files and - * directories, may have changed. Call xml_update_image_info() to - * recalculate these statistics. */ - xml_update_image_info(wim, image); + mark_image_dirty(imd); for (size_t i = 0; i < num_cmds; i++) if (cmds_copy[i].op == WIMLIB_UPDATE_OP_ADD && @@ -1481,7 +1457,6 @@ wimlib_update_image(WIMStruct *wim, wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX; out_free_cmds_copy: free_update_commands(cmds_copy, num_cmds); -out: return ret; }