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 struct wimlib_capture_config *config;
185 struct _ntfs_volume *ntfs_vol = NULL;
188 struct wim_dentry *branch;
189 bool rollback_sd = true;
191 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 memset(¶ms, 0, sizeof(params));
202 imd = wim->image_metadata[wim->current_image - 1];
204 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
206 capture_tree = build_dentry_tree_ntfs;
207 extra_arg = &ntfs_vol;
208 if (imd->ntfs_vol != NULL) {
209 ERROR("NTFS volume already set");
210 ret = WIMLIB_ERR_INVALID_PARAM;
214 ret = WIMLIB_ERR_INVALID_PARAM;
219 capture_tree = win32_build_dentry_tree;
221 capture_tree = unix_build_dentry_tree;
227 ret = init_inode_table(¶ms.inode_table, 9001);
231 ret = init_sd_set(¶ms.sd_set, imd->security_data);
233 goto out_destroy_inode_table;
235 INIT_LIST_HEAD(&unhashed_streams);
236 wim->lookup_table->unhashed_streams = &unhashed_streams;
237 params.lookup_table = wim->lookup_table;
238 params.config = config;
239 params.add_flags = add_flags;
240 params.extra_arg = extra_arg;
242 params.progress_func = progress_func;
243 params.progress.scan.source = fs_source_path;
244 params.progress.scan.wim_target_path = wim_target_path;
246 progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, ¶ms.progress);
248 config->_prefix = fs_source_path;
249 config->_prefix_num_tchars = tstrlen(fs_source_path);
252 if (wim_target_path[0] == T('\0'))
253 params.add_flags |= WIMLIB_ADD_FLAG_ROOT;
254 ret = (*capture_tree)(&branch, fs_source_path, ¶ms);
256 ERROR("Failed to build dentry tree for \"%"TS"\"",
258 goto out_destroy_sd_set;
261 /* Use the target name, not the source name, for
262 * the root of each branch from a capture
263 * source. (This will also set the root dentry
264 * of the entire image to be unnamed.) */
265 ret = set_dentry_name(branch,
266 path_basename(wim_target_path));
268 goto out_ntfs_umount;
270 ret = attach_branch(&imd->root_dentry, branch, wim_target_path);
272 goto out_ntfs_umount;
275 progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, ¶ms.progress);
276 list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
278 imd->ntfs_vol = ntfs_vol;
280 inode_table_prepare_inode_list(¶ms.inode_table, &imd->inode_list);
283 if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
284 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
285 goto out_destroy_sd_set;
289 do_ntfs_umount(ntfs_vol);
291 free_dentry_tree(branch, wim->lookup_table);
293 destroy_sd_set(¶ms.sd_set, rollback_sd);
294 out_destroy_inode_table:
295 destroy_inode_table(¶ms.inode_table);
301 execute_delete_command(WIMStruct *wim,
302 const struct wimlib_update_command *delete_cmd)
305 const tchar *wim_path;
306 struct wim_dentry *tree;
309 wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE);
310 flags = delete_cmd->delete.delete_flags;
311 wim_path = delete_cmd->delete.wim_path;
313 DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags);
315 tree = get_dentry(wim, wim_path);
317 /* Path to delete does not exist in the WIM. */
318 if (flags & WIMLIB_DELETE_FLAG_FORCE) {
321 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
322 wim_path, wim->current_image);
323 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
327 if (dentry_is_directory(tree) && !(flags & WIMLIB_DELETE_FLAG_RECURSIVE)) {
328 ERROR("Path \"%"TS"\" in WIM image %d is a directory "
329 "but a recursive delete was not requested",
330 wim_path, wim->current_image);
331 return WIMLIB_ERR_IS_DIRECTORY;
334 is_root = dentry_is_root(tree);
336 free_dentry_tree(tree, wim->lookup_table);
338 wim->image_metadata[wim->current_image - 1]->root_dentry = NULL;
343 free_dentry_full_path(struct wim_dentry *dentry, void *_ignore)
345 FREE(dentry->_full_path);
346 dentry->_full_path = NULL;
351 * Rename a file or directory in the WIM.
353 * This is also called from wimfs_rename() in the FUSE mount code.
356 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
358 struct wim_dentry *src;
359 struct wim_dentry *dst;
360 struct wim_dentry *parent_of_dst;
363 /* This rename() implementation currently only supports actual files
364 * (not alternate data streams) */
366 src = get_dentry(wim, from);
370 dst = get_dentry(wim, to);
373 /* Destination file exists */
375 if (src == dst) /* Same file */
378 if (!dentry_is_directory(src)) {
379 /* Cannot rename non-directory to directory. */
380 if (dentry_is_directory(dst))
383 /* Cannot rename directory to a non-directory or a non-empty
385 if (!dentry_is_directory(dst))
387 if (inode_has_children(dst->d_inode))
390 parent_of_dst = dst->parent;
392 /* Destination does not exist */
393 parent_of_dst = get_parent_dentry(wim, to);
397 if (!dentry_is_directory(parent_of_dst))
401 ret = set_dentry_name(src, path_basename(to));
406 free_dentry_tree(dst, wim->lookup_table);
409 dentry_add_child(parent_of_dst, src);
411 for_dentry_in_tree(src, free_dentry_full_path, NULL);
417 execute_rename_command(WIMStruct *wim,
418 const struct wimlib_update_command *rename_cmd)
422 wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME);
424 ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
425 rename_cmd->rename.wim_target_path);
429 ERROR_WITH_ERRNO("Can't rename \"%"TS"\" to \"%"TS"\"",
430 rename_cmd->rename.wim_source_path,
431 rename_cmd->rename.wim_target_path);
434 ret = WIMLIB_ERR_NOMEM;
437 ret = WIMLIB_ERR_NOTDIR;
440 ret = WIMLIB_ERR_NOTEMPTY;
443 ret = WIMLIB_ERR_IS_DIRECTORY;
447 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
454 static inline const tchar *
455 update_op_to_str(int op)
458 case WIMLIB_UPDATE_OP_ADD:
460 case WIMLIB_UPDATE_OP_DELETE:
462 case WIMLIB_UPDATE_OP_RENAME:
471 execute_update_commands(WIMStruct *wim,
472 const struct wimlib_update_command *cmds,
475 wimlib_progress_func_t progress_func)
478 union wimlib_progress_info info;
479 info.update.completed_commands = 0;
480 info.update.total_commands = num_cmds;
481 for (size_t i = 0; i < num_cmds; i++) {
482 DEBUG("Executing update command %zu of %zu (op=%"TS")",
483 i + 1, num_cmds, update_op_to_str(cmds[i].op));
484 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
487 info.update.command = &cmds[i];
488 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
491 switch (cmds[i].op) {
492 case WIMLIB_UPDATE_OP_ADD:
493 ret = execute_add_command(wim, &cmds[i], progress_func);
495 case WIMLIB_UPDATE_OP_DELETE:
496 ret = execute_delete_command(wim, &cmds[i]);
498 case WIMLIB_UPDATE_OP_RENAME:
499 ret = execute_rename_command(wim, &cmds[i]);
506 info.update.completed_commands++;
507 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
510 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
522 T("/System Volume Information"),
527 static const struct wimlib_capture_config winconfig = {
529 .num_pats = ARRAY_LEN(winpats),
535 check_add_command(struct wimlib_update_command *cmd,
536 const struct wim_header *hdr)
538 int add_flags = cmd->add.add_flags;
540 /* Are we adding the entire image or not? An empty wim_target_path
541 * indicates that the tree we're adding is to be placed in the root of
542 * the image. We consider this to be capturing the entire image,
543 * although it could potentially be an overlay on an existing root as
545 bool is_entire_image = cmd->add.wim_target_path[0] == T('\0');
548 /* Check for flags not supported on Windows */
549 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
550 ERROR("wimlib was compiled without support for NTFS-3g, so");
551 ERROR("we cannot capture a WIM image directly from a NTFS volume");
552 return WIMLIB_ERR_UNSUPPORTED;
554 if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
555 ERROR("Capturing UNIX-specific data is not supported on Windows");
556 return WIMLIB_ERR_UNSUPPORTED;
558 if (add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) {
559 ERROR("Dereferencing symbolic links is not supported on Windows");
560 return WIMLIB_ERR_UNSUPPORTED;
564 /* VERBOSE implies EXCLUDE_VERBOSE */
565 if (add_flags & WIMLIB_ADD_FLAG_VERBOSE)
566 add_flags |= WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
568 /* Check for contradictory reparse point fixup flags */
569 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
570 WIMLIB_ADD_FLAG_NORPFIX)) ==
571 (WIMLIB_ADD_FLAG_RPFIX |
572 WIMLIB_ADD_FLAG_NORPFIX))
574 ERROR("Cannot specify RPFIX and NORPFIX flags "
575 "at the same time!");
576 return WIMLIB_ERR_INVALID_PARAM;
579 /* Set default behavior on reparse point fixups if requested */
580 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
581 WIMLIB_ADD_FLAG_NORPFIX)) == 0)
583 /* Do reparse-point fixups by default if we are capturing an
584 * entire image and either the header flag is set from previous
585 * images, or if this is the first image being added. */
586 if (is_entire_image &&
587 ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
588 add_flags |= WIMLIB_ADD_FLAG_RPFIX;
591 if (!is_entire_image) {
592 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
593 ERROR("Cannot add directly from a NTFS volume "
594 "when not capturing a full image!");
595 return WIMLIB_ERR_INVALID_PARAM;
598 if (add_flags & WIMLIB_ADD_FLAG_RPFIX) {
599 ERROR("Cannot do reparse point fixups when "
600 "not capturing a full image!");
601 return WIMLIB_ERR_INVALID_PARAM;
604 /* We may have modified the add flags. */
605 cmd->add.add_flags = add_flags;
610 check_update_command(struct wimlib_update_command *cmd,
611 const struct wim_header *hdr)
614 case WIMLIB_UPDATE_OP_ADD:
615 return check_add_command(cmd, hdr);
616 case WIMLIB_UPDATE_OP_DELETE:
617 case WIMLIB_UPDATE_OP_RENAME:
624 check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
625 const struct wim_header *hdr)
628 for (size_t i = 0; i < num_cmds; i++) {
629 ret = check_update_command(&cmds[i], hdr);
638 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
641 for (size_t i = 0; i < num_cmds; i++) {
642 switch (cmds[i].op) {
643 case WIMLIB_UPDATE_OP_ADD:
644 FREE(cmds[i].add.fs_source_path);
645 FREE(cmds[i].add.wim_target_path);
646 free_capture_config(cmds[i].add.config);
648 case WIMLIB_UPDATE_OP_DELETE:
649 FREE(cmds[i].delete.wim_path);
651 case WIMLIB_UPDATE_OP_RENAME:
652 FREE(cmds[i].rename.wim_source_path);
653 FREE(cmds[i].rename.wim_target_path);
662 copy_update_commands(const struct wimlib_update_command *cmds,
664 struct wimlib_update_command **cmds_copy_ret)
667 struct wimlib_update_command *cmds_copy;
668 const struct wimlib_capture_config *config;
670 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
674 for (size_t i = 0; i < num_cmds; i++) {
675 cmds_copy[i].op = cmds[i].op;
676 switch (cmds[i].op) {
677 case WIMLIB_UPDATE_OP_ADD:
678 cmds_copy[i].add.fs_source_path =
679 canonicalize_fs_path(cmds[i].add.fs_source_path);
680 cmds_copy[i].add.wim_target_path =
681 canonicalize_wim_path(cmds[i].add.wim_target_path);
682 if (!cmds_copy[i].add.fs_source_path ||
683 !cmds_copy[i].add.wim_target_path)
685 config = cmds[i].add.config;
686 if (cmds[i].add.add_flags & WIMLIB_ADD_FLAG_WINCONFIG)
689 ret = copy_and_canonicalize_capture_config(config,
690 &cmds_copy[i].add.config);
694 cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
696 case WIMLIB_UPDATE_OP_DELETE:
697 cmds_copy[i].delete.wim_path =
698 canonicalize_wim_path(cmds[i].delete.wim_path);
699 if (!cmds_copy[i].delete.wim_path)
701 cmds_copy[i].delete.delete_flags = cmds[i].delete.delete_flags;
703 case WIMLIB_UPDATE_OP_RENAME:
704 cmds_copy[i].rename.wim_source_path =
705 canonicalize_wim_path(cmds[i].rename.wim_source_path);
706 cmds_copy[i].rename.wim_target_path =
707 canonicalize_wim_path(cmds[i].rename.wim_target_path);
708 if (!cmds_copy[i].rename.wim_source_path ||
709 !cmds_copy[i].rename.wim_target_path)
713 ERROR("Unknown update operation %u", cmds[i].op);
714 ret = WIMLIB_ERR_INVALID_PARAM;
718 *cmds_copy_ret = cmds_copy;
723 ret = WIMLIB_ERR_NOMEM;
725 free_update_commands(cmds_copy, num_cmds);
729 /* API function documented in wimlib.h */
731 wimlib_update_image(WIMStruct *wim,
733 const struct wimlib_update_command *cmds,
736 wimlib_progress_func_t progress_func)
739 struct wimlib_update_command *cmds_copy;
740 bool deletion_requested = false;
742 DEBUG("Updating image %d with %zu commands", image, num_cmds);
744 for (size_t i = 0; i < num_cmds; i++)
745 if (cmds[i].op == WIMLIB_UPDATE_OP_DELETE)
746 deletion_requested = true;
748 if (deletion_requested)
749 ret = can_delete_from_wim(wim);
751 ret = can_modify_wim(wim);
756 /* Load the metadata for the image to modify (if not loaded already) */
757 ret = select_wim_image(wim, image);
761 /* Short circuit a successful return if no commands were specified.
762 * Avoids problems with trying to allocate 0 bytes of memory. */
766 DEBUG("Preparing %zu update commands", num_cmds);
768 /* Make a copy of the update commands, in the process doing certain
769 * canonicalizations on paths (e.g. translating backslashes to forward
770 * slashes). This is done to avoid modifying the caller's copy of the
772 ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
776 /* Perform additional checks on the update commands before we execute
778 ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
780 goto out_free_cmds_copy;
782 /* Actually execute the update commands. */
783 DEBUG("Executing %zu update commands", num_cmds);
784 ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags,
787 goto out_free_cmds_copy;
789 wim->image_metadata[image - 1]->modified = 1;
791 /* Statistics about the WIM image, such as the numbers of files and
792 * directories, may have changed. Call xml_update_image_info() to
793 * recalculate these statistics. */
794 xml_update_image_info(wim, image);
796 free_update_commands(cmds_copy, num_cmds);