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"
31 /* Creates a new directory to place in the WIM image. This is to create parent
32 * directories that are not part of any target as needed. */
34 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret)
37 struct wim_dentry *dentry;
39 DEBUG("Creating filler directory \"%"TS"\"", name);
40 ret = new_dentry_with_inode(name, &dentry);
43 /* Leave the inode number as 0; this is allowed for non
44 * hard-linked files. */
45 dentry->d_inode->i_resolved = 1;
46 dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
53 /* Overlays @branch onto @target, both of which must be directories. */
55 do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
57 struct rb_root *rb_root;
59 DEBUG("Doing overlay \"%"WS"\" => \"%"WS"\"",
60 branch->file_name, target->file_name);
62 if (!dentry_is_directory(branch) || !dentry_is_directory(target)) {
63 ERROR("Cannot overlay \"%"WS"\" onto existing dentry: "
64 "is not directory-on-directory!", branch->file_name);
65 return WIMLIB_ERR_INVALID_OVERLAY;
68 rb_root = &branch->d_inode->i_children;
69 while (rb_root->rb_node) { /* While @branch has children... */
70 struct wim_dentry *child = rbnode_dentry(rb_root->rb_node);
71 struct wim_dentry *existing;
73 /* Move @child to the directory @target */
75 existing = dentry_add_child(target, child);
77 /* File or directory with same name already exists */
80 ret = do_overlay(existing, child);
82 /* Overlay failed. Revert the change to avoid
83 * leaking the directory tree rooted at @child.
85 dentry_add_child(branch, child);
94 /* Attach or overlay a branch onto the WIM image.
97 * Pointer to the root of the WIM image, or pointer to NULL if it has not
102 * Path in the WIM image to add the branch, with leading and trailing
106 attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
110 struct wim_dentry *dentry, *parent, *target;
113 DEBUG("Attaching branch \"%"WS"\" => \"%"TS"\"",
114 branch->file_name, target_path);
116 if (*target_path == T('\0')) {
117 /* Target: root directory */
119 /* Overlay on existing root */
120 return do_overlay(*root_p, branch);
122 if (!dentry_is_directory(branch)) {
123 ERROR("Cannot set non-directory as root of WIM image");
124 return WIMLIB_ERR_NOTDIR;
132 /* Adding a non-root branch. Create root if it hasn't been created
135 ret = new_filler_directory(T(""), root_p);
140 /* Walk the path to the branch, creating filler directories as needed.
143 while ((slash = tstrchr(target_path, T('/')))) {
145 dentry = get_dentry_child_with_name(parent, target_path);
147 ret = new_filler_directory(target_path, &dentry);
150 dentry_add_child(parent, dentry);
154 /* Skip over slashes. Note: this cannot overrun the length of
155 * the string because the last character cannot be a slash, as
156 * trailing slashes were tripped. */
159 } while (*target_path == T('/'));
162 /* If the target path already existed, overlay the branch onto it.
163 * Otherwise, set the branch as the target path. */
164 target = get_dentry_child_with_utf16le_name(parent, branch->file_name,
165 branch->file_name_nbytes);
167 return do_overlay(target, branch);
169 dentry_add_child(parent, branch);
175 execute_add_command(WIMStruct *wim,
176 const struct wimlib_update_command *add_cmd,
177 wimlib_progress_func_t progress_func)
181 tchar *fs_source_path;
182 tchar *wim_target_path;
183 struct wim_inode_table inode_table;
184 struct sd_set sd_set;
185 struct wim_image_metadata *imd;
186 struct list_head unhashed_streams;
187 struct add_image_params params;
188 int (*capture_tree)(struct wim_dentry **,
190 struct add_image_params *);
191 union wimlib_progress_info progress;
192 struct wimlib_capture_config *config;
194 struct _ntfs_volume *ntfs_vol = NULL;
197 struct wim_dentry *branch;
198 bool rollback_sd = true;
200 wimlib_assert(add_cmd->op == WIMLIB_UPDATE_OP_ADD);
201 add_flags = add_cmd->add.add_flags;
202 fs_source_path = add_cmd->add.fs_source_path;
203 wim_target_path = add_cmd->add.wim_target_path;
204 config = add_cmd->add.config;
205 DEBUG("fs_source_path=\"%"TS"\", wim_target_path=\"%"TS"\", add_flags=%#x",
206 fs_source_path, wim_target_path, add_flags);
208 imd = wim->image_metadata[wim->current_image - 1];
210 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
212 capture_tree = build_dentry_tree_ntfs;
213 extra_arg = &ntfs_vol;
214 if (imd->ntfs_vol != NULL) {
215 ERROR("NTFS volume already set");
216 ret = WIMLIB_ERR_INVALID_PARAM;
220 ret = WIMLIB_ERR_INVALID_PARAM;
225 capture_tree = win32_build_dentry_tree;
227 capture_tree = unix_build_dentry_tree;
232 ret = init_inode_table(&inode_table, 9001);
236 ret = init_sd_set(&sd_set, imd->security_data);
238 goto out_destroy_inode_table;
240 INIT_LIST_HEAD(&unhashed_streams);
241 wim->lookup_table->unhashed_streams = &unhashed_streams;
242 params.lookup_table = wim->lookup_table;
243 params.inode_table = &inode_table;
244 params.sd_set = &sd_set;
245 params.config = config;
246 params.add_image_flags = add_flags;
247 params.progress_func = progress_func;
248 params.extra_arg = extra_arg;
251 memset(&progress, 0, sizeof(progress));
252 progress.scan.source = fs_source_path;
253 progress.scan.wim_target_path = wim_target_path;
254 progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &progress);
256 config->_prefix = fs_source_path;
257 config->_prefix_num_tchars = tstrlen(fs_source_path);
259 if (wim_target_path[0] == T('\0'))
260 add_flags |= WIMLIB_ADD_IMAGE_FLAG_ROOT;
261 ret = (*capture_tree)(&branch, fs_source_path, ¶ms);
263 ERROR("Failed to build dentry tree for \"%"TS"\"",
265 goto out_destroy_sd_set;
268 /* Use the target name, not the source name, for
269 * the root of each branch from a capture
270 * source. (This will also set the root dentry
271 * of the entire image to be unnamed.) */
272 ret = set_dentry_name(branch,
273 path_basename(wim_target_path));
275 goto out_ntfs_umount;
277 ret = attach_branch(&imd->root_dentry, branch, wim_target_path);
279 goto out_ntfs_umount;
282 progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &progress);
283 list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
285 imd->ntfs_vol = ntfs_vol;
287 inode_table_prepare_inode_list(&inode_table, &imd->inode_list);
290 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX)
291 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
292 goto out_destroy_sd_set;
296 do_ntfs_umount(ntfs_vol);
298 free_dentry_tree(branch, wim->lookup_table);
300 destroy_sd_set(&sd_set, rollback_sd);
301 out_destroy_inode_table:
302 destroy_inode_table(&inode_table);
308 execute_delete_command(WIMStruct *wim,
309 const struct wimlib_update_command *delete_cmd)
312 const tchar *wim_path;
313 struct wim_dentry *tree;
316 wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE);
317 flags = delete_cmd->delete.delete_flags;
318 wim_path = delete_cmd->delete.wim_path;
320 tree = get_dentry(wim, wim_path);
322 /* Path to delete does not exist in the WIM. */
323 if (flags & WIMLIB_DELETE_FLAG_FORCE) {
326 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
327 wim_path, wim->current_image);
328 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
332 if (dentry_is_directory(tree) && !(flags & WIMLIB_DELETE_FLAG_RECURSIVE)) {
333 ERROR("Path \"%"TS"\" in WIM image %d is a directory "
334 "but a recursive delete was not requested",
335 wim_path, wim->current_image);
336 return WIMLIB_ERR_IS_DIRECTORY;
339 is_root = dentry_is_root(tree);
341 free_dentry_tree(tree, wim->lookup_table);
343 wim->image_metadata[wim->current_image - 1]->root_dentry = NULL;
348 * Rename a file or directory in the WIM.
350 * This is also called from wimfs_rename() in the FUSE mount code.
353 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
355 struct wim_dentry *src;
356 struct wim_dentry *dst;
357 struct wim_dentry *parent_of_dst;
360 /* This rename() implementation currently only supports actual files
361 * (not alternate data streams) */
363 src = get_dentry(wim, from);
367 dst = get_dentry(wim, to);
370 /* Destination file exists */
372 if (src == dst) /* Same file */
375 if (!dentry_is_directory(src)) {
376 /* Cannot rename non-directory to directory. */
377 if (dentry_is_directory(dst))
380 /* Cannot rename directory to a non-directory or a non-empty
382 if (!dentry_is_directory(dst))
384 if (inode_has_children(dst->d_inode))
387 parent_of_dst = dst->parent;
389 /* Destination does not exist */
390 parent_of_dst = get_parent_dentry(wim, to);
394 if (!dentry_is_directory(parent_of_dst))
398 ret = set_dentry_name(src, path_basename(to));
403 free_dentry_tree(dst, wim->lookup_table);
406 dentry_add_child(parent_of_dst, src);
412 execute_rename_command(WIMStruct *wim,
413 const struct wimlib_update_command *rename_cmd)
417 wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME);
419 ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
420 rename_cmd->rename.wim_target_path);
424 ret = WIMLIB_ERR_NOMEM;
427 ret = WIMLIB_ERR_NOTDIR;
431 ret = WIMLIB_ERR_IS_DIRECTORY;
435 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
442 static inline const tchar *
443 update_op_to_str(int op)
446 case WIMLIB_UPDATE_OP_ADD:
448 case WIMLIB_UPDATE_OP_DELETE:
450 case WIMLIB_UPDATE_OP_RENAME:
458 execute_update_commands(WIMStruct *wim,
459 const struct wimlib_update_command *cmds,
461 wimlib_progress_func_t progress_func)
464 for (size_t i = 0; i < num_cmds; i++) {
465 DEBUG("Executing update command %zu of %zu (op=%"TS")",
466 i + 1, num_cmds, update_op_to_str(cmds[i].op));
467 switch (cmds[i].op) {
468 case WIMLIB_UPDATE_OP_ADD:
469 ret = execute_add_command(wim, &cmds[i], progress_func);
471 case WIMLIB_UPDATE_OP_DELETE:
472 ret = execute_delete_command(wim, &cmds[i]);
474 wim->deletion_occurred = 1;
476 case WIMLIB_UPDATE_OP_RENAME:
477 ret = execute_rename_command(wim, &cmds[i]);
480 ret = WIMLIB_ERR_INVALID_PARAM;
485 wim->image_metadata[wim->current_image - 1]->modified = 1;
491 check_add_command(struct wimlib_update_command *cmd,
492 const struct wim_header *hdr)
494 int add_flags = cmd->add.add_flags;
495 bool is_entire_image = cmd->add.wim_target_path[0] == T('\0');
498 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
499 ERROR("wimlib was compiled without support for NTFS-3g, so");
500 ERROR("we cannot capture a WIM image directly from a NTFS volume");
501 return WIMLIB_ERR_UNSUPPORTED;
503 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) {
504 ERROR("Capturing UNIX-specific data is not supported on Windows");
505 return WIMLIB_ERR_INVALID_PARAM;
507 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE) {
508 ERROR("Dereferencing symbolic links is not supported on Windows");
509 return WIMLIB_ERR_INVALID_PARAM;
513 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
514 add_flags |= WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
516 if ((add_flags & (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
517 WIMLIB_ADD_IMAGE_FLAG_NORPFIX)) ==
518 (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
519 WIMLIB_ADD_IMAGE_FLAG_NORPFIX))
521 ERROR("Cannot specify RPFIX and NORPFIX flags "
522 "at the same time!");
523 return WIMLIB_ERR_INVALID_PARAM;
526 if ((add_flags & (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
527 WIMLIB_ADD_IMAGE_FLAG_NORPFIX)) == 0)
529 /* Do reparse-point fixups by default if we are capturing an
530 * entire image and either the header flag is set from previous
531 * images, or if this is the first image being added. */
532 if (is_entire_image &&
533 ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
534 add_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
537 if (!is_entire_image) {
538 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
539 ERROR("Cannot add directly from a NTFS volume "
540 "when not capturing a full image!");
541 return WIMLIB_ERR_INVALID_PARAM;
544 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX) {
545 ERROR("Cannot do reparse point fixups when "
546 "not capturing a full image!");
547 return WIMLIB_ERR_INVALID_PARAM;
550 ret = canonicalize_capture_config(cmd->add.config);
553 cmd->add.add_flags = add_flags;
558 check_update_command(struct wimlib_update_command *cmd,
559 const struct wim_header *hdr)
562 case WIMLIB_UPDATE_OP_ADD:
563 return check_add_command(cmd, hdr);
564 case WIMLIB_UPDATE_OP_DELETE:
565 case WIMLIB_UPDATE_OP_RENAME:
572 check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
573 const struct wim_header *hdr)
576 for (size_t i = 0; i < num_cmds; i++) {
577 ret = check_update_command(&cmds[i], hdr);
586 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
589 for (size_t i = 0; i < num_cmds; i++) {
591 case WIMLIB_UPDATE_OP_ADD:
592 FREE(cmds[i].add.fs_source_path);
593 FREE(cmds[i].add.wim_target_path);
594 free_capture_config(cmds[i].add.config);
596 case WIMLIB_UPDATE_OP_DELETE:
597 FREE(cmds[i].delete.wim_path);
599 case WIMLIB_UPDATE_OP_RENAME:
600 FREE(cmds[i].rename.wim_source_path);
601 FREE(cmds[i].rename.wim_target_path);
610 copy_update_commands(const struct wimlib_update_command *cmds,
612 struct wimlib_update_command **cmds_copy_ret)
615 struct wimlib_update_command *cmds_copy;
617 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
621 for (size_t i = 0; i < num_cmds; i++) {
622 cmds_copy[i].op = cmds[i].op;
623 switch (cmds[i].op) {
624 case WIMLIB_UPDATE_OP_ADD:
625 cmds_copy[i].add.fs_source_path =
626 canonicalize_fs_path(cmds[i].add.fs_source_path);
627 cmds_copy[i].add.wim_target_path =
628 canonicalize_wim_path(cmds[i].add.wim_target_path);
629 if (!cmds_copy[i].add.fs_source_path ||
630 !cmds_copy[i].add.wim_target_path)
632 if (cmds[i].add.config) {
633 cmds_copy[i].add.config =
634 copy_capture_config(cmds[i].add.config);
635 if (!cmds_copy[i].add.config)
638 cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
640 case WIMLIB_UPDATE_OP_DELETE:
641 cmds_copy[i].delete.wim_path =
642 canonicalize_wim_path(cmds[i].delete.wim_path);
643 if (!cmds_copy[i].delete.wim_path)
645 cmds_copy[i].delete.delete_flags = cmds[i].delete.delete_flags;
647 case WIMLIB_UPDATE_OP_RENAME:
648 cmds_copy[i].rename.wim_source_path =
649 canonicalize_wim_path(cmds[i].rename.wim_source_path);
650 cmds_copy[i].rename.wim_target_path =
651 canonicalize_wim_path(cmds[i].rename.wim_target_path);
652 if (!cmds_copy[i].rename.wim_source_path ||
653 !cmds_copy[i].rename.wim_target_path)
657 ERROR("Unknown update operation %u", cmds[i].op);
658 ret = WIMLIB_ERR_INVALID_PARAM;
662 *cmds_copy_ret = cmds_copy;
667 ret = WIMLIB_ERR_NOMEM;
669 free_update_commands(cmds_copy, num_cmds);
674 wimlib_update_image(WIMStruct *wim,
676 const struct wimlib_update_command *cmds,
679 wimlib_progress_func_t progress_func)
682 struct wimlib_update_command *cmds_copy;
684 DEBUG("Updating image %d with %zu commands", image, num_cmds);
686 if (wim->hdr.total_parts != 1) {
687 ERROR("Cannot update a split WIM!");
688 ret = WIMLIB_ERR_SPLIT_UNSUPPORTED;
692 ret = select_wim_image(wim, image);
696 DEBUG("Selected image %d for update", image);
701 DEBUG("Preparing %zu update commands", num_cmds);
703 ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
707 ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
709 goto out_free_cmds_copy;
711 DEBUG("Executing %zu update commands", num_cmds);
713 ret = execute_update_commands(wim, cmds_copy, num_cmds, progress_func);
715 goto out_free_cmds_copy;
716 xml_update_image_info(wim, wim->current_image);
718 free_update_commands(cmds_copy, num_cmds);