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/.
24 #include "wimlib_internal.h"
26 #include "lookup_table.h"
35 /* Overlays @branch onto @target, both of which must be directories. */
37 do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
39 struct rb_root *rb_root;
41 DEBUG("Doing overlay \"%"WS"\" => \"%"WS"\"",
42 branch->file_name, target->file_name);
44 if (!dentry_is_directory(branch) || !dentry_is_directory(target)) {
45 ERROR("Cannot overlay \"%"WS"\" onto existing dentry: "
46 "is not directory-on-directory!", branch->file_name);
47 return WIMLIB_ERR_INVALID_OVERLAY;
50 rb_root = &branch->d_inode->i_children;
51 while (rb_root->rb_node) { /* While @branch has children... */
52 struct wim_dentry *child = rbnode_dentry(rb_root->rb_node);
53 struct wim_dentry *existing;
55 /* Move @child to the directory @target */
57 existing = dentry_add_child(target, child);
59 /* File or directory with same name already exists */
62 ret = do_overlay(existing, child);
64 /* Overlay failed. Revert the change to avoid
65 * leaking the directory tree rooted at @child.
67 dentry_add_child(branch, child);
76 /* Attach or overlay a branch onto the WIM image.
79 * Pointer to the root of the WIM image, or pointer to NULL if it has not
84 * Path in the WIM image to add the branch, with leading and trailing
88 attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
92 struct wim_dentry *dentry, *parent, *target;
95 DEBUG("Attaching branch \"%"WS"\" => \"%"TS"\"",
96 branch->file_name, target_path);
98 if (*target_path == T('\0')) {
99 /* Target: root directory */
101 /* Overlay on existing root */
102 return do_overlay(*root_p, branch);
104 if (!dentry_is_directory(branch)) {
105 ERROR("Cannot set non-directory as root of WIM image");
106 return WIMLIB_ERR_NOTDIR;
114 /* Adding a non-root branch. Create root if it hasn't been created
117 ret = new_filler_directory(T(""), root_p);
122 /* Walk the path to the branch, creating filler directories as needed.
125 while ((slash = tstrchr(target_path, T('/')))) {
127 dentry = get_dentry_child_with_name(parent, target_path);
129 ret = new_filler_directory(target_path, &dentry);
132 dentry_add_child(parent, dentry);
136 /* Skip over slashes. Note: this cannot overrun the length of
137 * the string because the last character cannot be a slash, as
138 * trailing slashes were tripped. */
141 } while (*target_path == T('/'));
144 /* If the target path already existed, overlay the branch onto it.
145 * Otherwise, set the branch as the target path. */
146 target = get_dentry_child_with_utf16le_name(parent, branch->file_name,
147 branch->file_name_nbytes);
149 return do_overlay(target, branch);
151 dentry_add_child(parent, branch);
157 execute_add_command(WIMStruct *wim,
158 const struct wimlib_update_command *add_cmd,
159 wimlib_progress_func_t progress_func)
163 tchar *fs_source_path;
164 tchar *wim_target_path;
165 struct wim_inode_table inode_table;
166 struct sd_set sd_set;
167 struct wim_image_metadata *imd;
168 struct list_head unhashed_streams;
169 struct add_image_params params;
170 int (*capture_tree)(struct wim_dentry **,
172 struct add_image_params *);
173 union wimlib_progress_info progress;
174 struct wimlib_capture_config *config;
176 struct _ntfs_volume *ntfs_vol = NULL;
179 struct wim_dentry *branch;
180 bool rollback_sd = true;
182 wimlib_assert(add_cmd->op == WIMLIB_UPDATE_OP_ADD);
183 add_flags = add_cmd->add.add_flags;
184 fs_source_path = add_cmd->add.fs_source_path;
185 wim_target_path = add_cmd->add.wim_target_path;
186 config = add_cmd->add.config;
187 DEBUG("fs_source_path=\"%"TS"\", wim_target_path=\"%"TS"\", add_flags=%#x",
188 fs_source_path, wim_target_path, add_flags);
190 imd = wim->image_metadata[wim->current_image - 1];
192 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
194 capture_tree = build_dentry_tree_ntfs;
195 extra_arg = &ntfs_vol;
196 if (imd->ntfs_vol != NULL) {
197 ERROR("NTFS volume already set");
198 ret = WIMLIB_ERR_INVALID_PARAM;
202 ret = WIMLIB_ERR_INVALID_PARAM;
207 capture_tree = win32_build_dentry_tree;
209 capture_tree = unix_build_dentry_tree;
214 ret = init_inode_table(&inode_table, 9001);
218 ret = init_sd_set(&sd_set, imd->security_data);
220 goto out_destroy_inode_table;
222 INIT_LIST_HEAD(&unhashed_streams);
223 wim->lookup_table->unhashed_streams = &unhashed_streams;
224 params.lookup_table = wim->lookup_table;
225 params.inode_table = &inode_table;
226 params.sd_set = &sd_set;
227 params.config = config;
228 params.add_flags = add_flags;
229 params.progress_func = progress_func;
230 params.extra_arg = extra_arg;
233 memset(&progress, 0, sizeof(progress));
234 progress.scan.source = fs_source_path;
235 progress.scan.wim_target_path = wim_target_path;
236 progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &progress);
238 config->_prefix = fs_source_path;
239 config->_prefix_num_tchars = tstrlen(fs_source_path);
241 if (wim_target_path[0] == T('\0'))
242 add_flags |= WIMLIB_ADD_FLAG_ROOT;
243 ret = (*capture_tree)(&branch, fs_source_path, ¶ms);
245 ERROR("Failed to build dentry tree for \"%"TS"\"",
247 goto out_destroy_sd_set;
250 /* Use the target name, not the source name, for
251 * the root of each branch from a capture
252 * source. (This will also set the root dentry
253 * of the entire image to be unnamed.) */
254 ret = set_dentry_name(branch,
255 path_basename(wim_target_path));
257 goto out_ntfs_umount;
259 ret = attach_branch(&imd->root_dentry, branch, wim_target_path);
261 goto out_ntfs_umount;
264 progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &progress);
265 list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
267 imd->ntfs_vol = ntfs_vol;
269 inode_table_prepare_inode_list(&inode_table, &imd->inode_list);
272 if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
273 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
274 goto out_destroy_sd_set;
278 do_ntfs_umount(ntfs_vol);
280 free_dentry_tree(branch, wim->lookup_table);
282 destroy_sd_set(&sd_set, rollback_sd);
283 out_destroy_inode_table:
284 destroy_inode_table(&inode_table);
290 execute_delete_command(WIMStruct *wim,
291 const struct wimlib_update_command *delete_cmd)
294 const tchar *wim_path;
295 struct wim_dentry *tree;
298 wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE);
299 flags = delete_cmd->delete.delete_flags;
300 wim_path = delete_cmd->delete.wim_path;
302 DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags);
304 tree = get_dentry(wim, wim_path);
306 /* Path to delete does not exist in the WIM. */
307 if (flags & WIMLIB_DELETE_FLAG_FORCE) {
310 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
311 wim_path, wim->current_image);
312 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
316 if (dentry_is_directory(tree) && !(flags & WIMLIB_DELETE_FLAG_RECURSIVE)) {
317 ERROR("Path \"%"TS"\" in WIM image %d is a directory "
318 "but a recursive delete was not requested",
319 wim_path, wim->current_image);
320 return WIMLIB_ERR_IS_DIRECTORY;
323 is_root = dentry_is_root(tree);
325 free_dentry_tree(tree, wim->lookup_table);
327 wim->image_metadata[wim->current_image - 1]->root_dentry = NULL;
332 * Rename a file or directory in the WIM.
334 * This is also called from wimfs_rename() in the FUSE mount code.
337 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
339 struct wim_dentry *src;
340 struct wim_dentry *dst;
341 struct wim_dentry *parent_of_dst;
344 /* This rename() implementation currently only supports actual files
345 * (not alternate data streams) */
347 src = get_dentry(wim, from);
351 dst = get_dentry(wim, to);
354 /* Destination file exists */
356 if (src == dst) /* Same file */
359 if (!dentry_is_directory(src)) {
360 /* Cannot rename non-directory to directory. */
361 if (dentry_is_directory(dst))
364 /* Cannot rename directory to a non-directory or a non-empty
366 if (!dentry_is_directory(dst))
368 if (inode_has_children(dst->d_inode))
371 parent_of_dst = dst->parent;
373 /* Destination does not exist */
374 parent_of_dst = get_parent_dentry(wim, to);
378 if (!dentry_is_directory(parent_of_dst))
382 ret = set_dentry_name(src, path_basename(to));
387 free_dentry_tree(dst, wim->lookup_table);
390 dentry_add_child(parent_of_dst, src);
396 execute_rename_command(WIMStruct *wim,
397 const struct wimlib_update_command *rename_cmd)
401 wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME);
403 ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
404 rename_cmd->rename.wim_target_path);
408 ERROR_WITH_ERRNO("Can't rename \"%"TS"\" to \"%"TS"\"",
409 rename_cmd->rename.wim_source_path,
410 rename_cmd->rename.wim_target_path);
413 ret = WIMLIB_ERR_NOMEM;
416 ret = WIMLIB_ERR_NOTDIR;
419 ret = WIMLIB_ERR_NOTEMPTY;
422 ret = WIMLIB_ERR_IS_DIRECTORY;
426 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
433 static inline const tchar *
434 update_op_to_str(int op)
437 case WIMLIB_UPDATE_OP_ADD:
439 case WIMLIB_UPDATE_OP_DELETE:
441 case WIMLIB_UPDATE_OP_RENAME:
449 execute_update_commands(WIMStruct *wim,
450 const struct wimlib_update_command *cmds,
452 wimlib_progress_func_t progress_func)
455 for (size_t i = 0; i < num_cmds; i++) {
456 DEBUG("Executing update command %zu of %zu (op=%"TS")",
457 i + 1, num_cmds, update_op_to_str(cmds[i].op));
458 switch (cmds[i].op) {
459 case WIMLIB_UPDATE_OP_ADD:
460 ret = execute_add_command(wim, &cmds[i], progress_func);
462 case WIMLIB_UPDATE_OP_DELETE:
463 ret = execute_delete_command(wim, &cmds[i]);
465 case WIMLIB_UPDATE_OP_RENAME:
466 ret = execute_rename_command(wim, &cmds[i]);
478 check_add_command(struct wimlib_update_command *cmd,
479 const struct wim_header *hdr)
481 int add_flags = cmd->add.add_flags;
483 /* Are we adding the entire image or not? An empty wim_target_path
484 * indicates that the tree we're adding is to be placed in the root of
485 * the image. We consider this to be capturing the entire image,
486 * although it could potentially be an overlay on an existing root as
488 bool is_entire_image = cmd->add.wim_target_path[0] == T('\0');
491 /* Check for flags not supported on Windows */
492 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
493 ERROR("wimlib was compiled without support for NTFS-3g, so");
494 ERROR("we cannot capture a WIM image directly from a NTFS volume");
495 return WIMLIB_ERR_UNSUPPORTED;
497 if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
498 ERROR("Capturing UNIX-specific data is not supported on Windows");
499 return WIMLIB_ERR_UNSUPPORTED;
501 if (add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) {
502 ERROR("Dereferencing symbolic links is not supported on Windows");
503 return WIMLIB_ERR_UNSUPPORTED;
507 /* VERBOSE implies EXCLUDE_VERBOSE */
508 if (add_flags & WIMLIB_ADD_FLAG_VERBOSE)
509 add_flags |= WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
511 /* Check for contradictory reparse point fixup flags */
512 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
513 WIMLIB_ADD_FLAG_NORPFIX)) ==
514 (WIMLIB_ADD_FLAG_RPFIX |
515 WIMLIB_ADD_FLAG_NORPFIX))
517 ERROR("Cannot specify RPFIX and NORPFIX flags "
518 "at the same time!");
519 return WIMLIB_ERR_INVALID_PARAM;
522 /* Set default behavior on reparse point fixups if requested */
523 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
524 WIMLIB_ADD_FLAG_NORPFIX)) == 0)
526 /* Do reparse-point fixups by default if we are capturing an
527 * entire image and either the header flag is set from previous
528 * images, or if this is the first image being added. */
529 if (is_entire_image &&
530 ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
531 add_flags |= WIMLIB_ADD_FLAG_RPFIX;
534 if (!is_entire_image) {
535 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
536 ERROR("Cannot add directly from a NTFS volume "
537 "when not capturing a full image!");
538 return WIMLIB_ERR_INVALID_PARAM;
541 if (add_flags & WIMLIB_ADD_FLAG_RPFIX) {
542 ERROR("Cannot do reparse point fixups when "
543 "not capturing a full image!");
544 return WIMLIB_ERR_INVALID_PARAM;
547 /* We may have modified the add flags. */
548 cmd->add.add_flags = add_flags;
553 check_update_command(struct wimlib_update_command *cmd,
554 const struct wim_header *hdr)
557 case WIMLIB_UPDATE_OP_ADD:
558 return check_add_command(cmd, hdr);
559 case WIMLIB_UPDATE_OP_DELETE:
560 case WIMLIB_UPDATE_OP_RENAME:
567 check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
568 const struct wim_header *hdr)
571 for (size_t i = 0; i < num_cmds; i++) {
572 ret = check_update_command(&cmds[i], hdr);
581 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
584 for (size_t i = 0; i < num_cmds; i++) {
585 switch (cmds[i].op) {
586 case WIMLIB_UPDATE_OP_ADD:
587 FREE(cmds[i].add.fs_source_path);
588 FREE(cmds[i].add.wim_target_path);
589 free_capture_config(cmds[i].add.config);
591 case WIMLIB_UPDATE_OP_DELETE:
592 FREE(cmds[i].delete.wim_path);
594 case WIMLIB_UPDATE_OP_RENAME:
595 FREE(cmds[i].rename.wim_source_path);
596 FREE(cmds[i].rename.wim_target_path);
605 copy_update_commands(const struct wimlib_update_command *cmds,
607 struct wimlib_update_command **cmds_copy_ret)
610 struct wimlib_update_command *cmds_copy;
612 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
616 for (size_t i = 0; i < num_cmds; i++) {
617 cmds_copy[i].op = cmds[i].op;
618 switch (cmds[i].op) {
619 case WIMLIB_UPDATE_OP_ADD:
620 cmds_copy[i].add.fs_source_path =
621 canonicalize_fs_path(cmds[i].add.fs_source_path);
622 cmds_copy[i].add.wim_target_path =
623 canonicalize_wim_path(cmds[i].add.wim_target_path);
624 if (!cmds_copy[i].add.fs_source_path ||
625 !cmds_copy[i].add.wim_target_path)
627 if (cmds[i].add.config) {
628 ret = copy_and_canonicalize_capture_config(cmds[i].add.config,
629 &cmds_copy[i].add.config);
633 cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
635 case WIMLIB_UPDATE_OP_DELETE:
636 cmds_copy[i].delete.wim_path =
637 canonicalize_wim_path(cmds[i].delete.wim_path);
638 if (!cmds_copy[i].delete.wim_path)
640 cmds_copy[i].delete.delete_flags = cmds[i].delete.delete_flags;
642 case WIMLIB_UPDATE_OP_RENAME:
643 cmds_copy[i].rename.wim_source_path =
644 canonicalize_wim_path(cmds[i].rename.wim_source_path);
645 cmds_copy[i].rename.wim_target_path =
646 canonicalize_wim_path(cmds[i].rename.wim_target_path);
647 if (!cmds_copy[i].rename.wim_source_path ||
648 !cmds_copy[i].rename.wim_target_path)
652 ERROR("Unknown update operation %u", cmds[i].op);
653 ret = WIMLIB_ERR_INVALID_PARAM;
657 *cmds_copy_ret = cmds_copy;
662 ret = WIMLIB_ERR_NOMEM;
664 free_update_commands(cmds_copy, num_cmds);
669 * Entry point for making a series of updates to a WIM image.
672 wimlib_update_image(WIMStruct *wim,
674 const struct wimlib_update_command *cmds,
677 wimlib_progress_func_t progress_func)
680 struct wimlib_update_command *cmds_copy;
682 DEBUG("Updating image %d with %zu commands", image, num_cmds);
684 /* Refuse to update a split WIM. */
685 if (wim->hdr.total_parts != 1) {
686 ERROR("Cannot update a split WIM!");
687 ret = WIMLIB_ERR_SPLIT_UNSUPPORTED;
691 /* Load the metadata for the image to modify (if not loaded already) */
692 ret = select_wim_image(wim, image);
696 /* Short circuit a successful return if no commands were specified.
697 * Avoids problems with trying to allocate 0 bytes of memory. */
701 DEBUG("Preparing %zu update commands", num_cmds);
703 /* Make a copy of the update commands, in the process doing certain
704 * canonicalizations on paths (e.g. translating backslashes to forward
705 * slashes). This is done to avoid modifying the caller's copy of the
707 ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
711 /* Perform additional checks on the update commands before we execute
713 ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
715 goto out_free_cmds_copy;
717 /* Actually execute the update commands. */
718 DEBUG("Executing %zu update commands", num_cmds);
719 ret = execute_update_commands(wim, cmds_copy, num_cmds, progress_func);
721 goto out_free_cmds_copy;
723 wim->image_metadata[image - 1]->modified = 1;
725 /* Statistics about the WIM image, such as the numbers of files and
726 * directories, may have changed. Call xml_update_image_info() to
727 * recalculate these statistics. */
728 xml_update_image_info(wim, image);
730 free_update_commands(cmds_copy, num_cmds);