#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:
+ return 1U << 26; /* 67108864 */
+ 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, 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;
-
+ return order >= 12 && order <= 26;
case WIMLIB_COMPRESSION_TYPE_LZMS:
- return order >= 15 && order <= 26;
+ return order >= 15 && order <= 30;
}
return false;
}
}
}
-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 */
- }
-}
-
/*
- * 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 *))
wim->refcnts_ok = 1;
wim->compression_type = ctype;
wim->out_compression_type = ctype;
- wim->out_pack_compression_type = ctype;
wim->chunk_size = wim->hdr.chunk_size;
wim->out_chunk_size = wim->hdr.chunk_size;
- wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
*wim_ret = wim;
return 0;
out_free:
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 == 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);
+ }
+ 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;
+
+ 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 (imd_array == NULL)
+ 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);
+ DEBUG("Created new image metadata (refcnt=1)");
+ } else {
+ ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
+ }
+ return imd;
+}
+
+static 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 == 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] == NULL) {
+ 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)
{
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;
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)
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;
if (ret)
return ret;
- if (which & WIMLIB_CHANGE_GUID) {
- memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
- wim->guid_set_explicitly = 1;
- }
+ if (which & WIMLIB_CHANGE_GUID)
+ memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
if (which & WIMLIB_CHANGE_BOOT_INDEX) {
if (info->boot_index > wim->hdr.image_count) {
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:
return ret;
/* Reset the chunk size if it's no longer valid. */
- if (!wim_chunk_size_valid(ctype, wim->out_chunk_size))
+ if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
wim->out_chunk_size = wim_default_chunk_size(ctype);
return 0;
}
return ret;
/* Reset the chunk size if it's no longer valid. */
- if (!wim_chunk_size_valid(ctype, wim->out_pack_chunk_size))
+ if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
return 0;
}
&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
-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.
*/
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;
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;
if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
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;
wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
}
wim->out_compression_type = wim->compression_type;
- wim->out_pack_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;
- wim->out_pack_chunk_size = wim_default_pack_chunk_size(wim->out_pack_compression_type);
if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
ERROR("Invalid chunk size (%"PRIu32" bytes) "
"for compression type %"TS"!",
}
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);
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;
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;
if (wim == NULL)
return WIMLIB_ERR_NOMEM;
- ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func);
+ wim->progfunc = progfunc;
+ wim->progctx = progctx;
+
+ ret = begin_read(wim, wim_filename_or_fd, open_flags);
if (ret) {
wimlib_free(wim);
return ret;
/* 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 == 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);
- }
- 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)
+wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
+ WIMStruct **wim_ret,
+ wimlib_progress_func_t progfunc, void *progctx)
{
- 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;
-
- 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 (imd_array == NULL)
- 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;
+ if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
+ WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
+ WIMLIB_OPEN_FLAG_WRITE_ACCESS))
+ return WIMLIB_ERR_INVALID_PARAM;
- 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;
+ return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
+ progfunc, progctx);
}
-struct wim_image_metadata **
-new_image_metadata_array(unsigned num_images)
+/* 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_array;
-
- DEBUG("Creating new image metadata array for %u images",
- num_images);
-
- imd_array = CALLOC(num_images, sizeof(imd_array[0]));
-
- 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] == NULL) {
- 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),
#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 == NULL)
+ 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();
#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__
#endif
cleanup_decompressor_params();
cleanup_compressor_params();
+
+ wimlib_set_error_file(NULL);
+ lib_initialized = false;
}
git://wimlib.net / wimlib / blobdiff