X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwim.c;h=b52a28d99c265cbf79b0ff1de3642dd9216eadc0;hp=3d6febf1ee7898a96a96a65e0941fa09bab27c2b;hb=7bde3fc590afbdef8f71cd7f8ccbd24172bffc63;hpb=a21ea64188245e4928879928eaf05e60b5065840

diff --git a/src/wim.c b/src/wim.c
index 3d6febf1..b52a28d9 100644
--- a/src/wim.c
+++ b/src/wim.c
@@ -1,9 +1,8 @@
 /*
- * wim.c
+ * wim.c - Stuff that doesn't fit into any other file
  */
 
 /*
- * Copyright (C) 2010 Carl Thijssen
  * Copyright (C) 2012 Eric Biggers
  *
  * wimlib - Library for working with WIM files
@@ -28,8 +27,11 @@
 #include <limits.h>
 #include <stdlib.h>
 #include <stdarg.h>
+#include <errno.h>
 
 #include "dentry.h"
+#include <unistd.h>
+#include <fcntl.h>
 
 #ifdef WITH_NTFS_3G
 #include <time.h>
@@ -37,12 +39,11 @@
 #endif
 
 #include "wimlib_internal.h"
-#include "io.h"
+#include "buffer_io.h"
 #include "lookup_table.h"
 #include "xml.h"
 
-
-static int print_metadata(WIMStruct *w)
+static int image_print_metadata(WIMStruct *w)
 {
 	DEBUG("Printing metadata for image %d", w->current_image);
 	print_security_data(wim_security_data(w));
@@ -51,26 +52,28 @@ static int print_metadata(WIMStruct *w)
 }
 
 
-static int print_files(WIMStruct *w)
+static int image_print_files(WIMStruct *w)
 {
 	return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
 				  NULL);
 }
 
-WIMStruct *new_wim_struct()
+static WIMStruct *new_wim_struct()
 {
 	WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
+#ifdef WITH_FUSE
 	if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
 		ERROR_WITH_ERRNO("Failed to initialize mutex");
 		FREE(w);
 		w = NULL;
 	}
+#endif
 	return w;
 
 }
 
 /*
- * Calls a function on images in the WIM.  If @image is WIM_ALL_IMAGES, @visitor
+ * 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.
@@ -82,7 +85,7 @@ int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
 	int end;
 	int i;
 
-	if (image == WIM_ALL_IMAGES) {
+	if (image == WIMLIB_ALL_IMAGES) {
 		start = 1;
 		end = w->hdr.image_count;
 	} else if (image >= 1 && image <= w->hdr.image_count) {
@@ -104,8 +107,8 @@ int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
 
 static int sort_image_metadata_by_position(const void *p1, const void *p2)
 {
-	const struct image_metadata *imd1 = p1;
-	const struct image_metadata *imd2 = p2;
+	const struct wim_image_metadata *imd1 = p1;
+	const struct wim_image_metadata *imd2 = p2;
 	u64 offset1 = imd1->metadata_lte->resource_entry.offset;
 	u64 offset2 = imd2->metadata_lte->resource_entry.offset;
 	if (offset1 < offset2)
@@ -120,7 +123,7 @@ static int sort_image_metadata_by_position(const void *p1, const void *p2)
  * 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,
+static int append_metadata_resource_entry(struct wim_lookup_table_entry *lte,
 					  void *wim_p)
 {
 	WIMStruct *w = wim_p;
@@ -128,7 +131,8 @@ static int append_metadata_resource_entry(struct lookup_table_entry *lte,
 
 	if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
 		if (w->current_image == w->hdr.image_count) {
-			ERROR("Expected only %u images, but found more",
+			ERROR("The WIM header says there are %u images in the WIM,\n"
+			      "        but we found more metadata resources than this",
 			      w->hdr.image_count);
 			ret = WIMLIB_ERR_IMAGE_COUNT;
 		} else {
@@ -144,17 +148,17 @@ static int append_metadata_resource_entry(struct lookup_table_entry *lte,
 }
 
 /* Returns the compression type given in the flags of a WIM header. */
