Make WIMStructs reference-counted
[wimlib] / src / wim.c
index b15a02d..e01131d 100644 (file)
--- a/src/wim.c
+++ b/src/wim.c
 /*
- * wim.c - Stuff that doesn't fit into any other file
+ * wim.c - High-level code dealing with WIMStructs and images.
  */
 
 /*
- * 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
 #  include "config.h"
 #endif
 
-#include "wimlib/error.h"
+#include <errno.h>
+#include <fcntl.h>
+#ifndef __WIN32__
+#  include <langinfo.h>
+#endif
+#include <pthread.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+#include "wimlib.h"
+#include "wimlib/assert.h"
+#include "wimlib/blob_table.h"
 #include "wimlib/dentry.h"
 #include "wimlib/encoding.h"
 #include "wimlib/file_io.h"
 #include "wimlib/integrity.h"
-#include "wimlib/lookup_table.h"
 #include "wimlib/metadata.h"
-#ifdef WITH_NTFS_3G
-#  include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
-#endif
+#include "wimlib/ntfs_3g.h" /* for libntfs3g_global_init() */
 #include "wimlib/security.h"
 #include "wimlib/wim.h"
 #include "wimlib/xml.h"
+#include "wimlib/win32.h"
+
+/* Information about the available compression types for the WIM format.  */
+static const struct {
+       const tchar *name;
+       u32 min_chunk_size;
+       u32 max_chunk_size;
+       u32 default_nonsolid_chunk_size;
+       u32 default_solid_chunk_size;
+} wim_ctype_info[] = {
+       [WIMLIB_COMPRESSION_TYPE_NONE] = {
+               .name = T("None"),
+               .min_chunk_size = 0,
+               .max_chunk_size = 0,
+               .default_nonsolid_chunk_size = 0,
+               .default_solid_chunk_size = 0,
+       },
+       [WIMLIB_COMPRESSION_TYPE_XPRESS] = {
+               .name = T("XPRESS"),
+               .min_chunk_size = 4096,
+               .max_chunk_size = 65536,
+               .default_nonsolid_chunk_size = 32768,
+               .default_solid_chunk_size = 32768,
+       },
+       [WIMLIB_COMPRESSION_TYPE_LZX] = {
+               .name = T("LZX"),
+               .min_chunk_size = 32768,
+               .max_chunk_size = 2097152,
+               .default_nonsolid_chunk_size = 32768,
+               .default_solid_chunk_size = 32768,
+       },
+       [WIMLIB_COMPRESSION_TYPE_LZMS] = {
+               .name = T("LZMS"),
+               .min_chunk_size = 32768,
+               .max_chunk_size = 1073741824,
+               .default_nonsolid_chunk_size = 131072,
+               .default_solid_chunk_size = 67108864,
+       },
+};
+
+/* Is the specified compression type valid?  */
+static bool
+wim_compression_type_valid(enum wimlib_compression_type ctype)
+{
+       return (unsigned)ctype < ARRAY_LEN(wim_ctype_info) &&
+              wim_ctype_info[(unsigned)ctype].name != NULL;
+}
 
-#ifdef __WIN32__
-#  include "wimlib/win32.h" /* for realpath() replacement */
-#endif
+/* Is the specified chunk size valid for the compression type?  */
+static bool
+wim_chunk_size_valid(u32 chunk_size, enum wimlib_compression_type ctype)
+{
+       if (!(chunk_size == 0 || is_power_of_2(chunk_size)))
+               return false;
 
-#include <errno.h>
-#include <fcntl.h>
-#ifndef __WIN32__
-#  include <langinfo.h>
-#endif
-#include <limits.h>
-#include <stdarg.h>
-#include <stdlib.h>
-#include <unistd.h>
+       return chunk_size >= wim_ctype_info[(unsigned)ctype].min_chunk_size &&
+              chunk_size <= wim_ctype_info[(unsigned)ctype].max_chunk_size;
+}
 
-static int
-image_print_metadata(WIMStruct *w)
+/* Return the default chunk size to use for the specified compression type in
+ * non-solid resources.  */
+static u32
+wim_default_nonsolid_chunk_size(enum wimlib_compression_type ctype)
 {
-       DEBUG("Printing metadata for image %d", w->current_image);
-       print_wim_security_data(wim_security_data(w));
-       return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
-                                 w->lookup_table);
+       return wim_ctype_info[(unsigned)ctype].default_nonsolid_chunk_size;
 }
 
+/* Return the default chunk size to use for the specified compression type in
+ * solid resources.  */
+static u32
+wim_default_solid_chunk_size(enum wimlib_compression_type ctype)
+{
+       return wim_ctype_info[(unsigned)ctype].default_solid_chunk_size;
+}
+
+/* Return the default compression type to use in solid resources.  */
+static enum wimlib_compression_type
+wim_default_solid_compression_type(void)
+{
+       return WIMLIB_COMPRESSION_TYPE_LZMS;
+}
 
 static int
-image_print_files(WIMStruct *w)
+is_blob_in_solid_resource(struct blob_descriptor *blob, void *_ignore)
 {
-       return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
-                                 NULL);
+       return blob->blob_location == BLOB_IN_WIM &&
+               (blob->rdesc->flags & WIM_RESHDR_FLAG_SOLID);
+}
+
+bool
+wim_has_solid_resources(const WIMStruct *wim)
+{
+       return for_blob_in_table(wim->blob_table, is_blob_in_solid_resource, NULL);
 }
 
 static WIMStruct *
 new_wim_struct(void)
 {
-       WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
-       if (w) {
-               w->in_fd = -1;
-               w->out_fd = -1;
-       }
-       return w;
+       WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
+       if (!wim)
+               return NULL;
+
+       wim->refcnt = 1;
+       filedes_invalidate(&wim->in_fd);
+       filedes_invalidate(&wim->out_fd);
+       wim->out_solid_compression_type = wim_default_solid_compression_type();
+       wim->out_solid_chunk_size = wim_default_solid_chunk_size(
+                                       wim->out_solid_compression_type);
+       return wim;
 }
 
