2 * update_image.c - Update a WIM image.
6 * Copyright (C) 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
28 #include "wimlib/capture.h"
29 #include "wimlib/dentry.h"
30 #include "wimlib/error.h"
31 #include "wimlib/lookup_table.h"
32 #include "wimlib/metadata.h"
34 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
36 #include "wimlib/paths.h"
37 #include "wimlib/xml.h"
41 /* Overlays @branch onto @target, both of which must be directories. */
43 do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
45 struct rb_root *rb_root;
47 DEBUG("Doing overlay \"%"WS"\" => \"%"WS"\"",
48 branch->file_name, target->file_name);
50 if (!dentry_is_directory(branch) || !dentry_is_directory(target)) {
51 ERROR("Cannot overlay \"%"WS"\" onto existing dentry: "
52 "is not directory-on-directory!", branch->file_name);
53 return WIMLIB_ERR_INVALID_OVERLAY;
56 rb_root = &branch->d_inode->i_children;
57 LIST_HEAD(moved_children);
58 while (rb_root->rb_node) { /* While @branch has children... */
59 struct wim_dentry *child = rbnode_dentry(rb_root->rb_node);
60 struct wim_dentry *existing;
62 /* Move @child to the directory @target */
64 existing = dentry_add_child(target, child);
66 /* File or directory with same name already exists */
69 ret = do_overlay(existing, child);
71 /* Overlay failed. Revert the changes. */
72 dentry_add_child(branch, child);
73 list_for_each_entry(child, &moved_children, tmp_list)
76 dentry_add_child(branch, child);
81 list_add(&child->tmp_list, &moved_children);
88 /* Attach or overlay a branch onto the WIM image.
91 * Pointer to the root of the WIM image, or pointer to NULL if it has not
96 * Path in the WIM image to add the branch, with leading and trailing
100 attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
104 struct wim_dentry *dentry, *parent, *target;
107 DEBUG("Attaching branch \"%"WS"\" => \"%"TS"\"",
108 branch->file_name, target_path);
110 if (*target_path == T('\0')) {
111 /* Target: root directory */
113 /* Overlay on existing root */
114 return do_overlay(*root_p, branch);
116 if (!dentry_is_directory(branch)) {
117 ERROR("Cannot set non-directory as root of WIM image");
118 return WIMLIB_ERR_NOTDIR;
126 /* Adding a non-root branch. Create root if it hasn't been created
129 ret = new_filler_directory(T(""), root_p);
134 /* Walk the path to the branch, creating filler directories as needed.
137 while ((slash = tstrchr(target_path, WIM_PATH_SEPARATOR))) {
139 dentry = get_dentry_child_with_name(parent, target_path);
141 ret = new_filler_directory(target_path, &dentry);
144 dentry_add_child(parent, dentry);
148 /* Skip over slashes. Note: this cannot overrun the length of
149 * the string because the last character cannot be a slash, as
150 * trailing slashes were tripped. */
153 } while (*target_path == WIM_PATH_SEPARATOR);
156 /* If the target path already existed, overlay the branch onto it.
157 * Otherwise, set the branch as the target path. */
158 target = get_dentry_child_with_utf16le_name(parent, branch->file_name,
159 branch->file_name_nbytes);
161 return do_overlay(target, branch);
163 dentry_add_child(parent, branch);
169 execute_add_command(WIMStruct *wim,
170 const struct wimlib_update_command *add_cmd,
171 wimlib_progress_func_t progress_func)
175 tchar *fs_source_path;
176 tchar *wim_target_path;
177 struct wim_image_metadata *imd;
178 struct list_head unhashed_streams;
179 struct add_image_params params;
180 int (*capture_tree)(struct wim_dentry **,
182 struct add_image_params *);
183 union wimlib_progress_info progress;
184 struct wimlib_capture_config *config;
186 struct _ntfs_volume *ntfs_vol = NULL;
189 struct wim_dentry *branch;
190 bool rollback_sd = true;
192 wimlib_assert(add_cmd->op == WIMLIB_UPDATE_OP_ADD);
193 add_flags = add_cmd->add.add_flags;
194 fs_source_path = add_cmd->add.fs_source_path;
195 wim_target_path = add_cmd->add.wim_target_path;
196 config = add_cmd->add.config;
197 DEBUG("fs_source_path=\"%"TS"\", wim_target_path=\"%"TS"\", add_flags=%#x",
198 fs_source_path, wim_target_path, add_flags);
200 imd = wim->image_metadata[wim->current_image - 1];
202 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
204 capture_tree = build_dentry_tree_ntfs;
205 extra_arg = &ntfs_vol;
206 if (imd->ntfs_vol != NULL) {
207 ERROR("NTFS volume already set");
208 ret = WIMLIB_ERR_INVALID_PARAM;
212 ret = WIMLIB_ERR_INVALID_PARAM;
217 capture_tree = win32_build_dentry_tree;
219 capture_tree = unix_build_dentry_tree;
224 ret = init_inode_table(¶ms.inode_table, 9001);
228 ret = init_sd_set(¶ms.sd_set, imd->security_data);
230 goto out_destroy_inode_table;
232 INIT_LIST_HEAD(&unhashed_streams);
233 wim->lookup_table->unhashed_streams = &unhashed_streams;
234 params.lookup_table = wim->lookup_table;
235 params.config = config;
236 params.add_flags = add_flags;
237 params.progress_func = progress_func;
238 params.extra_arg = extra_arg;
241 memset(&progress, 0, sizeof(progress));
242 progress.scan.source = fs_source_path;
243 progress.scan.wim_target_path = wim_target_path;
244 progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &progress);
247 config->_prefix = fs_source_path;
248 config->_prefix_num_tchars = tstrlen(fs_source_path);
251 if (wim_target_path[0] == T('\0'))
252 params.add_flags |= WIMLIB_ADD_FLAG_ROOT;
253 ret = (*capture_tree)(&branch, fs_source_path, ¶ms);
255 ERROR("Failed to build dentry tree for \"%"TS"\"",
257 goto out_destroy_sd_set;
260 /* Use the target name, not the source name, for
261 * the root of each branch from a capture
262 * source. (This will also set the root dentry
263 * of the entire image to be unnamed.) */
264 ret = set_dentry_name(branch,
265 path_basename(wim_target_path));
267 goto out_ntfs_umount;
269 ret = attach_branch(&imd->root_dentry, branch, wim_target_path);
271 goto out_ntfs_umount;
274 progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &progress);
275 list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
277 imd->ntfs_vol = ntfs_vol;
279 inode_table_prepare_inode_list(¶ms.inode_table, &imd->inode_list);
282 if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
283 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
284 goto out_destroy_sd_set;
288 do_ntfs_umount(ntfs_vol);
290 free_dentry_tree(branch, wim->lookup_table);
292 destroy_sd_set(¶ms.sd_set, rollback_sd);
293 out_destroy_inode_table:
294 destroy_inode_table(¶ms.inode_table);
300 execute_delete_command(WIMStruct *wim,
301 const struct wimlib_update_command *delete_cmd)
304 const tchar *wim_path;
305 struct wim_dentry *tree;
308 wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE);
309 flags = delete_cmd->delete.delete_flags;
310 wim_path = delete_cmd->delete.wim_path;
312 DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags);
314 tree = get_dentry(wim, wim_path);
316 /* Path to delete does not exist in the WIM. */
317 if (flags & WIMLIB_DELETE_FLAG_FORCE) {
320 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
321 wim_path, wim->current_image);
322 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
326 if (dentry_is_directory(tree) && !(flags & WIMLIB_DELETE_FLAG_RECURSIVE)) {
327 ERROR("Path \"%"TS"\" in WIM image %d is a directory "
328 "but a recursive delete was not requested",
329 wim_path, wim->current_image);
330 return WIMLIB_ERR_IS_DIRECTORY;
333 is_root = dentry_is_root(tree);
335 free_dentry_tree(tree, wim->lookup_table);
337 wim->image_metadata[wim->current_image - 1]->root_dentry = NULL;
342 free_dentry_full_path(struct wim_dentry *dentry, void *_ignore)
344 FREE(dentry->_full_path);
345 dentry->_full_path = NULL;
350 * Rename a file or directory in the WIM.
352 * This is also called from wimfs_rename() in the FUSE mount code.
355 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
357 struct wim_dentry *src;
358 struct wim_dentry *dst;
359 struct wim_dentry *parent_of_dst;
362 /* This rename() implementation currently only supports actual files
363 * (not alternate data streams) */
365 src = get_dentry(wim, from);
369 dst = get_dentry(wim, to);
372 /* Destination file exists */
374 if (src == dst) /* Same file */
377 if (!dentry_is_directory(src)) {
378 /* Cannot rename non-directory to directory. */
379 if (dentry_is_directory(dst))
382 /* Cannot rename directory to a non-directory or a non-empty
384 if (!dentry_is_directory(dst))
386 if (inode_has_children(dst->d_inode))
389 parent_of_dst = dst->parent;
391 /* Destination does not exist */
392 parent_of_dst = get_parent_dentry(wim, to);
396 if (!dentry_is_directory(parent_of_dst))
400 ret = set_dentry_name(src, path_basename(to));
405 free_dentry_tree(dst, wim->lookup_table);
408 dentry_add_child(parent_of_dst, src);
410 for_dentry_in_tree(src, free_dentry_full_path, NULL);
416 execute_rename_command(WIMStruct *wim,
417 const struct wimlib_update_command *rename_cmd)
421 wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME);
423 ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
424 rename_cmd->rename.wim_target_path);
428 ERROR_WITH_ERRNO("Can't rename \"%"TS"\" to \"%"TS"\"",
429 rename_cmd->rename.wim_source_path,
430 rename_cmd->rename.wim_target_path);
433 ret = WIMLIB_ERR_NOMEM;
436 ret = WIMLIB_ERR_NOTDIR;
439 ret = WIMLIB_ERR_NOTEMPTY;
442 ret = WIMLIB_ERR_IS_DIRECTORY;
446 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
453 static inline const tchar *
454 update_op_to_str(int op)
457 case WIMLIB_UPDATE_OP_ADD:
459 case WIMLIB_UPDATE_OP_DELETE:
461 case WIMLIB_UPDATE_OP_RENAME:
470 execute_update_commands(WIMStruct *wim,
471 const struct wimlib_update_command *cmds,
474 wimlib_progress_func_t progress_func)
477 union wimlib_progress_info info;
478 info.update.completed_commands = 0;
479 info.update.total_commands = num_cmds;
480 for (size_t i = 0; i < num_cmds; i++) {
481 DEBUG("Executing update command %zu of %zu (op=%"TS")",
482 i + 1, num_cmds, update_op_to_str(cmds[i].op));
483 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
486 info.update.command = &cmds[i];
487 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
490 switch (cmds[i].op) {
491 case WIMLIB_UPDATE_OP_ADD:
492 ret = execute_add_command(wim, &cmds[i], progress_func);
494 case WIMLIB_UPDATE_OP_DELETE:
495 ret = execute_delete_command(wim, &cmds[i]);
497 case WIMLIB_UPDATE_OP_RENAME:
498 ret = execute_rename_command(wim, &cmds[i]);
505 info.update.completed_commands++;
506 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
509 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
517 check_add_command(struct wimlib_update_command *cmd,
518 const struct wim_header *hdr)
520 int add_flags = cmd->add.add_flags;
522 /* Are we adding the entire image or not? An empty wim_target_path
523 * indicates that the tree we're adding is to be placed in the root of
524 * the image. We consider this to be capturing the entire image,
525 * although it could potentially be an overlay on an existing root as
527 bool is_entire_image = cmd->add.wim_target_path[0] == T('\0');
530 /* Check for flags not supported on Windows */
531 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
532 ERROR("wimlib was compiled without support for NTFS-3g, so");
533 ERROR("we cannot capture a WIM image directly from a NTFS volume");
534 return WIMLIB_ERR_UNSUPPORTED;
536 if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
537 ERROR("Capturing UNIX-specific data is not supported on Windows");
538 return WIMLIB_ERR_UNSUPPORTED;
540 if (add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) {
541 ERROR("Dereferencing symbolic links is not supported on Windows");
542 return WIMLIB_ERR_UNSUPPORTED;
546 /* VERBOSE implies EXCLUDE_VERBOSE */
547 if (add_flags & WIMLIB_ADD_FLAG_VERBOSE)
548 add_flags |= WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
550 /* Check for contradictory reparse point fixup flags */
551 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
552 WIMLIB_ADD_FLAG_NORPFIX)) ==
553 (WIMLIB_ADD_FLAG_RPFIX |
554 WIMLIB_ADD_FLAG_NORPFIX))
556 ERROR("Cannot specify RPFIX and NORPFIX flags "
557 "at the same time!");
558 return WIMLIB_ERR_INVALID_PARAM;
561 /* Set default behavior on reparse point fixups if requested */
562 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
563 WIMLIB_ADD_FLAG_NORPFIX)) == 0)
565 /* Do reparse-point fixups by default if we are capturing an
566 * entire image and either the header flag is set from previous
567 * images, or if this is the first image being added. */
568 if (is_entire_image &&
569 ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
570 add_flags |= WIMLIB_ADD_FLAG_RPFIX;
573 if (!is_entire_image) {
574 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
575 ERROR("Cannot add directly from a NTFS volume "
576 "when not capturing a full image!");
577 return WIMLIB_ERR_INVALID_PARAM;
580 if (add_flags & WIMLIB_ADD_FLAG_RPFIX) {
581 ERROR("Cannot do reparse point fixups when "
582 "not capturing a full image!");
583 return WIMLIB_ERR_INVALID_PARAM;
586 /* We may have modified the add flags. */
587 cmd->add.add_flags = add_flags;
592 check_update_command(struct wimlib_update_command *cmd,
593 const struct wim_header *hdr)
596 case WIMLIB_UPDATE_OP_ADD:
597 return check_add_command(cmd, hdr);
598 case WIMLIB_UPDATE_OP_DELETE:
599 case WIMLIB_UPDATE_OP_RENAME:
606 check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
607 const struct wim_header *hdr)
610 for (size_t i = 0; i < num_cmds; i++) {
611 ret = check_update_command(&cmds[i], hdr);
620 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
623 for (size_t i = 0; i < num_cmds; i++) {
624 switch (cmds[i].op) {
625 case WIMLIB_UPDATE_OP_ADD:
626 FREE(cmds[i].add.fs_source_path);
627 FREE(cmds[i].add.wim_target_path);
628 free_capture_config(cmds[i].add.config);
630 case WIMLIB_UPDATE_OP_DELETE:
631 FREE(cmds[i].delete.wim_path);
633 case WIMLIB_UPDATE_OP_RENAME:
634 FREE(cmds[i].rename.wim_source_path);
635 FREE(cmds[i].rename.wim_target_path);
644 copy_update_commands(const struct wimlib_update_command *cmds,
646 struct wimlib_update_command **cmds_copy_ret)
649 struct wimlib_update_command *cmds_copy;
651 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
655 for (size_t i = 0; i < num_cmds; i++) {
656 cmds_copy[i].op = cmds[i].op;
657 switch (cmds[i].op) {
658 case WIMLIB_UPDATE_OP_ADD:
659 cmds_copy[i].add.fs_source_path =
660 canonicalize_fs_path(cmds[i].add.fs_source_path);
661 cmds_copy[i].add.wim_target_path =
662 canonicalize_wim_path(cmds[i].add.wim_target_path);
663 if (!cmds_copy[i].add.fs_source_path ||
664 !cmds_copy[i].add.wim_target_path)
666 if (cmds[i].add.config) {
667 ret = copy_and_canonicalize_capture_config(cmds[i].add.config,
668 &cmds_copy[i].add.config);
672 cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
674 case WIMLIB_UPDATE_OP_DELETE:
675 cmds_copy[i].delete.wim_path =
676 canonicalize_wim_path(cmds[i].delete.wim_path);
677 if (!cmds_copy[i].delete.wim_path)
679 cmds_copy[i].delete.delete_flags = cmds[i].delete.delete_flags;
681 case WIMLIB_UPDATE_OP_RENAME:
682 cmds_copy[i].rename.wim_source_path =
683 canonicalize_wim_path(cmds[i].rename.wim_source_path);
684 cmds_copy[i].rename.wim_target_path =
685 canonicalize_wim_path(cmds[i].rename.wim_target_path);
686 if (!cmds_copy[i].rename.wim_source_path ||
687 !cmds_copy[i].rename.wim_target_path)
691 ERROR("Unknown update operation %u", cmds[i].op);
692 ret = WIMLIB_ERR_INVALID_PARAM;
696 *cmds_copy_ret = cmds_copy;
701 ret = WIMLIB_ERR_NOMEM;
703 free_update_commands(cmds_copy, num_cmds);
708 * Entry point for making a series of updates to a WIM image.
711 wimlib_update_image(WIMStruct *wim,
713 const struct wimlib_update_command *cmds,
716 wimlib_progress_func_t progress_func)
719 struct wimlib_update_command *cmds_copy;
720 bool deletion_requested = false;
722 DEBUG("Updating image %d with %zu commands", image, num_cmds);
724 for (size_t i = 0; i < num_cmds; i++)
725 if (cmds[i].op == WIMLIB_UPDATE_OP_DELETE)
726 deletion_requested = true;
728 if (deletion_requested)
729 ret = can_delete_from_wim(wim);
731 ret = can_modify_wim(wim);
736 /* Load the metadata for the image to modify (if not loaded already) */
737 ret = select_wim_image(wim, image);
741 /* Short circuit a successful return if no commands were specified.
742 * Avoids problems with trying to allocate 0 bytes of memory. */
746 DEBUG("Preparing %zu update commands", num_cmds);
748 /* Make a copy of the update commands, in the process doing certain
749 * canonicalizations on paths (e.g. translating backslashes to forward
750 * slashes). This is done to avoid modifying the caller's copy of the
752 ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
756 /* Perform additional checks on the update commands before we execute
758 ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
760 goto out_free_cmds_copy;
762 /* Actually execute the update commands. */
763 DEBUG("Executing %zu update commands", num_cmds);
764 ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags,
767 goto out_free_cmds_copy;
769 wim->image_metadata[image - 1]->modified = 1;
771 /* Statistics about the WIM image, such as the numbers of files and
772 * directories, may have changed. Call xml_update_image_info() to
773 * recalculate these statistics. */
774 xml_update_image_info(wim, image);
776 free_update_commands(cmds_copy, num_cmds);