-int wim_hdr_flags_compression_type(int wim_hdr_flags)
+static int wim_hdr_flags_compression_type(int wim_hdr_flags)
 {
 	if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
 		if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
-			return WIM_COMPRESSION_TYPE_LZX;
+			return WIMLIB_COMPRESSION_TYPE_LZX;
 		else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
-			return WIM_COMPRESSION_TYPE_XPRESS;
+			return WIMLIB_COMPRESSION_TYPE_XPRESS;
 		else
-			return WIM_COMPRESSION_TYPE_INVALID;
+			return WIMLIB_COMPRESSION_TYPE_INVALID;
 	} else {
-		return WIM_COMPRESSION_TYPE_NONE;
+		return WIMLIB_COMPRESSION_TYPE_NONE;
 	}
 }
 
@@ -164,7 +168,7 @@ int wim_hdr_flags_compression_type(int wim_hdr_flags)
 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
 {
 	WIMStruct *w;
-	struct lookup_table *table;
+	struct wim_lookup_table *table;
 	int ret;
 
 	DEBUG("Creating new WIM with %s compression.",
@@ -199,10 +203,15 @@ WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
 
 int select_wim_image(WIMStruct *w, int image)
 {
-	struct image_metadata *imd;
+	struct wim_image_metadata *imd;
 
 	DEBUG("Selecting image %d", image);
 
+	if (image == WIMLIB_NO_IMAGE) {
+		ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
+		return WIMLIB_ERR_INVALID_IMAGE;
+	}
+
 	if (image == w->current_image)
 		return 0;
 
@@ -212,16 +221,16 @@ int select_wim_image(WIMStruct *w, int image)
 		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 != WIM_NO_IMAGE) {
+	if (w->current_image != WIMLIB_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;
+			INIT_HLIST_HEAD(&imd->inode_list);
 		}
 	}
 
@@ -250,11 +259,11 @@ WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
 {
 	switch (ctype) {
-		case WIM_COMPRESSION_TYPE_NONE:
+		case WIMLIB_COMPRESSION_TYPE_NONE:
 			return "None";
-		case WIM_COMPRESSION_TYPE_LZX:
+		case WIMLIB_COMPRESSION_TYPE_LZX:
 			return "LZX";
-		case WIM_COMPRESSION_TYPE_XPRESS:
+		case WIMLIB_COMPRESSION_TYPE_XPRESS:
 			return "XPRESS";
 		default:
 			return "Invalid";
@@ -272,16 +281,16 @@ WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
 	int 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
 	    || strcmp(image_name_or_num, "*") == 0)
-		return WIM_ALL_IMAGES;
+		return WIMLIB_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 (p != image_name_or_num && *p == '\0' && image > 0) {
+		if (image > w->hdr.image_count)
+			return WIMLIB_NO_IMAGE;
 		return image;
 	} else {
 		for (i = 1; i <= w->hdr.image_count; i++) {
@@ -289,7 +298,7 @@ WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
 				   wimlib_get_image_name(w, i)) == 0)
 				return i;
 		}
-		return WIM_NO_IMAGE;
+		return WIMLIB_NO_IMAGE;
 	}
 }
 
@@ -313,7 +322,7 @@ WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
 	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");
+	printf("Integrity Info: %s\n", (w->hdr.integrity.offset != 0) ? "yes" : "no");
 	putchar('\n');
 }
 
@@ -328,7 +337,7 @@ WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
 	int last;
 	int i;
 	int n;