-/*
- * Calls a function on images in the WIM.  If @image is WIMLIB_ALL_IMAGES, @visitor
- * is called on the WIM once for each image, with each image selected as the
- * current image in turn.  If @image is a certain image, @visitor is called on
- * the WIM only once, with that image selected.
- */
-int
-for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret)
 {
        int ret;
-       int start;
-       int end;
-       int i;
+       WIMStruct *wim;
 
-       if (image == WIMLIB_ALL_IMAGES) {
-               start = 1;
-               end = w->hdr.image_count;
-       } else if (image >= 1 && image <= w->hdr.image_count) {
-               start = image;
-               end = image;
-       } else {
-               return WIMLIB_ERR_INVALID_IMAGE;
-       }
-       for (i = start; i <= end; i++) {
-               ret = select_wim_image(w, i);
-               if (ret != 0)
-                       return ret;
-               ret = visitor(w);
-               if (ret != 0)
-                       return ret;
+       ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+       if (ret)
+               return ret;
+
+       if (!wim_ret)
+               return WIMLIB_ERR_INVALID_PARAM;
+
+       if (!wim_compression_type_valid(ctype))
+               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+
+       wim = new_wim_struct();
+       if (!wim)
+               return WIMLIB_ERR_NOMEM;
+
+       wim->xml_info = xml_new_info_struct();
+       wim->blob_table = new_blob_table(9001);
+       if (!wim->xml_info || !wim->blob_table) {
+               wimlib_free(wim);
+               return WIMLIB_ERR_NOMEM;
        }
+
+       /* Fill in wim->hdr with default values  */
+       wim->hdr.magic = WIM_MAGIC;
+       wim->hdr.wim_version = WIM_VERSION_DEFAULT;
+       wim->hdr.flags = 0;
+       wim->hdr.chunk_size = 0;
+       generate_guid(wim->hdr.guid);
+       wim->hdr.part_number = 1;
+       wim->hdr.total_parts = 1;
+       wim->hdr.image_count = 0;
+       wim->hdr.boot_idx = 0;
+
+       wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
+       wim->chunk_size = wim->hdr.chunk_size;
+
+       /* Set the output compression type  */
+       wim->out_compression_type = ctype;
+       wim->out_chunk_size = wim_default_nonsolid_chunk_size(ctype);
+
+       *wim_ret = wim;
        return 0;
 }
 
-/*
- * Creates a WIMStruct for a new WIM file.
- */
-WIMLIBAPI int
-wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
+static void
+destroy_image_metadata(struct wim_image_metadata *imd,
+                      struct blob_table *table,
+                      bool free_metadata_blob_descriptor)
 {
-       WIMStruct *w;
-       struct wim_lookup_table *table;
-       int ret;
+       free_dentry_tree(imd->root_dentry, table);
+       imd->root_dentry = NULL;
+       free_wim_security_data(imd->security_data);
+       imd->security_data = NULL;
 
-       wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+       if (free_metadata_blob_descriptor) {
+               free_blob_descriptor(imd->metadata_blob);
+               imd->metadata_blob = NULL;
+       }
+       if (!table) {
+               struct blob_descriptor *blob, *tmp;
+               list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
+                       free_blob_descriptor(blob);
+       }
+       INIT_LIST_HEAD(&imd->unhashed_blobs);
+       INIT_HLIST_HEAD(&imd->inode_list);
+}
 
-       DEBUG("Creating new WIM with %"TS" compression.",
-             wimlib_get_compression_type_string(ctype));
+void
+put_image_metadata(struct wim_image_metadata *imd, struct blob_table *table)
+{
+       if (imd && --imd->refcnt == 0) {
+               destroy_image_metadata(imd, table, true);
+               FREE(imd);
+       }
+}
+
+/* Appends the specified image metadata structure to the array of image metadata
+ * for a WIM, and increments the image count. */
+int
+append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
+{
+       struct wim_image_metadata **imd_array;
+
+       imd_array = REALLOC(wim->image_metadata,
+                           sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
 
-       /* Allocate the WIMStruct. */
-       w = new_wim_struct();
-       if (!w)
+       if (!imd_array)
                return WIMLIB_ERR_NOMEM;
+       wim->image_metadata = imd_array;
+       imd_array[wim->hdr.image_count++] = imd;
+       return 0;
+}
 
-       ret = init_header(&w->hdr, ctype);
-       if (ret != 0)
-               goto out_free;
+struct wim_image_metadata *
+new_image_metadata(void)
+{
+       struct wim_image_metadata *imd;
 
-       table = new_lookup_table(9001);
-       if (!table) {
-               ret = WIMLIB_ERR_NOMEM;
-               goto out_free;
+       imd = CALLOC(1, sizeof(*imd));
+       if (imd) {
+               imd->refcnt = 1;
+               INIT_HLIST_HEAD(&imd->inode_list);
+               INIT_LIST_HEAD(&imd->unhashed_blobs);
        }
-       w->lookup_table = table;
-       w->refcnts_ok = 1;
-       w->compression_type = ctype;
-       *w_ret = w;
-       return 0;
-out_free:
-       FREE(w);
-       return ret;
+       return imd;
 }
 
+static struct wim_image_metadata **
+new_image_metadata_array(unsigned num_images)
+{
+       struct wim_image_metadata **imd_array;
+
+       imd_array = CALLOC(num_images, sizeof(imd_array[0]));
+
+       if (!imd_array)
+               return NULL;
+       for (unsigned i = 0; i < num_images; i++) {
+               imd_array[i] = new_image_metadata();
+               if (unlikely(!imd_array[i])) {
+                       for (unsigned j = 0; j < i; j++)
+                               put_image_metadata(imd_array[j], NULL);
+                       FREE(imd_array);
+                       return NULL;
+               }
+       }
+       return imd_array;
+}
+
+
+/*
+ * Load the metadata for the specified WIM image into memory and set it
+ * as the WIMStruct's currently selected image.
+ *
+ * @wim
+ *     The WIMStruct for the WIM.
+ * @image
+ *     The 1-based index of the image in the WIM to select.
+ *
+ * On success, 0 will be returned, wim->current_image will be set to
+ * @image, and wim_get_current_image_metadata() can be used to retrieve
+ * metadata information for the image.
+ *
+ * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
+ * or another error code will be returned.
+ */
 int
-select_wim_image(WIMStruct *w, int image)
+select_wim_image(WIMStruct *wim, int image)
 {
        struct wim_image_metadata *imd;
        int ret;
 
-       DEBUG("Selecting image %d", image);
-
-       if (image == WIMLIB_NO_IMAGE) {
-               ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
+       if (image == WIMLIB_NO_IMAGE)
                return WIMLIB_ERR_INVALID_IMAGE;
-       }
 
-       if (image == w->current_image)
+       if (image == wim->current_image)
                return 0;
 
-       if (image < 1 || image > w->hdr.image_count) {
-               ERROR("Cannot select image %d: There are only %u images",
-                     image, w->hdr.image_count);
+       if (image < 1 || image > wim->hdr.image_count)
                return WIMLIB_ERR_INVALID_IMAGE;
-       }
 
-       /* If a valid image is currently selected, it can be freed if it is not
-        * modified.  */
-       if (w->current_image != WIMLIB_NO_IMAGE) {
-               imd = wim_get_current_image_metadata(w);
-               if (!imd->modified) {
-                       wimlib_assert(list_empty(&imd->unhashed_streams));
-                       DEBUG("Freeing image %u", w->current_image);
-                       destroy_image_metadata(imd, NULL, false);
-               }
-       }
-       w->current_image = image;
-       imd = wim_get_current_image_metadata(w);
-       if (imd->root_dentry || imd->modified) {
+       if (!wim_has_metadata(wim))
+               return WIMLIB_ERR_METADATA_NOT_FOUND;
+
+       /* If a valid image is currently selected, its metadata can be freed if
+        * it is not dirty and no other WIMStructs may have it selected.  */
+       deselect_current_wim_image(wim);
+       wim->current_image = image;
+       imd = wim_get_current_image_metadata(wim);
+       if (imd->root_dentry || is_image_dirty(imd)) {
                ret = 0;
        } else {
-               #ifdef ENABLE_DEBUG
-               DEBUG("Reading metadata resource specified by the following "
-                     "lookup table entry:");
-               print_lookup_table_entry(imd->metadata_lte, stderr);
-               #endif
-               ret = read_metadata_resource(w, imd);
+               ret = read_metadata_resource(imd);
                if (ret)
-                       w->current_image = WIMLIB_NO_IMAGE;
+                       wim->current_image = WIMLIB_NO_IMAGE;
        }
        return ret;
 }
 
-
-WIMLIBAPI const tchar *
-wimlib_get_compression_type_string(int ctype)
+void
+deselect_current_wim_image(WIMStruct *wim)
 {
-       switch (ctype) {
-               case WIMLIB_COMPRESSION_TYPE_NONE:
-                       return T("None");
-               case WIMLIB_COMPRESSION_TYPE_LZX:
-                       return T("LZX");
-               case WIMLIB_COMPRESSION_TYPE_XPRESS:
-                       return T("XPRESS");
-               default:
-                       return T("Invalid");
+       struct wim_image_metadata *imd;
+       if (wim->current_image == WIMLIB_NO_IMAGE)
+               return;
+       imd = wim_get_current_image_metadata(wim);
+       if (!is_image_dirty(imd) && imd->refcnt == 1) {
+               wimlib_assert(list_empty(&imd->unhashed_blobs));
+               destroy_image_metadata(imd, NULL, false);
        }
+       wim->current_image = WIMLIB_NO_IMAGE;
 }
 
 /*
- * Returns the number of an image in the WIM file, given a string that is either
- * the number of the image, or the name of the image.  The images are numbered
- * starting at 1.
+ * Calls a function on images in the WIM.  If @image is WIMLIB_ALL_IMAGES,
+ * @visitor is called on the WIM once for each image, with each image selected
+ * as the current image in turn.  If @image is a certain image, @visitor is
+ * called on the WIM only once, with that image selected.
  */
+int
+for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
+{
+       int ret;
+       int start;
+       int end;
+       int i;
+
+       if (image == WIMLIB_ALL_IMAGES) {
+               start = 1;
+               end = wim->hdr.image_count;
+       } else if (image >= 1 && image <= wim->hdr.image_count) {
+               start = image;
+               end = image;
+       } else {
+               return WIMLIB_ERR_INVALID_IMAGE;
+       }
+       for (i = start; i <= end; i++) {
+               ret = select_wim_image(wim, i);
+               if (ret != 0)
+                       return ret;
+               ret = visitor(wim);
+               if (ret != 0)
+                       return ret;
+       }
+       return 0;
+}
+
+/* API function documented in wimlib.h  */
 WIMLIBAPI int
-wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
+wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
 {
        tchar *p;
        long image;
@@ -239,54 +403,22 @@ wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
                return WIMLIB_ALL_IMAGES;
        image = tstrtol(image_name_or_num, &p, 10);
        if (p != image_name_or_num && *p == T('\0') && image > 0) {
-               if (image > w->hdr.image_count)
+               if (image > wim->hdr.image_count)
                        return WIMLIB_NO_IMAGE;
                return image;
        } else {
-               for (i = 1; i <= w->hdr.image_count; i++) {
+               for (i = 1; i <= wim->hdr.image_count; i++) {
                        if (!tstrcmp(image_name_or_num,
-                                    wimlib_get_image_name(w, i)))
+                                    wimlib_get_image_name(wim, i)))
                                return i;
                }
                return WIMLIB_NO_IMAGE;
        }
 }
 
-/* Prints some basic information about a WIM file. */
+/* API function documented in wimlib.h  */
 WIMLIBAPI void
-wimlib_print_wim_information(const WIMStruct *w)
-{
-       const struct wim_header *hdr;
-
-       hdr = &w->hdr;
-       tputs(T("WIM Information:"));
-       tputs(T("----------------"));
-       tprintf(T("Path:           %"TS"\n"), w->filename);
-       tfputs(T("GUID:           0x"), stdout);
-       print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
-       tputchar(T('\n'));
-       tprintf(T("Image Count:    %d\n"), hdr->image_count);
-       tprintf(T("Compression:    %"TS"\n"),
-               wimlib_get_compression_type_string(w->compression_type));
-       tprintf(T("Part Number:    %d/%d\n"), hdr->part_number, hdr->total_parts);
-       tprintf(T("Boot Index:     %d\n"), hdr->boot_idx);
-       tprintf(T("Size:           %"PRIu64" bytes\n"),
-               wim_info_get_total_bytes(w->wim_info));
-       tprintf(T("Integrity Info: %"TS"\n"),
-               (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
-       tprintf(T("Relative path junction: %"TS"\n"),
-               (hdr->flags & WIM_HDR_FLAG_RP_FIX) ? T("yes") : T("no"));
-       tputchar(T('\n'));
-}
-
-WIMLIBAPI bool
-wimlib_has_integrity_table(const WIMStruct *w)
-{
-       return w->hdr.integrity.size != 0;
-}
-
-WIMLIBAPI void
-wimlib_print_available_images(const WIMStruct *w, int image)
+wimlib_print_available_images(const WIMStruct *wim, int image)
 {
        int first;
        int last;
@@ -295,8 +427,8 @@ wimlib_print_available_images(const WIMStruct *w, int image)
        if (image == WIMLIB_ALL_IMAGES) {
                n = tprintf(T("Available Images:\n"));
                first = 1;
-               last = w->hdr.image_count;
-       } else if (image >= 1 && image <= w->hdr.image_count) {
+               last = wim->hdr.image_count;
+       } else if (image >= 1 && image <= wim->hdr.image_count) {
                n = tprintf(T("Information for Image %d\n"), image);
                first = image;
                last = image;
@@ -309,55 +441,26 @@ wimlib_print_available_images(const WIMStruct *w, int image)
                tputchar(T('-'));
        tputchar(T('\n'));
        for (i = first; i <= last; i++)
-               print_image_info(w->wim_info, i);
-}
-
-
-/* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
- * not WIMLIB_NO_IMAGE. */
-WIMLIBAPI int
-wimlib_print_metadata(WIMStruct *w, int image)
-{
-       if (w->hdr.part_number != 1) {
-               ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
-                      w->hdr.part_number, w->hdr.total_parts);
-               ERROR("Select the first part of the split WIM to see the metadata.");
-               return WIMLIB_ERR_SPLIT_UNSUPPORTED;
-       }
-       return for_image(w, image, image_print_metadata);
-}
-
-WIMLIBAPI int
-wimlib_print_files(WIMStruct *w, int image)
-{
-       if (w->hdr.part_number != 1) {
-               ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
-                      w->hdr.part_number, w->hdr.total_parts);
-               ERROR("Select the first part of the split WIM if you'd like to list the files.");
-               return WIMLIB_ERR_SPLIT_UNSUPPORTED;
-       }
-       return for_image(w, image, image_print_files);
+               xml_print_image_info(wim->xml_info, i);
 }
 
+/* API function documented in wimlib.h  */
 WIMLIBAPI int
 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
 {
        memset(info, 0, sizeof(struct wimlib_wim_info));
-       memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
+       copy_guid(info->guid, wim->hdr.guid);
        info->image_count = wim->hdr.image_count;
        info->boot_index = wim->hdr.boot_idx;
-       info->wim_version = WIM_VERSION;
-       info->chunk_size = WIM_CHUNK_SIZE;
+       info->wim_version = wim->hdr.wim_version;
+       info->chunk_size = wim->chunk_size;
        info->part_number = wim->hdr.part_number;
        info->total_parts = wim->hdr.total_parts;
        info->compression_type = wim->compression_type;
-       if (wim->wim_info)
-               info->total_bytes = wim->wim_info->total_bytes;
-       else
-               info->total_bytes = 0;
-       info->has_integrity_table = wim->hdr.integrity.offset != 0;
+       info->total_bytes = xml_get_total_bytes(wim->xml_info);
+       info->has_integrity_table = wim_has_integrity_table(wim);
        info->opened_from_file = (wim->filename != NULL);
-       info->is_readonly == (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
+       info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
                             (wim->hdr.total_parts != 1) ||
                             (wim->filename && taccess(wim->filename, W_OK));
        info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
@@ -366,56 +469,23 @@ wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
        info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
        info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
        info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
+       info->pipable = wim_is_pipable(wim);
        return 0;
 }
 
-
-/* Deprecated */
-WIMLIBAPI int
-wimlib_get_boot_idx(const WIMStruct *wim)
-{
-       struct wimlib_wim_info info;
-
-       wimlib_get_wim_info((WIMStruct*)wim, &info);
-       return info.boot_index;
-}
-
-/* Deprecated */
-WIMLIBAPI int
-wimlib_get_compression_type(const WIMStruct *wim)
-{
-       struct wimlib_wim_info info;
-
-       wimlib_get_wim_info((WIMStruct*)wim, &info);
-       return info.compression_type;
-}
-
-/* Deprecated */
-WIMLIBAPI int
-wimlib_get_num_images(const WIMStruct *wim)
-{
-       struct wimlib_wim_info info;
-
-       wimlib_get_wim_info((WIMStruct*)wim, &info);
-       return info.image_count;
-}
-
-/* Deprecated */
-WIMLIBAPI int
-wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret)
-{
-       struct wimlib_wim_info info;
-
-       wimlib_get_wim_info((WIMStruct*)wim, &info);
-       if (total_parts_ret)
-               *total_parts_ret = info.total_parts;
-       return info.part_number;
-}
-
+/* API function documented in wimlib.h  */
 WIMLIBAPI int
 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
 {
-       int ret;
+       if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
+                     WIMLIB_CHANGE_GUID |
+                     WIMLIB_CHANGE_BOOT_INDEX |
+                     WIMLIB_CHANGE_RPFIX_FLAG))
+               return WIMLIB_ERR_INVALID_PARAM;
+
+       if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
+           info->boot_index > wim->hdr.image_count)
+               return WIMLIB_ERR_INVALID_IMAGE;
 
        if (which & WIMLIB_CHANGE_READONLY_FLAG) {
                if (info->is_marked_readonly)
@@ -424,25 +494,11 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic
                        wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
        }
 
-       if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
-               return 0;
-
-       ret = can_modify_wim(wim);
-       if (ret)
-               return ret;
-
        if (which & WIMLIB_CHANGE_GUID)
-               memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
-
-       if (which & WIMLIB_CHANGE_BOOT_INDEX) {
-               if (info->boot_index < 0 || info->boot_index > wim->hdr.image_count)
-               {
-                       ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
-                             info->boot_index);
-                       return WIMLIB_ERR_INVALID_IMAGE;
-               }
+               copy_guid(wim->hdr.guid, info->guid);
+
+       if (which & WIMLIB_CHANGE_BOOT_INDEX)
                wim->hdr.boot_idx = info->boot_index;
-       }
 
        if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
                if (info->has_rpfix)
@@ -453,331 +509,327 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic
        return 0;
 }
 
-/* Deprecated */
+/* API function documented in wimlib.h  */
 WIMLIBAPI int
-wimlib_set_boot_idx(WIMStruct *wim, int boot_idx)
+wimlib_set_output_compression_type(WIMStruct *wim,
+                                  enum wimlib_compression_type ctype)
 {
-       struct wimlib_wim_info info;
+       if (!wim_compression_type_valid(ctype))
+               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+
+       wim->out_compression_type = ctype;
 
-       info.boot_index = boot_idx;
-       return wimlib_set_wim_info(wim, &info, WIMLIB_CHANGE_BOOT_INDEX);
+       /* Reset the chunk size if it's no longer valid.  */
+       if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
+               wim->out_chunk_size = wim_default_nonsolid_chunk_size(ctype);
+       return 0;
 }
 
-static int
-do_open_wim(const tchar *filename, int *fd_ret)
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_set_output_pack_compression_type(WIMStruct *wim,
+                                       enum wimlib_compression_type ctype)
 {
-       int fd;
+       if (!wim_compression_type_valid(ctype))
+               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
 
-       fd = topen(filename, O_RDONLY | O_BINARY);
-       if (fd == -1) {
-               ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
-               return WIMLIB_ERR_OPEN;
+       /* Solid resources can't be uncompressed.  */
+       if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
+               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+
+       wim->out_solid_compression_type = ctype;
+
+       /* Reset the chunk size if it's no longer valid.  */
+       if (!wim_chunk_size_valid(wim->out_solid_chunk_size, ctype))
+               wim->out_solid_chunk_size = wim_default_solid_chunk_size(ctype);
+       return 0;
+}
+
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_set_output_chunk_size(WIMStruct *wim, u32 chunk_size)
+{
+       if (chunk_size == 0) {
+               wim->out_chunk_size =
+                       wim_default_nonsolid_chunk_size(wim->out_compression_type);
+               return 0;
        }
-       *fd_ret = fd;
+
+       if (!wim_chunk_size_valid(chunk_size, wim->out_compression_type))
+               return WIMLIB_ERR_INVALID_CHUNK_SIZE;
+
+       wim->out_chunk_size = chunk_size;
        return 0;
 }
 
-int
-reopen_wim(WIMStruct *w)
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_set_output_pack_chunk_size(WIMStruct *wim, u32 chunk_size)
 {
-       wimlib_assert(w->in_fd == -1);
-       return do_open_wim(w->filename, &w->in_fd);
+       if (chunk_size == 0) {
+               wim->out_solid_chunk_size =
+                       wim_default_solid_chunk_size(wim->out_solid_compression_type);
+               return 0;
+       }
+
+       if (!wim_chunk_size_valid(chunk_size, wim->out_solid_compression_type))
+               return WIMLIB_ERR_INVALID_CHUNK_SIZE;
+
+       wim->out_solid_chunk_size = chunk_size;
+       return 0;
 }
 
-int
-close_wim(WIMStruct *w)
+/* API function documented in wimlib.h  */
+WIMLIBAPI const tchar *
+wimlib_get_compression_type_string(enum wimlib_compression_type ctype)
 {
-       if (w->in_fd != -1) {
-               close(w->in_fd);
-               w->in_fd = -1;
+       if (!wim_compression_type_valid(ctype))
+               return T("Invalid");
+
+       return wim_ctype_info[(unsigned)ctype].name;
+}
+
+WIMLIBAPI void
+wimlib_register_progress_function(WIMStruct *wim,
+                                 wimlib_progress_func_t progfunc,
+                                 void *progctx)
+{
+       wim->progfunc = progfunc;
+       wim->progctx = progctx;
+}
+
+static int
+open_wim_file(const tchar *filename, struct filedes *fd_ret)
+{
+       int raw_fd;
+
+       raw_fd = topen(filename, O_RDONLY | O_BINARY);
+       if (raw_fd < 0) {
+               ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
+               return WIMLIB_ERR_OPEN;
        }
+       filedes_init(fd_ret, raw_fd);
        return 0;
 }
 
 /*
  * Begins the reading of a WIM file; opens the file and reads its header and
- * lookup table, and optionally checks the integrity.
+ * blob table, and optionally checks the integrity.
  */
 static int
-begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
-          wimlib_progress_func_t progress_func)
+begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
 {
        int ret;
-       int xml_num_images;
-
-       DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
+       const tchar *wimfile;
 
-       ret = do_open_wim(in_wim_path, &w->in_fd);
-       if (ret)
-               return ret;
+       if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
+               wimfile = NULL;
+               filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
+               wim->in_fd.is_pipe = 1;
+       } else {
+               wimfile = wim_filename_or_fd;
+               ret = open_wim_file(wimfile, &wim->in_fd);
+               if (ret)
+                       return ret;
 
-       /* The absolute path to the WIM is requested so that wimlib_overwrite()
-        * still works even if the process changes its working directory.  This
-        * actually happens if a WIM is mounted read-write, since the FUSE
-        * thread changes directory to "/", and it needs to be able to find the
-        * WIM file again.
-        *
-        * This will break if the full path to the WIM changes in the
-        * intervening time...
-        *
-        * Warning: in Windows native builds, realpath() calls the replacement
-        * function in win32.c.
-        */
-       w->filename = realpath(in_wim_path, NULL);
-       if (!w->filename) {
-               ERROR_WITH_ERRNO("Failed to resolve WIM filename");
-               if (errno == ENOMEM)
-                       return WIMLIB_ERR_NOMEM;
-               else
-                       return WIMLIB_ERR_OPEN;
+               /* The absolute path to the WIM is requested so that
+                * wimlib_overwrite() still works even if the process changes
+                * its working directory.  This actually happens if a WIM is
+                * mounted read-write, since the FUSE thread changes directory
+                * to "/", and it needs to be able to find the WIM file again.
+                *
+                * This will break if the full path to the WIM changes in the
+                * intervening time...
+                *
+                * Warning: in Windows native builds, realpath() calls the
+                * replacement function in win32_replacements.c.
+                */
+               wim->filename = realpath(wimfile, NULL);
+               if (!wim->filename) {
+                       ERROR_WITH_ERRNO("Failed to get full path to file "
+                                        "\"%"TS"\"", wimfile);
+                       if (errno == ENOMEM)
+                               return WIMLIB_ERR_NOMEM;
+                       else
+                               return WIMLIB_ERR_NO_FILENAME;
+               }
        }
 
-       ret = read_header(w->filename, w->in_fd, &w->hdr);
+       ret = read_wim_header(wim, &wim->hdr);
        if (ret)
                return ret;
 
-       if (w->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
-               WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS is set in the header of \"%"TS"\".\n"
-                       "          It may be being changed by another process, or a process\n"
-                       "          may have crashed while writing the WIM.", in_wim_path);
+       if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
+               WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
+                       "          \"%"TS"\".  It may be being changed by another process,\n"
+                       "          or a process may have crashed while writing the WIM.",
+                       wimfile);
        }
 
        if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
-               ret = can_modify_wim(w);
+               ret = can_modify_wim(wim);
                if (ret)
                        return ret;
        }
 
