/*
- * wim.c
+ * wim.c - Stuff that doesn't fit into any other file
*/
/*
- * Copyright (C) 2010 Carl Thijssen
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012, 2013 Eric Biggers
*
* wimlib - Library for working with WIM files
*
*/
#include "config.h"
-#include <stdlib.h>
+
+#include <errno.h>
+#include <fcntl.h>
+#include <limits.h>
#include <stdarg.h>
+#include <stdlib.h>
+#include <unistd.h>
#ifdef WITH_NTFS_3G
-#include <ntfs-3g/volume.h>
+# include <time.h>
+# include <ntfs-3g/volume.h>
#endif
-#include "wimlib_internal.h"
-#include "io.h"
+#ifdef __WIN32__
+# include "win32.h"
+#else
+# include <langinfo.h>
+#endif
+
+#include "buffer_io.h"
+#include "dentry.h"
#include "lookup_table.h"
+#include "wimlib_internal.h"
#include "xml.h"
-
-static int print_metadata(WIMStruct *w)
+static int
+image_print_metadata(WIMStruct *w)
{
DEBUG("Printing metadata for image %d", w->current_image);
print_security_data(wim_security_data(w));
}
-static int print_files(WIMStruct *w)
+static int
+image_print_files(WIMStruct *w)
{
return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
NULL);
}
-WIMStruct *new_wim_struct()
+static WIMStruct *
+new_wim_struct()
{
- return CALLOC(1, sizeof(WIMStruct));
+ WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
+#ifdef WITH_FUSE
+ if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
+ ERROR_WITH_ERRNO("Failed to initialize mutex");
+ FREE(w);
+ w = NULL;
+ }
+#endif
+ return w;
+
}
/*
- * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
+ * 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 *w, int image, int (*visitor)(WIMStruct *))
+int
+for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
{
int ret;
int start;
int end;
int i;
- if (image == WIM_ALL_IMAGES) {
+ if (image == WIMLIB_ALL_IMAGES) {
start = 1;
end = w->hdr.image_count;
} else if (image >= 1 && image <= w->hdr.image_count) {
return 0;
}
-static int sort_image_metadata_by_position(const void *p1, const void *p2)
+static int
+sort_image_metadata_by_position(const void *p1, const void *p2)
{
- const struct image_metadata *imd1 = p1;
- const struct image_metadata *imd2 = p2;
+ const struct wim_image_metadata *imd1 = p1;
+ const struct wim_image_metadata *imd2 = p2;
u64 offset1 = imd1->metadata_lte->resource_entry.offset;
u64 offset2 = imd2->metadata_lte->resource_entry.offset;
if (offset1 < offset2)
* If @lte points to a metadata resource, append it to the list of metadata
* resources in the WIMStruct. Otherwise, do nothing.
*/
-static int append_metadata_resource_entry(struct lookup_table_entry *lte,
- void *wim_p)
+static int
+append_metadata_resource_entry(struct wim_lookup_table_entry *lte, void *wim_p)
{
WIMStruct *w = wim_p;
int ret = 0;
if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
if (w->current_image == w->hdr.image_count) {
- ERROR("Expected only %u images, but found more",
+ ERROR("The WIM header says there are %u images in the WIM,\n"
+ " but we found more metadata resources than this",
w->hdr.image_count);
ret = WIMLIB_ERR_IMAGE_COUNT;
} else {
}
/* Returns the compression type given in the flags of a WIM header. */
-int wim_hdr_flags_compression_type(int wim_hdr_flags)
+static int
+wim_hdr_flags_compression_type(int wim_hdr_flags)
{
if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
- return WIM_COMPRESSION_TYPE_LZX;
+ return WIMLIB_COMPRESSION_TYPE_LZX;
else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
- return WIM_COMPRESSION_TYPE_XPRESS;
+ return WIMLIB_COMPRESSION_TYPE_XPRESS;
else
- return WIM_COMPRESSION_TYPE_INVALID;
+ return WIMLIB_COMPRESSION_TYPE_INVALID;
} else {
- return WIM_COMPRESSION_TYPE_NONE;
+ return WIMLIB_COMPRESSION_TYPE_NONE;
}
}
/*
* Creates a WIMStruct for a new WIM file.
*/
-WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
+WIMLIBAPI int
+wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
{
WIMStruct *w;
- struct lookup_table *table;
+ struct wim_lookup_table *table;
int ret;
DEBUG("Creating new WIM with %s compression.",
return ret;
}
-WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
+WIMLIBAPI int
+wimlib_get_num_images(const WIMStruct *w)
{
return w->hdr.image_count;
}
-int select_wim_image(WIMStruct *w, int image)
+int
+select_wim_image(WIMStruct *w, int image)
{
- struct image_metadata *imd;
+ struct wim_image_metadata *imd;
+ int ret;
DEBUG("Selecting image %d", image);
+ if (image == WIMLIB_NO_IMAGE) {
+ ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
+ return WIMLIB_ERR_INVALID_IMAGE;
+ }
+
if (image == w->current_image)
return 0;
return WIMLIB_ERR_INVALID_IMAGE;
}
-
/* If a valid image is currently selected, it can be freed if it is not
* modified. */
- if (w->current_image != WIM_NO_IMAGE) {
+ if (w->current_image != WIMLIB_NO_IMAGE) {
imd = wim_get_current_image_metadata(w);
if (!imd->modified) {
DEBUG("Freeing image %u", w->current_image);
destroy_image_metadata(imd, NULL);
imd->root_dentry = NULL;
imd->security_data = NULL;
+ INIT_HLIST_HEAD(&imd->inode_list);
}
}
-
w->current_image = image;
- imd = wim_get_current_image_metadata(w);
-
+ imd = &w->image_metadata[image - 1];
if (imd->root_dentry) {
- return 0;
+ ret = 0;
} else {
#ifdef ENABLE_DEBUG
DEBUG("Reading metadata resource specified by the following "
"lookup table entry:");
- print_lookup_table_entry(imd->metadata_lte);
+ print_lookup_table_entry(imd->metadata_lte, stdout);
#endif
- return read_metadata_resource(w, imd);
+ ret = read_metadata_resource(w, imd);
+ if (ret)
+ w->current_image = WIMLIB_NO_IMAGE;
}
+ return ret;
}
/* Returns the compression type of the WIM file. */
-WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
+WIMLIBAPI int
+wimlib_get_compression_type(const WIMStruct *w)
{
return wim_hdr_flags_compression_type(w->hdr.flags);
}
-WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
+WIMLIBAPI const char *
+wimlib_get_compression_type_string(int ctype)
{
switch (ctype) {
- case WIM_COMPRESSION_TYPE_NONE:
+ case WIMLIB_COMPRESSION_TYPE_NONE:
return "None";
- case WIM_COMPRESSION_TYPE_LZX:
+ case WIMLIB_COMPRESSION_TYPE_LZX:
return "LZX";
- case WIM_COMPRESSION_TYPE_XPRESS:
+ case WIMLIB_COMPRESSION_TYPE_XPRESS:
return "XPRESS";
default:
return "Invalid";
* the number of the image, or the name of the image. The images are numbered
* starting at 1.
*/
-WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
+WIMLIBAPI int
+wimlib_resolve_image(WIMStruct *w, const utf8char *image_name_or_num)
{
char *p;
int image;
int i;
- if (!image_name_or_num)
- return WIM_NO_IMAGE;
+ if (!image_name_or_num || !*image_name_or_num)
+ return WIMLIB_NO_IMAGE;
if (strcmp(image_name_or_num, "all") == 0
|| strcmp(image_name_or_num, "*") == 0)
- return WIM_ALL_IMAGES;
+ return WIMLIB_ALL_IMAGES;
image = strtol(image_name_or_num, &p, 10);
- if (p != image_name_or_num && *p == '\0') {
- if (image < 1 || image > w->hdr.image_count)
- return WIM_NO_IMAGE;
+ if (p != image_name_or_num && *p == '\0' && image > 0) {
+ if (image > w->hdr.image_count)
+ return WIMLIB_NO_IMAGE;
return image;
} else {
for (i = 1; i <= w->hdr.image_count; i++) {
wimlib_get_image_name(w, i)) == 0)
return i;
}
- return WIM_NO_IMAGE;
+ return WIMLIB_NO_IMAGE;
}
}
/* Prints some basic information about a WIM file. */
-WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
+WIMLIBAPI void
+wimlib_print_wim_information(const WIMStruct *w)
{
const struct wim_header *hdr;
printf("Boot Index: %d\n", hdr->boot_idx);
printf("Size: %"PRIu64" bytes\n",
wim_info_get_total_bytes(w->wim_info));
- printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
+ printf("Integrity Info: %s\n", (w->hdr.integrity.offset != 0) ? "yes" : "no");
putchar('\n');
}
-WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
+WIMLIBAPI bool
+wimlib_has_integrity_table(const WIMStruct *w)
{
return w->hdr.integrity.size != 0;
}
-WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
+WIMLIBAPI void
+wimlib_print_available_images(const WIMStruct *w, int image)
{
int first;
int last;
int i;
int n;
- if (image == WIM_ALL_IMAGES) {
+ if (image == WIMLIB_ALL_IMAGES) {
n = printf("Available Images:\n");
first = 1;
last = w->hdr.image_count;
}
-/* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
- * not WIM_NO_IMAGE. */
-WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
+/* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
+ * not WIMLIB_NO_IMAGE. */
+WIMLIBAPI int
+wimlib_print_metadata(WIMStruct *w, int image)
{
- if (!w)
- return WIMLIB_ERR_INVALID_PARAM;
if (w->hdr.part_number != 1) {
ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
w->hdr.part_number, w->hdr.total_parts);
ERROR("Select the first part of the split WIM to see the metadata.");
return WIMLIB_ERR_SPLIT_UNSUPPORTED;
}
- return for_image(w, image, print_metadata);
+ return for_image(w, image, image_print_metadata);
}
-WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
+WIMLIBAPI int
+wimlib_print_files(WIMStruct *w, int image)
{
- if (!w)
- return WIMLIB_ERR_INVALID_PARAM;
if (w->hdr.part_number != 1) {
ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
w->hdr.part_number, w->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(w, image, print_files);
+ return for_image(w, image, image_print_files);
}
/* Sets the index of the bootable image. */
-WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
+WIMLIBAPI int
+wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
{
- if (!w)
- return WIMLIB_ERR_INVALID_PARAM;
if (w->hdr.total_parts != 1) {
ERROR("Cannot modify the boot index of a split WIM!");
return WIMLIB_ERR_SPLIT_UNSUPPORTED;
if (boot_idx < 0 || boot_idx > w->hdr.image_count)
return WIMLIB_ERR_INVALID_IMAGE;
w->hdr.boot_idx = boot_idx;
+
+ if (boot_idx == 0) {
+ memset(&w->hdr.boot_metadata_res_entry, 0,
+ sizeof(struct resource_entry));
+ } else {
+ memcpy(&w->hdr.boot_metadata_res_entry,
+ &w->image_metadata[
+ boot_idx - 1].metadata_lte->resource_entry,
+ sizeof(struct resource_entry));
+ }
+
return 0;
}
-WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
+WIMLIBAPI int
+wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
{
if (total_parts_ret)
*total_parts_ret = w->hdr.total_parts;
}
-WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
+WIMLIBAPI int
+wimlib_get_boot_idx(const WIMStruct *w)
{
return w->hdr.boot_idx;
}
* 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 *w, const char *in_wim_path, int open_flags)
+static int
+begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
+ wimlib_progress_func_t progress_func)
{
int ret;
- uint xml_num_images;
+ int xml_num_images;
DEBUG("Reading the WIM file `%s'", in_wim_path);
- w->filename = STRDUP(in_wim_path);
- if (!w->filename) {
- ERROR("Failed to allocate memory for WIM filename");
- return WIMLIB_ERR_NOMEM;
- }
-
w->fp = fopen(in_wim_path, "rb");
-
if (!w->fp) {
- ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
+ ERROR_WITH_ERRNO("Failed to open `%s' for reading",
in_wim_path);
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.c.
+ */
+ w->filename = realpath(in_wim_path, NULL);
+ if (!w->filename) {
+ ERROR_WITH_ERRNO("Failed to resolve WIM filename");
+ if (errno == ENOMEM)
+ return WIMLIB_ERR_NOMEM;
+ else
+ return WIMLIB_ERR_OPEN;
+ }
+
ret = read_header(w->fp, &w->hdr, open_flags);
if (ret != 0)
return ret;
- DEBUG("Wim file contains %u images", w->hdr.image_count);
+ DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
/* If the boot index is invalid, print a warning and set it to 0 */
if (w->hdr.boot_idx > w->hdr.image_count) {
w->hdr.boot_idx = 0;
}
- if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
- ERROR("Invalid compression type (WIM header flags = %x)",
+ if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
+ ERROR("Invalid compression type (WIM header flags = 0x%x)",
w->hdr.flags);
return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
}
-
if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
- int integrity_status;
- ret = check_wim_integrity(w,
- open_flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
- &integrity_status);
- if (ret != 0)
- return ret;
- if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
+ ret = check_wim_integrity(w, progress_func);
+ if (ret == WIM_INTEGRITY_NONEXISTENT) {
WARNING("No integrity information for `%s'; skipping "
- "integrity check.", w->filename);
- } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
+ "integrity check.", in_wim_path);
+ } 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;
}
}
- if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
- ERROR("Didn't expect a compressed lookup table!");
- ERROR("Ask the author to implement support for this.");
- return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
- }
-
ret = read_lookup_table(w);
if (ret != 0)
return ret;
- w->image_metadata = CALLOC(w->hdr.image_count,
- sizeof(struct image_metadata));
+ if (w->hdr.image_count != 0) {
+ w->image_metadata = CALLOC(w->hdr.image_count,
+ sizeof(struct wim_image_metadata));
- if (!w->image_metadata) {
- ERROR("Failed to allocate memory for %u metadata structures",
- w->hdr.image_count);
- return WIMLIB_ERR_NOMEM;
+ if (!w->image_metadata) {
+ ERROR("Failed to allocate memory for %u image metadata structures",
+ w->hdr.image_count);
+ return WIMLIB_ERR_NOMEM;
+ }
}
w->current_image = 0;
return ret;
/* Make sure all the expected images were found. (We already have
- * returned false if *extra* images were found) */
+ * returned WIMLIB_ERR_IMAGE_COUNT if *extra* images were found) */
if (w->current_image != w->hdr.image_count &&
w->hdr.part_number == 1)
{
- ERROR("Only found %u images in WIM, but expected %u",
+ ERROR("Only found %d images in WIM, but expected %u",
w->current_image, w->hdr.image_count);
return WIMLIB_ERR_IMAGE_COUNT;
}
-
/* Sort images by the position of their metadata resources. I'm
* assuming that is what determines the other of the images in the WIM
* file, rather than their order in the lookup table, which is random
* because of hashing. */
qsort(w->image_metadata, w->current_image,
- sizeof(struct image_metadata), sort_image_metadata_by_position);
+ sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
- w->current_image = WIM_NO_IMAGE;
+ w->current_image = WIMLIB_NO_IMAGE;
/* Read the XML data. */
ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
&w->xml_data, &w->wim_info);
- if (ret != 0) {
- ERROR("Missing or invalid XML data");
+ if (ret != 0)
return ret;
- }
xml_num_images = wim_info_get_num_images(w->wim_info);
if (xml_num_images != w->hdr.image_count) {
return 0;
}
-
/*
* Opens a WIM file and creates a WIMStruct for it.
*/
-WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
- WIMStruct **w_ret)
+WIMLIBAPI int
+wimlib_open_wim(const mbchar *wim_file, int open_flags,
+ WIMStruct **w_ret,
+ wimlib_progress_func_t progress_func)
{
WIMStruct *w;
int ret;
- DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
+ if (!wim_file || !w_ret)
+ return WIMLIB_ERR_INVALID_PARAM;
+
w = new_wim_struct();
- if (!w) {
- ERROR("Failed to allocate memory for WIMStruct");
+ if (!w)
return WIMLIB_ERR_NOMEM;
- }
- ret = begin_read(w, wim_file, open_flags);
- if (ret == 0) {
+ ret = begin_read(w, wim_file, open_flags, progress_func);
+ if (ret == 0)
*w_ret = w;
- } else {
- DEBUG("Could not begin reading the WIM file `%s'", wim_file);
+ else
wimlib_free(w);
- }
return ret;
}
+void
+destroy_image_metadata(struct wim_image_metadata *imd,
+ struct wim_lookup_table *table)
+{
+ free_dentry_tree(imd->root_dentry, table);
+ free_security_data(imd->security_data);
+
+ /* Get rid of the lookup table entry for this image's metadata resource
+ * */
+ if (table) {
+ lookup_table_unlink(table, imd->metadata_lte);
+ free_lookup_table_entry(imd->metadata_lte);
+ }
+}
+
/* Frees the memory for the WIMStruct, including all internal memory; also
* closes all files associated with the WIMStruct. */
-WIMLIBAPI void wimlib_free(WIMStruct *w)
+WIMLIBAPI void
+wimlib_free(WIMStruct *w)
{
- DEBUG2("Freeing WIMStruct");
+ DEBUG("Freeing WIMStruct");
if (!w)
return;
if (w->out_fp)
fclose(w->out_fp);
+#ifdef WITH_FUSE
+ if (w->fp_tab) {
+ for (size_t i = 0; i < w->num_allocated_fps; i++)
+ if (w->fp_tab[i])
+ fclose(w->fp_tab[i]);
+ FREE(w->fp_tab);
+ }
+ pthread_mutex_destroy(&w->fp_tab_mutex);
+#endif
+
free_lookup_table(w->lookup_table);
FREE(w->filename);
FREE(w->xml_data);
free_wim_info(w->wim_info);
if (w->image_metadata) {
- for (uint i = 0; i < w->hdr.image_count; i++)
+ for (unsigned i = 0; i < w->hdr.image_count; i++)
destroy_image_metadata(&w->image_metadata[i], NULL);
FREE(w->image_metadata);
}
}
#endif
FREE(w);
+ DEBUG("Freed WIMStruct");
+}
+
+static bool test_locale_ctype_utf8()
+{
+ char *ctype = nl_langinfo(CODESET);
+
+ return (strstr(ctype, "UTF-8") == 0 ||
+ strstr(ctype, "UTF8") == 0 ||
+ strstr(ctype, "utf8") == 0 ||
+ strstr(ctype, "utf-8") == 0);
}
+bool wimlib_mbs_is_utf8;
+
+/* Get global memory allocations out of the way. Not strictly necessary in
+ * single-threaded programs like 'imagex'. */
+WIMLIBAPI int
+wimlib_global_init()
+{
+ libxml_global_init();
+#ifdef WITH_NTFS_3G
+ libntfs3g_global_init();
+#endif
+ wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
+ 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'). */
+WIMLIBAPI void
+wimlib_global_cleanup()
+{
+ libxml_global_cleanup();
+ iconv_global_cleanup();
+}