-	if (image == WIM_ALL_IMAGES) {
+	if (image == WIMLIB_ALL_IMAGES) {
 		n = printf("Available Images:\n");
 		first = 1;
 		last = w->hdr.image_count;
@@ -349,39 +358,33 @@ WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
 }
 
 
-/* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
- * not WIM_NO_IMAGE. */
+/* 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)
-		return WIMLIB_ERR_INVALID_PARAM;
 	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, print_metadata);
+	return for_image(w, image, image_print_metadata);
 }
 
 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
 {
-	if (!w)
-		return WIMLIB_ERR_INVALID_PARAM;
 	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, print_files);
+	return for_image(w, image, image_print_files);
 }
 
 /* Sets the index of the bootable image. */
 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
 {
-	if (!w)
-		return WIMLIB_ERR_INVALID_PARAM;
 	if (w->hdr.total_parts != 1) {
 		ERROR("Cannot modify the boot index of a split WIM!");
 		return WIMLIB_ERR_SPLIT_UNSUPPORTED;
@@ -389,6 +392,17 @@ WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
 	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));
+	}
+
 	return 0;
 }
 
@@ -409,32 +423,44 @@ WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
  * Begins the reading of a WIM file; opens the file and reads its header and
  * lookup table, and optionally checks the integrity.
  */
-static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
+static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
+		      wimlib_progress_func_t progress_func)
 {
 	int ret;
-	uint xml_num_images;
+	int xml_num_images;
 
 	DEBUG("Reading the WIM file `%s'", in_wim_path);
 
-	w->filename = realpath(in_wim_path, NULL);
-	if (!w->filename) {
-		ERROR("Failed to allocate memory for WIM filename");
-		return WIMLIB_ERR_NOMEM;
-	}
-
 	w->fp = fopen(in_wim_path, "rb");
-
 	if (!w->fp) {
-		ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
+		ERROR_WITH_ERRNO("Failed to open `%s' for reading",
 				 in_wim_path);
 		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...
+	 */
+	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;
+	}
+
 	ret = read_header(w->fp, &w->hdr, open_flags);
 	if (ret != 0)
 		return ret;
 
-	DEBUG("Wim file contains %u images", w->hdr.image_count);
+	DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
 
 	/* If the boot index is invalid, print a warning and set it to 0 */
 	if (w->hdr.boot_idx > w->hdr.image_count) {
@@ -444,46 +470,38 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
 		w->hdr.boot_idx = 0;
 	}
 
-	if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
-		ERROR("Invalid compression type (WIM header flags = %x)",
+	if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
+		ERROR("Invalid compression type (WIM header flags = 0x%x)",
 		      w->hdr.flags);
 		return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
 	}
 
-
 	if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
-		int integrity_status;
-		ret = check_wim_integrity(w,
-					  open_flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
-					  &integrity_status);
-		if (ret != 0)
-			return ret;
-		if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
+		ret = check_wim_integrity(w, progress_func);
+		if (ret == WIM_INTEGRITY_NONEXISTENT) {
 			WARNING("No integrity information for `%s'; skipping "
-				"integrity check.", w->filename);
-		} else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
+				"integrity check.", in_wim_path);
+		} 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 (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;
-	}
-
 	ret = read_lookup_table(w);
 	if (ret != 0)
 		return ret;
 
-	w->image_metadata = CALLOC(w->hdr.image_count,
-				   sizeof(struct image_metadata));
+	if (w->hdr.image_count != 0) {
+		w->image_metadata = CALLOC(w->hdr.image_count,
+					   sizeof(struct wim_image_metadata));
 
-	if (!w->image_metadata) {
-		ERROR("Failed to allocate memory for %u metadata structures",
-		      w->hdr.image_count);
-		return WIMLIB_ERR_NOMEM;
+		if (!w->image_metadata) {
+			ERROR("Failed to allocate memory for %u image metadata structures",
+			      w->hdr.image_count);
+			return WIMLIB_ERR_NOMEM;
+		}
 	}
 	w->current_image = 0;
 
@@ -497,33 +515,30 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
 		return ret;
 
 	/* Make sure all the expected images were found.  (We already have
-	 * returned false if *extra* images were found) */
+	 * returned WIMLIB_ERR_IMAGE_COUNT 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",
+		ERROR("Only found %d images in WIM, but expected %u",
 		      w->current_image, w->hdr.image_count);
 		return WIMLIB_ERR_IMAGE_COUNT;
 	}
 