-       if (w->hdr.total_parts != 1 && !(open_flags & WIMLIB_OPEN_FLAG_SPLIT_OK)) {
-               ERROR("\"%"TS"\": This WIM is part %u of a %u-part WIM",
-                     in_wim_path, w->hdr.part_number, w->hdr.total_parts);
-               return WIMLIB_ERR_SPLIT_UNSUPPORTED;
-       }
-
-       DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
+       if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
+           (wim->hdr.total_parts != 1))
+               return WIMLIB_ERR_IS_SPLIT_WIM;
 
        /* If the boot index is invalid, print a warning and set it to 0 */
-       if (w->hdr.boot_idx > w->hdr.image_count) {
-               WARNING("In `%"TS"', image %u is marked as bootable, "
-                       "but there are only %u images in the WIM",
-                       in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
-               w->hdr.boot_idx = 0;
+       if (wim->hdr.boot_idx > wim->hdr.image_count) {
+               WARNING("Ignoring invalid boot index.");
+               wim->hdr.boot_idx = 0;
        }
 
        /* Check and cache the compression type */
-       if (w->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
-               if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
-                       if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
-                               ERROR("Multiple compression flags are set in \"%"TS"\"",
-                                     in_wim_path);
-                               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
-                       }
-                       w->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
-               } else if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
-                       w->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
+       if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
+               if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
+                       wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
+               } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
+                                            WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
+                       wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
+               } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
+                       wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
                } else {
-                       ERROR("The compression flag is set on \"%"TS"\", but "
-                             "neither the XPRESS nor LZX flag is set",
-                             in_wim_path);
                        return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
                }
        } else {
-               BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_NONE != 0);
+               wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
+       }
+       wim->out_compression_type = wim->compression_type;
+
+       /* Check and cache the chunk size.  */
+       wim->chunk_size = wim->hdr.chunk_size;
+       wim->out_chunk_size = wim->chunk_size;
+       if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
+               ERROR("Invalid chunk size (%"PRIu32" bytes) "
+                     "for compression type %"TS"!", wim->chunk_size,
+                     wimlib_get_compression_type_string(wim->compression_type));
+               return WIMLIB_ERR_INVALID_CHUNK_SIZE;
        }
 
        if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
