#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;
}
+/* 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 >= 15 && order <= 26;
+ 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 *))
/* Allocate the WIMStruct. */
wim = new_wim_struct();
- if (!wim)
+ if (wim == NULL)
return WIMLIB_ERR_NOMEM;
- ret = init_wim_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->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:
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 */
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;
{
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;
}
static int
-do_open_wim(const tchar *filename, struct filedes *fd_ret)
+set_out_ctype(int ctype, u8 *out_ctype_p)
{
- int raw_fd;
+ 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;
+}
- 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;
+/* 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;
+}
+
+/* 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(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(ctype));
+ return WIMLIB_ERR_INVALID_CHUNK_SIZE;
}
- filedes_init(fd_ret, raw_fd);
+
+ *out_chunk_size_p = chunk_size;
return 0;
}
-int
-reopen_wim(WIMStruct *wim)
+/* 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)
{
- wimlib_assert(!filedes_valid(&wim->in_fd));
- return do_open_wim(wim->filename, &wim->in_fd);
+ 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);
}
-int
-close_wim(WIMStruct *wim)
+static int
+open_wim_file(const tchar *filename, struct filedes *fd_ret)
{
- if (filedes_valid(&wim->in_fd)) {
- filedes_close(&wim->in_fd);
- filedes_invalidate(&wim->in_fd);
+ 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;
}
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;
* replacement function in win32_replacements.c.
*/
wim->filename = realpath(wimfile, NULL);
- if (!wim->filename) {
+ if (wim->filename == NULL) {
ERROR_WITH_ERRNO("Failed to resolve WIM filename");
if (errno == ENOMEM)
return WIMLIB_ERR_NOMEM;
}
}
- 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) {
/* 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) {
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",
+ "a flag for a recognized format is not",
wimfile);
return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
}
}
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) {
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;
}
if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
wim->lookup_table = new_lookup_table(9001);
- if (!wim->lookup_table)
+ 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;
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_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_filename_or_fd, open_flags, progress_func);
- if (ret)
- goto out_wimlib_free;
+ 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 */
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);
}
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);
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;
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);
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;
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;
}
WIMLIBAPI void
wimlib_free(WIMStruct *wim)
{
- if (!wim)
+ if (wim == NULL)
return;
DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
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();
}