X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwim.c;h=ca40e53a47a303b4dbe3cb44e2172e2976e91da5;hp=9b5e4b24856d8b70deec0bfc50059158ec0c6e0f;hb=HEAD;hpb=62458ef728064652932d49fbab1116b2f2462fa8

diff --git a/src/wim.c b/src/wim.c
index 9b5e4b24..3a2a216a 100644
--- a/src/wim.c
+++ b/src/wim.c
@@ -3,7 +3,7 @@
  */
 
 /*
- * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
+ * Copyright 2012-2023 Eric Biggers
  *
  * 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
@@ -16,7 +16,7 @@
  * details.
  *
  * 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/.
+ * along with this file; if not, see https://www.gnu.org/licenses/.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -25,23 +25,21 @@
 
 #include <errno.h>
 #include <fcntl.h>
-#ifndef __WIN32__
-#  include <langinfo.h>
-#endif
-#include <pthread.h>
 #include <stdlib.h>
+#include <sys/stat.h>
 #include <unistd.h>
 
 #include "wimlib.h"
 #include "wimlib/assert.h"
 #include "wimlib/blob_table.h"
+#include "wimlib/cpu_features.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/threads.h"
 #include "wimlib/wim.h"
 #include "wimlib/xml.h"
 #include "wimlib/win32.h"
@@ -146,12 +144,12 @@ new_wim_struct(void)
 	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);
-	INIT_LIST_HEAD(&wim->subwims);
 	return wim;
 }
 
@@ -162,7 +160,7 @@ wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret)
 	int ret;
 	WIMStruct *wim;
 
-	ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+	ret = wimlib_global_init(0);
 	if (ret)
 		return ret;
 
@@ -176,65 +174,57 @@ wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret)
 	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  */
+	/* 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  */
+	/* Set the output compression type */
 	wim->out_compression_type = ctype;
 	wim->out_chunk_size = wim_default_nonsolid_chunk_size(ctype);
 
+	/* Allocate an empty XML info and blob table */
+	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;
+	}
+
 	*wim_ret = wim;
 	return 0;
 }
 
 static void
-destroy_image_metadata(struct wim_image_metadata *imd,
-		       struct blob_table *table,
-		       bool free_metadata_blob_descriptor)
+unload_image_metadata(struct wim_image_metadata *imd)
 {
-	free_dentry_tree(imd->root_dentry, table);
+	free_dentry_tree(imd->root_dentry, NULL);
 	imd->root_dentry = NULL;
 	free_wim_security_data(imd->security_data);
 	imd->security_data = NULL;
-
-	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);
 }
 
+/* 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, struct blob_table *table)
+put_image_metadata(struct wim_image_metadata *imd)
 {
-	if (imd && --imd->refcnt == 0) {
-		destroy_image_metadata(imd, table, true);
-		FREE(imd);
-	}
+	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
@@ -244,6 +234,12 @@ append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
 {
 	struct wim_image_metadata **imd_array;
 
+	if (!wim_has_metadata(wim))
+		return WIMLIB_ERR_METADATA_NOT_FOUND;
+
+	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));
 
@@ -254,41 +250,57 @@ append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
 	return 0;
 }
 
-struct wim_image_metadata *
-new_image_metadata(void)
+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) {
-		imd->refcnt = 1;
-		INIT_HLIST_HEAD(&imd->inode_list);
-		INIT_LIST_HEAD(&imd->unhashed_blobs);
-	}
+	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;
 }
 
-static struct wim_image_metadata **
-new_image_metadata_array(unsigned num_images)
+/* Create an image metadata structure for a new empty image.  */
+struct wim_image_metadata *
+new_empty_image_metadata(void)
 {
-	struct wim_image_metadata **imd_array;
-
-	imd_array = CALLOC(num_images, sizeof(imd_array[0]));
+	struct blob_descriptor *metadata_blob;
+	struct wim_security_data *security_data;
+	struct wim_image_metadata *imd;
 
-	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;
-		}
+	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;
 	}
-	return imd_array;
+	free_blob_descriptor(metadata_blob);
+	FREE(security_data);
+	return NULL;
 }
 
+/* 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)
+{
+	wimlib_assert(metadata_blob->blob_location == BLOB_IN_WIM);
+	return new_image_metadata(metadata_blob, NULL);
+}
 
 /*
  * Load the metadata for the specified WIM image into memory and set it
@@ -324,33 +336,39 @@ select_wim_image(WIMStruct *wim, int image)
 	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 has not been modified.  */
 	deselect_current_wim_image(wim);
-	wim->current_image = image;
-	imd = wim_get_current_image_metadata(wim);
-	if (imd->root_dentry || imd->modified) {
-		ret = 0;
-	} else {
+
+	imd = wim->image_metadata[image - 1];
+	if (!is_image_loaded(imd)) {
 		ret = read_metadata_resource(imd);
 		if (ret)
-			wim->current_image = WIMLIB_NO_IMAGE;
+			return ret;
 	}
-	return ret;
+	wim->current_image = image;
+	imd->selected_refcnt++;
+	return 0;
 }
 