-               ret = check_wim_integrity(w, progress_func);
+               ret = check_wim_integrity(wim);
                if (ret == WIM_INTEGRITY_NONEXISTENT) {
-                       WARNING("No integrity information for `%"TS"'; skipping "
-                               "integrity check.", in_wim_path);
+                       WARNING("\"%"TS"\" does not contain integrity "
+                               "information.  Skipping integrity check.",
+                               wimfile);
                } else if (ret == WIM_INTEGRITY_NOT_OK) {
-                       ERROR("WIM is not intact! (Failed integrity check)");
                        return WIMLIB_ERR_INTEGRITY;
                } else if (ret != WIM_INTEGRITY_OK) {
                        return ret;
                }
        }
 
-       if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
-               w->image_metadata = new_image_metadata_array(w->hdr.image_count);
-               if (!w->image_metadata)
+       if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
+               wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
+               if (!wim->image_metadata)
                        return WIMLIB_ERR_NOMEM;
        }
 
-       ret = read_lookup_table(w);
-       if (ret)
-               return ret;
+       if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
+               wim->blob_table = new_blob_table(9001);
+               if (!wim->blob_table)
+                       return WIMLIB_ERR_NOMEM;
+       } else {
+               if (wim->hdr.blob_table_reshdr.uncompressed_size == 0 &&
+                   wim->hdr.xml_data_reshdr.uncompressed_size == 0)
+                       return WIMLIB_ERR_WIM_IS_INCOMPLETE;
 
-       ret = read_xml_data(w->in_fd, &w->hdr.xml_res_entry, &w->wim_info);
-       if (ret)
-               return ret;
+               ret = read_wim_xml_data(wim);
+               if (ret)
+                       return ret;
 
-       xml_num_images = wim_info_get_num_images(w->wim_info);
-       if (xml_num_images != w->hdr.image_count) {
-               ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
-                     "in the XML data,", in_wim_path, xml_num_images);
-               ERROR("but %u images in the WIM!  There must be exactly one "
-                     "<IMAGE> element per image.", w->hdr.image_count);
-               return WIMLIB_ERR_IMAGE_COUNT;
-       }
+               if (xml_get_image_count(wim->xml_info) != wim->hdr.image_count) {
+                       ERROR("The WIM's header is inconsistent with its XML data.\n"
+                             "        Please submit a bug report if you believe this "
+                             "WIM file should be considered valid.");
+                       return WIMLIB_ERR_IMAGE_COUNT;
+               }
 
