2 * update_image.c - Update a WIM image.
6 * Copyright (C) 2013, 2014 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/encoding.h"
31 #include "wimlib/error.h"
32 #include "wimlib/lookup_table.h"
33 #include "wimlib/metadata.h"
35 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
37 #include "wimlib/paths.h"
38 #include "wimlib/xml.h"
48 /* Saved specification of a "primitive" update operation that was performed. */
49 struct update_primitive {
51 /* Unlinked a dentry from its parent directory. */
54 /* Linked a dentry into its parent directory. */
57 /* Changed the file name of a dentry. */
60 /* Changed the short name of a dentry. */
65 /* For UNLINK_DENTRY and LINK_DENTRY operations */
67 /* Dentry that was linked or unlinked. */
68 struct wim_dentry *subject;
70 /* For link operations, the directory into which
71 * @subject was linked, or NULL if @subject was set as
72 * the root of the image.
74 * For unlink operations, the directory from which
75 * @subject was unlinked, or NULL if @subject was unset
76 * as the root of the image. */
77 struct wim_dentry *parent;
80 /* For CHANGE_FILE_NAME and CHANGE_SHORT_NAME operations */
82 /* Dentry that had its name changed. */
83 struct wim_dentry *subject;
86 utf16lechar *old_name;
91 /* Chronological list of primitive operations that were executed for a single
92 * logical update command, such as 'add', 'delete', or 'rename'. */
93 struct update_primitive_list {
94 struct update_primitive *entries;
95 struct update_primitive inline_entries[4];
97 size_t num_alloc_entries;
100 /* Journal for managing the executing of zero or more logical update commands,
101 * such as 'add', 'delete', or 'rename'. This allows either committing or
102 * rolling back the commands. */
103 struct update_command_journal {
104 /* Number of update commands this journal contains. */
107 /* Index of currently executing update command. */
110 /* Location of the WIM image's root pointer. */
111 struct wim_dentry **root_p;
113 /* Pointer to the lookup table of the WIM (may needed for rollback) */
114 struct wim_lookup_table *lookup_table;
116 /* List of dentries that are currently unlinked from the WIM image.
117 * These must be freed when no longer needed for commit or rollback. */
118 struct list_head orphans;
120 /* Per-command logs. */
121 struct update_primitive_list cmd_prims[];
125 init_update_primitive_list(struct update_primitive_list *l)
127 l->entries = l->inline_entries;
129 l->num_alloc_entries = ARRAY_LEN(l->inline_entries);
132 /* Allocates a new journal for managing the execution of up to @num_cmds update
134 static struct update_command_journal *
135 new_update_command_journal(size_t num_cmds, struct wim_dentry **root_p,
136 struct wim_lookup_table *lookup_table)
138 struct update_command_journal *j;
140 j = MALLOC(sizeof(*j) + num_cmds * sizeof(j->cmd_prims[0]));
142 j->num_cmds = num_cmds;
145 j->lookup_table = lookup_table;
146 INIT_LIST_HEAD(&j->orphans);
147 for (size_t i = 0; i < num_cmds; i++)
148 init_update_primitive_list(&j->cmd_prims[i]);
153 /* Don't call this directly; use commit_update() or rollback_update() instead.
156 free_update_command_journal(struct update_command_journal *j)
158 struct wim_dentry *orphan;
160 /* Free orphaned dentry trees */
161 while (!list_empty(&j->orphans)) {
162 orphan = list_first_entry(&j->orphans,
163 struct wim_dentry, tmp_list);
164 list_del(&orphan->tmp_list);
165 free_dentry_tree(orphan, j->lookup_table);
168 for (size_t i = 0; i < j->num_cmds; i++)
169 if (j->cmd_prims[i].entries != j->cmd_prims[i].inline_entries)
170 FREE(j->cmd_prims[i].entries);
174 /* Add the entry @prim to the update command journal @j. */
176 record_update_primitive(struct update_command_journal *j,
177 struct update_primitive prim)
179 struct update_primitive_list *l;
181 l = &j->cmd_prims[j->cur_cmd];
183 if (l->num_entries == l->num_alloc_entries) {
184 struct update_primitive *new_entries;
185 size_t new_num_alloc_entries;
188 new_num_alloc_entries = l->num_alloc_entries * 2;
189 new_size = new_num_alloc_entries * sizeof(new_entries[0]);
190 if (l->entries == l->inline_entries) {
191 new_entries = MALLOC(new_size);
193 return WIMLIB_ERR_NOMEM;
194 memcpy(new_entries, l->inline_entries,
195 sizeof(l->inline_entries));
197 new_entries = REALLOC(l->entries, new_size);
199 return WIMLIB_ERR_NOMEM;
201 l->entries = new_entries;
202 l->num_alloc_entries = new_num_alloc_entries;
204 l->entries[l->num_entries++] = prim;
209 do_unlink(struct wim_dentry *subject, struct wim_dentry *parent,
210 struct wim_dentry **root_p)
213 /* Unlink @subject from its @parent. */
214 wimlib_assert(subject->parent == parent);
215 unlink_dentry(subject);
217 /* Unset @subject as the root of the image. */
220 subject->parent = subject;
224 do_link(struct wim_dentry *subject, struct wim_dentry *parent,
225 struct wim_dentry **root_p)
228 /* Link @subject to its @parent */
229 struct wim_dentry *existing;
231 existing = dentry_add_child(parent, subject);
232 wimlib_assert(!existing);
234 /* Set @subject as root of the image */
239 /* Undo a link operation. */
241 rollback_link(struct wim_dentry *subject, struct wim_dentry *parent,
242 struct wim_dentry **root_p, struct list_head *orphans)
244 /* Unlink is the opposite of link */
245 do_unlink(subject, parent, root_p);
247 /* @subject is now unlinked. Add it to orphans. */
248 list_add(&subject->tmp_list, orphans);
249 subject->is_orphan = 1;
252 /* Undo an unlink operation. */
254 rollback_unlink(struct wim_dentry *subject, struct wim_dentry *parent,
255 struct wim_dentry **root_p)
257 /* Link is the opposite of unlink */
258 do_link(subject, parent, root_p);
260 /* @subject is no longer unlinked. Delete it from orphans. */
261 list_del(&subject->tmp_list);
262 subject->is_orphan = 0;
265 /* Rollback a name change operation. */
267 rollback_name_change(utf16lechar *old_name,
268 utf16lechar **name_ptr, u16 *name_nbytes_ptr)
270 /* Free the new name, then replace it with the old name. */
273 *name_ptr = old_name;
274 *name_nbytes_ptr = utf16le_strlen(old_name);
277 *name_nbytes_ptr = 0;
281 /* Rollback a primitive update operation. */
283 rollback_update_primitive(const struct update_primitive *prim,
284 struct wim_dentry **root_p,
285 struct list_head *orphans)
287 switch (prim->type) {
289 rollback_link(prim->link.subject, prim->link.parent, root_p,
293 rollback_unlink(prim->link.subject, prim->link.parent, root_p);
295 case CHANGE_FILE_NAME:
296 rollback_name_change(prim->name.old_name,
297 &prim->name.subject->file_name,
298 &prim->name.subject->file_name_nbytes);
300 case CHANGE_SHORT_NAME:
301 rollback_name_change(prim->name.old_name,
302 &prim->name.subject->short_name,
303 &prim->name.subject->short_name_nbytes);
308 /* Rollback a logical update command */
310 rollback_update_command(const struct update_primitive_list *l,
311 struct wim_dentry **root_p,
312 struct list_head *orphans)
314 size_t i = l->num_entries;
316 /* Rollback each primitive operation, in reverse order. */
318 rollback_update_primitive(&l->entries[i], root_p, orphans);
321 /****************************************************************************/
323 /* Link @subject into the directory @parent; or, if @parent is NULL, set
324 * @subject as the root of the WIM image.
326 * This is the journaled version, so it can be rolled back. */
328 journaled_link(struct update_command_journal *j,
329 struct wim_dentry *subject, struct wim_dentry *parent)
331 struct update_primitive prim;
334 prim.type = LINK_DENTRY;
335 prim.link.subject = subject;
336 prim.link.parent = parent;
338 ret = record_update_primitive(j, prim);
342 do_link(subject, parent, j->root_p);
344 if (subject->is_orphan) {
345 list_del(&subject->tmp_list);
346 subject->is_orphan = 0;
351 /* Unlink @subject from the WIM image.
353 * This is the journaled version, so it can be rolled back. */
355 journaled_unlink(struct update_command_journal *j, struct wim_dentry *subject)
357 struct wim_dentry *parent;
358 struct update_primitive prim;
361 if (dentry_is_root(subject))
364 parent = subject->parent;
366 prim.type = UNLINK_DENTRY;
367 prim.link.subject = subject;
368 prim.link.parent = parent;
370 ret = record_update_primitive(j, prim);
374 do_unlink(subject, parent, j->root_p);
376 list_add(&subject->tmp_list, &j->orphans);
377 subject->is_orphan = 1;
381 /* Change the name of @dentry to @new_name_tstr.
383 * This is the journaled version, so it can be rolled back. */
385 journaled_change_name(struct update_command_journal *j,
386 struct wim_dentry *dentry, const tchar *new_name_tstr)
389 utf16lechar *new_name = NULL;
390 u16 new_name_nbytes = 0;
391 struct update_primitive prim;
393 /* Set the long name. */
394 ret = get_utf16le_string(new_name_tstr, &new_name, &new_name_nbytes);
398 prim.type = CHANGE_FILE_NAME;
399 prim.name.subject = dentry;
400 prim.name.old_name = dentry->file_name;
401 ret = record_update_primitive(j, prim);
405 dentry->file_name = new_name;
406 dentry->file_name_nbytes = new_name_nbytes;
408 /* Clear the short name. */
409 prim.type = CHANGE_SHORT_NAME;
410 prim.name.subject = dentry;
411 prim.name.old_name = dentry->short_name;
412 ret = record_update_primitive(j, prim);
416 dentry->short_name = NULL;
417 dentry->short_name_nbytes = 0;
422 next_command(struct update_command_journal *j)
428 commit_update(struct update_command_journal *j)
430 for (size_t i = 0; i < j->num_cmds; i++)
432 for (size_t k = 0; k < j->cmd_prims[i].num_entries; k++)
434 if (j->cmd_prims[i].entries[k].type == CHANGE_FILE_NAME ||
435 j->cmd_prims[i].entries[k].type == CHANGE_SHORT_NAME)
437 FREE(j->cmd_prims[i].entries[k].name.old_name);
441 free_update_command_journal(j);
445 rollback_update(struct update_command_journal *j)
447 /* Rollback each logical update command, in reverse order. */
448 size_t i = j->cur_cmd;
452 rollback_update_command(&j->cmd_prims[i], j->root_p, &j->orphans);
453 free_update_command_journal(j);
457 * Set the name of @branch for placing it at @target in the WIM image. This
458 * assumes that @target is in "canonical form", as produced by
459 * canonicalize_wim_path().
461 * Note: for the root target this produces the empty name.
464 set_branch_name(struct wim_dentry *branch, const utf16lechar *target)
466 const utf16lechar *p;
468 /* Find end of string. (We can assume it contains at least one
469 * character, the leading slash.) */
470 wimlib_assert(target[0] == cpu_to_le16(WIM_PATH_SEPARATOR));
476 while (*(p - 1) != cpu_to_le16(WIM_PATH_SEPARATOR))
480 /* We're assuming no trailing slashes. */
481 wimlib_assert(*p || p == &target[1]);
483 return dentry_set_name_utf16le(branch, p);
487 handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing,
488 struct update_command_journal *j,
489 int add_flags, wimlib_progress_func_t progress_func)
491 bool branch_is_dir = dentry_is_directory(branch);
492 bool existing_is_dir = dentry_is_directory(existing);
494 if (branch_is_dir != existing_is_dir) {
495 if (existing_is_dir) {
496 ERROR("\"%"TS"\" is a directory!\n"
497 " Specify the path at which "
498 "to place the file inside this directory.",
499 dentry_full_path(existing));
500 return WIMLIB_ERR_IS_DIRECTORY;
502 ERROR("Can't place directory at \"%"TS"\" because "
503 "a nondirectory file already exists there!",
504 dentry_full_path(existing));
505 return WIMLIB_ERR_NOTDIR;
510 /* Directory overlay */
511 while (dentry_has_children(branch)) {
512 struct wim_dentry *new_child;
513 struct wim_dentry *existing_child;
516 new_child = dentry_any_child(branch);
519 get_dentry_child_with_utf16le_name(existing,
520 new_child->file_name,
521 new_child->file_name_nbytes,
522 WIMLIB_CASE_PLATFORM_DEFAULT);
523 unlink_dentry(new_child);
524 if (existing_child) {
525 ret = handle_conflict(new_child, existing_child,
526 j, add_flags, progress_func);
528 ret = journaled_link(j, new_child, existing);
531 dentry_add_child(branch, new_child);
537 } else if (add_flags & WIMLIB_ADD_FLAG_NO_REPLACE) {
538 /* Can't replace nondirectory file */
539 ERROR("Refusing to overwrite nondirectory file \"%"TS"\"",
540 dentry_full_path(existing));
541 return WIMLIB_ERR_INVALID_OVERLAY;
543 /* Replace nondirectory file */
544 struct wim_dentry *parent;
547 parent = existing->parent;
549 ret = calculate_dentry_full_path(existing);
553 ret = journaled_unlink(j, existing);
557 ret = journaled_link(j, branch, parent);
561 if (progress_func && (add_flags & WIMLIB_ADD_FLAG_VERBOSE)) {
562 union wimlib_progress_info info;
564 info.replace.path_in_wim = existing->_full_path;
565 progress_func(WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM, &info);
572 do_attach_branch(struct wim_dentry *branch, utf16lechar *target,
573 struct update_command_journal *j,
574 int add_flags, wimlib_progress_func_t progress_func)
576 struct wim_dentry *parent;
577 struct wim_dentry *existing;
578 utf16lechar empty_name[1] = {0};
579 utf16lechar *cur_component_name;
580 utf16lechar *next_component_name;
583 /* Attempt to create root directory before proceeding to the "real"
586 existing = *j->root_p;
587 cur_component_name = empty_name;
589 /* Skip leading slashes */
590 next_component_name = target;
591 while (*next_component_name == cpu_to_le16(WIM_PATH_SEPARATOR))
592 next_component_name++;
594 while (*next_component_name) { /* While not the last component ... */
598 /* Descend into existing directory */
599 if (!dentry_is_directory(existing)) {
600 ERROR("\"%"TS"\" in the WIM image "
601 "is not a directory!",
602 dentry_full_path(existing));
603 return WIMLIB_ERR_NOTDIR;
606 /* A parent directory of the target didn't exist. Make
607 * the way by creating a filler directory. */
608 struct wim_dentry *filler;
610 ret = new_filler_directory(&filler);
613 ret = dentry_set_name_utf16le(filler,
619 ret = journaled_link(j, filler, parent);
627 /* Advance to next component */
629 cur_component_name = next_component_name;
630 end = cur_component_name + 1;
631 while (*end && *end != cpu_to_le16(WIM_PATH_SEPARATOR))
634 next_component_name = end;
636 /* There will still be more components after this. */
639 } while (*++next_component_name == cpu_to_le16(WIM_PATH_SEPARATOR));
640 wimlib_assert(*next_component_name); /* No trailing slashes */
642 /* This will be the last component */
643 next_component_name = end;
646 existing = get_dentry_child_with_utf16le_name(
649 (end - cur_component_name) * sizeof(utf16lechar),
650 WIMLIB_CASE_PLATFORM_DEFAULT);
655 return handle_conflict(branch, existing, j,
656 add_flags, progress_func);
658 return journaled_link(j, branch, parent);
663 * Place the directory entry tree @branch at the path @target_tstr in the WIM
666 * @target_tstr cannot contain trailing slashes, and all path separators must be
667 * WIM_PATH_SEPARATOR.
669 * On success, @branch is committed to the journal @j.
670 * Otherwise @branch is freed.
672 * The relevant @add_flags are WIMLIB_ADD_FLAG_NO_REPLACE and
673 * WIMLIB_ADD_FLAG_VERBOSE.
676 attach_branch(struct wim_dentry *branch, const tchar *target_tstr,
677 struct update_command_journal *j,
678 int add_flags, wimlib_progress_func_t progress_func)
683 if (unlikely(!branch))
687 target = memdup(target_tstr,
688 (tstrlen(target_tstr) + 1) * sizeof(target_tstr[0]));
690 ret = WIMLIB_ERR_NOMEM;
691 goto out_free_branch;
695 size_t target_nbytes;
696 ret = tstr_to_utf16le(target_tstr,
697 tstrlen(target_tstr) * sizeof(target_tstr[0]),
698 &target, &target_nbytes);
700 goto out_free_branch;
704 ret = set_branch_name(branch, target);
706 goto out_free_target;
708 ret = do_attach_branch(branch, target, j, add_flags, progress_func);
710 goto out_free_target;
711 /* branch was successfully committed to the journal */
716 free_dentry_tree(branch, j->lookup_table);
720 static const char wincfg[] =
726 "/System Volume Information\n"
730 static const tchar *wimboot_cfgfile =
731 WIMLIB_WIM_PATH_SEPARATOR_STRING T("Windows")
732 WIMLIB_WIM_PATH_SEPARATOR_STRING T("System32")
733 WIMLIB_WIM_PATH_SEPARATOR_STRING T("WimBootCompress.ini");
736 get_capture_config(const tchar *config_file, struct capture_config *config,
737 int add_flags, const tchar *fs_source_path)
740 tchar *tmp_config_file = NULL;
742 memset(config, 0, sizeof(*config));
744 /* For WIMBoot capture, check for default capture configuration file
745 * unless one was explicitly specified. */
746 if (!config_file && (add_flags & WIMLIB_ADD_FLAG_WIMBOOT)) {
748 /* XXX: Handle loading file correctly when in NTFS volume. */
750 size_t len = tstrlen(fs_source_path) +
751 tstrlen(wimboot_cfgfile);
752 tmp_config_file = MALLOC((len + 1) * sizeof(tchar));
755 tsprintf(tmp_config_file, T("%"TS"%"TS),
756 fs_source_path, wimboot_cfgfile);
757 if (!tstat(tmp_config_file, &st)) {
758 config_file = tmp_config_file;
759 add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
761 WARNING("\"%"TS"\" does not exist.\n"
762 " Using default capture configuration!",
767 if (add_flags & WIMLIB_ADD_FLAG_WINCONFIG) {
768 /* Use Windows default. */
770 return WIMLIB_ERR_INVALID_PARAM;
771 ret = read_capture_config(T("wincfg"), wincfg,
772 sizeof(wincfg) - 1, config);
773 } else if (config_file) {
774 /* Use the specified configuration file. */
775 ret = read_capture_config(config_file, NULL, 0, config);
777 /* ... Or don't use any configuration file at all. No files
778 * will be excluded from capture, all files will be compressed,
782 FREE(tmp_config_file);
787 execute_add_command(struct update_command_journal *j,
789 const struct wimlib_update_command *add_cmd,
790 struct wim_inode_table *inode_table,
791 struct wim_sd_set *sd_set,
792 struct list_head *unhashed_streams,
793 wimlib_progress_func_t progress_func)
797 tchar *fs_source_path;
798 tchar *wim_target_path;
799 const tchar *config_file;
800 struct add_image_params params;
801 struct capture_config config;
802 capture_tree_t capture_tree = platform_default_capture_tree;
804 struct _ntfs_volume *ntfs_vol = NULL;
806 void *extra_arg = NULL;
807 struct wim_dentry *branch;
809 add_flags = add_cmd->add.add_flags;
810 fs_source_path = add_cmd->add.fs_source_path;
811 wim_target_path = add_cmd->add.wim_target_path;
812 config_file = add_cmd->add.config_file;
814 DEBUG("fs_source_path=\"%"TS"\", wim_target_path=\"%"TS"\", add_flags=%#x",
815 fs_source_path, wim_target_path, add_flags);
817 memset(¶ms, 0, sizeof(params));
820 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
821 capture_tree = build_dentry_tree_ntfs;
822 extra_arg = &ntfs_vol;
823 if (wim_get_current_image_metadata(wim)->ntfs_vol != NULL) {
824 ERROR("NTFS volume already set");
825 ret = WIMLIB_ERR_INVALID_PARAM;
831 ret = get_capture_config(config_file, &config,
832 add_flags, fs_source_path);
836 params.lookup_table = wim->lookup_table;
837 params.unhashed_streams = unhashed_streams;
838 params.inode_table = inode_table;
839 params.sd_set = sd_set;
840 params.config = &config;
841 params.add_flags = add_flags;
842 params.extra_arg = extra_arg;
844 params.progress_func = progress_func;
845 params.progress.scan.source = fs_source_path;
846 params.progress.scan.wim_target_path = wim_target_path;
848 progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, ¶ms.progress);
850 if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path))
851 params.add_flags |= WIMLIB_ADD_FLAG_ROOT;
852 ret = (*capture_tree)(&branch, fs_source_path, ¶ms);
854 goto out_destroy_config;
857 progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, ¶ms.progress);
859 if (WIMLIB_IS_WIM_ROOT_PATH(wim_target_path) &&
860 branch && !dentry_is_directory(branch))
862 ERROR("\"%"TS"\" is not a directory!", fs_source_path);
863 ret = WIMLIB_ERR_NOTDIR;
864 free_dentry_tree(branch, wim->lookup_table);
865 goto out_cleanup_after_capture;
868 ret = attach_branch(branch, wim_target_path, j,
869 add_flags, params.progress_func);
871 goto out_cleanup_after_capture;
873 if (config_file && (add_flags & WIMLIB_ADD_FLAG_WIMBOOT) &&
874 WIMLIB_IS_WIM_ROOT_PATH(wim_target_path))
876 params.add_flags = 0;
877 params.progress_func = NULL;
878 params.config = NULL;
880 /* If a capture configuration file was explicitly specified when
881 * capturing an image in WIMBoot mode, save it as
882 * /Windows/System32/WimBootCompress.ini in the WIM image. */
883 ret = platform_default_capture_tree(&branch, config_file, ¶ms);
885 goto out_cleanup_after_capture;
887 ret = attach_branch(branch, wimboot_cfgfile, j, 0, NULL);
889 goto out_cleanup_after_capture;
893 wim_get_current_image_metadata(wim)->ntfs_vol = ntfs_vol;
895 if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
896 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
898 goto out_destroy_config;
899 out_cleanup_after_capture:
902 do_ntfs_umount(ntfs_vol);
905 destroy_capture_config(&config);
911 execute_delete_command(struct update_command_journal *j,
913 const struct wimlib_update_command *delete_cmd)
916 const tchar *wim_path;
917 struct wim_dentry *tree;
919 flags = delete_cmd->delete_.delete_flags;
920 wim_path = delete_cmd->delete_.wim_path;
922 DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags);
924 tree = get_dentry(wim, wim_path, WIMLIB_CASE_PLATFORM_DEFAULT);
926 /* Path to delete does not exist in the WIM. */
927 if (flags & WIMLIB_DELETE_FLAG_FORCE) {
930 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
931 wim_path, wim->current_image);
932 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
936 if (dentry_is_directory(tree) && !(flags & WIMLIB_DELETE_FLAG_RECURSIVE)) {
937 ERROR("Path \"%"TS"\" in WIM image %d is a directory "
938 "but a recursive delete was not requested",
939 wim_path, wim->current_image);
940 return WIMLIB_ERR_IS_DIRECTORY;
943 return journaled_unlink(j, tree);
947 free_dentry_full_path(struct wim_dentry *dentry, void *_ignore)
949 FREE(dentry->_full_path);
950 dentry->_full_path = NULL;
954 /* Is @d1 a (possibly nonproper) ancestor of @d2? */
956 is_ancestor(struct wim_dentry *d1, struct wim_dentry *d2)
961 if (dentry_is_root(d2))
967 /* Rename a file or directory in the WIM.
969 * This returns a -errno value.
971 * The journal @j is optional.
974 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
975 CASE_SENSITIVITY_TYPE case_type,
976 struct update_command_journal *j)
978 struct wim_dentry *src;
979 struct wim_dentry *dst;
980 struct wim_dentry *parent_of_dst;
983 /* This rename() implementation currently only supports actual files
984 * (not alternate data streams) */
986 src = get_dentry(wim, from, case_type);
990 dst = get_dentry(wim, to, case_type);
993 /* Destination file exists */
995 if (src == dst) /* Same file */
998 if (!dentry_is_directory(src)) {
999 /* Cannot rename non-directory to directory. */
1000 if (dentry_is_directory(dst))
1003 /* Cannot rename directory to a non-directory or a non-empty
1005 if (!dentry_is_directory(dst))
1007 if (dentry_has_children(dst))
1010 parent_of_dst = dst->parent;
1012 /* Destination does not exist */
1013 parent_of_dst = get_parent_dentry(wim, to, case_type);
1017 if (!dentry_is_directory(parent_of_dst))
1021 /* @src can't be an ancestor of @dst. Otherwise we're unlinking @src
1022 * from the tree and creating a loop... */
1023 if (is_ancestor(src, parent_of_dst))
1028 if (journaled_unlink(j, dst))
1030 if (journaled_unlink(j, src))
1032 if (journaled_change_name(j, src, path_basename(to)))
1034 if (journaled_link(j, src, parent_of_dst))
1037 ret = dentry_set_name(src, path_basename(to));
1042 free_dentry_tree(dst, wim->lookup_table);
1045 dentry_add_child(parent_of_dst, src);
1047 if (src->_full_path)
1048 for_dentry_in_tree(src, free_dentry_full_path, NULL);
1054 execute_rename_command(struct update_command_journal *j,
1056 const struct wimlib_update_command *rename_cmd)
1060 ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
1061 rename_cmd->rename.wim_target_path,
1062 WIMLIB_CASE_PLATFORM_DEFAULT, j);
1066 ERROR_WITH_ERRNO("Can't rename \"%"TS"\" to \"%"TS"\"",
1067 rename_cmd->rename.wim_source_path,
1068 rename_cmd->rename.wim_target_path);
1071 ret = WIMLIB_ERR_NOMEM;
1074 ret = WIMLIB_ERR_NOTDIR;
1078 /* XXX: EBUSY is returned when the rename would create a
1079 * loop. It maybe should have its own error code. */
1080 ret = WIMLIB_ERR_NOTEMPTY;
1083 ret = WIMLIB_ERR_IS_DIRECTORY;
1087 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
1094 static inline const tchar *
1095 update_op_to_str(int op)
1098 case WIMLIB_UPDATE_OP_ADD:
1100 case WIMLIB_UPDATE_OP_DELETE:
1102 case WIMLIB_UPDATE_OP_RENAME:
1111 have_command_type(const struct wimlib_update_command *cmds, size_t num_cmds,
1112 enum wimlib_update_op op)
1114 for (size_t i = 0; i < num_cmds; i++)
1115 if (cmds[i].op == op)
1121 execute_update_commands(WIMStruct *wim,
1122 const struct wimlib_update_command *cmds,
1125 wimlib_progress_func_t progress_func)
1127 struct wim_inode_table *inode_table;
1128 struct wim_sd_set *sd_set;
1129 struct list_head unhashed_streams;
1130 struct update_command_journal *j;
1131 union wimlib_progress_info info;
1134 if (have_command_type(cmds, num_cmds, WIMLIB_UPDATE_OP_ADD)) {
1135 /* If we have at least one "add" command, create the inode and
1136 * security descriptor tables to index new inodes and new
1137 * security descriptors, respectively. */
1138 inode_table = alloca(sizeof(struct wim_inode_table));
1139 sd_set = alloca(sizeof(struct wim_sd_set));
1141 ret = init_inode_table(inode_table, 9001);
1145 ret = init_sd_set(sd_set, wim_security_data(wim));
1147 goto out_destroy_inode_table;
1149 INIT_LIST_HEAD(&unhashed_streams);
1155 /* Start an in-memory journal to allow rollback if something goes wrong
1157 j = new_update_command_journal(num_cmds,
1158 &wim_get_current_image_metadata(wim)->root_dentry,
1161 ret = WIMLIB_ERR_NOMEM;
1162 goto out_destroy_sd_set;
1165 info.update.completed_commands = 0;
1166 info.update.total_commands = num_cmds;
1168 for (size_t i = 0; i < num_cmds; i++) {
1169 DEBUG("Executing update command %zu of %zu (op=%"TS")",
1170 i + 1, num_cmds, update_op_to_str(cmds[i].op));
1171 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
1174 info.update.command = &cmds[i];
1175 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
1178 ret = WIMLIB_ERR_INVALID_PARAM;
1179 switch (cmds[i].op) {
1180 case WIMLIB_UPDATE_OP_ADD:
1181 ret = execute_add_command(j, wim, &cmds[i], inode_table,
1182 sd_set, &unhashed_streams,
1185 case WIMLIB_UPDATE_OP_DELETE:
1186 ret = execute_delete_command(j, wim, &cmds[i]);
1188 case WIMLIB_UPDATE_OP_RENAME:
1189 ret = execute_rename_command(j, wim, &cmds[i]);
1194 info.update.completed_commands++;
1195 if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
1198 (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
1206 struct wim_image_metadata *imd;
1208 imd = wim_get_current_image_metadata(wim);
1210 list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
1211 inode_table_prepare_inode_list(inode_table, &imd->inode_list);
1213 goto out_destroy_sd_set;
1217 rollback_new_security_descriptors(sd_set);
1221 destroy_sd_set(sd_set);
1222 out_destroy_inode_table:
1224 destroy_inode_table(inode_table);
1231 check_add_command(struct wimlib_update_command *cmd,
1232 const struct wim_header *hdr)
1234 int add_flags = cmd->add.add_flags;
1236 if (add_flags & ~(WIMLIB_ADD_FLAG_NTFS |
1237 WIMLIB_ADD_FLAG_DEREFERENCE |
1238 WIMLIB_ADD_FLAG_VERBOSE |
1239 /* BOOT doesn't make sense for wimlib_update_image(). */
1240 /*WIMLIB_ADD_FLAG_BOOT |*/
1241 WIMLIB_ADD_FLAG_UNIX_DATA |
1242 WIMLIB_ADD_FLAG_NO_ACLS |
1243 WIMLIB_ADD_FLAG_STRICT_ACLS |
1244 WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
1245 WIMLIB_ADD_FLAG_RPFIX |
1246 WIMLIB_ADD_FLAG_NORPFIX |
1247 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE |
1248 WIMLIB_ADD_FLAG_WINCONFIG |
1249 WIMLIB_ADD_FLAG_WIMBOOT |
1250 WIMLIB_ADD_FLAG_NO_REPLACE))
1251 return WIMLIB_ERR_INVALID_PARAM;
1253 bool is_entire_image = WIMLIB_IS_WIM_ROOT_PATH(cmd->add.wim_target_path);
1255 #ifndef WITH_NTFS_3G
1256 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
1257 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
1258 " we cannot capture a WIM image directly "
1259 "from an NTFS volume");
1260 return WIMLIB_ERR_UNSUPPORTED;
1265 /* Check for flags not supported on Windows */
1266 if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
1267 ERROR("Capturing UNIX-specific data is not supported on Windows");
1268 return WIMLIB_ERR_UNSUPPORTED;
1270 if (add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) {
1271 ERROR("Dereferencing symbolic links is not supported on Windows");
1272 return WIMLIB_ERR_UNSUPPORTED;
1276 /* VERBOSE implies EXCLUDE_VERBOSE */
1277 if (add_flags & WIMLIB_ADD_FLAG_VERBOSE)
1278 add_flags |= WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
1280 /* Check for contradictory reparse point fixup flags */
1281 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
1282 WIMLIB_ADD_FLAG_NORPFIX)) ==
1283 (WIMLIB_ADD_FLAG_RPFIX |
1284 WIMLIB_ADD_FLAG_NORPFIX))
1286 ERROR("Cannot specify RPFIX and NORPFIX flags "
1287 "at the same time!");
1288 return WIMLIB_ERR_INVALID_PARAM;
1291 /* Set default behavior on reparse point fixups if requested */
1292 if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
1293 WIMLIB_ADD_FLAG_NORPFIX)) == 0)
1295 /* Do reparse-point fixups by default if we are capturing an
1296 * entire image and either the header flag is set from previous
1297 * images, or if this is the first image being added. */
1298 if (is_entire_image &&
1299 ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
1300 add_flags |= WIMLIB_ADD_FLAG_RPFIX;
1303 if (!is_entire_image) {
1304 if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
1305 ERROR("Cannot add directly from a NTFS volume "
1306 "when not capturing a full image!");
1307 return WIMLIB_ERR_INVALID_PARAM;
1310 if (add_flags & WIMLIB_ADD_FLAG_RPFIX) {
1311 ERROR("Cannot do reparse point fixups when "
1312 "not capturing a full image!");
1313 return WIMLIB_ERR_INVALID_PARAM;
1316 /* We may have modified the add flags. */
1317 cmd->add.add_flags = add_flags;
1322 check_delete_command(const struct wimlib_update_command *cmd)
1324 if (cmd->delete_.delete_flags & ~(WIMLIB_DELETE_FLAG_FORCE |
1325 WIMLIB_DELETE_FLAG_RECURSIVE))
1326 return WIMLIB_ERR_INVALID_PARAM;
1331 check_rename_command(const struct wimlib_update_command *cmd)
1333 if (cmd->rename.rename_flags != 0)
1334 return WIMLIB_ERR_INVALID_PARAM;
1339 check_update_command(struct wimlib_update_command *cmd,
1340 const struct wim_header *hdr)
1343 case WIMLIB_UPDATE_OP_ADD:
1344 return check_add_command(cmd, hdr);
1345 case WIMLIB_UPDATE_OP_DELETE:
1346 return check_delete_command(cmd);
1347 case WIMLIB_UPDATE_OP_RENAME:
1348 return check_rename_command(cmd);
1354 check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
1355 const struct wim_header *hdr)
1358 for (size_t i = 0; i < num_cmds; i++) {
1359 ret = check_update_command(&cmds[i], hdr);
1368 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
1371 for (size_t i = 0; i < num_cmds; i++) {
1372 switch (cmds[i].op) {
1373 case WIMLIB_UPDATE_OP_ADD:
1374 FREE(cmds[i].add.wim_target_path);
1376 case WIMLIB_UPDATE_OP_DELETE:
1377 FREE(cmds[i].delete_.wim_path);
1379 case WIMLIB_UPDATE_OP_RENAME:
1380 FREE(cmds[i].rename.wim_source_path);
1381 FREE(cmds[i].rename.wim_target_path);
1390 copy_update_commands(const struct wimlib_update_command *cmds,
1392 struct wimlib_update_command **cmds_copy_ret)
1395 struct wimlib_update_command *cmds_copy;
1397 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
1401 for (size_t i = 0; i < num_cmds; i++) {
1402 cmds_copy[i].op = cmds[i].op;
1403 switch (cmds[i].op) {
1404 case WIMLIB_UPDATE_OP_ADD:
1405 cmds_copy[i].add.fs_source_path = cmds[i].add.fs_source_path;
1406 cmds_copy[i].add.wim_target_path =
1407 canonicalize_wim_path(cmds[i].add.wim_target_path);
1408 if (!cmds_copy[i].add.wim_target_path)
1410 cmds_copy[i].add.config_file = cmds[i].add.config_file;
1411 cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
1413 case WIMLIB_UPDATE_OP_DELETE:
1414 cmds_copy[i].delete_.wim_path =
1415 canonicalize_wim_path(cmds[i].delete_.wim_path);
1416 if (!cmds_copy[i].delete_.wim_path)
1418 cmds_copy[i].delete_.delete_flags = cmds[i].delete_.delete_flags;
1420 case WIMLIB_UPDATE_OP_RENAME:
1421 cmds_copy[i].rename.wim_source_path =
1422 canonicalize_wim_path(cmds[i].rename.wim_source_path);
1423 cmds_copy[i].rename.wim_target_path =
1424 canonicalize_wim_path(cmds[i].rename.wim_target_path);
1425 if (!cmds_copy[i].rename.wim_source_path ||
1426 !cmds_copy[i].rename.wim_target_path)
1430 ERROR("Unknown update operation %u", cmds[i].op);
1431 ret = WIMLIB_ERR_INVALID_PARAM;
1435 *cmds_copy_ret = cmds_copy;
1440 ret = WIMLIB_ERR_NOMEM;
1442 free_update_commands(cmds_copy, num_cmds);
1446 /* API function documented in wimlib.h */
1448 wimlib_update_image(WIMStruct *wim,
1450 const struct wimlib_update_command *cmds,
1453 wimlib_progress_func_t progress_func)
1456 struct wimlib_update_command *cmds_copy;
1458 if (update_flags & ~WIMLIB_UPDATE_FLAG_SEND_PROGRESS)
1459 return WIMLIB_ERR_INVALID_PARAM;
1461 DEBUG("Updating image %d with %zu commands", image, num_cmds);
1463 if (have_command_type(cmds, num_cmds, WIMLIB_UPDATE_OP_DELETE))
1464 ret = can_delete_from_wim(wim);
1466 ret = can_modify_wim(wim);
1471 /* Load the metadata for the image to modify (if not loaded already) */
1472 ret = select_wim_image(wim, image);
1476 DEBUG("Preparing %zu update commands", num_cmds);
1478 /* Make a copy of the update commands, in the process doing certain
1479 * canonicalizations on paths (e.g. translating backslashes to forward
1480 * slashes). This is done to avoid modifying the caller's copy of the
1482 ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
1486 /* Perform additional checks on the update commands before we execute
1488 ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
1490 goto out_free_cmds_copy;
1492 /* Actually execute the update commands. */
1493 DEBUG("Executing %zu update commands", num_cmds);
1494 ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags,
1497 goto out_free_cmds_copy;
1499 wim->image_metadata[image - 1]->modified = 1;
1501 /* Statistics about the WIM image, such as the numbers of files and
1502 * directories, may have changed. Call xml_update_image_info() to
1503 * recalculate these statistics. */
1504 xml_update_image_info(wim, image);
1506 free_update_commands(cmds_copy, num_cmds);