]> wimlib.net Git - wimlib/blobdiff - src/export_image.c
wimlib_export_image(): improve duplicate image detection
[wimlib] / src / export_image.c
index f901ff1973a74038878ff2c3560e8f25efbcfcb6..da638322ee06c32d19217986653be498eea4e63d 100644 (file)
@@ -3,22 +3,20 @@
  */
 
 /*
- * Copyright (C) 2012, 2013 Eric Biggers
+ * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
  *
- * This file is part of wimlib, a library for working with WIM files.
+ * This file is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option) any
+ * later version.
  *
- * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 3 of the License, or (at your option)
- * any later version.
- *
- * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * This file is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  * details.
  *
- * You should have received a copy of the GNU General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this file; if not, see http://www.gnu.org/licenses/.
  */
 
 #ifdef HAVE_CONFIG_H
 #endif
 
 #include "wimlib.h"
-#include "wimlib/dentry.h"
+#include "wimlib/blob_table.h"
 #include "wimlib/error.h"
 #include "wimlib/inode.h"
-#include "wimlib/lookup_table.h"
 #include "wimlib/metadata.h"
 #include "wimlib/xml.h"
-#include <stdlib.h>
 
 static int
-inode_export_streams(struct wim_inode *inode,
-                    const struct wim_lookup_table *src_lookup_table,
-                    struct wim_lookup_table *dest_lookup_table)
+blob_set_not_exported(struct blob_descriptor *blob, void *_ignore)
+{
+       blob->out_refcnt = 0;
+       blob->was_exported = 0;
+       return 0;
+}
+
+static int
+blob_rollback_export(struct blob_descriptor *blob, void *_blob_table)
+{
+       struct blob_table *blob_table = _blob_table;
+
+       blob->refcnt -= blob->out_refcnt;
+       if (blob->was_exported) {
+               blob_table_unlink(blob_table, blob);
+               free_blob_descriptor(blob);
+       }
+       return 0;
+}
+
+static int
+inode_export_blobs(struct wim_inode *inode, struct blob_table *src_blob_table,
+                  struct blob_table *dest_blob_table, bool gift)
 {
        unsigned i;
        const u8 *hash;
-       struct wim_lookup_table_entry *src_lte, *dest_lte;
+       struct blob_descriptor *src_blob, *dest_blob;
 
-       inode_unresolve_streams(inode);
-       for (i = 0; i <= inode->i_num_ads; i++) {
+       for (i = 0; i < inode->i_num_streams; i++) {
 
-               /* Retrieve SHA1 message digest of stream to export.  */
-               hash = inode_stream_hash(inode, i);
+               /* Retrieve SHA-1 message digest of blob to export.  */
+               hash = stream_hash(&inode->i_streams[i]);
                if (is_zero_hash(hash))  /* Empty stream?  */
                        continue;
 
-               /* Search for the stream (via SHA1 message digest) in the
+               /* Search for the blob (via SHA-1 message digest) in the
                 * destination WIM.  */
-               dest_lte = lookup_stream(dest_lookup_table, hash);
-               if (!dest_lte) {
-                       /* Stream not yet present in destination WIM.  Search
-                        * for it in the source WIM, then export it into the
+               dest_blob = lookup_blob(dest_blob_table, hash);
+               if (!dest_blob) {
+                       /* Blob not yet present in destination WIM.  Search for
+                        * it in the source WIM, then export it into the
                         * destination WIM.  */
-                       src_lte = lookup_stream(src_lookup_table, hash);
-                       if (!src_lte)
-                               return stream_not_found_error(inode, hash);
-
-                       dest_lte = clone_lookup_table_entry(src_lte);
-                       if (!dest_lte)
-                               return WIMLIB_ERR_NOMEM;
-                       dest_lte->refcnt = 0;
-                       dest_lte->out_refcnt = 0;
-                       lookup_table_insert(dest_lookup_table, dest_lte);
+                       src_blob = stream_blob(&inode->i_streams[i],
+                                              src_blob_table);
+                       if (!src_blob)
+                               return blob_not_found_error(inode, hash);
+
+                       if (gift) {
+                               dest_blob = src_blob;
+                               blob_table_unlink(src_blob_table, src_blob);
+                       } else {
+                               dest_blob = clone_blob_descriptor(src_blob);
+                               if (!dest_blob)
+                                       return WIMLIB_ERR_NOMEM;
+                       }
+                       dest_blob->refcnt = 0;
+                       dest_blob->out_refcnt = 0;
+                       dest_blob->was_exported = 1;
+                       blob_table_insert(dest_blob_table, dest_blob);
                }
 
-               /* Stream is present in destination WIM (either pre-existing,
+               /* Blob is present in destination WIM (either pre-existing,
                 * already exported, or just exported above).  Increment its
                 * reference count appropriately.   Note: we use 'refcnt' for
                 * the raw reference count, but 'out_refcnt' for references
                 * arising just from the export operation; this is used to roll
                 * back a failed export if needed.  */
-               dest_lte->refcnt += inode->i_nlink;
-               dest_lte->out_refcnt += inode->i_nlink;
-       }
-       return 0;
-}
-
-static int
-lte_unexport(struct wim_lookup_table_entry *lte, void *_lookup_table)
-{
-       struct wim_lookup_table *lookup_table = _lookup_table;
-
-       lte->refcnt -= lte->out_refcnt;
-       if (lte->refcnt == 0) {
-               lookup_table_unlink(lookup_table, lte);
-               free_lookup_table_entry(lte);
+               dest_blob->refcnt += inode->i_nlink;
+               dest_blob->out_refcnt += inode->i_nlink;
        }
        return 0;
 }
@@ -102,103 +111,98 @@ wimlib_export_image(WIMStruct *src_wim,
                    WIMStruct *dest_wim,
                    const tchar *dest_name,
                    const tchar *dest_description,
-                   int export_flags,
-                   wimlib_progress_func_t progress_func)
+                   int export_flags)
 {
        int ret;
-       int start_image;
-       int end_image;
+       int start_src_image;
+       int end_src_image;
+       int orig_dest_image_count;
        int image;
-       u32 orig_dest_boot_idx;
-       u32 orig_dest_image_count;
+       bool all_images = (src_image == WIMLIB_ALL_IMAGES);
 
        /* Check for sane parameters.  */
        if (export_flags & ~(WIMLIB_EXPORT_FLAG_BOOT |
                             WIMLIB_EXPORT_FLAG_NO_NAMES |
-                            WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS))
+                            WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS |
+                            WIMLIB_EXPORT_FLAG_GIFT |
+                            WIMLIB_EXPORT_FLAG_WIMBOOT))
                return WIMLIB_ERR_INVALID_PARAM;
 