-       DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
+               ret = read_blob_table(wim);
+               if (ret)
+                       return ret;
+       }
        return 0;
 }
 
-/*
- * Opens a WIM file and creates a WIMStruct for it.
- */
-WIMLIBAPI int
-wimlib_open_wim(const tchar *wim_file, int open_flags,
-               WIMStruct **wim_ret,
-               wimlib_progress_func_t progress_func)
+int
+open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
+                     WIMStruct **wim_ret,
+                     wimlib_progress_func_t progfunc, void *progctx)
 {
        WIMStruct *wim;
        int ret;
 
-       wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
-
-       ret = WIMLIB_ERR_INVALID_PARAM;
-       if (!wim_file || !wim_ret)
-               goto out;
+       ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+       if (ret)
+               return ret;
 
-       ret = WIMLIB_ERR_NOMEM;
        wim = new_wim_struct();
        if (!wim)
-               goto out;
-
-       ret = begin_read(wim, wim_file, open_flags, progress_func);
-       if (ret)
-               goto out_wimlib_free;
-
-       ret = 0;
-       *wim_ret = wim;
-       goto out;
-out_wimlib_free:
-       wimlib_free(wim);
-out:
-       return ret;
-}
-
-void
-destroy_image_metadata(struct wim_image_metadata *imd,
-                      struct wim_lookup_table *table,
-                      bool free_metadata_lte)
-{
-       free_dentry_tree(imd->root_dentry, table);
-       imd->root_dentry = NULL;
-       free_wim_security_data(imd->security_data);
-       imd->security_data = NULL;
+               return WIMLIB_ERR_NOMEM;
 
-       if (free_metadata_lte) {
-               free_lookup_table_entry(imd->metadata_lte);
-               imd->metadata_lte = NULL;
-       }
-       if (!table) {
-               struct wim_lookup_table_entry *lte, *tmp;
-               list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
-                       free_lookup_table_entry(lte);
-       }
-       INIT_LIST_HEAD(&imd->unhashed_streams);
-       INIT_LIST_HEAD(&imd->inode_list);
-#ifdef WITH_NTFS_3G
-       if (imd->ntfs_vol) {
-               do_ntfs_umount(imd->ntfs_vol);
-               imd->ntfs_vol = NULL;
-       }
-#endif
-}
+       wim->progfunc = progfunc;
+       wim->progctx = progctx;
 
