#include "wimlib/security.h"
#include "wimlib/wim.h"
#include "wimlib/xml.h"
+#include "wimlib/compressor_ops.h"
+#include "wimlib/decompressor_ops.h"
+#include "wimlib/version.h"
#ifdef __WIN32__
# include "wimlib/win32.h" /* for realpath() replacement */
#include <unistd.h>
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:
+ /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible.
+ * */
+ 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;
+ 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;
* 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:
- /* 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) didn't seem to support XPRESS chunk size
- * below 32768 bytes, but larger power-of-two sizes appear to be
- * supported. 67108864 was the largest size that worked.
- * (Note, however, that the offsets of XPRESS matches are still
- * limited to 65535 bytes even when a much larger chunk size is
- * used!)
- *
- * WIMGAPI (Windows 8) seemed to have removed the support for
- * larger XPRESS chunk sizes and will refuse to open such WIMs.
- *
- * 2^15 = 32768 is the default value used for compatibility, but
- * wimlib can actually use up to 2^26. */
return order >= 15 && order <= 26;
-
case WIMLIB_COMPRESSION_TYPE_LZMS:
- /* TODO */
- return 131072;
+ return order >= 15 && order <= 30;
}
return false;
}
static u32
wim_default_chunk_size(int ctype)
{
- return 32768;
+ 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 *))
return ret;
}
+/* Load the metadata for the specified WIM image into memory and set it as the
+ * WIMStruct's currently selected WIM image. */
int
select_wim_image(WIMStruct *wim, int image)
{
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) {
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);
if (ret)
wim->current_image = WIMLIB_NO_IMAGE;
return T("LZX");
case WIMLIB_COMPRESSION_TYPE_XPRESS:
return T("XPRESS");
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ return T("LZMS");
default:
return T("Invalid");
}
print_image_info(wim->wim_info, i);
}
-
-/* API function documented in wimlib.h */
+/* TODO: Deprecated; remove this. */
WIMLIBAPI int
wimlib_print_metadata(WIMStruct *wim, int image)
{
- return for_image(wim, image, image_print_metadata);
+ return WIMLIB_ERR_UNSUPPORTED;
}
/* API function documented in wimlib.h */
info->image_count = wim->hdr.image_count;
info->boot_index = wim->hdr.boot_idx;
info->wim_version = wim->hdr.wim_version;
- info->chunk_size = wim->hdr.chunk_size;
+ 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;
{
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_READONLY_FLAG) {
if (info->is_marked_readonly)
wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
return 0;
}
-/* API function documented in wimlib.h */
-WIMLIBAPI int
-wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
+static int
+set_out_ctype(int ctype, u8 *out_ctype_p)
{
switch (ctype) {
case WIMLIB_COMPRESSION_TYPE_INVALID:
case WIMLIB_COMPRESSION_TYPE_NONE:
case WIMLIB_COMPRESSION_TYPE_LZX:
case WIMLIB_COMPRESSION_TYPE_XPRESS:
- wim->out_compression_type = ctype;
-
- /* Reset the chunk size if it's no longer valid. */
- if (!wim_chunk_size_valid(wim->out_chunk_size,
- wim->out_compression_type))
- wim->out_chunk_size = wim_default_chunk_size(wim->out_compression_type);
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ *out_ctype_p = ctype;
return 0;
}
- return WIMLIB_ERR_INVALID_PARAM;
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
}
/* API function documented in wimlib.h */
WIMLIBAPI int
-wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
+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;
+}
+
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
{
- if (!wim_chunk_size_valid(chunk_size, wim->out_compression_type)) {
+ 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;
+}
+
+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(wim->out_compression_type));
- switch (wim->out_compression_type) {
- case WIMLIB_COMPRESSION_TYPE_XPRESS:
- ERROR("Valid chunk sizes for XPRESS are "
- "32768, 65536, 131072, ..., 67108864.");
- break;
- case WIMLIB_COMPRESSION_TYPE_LZX:
- ERROR("Valid chunk sizes for LZX are "
- "32768, 65536, 131072, ..., 2097152.");
- break;
- }
+ wimlib_get_compression_type_string(ctype));
return WIMLIB_ERR_INVALID_CHUNK_SIZE;
}
- if (chunk_size != 32768) {
- WARNING ("Changing the compression chunk size to any value other than\n"
- " the default of 32768 bytes eliminates compatibility with\n"
- " Microsoft's software!");
- }
- wim->out_chunk_size = 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, struct filedes *fd_ret)
+open_wim_file(const tchar *filename, struct filedes *fd_ret)
{
int raw_fd;
return 0;
}
-int
-reopen_wim(WIMStruct *wim)
-{
- wimlib_assert(!filedes_valid(&wim->in_fd));
- return do_open_wim(wim->filename, &wim->in_fd);
-}
-
-int
-close_wim(WIMStruct *wim)
-{
- if (filedes_valid(&wim->in_fd)) {
- filedes_close(&wim->in_fd);
- filedes_invalidate(&wim->in_fd);
- }
- return 0;
-}
-
/*
* Begins the reading of a WIM file; opens the file and reads its header and
* lookup table, and optionally checks the integrity.
wim->in_fd.is_pipe = 1;
} else {
wimfile = wim_filename_or_fd;
- ret = do_open_wim(wimfile, &wim->in_fd);
+ ret = open_wim_file(wimfile, &wim->in_fd);
if (ret)
return ret;
wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
} else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
- #if 0
- /* TODO */
} else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
- #endif
} else {
ERROR("The compression flag is set on \"%"TS"\", but "
"a flag for a recognized format is not",
wim->out_compression_type = wim->compression_type;
/* Check and cache the chunk size. */
- wim->chunk_size = wim->out_chunk_size = wim->hdr.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"!",
if (wim->lookup_table == NULL)
return WIMLIB_ERR_NOMEM;
} else {
- ret = read_wim_lookup_table(wim);
- if (ret)
- return ret;
ret = read_wim_xml_data(wim);
if (ret)
"<IMAGE> element per image.", wim->hdr.image_count);
return WIMLIB_ERR_IMAGE_COUNT;
}
+
+ ret = read_wim_lookup_table(wim);
+ if (ret)
+ return ret;
+
DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
}
return 0;
wimlib_open_wim(const tchar *wimfile, int open_flags,
WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
{
- open_flags &= WIMLIB_OPEN_MASK_PUBLIC;
+ if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
+ WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
+ WIMLIB_OPEN_FLAG_WRITE_ACCESS))
+ return WIMLIB_ERR_INVALID_PARAM;
+
return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
progress_func);
}
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;
if (filedes_valid(&wim->out_fd))
filedes_close(&wim->out_fd);
- wimlib_lzx_free_context(wim->lzx_context);
-
free_lookup_table(wim->lookup_table);
+ wimlib_free_decompressor(wim->decompressor);
+
FREE(wim->filename);
free_wim_info(wim->wim_info);
if (wim->image_metadata) {
#endif
}
+/* API function documented in wimlib.h */
+WIMLIBAPI u32
+wimlib_get_version(void)
+{
+ return WIMLIB_VERSION_CODE;
+}
+
/* API function documented in wimlib.h */
WIMLIBAPI int
wimlib_global_init(int init_flags)
{
static bool already_inited = false;
- int ret;
if (already_inited)
return 0;
+
+ 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();
#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
+ 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 ret;
+ return 0;
}
/* API function documented in wimlib.h */
#ifdef __WIN32__
win32_global_cleanup();
#endif
+ cleanup_decompressor_params();
+ cleanup_compressor_params();
}