/*
- * wim.c
+ * wim.c - High-level code dealing with WIMStructs and images.
*/
/*
- * Copyright (C) 2010 Carl Thijssen
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012-2016 Eric Biggers
*
- * wimlib - 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.
*
- * This file is part of wimlib, a library for working with WIM files.
- *
- * wimlib 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 2.1 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 Lesser 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 Lesser General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * along with this file; if not, see http://www.gnu.org/licenses/.
*/
-#include "wimlib_internal.h"
-#include "io.h"
-#include "lookup_table.h"
-#include "xml.h"
-#include <stdlib.h>
-
-#ifdef WITH_NTFS_3G
-#include <ntfs-3g/volume.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
#endif
-static int print_metadata(WIMStruct *w)
+#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/metadata.h"
+#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)
{
- print_security_data(wim_security_data(w));
- return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
- w->lookup_table);
+ return (unsigned)ctype < ARRAY_LEN(wim_ctype_info) &&
+ wim_ctype_info[(unsigned)ctype].name != NULL;
}
+/* 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;
-static int print_files(WIMStruct *w)
+ return chunk_size >= wim_ctype_info[(unsigned)ctype].min_chunk_size &&
+ chunk_size <= wim_ctype_info[(unsigned)ctype].max_chunk_size;
+}
+
+/* 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)
{
- return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
- NULL);
+ return wim_ctype_info[(unsigned)ctype].default_nonsolid_chunk_size;
}
-WIMStruct *new_wim_struct()
+/* 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 CALLOC(1, sizeof(WIMStruct));
+ return wim_ctype_info[(unsigned)ctype].default_solid_chunk_size;
}
-/*
- * Calls a function on images in the WIM. If @image is WIM_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 *))
+/* Return the default compression type to use in solid resources. */
+static enum wimlib_compression_type
+wim_default_solid_compression_type(void)
{
- int ret;
- int i;
- int end;
+ return WIMLIB_COMPRESSION_TYPE_LZMS;
+}
- DEBUG("for_image(w = %p, image = %d, visitor = %p)", w, image, visitor);
+static int
+is_blob_in_solid_resource(struct blob_descriptor *blob, void *_ignore)
+{
+ return blob->blob_location == BLOB_IN_WIM &&
+ (blob->rdesc->flags & WIM_RESHDR_FLAG_SOLID);
+}
- if (image == WIM_ALL_IMAGES) {
- i = 1;
- end = w->hdr.image_count;
- } else {
- if (image < 1 || image > w->hdr.image_count)
- return WIMLIB_ERR_INVALID_IMAGE;
- i = image;
- end = image;
- }
- for (; i <= end; i++) {
- ret = wimlib_select_image(w, i);
- if (ret != 0)
- return ret;
- ret = visitor(w);
- if (ret != 0)
- return ret;
- }
- return 0;
+bool
+wim_has_solid_resources(const WIMStruct *wim)
+{
+ return for_blob_in_table(wim->blob_table, is_blob_in_solid_resource, NULL);
}
-static int sort_image_metadata_by_position(const void *p1, const void *p2)
+static WIMStruct *
+new_wim_struct(void)
{
- struct image_metadata *bmd1 = (struct image_metadata*)p1;
- struct image_metadata *bmd2 = (struct image_metadata*)p2;
- u64 offset1 = bmd1->metadata_lte->resource_entry.offset;
- u64 offset2 = bmd2->metadata_lte->resource_entry.offset;
- if (offset1 < offset2)
- return -1;
- else if (offset1 > offset2)
- return 1;
- else
- return 0;
+ 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;
}
-/*
- * If @lte points to a metadata resource, append it to the list of metadata
- * resources in the WIMStruct. Otherwise, do nothing.
- */
-static int append_metadata_resource_entry(struct lookup_table_entry *lte,
- void *wim_p)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret)
{
- WIMStruct *w = wim_p;
+ int ret;
+ WIMStruct *wim;
- if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
- /*fprintf(stderr, "found mlte at %u\n", lte->resource_entry.offset);*/
- if (w->current_image == w->hdr.image_count) {
- ERROR("Expected only %u images, but found more",
- w->hdr.image_count);
- return WIMLIB_ERR_IMAGE_COUNT;
- } else {
- DEBUG("Found metadata resource for image %u at "
- "offset %"PRIu64".",
- w->current_image + 1,
- lte->resource_entry.offset);
- w->image_metadata[
- w->current_image++].metadata_lte = lte;
- }
+ 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(64);
+ 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;
}
-/* Returns the compression type given in the flags of a WIM header. */
-int wim_hdr_flags_compression_type(int wim_hdr_flags)
+static void
+unload_image_metadata(struct wim_image_metadata *imd)
{
- if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
- if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
- return WIM_COMPRESSION_TYPE_LZX;
- else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
- return WIM_COMPRESSION_TYPE_XPRESS;
- else
- return WIM_COMPRESSION_TYPE_INVALID;
- } else {
- return WIM_COMPRESSION_TYPE_NONE;
- }
+ free_dentry_tree(imd->root_dentry, NULL);
+ imd->root_dentry = NULL;
+ free_wim_security_data(imd->security_data);
+ imd->security_data = NULL;
+ INIT_HLIST_HEAD(&imd->inode_list);
}
-/*
- * Creates a WIMStruct for a new WIM file.
- */
-WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
+/* Release a reference to the specified image metadata. This assumes that no
+ * WIMStruct has the image selected. */
+void
+put_image_metadata(struct wim_image_metadata *imd)
{
- WIMStruct *w;
- struct lookup_table *table;
- int ret;
+ struct blob_descriptor *blob, *tmp;
+
+ if (!imd)
+ return;
+ wimlib_assert(imd->refcnt > 0);
+ if (--imd->refcnt != 0)
+ return;
+ wimlib_assert(imd->selected_refcnt == 0);
+ unload_image_metadata(imd);
+ list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
+ free_blob_descriptor(blob);
+ free_blob_descriptor(imd->metadata_blob);
+ 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;
- DEBUG("Creating new WIM with %s compression.",
- wimlib_get_compression_type_string(ctype));
+ if (!wim_has_metadata(wim))
+ return WIMLIB_ERR_METADATA_NOT_FOUND;
- /* Allocate the WIMStruct. */
- w = new_wim_struct();
- if (!w)
+ if (wim->hdr.image_count >= MAX_IMAGES)
+ return WIMLIB_ERR_IMAGE_COUNT;
+
+ imd_array = REALLOC(wim->image_metadata,
+ sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
+
+ 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;
+static struct wim_image_metadata *
+new_image_metadata(struct blob_descriptor *metadata_blob,
+ struct wim_security_data *security_data)
+{
+ struct wim_image_metadata *imd;
+
+ imd = CALLOC(1, sizeof(*imd));
+ if (!imd)
+ return NULL;
+
+ metadata_blob->is_metadata = 1;
+ imd->refcnt = 1;
+ imd->selected_refcnt = 0;
+ imd->root_dentry = NULL;
+ imd->security_data = security_data;
+ imd->metadata_blob = metadata_blob;
+ INIT_HLIST_HEAD(&imd->inode_list);
+ INIT_LIST_HEAD(&imd->unhashed_blobs);
+ imd->stats_outdated = false;
+ return imd;
+}
- table = new_lookup_table(9001);
- if (!table) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free;
+/* Create an image metadata structure for a new empty image. */
+struct wim_image_metadata *
+new_empty_image_metadata(void)
+{
+ struct blob_descriptor *metadata_blob;
+ struct wim_security_data *security_data;
+ struct wim_image_metadata *imd;
+
+ metadata_blob = new_blob_descriptor();
+ security_data = new_wim_security_data();
+ if (metadata_blob && security_data) {
+ metadata_blob->refcnt = 1;
+ imd = new_image_metadata(metadata_blob, security_data);
+ if (imd)
+ return imd;
}
- w->lookup_table = table;
- *w_ret = w;
- return 0;
-out_free:
- FREE(w);
- return ret;
+ free_blob_descriptor(metadata_blob);
+ FREE(security_data);
+ return NULL;
}
-WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
+/* Create an image metadata structure that refers to the specified metadata
+ * resource and is initially not loaded. */
+struct wim_image_metadata *
+new_unloaded_image_metadata(struct blob_descriptor *metadata_blob)
{
- return w->hdr.image_count;
+ wimlib_assert(metadata_blob->blob_location == BLOB_IN_WIM);
+ return new_image_metadata(metadata_blob, NULL);
}
-int wimlib_select_image(WIMStruct *w, int image)
+/*
+ * 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 *wim, int image)
{
- struct image_metadata *imd;
+ struct wim_image_metadata *imd;
+ int ret;
- DEBUG("Selecting image %d", 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 (!wim_has_metadata(wim))
+ return WIMLIB_ERR_METADATA_NOT_FOUND;
- /* If a valid image is currently selected, it can be freed if it is not
- * modified. */
- if (w->current_image != WIM_NO_IMAGE) {
- imd = wim_get_current_image_metadata(w);
- if (!imd->modified) {
- DEBUG("Freeing image %u", w->current_image);
- destroy_image_metadata(imd, NULL);
- imd->root_dentry = NULL;
- imd->security_data = NULL;
- imd->lgt = NULL;
- }
- }
-
- w->current_image = image;
- imd = wim_get_current_image_metadata(w);
+ deselect_current_wim_image(wim);
- if (imd->root_dentry) {
- return 0;
- } else {
- #ifdef ENABLE_DEBUG
- DEBUG("Reading metadata resource specified by the following "
- "lookup table entry:");
- print_lookup_table_entry(imd->metadata_lte);
- #endif
- return read_metadata_resource(w->fp,
- wimlib_get_compression_type(w),
- imd);
+ imd = wim->image_metadata[image - 1];
+ if (!is_image_loaded(imd)) {
+ ret = read_metadata_resource(imd);
+ if (ret)
+ return ret;
}
+ wim->current_image = image;
+ imd->selected_refcnt++;
+ return 0;
}
-
-/* Returns the compression type of the WIM file. */
-WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
+/*
+ * Deselect the WIMStruct's currently selected image, if any. To reduce memory
+ * usage, possibly unload the newly deselected image's metadata from memory.
+ */
+void
+deselect_current_wim_image(WIMStruct *wim)
{
- return wim_hdr_flags_compression_type(w->hdr.flags);
-}
+ struct wim_image_metadata *imd;
-WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
-{
- switch (ctype) {
- case WIM_COMPRESSION_TYPE_NONE:
- return "None";
- case WIM_COMPRESSION_TYPE_LZX:
- return "LZX";
- case WIM_COMPRESSION_TYPE_XPRESS:
- return "XPRESS";
- default:
- return "Invalid";
+ if (wim->current_image == WIMLIB_NO_IMAGE)
+ return;
+ imd = wim_get_current_image_metadata(wim);
+ wimlib_assert(imd->selected_refcnt > 0);
+ imd->selected_refcnt--;
+ wim->current_image = WIMLIB_NO_IMAGE;
+
+ if (can_unload_image(imd)) {
+ wimlib_assert(list_empty(&imd->unhashed_blobs));
+ unload_image_metadata(imd);
}
}
/*
- * 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.
*/
-WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
+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 *wim, const tchar *image_name_or_num)
{
- char *p;
- int image;
+ tchar *p;
+ long image;
int i;
- if (!image_name_or_num)
- return WIM_NO_IMAGE;
+ if (!image_name_or_num || !*image_name_or_num)
+ return WIMLIB_NO_IMAGE;
- if (strcmp(image_name_or_num, "all") == 0)
- return WIM_ALL_IMAGES;
- image = strtol(image_name_or_num, &p, 10);
- if (p != image_name_or_num && *p == '\0') {
- if (image < 1 || image > w->hdr.image_count)
- return WIM_NO_IMAGE;
+ if (!tstrcasecmp(image_name_or_num, T("all"))
+ || !tstrcasecmp(image_name_or_num, T("*")))
+ 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 > wim->hdr.image_count)
+ return WIMLIB_NO_IMAGE;
return image;
} else {
- for (i = 1; i <= w->hdr.image_count; i++) {
- if (strcmp(image_name_or_num,
- wimlib_get_image_name(w, i)) == 0)
+ for (i = 1; i <= wim->hdr.image_count; i++) {
+ if (!tstrcmp(image_name_or_num,
+ wimlib_get_image_name(wim, i)))
return i;
}
- return WIM_NO_IMAGE;
+ return WIMLIB_NO_IMAGE;
}
}
-
-/* Prints some basic information about a WIM file. */
-WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
+/* API function documented in wimlib.h */
+WIMLIBAPI void
+wimlib_print_available_images(const WIMStruct *wim, int image)
{
- const struct wim_header *hdr;
-
- hdr = &w->hdr;
- puts("WIM Information:");
- puts("----------------");
- printf("Path: %s\n", w->filename);
- fputs ("GUID: 0x", stdout);
- print_byte_field(hdr->guid, WIM_GID_LEN);
- putchar('\n');
- printf("Image Count: %d\n", hdr->image_count);
- printf("Compression: %s\n", wimlib_get_compression_type_string(
- wimlib_get_compression_type(w)));
- printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
- printf("Boot Index: %d\n", hdr->boot_idx);
- printf("Size: %"PRIu64" bytes\n",
- wim_info_get_total_bytes(w->wim_info));
- printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
- putchar('\n');
+ int first;
+ int last;
+ int i;
+ int n;
+ if (image == WIMLIB_ALL_IMAGES) {
+ n = tprintf(T("Available Images:\n"));
+ first = 1;
+ 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;
+ } else {
+ tprintf(T("wimlib_print_available_images(): Invalid image %d"),
+ image);
+ return;
+ }
+ for (i = 0; i < n - 1; i++)
+ tputchar(T('-'));
+ tputchar(T('\n'));
+ for (i = first; i <= last; i++)
+ xml_print_image_info(wim->xml_info, i);
}
-WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
{
- return w->hdr.integrity.size != 0;
+ memset(info, 0, sizeof(struct wimlib_wim_info));
+ 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->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;
+ 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) ||
+ (wim->hdr.total_parts != 1) ||
+ (wim->filename && taccess(wim->filename, W_OK));
+ info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
+ info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
+ info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
+ 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;
}
-WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
{
- if (image == WIM_ALL_IMAGES) {
- puts("Available Images:");
- puts("-----------------");
- } else {
- int n;
- int i;
+ 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)
+ wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
+ else
+ wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
+ }
+
+ if (which & WIMLIB_CHANGE_GUID)
+ copy_guid(wim->hdr.guid, info->guid);
- n = printf("Information for Image %d\n", image);
- for (i = 0; i < n - 1; i++)
- putchar('-');
- putchar('\n');
+ if (which & WIMLIB_CHANGE_BOOT_INDEX)
+ wim->hdr.boot_idx = info->boot_index;
+ if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
+ if (info->has_rpfix)
+ wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
+ else
+ wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
}
- print_image_info(w->wim_info, image);
+ return 0;
}
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_compression_type(WIMStruct *wim,
+ enum wimlib_compression_type ctype)
+{
+ if (!wim_compression_type_valid(ctype))
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
-/* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
- * not WIM_NO_IMAGE. */
-WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
+ wim->out_compression_type = ctype;
+
+ /* 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;
+}
+
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_pack_compression_type(WIMStruct *wim,
+ enum wimlib_compression_type ctype)
{
- return for_image(w, image, print_metadata);
+ if (!wim_compression_type_valid(ctype))
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+
+ /* 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;
}
-WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_chunk_size(WIMStruct *wim, u32 chunk_size)
{
- return for_image(w, image, print_files);
+ if (chunk_size == 0) {
+ wim->out_chunk_size =
+ wim_default_nonsolid_chunk_size(wim->out_compression_type);
+ return 0;
+ }
+
+ 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;
}
-/* Sets the index of the bootable image. */
-WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_pack_chunk_size(WIMStruct *wim, u32 chunk_size)
{
- if (boot_idx < 0 || boot_idx > w->hdr.image_count)
- return WIMLIB_ERR_INVALID_IMAGE;
- w->hdr.boot_idx = boot_idx;
- if (boot_idx == 0) {
- memset(&w->hdr.boot_metadata_res_entry, 0,
- sizeof(struct resource_entry));
- } else {
- memcpy(&w->hdr.boot_metadata_res_entry,
- &w->image_metadata[
- boot_idx - 1].metadata_lte->resource_entry,
- sizeof(struct resource_entry));
+ 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;
}
-WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
+/* API function documented in wimlib.h */
+WIMLIBAPI const tchar *
+wimlib_get_compression_type_string(enum wimlib_compression_type ctype)
{
- if (total_parts_ret)
- *total_parts_ret = w->hdr.total_parts;
- return w->hdr.part_number;
+ if (!wim_compression_type_valid(ctype))
+ return T("Invalid");
+
+ return wim_ctype_info[(unsigned)ctype].name;
}
-
-WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
+WIMLIBAPI void
+wimlib_register_progress_function(WIMStruct *wim,
+ wimlib_progress_func_t progfunc,
+ void *progctx)
{
- return w->hdr.boot_idx;
+ 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 char *in_wim_path, int flags)
+static int
+begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
{
int ret;
- uint xml_num_images;
+ const tchar *wimfile;
- DEBUG("Reading the WIM file `%s'", in_wim_path);
+ 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;
- w->filename = STRDUP(in_wim_path);
- if (!w->filename) {
- ERROR("Failed to allocate memory for WIM filename");
- return WIMLIB_ERR_NOMEM;
+ /* 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;
+ }
}
- w->fp = fopen(in_wim_path, "rb");
+ ret = read_wim_header(wim, &wim->hdr);
+ if (ret)
+ return ret;
- if (!w->fp) {
- ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
- in_wim_path);
- return WIMLIB_ERR_OPEN;
+ 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);
}
- ret = read_header(w->fp, &w->hdr, flags & WIMLIB_OPEN_FLAG_SPLIT_OK);
- if (ret != 0)
- return ret;
+ if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
+ ret = can_modify_wim(wim);
+ if (ret)
+ return ret;
+ }
- DEBUG("Wim file 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 `%s', image %u is marked as bootable, "
- "but there are only %u images",
- 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;
}
- if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
- ERROR("Invalid compression type (WIM header flags = %x)",
- w->hdr.flags);
- return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ /* Check and cache the compression type */
+ 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 {
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ }
+ } else {
+ 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 (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
- int integrity_status;
- ret = check_wim_integrity(w,
- flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
- &integrity_status);
- if (ret != 0) {
- ERROR("Error in check_wim_integrity()");
- return ret;
- }
- if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
- WARNING("No integrity information for `%s'; skipping "
- "integrity check.", w->filename);
- } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
- ERROR("WIM is not intact! (Failed integrity check)");
+ if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
+ ret = check_wim_integrity(wim);
+ if (ret == WIM_INTEGRITY_NONEXISTENT) {
+ WARNING("\"%"TS"\" does not contain integrity "
+ "information. Skipping integrity check.",
+ wimfile);
+ } else if (ret == WIM_INTEGRITY_NOT_OK) {
return WIMLIB_ERR_INTEGRITY;
+ } else if (ret != WIM_INTEGRITY_OK) {
+ return ret;
}
}
- if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
- ERROR("Didn't expect a compressed lookup table!");
- ERROR("Ask the author to implement support for this.");
- return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
+ if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
+ wim->image_metadata = CALLOC(wim->hdr.image_count,
+ sizeof(wim->image_metadata[0]));
+ if (!wim->image_metadata)
+ return WIMLIB_ERR_NOMEM;
}
- ret = read_lookup_table(w);
- if (ret != 0)
- return ret;
+ if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
+ wim->blob_table = new_blob_table(64);
+ 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;
- w->image_metadata = CALLOC(w->hdr.image_count,
- sizeof(struct image_metadata));
+ ret = read_wim_xml_data(wim);
+ if (ret)
+ return ret;
- if (!w->image_metadata) {
- ERROR("Failed to allocate memory for %u metadata structures",
- w->hdr.image_count);
- return WIMLIB_ERR_NOMEM;
- }
- w->current_image = 0;
+ 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("Looking for metadata resources in the lookup table.");
+ ret = read_blob_table(wim);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
- /* Find the images in the WIM by searching the lookup table. */
- ret = for_lookup_table_entry(w->lookup_table,
- append_metadata_resource_entry, w);
+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;
- if (ret != 0)
+ ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+ if (ret)
return ret;
- /* Make sure all the expected images were found. (We already have
- * returned false if *extra* images were found) */
- if (w->current_image != w->hdr.image_count && w->hdr.part_number == 1) {
- ERROR("Only found %u images in WIM, but expected %u",
- w->current_image, w->hdr.image_count);
- return WIMLIB_ERR_IMAGE_COUNT;
+ wim = new_wim_struct();
+ if (!wim)
+ return WIMLIB_ERR_NOMEM;
+
+ wim->progfunc = progfunc;
+ wim->progctx = progctx;
+
+ ret = begin_read(wim, wim_filename_or_fd, open_flags);
+ if (ret) {
+ wimlib_free(wim);
+ return ret;
}
+ *wim_ret = wim;
+ return 0;
+}
- /* Sort images by the position of their metadata resources. I'm
- * assuming that is what determines the other of the images in the WIM
- * file, rather than their order in the lookup table, which is random
- * because of hashing. */
- qsort(w->image_metadata, w->current_image,
- sizeof(struct image_metadata), sort_image_metadata_by_position);
+/* 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)
+{
+ if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
+ WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
+ WIMLIB_OPEN_FLAG_WRITE_ACCESS))
+ return WIMLIB_ERR_INVALID_PARAM;
- w->current_image = WIM_NO_IMAGE;
+ if (!wimfile || !*wimfile || !wim_ret)
+ return WIMLIB_ERR_INVALID_PARAM;
- /* Read the XML data. */
- ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
- &w->xml_data, &w->wim_info);
+ return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
+ progfunc, progctx);
+}
- if (ret != 0) {
- ERROR("Missing or invalid XML data");
- return ret;
- }
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
+{
+ return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
+ NULL, NULL);
+}
- xml_num_images = wim_info_get_num_images(w->wim_info);
- if (xml_num_images != w->hdr.image_count) {
- ERROR("In the file `%s', 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;
- }
+/* 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_blobs(WIMStruct *wim)
+{
+ int ret;
- DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
+ 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;
}
-
/*
- * Opens a WIM file and creates a WIMStruct for it.
+ * can_modify_wim - Check if a given WIM is writeable. This is only the case if
+ * it meets the following three conditions:
+ *
+ * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
+ * 2. The WIM is not part of a spanned set.
+ * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
+ *
+ * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
*/
-WIMLIBAPI int wimlib_open_wim(const char *wim_file, int flags,
- WIMStruct **w_ret)
+int
+can_modify_wim(WIMStruct *wim)
{
- WIMStruct *w;
- int ret;
-
- DEBUG("wim_file = `%s', flags = %#x", wim_file, flags);
- w = new_wim_struct();
- if (!w) {
- ERROR("Failed to allocate memory for WIMStruct");
- return WIMLIB_ERR_NOMEM;
+ if (wim->filename) {
+ if (taccess(wim->filename, W_OK)) {
+ ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
}
-
- ret = begin_read(w, wim_file, flags);
- if (ret != 0) {
- DEBUG("Could not begin reading the WIM file `%s'", wim_file);
- wimlib_free(w);
- return ret;
+ if (wim->hdr.total_parts != 1) {
+ ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
+ wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
+ ERROR("Cannot modify \"%"TS"\": is marked read-only",
+ wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
}
- *w_ret = w;
return 0;
}
-/* Frees the memory for the WIMStruct, including all internal memory; also
- * closes all files associated with the WIMStruct. */
-WIMLIBAPI void wimlib_free(WIMStruct *w)
+/* Release a reference to a WIMStruct. If the reference count reaches 0, the
+ * WIMStruct is freed. */
+void
+wim_decrement_refcnt(WIMStruct *wim)
{
- DEBUG("Freeing WIMStruct");
+ wimlib_assert(wim->refcnt > 0);
+ if (--wim->refcnt != 0)
+ return;
+ 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);
+}
- if (!w)
+/* API function documented in wimlib.h */
+WIMLIBAPI void
+wimlib_free(WIMStruct *wim)
+{
+ if (!wim)
return;
- if (w->fp)
- fclose(w->fp);
- if (w->out_fp)
- fclose(w->out_fp);
-
- free_lookup_table(w->lookup_table);
-
- FREE(w->filename);
- FREE(w->xml_data);
- free_wim_info(w->wim_info);
- if (w->image_metadata) {
- for (uint i = 0; i < w->hdr.image_count; i++)
- destroy_image_metadata(&w->image_metadata[i], NULL);
- FREE(w->image_metadata);
+
+ /* 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_blob_table(wim->blob_table);
+ wim->blob_table = NULL;
+ if (wim->image_metadata != NULL) {
+ deselect_current_wim_image(wim);
+ for (int i = 0; i < wim->hdr.image_count; i++)
+ put_image_metadata(wim->image_metadata[i]);
+ FREE(wim->image_metadata);
+ wim->image_metadata = NULL;
}
-#ifdef WITH_NTFS_3G
- if (w->ntfs_vol) {
- DEBUG("Unmounting NTFS volume");
- ntfs_umount(w->ntfs_vol, FALSE);
+
+ wim_decrement_refcnt(wim);
+}
+
+static bool
+test_locale_ctype_utf8(void)
+{
+#ifdef __WIN32__
+ return false;
+#else
+ char *ctype = nl_langinfo(CODESET);
+
+ return (!strstr(ctype, "UTF-8") ||
+ !strstr(ctype, "UTF8") ||
+ !strstr(ctype, "utf8") ||
+ !strstr(ctype, "utf-8"));
+#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)
+{
+ int ret = 0;
+
+ 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
+ if (!wimlib_mbs_is_utf8)
+ libntfs3g_global_init();
+ #endif
}
+#ifdef __WIN32__
+ ret = win32_global_init(init_flags);
+ if (ret)
+ goto out_unlock;
#endif
- FREE(w);
+ 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;
}
+/* API function documented in wimlib.h */
+WIMLIBAPI void
+wimlib_global_cleanup(void)
+{
+ 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);
+}