+/*
+ * 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)
 {
 	struct wim_image_metadata *imd;
+
 	if (wim->current_image == WIMLIB_NO_IMAGE)
 		return;
 	imd = wim_get_current_image_metadata(wim);
-	if (!imd->modified) {
+	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));
-		destroy_image_metadata(imd, NULL, false);
+		unload_image_metadata(imd);
 	}
-	wim->current_image = WIMLIB_NO_IMAGE;
 }
 
 /*
@@ -627,11 +645,17 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
 		filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
 		wim->in_fd.is_pipe = 1;
 	} else {
+		struct stat stbuf;
+
 		wimfile = wim_filename_or_fd;
 		ret = open_wim_file(wimfile, &wim->in_fd);
 		if (ret)
 			return ret;
 
+		/* The file size is needed for enforcing some limits later. */
+		if (fstat(wim->in_fd.fd, &stbuf) == 0)
+			wim->file_size = stbuf.st_size;
+
 		/* 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
@@ -723,16 +747,20 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
 	}
 
 	if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
-		wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
+		wim->image_metadata = CALLOC(wim->hdr.image_count,
+					     sizeof(wim->image_metadata[0]));
 		if (!wim->image_metadata)
 			return WIMLIB_ERR_NOMEM;
 	}
 
 	if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
-		wim->blob_table = new_blob_table(9001);
+		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;
 
 		ret = read_wim_xml_data(wim);
 		if (ret)
@@ -760,7 +788,7 @@ open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
 	WIMStruct *wim;
 	int ret;
 
-	ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+	ret = wimlib_global_init(0);
 	if (ret)
 		return ret;
 
@@ -864,53 +892,46 @@ can_modify_wim(WIMStruct *wim)
 	return 0;
 }
 
-/* API function documented in wimlib.h  */
-WIMLIBAPI void
-wimlib_free(WIMStruct *wim)
+/* Release a reference to a WIMStruct.  If the reference count reaches 0, the
+ * WIMStruct is freed.  */
+void
+wim_decrement_refcnt(WIMStruct *wim)
 {
-	if (!wim)
+	wimlib_assert(wim->refcnt > 0);
+	if (--wim->refcnt != 0)
 		return;
-
-	while (!list_empty(&wim->subwims)) {
-		WIMStruct *subwim;
-
-		subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
-		list_del(&subwim->subwim_node);
-		wimlib_free(subwim);
-	}
-
 	if (filedes_valid(&wim->in_fd))
 		filedes_close(&wim->in_fd);
 	if (filedes_valid(&wim->out_fd))
 		filedes_close(&wim->out_fd);
-
-	free_blob_table(wim->blob_table);
-
 	wimlib_free_decompressor(wim->decompressor);
-
-	FREE(wim->filename);
 	xml_free_info_struct(wim->xml_info);
-	if (wim->image_metadata) {
-		for (unsigned i = 0; i < wim->hdr.image_count; i++)
-			put_image_metadata(wim->image_metadata[i], NULL);
-		FREE(wim->image_metadata);
-	}
+	FREE(wim->filename);
 	FREE(wim);
 }
 
-static bool
-test_locale_ctype_utf8(void)
+/* API function documented in wimlib.h  */
+WIMLIBAPI void
+wimlib_free(WIMStruct *wim)
 {
-#ifdef __WIN32__
-	return false;
-#else
-	char *ctype = nl_langinfo(CODESET);
+	if (!wim)
+		return;
 
-	return (!strstr(ctype, "UTF-8") ||
-		!strstr(ctype, "UTF8") ||
-		!strstr(ctype, "utf8") ||
-		!strstr(ctype, "utf-8"));
-#endif
+	/* 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;
+	}
+
+	wim_decrement_refcnt(wim);
 }
 
 /* API function documented in wimlib.h  */
@@ -922,8 +943,14 @@ wimlib_get_version(void)
 		WIMLIB_PATCH_VERSION;
 }
 
+WIMLIBAPI const tchar *
+wimlib_get_version_string(void)
+{
+	return T(PACKAGE_VERSION);
+}
+
 static bool lib_initialized = false;
-static pthread_mutex_t lib_initialization_mutex = PTHREAD_MUTEX_INITIALIZER;
+static struct mutex lib_initialization_mutex = MUTEX_INITIALIZER;
 
 /* API function documented in wimlib.h  */
 WIMLIBAPI int
@@ -934,15 +961,13 @@ wimlib_global_init(int init_flags)
 	if (lib_initialized)
 		goto out;
 
-	pthread_mutex_lock(&lib_initialization_mutex);
+	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 |
@@ -960,20 +985,12 @@ wimlib_global_init(int init_flags)
 			    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__
+	init_cpu_features();
+#ifdef _WIN32
 	ret = win32_global_init(init_flags);
 	if (ret)
 		goto out_unlock;
 #endif
-	iconv_global_init();
 	init_upcase();
 	if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
 		default_ignore_case = false;
@@ -982,7 +999,7 @@ wimlib_global_init(int init_flags)
 	lib_initialized = true;
 	ret = 0;
 out_unlock:
-	pthread_mutex_unlock(&lib_initialization_mutex);
+	mutex_unlock(&lib_initialization_mutex);
 out:
 	return ret;
 }
@@ -994,14 +1011,12 @@ wimlib_global_cleanup(void)
 	if (!lib_initialized)
 		return;
 
-	pthread_mutex_lock(&lib_initialization_mutex);
+	mutex_lock(&lib_initialization_mutex);
 
 	if (!lib_initialized)
 		goto out_unlock;
 
-	xml_global_cleanup();
-	iconv_global_cleanup();
-#ifdef __WIN32__
+#ifdef _WIN32
 	win32_global_cleanup();
 #endif
 
@@ -1009,5 +1024,5 @@ wimlib_global_cleanup(void)
 	lib_initialized = false;
 
 out_unlock:
-	pthread_mutex_unlock(&lib_initialization_mutex);
+	mutex_unlock(&lib_initialization_mutex);
 }