]> wimlib.net Git - wimlib/blobdiff - src/update_image.c
ntfs-3g_capture.c: fix capture of empty named data stream
[wimlib] / src / update_image.c
index bb1b60472169e10755efd638e5455829c92df9da..b2eceecf760c72319b9fafcf916c531ed22e8101 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * update_image.c - Update a WIM image.
+ * update_image.c - see description below
  */
 
 /*
  * along with this file; if not, see http://www.gnu.org/licenses/.
  */
 
+/*
+ * This file contains the implementation of wimlib_update_image(), which is one
+ * of the two ways by which library users can make changes to a WIM image.  (The
+ * other way is by mounting an image read-write.)  wimlib_update_image() is also
+ * used in the implementation of wimlib_add_image(), since "create a WIM image
+ * from this directory tree" is equivalent to "create an empty WIM image, then
+ * update it to add this directory tree as the root".
+ *
+ * wimlib_update_image() processes a list of commands passed to it.  Currently,
+ * the following types of commands are supported:
+ *
+ * - Add a directory tree from an external source (filesystem or NTFS volume).
+ *   This can be used to add new files or to replace existing files.
+ * - Delete a file or directory tree.
+ * - Rename a file or directory tree.
+ *
+ * Not supported are creating links to existing files or changing metadata of
+ * existing files.
+ *
+ * wimlib_update_image() is atomic.  If it cannot complete successfully, then
+ * all changes are rolled back and the WIMStruct is left unchanged.  Rollback is
+ * implemented by breaking the commands into primitive operations such as "link
+ * this dentry tree here" which can be undone by doing the opposite operations
+ * in reverse order.
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
 
+#include <errno.h>
+#include <string.h>
+#include <sys/stat.h>
+
+#include "wimlib/alloca.h"
+#include "wimlib/assert.h"
+#include "wimlib/blob_table.h"
 #include "wimlib/capture.h"
 #include "wimlib/dentry.h"
 #include "wimlib/encoding.h"
 #include "wimlib/endianness.h"
 #include "wimlib/error.h"
-#include "wimlib/lookup_table.h"
 #include "wimlib/metadata.h"
 #ifdef WITH_NTFS_3G
 #  include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
 #include "wimlib/progress.h"
 #include "wimlib/xml.h"
 
-#include <errno.h>
-#include <sys/stat.h>
-#include <stdlib.h>
-
-#ifdef HAVE_ALLOCA_H
-#  include <alloca.h>
-#endif
-
 /* Saved specification of a "primitive" update operation that was performed.  */
 struct update_primitive {
        enum {
@@ -110,8 +134,8 @@ struct update_command_journal {
        /* Location of the WIM image's root pointer.  */
        struct wim_dentry **root_p;
 
-       /* Pointer to the lookup table of the WIM (may needed for rollback)  */
-       struct wim_lookup_table *lookup_table;
+       /* Pointer to the blob table of the WIM (may needed for rollback)  */
+       struct blob_table *blob_table;
 
        /* List of dentries that are currently unlinked from the WIM image.
         * These must be freed when no longer needed for commit or rollback.  */
@@ -133,7 +157,7 @@ init_update_primitive_list(struct update_primitive_list *l)
  * commands.  */
 static struct update_command_journal *
 new_update_command_journal(size_t num_cmds, struct wim_dentry **root_p,
-                          struct wim_lookup_table *lookup_table)
+                          struct blob_table *blob_table)
 {
        struct update_command_journal *j;
 
@@ -142,7 +166,7 @@ new_update_command_journal(size_t num_cmds, struct wim_dentry **root_p,
                j->num_cmds = num_cmds;
                j->cur_cmd = 0;
                j->root_p = root_p;
-               j->lookup_table = lookup_table;
+               j->blob_table = blob_table;
                INIT_LIST_HEAD(&j->orphans);
                for (size_t i = 0; i < num_cmds; i++)
                        init_update_primitive_list(&j->cmd_prims[i]);
@@ -162,7 +186,7 @@ free_update_command_journal(struct update_command_journal *j)
                orphan = list_first_entry(&j->orphans,
                                          struct wim_dentry, tmp_list);
                list_del(&orphan->tmp_list);
-               free_dentry_tree(orphan, j->lookup_table);
+               free_dentry_tree(orphan, j->blob_table);
        }
 
        for (size_t i = 0; i < j->num_cmds; i++)
@@ -271,7 +295,7 @@ rollback_name_change(utf16lechar *old_name,
        FREE(*name_ptr);
        if (old_name) {
                *name_ptr = old_name;
-               *name_nbytes_ptr = utf16le_strlen(old_name);
+               *name_nbytes_ptr = utf16le_len_bytes(old_name);
        } else {
                *name_ptr = NULL;
                *name_nbytes_ptr = 0;
@@ -508,7 +532,7 @@ handle_conflict(struct wim_dentry *branch, struct wim_dentry *existing,
                                return ret;
                        }
                }
-               free_dentry(branch);
+               free_dentry_tree(branch, j->blob_table);
                return 0;
        } else if (add_flags & WIMLIB_ADD_FLAG_NO_REPLACE) {
                /* Can't replace nondirectory file  */
@@ -681,7 +705,7 @@ attach_branch(struct wim_dentry *branch, const tchar *target_tstr,
 out_free_target:
        tstr_put_utf16le(target);
 out_free_branch:
-       free_dentry_tree(branch, j->lookup_table);
+       free_dentry_tree(branch, j->blob_table);
 out:
        return ret;
 }
@@ -758,7 +782,7 @@ execute_add_command(struct update_command_journal *j,
                    const struct wimlib_update_command *add_cmd,
                    struct wim_inode_table *inode_table,
                    struct wim_sd_set *sd_set,
-                   struct list_head *unhashed_streams)
+                   struct list_head *unhashed_blobs)
 {
        int ret;
        int add_flags;
@@ -801,8 +825,8 @@ execute_add_command(struct update_command_journal *j,
        if (ret)
                goto out;
 
-       params.lookup_table = wim->lookup_table;
-       params.unhashed_streams = unhashed_streams;
+       params.blob_table = wim->blob_table;
+       params.unhashed_blobs = unhashed_blobs;
        params.inode_table = inode_table;
        params.sd_set = sd_set;
        params.config = &config;
@@ -827,7 +851,7 @@ execute_add_command(struct update_command_journal *j,
        ret = call_progress(params.progfunc, WIMLIB_PROGRESS_MSG_SCAN_END,
                            &params.progress, params.progctx);
        if (ret) {
-               free_dentry_tree(branch, wim->lookup_table);
+               free_dentry_tree(branch, wim->blob_table);
                goto out_cleanup_after_capture;
        }
 
@@ -836,7 +860,7 @@ execute_add_command(struct update_command_journal *j,
        {
                ERROR("\"%"TS"\" is not a directory!", fs_source_path);
                ret = WIMLIB_ERR_NOTDIR;
-               free_dentry_tree(branch, wim->lookup_table);
+               free_dentry_tree(branch, wim->blob_table);
                goto out_cleanup_after_capture;
        }
 
@@ -1012,7 +1036,7 @@ rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
                        return -ENOMEM;
                if (dst) {
                        unlink_dentry(dst);
-                       free_dentry_tree(dst, wim->lookup_table);
+                       free_dentry_tree(dst, wim->blob_table);
                }
                unlink_dentry(src);
                dentry_add_child(parent_of_dst, src);
@@ -1098,7 +1122,7 @@ execute_update_commands(WIMStruct *wim,
 {
        struct wim_inode_table *inode_table;
        struct wim_sd_set *sd_set;
-       struct list_head unhashed_streams;
+       struct list_head unhashed_blobs;
        struct update_command_journal *j;
        union wimlib_progress_info info;
        int ret;
@@ -1118,7 +1142,7 @@ execute_update_commands(WIMStruct *wim,
                if (ret)
                        goto out_destroy_inode_table;
 
-               INIT_LIST_HEAD(&unhashed_streams);
+               INIT_LIST_HEAD(&unhashed_blobs);
        } else {
                inode_table = NULL;
                sd_set = NULL;
@@ -1128,7 +1152,7 @@ execute_update_commands(WIMStruct *wim,
         */
        j = new_update_command_journal(num_cmds,
                                       &wim_get_current_image_metadata(wim)->root_dentry,
-                                      wim->lookup_table);
+                                      wim->blob_table);
        if (!j) {
                ret = WIMLIB_ERR_NOMEM;
                goto out_destroy_sd_set;
@@ -1152,7 +1176,7 @@ execute_update_commands(WIMStruct *wim,
                switch (cmds[i].op) {
                case WIMLIB_UPDATE_OP_ADD:
                        ret = execute_add_command(j, wim, &cmds[i], inode_table,
-                                                 sd_set, &unhashed_streams);
+                                                 sd_set, &unhashed_blobs);
                        break;
                case WIMLIB_UPDATE_OP_DELETE:
                        ret = execute_delete_command(j, wim, &cmds[i]);
@@ -1180,7 +1204,7 @@ execute_update_commands(WIMStruct *wim,
 
                imd = wim_get_current_image_metadata(wim);
 
-               list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
+               list_splice_tail(&unhashed_blobs, &imd->unhashed_blobs);
                inode_table_prepare_inode_list(inode_table, &imd->inode_list);
        }
        goto out_destroy_sd_set;