-void
-put_image_metadata(struct wim_image_metadata *imd,
-                  struct wim_lookup_table *table)
-{
-       if (imd && --imd->refcnt == 0) {
-               destroy_image_metadata(imd, table, true);
-               FREE(imd);
+       ret = begin_read(wim, wim_filename_or_fd, open_flags);
+       if (ret) {
+               wimlib_free(wim);
+               return ret;
        }
-}
 
-/* Appends the specified image metadata structure to the array of image metadata
- * for a WIM, and increments the image count. */
-int
-append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd)
-{
-       struct wim_image_metadata **imd_array;
-
-       DEBUG("Reallocating image metadata array for image_count = %u",
-             w->hdr.image_count + 1);
-       imd_array = REALLOC(w->image_metadata,
-                           sizeof(w->image_metadata[0]) * (w->hdr.image_count + 1));
-
-       if (!imd_array)
-               return WIMLIB_ERR_NOMEM;
-       w->image_metadata = imd_array;
-       imd_array[w->hdr.image_count++] = imd;
+       *wim_ret = wim;
        return 0;
 }
 
-
-struct wim_image_metadata *
-new_image_metadata(void)
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
+                             WIMStruct **wim_ret,
+                             wimlib_progress_func_t progfunc, void *progctx)
 {
-       struct wim_image_metadata *imd;
+       if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
+                          WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
+                          WIMLIB_OPEN_FLAG_WRITE_ACCESS))
+               return WIMLIB_ERR_INVALID_PARAM;
 
