X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwim.c;h=6262a1b757646966d3db737180665d505f93ff72;hp=99a8c70072e89c1f1a6b563bc88ba229f09ed7cf;hb=9fb3aaca115429b0af2a623bf20bfceef74f047f;hpb=6b48d458662451251f506fcf7e275b4250a31cd0 diff --git a/src/wim.c b/src/wim.c index 99a8c700..6262a1b7 100644 --- a/src/wim.c +++ b/src/wim.c @@ -1,103 +1,127 @@ /* - * wim.c + * wim.c - Stuff that doesn't fit into any other file */ /* - * Copyright (C) 2010 Carl Thijssen - * Copyright (C) 2012 Eric Biggers + * Copyright (C) 2012, 2013 Eric Biggers * - * wimlib - Library for working with WIM files + * wimlib - Library for working with WIM files * * 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) + * 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 Lesser General Public License for more + * A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * - * You should have received a copy of the GNU Lesser General Public License + * You should have received a copy of the GNU General Public License * along with wimlib; if not, see http://www.gnu.org/licenses/. */ -#include "wimlib_internal.h" -#include "io.h" +#include "config.h" + +#include +#include +#include +#include +#include +#include + +#ifdef WITH_NTFS_3G +# include +# include +#endif + +#ifdef __WIN32__ +# include "win32.h" +#else +# include +#endif + +#include "buffer_io.h" +#include "dentry.h" #include "lookup_table.h" +#include "wimlib_internal.h" #include "xml.h" -#include -static int print_metadata(WIMStruct *w) +static int +image_print_metadata(WIMStruct *w) { -#ifdef ENABLE_SECURITY_DATA + DEBUG("Printing metadata for image %d", w->current_image); print_security_data(wim_security_data(w)); -#endif - return for_dentry_in_tree(wim_root_dentry(w), print_dentry, + return for_dentry_in_tree(wim_root_dentry(w), print_dentry, w->lookup_table); } -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, + 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; - - w = CALLOC(1, sizeof(WIMStruct)); - if (!w) - return NULL; - w->link_type = WIM_LINK_TYPE_NONE; - w->current_image = WIM_NO_IMAGE; + 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. */ -int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *)) +int +for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *)) { - int ret = 0; + int ret; + int start; + int end; int i; - int image_count; - - DEBUG("for_image(w = %p, image = %d, visitor = %p)\n", - w, image, visitor); - - if (image == WIM_ALL_IMAGES) { - image_count = w->hdr.image_count; - for (i = 1; i <= image_count; i++) { - ret = wimlib_select_image(w, i); - if (ret != 0) - return ret; - ret = visitor(w); - if (ret != 0) - return ret; - } + + 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 { - ret = wimlib_select_image(w, image); + 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; } - return ret; + return 0; } -static int sort_image_metadata_by_position(const void *p1, const void *p2) +static int +sort_image_metadata_by_position(const void *p1, const void *p2) { - struct image_metadata *bmd1 = (struct image_metadata*)p1; - struct image_metadata *bmd2 = (struct image_metadata*)p2; - u64 offset1 = bmd1->lookup_table_entry->resource_entry.offset; - u64 offset2 = bmd2->lookup_table_entry->resource_entry.offset; + 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) return -1; else if (offset1 > offset2) @@ -106,71 +130,62 @@ static int sort_image_metadata_by_position(const void *p1, const void *p2) return 0; } -/* +/* * If @lte points to a metadata resource, append it to the list of metadata - * resources in the WIMStruct. + * resources in the WIMStruct. Otherwise, do nothing. */ -static int append_metadata_resource_entry(struct lookup_table_entry *lte, - void *wim_p) +static int +append_metadata_resource_entry(struct wim_lookup_table_entry *lte, void *wim_p) { WIMStruct *w = wim_p; + int ret = 0; 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!\n", - w->hdr.image_count); - return WIMLIB_ERR_IMAGE_COUNT; + 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 { DEBUG("Found metadata resource for image %u at " - "offset %"PRIu64"\n", w->current_image + 1, - lte->resource_entry.offset); + "offset %"PRIu64".", + w->current_image + 1, + lte->resource_entry.offset); w->image_metadata[ - w->current_image++].lookup_table_entry = lte; + w->current_image++].metadata_lte = lte; } } - - /* Do nothing if not a metadata resource. */ - return 0; + return ret; } /* 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; } } -int wim_resource_compression_type(const WIMStruct *w, - const struct resource_entry *entry) -{ - int wim_ctype = wimlib_get_compression_type(w); - return resource_compression_type(wim_ctype, entry->flags); -} - -WIMLIBAPI void wimlib_set_verbose(WIMStruct *w, bool verbose) -{ - w->verbose = verbose; -} - /* * Creates a WIMStruct for a new WIM file. */ -WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret) +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\n", - wimlib_get_compression_type_string(ctype)); + DEBUG("Creating new WIM with %s compression.", + wimlib_get_compression_type_string(ctype)); /* Allocate the WIMStruct. */ w = new_wim_struct(); @@ -179,89 +194,95 @@ WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret) ret = init_header(&w->hdr, ctype); if (ret != 0) - goto err; + goto out_free; table = new_lookup_table(9001); if (!table) { ret = WIMLIB_ERR_NOMEM; - goto err; + goto out_free; } w->lookup_table = table; *w_ret = w; return 0; -err: +out_free: FREE(w); return ret; } -WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w) +WIMLIBAPI int +wimlib_get_num_images(const WIMStruct *w) { return w->hdr.image_count; } -int wimlib_select_image(WIMStruct *w, int image) +int +select_wim_image(WIMStruct *w, int image) { - DEBUG("Selecting image %u\n", image); + struct wim_image_metadata *imd; + int ret; - if (image == w->current_image) - return 0; + DEBUG("Selecting image %d", image); - if (image > w->hdr.image_count || image < 1) { - ERROR("Cannot select image %u: There are only %u images!\n", - image, w->hdr.image_count); + if (image == WIMLIB_NO_IMAGE) { + ERROR("Invalid image: %d", WIMLIB_NO_IMAGE); return WIMLIB_ERR_INVALID_IMAGE; } + if (image == w->current_image) + return 0; - /* If a valid image is selected, it can be freed if it is not modified. - * */ - if (w->current_image != WIM_NO_IMAGE && - !wim_current_image_is_modified(w)) { - - struct image_metadata *imd; + if (image < 1 || image > w->hdr.image_count) { + ERROR("Cannot select image %d: There are only %u images", + image, w->hdr.image_count); + return WIMLIB_ERR_INVALID_IMAGE; + } - DEBUG("Freeing image %u\n", w->current_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); - free_dentry_tree(imd->root_dentry, NULL, false); - imd->root_dentry = NULL; -#ifdef ENABLE_SECURITY_DATA - free_security_data(imd->security_data); - imd->security_data = NULL; -#endif + 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); + } } - w->current_image = image; - - if (wim_root_dentry(w)) { - return 0; + imd = &w->image_metadata[image - 1]; + if (imd->root_dentry) { + ret = 0; } else { #ifdef ENABLE_DEBUG DEBUG("Reading metadata resource specified by the following " - "lookup table entry:\n"); - print_lookup_table_entry(wim_metadata_lookup_table_entry(w), NULL); + "lookup table entry:"); + print_lookup_table_entry(imd->metadata_lte, stdout); #endif - return read_metadata_resource(w->fp, - wim_metadata_resource_entry(w), - wimlib_get_compression_type(w), - wim_get_current_image_metadata(w)); + ret = read_metadata_resource(w, imd); + if (ret) + w->current_image = WIMLIB_NO_IMAGE; } + return ret; } /* Returns the compression type of the WIM file. */ -WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w) +WIMLIBAPI int +wimlib_get_compression_type(const WIMStruct *w) { return wim_hdr_flags_compression_type(w->hdr.flags); } -WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype) +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"; @@ -273,38 +294,41 @@ WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype) * the number of the image, or the name of the image. The images are numbered * starting at 1. */ -WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num) +WIMLIBAPI int +wimlib_resolve_image(WIMStruct *w, const utf8char *image_name_or_num) { char *p; 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) - return WIM_ALL_IMAGES; - image = strtoul(image_name_or_num, &p, 10); - if (*p == '\0') { - if (image < 1 || image > w->hdr.image_count) - return WIM_NO_IMAGE; + if (strcmp(image_name_or_num, "all") == 0 + || strcmp(image_name_or_num, "*") == 0) + return WIMLIB_ALL_IMAGES; + image = strtol(image_name_or_num, &p, 10); + 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++) { - if (strcmp(image_name_or_num, - wimlib_get_image_name(w, i)) == 0) + if (strcmp(image_name_or_num, + wimlib_get_image_name(w, i)) == 0) 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) +WIMLIBAPI void +wimlib_print_wim_information(const WIMStruct *w) { const struct wim_header *hdr; - + hdr = &w->hdr; puts("WIM Information:"); puts("----------------"); @@ -317,256 +341,297 @@ WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w) 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", + 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'); } -WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w) +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) +WIMLIBAPI void +wimlib_print_available_images(const WIMStruct *w, int image) { - if (image == WIM_ALL_IMAGES) { - puts("Available Images:"); - puts("-----------------"); - } else { - int n; - int i; - + int first; + int last; + int i; + int n; + if (image == WIMLIB_ALL_IMAGES) { + n = printf("Available Images:\n"); + first = 1; + last = w->hdr.image_count; + } else if (image >= 1 && image <= w->hdr.image_count) { n = printf("Information for Image %d\n", image); - for (i = 0; i < n - 1; i++) - putchar('-'); - putchar('\n'); - + first = image; + last = image; + } else { + printf("wimlib_print_available_images(): Invalid image %d", + image); + return; } - print_image_info(w->wim_info, image); + for (i = 0; i < n - 1; i++) + putchar('-'); + putchar('\n'); + for (i = first; i <= last; i++) + print_image_info(w->wim_info, i); } -/* 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) +/* 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) { - return for_image(w, image, print_metadata); + 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) +WIMLIBAPI int +wimlib_print_files(WIMStruct *w, int image) { - return for_image(w, image, print_files); + 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); } /* Sets the index of the bootable image. */ -WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx) +WIMLIBAPI int +wimlib_set_boot_idx(WIMStruct *w, int boot_idx) { + if (w->hdr.total_parts != 1) { + ERROR("Cannot modify the boot index of a split WIM!"); + return WIMLIB_ERR_SPLIT_UNSUPPORTED; + } 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, + 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].lookup_table_entry-> - resource_entry, + &w->image_metadata[ + boot_idx - 1].metadata_lte->resource_entry, sizeof(struct resource_entry)); } + return 0; } -WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret) +WIMLIBAPI int +wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret) { if (total_parts_ret) *total_parts_ret = w->hdr.total_parts; return w->hdr.part_number; } - -WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w) + +WIMLIBAPI int +wimlib_get_boot_idx(const WIMStruct *w) { return w->hdr.boot_idx; } -/* +/* * 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 flags) +static int +begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags, + wimlib_progress_func_t progress_func) { int ret; - uint xml_num_images; - int integrity_status; - - DEBUG("Reading the WIM file `%s'\n", in_wim_path); + int xml_num_images; - w->filename = STRDUP(in_wim_path); - if (!w->filename) { - ERROR("Failed to allocate memory for WIM filename.\n"); - return WIMLIB_ERR_NOMEM; - } + DEBUG("Reading the WIM file `%s'", in_wim_path); w->fp = fopen(in_wim_path, "rb"); - if (!w->fp) { - ERROR("Failed to open the file \"%s\" for reading: %m\n", - in_wim_path); - ret = WIMLIB_ERR_OPEN; - goto done; + 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... + * + * 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; } - ret = read_header(w->fp, &w->hdr, flags & WIMLIB_OPEN_FLAG_SPLIT_OK); + ret = read_header(w->fp, &w->hdr, open_flags); if (ret != 0) - goto done; + return ret; - DEBUG("Wim file contains %u images\n", 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) { - WARNING("In `%s', image %u is marked as bootable,\n" - "\tbut there are only %u images!\n", - in_wim_path, w->hdr.boot_idx, w->hdr.image_count); + WARNING("In `%s', 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 (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) { - ERROR("Invalid compression type (WIM header flags " - "= %x)\n", w->hdr.flags); - ret = WIMLIB_ERR_INVALID_COMPRESSION_TYPE; - goto done; + 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 (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) { - ret = check_wim_integrity(w, - flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS, - &integrity_status); - if (ret != 0) { - ERROR("Error in check_wim_integrity()\n"); - goto done; - } - if (integrity_status == WIM_INTEGRITY_NONEXISTENT) { + if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) { + ret = check_wim_integrity(w, progress_func); + if (ret == WIM_INTEGRITY_NONEXISTENT) { WARNING("No integrity information for `%s'; skipping " - "integrity check.\n", w->filename); - } else if (integrity_status == WIM_INTEGRITY_NOT_OK) { - ERROR("WIM is not intact! (Failed integrity check)\n"); - ret = WIMLIB_ERR_INTEGRITY; - goto done; + "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!\n"); - ERROR("Ask the author to implement support for this.\n"); - ret = WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE; - goto done; - } - - ret = read_lookup_table(w->fp, w->hdr.lookup_table_res_entry.offset, - w->hdr.lookup_table_res_entry.size, - &w->lookup_table); - + ret = read_lookup_table(w); if (ret != 0) - goto done; + 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\n", - w->hdr.image_count); - goto done; + 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; - DEBUG("Looking for metadata resources in the lookup table.\n"); + DEBUG("Looking for metadata resources in the lookup table."); /* Find the images in the WIM by searching the lookup table. */ - ret = for_lookup_table_entry(w->lookup_table, + ret = for_lookup_table_entry(w->lookup_table, append_metadata_resource_entry, w); - if (ret != 0 && w->hdr.part_number == 1) - goto done; + if (ret != 0) + 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!\n", - w->current_image, w->hdr.image_count); - ret = WIMLIB_ERR_IMAGE_COUNT; - goto done; + * 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 %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 may be - * random because of hashing. */ + * 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, + 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\n"); - goto done; - } + if (ret != 0) + 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 `%s', there are %u elements " - "in the XML data,\n", in_wim_path, - xml_num_images); - ERROR("but %u images in the WIM! There must be " - "exactly one element per image.\n", - w->hdr.image_count); - ret = WIMLIB_ERR_IMAGE_COUNT; - goto done; + "in the XML data,", in_wim_path, xml_num_images); + ERROR("but %u images in the WIM! There must be exactly one " + " element per image.", w->hdr.image_count); + return WIMLIB_ERR_IMAGE_COUNT; } - DEBUG("Done beginning read of WIM file.\n"); - ret = 0; -done: - return ret; + DEBUG("Done beginning read of WIM file `%s'.", in_wim_path); + return 0; } - /* * Opens a WIM file and creates a WIMStruct for it. */ -WIMLIBAPI int wimlib_open_wim(const char *wim_file, int flags, - WIMStruct **w_ret) +WIMLIBAPI int +wimlib_open_wim(const mbchar *wim_file, int open_flags, + WIMStruct **w_ret, + wimlib_progress_func_t progress_func) { WIMStruct *w; int ret; - DEBUG("wim_file = `%s', flags = %d\n", wim_file, flags); + if (!wim_file || !w_ret) + return WIMLIB_ERR_INVALID_PARAM; + w = new_wim_struct(); if (!w) return WIMLIB_ERR_NOMEM; - ret = begin_read(w, wim_file, flags); - if (ret != 0) { - ERROR("Could not begin reading the WIM file `%s'\n", wim_file); - FREE(w); - return ret; + ret = begin_read(w, wim_file, open_flags, progress_func); + if (ret == 0) + *w_ret = w; + 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); } - *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) +WIMLIBAPI void +wimlib_free(WIMStruct *w) { - uint i; + DEBUG("Freeing WIMStruct"); if (!w) return; @@ -575,22 +640,66 @@ 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]) + fclose(w->fp_tab[i]); + FREE(w->fp_tab); + } + pthread_mutex_destroy(&w->fp_tab_mutex); +#endif + free_lookup_table(w->lookup_table); FREE(w->filename); - FREE(w->output_dir); FREE(w->xml_data); free_wim_info(w->wim_info); if (w->image_metadata) { - for (i = 0; i < w->hdr.image_count; i++) { - free_dentry_tree(w->image_metadata[i].root_dentry, - NULL, false); - #ifdef ENABLE_SECURITY_DATA - free_security_data(w->image_metadata[i].security_data); - #endif - } + for (unsigned i = 0; i < w->hdr.image_count; i++) + destroy_image_metadata(&w->image_metadata[i], NULL); FREE(w->image_metadata); } +#ifdef WITH_NTFS_3G + if (w->ntfs_vol) { + DEBUG("Unmounting NTFS volume"); + ntfs_umount(w->ntfs_vol, FALSE); + } +#endif FREE(w); + DEBUG("Freed WIMStruct"); +} + +static bool test_locale_ctype_utf8() +{ + char *ctype = nl_langinfo(CODESET); + + return (strstr(ctype, "UTF-8") == 0 || + strstr(ctype, "UTF8") == 0 || + strstr(ctype, "utf8") == 0 || + strstr(ctype, "utf-8") == 0); } +bool wimlib_mbs_is_utf8; + +/* 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(); +#ifdef WITH_NTFS_3G + libntfs3g_global_init(); +#endif + wimlib_mbs_is_utf8 = test_locale_ctype_utf8(); + return 0; +} + +/* 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(); +}