X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwim.c;h=8422d9e10b3d5b9dec5442317106b84f48930a75;hp=e1cda332488c76d34284e51301c3f47465707e99;hb=69f07a55f05919a15ff1ec77b963b48f5f6a5d04;hpb=6b8d739e7c68237499366546eb41bc4cb3fff9d4 diff --git a/src/wim.c b/src/wim.c index e1cda332..8422d9e1 100644 --- a/src/wim.c +++ b/src/wim.c @@ -1,31 +1,29 @@ /* - * wim.c - Stuff that doesn't fit into any other file + * wim.c - High-level code dealing with WIMStructs and images. */ /* - * Copyright (C) 2012, 2013 Eric Biggers + * Copyright (C) 2012, 2013, 2014 Eric Biggers * - * This file is part of wimlib, a library for working with WIM files. + * This file is free software; you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation; either version 3 of the License, or (at your option) any + * later version. * - * wimlib is free software; you can redistribute it and/or modify it under the - * terms of the GNU General Public License as published by the Free - * Software Foundation; either version 3 of the License, or (at your option) - * any later version. - * - * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY - * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - * A PARTICULAR PURPOSE. See the GNU General Public License for more + * This file is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. * - * You should have received a copy of the GNU General Public License - * along with wimlib; if not, see http://www.gnu.org/licenses/. + * You should have received a copy of the GNU Lesser General Public License + * along with this file; if not, see http://www.gnu.org/licenses/. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif -#include "wimlib/error.h" +#include "wimlib.h" #include "wimlib/dentry.h" #include "wimlib/encoding.h" #include "wimlib/file_io.h" @@ -38,6 +36,7 @@ #include "wimlib/security.h" #include "wimlib/wim.h" #include "wimlib/xml.h" +#include "wimlib/version.h" #ifdef __WIN32__ # include "wimlib/win32.h" /* for realpath() replacement */ @@ -48,38 +47,107 @@ #ifndef __WIN32__ # include #endif -#include -#include #include #include static int -image_print_metadata(WIMStruct *wim) +wim_default_pack_compression_type(void) { - DEBUG("Printing metadata for image %d", wim->current_image); - print_wim_security_data(wim_security_data(wim)); - return for_dentry_in_tree(wim_root_dentry(wim), print_dentry, - wim->lookup_table); + return WIMLIB_COMPRESSION_TYPE_LZMS; } +static u32 +wim_default_pack_chunk_size(int ctype) { + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_LZMS: + return 1U << 25; /* 33554432 */ + default: + return 1U << 15; /* 32768 */ + } +} static WIMStruct * new_wim_struct(void) { WIMStruct *wim = CALLOC(1, sizeof(WIMStruct)); - if (wim) { - wim->in_fd.fd = -1; - wim->out_fd.fd = -1; - INIT_LIST_HEAD(&wim->subwims); - } + if (!wim) + return NULL; + + filedes_invalidate(&wim->in_fd); + filedes_invalidate(&wim->out_fd); + wim->out_pack_compression_type = wim_default_pack_compression_type(); + wim->out_pack_chunk_size = wim_default_pack_chunk_size( + wim->out_pack_compression_type); + INIT_LIST_HEAD(&wim->subwims); return wim; } +/* Determine if the chunk size is valid for the specified compression type. */ +static bool +wim_chunk_size_valid(u32 chunk_size, int ctype) +{ + u32 order; + + /* Chunk size is meaningless for uncompressed WIMs --- any value is + * okay. */ + if (ctype == WIMLIB_COMPRESSION_TYPE_NONE) + return true; + + /* Chunk size must be power of 2. */ + if (chunk_size == 0) + return false; + order = bsr32(chunk_size); + if (chunk_size != 1U << order) + return false; + + /* Order Size + * ===== ==== + * 15 32768 + * 16 65536 + * 17 131072 + * 18 262144 + * 19 524288 + * 20 1048576 + * 21 2097152 + * 22 4194304 + * 23 8388608 + * 24 16777216 + * 25 33554432 + * 26 67108864 + */ + + /* See the documentation for the --chunk-size option of `wimlib-imagex + * capture' for information about allowed chunk sizes. */ + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_LZX: + return order >= 15 && order <= 21; + case WIMLIB_COMPRESSION_TYPE_XPRESS: + return order >= 12 && order <= 16; + case WIMLIB_COMPRESSION_TYPE_LZMS: + return order >= 15 && order <= 30; + } + return false; +} + +/* Return the default chunk size to use for the specified compression type. + * + * See notes above in wim_chunk_size_valid(). */ +static u32 +wim_default_chunk_size(int ctype) +{ + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_LZMS: + return 1U << 17; /* 131072 */ + default: + return 1U << 15; /* 32768 */ + } +} + /* - * 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. + * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, + * @visitor is called on the WIM once for each image, with each image selected + * as the current image in turn. If @image is a certain image, @visitor is + * called on the WIM only once, with that image selected. */ int for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *)) @@ -117,71 +185,168 @@ wimlib_create_new_wim(int ctype, WIMStruct **wim_ret) struct wim_lookup_table *table; int ret; - wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8); - - DEBUG("Creating new WIM with %"TS" compression.", - wimlib_get_compression_type_string(ctype)); + ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8); + if (ret) + return ret; - /* Allocate the WIMStruct. */ wim = new_wim_struct(); if (!wim) return WIMLIB_ERR_NOMEM; - ret = init_wim_header(&wim->hdr, ctype); - if (ret != 0) - goto out_free; + ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype)); + if (ret) + goto out_free_wim; table = new_lookup_table(9001); if (!table) { ret = WIMLIB_ERR_NOMEM; - goto out_free; + goto out_free_wim; } wim->lookup_table = table; - wim->refcnts_ok = 1; wim->compression_type = ctype; + wim->out_compression_type = ctype; + wim->chunk_size = wim->hdr.chunk_size; + wim->out_chunk_size = wim->hdr.chunk_size; *wim_ret = wim; return 0; -out_free: + +out_free_wim: FREE(wim); return ret; } +static void +destroy_image_metadata(struct wim_image_metadata *imd, + struct wim_lookup_table *table, + bool free_metadata_lte) +{ + free_dentry_tree(imd->root_dentry, table); + imd->root_dentry = NULL; + free_wim_security_data(imd->security_data); + imd->security_data = NULL; + + if (free_metadata_lte) { + free_lookup_table_entry(imd->metadata_lte); + imd->metadata_lte = NULL; + } + if (!table) { + struct wim_lookup_table_entry *lte, *tmp; + list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list) + free_lookup_table_entry(lte); + } + INIT_LIST_HEAD(&imd->unhashed_streams); + INIT_LIST_HEAD(&imd->inode_list); +#ifdef WITH_NTFS_3G + if (imd->ntfs_vol) { + do_ntfs_umount(imd->ntfs_vol); + imd->ntfs_vol = NULL; + } +#endif +} + +void +put_image_metadata(struct wim_image_metadata *imd, + struct wim_lookup_table *table) +{ + if (imd && --imd->refcnt == 0) { + destroy_image_metadata(imd, table, true); + FREE(imd); + } +} + +/* Appends the specified image metadata structure to the array of image metadata + * for a WIM, and increments the image count. */ +int +append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd) +{ + struct wim_image_metadata **imd_array; + + imd_array = REALLOC(wim->image_metadata, + sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1)); + + if (!imd_array) + return WIMLIB_ERR_NOMEM; + wim->image_metadata = imd_array; + imd_array[wim->hdr.image_count++] = imd; + return 0; +} + +struct wim_image_metadata * +new_image_metadata(void) +{ + struct wim_image_metadata *imd; + + imd = CALLOC(1, sizeof(*imd)); + if (imd) { + imd->refcnt = 1; + INIT_LIST_HEAD(&imd->inode_list); + INIT_LIST_HEAD(&imd->unhashed_streams); + } + return imd; +} + +static struct wim_image_metadata ** +new_image_metadata_array(unsigned num_images) +{ + struct wim_image_metadata **imd_array; + + imd_array = CALLOC(num_images, sizeof(imd_array[0])); + + if (!imd_array) + return NULL; + for (unsigned i = 0; i < num_images; i++) { + imd_array[i] = new_image_metadata(); + if (unlikely(!imd_array[i])) { + for (unsigned j = 0; j < i; j++) + put_image_metadata(imd_array[j], NULL); + FREE(imd_array); + return NULL; + } + } + return imd_array; +} + + +/* + * Load the metadata for the specified WIM image into memory and set it + * as the WIMStruct's currently selected image. + * + * @wim + * The WIMStruct for the WIM. + * @image + * The 1-based index of the image in the WIM to select. + * + * On success, 0 will be returned, wim->current_image will be set to + * @image, and wim_get_current_image_metadata() can be used to retrieve + * metadata information for the image. + * + * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND, + * or another error code will be returned. + */ int select_wim_image(WIMStruct *wim, int image) { struct wim_image_metadata *imd; int ret; - DEBUG("Selecting image %d", image); - - if (image == WIMLIB_NO_IMAGE) { - ERROR("Invalid image: %d", WIMLIB_NO_IMAGE); + if (image == WIMLIB_NO_IMAGE) return WIMLIB_ERR_INVALID_IMAGE; - } if (image == wim->current_image) return 0; - if (image < 1 || image > wim->hdr.image_count) { - ERROR("Cannot select image %d: There are only %u images", - image, wim->hdr.image_count); + if (image < 1 || image > wim->hdr.image_count) return WIMLIB_ERR_INVALID_IMAGE; - } - if (!wim_has_metadata(wim)) { - ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename); - if (wim->hdr.part_number != 1) - ERROR("Specify the first part of the split WIM instead."); + 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 a valid image is currently selected, its metadata can be freed if + * it has not been modified. */ if (wim->current_image != WIMLIB_NO_IMAGE) { imd = wim_get_current_image_metadata(wim); if (!imd->modified) { wimlib_assert(list_empty(&imd->unhashed_streams)); - DEBUG("Freeing image %u", wim->current_image); destroy_image_metadata(imd, NULL, false); } } @@ -190,12 +355,7 @@ select_wim_image(WIMStruct *wim, int image) if (imd->root_dentry || imd->modified) { ret = 0; } else { - #ifdef ENABLE_DEBUG - DEBUG("Reading metadata resource specified by the following " - "lookup table entry:"); - print_lookup_table_entry(imd->metadata_lte, stderr); - #endif - ret = read_metadata_resource(wim, imd); + ret = read_metadata_resource(imd); if (ret) wim->current_image = WIMLIB_NO_IMAGE; } @@ -208,14 +368,16 @@ WIMLIBAPI const tchar * wimlib_get_compression_type_string(int ctype) { switch (ctype) { - case WIMLIB_COMPRESSION_TYPE_NONE: - return T("None"); - case WIMLIB_COMPRESSION_TYPE_LZX: - return T("LZX"); - case WIMLIB_COMPRESSION_TYPE_XPRESS: - return T("XPRESS"); - default: - return T("Invalid"); + case WIMLIB_COMPRESSION_TYPE_NONE: + return T("None"); + case WIMLIB_COMPRESSION_TYPE_XPRESS: + return T("XPRESS"); + case WIMLIB_COMPRESSION_TYPE_LZX: + return T("LZX"); + case WIMLIB_COMPRESSION_TYPE_LZMS: + return T("LZMS"); + default: + return T("Invalid"); } } @@ -276,14 +438,6 @@ wimlib_print_available_images(const WIMStruct *wim, int image) print_image_info(wim->wim_info, i); } - -/* API function documented in wimlib.h */ -WIMLIBAPI int -wimlib_print_metadata(WIMStruct *wim, int image) -{ - return for_image(wim, image, image_print_metadata); -} - /* API function documented in wimlib.h */ WIMLIBAPI int wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info) @@ -292,8 +446,8 @@ wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info) memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN); info->image_count = wim->hdr.image_count; info->boot_index = wim->hdr.boot_idx; - info->wim_version = WIM_VERSION; - info->chunk_size = WIM_CHUNK_SIZE; + info->wim_version = wim->hdr.wim_version; + info->chunk_size = wim->chunk_size; info->part_number = wim->hdr.part_number; info->total_parts = wim->hdr.total_parts; info->compression_type = wim->compression_type; @@ -317,7 +471,15 @@ wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info) WIMLIBAPI int wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which) { - int ret; + if (which & ~(WIMLIB_CHANGE_READONLY_FLAG | + WIMLIB_CHANGE_GUID | + WIMLIB_CHANGE_BOOT_INDEX | + WIMLIB_CHANGE_RPFIX_FLAG)) + return WIMLIB_ERR_INVALID_PARAM; + + if ((which & WIMLIB_CHANGE_BOOT_INDEX) && + info->boot_index > wim->hdr.image_count) + return WIMLIB_ERR_INVALID_IMAGE; if (which & WIMLIB_CHANGE_READONLY_FLAG) { if (info->is_marked_readonly) @@ -326,26 +488,11 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY; } - if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0) - return 0; - - ret = can_modify_wim(wim); - if (ret) - return ret; + if (which & WIMLIB_CHANGE_GUID) + memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN); - if (which & WIMLIB_CHANGE_GUID) { - memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN); - wim->guid_set_explicitly = 1; - } - - if (which & WIMLIB_CHANGE_BOOT_INDEX) { - if (info->boot_index > wim->hdr.image_count) { - ERROR("%u is not 0 or a valid image in the WIM to mark as bootable", - info->boot_index); - return WIMLIB_ERR_INVALID_IMAGE; - } + if (which & WIMLIB_CHANGE_BOOT_INDEX) wim->hdr.boot_idx = info->boot_index; - } if (which & WIMLIB_CHANGE_RPFIX_FLAG) { if (info->has_rpfix) @@ -357,33 +504,107 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic } static int -do_open_wim(const tchar *filename, struct filedes *fd_ret) +set_out_ctype(int ctype, u8 *out_ctype_p) { - 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; + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_NONE: + case WIMLIB_COMPRESSION_TYPE_LZX: + case WIMLIB_COMPRESSION_TYPE_XPRESS: + case WIMLIB_COMPRESSION_TYPE_LZMS: + *out_ctype_p = ctype; + return 0; } - filedes_init(fd_ret, raw_fd); + return WIMLIB_ERR_INVALID_COMPRESSION_TYPE; +} + +/* API function documented in wimlib.h */ +WIMLIBAPI int +wimlib_set_output_compression_type(WIMStruct *wim, int ctype) +{ + int ret = set_out_ctype(ctype, &wim->out_compression_type); + if (ret) + return ret; + + /* 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_chunk_size(ctype); return 0; } -int -reopen_wim(WIMStruct *wim) +/* API function documented in wimlib.h */ +WIMLIBAPI int +wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype) { - wimlib_assert(!filedes_valid(&wim->in_fd)); - return do_open_wim(wim->filename, &wim->in_fd); + int ret = set_out_ctype(ctype, &wim->out_pack_compression_type); + if (ret) + return ret; + + /* Reset the chunk size if it's no longer valid. */ + if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype)) + wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype); + return 0; } -int -close_wim(WIMStruct *wim) +static int +set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p) { - if (filedes_valid(&wim->in_fd)) { - filedes_close(&wim->in_fd); - filedes_invalidate(&wim->in_fd); + if (!wim_chunk_size_valid(chunk_size, ctype)) + return WIMLIB_ERR_INVALID_CHUNK_SIZE; + + *out_chunk_size_p = chunk_size; + return 0; +} + +/* API function documented in wimlib.h */ +WIMLIBAPI int +wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size) +{ + if (chunk_size == 0) { + wim->out_chunk_size = + wim_default_chunk_size(wim->out_compression_type); + return 0; + } + + return set_out_chunk_size(chunk_size, + wim->out_compression_type, + &wim->out_chunk_size); +} + +/* API function documented in wimlib.h */ +WIMLIBAPI int +wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size) +{ + if (chunk_size == 0) { + wim->out_pack_chunk_size = + wim_default_pack_chunk_size(wim->out_pack_compression_type); + return 0; + } + + return set_out_chunk_size(chunk_size, + wim->out_pack_compression_type, + &wim->out_pack_chunk_size); +} + +WIMLIBAPI void +wimlib_register_progress_function(WIMStruct *wim, + wimlib_progress_func_t progfunc, + void *progctx) +{ + wim->progfunc = progfunc; + wim->progctx = progctx; +} + +static int +open_wim_file(const tchar *filename, struct filedes *fd_ret) +{ + int raw_fd; + + raw_fd = topen(filename, O_RDONLY | O_BINARY); + if (raw_fd < 0) { + ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename); + return WIMLIB_ERR_OPEN; } + filedes_init(fd_ret, raw_fd); return 0; } @@ -392,8 +613,7 @@ close_wim(WIMStruct *wim) * lookup table, and optionally checks the integrity. */ static int -begin_read(WIMStruct *wim, const void *wim_filename_or_fd, - int open_flags, wimlib_progress_func_t progress_func) +begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags) { int ret; int xml_num_images; @@ -405,8 +625,7 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, wim->in_fd.is_pipe = 1; } else { wimfile = wim_filename_or_fd; - DEBUG("Reading the WIM file `%"TS"'", wimfile); - ret = do_open_wim(wimfile, &wim->in_fd); + ret = open_wim_file(wimfile, &wim->in_fd); if (ret) return ret; @@ -424,22 +643,24 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, */ wim->filename = realpath(wimfile, NULL); if (!wim->filename) { - ERROR_WITH_ERRNO("Failed to resolve 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_OPEN; + return WIMLIB_ERR_NO_FILENAME; } } - ret = read_wim_header(wim->filename, &wim->in_fd, &wim->hdr); + ret = read_wim_header(wim, &wim->hdr); if (ret) return ret; if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) { - WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS is set in the header of \"%"TS"\".\n" - " It may be being changed by another process, or a process\n" - " may have crashed while writing the WIM.", wimfile); + WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n" + " \"%"TS"\". It may be being changed by another process,\n" + " or a process may have crashed while writing the WIM.", + wimfile); } if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) { @@ -452,44 +673,46 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, (wim->hdr.total_parts != 1)) return WIMLIB_ERR_IS_SPLIT_WIM; - DEBUG("According to header, WIM contains %u images", wim->hdr.image_count); - /* If the boot index is invalid, print a warning and set it to 0 */ if (wim->hdr.boot_idx > wim->hdr.image_count) { - WARNING("In `%"TS"', image %u is marked as bootable, " - "but there are only %u images in the WIM", - wimfile, wim->hdr.boot_idx, wim->hdr.image_count); + WARNING("Ignoring invalid boot index."); wim->hdr.boot_idx = 0; } /* Check and cache the compression type */ if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) { if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) { - if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) { - ERROR("Multiple compression flags are set in \"%"TS"\"", - wimfile); - return WIMLIB_ERR_INVALID_COMPRESSION_TYPE; - } wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX; - } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) { + } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS | + WIM_HDR_FLAG_COMPRESS_XPRESS_2)) { wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS; + } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) { + wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS; } else { - ERROR("The compression flag is set on \"%"TS"\", but " - "neither the XPRESS nor LZX flag is set", - wimfile); 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 (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) { - ret = check_wim_integrity(wim, progress_func); + ret = check_wim_integrity(wim); if (ret == WIM_INTEGRITY_NONEXISTENT) { - WARNING("No integrity information for `%"TS"'; skipping " - "integrity check.", wimfile); + WARNING("\"%"TS"\" does not contain integrity " + "information. Skipping integrity check.", + wimfile); } else if (ret == WIM_INTEGRITY_NOT_OK) { - ERROR("WIM is not intact! (Failed integrity check)"); return WIMLIB_ERR_INTEGRITY; } else if (ret != WIM_INTEGRITY_OK) { return ret; @@ -507,9 +730,6 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, if (!wim->lookup_table) return WIMLIB_ERR_NOMEM; } else { - ret = read_wim_lookup_table(wim); - if (ret) - return ret; ret = read_wim_xml_data(wim); if (ret) @@ -517,159 +737,72 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd, xml_num_images = wim_info_get_num_images(wim->wim_info); if (xml_num_images != wim->hdr.image_count) { - ERROR("In the file `%"TS"', there are %u elements " - "in the XML data,", wimfile, xml_num_images); - ERROR("but %u images in the WIM! There must be exactly one " - " element per image.", wim->hdr.image_count); + ERROR("The WIM's header is inconsistent with its XML data.\n" + " Please submit a bug report if you believe this " + "WIM file should be considered valid."); return WIMLIB_ERR_IMAGE_COUNT; } - DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile); + + ret = read_wim_lookup_table(wim); + if (ret) + return ret; } return 0; } int open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags, - WIMStruct **wim_ret, wimlib_progress_func_t progress_func) + WIMStruct **wim_ret, + wimlib_progress_func_t progfunc, void *progctx) { WIMStruct *wim; int ret; - wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8); - - ret = WIMLIB_ERR_INVALID_PARAM; - if (!wim_ret) - goto out; + ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8); + if (ret) + return ret; - ret = WIMLIB_ERR_NOMEM; wim = new_wim_struct(); if (!wim) - goto out; + return WIMLIB_ERR_NOMEM; - ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func); - if (ret) - goto out_wimlib_free; + wim->progfunc = progfunc; + wim->progctx = progctx; + + ret = begin_read(wim, wim_filename_or_fd, open_flags); + if (ret) { + wimlib_free(wim); + return ret; + } - ret = 0; *wim_ret = wim; - goto out; -out_wimlib_free: - wimlib_free(wim); -out: - return ret; + return 0; } /* API function documented in wimlib.h */ WIMLIBAPI int -wimlib_open_wim(const tchar *wimfile, int open_flags, - WIMStruct **wim_ret, wimlib_progress_func_t progress_func) -{ - open_flags &= WIMLIB_OPEN_MASK_PUBLIC; - return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret, - progress_func); -} - -void -destroy_image_metadata(struct wim_image_metadata *imd, - struct wim_lookup_table *table, - bool free_metadata_lte) -{ - free_dentry_tree(imd->root_dentry, table); - imd->root_dentry = NULL; - free_wim_security_data(imd->security_data); - imd->security_data = NULL; - - if (free_metadata_lte) { - free_lookup_table_entry(imd->metadata_lte); - imd->metadata_lte = NULL; - } - if (!table) { - struct wim_lookup_table_entry *lte, *tmp; - list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list) - free_lookup_table_entry(lte); - } - INIT_LIST_HEAD(&imd->unhashed_streams); - INIT_LIST_HEAD(&imd->inode_list); -#ifdef WITH_NTFS_3G - if (imd->ntfs_vol) { - do_ntfs_umount(imd->ntfs_vol); - imd->ntfs_vol = NULL; - } -#endif -} - -void -put_image_metadata(struct wim_image_metadata *imd, - struct wim_lookup_table *table) -{ - if (imd && --imd->refcnt == 0) { - destroy_image_metadata(imd, table, true); - FREE(imd); - } -} - -/* 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) +wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags, + WIMStruct **wim_ret, + wimlib_progress_func_t progfunc, void *progctx) { - struct wim_image_metadata **imd_array; + if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY | + WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT | + WIMLIB_OPEN_FLAG_WRITE_ACCESS)) + return WIMLIB_ERR_INVALID_PARAM; - DEBUG("Reallocating image metadata array for image_count = %u", - wim->hdr.image_count + 1); - imd_array = REALLOC(wim->image_metadata, - sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1)); + if (!wimfile || !*wimfile || !wim_ret) + return WIMLIB_ERR_INVALID_PARAM; - if (!imd_array) - return WIMLIB_ERR_NOMEM; - wim->image_metadata = imd_array; - imd_array[wim->hdr.image_count++] = imd; - return 0; + return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret, + progfunc, progctx); } - -struct wim_image_metadata * -new_image_metadata(void) +/* API function documented in wimlib.h */ +WIMLIBAPI int +wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret) { - struct wim_image_metadata *imd; - - imd = CALLOC(1, sizeof(*imd)); - if (imd) { - imd->refcnt = 1; - INIT_LIST_HEAD(&imd->inode_list); - INIT_LIST_HEAD(&imd->unhashed_streams); - DEBUG("Created new image metadata (refcnt=1)"); - } else { - ERROR_WITH_ERRNO("Failed to allocate new image metadata structure"); - } - return imd; -} - -struct wim_image_metadata ** -new_image_metadata_array(unsigned num_images) -{ - struct wim_image_metadata **imd_array; - - DEBUG("Creating new image metadata array for %u images", - num_images); - - imd_array = CALLOC(num_images, sizeof(imd_array[0])); - - if (!imd_array) { - ERROR("Failed to allocate memory for %u image metadata structures", - num_images); - return NULL; - } - for (unsigned i = 0; i < num_images; i++) { - imd_array[i] = new_image_metadata(); - if (!imd_array[i]) { - for (unsigned j = 0; j < i; j++) - put_image_metadata(imd_array[j], NULL); - FREE(imd_array); - return NULL; - } - } - return imd_array; + return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret, + NULL, NULL); } /* Checksum all streams that are unhashed (other than the metadata streams), @@ -687,9 +820,12 @@ wim_checksum_unhashed_streams(WIMStruct *wim) struct wim_lookup_table_entry *lte, *tmp; struct wim_image_metadata *imd = wim->image_metadata[i]; image_for_each_unhashed_stream_safe(lte, tmp, imd) { - ret = hash_unhashed_stream(lte, wim->lookup_table, NULL); + struct wim_lookup_table_entry *new_lte; + ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte); if (ret) return ret; + if (new_lte != lte) + free_lookup_table_entry(lte); } } return 0; @@ -727,30 +863,6 @@ can_modify_wim(WIMStruct *wim) return 0; } -/* - * can_delete_from_wim - Check if files or images can be deleted from a given - * WIM file. - * - * This theoretically should be exactly the same as can_modify_wim(), but - * unfortunately, due to bugs in Microsoft's software that generate incorrect - * reference counts for some WIM resources, we need to run expensive - * verifications to make sure the reference counts are correct on all WIM - * resources. Otherwise we might delete a WIM resource whose reference count - * has fallen to 0, but is actually still referenced somewhere. - */ -int -can_delete_from_wim(WIMStruct *wim) -{ - int ret; - - ret = can_modify_wim(wim); - if (ret) - return ret; - if (!wim->refcnts_ok) - wim_recalculate_refcnts(wim); - return 0; -} - /* API function documented in wimlib.h */ WIMLIBAPI void wimlib_free(WIMStruct *wim) @@ -758,15 +870,11 @@ wimlib_free(WIMStruct *wim) if (!wim) return; - DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)", - wim->filename, wim->hdr.image_count); - while (!list_empty(&wim->subwims)) { WIMStruct *subwim; subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node); list_del(&subwim->subwim_node); - DEBUG("Freeing subwim."); wimlib_free(subwim); } @@ -775,9 +883,10 @@ wimlib_free(WIMStruct *wim) if (filedes_valid(&wim->out_fd)) filedes_close(&wim->out_fd); - free_lookup_table(wim->lookup_table); + wimlib_free_decompressor(wim->decompressor); + FREE(wim->filename); free_wim_info(wim->wim_info); if (wim->image_metadata) { @@ -803,15 +912,35 @@ test_locale_ctype_utf8(void) #endif } +/* API function documented in wimlib.h */ +WIMLIBAPI u32 +wimlib_get_version(void) +{ + return WIMLIB_VERSION_CODE; +} + +static bool lib_initialized = false; + /* API function documented in wimlib.h */ WIMLIBAPI int wimlib_global_init(int init_flags) { - static bool already_inited = false; - int ret; - - if (already_inited) + if (lib_initialized) return 0; + +#ifdef ENABLE_ERROR_MESSAGES + if (!wimlib_error_file) + wimlib_error_file = stderr; +#endif + + 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)) + return WIMLIB_ERR_INVALID_PARAM; + libxml_global_init(); if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) { wimlib_mbs_is_utf8 = test_locale_ctype_utf8(); @@ -821,23 +950,34 @@ wimlib_global_init(int init_flags) #endif } #ifdef __WIN32__ - ret = win32_global_init(init_flags); - if (ret) - return ret; -#else - ret = 0; + { + int ret = win32_global_init(init_flags); + if (ret) + return ret; + } #endif - already_inited = true; - return ret; + 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; + return 0; } /* API function documented in wimlib.h */ WIMLIBAPI void wimlib_global_cleanup(void) { + if (!lib_initialized) + return; libxml_global_cleanup(); iconv_global_cleanup(); #ifdef __WIN32__ win32_global_cleanup(); #endif + + wimlib_set_error_file(NULL); + lib_initialized = false; }