-       imd = CALLOC(1, sizeof(*imd));
-       if (imd) {
-               imd->refcnt = 1;
-               INIT_LIST_HEAD(&imd->inode_list);
-               INIT_LIST_HEAD(&imd->unhashed_streams);
-               DEBUG("Created new image metadata (refcnt=1)");
-       } else {
-               ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
-       }
-       return imd;
+       if (!wimfile || !*wimfile || !wim_ret)
+               return WIMLIB_ERR_INVALID_PARAM;
+
+       return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
+                                    progfunc, progctx);
 }
 
-struct wim_image_metadata **
-new_image_metadata_array(unsigned num_images)
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
 {
-       struct wim_image_metadata **imd_array;
-
-       DEBUG("Creating new image metadata array for %u images",
-             num_images);
-
-       imd_array = CALLOC(num_images, sizeof(imd_array[0]));
-
-       if (!imd_array) {
-               ERROR("Failed to allocate memory for %u image metadata structures",
-                     num_images);
-               return NULL;
-       }
-       for (unsigned i = 0; i < num_images; i++) {
-               imd_array[i] = new_image_metadata();
-               if (!imd_array[i]) {
-                       for (unsigned j = 0; j < i; j++)
-                               put_image_metadata(imd_array[j], NULL);
-                       FREE(imd_array);
-                       return NULL;
-               }
-       }
-       return imd_array;
+       return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
+                                            NULL, NULL);
 }
 
-/* Checksum all streams that are unhashed (other than the metadata streams),
- * merging them into the lookup table as needed.  This is a no-op unless the
- * library has previously used to add or mount an image using the same
- * WIMStruct. */
+/* Checksum all blobs that are unhashed (other than the metadata blobs), merging
+ * them into the blob table as needed.  This is a no-op unless files have been
+ * added to an image in the same WIMStruct.  */
 int
-wim_checksum_unhashed_streams(WIMStruct *w)
+wim_checksum_unhashed_blobs(WIMStruct *wim)
 {
        int ret;
-       for (int i = 0; i < w->hdr.image_count; i++) {
-               struct wim_lookup_table_entry *lte, *tmp;
-               struct wim_image_metadata *imd = w->image_metadata[i];
-               image_for_each_unhashed_stream_safe(lte, tmp, imd) {
-                       ret = hash_unhashed_stream(lte, w->lookup_table, NULL);
+
+       if (!wim_has_metadata(wim))
+               return 0;
+       for (int i = 0; i < wim->hdr.image_count; i++) {
+               struct blob_descriptor *blob, *tmp;
+               struct wim_image_metadata *imd = wim->image_metadata[i];
+               image_for_each_unhashed_blob_safe(blob, tmp, imd) {
+                       struct blob_descriptor *new_blob;
+                       ret = hash_unhashed_blob(blob, wim->blob_table, &new_blob);
                        if (ret)
                                return ret;
+                       if (new_blob != blob)
+                               free_blob_descriptor(blob);
                }
        }
        return 0;
@@ -803,7 +855,7 @@ can_modify_wim(WIMStruct *wim)
                }
        }
        if (wim->hdr.total_parts != 1) {
-               ERROR("Cannot modify \"%"TS"\": is part of a spanned set",
+               ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
                      wim->filename);
                return WIMLIB_ERR_WIM_IS_READONLY;
        }
@@ -815,55 +867,43 @@ can_modify_wim(WIMStruct *wim)
        return 0;
 }
 
