/*
- * wim.c
+ * wim.c - Stuff that doesn't fit into any other file
*/
/*
- * Copyright (C) 2010 Carl Thijssen
- * Copyright (C) 2012 Eric Biggers
- *
- * wimlib - Library for working with WIM files
+ * Copyright (C) 2012, 2013 Eric Biggers
*
* This file is part of wimlib, a library for working with WIM files.
*
* along with wimlib; if not, see http://www.gnu.org/licenses/.
*/
-#include "config.h"
-#include <limits.h>
-#include <stdlib.h>
-#include <stdarg.h>
-
-#include "dentry.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+#include "wimlib/error.h"
+#include "wimlib/dentry.h"
+#include "wimlib/encoding.h"
+#include "wimlib/file_io.h"
+#include "wimlib/integrity.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/metadata.h"
#ifdef WITH_NTFS_3G
-#include <time.h>
-#include <ntfs-3g/volume.h>
+# include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
#endif
+#include "wimlib/security.h"
+#include "wimlib/wim.h"
+#include "wimlib/xml.h"
-#include "wimlib_internal.h"
-#include "io.h"
-#include "lookup_table.h"
-#include "xml.h"
+#ifdef __WIN32__
+# include "wimlib/win32.h" /* for realpath() replacement */
+#endif
+#include <errno.h>
+#include <fcntl.h>
+#ifndef __WIN32__
+# include <langinfo.h>
+#endif
+#include <limits.h>
+#include <stdarg.h>
+#include <stdlib.h>
+#include <unistd.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));
+ print_wim_security_data(wim_security_data(w));
return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
w->lookup_table);
}
-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(void)
{
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;
+ if (w) {
+ w->in_fd = -1;
+ w->out_fd = -1;
}
-#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)
-{
- const struct image_metadata *imd1 = p1;
- const struct image_metadata *imd2 = p2;
- u64 offset1 = imd1->metadata_lte->resource_entry.offset;
- u64 offset2 = imd2->metadata_lte->resource_entry.offset;
- if (offset1 < offset2)
- return -1;
- else if (offset1 > offset2)
- return 1;
- else
- return 0;
-}
-
-/*
- * 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)
-{
- 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",
- w->hdr.image_count);
- ret = WIMLIB_ERR_IMAGE_COUNT;
- } else {
- DEBUG("Found metadata resource for image %u at "
- "offset %"PRIu64".",
- w->current_image + 1,
- lte->resource_entry.offset);
- w->image_metadata[
- w->current_image++].metadata_lte = lte;
- }
- }
- return ret;
-}
-
-/* Returns the compression type given in the flags of a WIM header. */
-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;
- else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
- return WIM_COMPRESSION_TYPE_XPRESS;
- else
- return WIM_COMPRESSION_TYPE_INVALID;
- } else {
- return WIM_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.",
+ wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+
+ DEBUG("Creating new WIM with %"TS" compression.",
wimlib_get_compression_type_string(ctype));
/* Allocate the WIMStruct. */
goto out_free;
}
w->lookup_table = table;
+ w->refcnts_ok = 1;
+ w->compression_type = ctype;
*w_ret = w;
return 0;
out_free:
return ret;
}
-WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
+int
+select_wim_image(WIMStruct *w, int image)
{
- return w->hdr.image_count;
-}
-
-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) {
+ wimlib_assert(list_empty(&imd->unhashed_streams));
DEBUG("Freeing image %u", w->current_image);
- destroy_image_metadata(imd, NULL);
- imd->root_dentry = NULL;
- imd->security_data = NULL;
+ destroy_image_metadata(imd, NULL, false);
}
}
-
w->current_image = image;
imd = wim_get_current_image_metadata(w);
-
- if (imd->root_dentry) {
- return 0;
+ 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);
+ print_lookup_table_entry(imd->metadata_lte, stderr);
#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)
-{
- return wim_hdr_flags_compression_type(w->hdr.flags);
-}
-
-WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
+WIMLIBAPI const tchar *
+wimlib_get_compression_type_string(int ctype)
{
switch (ctype) {
- case WIM_COMPRESSION_TYPE_NONE:
- return "None";
- case WIM_COMPRESSION_TYPE_LZX:
- return "LZX";
- case WIM_COMPRESSION_TYPE_XPRESS:
- return "XPRESS";
+ case WIMLIB_COMPRESSION_TYPE_NONE:
+ return T("None");
+ case WIMLIB_COMPRESSION_TYPE_LZX:
+ return T("LZX");
+ case WIMLIB_COMPRESSION_TYPE_XPRESS:
+ return T("XPRESS");
default:
- return "Invalid";
+ return T("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 tchar *image_name_or_num)
{
- char *p;
- int image;
+ tchar *p;
+ long 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;
- 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 (!tstrcasecmp(image_name_or_num, T("all"))
+ || !tstrcasecmp(image_name_or_num, T("*")))
+ return WIMLIB_ALL_IMAGES;
+ image = tstrtol(image_name_or_num, &p, 10);
+ if (p != image_name_or_num && *p == T('\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++) {
- if (strcmp(image_name_or_num,
- wimlib_get_image_name(w, i)) == 0)
+ if (!tstrcmp(image_name_or_num,
+ wimlib_get_image_name(w, i)))
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;
hdr = &w->hdr;
- puts("WIM Information:");
- puts("----------------");
- printf("Path: %s\n", w->filename);
- fputs ("GUID: 0x", stdout);
- print_byte_field(hdr->guid, WIM_GID_LEN);
- putchar('\n');
- printf("Image Count: %d\n", hdr->image_count);
- printf("Compression: %s\n", wimlib_get_compression_type_string(
- wimlib_get_compression_type(w)));
- printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
- 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");
- putchar('\n');
-}
-
-WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
+ tputs(T("WIM Information:"));
+ tputs(T("----------------"));
+ tprintf(T("Path: %"TS"\n"), w->filename);
+ tfputs(T("GUID: 0x"), stdout);
+ print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
+ tputchar(T('\n'));
+ tprintf(T("Image Count: %d\n"), hdr->image_count);
+ tprintf(T("Compression: %"TS"\n"),
+ wimlib_get_compression_type_string(w->compression_type));
+ tprintf(T("Part Number: %d/%d\n"), hdr->part_number, hdr->total_parts);
+ tprintf(T("Boot Index: %d\n"), hdr->boot_idx);
+ tprintf(T("Size: %"PRIu64" bytes\n"),
+ wim_info_get_total_bytes(w->wim_info));
+ tprintf(T("Integrity Info: %"TS"\n"),
+ (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
+ tprintf(T("Relative path junction: %"TS"\n"),
+ (hdr->flags & WIM_HDR_FLAG_RP_FIX) ? T("yes") : T("no"));
+ tputchar(T('\n'));
+}
+
+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) {
- n = printf("Available Images:\n");
+ if (image == WIMLIB_ALL_IMAGES) {
+ n = tprintf(T("Available Images:\n"));
first = 1;
last = w->hdr.image_count;
} else if (image >= 1 && image <= w->hdr.image_count) {
- n = printf("Information for Image %d\n", image);
+ n = tprintf(T("Information for Image %d\n"), image);
first = image;
last = image;
} else {
- printf("wimlib_print_available_images(): Invalid image %d",
- image);
+ tprintf(T("wimlib_print_available_images(): Invalid image %d"),
+ image);
return;
}
for (i = 0; i < n - 1; i++)
- putchar('-');
- putchar('\n');
+ tputchar(T('-'));
+ tputchar(T('\n'));
for (i = first; i <= last; i++)
print_image_info(w->wim_info, i);
}
-/* 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_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
{
- 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;
+ memset(info, 0, sizeof(struct wimlib_wim_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->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->opened_from_file = (wim->filename != NULL);
+ info->is_readonly == (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
+ (wim->hdr.total_parts != 1) ||
+ (wim->filename && taccess(wim->filename, W_OK));
+ info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
+ info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
+ info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
+ 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;
return 0;
}
-WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
+
+/* 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 = w->hdr.total_parts;
- return w->hdr.part_number;
+ *total_parts_ret = info.total_parts;
+ return info.part_number;
+}
+
+WIMLIBAPI int
+wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
+{
+ int ret;
+
+ if (which & WIMLIB_CHANGE_READONLY_FLAG) {
+ if (info->is_marked_readonly)
+ wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
+ else
+ wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
+ }
+
+ if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
+ return 0;
+
+ ret = can_modify_wim(wim);
+ if (ret)
+ return ret;
+
+ if (which & WIMLIB_CHANGE_GUID)
+ memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
+
+ if (which & WIMLIB_CHANGE_BOOT_INDEX) {
+ if (info->boot_index < 0 || 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;
+ }
+ wim->hdr.boot_idx = info->boot_index;
+ }
+
+ if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
+ if (info->has_rpfix)
+ wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
+ else
+ wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
+ }
+ return 0;
}
+/* Deprecated */
+WIMLIBAPI int
+wimlib_set_boot_idx(WIMStruct *wim, int boot_idx)
+{
+ struct wimlib_wim_info info;
-WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
+ info.boot_index = boot_idx;
+ return wimlib_set_wim_info(wim, &info, WIMLIB_CHANGE_BOOT_INDEX);
+}
+
+static int
+do_open_wim(const tchar *filename, int *fd_ret)
{
- return w->hdr.boot_idx;
+ int fd;
+
+ fd = topen(filename, O_RDONLY | O_BINARY);
+ if (fd == -1) {
+ ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
+ return WIMLIB_ERR_OPEN;
+ }
+ *fd_ret = fd;
+ return 0;
+}
+
+int
+reopen_wim(WIMStruct *w)
+{
+ wimlib_assert(w->in_fd == -1);
+ return do_open_wim(w->filename, &w->in_fd);
+}
+
+int
+close_wim(WIMStruct *w)
+{
+ if (w->in_fd != -1) {
+ close(w->in_fd);
+ w->in_fd = -1;
+ }
+ 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 *w, const char *in_wim_path, int open_flags)
+static int
+begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
+ wimlib_progress_func_t progress_func)
{
int ret;
- uint xml_num_images;
-
- DEBUG("Reading the WIM file `%s'", in_wim_path);
+ int xml_num_images;
- w->fp = fopen(in_wim_path, "rb");
+ DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
- if (!w->fp) {
- ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
- in_wim_path);
- return WIMLIB_ERR_OPEN;
- }
+ ret = do_open_wim(in_wim_path, &w->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.
+ */
w->filename = realpath(in_wim_path, NULL);
if (!w->filename) {
ERROR_WITH_ERRNO("Failed to resolve WIM filename");
- return WIMLIB_ERR_NOMEM;
+ if (errno == ENOMEM)
+ return WIMLIB_ERR_NOMEM;
+ else
+ return WIMLIB_ERR_OPEN;
}
- ret = read_header(w->fp, &w->hdr, open_flags);
- if (ret != 0)
+ ret = read_header(w->filename, w->in_fd, &w->hdr);
+ if (ret)
return ret;
- DEBUG("Wim file contains %u images", w->hdr.image_count);
+ if (w->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);
+ }
+
+ if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
+ ret = can_modify_wim(w);
+ if (ret)
+ return ret;
+ }
+
+ if (w->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, w->hdr.part_number, w->hdr.total_parts);
+ return WIMLIB_ERR_SPLIT_UNSUPPORTED;
+ }
+
+ 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) {
- WARNING("In `%s', image %u is marked as bootable, "
+ WARNING("In `%"TS"', image %u is marked as bootable, "
"but there are only %u images in the WIM",
in_wim_path, 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)",
- w->hdr.flags);
- return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ /* Check and cache the compression type */
+ if (w->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
+ if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
+ if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
+ ERROR("Multiple compression flags are set in \"%"TS"\"",
+ in_wim_path);
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ }
+ w->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
+ } else if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
+ w->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
+ } else {
+ ERROR("The compression flag is set on \"%"TS"\", but "
+ "neither the XPRESS nor LZX flag is set",
+ in_wim_path);
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ }
+ } else {
+ BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_NONE != 0);
}
-
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) {
- WARNING("No integrity information for `%s'; skipping "
- "integrity check.", w->filename);
- } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
+ ret = check_wim_integrity(w, progress_func);
+ if (ret == WIM_INTEGRITY_NONEXISTENT) {
+ WARNING("No integrity information for `%"TS"'; skipping "
+ "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;
+ if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
+ w->image_metadata = new_image_metadata_array(w->hdr.image_count);
+ if (!w->image_metadata)
+ return WIMLIB_ERR_NOMEM;
}
ret = read_lookup_table(w);
- if (ret != 0)
+ if (ret)
return ret;
- w->image_metadata = CALLOC(w->hdr.image_count,
- sizeof(struct image_metadata));
+ ret = read_xml_data(w->in_fd, &w->hdr.xml_res_entry, &w->wim_info);
+ if (ret)
+ return ret;
- if (!w->image_metadata) {
- ERROR("Failed to allocate memory for %u metadata structures",
- w->hdr.image_count);
- return WIMLIB_ERR_NOMEM;
+ xml_num_images = wim_info_get_num_images(w->wim_info);
+ if (xml_num_images != w->hdr.image_count) {
+ ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
+ "in the XML data,", in_wim_path, xml_num_images);
+ ERROR("but %u images in the WIM! There must be exactly one "
+ "<IMAGE> element per image.", w->hdr.image_count);
+ return WIMLIB_ERR_IMAGE_COUNT;
}
- w->current_image = 0;
- DEBUG("Looking for metadata resources in the lookup table.");
+ DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
+ 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)
+{
+ WIMStruct *wim;
+ int ret;
+
+ wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
- /* Find the images in the WIM by searching the lookup table. */
- ret = for_lookup_table_entry(w->lookup_table,
- append_metadata_resource_entry, w);
+ ret = WIMLIB_ERR_INVALID_PARAM;
+ if (!wim_file || !wim_ret)
+ goto out;
- if (ret != 0)
- return ret;
+ ret = WIMLIB_ERR_NOMEM;
+ wim = new_wim_struct();
+ if (!wim)
+ goto out;
- /* Make sure all the expected images were found. (We already have
- * returned false 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",
- w->current_image, w->hdr.image_count);
- return WIMLIB_ERR_IMAGE_COUNT;
+ ret = begin_read(wim, wim_file, open_flags, progress_func);
+ if (ret)
+ goto out_wimlib_free;
+
+ ret = 0;
+ *wim_ret = wim;
+ goto out;
+out_wimlib_free:
+ wimlib_free(wim);
+out:
+ return ret;
+}
+
+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) {
+ 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 *w, struct wim_image_metadata *imd)
+{
+ struct wim_image_metadata **imd_array;
- /* 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);
+ DEBUG("Reallocating image metadata array for image_count = %u",
+ w->hdr.image_count + 1);
+ imd_array = REALLOC(w->image_metadata,
+ sizeof(w->image_metadata[0]) * (w->hdr.image_count + 1));
- w->current_image = WIM_NO_IMAGE;
+ if (!imd_array)
+ return WIMLIB_ERR_NOMEM;
+ w->image_metadata = imd_array;
+ imd_array[w->hdr.image_count++] = imd;
+ return 0;
+}
- /* 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");
- return ret;
+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;
+}
- xml_num_images = wim_info_get_num_images(w->wim_info);
- if (xml_num_images != w->hdr.image_count) {
- ERROR("In the file `%s', there are %u <IMAGE> elements "
- "in the XML data,", in_wim_path, xml_num_images);
- ERROR("but %u images in the WIM! There must be exactly one "
- "<IMAGE> element per image.", w->hdr.image_count);
- return WIMLIB_ERR_IMAGE_COUNT;
+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) {
+ 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]) {
+ for (unsigned j = 0; j < i; j++)
+ put_image_metadata(imd_array[j], NULL);
+ FREE(imd_array);
+ return NULL;
+ }
}
+ return imd_array;
+}
- DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
+/* Checksum all streams that are unhashed (other than the metadata streams),
+ * merging them into the lookup table as needed. This is a no-op unless the
+ * library has previously used to add or mount an image using the same
+ * WIMStruct. */
+int
+wim_checksum_unhashed_streams(WIMStruct *w)
+{
+ int ret;
+ for (int i = 0; i < w->hdr.image_count; i++) {
+ struct wim_lookup_table_entry *lte, *tmp;
+ struct wim_image_metadata *imd = w->image_metadata[i];
+ image_for_each_unhashed_stream_safe(lte, tmp, imd) {
+ ret = hash_unhashed_stream(lte, w->lookup_table, NULL);
+ if (ret)
+ return ret;
+ }
+ }
return 0;
}
+/*
+ * can_modify_wim - Check if a given WIM is writeable. This is only the case if
+ * it meets the following three conditions:
+ *
+ * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
+ * 2. The WIM is not part of a spanned set.
+ * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
+ *
+ * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
+ */
+int
+can_modify_wim(WIMStruct *wim)
+{
+ if (wim->filename) {
+ if (taccess(wim->filename, W_OK)) {
+ ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ }
+ if (wim->hdr.total_parts != 1) {
+ ERROR("Cannot modify \"%"TS"\": is part of a spanned set",
+ wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
+ ERROR("Cannot modify \"%"TS"\": is marked read-only",
+ wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ return 0;
+}
/*
- * Opens a WIM file and creates a WIMStruct for it.
+ * can_delete_from_wim - Check if files or images can be deleted from a given
+ * WIM file.
+ *
+ * This theoretically should be exactly the same as can_modify_wim(), but
+ * unfortunately, due to bugs in Microsoft's software that generate incorrect
+ * reference counts for some WIM resources, we need to run expensive
+ * verifications to make sure the reference counts are correct on all WIM
+ * resources. Otherwise we might delete a WIM resource whose reference count
+ * has fallen to 0, but is actually still referenced somewhere.
*/
-WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
- WIMStruct **w_ret)
+int
+can_delete_from_wim(WIMStruct *wim)
{
- WIMStruct *w;
int ret;
- DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
- w = new_wim_struct();
- if (!w) {
- ERROR("Failed to allocate memory for WIMStruct");
- return WIMLIB_ERR_NOMEM;
- }
-
- ret = begin_read(w, wim_file, open_flags);
- if (ret == 0) {
- *w_ret = w;
- } else {
- DEBUG("Could not begin reading the WIM file `%s'", wim_file);
- wimlib_free(w);
- }
- return ret;
+ ret = can_modify_wim(wim);
+ if (ret)
+ return ret;
+ if (!wim->refcnts_ok)
+ wim_recalculate_refcnts(wim);
+ return 0;
}
/* 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->fp)
- fclose(w->fp);
- 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
+ if (w->in_fd != -1)
+ close(w->in_fd);
+ if (w->out_fd != -1)
+ close(w->out_fd);
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++)
- destroy_image_metadata(&w->image_metadata[i], NULL);
+ for (unsigned i = 0; i < w->hdr.image_count; i++)
+ put_image_metadata(w->image_metadata[i], NULL);
FREE(w->image_metadata);
}
-#ifdef WITH_NTFS_3G
- if (w->ntfs_vol) {
- DEBUG("Unmounting NTFS volume");
- ntfs_umount(w->ntfs_vol, FALSE);
+ FREE(w);
+ DEBUG("Freed WIMStruct");
+}
+
+static bool
+test_locale_ctype_utf8(void)
+{
+#ifdef __WIN32__
+ return false;
+#else
+ char *ctype = nl_langinfo(CODESET);
+
+ return (!strstr(ctype, "UTF-8") ||
+ !strstr(ctype, "UTF8") ||
+ !strstr(ctype, "utf8") ||
+ !strstr(ctype, "utf-8"));
+#endif
+}
+
+WIMLIBAPI int
+wimlib_global_init(int init_flags)
+{
+ static bool already_inited = false;
+
+ if (already_inited)
+ return 0;
+ libxml_global_init();
+ if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
+ wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
+ #ifdef WITH_NTFS_3G
+ if (!wimlib_mbs_is_utf8)
+ libntfs3g_global_init();
+ #endif
}
+#ifdef __WIN32__
+ win32_global_init();
#endif
- FREE(w);
+ 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'). */
+WIMLIBAPI void
+wimlib_global_cleanup(void)
+{
+ libxml_global_cleanup();
+ iconv_global_cleanup();
+#ifdef __WIN32__
+ win32_global_cleanup();
+#endif
+}
git://wimlib.net / wimlib / blobdiff