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 goto out_destroy_sd_set;
259 /* Use the target name, not the source name, for
260 * the root of each branch from a capture
261 * source. (This will also set the root dentry
262 * of the entire image to be unnamed.) */
263 ret = set_dentry_name(branch,
264 path_basename(wim_target_path));
266 goto out_ntfs_umount;
268 ret = attach_branch(&imd->root_dentry, branch, wim_target_path);
270 goto out_ntfs_umount;
273 progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, ¶ms.progress);
274 list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
276 imd->ntfs_vol = ntfs_vol;
278 inode_table_prepare_inode_list(¶ms.inode_table, &imd->inode_list);
281 if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
282 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
283 goto out_destroy_sd_set;
287 do_ntfs_umount(ntfs_vol);
289 free_dentry_tree(branch, wim->lookup_table);
291 destroy_sd_set(¶ms.sd_set, rollback_sd);
292 out_destroy_inode_table:
293 destroy_inode_table(¶ms.inode_table);
299 execute_delete_command(WIMStruct *wim,
300 const struct wimlib_update_command *delete_cmd)
303 const tchar *wim_path;
304 struct wim_dentry *tree;
307 wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE);
308 flags = delete_cmd->delete_.delete_flags;
309 wim_path = delete_cmd->delete_.wim_path;
311 DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags);
313 tree = get_dentry(wim, wim_path);
315 /* Path to delete does not exist in the WIM. */
316 if (flags & WIMLIB_DELETE_FLAG_FORCE) {
319 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
320 wim_path, wim->current_image);
321 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
325 if (dentry_is_directory(tree) && !(flags & WIMLIB_DELETE_FLAG_RECURSIVE)) {
326 ERROR("Path \"%"TS"\" in WIM image %d is a directory "
327 "but a recursive delete was not requested",
328 wim_path, wim->current_image);
329 return WIMLIB_ERR_IS_DIRECTORY;
332 is_root = dentry_is_root(tree);
334 free_dentry_tree(tree, wim->lookup_table);
336 wim->image_metadata[wim->current_image - 1]->root_dentry = NULL;
341 free_dentry_full_path(struct wim_dentry *dentry, void *_ignore)
343 FREE(dentry->_full_path);
344 dentry->_full_path = NULL;
349 * Rename a file or directory in the WIM.
351 * This is also called from wimfs_rename() in the FUSE mount code.
354 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
356 struct wim_dentry *src;
357 struct wim_dentry *dst;
358 struct wim_dentry *parent_of_dst;
361 /* This rename() implementation currently only supports actual files
362 * (not alternate data streams) */
364 src = get_dentry(wim, from);
368 dst = get_dentry(wim, to);
371 /* Destination file exists */
373 if (src == dst) /* Same file */
376 if (!dentry_is_directory(src)) {
377 /* Cannot rename non-directory to directory. */
378 if (dentry_is_directory(dst))
381 /* Cannot rename directory to a non-directory or a non-empty
383 if (!dentry_is_directory(dst))
385 if (dentry_has_children(dst))
388 parent_of_dst = dst->parent;
390 /* Destination does not exist */
391 parent_of_dst = get_parent_dentry(wim, to);
395 if (!dentry_is_directory(parent_of_dst))
399 ret = set_dentry_name(src, path_basename(to));
404 free_dentry_tree(dst, wim->lookup_table);
407 dentry_add_child(parent_of_dst, src);
409 for_dentry_in_tree(src, free_dentry_full_path, NULL);
415 execute_rename_command(WIMStruct *wim,
416 const struct wimlib_update_command *rename_cmd)
420 wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME);
422 ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
423 rename_cmd->rename.wim_target_path);
427 ERROR_WITH_ERRNO("Can't rename \"%"TS"\" to \"%"TS"\"",
428 rename_cmd->rename.wim_source_path,
429 rename_cmd->rename.wim_target_path);
432 ret = WIMLIB_ERR_NOMEM;
435 ret = WIMLIB_ERR_NOTDIR;
438 ret = WIMLIB_ERR_NOTEMPTY;
441 ret = WIMLIB_ERR_IS_DIRECTORY;
445 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
452 static inline const tchar *
453 update_op_to_str(int op)
456 case WIMLIB_UPDATE_OP_ADD:
458 case WIMLIB_UPDATE_OP_DELETE:
460 case WIMLIB_UPDATE_OP_RENAME:
469 execute_update_commands(WIMStruct *wim,
470 const struct wimlib_update_command *cmds,
473 wimlib_progress_func_t progress_func)
476 union wimlib_progress_info info;
477 info.update.completed_commands = 0;
478 info.update.total_commands = num_cmds;
479 for (size_t i = 0; i < num_cmds; i++) {
480 DEBUG("Executing update command %zu of %zu (op=%"TS")",
481 i + 1, num_cmds, update_op_to_str(cmds[i].op));
482 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
485 info.update.command = &cmds[i];
486 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
489 switch (cmds[i].op) {
490 case WIMLIB_UPDATE_OP_ADD:
491 ret = execute_add_command(wim, &cmds[i], progress_func);
493 case WIMLIB_UPDATE_OP_DELETE:
494 ret = execute_delete_command(wim, &cmds[i]);
496 case WIMLIB_UPDATE_OP_RENAME:
497 ret = execute_rename_command(wim, &cmds[i]);
504 info.update.completed_commands++;
505 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
508 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
520 T("/System Volume Information"),
525 static const struct wimlib_capture_config winconfig = {
527 .num_pats = ARRAY_LEN(winpats),
533 check_add_command(struct wimlib_update_command *cmd,
534 const struct wim_header *hdr)
536 int add_flags = cmd->add.add_flags;
538 /* Are we adding the entire image or not? An empty wim_target_path
539 * indicates that the tree we're adding is to be placed in the root of
540 * the image. We consider this to be capturing the entire image,
541 * although it could potentially be an overlay on an existing root as
543 bool is_entire_image = cmd->add.wim_target_path[0] == T('\0');
546 /* Check for flags not supported on Windows */
547 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
548 ERROR("wimlib was compiled without support for NTFS-3g, so");
549 ERROR("we cannot capture a WIM image directly from a NTFS volume");
550 return WIMLIB_ERR_UNSUPPORTED;
552 if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
553 ERROR("Capturing UNIX-specific data is not supported on Windows");
554 return WIMLIB_ERR_UNSUPPORTED;
556 if (add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) {
557 ERROR("Dereferencing symbolic links is not supported on Windows");
558 return WIMLIB_ERR_UNSUPPORTED;
562 /* VERBOSE implies EXCLUDE_VERBOSE */
563 if (add_flags & WIMLIB_ADD_FLAG_VERBOSE)
564 add_flags |= WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
566 /* Check for contradictory reparse point fixup flags */
567 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
568 WIMLIB_ADD_FLAG_NORPFIX)) ==
569 (WIMLIB_ADD_FLAG_RPFIX |
570 WIMLIB_ADD_FLAG_NORPFIX))
572 ERROR("Cannot specify RPFIX and NORPFIX flags "
573 "at the same time!");
574 return WIMLIB_ERR_INVALID_PARAM;
577 /* Set default behavior on reparse point fixups if requested */
578 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
579 WIMLIB_ADD_FLAG_NORPFIX)) == 0)
581 /* Do reparse-point fixups by default if we are capturing an
582 * entire image and either the header flag is set from previous
583 * images, or if this is the first image being added. */
584 if (is_entire_image &&
585 ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
586 add_flags |= WIMLIB_ADD_FLAG_RPFIX;
589 if (!is_entire_image) {
590 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
591 ERROR("Cannot add directly from a NTFS volume "
592 "when not capturing a full image!");
593 return WIMLIB_ERR_INVALID_PARAM;
596 if (add_flags & WIMLIB_ADD_FLAG_RPFIX) {
597 ERROR("Cannot do reparse point fixups when "
598 "not capturing a full image!");
599 return WIMLIB_ERR_INVALID_PARAM;
602 /* We may have modified the add flags. */
603 cmd->add.add_flags = add_flags;
608 check_update_command(struct wimlib_update_command *cmd,
609 const struct wim_header *hdr)
612 case WIMLIB_UPDATE_OP_ADD:
613 return check_add_command(cmd, hdr);
614 case WIMLIB_UPDATE_OP_DELETE:
615 case WIMLIB_UPDATE_OP_RENAME:
622 check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
623 const struct wim_header *hdr)
626 for (size_t i = 0; i < num_cmds; i++) {
627 ret = check_update_command(&cmds[i], hdr);
636 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
639 for (size_t i = 0; i < num_cmds; i++) {
640 switch (cmds[i].op) {
641 case WIMLIB_UPDATE_OP_ADD:
642 FREE(cmds[i].add.fs_source_path);
643 FREE(cmds[i].add.wim_target_path);
644 free_capture_config(cmds[i].add.config);
646 case WIMLIB_UPDATE_OP_DELETE:
647 FREE(cmds[i].delete_.wim_path);
649 case WIMLIB_UPDATE_OP_RENAME:
650 FREE(cmds[i].rename.wim_source_path);
651 FREE(cmds[i].rename.wim_target_path);
660 copy_update_commands(const struct wimlib_update_command *cmds,
662 struct wimlib_update_command **cmds_copy_ret)
665 struct wimlib_update_command *cmds_copy;
666 const struct wimlib_capture_config *config;
668 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
672 for (size_t i = 0; i < num_cmds; i++) {
673 cmds_copy[i].op = cmds[i].op;
674 switch (cmds[i].op) {
675 case WIMLIB_UPDATE_OP_ADD:
676 cmds_copy[i].add.fs_source_path =
677 canonicalize_fs_path(cmds[i].add.fs_source_path);
678 cmds_copy[i].add.wim_target_path =
679 canonicalize_wim_path(cmds[i].add.wim_target_path);
680 if (!cmds_copy[i].add.fs_source_path ||
681 !cmds_copy[i].add.wim_target_path)
683 config = cmds[i].add.config;
684 if (cmds[i].add.add_flags & WIMLIB_ADD_FLAG_WINCONFIG)
687 ret = copy_and_canonicalize_capture_config(config,
688 &cmds_copy[i].add.config);
692 cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
694 case WIMLIB_UPDATE_OP_DELETE:
695 cmds_copy[i].delete_.wim_path =
696 canonicalize_wim_path(cmds[i].delete_.wim_path);
697 if (!cmds_copy[i].delete_.wim_path)
699 cmds_copy[i].delete_.delete_flags = cmds[i].delete_.delete_flags;
701 case WIMLIB_UPDATE_OP_RENAME:
702 cmds_copy[i].rename.wim_source_path =
703 canonicalize_wim_path(cmds[i].rename.wim_source_path);
704 cmds_copy[i].rename.wim_target_path =
705 canonicalize_wim_path(cmds[i].rename.wim_target_path);
706 if (!cmds_copy[i].rename.wim_source_path ||
707 !cmds_copy[i].rename.wim_target_path)
711 ERROR("Unknown update operation %u", cmds[i].op);
712 ret = WIMLIB_ERR_INVALID_PARAM;
716 *cmds_copy_ret = cmds_copy;
721 ret = WIMLIB_ERR_NOMEM;
723 free_update_commands(cmds_copy, num_cmds);
727 /* API function documented in wimlib.h */
729 wimlib_update_image(WIMStruct *wim,
731 const struct wimlib_update_command *cmds,
734 wimlib_progress_func_t progress_func)
737 struct wimlib_update_command *cmds_copy;
738 bool deletion_requested = false;
740 DEBUG("Updating image %d with %zu commands", image, num_cmds);
742 for (size_t i = 0; i < num_cmds; i++)
743 if (cmds[i].op == WIMLIB_UPDATE_OP_DELETE)
744 deletion_requested = true;
746 if (deletion_requested)
747 ret = can_delete_from_wim(wim);
749 ret = can_modify_wim(wim);
754 /* Load the metadata for the image to modify (if not loaded already) */
755 ret = select_wim_image(wim, image);
759 /* Short circuit a successful return if no commands were specified.
760 * Avoids problems with trying to allocate 0 bytes of memory. */
764 DEBUG("Preparing %zu update commands", num_cmds);
766 /* Make a copy of the update commands, in the process doing certain
767 * canonicalizations on paths (e.g. translating backslashes to forward
768 * slashes). This is done to avoid modifying the caller's copy of the
770 ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
774 /* Perform additional checks on the update commands before we execute
776 ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
778 goto out_free_cmds_copy;
780 /* Actually execute the update commands. */
781 DEBUG("Executing %zu update commands", num_cmds);
782 ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags,
785 goto out_free_cmds_copy;
787 wim->image_metadata[image - 1]->modified = 1;
789 /* Statistics about the WIM image, such as the numbers of files and
790 * directories, may have changed. Call xml_update_image_info() to
791 * recalculate these statistics. */
792 xml_update_image_info(wim, image);
794 free_update_commands(cmds_copy, num_cmds);