X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwim.c;h=498821bc2bffab8e38081d778d95df730486e137;hp=43a0e3491680feafc723b0576333545c665d5a17;hb=5695db8f27535e50a8159a226902687fe32ffe9a;hpb=00a775dc256d1fc8254d4f055e362e67f25b66d8 diff --git a/src/wim.c b/src/wim.c index 43a0e349..498821bc 100644 --- a/src/wim.c +++ b/src/wim.c @@ -38,6 +38,8 @@ #include "wimlib/security.h" #include "wimlib/wim.h" #include "wimlib/xml.h" +#include "wimlib/compressor_ops.h" +#include "wimlib/decompressor_ops.h" #ifdef __WIN32__ # include "wimlib/win32.h" /* for realpath() replacement */ @@ -62,12 +64,22 @@ image_print_metadata(WIMStruct *wim) wim->lookup_table); } - static int -image_print_files(WIMStruct *wim) +wim_default_pack_compression_type(void) { - return for_dentry_in_tree(wim_root_dentry(wim), print_dentry_full_path, - NULL); + return WIMLIB_COMPRESSION_TYPE_LZMS; +} + +static u32 +wim_default_pack_chunk_size(int ctype) { + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_LZMS: + /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible. + * */ + return 1U << 25; /* 33554432 */ + default: + return 1U << 15; /* 32768 */ + } } static WIMStruct * @@ -75,12 +87,93 @@ new_wim_struct(void) { WIMStruct *wim = CALLOC(1, sizeof(WIMStruct)); if (wim) { - wim->in_fd = -1; - wim->out_fd = -1; + wim->in_fd.fd = -1; + wim->out_fd.fd = -1; + 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 + */ + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_LZX: + /* For LZX compression, the chunk size corresponds to the LZX + * window size, which according the LZX specification can be any + * power of 2 between 2^15 and 2^21, inclusively. All these are + * supported by wimlib; however, unfortunately only 2^15 is + * supported by WIMGAPI[1] so this value is used by default. + * + * [1] WIMGAPI (Windows 7) attempts to decompress LZX chunk + * sizes > 2^15 but seems to have bug(s) that cause it to fail + * or crash. (I tried several tweaks to the LZX data but none + * resulted in successful decompression.) WIMGAPI (Windows 8) + * appears to refuse to open WIMs with chunk size > 2^15 + * entirely. */ + return order >= 15 && order <= 21; + + case WIMLIB_COMPRESSION_TYPE_XPRESS: + /* WIMGAPI (Windows 7, Windows 8) doesn't seem to support XPRESS + * chunk size below 32768 bytes, but larger power-of-two sizes, + * up ta 67108864 bytes, appear to work. (Note, however, that + * the offsets of XPRESS matches are still limited to 65535 + * bytes even when a much larger chunk size is used!) */ + return order >= 15 && order <= 26; + + case WIMLIB_COMPRESSION_TYPE_LZMS: + return order >= 15 && order <= 26; + } + 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 @@ -115,9 +208,7 @@ for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *)) return 0; } -/* - * Creates a WIMStruct for a new WIM file. - */ +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret) { @@ -132,21 +223,24 @@ wimlib_create_new_wim(int ctype, WIMStruct **wim_ret) /* Allocate the WIMStruct. */ wim = new_wim_struct(); - if (!wim) + if (wim == NULL) return WIMLIB_ERR_NOMEM; - ret = init_header(&wim->hdr, ctype); - if (ret != 0) + ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype)); + if (ret) goto out_free; table = new_lookup_table(9001); - if (!table) { + if (table == NULL) { ret = WIMLIB_ERR_NOMEM; goto out_free; } 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: @@ -176,9 +270,11 @@ select_wim_image(WIMStruct *wim, int image) return WIMLIB_ERR_INVALID_IMAGE; } - if (wim->hdr.part_number != 1) { - ERROR("Cannot select an image from a non-first part of a split WIM"); - return WIMLIB_ERR_SPLIT_UNSUPPORTED; + 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."); + return WIMLIB_ERR_METADATA_NOT_FOUND; } /* If a valid image is currently selected, it can be freed if it is not @@ -209,6 +305,7 @@ select_wim_image(WIMStruct *wim, int image) } +/* API function documented in wimlib.h */ WIMLIBAPI const tchar * wimlib_get_compression_type_string(int ctype) { @@ -219,16 +316,14 @@ wimlib_get_compression_type_string(int ctype) return T("LZX"); case WIMLIB_COMPRESSION_TYPE_XPRESS: return T("XPRESS"); + case WIMLIB_COMPRESSION_TYPE_LZMS: + return T("LZMS"); default: return T("Invalid"); } } -/* - * 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. - */ +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num) { @@ -257,33 +352,7 @@ wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num) } } -/* Prints some basic information about a WIM file. */ -WIMLIBAPI void -wimlib_print_wim_information(const WIMStruct *wim) -{ - struct wimlib_wim_info info; - - wimlib_get_wim_info((WIMStruct*)wim, &info); - - tputs(T("WIM Information:")); - tputs(T("----------------")); - tprintf(T("Path: %"TS"\n"), wim->filename); - tfputs(T("GUID: 0x"), stdout); - print_byte_field(info.guid, WIM_GID_LEN, stdout); - tputchar(T('\n')); - tprintf(T("Image Count: %d\n"), info.image_count); - tprintf(T("Compression: %"TS"\n"), - wimlib_get_compression_type_string(info.compression_type)); - tprintf(T("Part Number: %d/%d\n"), info.part_number, info.total_parts); - tprintf(T("Boot Index: %d\n"), info.boot_index); - tprintf(T("Size: %"PRIu64" bytes\n"), info.total_bytes); - tprintf(T("Integrity Info: %"TS"\n"), - info.has_integrity_table ? T("yes") : T("no")); - tprintf(T("Relative path junction: %"TS"\n"), - info.has_rpfix ? T("yes") : T("no")); - tputchar(T('\n')); -} - +/* API function documented in wimlib.h */ WIMLIBAPI void wimlib_print_available_images(const WIMStruct *wim, int image) { @@ -312,32 +381,14 @@ wimlib_print_available_images(const WIMStruct *wim, int image) } -/* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but - * not WIMLIB_NO_IMAGE. */ +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_print_metadata(WIMStruct *wim, int image) { - if (wim->hdr.part_number != 1) { - ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!", - wim->hdr.part_number, wim->hdr.total_parts); - ERROR("Select the first part of the split WIM to see the metadata."); - return WIMLIB_ERR_SPLIT_UNSUPPORTED; - } return for_image(wim, image, image_print_metadata); } -WIMLIBAPI int -wimlib_print_files(WIMStruct *wim, int image) -{ - if (wim->hdr.part_number != 1) { - ERROR("Cannot list the files from part %hu of a %hu-part split WIM!", - wim->hdr.part_number, wim->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(wim, image, image_print_files); -} - +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info) { @@ -345,16 +396,13 @@ 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->hdr.chunk_size; info->part_number = wim->hdr.part_number; info->total_parts = wim->hdr.total_parts; info->compression_type = wim->compression_type; - if (wim->wim_info) - info->total_bytes = wim->wim_info->total_bytes; - else - info->total_bytes = 0; - info->has_integrity_table = wim->hdr.integrity.offset != 0; + info->total_bytes = wim_info_get_total_bytes(wim->wim_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) || @@ -365,62 +413,11 @@ wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info) 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; } - -/* Deprecated */ -WIMLIBAPI int -wimlib_get_boot_idx(const WIMStruct *wim) -{ - struct wimlib_wim_info info; - - wimlib_get_wim_info((WIMStruct*)wim, &info); - return info.boot_index; -} - -/* Deprecated */ -WIMLIBAPI int -wimlib_get_compression_type(const WIMStruct *wim) -{ - struct wimlib_wim_info info; - - wimlib_get_wim_info((WIMStruct*)wim, &info); - return info.compression_type; -} - -/* Deprecated */ -WIMLIBAPI int -wimlib_get_num_images(const WIMStruct *wim) -{ - struct wimlib_wim_info info; - - wimlib_get_wim_info((WIMStruct*)wim, &info); - return info.image_count; -} - -/* Deprecated */ -WIMLIBAPI int -wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret) -{ - struct wimlib_wim_info info; - - wimlib_get_wim_info((WIMStruct*)wim, &info); - if (total_parts_ret) - *total_parts_ret = info.total_parts; - return info.part_number; -} - -/* Deprecated */ -WIMLIBAPI bool -wimlib_has_integrity_table(const WIMStruct *wim) -{ - struct wimlib_wim_info info; - - wimlib_get_wim_info((WIMStruct*)wim, &info); - return info.has_integrity_table; -} - +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which) { @@ -440,12 +437,13 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic if (ret) return ret; - if (which & WIMLIB_CHANGE_GUID) + 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 < 0 || info->boot_index > wim->hdr.image_count) - { + 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; @@ -462,43 +460,122 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic return 0; } -/* Deprecated */ +static int +set_out_ctype(int ctype, u8 *out_ctype_p) +{ + switch (ctype) { + case WIMLIB_COMPRESSION_TYPE_INVALID: + break; + 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; + } + return WIMLIB_ERR_INVALID_COMPRESSION_TYPE; +} + +/* API function documented in wimlib.h */ WIMLIBAPI int -wimlib_set_boot_idx(WIMStruct *wim, int boot_idx) +wimlib_set_output_compression_type(WIMStruct *wim, int ctype) { - struct wimlib_wim_info info; + int ret = set_out_ctype(ctype, &wim->out_compression_type); + if (ret) + return ret; - info.boot_index = boot_idx; - return wimlib_set_wim_info(wim, &info, WIMLIB_CHANGE_BOOT_INDEX); + /* Reset the chunk size if it's no longer valid. */ + if (!wim_chunk_size_valid(ctype, wim->out_chunk_size)) + wim->out_chunk_size = wim_default_chunk_size(ctype); + return 0; +} + +/* API function documented in wimlib.h */ +WIMLIBAPI int +wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype) +{ + 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(ctype, wim->out_pack_chunk_size)) + wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype); + return 0; +} + +static int +set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p) +{ + if (!wim_chunk_size_valid(chunk_size, ctype)) { + ERROR("Invalid chunk size (%"PRIu32" bytes) " + "for compression type %"TS"!", + chunk_size, + wimlib_get_compression_type_string(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); } static int -do_open_wim(const tchar *filename, int *fd_ret) +do_open_wim(const tchar *filename, struct filedes *fd_ret) { - int fd; + int raw_fd; - fd = topen(filename, O_RDONLY | O_BINARY); - if (fd == -1) { + 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; } - *fd_ret = fd; + filedes_init(fd_ret, raw_fd); return 0; } int reopen_wim(WIMStruct *wim) { - wimlib_assert(wim->in_fd == -1); + wimlib_assert(!filedes_valid(&wim->in_fd)); return do_open_wim(wim->filename, &wim->in_fd); } int close_wim(WIMStruct *wim) { - if (wim->in_fd != -1) { - close(wim->in_fd); - wim->in_fd = -1; + if (filedes_valid(&wim->in_fd)) { + filedes_close(&wim->in_fd); + filedes_invalidate(&wim->in_fd); } return 0; } @@ -508,47 +585,54 @@ close_wim(WIMStruct *wim) * lookup table, and optionally checks the integrity. */ static int -begin_read(WIMStruct *wim, const tchar *in_wim_path, int open_flags, - wimlib_progress_func_t progress_func) +begin_read(WIMStruct *wim, const void *wim_filename_or_fd, + int open_flags, wimlib_progress_func_t progress_func) { int ret; int xml_num_images; + const tchar *wimfile; - DEBUG("Reading the WIM file `%"TS"'", in_wim_path); - - ret = do_open_wim(in_wim_path, &wim->in_fd); - if (ret) - return ret; + 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 = do_open_wim(wimfile, &wim->in_fd); + if (ret) + return ret; - /* 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. - */ - wim->filename = realpath(in_wim_path, NULL); - if (!wim->filename) { - ERROR_WITH_ERRNO("Failed to resolve WIM filename"); - if (errno == ENOMEM) - return WIMLIB_ERR_NOMEM; - else - 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_replacements.c. + */ + wim->filename = realpath(wimfile, NULL); + if (wim->filename == NULL) { + ERROR_WITH_ERRNO("Failed to resolve WIM filename"); + if (errno == ENOMEM) + return WIMLIB_ERR_NOMEM; + else + return WIMLIB_ERR_OPEN; + } } - ret = read_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.", in_wim_path); + 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) { @@ -557,11 +641,9 @@ begin_read(WIMStruct *wim, const tchar *in_wim_path, int open_flags, return ret; } - if (wim->hdr.total_parts != 1 && !(open_flags & WIMLIB_OPEN_FLAG_SPLIT_OK)) { - ERROR("\"%"TS"\": This WIM is part %u of a %u-part WIM", - in_wim_path, wim->hdr.part_number, wim->hdr.total_parts); - return WIMLIB_ERR_SPLIT_UNSUPPORTED; - } + if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) && + (wim->hdr.total_parts != 1)) + return WIMLIB_ERR_IS_SPLIT_WIM; DEBUG("According to header, WIM contains %u images", wim->hdr.image_count); @@ -569,36 +651,45 @@ begin_read(WIMStruct *wim, const tchar *in_wim_path, int open_flags, 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", - in_wim_path, wim->hdr.boot_idx, wim->hdr.image_count); + wimfile, wim->hdr.boot_idx, wim->hdr.image_count); 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"\"", - in_wim_path); - return WIMLIB_ERR_INVALID_COMPRESSION_TYPE; - } wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX; } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) { 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", - in_wim_path); + "a flag for a recognized format is not", + wimfile); return WIMLIB_ERR_INVALID_COMPRESSION_TYPE; } } else { - BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_NONE != 0); + 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); if (ret == WIM_INTEGRITY_NONEXISTENT) { WARNING("No integrity information for `%"TS"'; skipping " - "integrity check.", in_wim_path); + "integrity check.", wimfile); } else if (ret == WIM_INTEGRITY_NOT_OK) { ERROR("WIM is not intact! (Failed integrity check)"); return WIMLIB_ERR_INTEGRITY; @@ -609,64 +700,78 @@ begin_read(WIMStruct *wim, const tchar *in_wim_path, 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); - if (!wim->image_metadata) + if (wim->image_metadata == NULL) return WIMLIB_ERR_NOMEM; } - ret = read_lookup_table(wim); - if (ret) - return ret; + if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) { + wim->lookup_table = new_lookup_table(9001); + if (wim->lookup_table == NULL) + return WIMLIB_ERR_NOMEM; + } else { - ret = read_xml_data(wim->in_fd, &wim->hdr.xml_res_entry, &wim->wim_info); - if (ret) - return ret; + ret = read_wim_xml_data(wim); + if (ret) + return ret; - 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,", in_wim_path, xml_num_images); - ERROR("but %u images in the WIM! There must be exactly one " - " element per image.", wim->hdr.image_count); - return WIMLIB_ERR_IMAGE_COUNT; - } + 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); + return WIMLIB_ERR_IMAGE_COUNT; + } - DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path); + ret = read_wim_lookup_table(wim); + if (ret) + return ret; + + DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile); + } return 0; } -/* - * Opens a WIM file and creates a WIMStruct for it. - */ -WIMLIBAPI int -wimlib_open_wim(const tchar *wim_file, int open_flags, - WIMStruct **wim_ret, - wimlib_progress_func_t progress_func) +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; int ret; + if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) + DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd); + else + DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd); + wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8); - ret = WIMLIB_ERR_INVALID_PARAM; - if (!wim_file || !wim_ret) - goto out; + if (wim_ret == NULL) + return WIMLIB_ERR_INVALID_PARAM; - ret = WIMLIB_ERR_NOMEM; wim = new_wim_struct(); - if (!wim) - goto out; + if (wim == NULL) + return WIMLIB_ERR_NOMEM; - ret = begin_read(wim, wim_file, open_flags, progress_func); - if (ret) - goto out_wimlib_free; + ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func); + if (ret) { + wimlib_free(wim); + return ret; + } - ret = 0; + DEBUG("Successfully opened WIM and created WIMStruct."); *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 @@ -683,7 +788,7 @@ destroy_image_metadata(struct wim_image_metadata *imd, free_lookup_table_entry(imd->metadata_lte); imd->metadata_lte = NULL; } - if (!table) { + if (table == NULL) { struct wim_lookup_table_entry *lte, *tmp; list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list) free_lookup_table_entry(lte); @@ -720,7 +825,7 @@ append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd) imd_array = REALLOC(wim->image_metadata, sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1)); - if (!imd_array) + if (imd_array == NULL) return WIMLIB_ERR_NOMEM; wim->image_metadata = imd_array; imd_array[wim->hdr.image_count++] = imd; @@ -755,14 +860,14 @@ new_image_metadata_array(unsigned num_images) imd_array = CALLOC(num_images, sizeof(imd_array[0])); - if (!imd_array) { + if (imd_array == NULL) { 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]) { + if (imd_array[i] == NULL) { for (unsigned j = 0; j < i; j++) put_image_metadata(imd_array[j], NULL); FREE(imd_array); @@ -780,13 +885,19 @@ int wim_checksum_unhashed_streams(WIMStruct *wim) { int ret; + + if (!wim_has_metadata(wim)) + return 0; for (int i = 0; i < wim->hdr.image_count; i++) { 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; @@ -812,7 +923,7 @@ can_modify_wim(WIMStruct *wim) } } if (wim->hdr.total_parts != 1) { - ERROR("Cannot modify \"%"TS"\": is part of a spanned set", + ERROR("Cannot modify \"%"TS"\": is part of a split WIM", wim->filename); return WIMLIB_ERR_WIM_IS_READONLY; } @@ -843,27 +954,42 @@ can_delete_from_wim(WIMStruct *wim) ret = can_modify_wim(wim); if (ret) return ret; - if (!wim->refcnts_ok) - wim_recalculate_refcnts(wim); + if (!wim->refcnts_ok) { + ret = wim_recalculate_refcnts(wim); + if (ret) + return ret; + } return 0; } -/* Frees the memory for the WIMStruct, including all internal memory; also - * closes all files associated with the WIMStruct. */ +/* API function documented in wimlib.h */ WIMLIBAPI void wimlib_free(WIMStruct *wim) { - DEBUG("Freeing WIMStruct"); - - if (!wim) + if (wim == NULL) return; - if (wim->in_fd != -1) - close(wim->in_fd); - if (wim->out_fd != -1) - close(wim->out_fd); + + 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); + } + + if (filedes_valid(&wim->in_fd)) + filedes_close(&wim->in_fd); + 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) { @@ -872,7 +998,6 @@ wimlib_free(WIMStruct *wim) FREE(wim->image_metadata); } FREE(wim); - DEBUG("Freed WIMStruct"); } static bool @@ -890,6 +1015,7 @@ test_locale_ctype_utf8(void) #endif } +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_global_init(int init_flags) { @@ -906,14 +1032,22 @@ wimlib_global_init(int init_flags) #endif } #ifdef __WIN32__ - win32_global_init(); + { + int ret = win32_global_init(init_flags); + if (ret) + return ret; + } #endif + 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; already_inited = true; 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'). */ +/* API function documented in wimlib.h */ WIMLIBAPI void wimlib_global_cleanup(void) { @@ -922,4 +1056,6 @@ wimlib_global_cleanup(void) #ifdef __WIN32__ win32_global_cleanup(); #endif + cleanup_decompressor_params(); + cleanup_compressor_params(); }