-       if (src_wim == NULL || dest_wim == NULL)
+       if (!src_wim || !dest_wim)
                return WIMLIB_ERR_INVALID_PARAM;
 
-       if (!wim_has_metadata(dest_wim))
+       if (!wim_has_metadata(src_wim) || !wim_has_metadata(dest_wim))
                return WIMLIB_ERR_METADATA_NOT_FOUND;
 
-       /* Destination WIM must be writable.  */
-       ret = can_modify_wim(dest_wim);
-       if (ret)
-               return ret;
-
-       if (src_image == WIMLIB_ALL_IMAGES) {
+       if (all_images) {
                /* Multi-image export.  */
                if ((!(export_flags & WIMLIB_EXPORT_FLAG_NO_NAMES) &&
                        dest_name) ||
                    (!(export_flags & WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS) &&
                        dest_description))
                {
-                       ERROR("Image name or image description was "
-                             "specified, but we are exporting "
-                             "multiple images");
+                       ERROR("Image name and description must be "
+                             "left NULL for multi-image export");
                        return WIMLIB_ERR_INVALID_PARAM;
                }
-               start_image = 1;
-               end_image = src_wim->hdr.image_count;
+               start_src_image = 1;
+               end_src_image = src_wim->hdr.image_count;
        } else {
-               start_image = src_image;
-               end_image = src_image;
+               start_src_image = src_image;
+               end_src_image = src_image;
        }
+       orig_dest_image_count = dest_wim->hdr.image_count;
 
-       /* Stream checksums must be known before proceeding.  */
-       ret = wim_checksum_unhashed_streams(src_wim);
+       /* We don't yet support having a single WIMStruct contain duplicate
+        * 'image_metadata' structures, so we must forbid this from happening.
+        * A duplication is possible if 'src_wim == dest_wim', if the same image
+        * is exported to the same destination WIMStruct multiple times, or if
+        * an image is exported in an A => B => A manner.  */
+       for (src_image = start_src_image;
+            src_image <= end_src_image; src_image++)
+       {
+               const struct wim_image_metadata *src_imd =
+                               src_wim->image_metadata[src_image - 1];
+               for (int i = 0; i < dest_wim->hdr.image_count; i++)
+                       if (dest_wim->image_metadata[i] == src_imd)
+                               return WIMLIB_ERR_DUPLICATE_EXPORTED_IMAGE;
+       }
+
+       /* Blob checksums must be known before proceeding.  */
+       ret = wim_checksum_unhashed_blobs(src_wim);
        if (ret)
                return ret;
-       ret = wim_checksum_unhashed_streams(dest_wim);
+       ret = wim_checksum_unhashed_blobs(dest_wim);
        if (ret)
                return ret;
 
-       /* Zero 'out_refcnt' in all lookup table entries in the destination WIM;
-        * this tracks the number of references found from the source WIM
-        * image(s).  */
-       for_lookup_table_entry(dest_wim->lookup_table, lte_zero_out_refcnt,
-                              NULL);
-
-       /* Save the original count of images in the destination WIM and the boot
-        * index (used if rollback necessary).  */
-       orig_dest_image_count = dest_wim->hdr.image_count;
-       orig_dest_boot_idx = dest_wim->hdr.boot_idx;
+       /* Enable rollbacks  */
+       for_blob_in_table(dest_wim->blob_table, blob_set_not_exported, NULL);
 
        /* Export each requested image.  */
-       for (image = start_image; image <= end_image; image++) {
+       for (src_image = start_src_image;
+            src_image <= end_src_image;
+            src_image++)
+       {
                const tchar *next_dest_name, *next_dest_description;
                struct wim_image_metadata *src_imd;
                struct wim_inode *inode;
 
-               DEBUG("Exporting image %d from \"%"TS"\"",
-                     image, src_wim->filename);
-
                /* Determine destination image name and description.  */
 
-               if (export_flags & WIMLIB_EXPORT_FLAG_NO_NAMES) {
+               if (export_flags & WIMLIB_EXPORT_FLAG_NO_NAMES)
                        next_dest_name = NULL;
-               } else if (dest_name) {
+               else if (dest_name)
                        next_dest_name = dest_name;
-               } else {
-                       next_dest_name = wimlib_get_image_name(src_wim,
-                                                              image);
-               }
-
-               DEBUG("Using name \"%"TS"\"", next_dest_name);
+               else
+                       next_dest_name = wimlib_get_image_name(src_wim, src_image);
 
-               if (export_flags & WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS) {
+               if (export_flags & WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS)
                        next_dest_description = NULL;
-               } if (dest_description) {
+               else if (dest_description)
                        next_dest_description = dest_description;
-               } else {
-                       next_dest_description = wimlib_get_image_description(
-                                                       src_wim, image);
-               }
-
-               DEBUG("Using description \"%"TS"\"", next_dest_description);
+               else
+                       next_dest_description = wimlib_get_image_description(src_wim, src_image);
 
                /* Check for name conflict.  */
                if (wimlib_image_name_in_use(dest_wim, next_dest_name)) {
@@ -209,26 +213,28 @@ wimlib_export_image(WIMStruct *src_wim,
                }
 
                /* Load metadata for source image into memory.  */
-               ret = select_wim_image(src_wim, image);
+               ret = select_wim_image(src_wim, src_image);
                if (ret)
                        goto out_rollback;
 
                src_imd = wim_get_current_image_metadata(src_wim);
 
                /* Iterate through inodes in the source image and export their
-                * streams into the destination WIM.  */
+                * blobs into the destination WIM.  */
                image_for_each_inode(inode, src_imd) {
-                       ret = inode_export_streams(inode,
-                                                  src_wim->lookup_table,
-                                                  dest_wim->lookup_table);
+                       ret = inode_export_blobs(inode,
+                                                src_wim->blob_table,
+                                                dest_wim->blob_table,
+                                                export_flags & WIMLIB_EXPORT_FLAG_GIFT);
                        if (ret)
                                goto out_rollback;
                }
 
                /* Export XML information into the destination WIM.  */
-               ret = xml_export_image(src_wim->wim_info, image,
-                                      &dest_wim->wim_info, next_dest_name,
-                                      next_dest_description);
+               ret = xml_export_image(src_wim->xml_info, src_image,
+                                      dest_wim->xml_info, next_dest_name,
+                                      next_dest_description,
+                                      export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT);
                if (ret)
                        goto out_rollback;
 
@@ -238,42 +244,40 @@ wimlib_export_image(WIMStruct *src_wim,
                if (ret)
                        goto out_rollback;
                src_imd->refcnt++;
+       }
 
-               /* Lock the metadata into memory.  XXX: need better solution for
-                * this.  */
-               src_imd->modified = 1;
-
-               /* Set boot index in destination WIM.  */
-               if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
-                   (src_image != WIMLIB_ALL_IMAGES ||
-                    image == src_wim->hdr.boot_idx))
-               {
-                       DEBUG("Marking destination image %u as bootable.",
-                             dest_wim->hdr.image_count);
-                       dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
-               }
+       /* Image export complete.  Finish by setting any needed special metadata
+        * on the destination WIM.  */
 
-       }
-       /* Set the reparse point fixup flag on the destination WIM if the flag
-        * is set on the source WIM. */
        if (src_wim->hdr.flags & WIM_HDR_FLAG_RP_FIX)
                dest_wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
-       DEBUG("Export operation successful.");
+
+       for (src_image = start_src_image;
+            src_image <= end_src_image;
+            src_image++)
+       {
+               int dst_image = orig_dest_image_count + 1 +
+                               (src_image - start_src_image);
+
+               if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
+                   (!all_images || src_image == src_wim->hdr.boot_idx))
+                       dest_wim->hdr.boot_idx = dst_image;
+       }
+
        return 0;
 
 out_rollback:
-       while ((image = wim_info_get_num_images(dest_wim->wim_info))
+       while ((image = xml_get_image_count(dest_wim->xml_info))
               > orig_dest_image_count)
        {
-               xml_delete_image(&dest_wim->wim_info, image);
+               xml_delete_image(dest_wim->xml_info, image);
        }
        while (dest_wim->hdr.image_count > orig_dest_image_count)
        {
                put_image_metadata(dest_wim->image_metadata[
                                        --dest_wim->hdr.image_count], NULL);
        }
-       for_lookup_table_entry(dest_wim->lookup_table, lte_unexport,
-                              dest_wim->lookup_table);
-       dest_wim->hdr.boot_idx = orig_dest_boot_idx;
+       for_blob_in_table(dest_wim->blob_table, blob_rollback_export,
+                         dest_wim->blob_table);
        return ret;
 }