-/*
- * can_delete_from_wim - Check if files or images can be deleted from a given
- * WIM file.
- *
- * This theoretically should be exactly the same as can_modify_wim(), but
- * unfortunately, due to bugs in Microsoft's software that generate incorrect
- * reference counts for some WIM resources, we need to run expensive
- * verifications to make sure the reference counts are correct on all WIM
- * resources.  Otherwise we might delete a WIM resource whose reference count
- * has fallen to 0, but is actually still referenced somewhere.
- */
-int
-can_delete_from_wim(WIMStruct *wim)
+/* Free a WIMStruct after no more resources reference it.  */
+void
+finalize_wim_struct(WIMStruct *wim)
 {
-       int ret;
-
-       ret = can_modify_wim(wim);
-       if (ret)
-               return ret;
-       if (!wim->refcnts_ok)
-               wim_recalculate_refcnts(wim);
-       return 0;
+       if (filedes_valid(&wim->in_fd))
+               filedes_close(&wim->in_fd);
+       if (filedes_valid(&wim->out_fd))
+               filedes_close(&wim->out_fd);
+       wimlib_free_decompressor(wim->decompressor);
+       xml_free_info_struct(wim->xml_info);
+       FREE(wim->filename);
+       FREE(wim);
 }
 
-/* Frees the memory for the WIMStruct, including all internal memory; also
- * closes all files associated with the WIMStruct.  */
+/* API function documented in wimlib.h  */
 WIMLIBAPI void
-wimlib_free(WIMStruct *w)
+wimlib_free(WIMStruct *wim)
 {
-       DEBUG("Freeing WIMStruct");
-
-       if (!w)
+       if (!wim)
                return;
-       if (w->in_fd != -1)
-               close(w->in_fd);
-       if (w->out_fd != -1)
-               close(w->out_fd);
 
-       free_lookup_table(w->lookup_table);
+       /* The blob table and image metadata are freed immediately, but other
+        * members of the WIMStruct such as the input file descriptor are
+        * retained until no more exported resources reference the WIMStruct. */
 
-       FREE(w->filename);
-       free_wim_info(w->wim_info);
-       if (w->image_metadata) {
-               for (unsigned i = 0; i < w->hdr.image_count; i++)
-                       put_image_metadata(w->image_metadata[i], NULL);
-               FREE(w->image_metadata);
+       free_blob_table(wim->blob_table);
+       wim->blob_table = NULL;
+       if (wim->image_metadata != NULL) {
+               for (int i = 0; i < wim->hdr.image_count; i++)
+                       put_image_metadata(wim->image_metadata[i], NULL);
+               FREE(wim->image_metadata);
+               wim->image_metadata = NULL;
        }
-       FREE(w);
-       DEBUG("Freed WIMStruct");
+
+       wimlib_assert(wim->refcnt > 0);
+       if (--wim->refcnt == 0)
+               finalize_wim_struct(wim);
 }
 
 static bool
@@ -881,14 +921,54 @@ test_locale_ctype_utf8(void)
 #endif
 }
 
+/* API function documented in wimlib.h  */
+WIMLIBAPI u32
+wimlib_get_version(void)
+{
+       return (WIMLIB_MAJOR_VERSION << 20) |
+              (WIMLIB_MINOR_VERSION << 10) |
+               WIMLIB_PATCH_VERSION;
+}
+
+static bool lib_initialized = false;
+static pthread_mutex_t lib_initialization_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+/* API function documented in wimlib.h  */
 WIMLIBAPI int
 wimlib_global_init(int init_flags)
 {
-       static bool already_inited = false;
+       int ret = 0;
 
-       if (already_inited)
-               return 0;
-       libxml_global_init();
+       if (lib_initialized)
+               goto out;
+
+       pthread_mutex_lock(&lib_initialization_mutex);
+
+       if (lib_initialized)
+               goto out_unlock;
+
+#ifdef ENABLE_ERROR_MESSAGES
+       if (!wimlib_error_file)
+               wimlib_error_file = stderr;
+#endif
+
+       ret = WIMLIB_ERR_INVALID_PARAM;
+       if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
+                          WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
+                          WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
+                          WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
+                          WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
+                          WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
+               goto out_unlock;
+
+       ret = WIMLIB_ERR_INVALID_PARAM;
+       if ((init_flags & (WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
+                          WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
+                       == (WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
+                           WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
+               goto out_unlock;
+
+       xml_global_init();
        if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
                wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
        #ifdef WITH_NTFS_3G
@@ -897,20 +977,45 @@ wimlib_global_init(int init_flags)
        #endif
        }
 #ifdef __WIN32__
-       win32_global_init();
+       ret = win32_global_init(init_flags);
+       if (ret)
+               goto out_unlock;
 #endif
-       already_inited = true;
-       return 0;
+       iconv_global_init();
+       init_upcase();
+       if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
+               default_ignore_case = false;
+       else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
+               default_ignore_case = true;
+       lib_initialized = true;
+       ret = 0;
+out_unlock:
+       pthread_mutex_unlock(&lib_initialization_mutex);
+out:
+       return ret;
 }
 
-/* Free global memory allocations.  Not strictly necessary if the process using
- * wimlib is just about to exit (as is the case for 'imagex'). */
+/* API function documented in wimlib.h  */
 WIMLIBAPI void
 wimlib_global_cleanup(void)
 {
-       libxml_global_cleanup();
+       if (!lib_initialized)
+               return;
+
+       pthread_mutex_lock(&lib_initialization_mutex);
+
+       if (!lib_initialized)
+               goto out_unlock;
+
+       xml_global_cleanup();
        iconv_global_cleanup();
 #ifdef __WIN32__
        win32_global_cleanup();
 #endif
+
+       wimlib_set_error_file(NULL);
+       lib_initialized = false;
+
+out_unlock:
+       pthread_mutex_unlock(&lib_initialization_mutex);
 }