-
 	/* 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);
+	      sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
 
-	w->current_image = WIM_NO_IMAGE;
+	w->current_image = WIMLIB_NO_IMAGE;
 
 	/* Read the XML data. */
 	ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
 			    &w->xml_data, &w->wim_info);
 
-	if (ret != 0) {
-		ERROR("Missing or invalid XML data");
+	if (ret != 0)
 		return ret;
-	}
 
 	xml_num_images = wim_info_get_num_images(w->wim_info);
 	if (xml_num_images != w->hdr.image_count) {
@@ -543,28 +558,41 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
  * Opens a WIM file and creates a WIMStruct for it.
  */
 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
-			      WIMStruct **w_ret)
+			      WIMStruct **w_ret,
+			      wimlib_progress_func_t progress_func)
 {
 	WIMStruct *w;
 	int ret;
 
-	DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
+	if (!wim_file || !w_ret)
+		return WIMLIB_ERR_INVALID_PARAM;
+
 	w = new_wim_struct();
-	if (!w) {
-		ERROR("Failed to allocate memory for WIMStruct");
+	if (!w)
 		return WIMLIB_ERR_NOMEM;
-	}
 
-	ret = begin_read(w, wim_file, open_flags);
-	if (ret == 0) {
+	ret = begin_read(w, wim_file, open_flags, progress_func);
+	if (ret == 0)
 		*w_ret = w;
-	} else {
-		DEBUG("Could not begin reading the WIM file `%s'", wim_file);
+	else
 		wimlib_free(w);
-	}
 	return ret;
 }
 
+void destroy_image_metadata(struct wim_image_metadata *imd,
+			    struct wim_lookup_table *table)
+{
+	free_dentry_tree(imd->root_dentry, table);
+	free_security_data(imd->security_data);
+
+	/* Get rid of the lookup table entry for this image's metadata resource
+	 * */
+	if (table) {
+		lookup_table_unlink(table, imd->metadata_lte);
+		free_lookup_table_entry(imd->metadata_lte);
+	}
+}
+
 /* Frees the memory for the WIMStruct, including all internal memory; also
  * closes all files associated with the WIMStruct.  */
 WIMLIBAPI void wimlib_free(WIMStruct *w)
@@ -578,6 +606,7 @@ WIMLIBAPI void wimlib_free(WIMStruct *w)
 	if (w->out_fp)
 		fclose(w->out_fp);
 
+#ifdef WITH_FUSE
 	if (w->fp_tab) {
 		for (size_t i = 0; i < w->num_allocated_fps; i++)
 			if (w->fp_tab[i])
@@ -585,6 +614,7 @@ WIMLIBAPI void wimlib_free(WIMStruct *w)
 		FREE(w->fp_tab);
 	}
 	pthread_mutex_destroy(&w->fp_tab_mutex);
+#endif
 
 	free_lookup_table(w->lookup_table);
 
@@ -592,7 +622,7 @@ WIMLIBAPI void wimlib_free(WIMStruct *w)
 	FREE(w->xml_data);
 	free_wim_info(w->wim_info);
 	if (w->image_metadata) {
-		for (uint i = 0; i < w->hdr.image_count; i++)
+		for (unsigned i = 0; i < w->hdr.image_count; i++)
 			destroy_image_metadata(&w->image_metadata[i], NULL);
 		FREE(w->image_metadata);
 	}
@@ -605,3 +635,18 @@ WIMLIBAPI void wimlib_free(WIMStruct *w)
 	FREE(w);
 }
 
+/* Get global memory allocations out of the way.  Not strictly necessary in
+ * single-threaded programs like 'imagex'. */
+WIMLIBAPI int wimlib_global_init()
+{
+	libxml_global_init();
+	return iconv_global_init();
+}
+
+/* Free global memory allocations.  Not strictly necessary if the process using
+ * wimlib is just about to exit (as is the case for 'imagex'). */
+WIMLIBAPI void wimlib_global_cleanup()
+{
+	libxml_global_cleanup();
+	iconv_global_cleanup();
+}