]> wimlib.net Git - wimlib/blobdiff - src/wim.c
Save original xml_data only when needed
[wimlib] / src / wim.c
index ac869302358aa283a562f68d218d888a284632fa..9bc025562cfa17289e639f972372ca4bbfd8a833 100644 (file)
--- a/src/wim.c
+++ b/src/wim.c
 #include <stdlib.h>
 #include <unistd.h>
 
-#ifdef WITH_NTFS_3G
-#  include <time.h>
-#  include <ntfs-3g/volume.h>
-#endif
-
 #ifdef __WIN32__
 #  include "win32.h"
 #else
@@ -70,7 +65,7 @@ static WIMStruct *
 new_wim_struct()
 {
        WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
-#ifdef WITH_FUSE
+#if defined(WITH_FUSE) || defined(ENABLE_MULTITHREADED_COMPRESSION)
        if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
                ERROR_WITH_ERRNO("Failed to initialize mutex");
                FREE(w);
@@ -115,49 +110,6 @@ for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
        return 0;
 }
 
-static int
-sort_image_metadata_by_position(const void *p1, const void *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)
-               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 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("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 {
-                       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. */
 static int
 wim_hdr_flags_compression_type(int wim_hdr_flags)
@@ -184,7 +136,7 @@ wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
        struct wim_lookup_table *table;
        int ret;
 
-       DEBUG("Creating new WIM with %s compression.",
+       DEBUG("Creating new WIM with %"TS" compression.",
              wimlib_get_compression_type_string(ctype));
 
        /* Allocate the WIMStruct. */
@@ -242,22 +194,20 @@ select_wim_image(WIMStruct *w, int 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;
-                       INIT_HLIST_HEAD(&imd->inode_list);
+                       destroy_image_metadata(imd, NULL, false);
                }
        }
        w->current_image = image;
-       imd = &w->image_metadata[image - 1];
+       imd = wim_get_current_image_metadata(w);
        if (imd->root_dentry) {
                ret = 0;
        } else {
                #ifdef ENABLE_DEBUG
                DEBUG("Reading metadata resource specified by the following "
                      "lookup table entry:");
-               print_lookup_table_entry(imd->metadata_lte, stdout);
+               print_lookup_table_entry(imd->metadata_lte, stderr);
                #endif
                ret = read_metadata_resource(w, imd);
                if (ret)
@@ -274,18 +224,18 @@ wimlib_get_compression_type(const WIMStruct *w)
        return wim_hdr_flags_compression_type(w->hdr.flags);
 }
 
-WIMLIBAPI const char *
+WIMLIBAPI const tchar *
 wimlib_get_compression_type_string(int ctype)
 {
        switch (ctype) {
                case WIMLIB_COMPRESSION_TYPE_NONE:
-                       return "None";
+                       return T("None");
                case WIMLIB_COMPRESSION_TYPE_LZX:
-                       return "LZX";
+                       return T("LZX");
                case WIMLIB_COMPRESSION_TYPE_XPRESS:
-                       return "XPRESS";
+                       return T("XPRESS");
                default:
-                       return "Invalid";
+                       return T("Invalid");
        }
 }
 
@@ -295,34 +245,33 @@ wimlib_get_compression_type_string(int ctype)
  * starting at 1.
  */
 WIMLIBAPI int
-wimlib_resolve_image(WIMStruct *w, const utf8char *image_name_or_num)
+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 || !*image_name_or_num)
                return WIMLIB_NO_IMAGE;
 
-       if (strcmp(image_name_or_num, "all") == 0
-           || strcmp(image_name_or_num, "*") == 0)
+       if (!tstrcasecmp(image_name_or_num, T("all"))
+           || !tstrcasecmp(image_name_or_num, T("*")))
                return WIMLIB_ALL_IMAGES;
-       image = strtol(image_name_or_num, &p, 10);
-       if (p != image_name_or_num && *p == '\0' && image > 0) {
+       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 WIMLIB_NO_IMAGE;
        }
 }
 
-
 /* Prints some basic information about a WIM file. */
 WIMLIBAPI void
 wimlib_print_wim_information(const WIMStruct *w)
@@ -330,21 +279,22 @@ 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.offset != 0) ? "yes" : "no");
-       putchar('\n');
+       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(wimlib_get_compression_type(w)));
+       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"));
+       tputchar(T('\n'));
 }
 
 WIMLIBAPI bool
@@ -361,21 +311,21 @@ wimlib_print_available_images(const WIMStruct *w, int image)
        int i;
        int n;
        if (image == WIMLIB_ALL_IMAGES) {
-               n = printf("Available Images:\n");
+               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);
 }
@@ -418,17 +368,6 @@ wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
        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;
 }
 
@@ -452,17 +391,17 @@ wimlib_get_boot_idx(const WIMStruct *w)
  * lookup table, and optionally checks the integrity.
  */
 static int
-begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
+begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
           wimlib_progress_func_t progress_func)
 {
        int ret;
        int xml_num_images;
 
-       DEBUG("Reading the WIM file `%s'", in_wim_path);
+       DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
 
-       w->fp = fopen(in_wim_path, "rb");
+       w->fp = tfopen(in_wim_path, T("rb"));
        if (!w->fp) {
-               ERROR_WITH_ERRNO("Failed to open `%s' for reading",
+               ERROR_WITH_ERRNO("Failed to open `%"TS"' for reading",
                                 in_wim_path);
                return WIMLIB_ERR_OPEN;
        }
@@ -489,14 +428,14 @@ begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
        }
 
        ret = read_header(w->fp, &w->hdr, open_flags);
-       if (ret != 0)
+       if (ret)
                return ret;
 
        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;
@@ -511,7 +450,7 @@ begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
        if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
                ret = check_wim_integrity(w, progress_func);
                if (ret == WIM_INTEGRITY_NONEXISTENT) {
-                       WARNING("No integrity information for `%s'; skipping "
+                       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)");
@@ -521,67 +460,30 @@ begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
                }
        }
 
-       ret = read_lookup_table(w);
-       if (ret != 0)
-               return ret;
-
-       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 image metadata structures",
-                             w->hdr.image_count);
+       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;
-               }
        }
-       w->current_image = 0;
-
-       DEBUG("Looking for metadata resources in the lookup table.");
-
-       /* Find the images in the WIM by searching the lookup table. */
-       ret = for_lookup_table_entry(w->lookup_table,
-                                    append_metadata_resource_entry, w);
 
-       if (ret != 0)
+       ret = read_lookup_table(w);
+       if (ret)
                return ret;
 
-       /* Make sure all the expected images were found.  (We already have
-        * 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 %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 wim_image_metadata), sort_image_metadata_by_position);
-
-       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)
+       ret = read_xml_data(w->fp, &w->hdr.xml_res_entry, &w->wim_info);
+       if (ret)
                return ret;
 
        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 "
+               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;
        }
 
-       DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
+       DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
        return 0;
 }
 
@@ -589,7 +491,7 @@ begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
  * Opens a WIM file and creates a WIMStruct for it.
  */
 WIMLIBAPI int
-wimlib_open_wim(const mbchar *wim_file, int open_flags,
+wimlib_open_wim(const tchar *wim_file, int open_flags,
                WIMStruct **w_ret,
                wimlib_progress_func_t progress_func)
 {
@@ -613,17 +515,125 @@ wimlib_open_wim(const mbchar *wim_file, int open_flags,
 
 void
 destroy_image_metadata(struct wim_image_metadata *imd,
-                      struct wim_lookup_table *table)
+                      struct wim_lookup_table *table,
+                      bool free_metadata_lte)
 {
        free_dentry_tree(imd->root_dentry, table);
+       imd->root_dentry = NULL;
        free_security_data(imd->security_data);
+       imd->security_data = NULL;
 
-       /* Get rid of the lookup table entry for this image's metadata resource
-        * */
-       if (table) {
-               lookup_table_unlink(table, imd->metadata_lte);
+       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;
+
+       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));
+
+       if (!imd_array)
+               return WIMLIB_ERR_NOMEM;
+       w->image_metadata = imd_array;
+       imd_array[w->hdr.image_count++] = imd;
+       return 0;
+}
+
+
+struct wim_image_metadata *
+new_image_metadata()
+{
+       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;
+}
+
+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;
+}
+
+/* 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;
 }
 
 /* Frees the memory for the WIMStruct, including all internal memory; also
@@ -653,19 +663,12 @@ wimlib_free(WIMStruct *w)
        free_lookup_table(w->lookup_table);
 
        FREE(w->filename);
-       FREE(w->xml_data);
        free_wim_info(w->wim_info);
        if (w->image_metadata) {
                for (unsigned i = 0; i < w->hdr.image_count; i++)
-                       destroy_image_metadata(&w->image_metadata[i], NULL);
+                       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);
-       }
-#endif
        FREE(w);
        DEBUG("Freed WIMStruct");
 }
@@ -673,24 +676,29 @@ wimlib_free(WIMStruct *w)
 static bool
 test_locale_ctype_utf8()
 {
+#ifdef __WIN32__
+       return false;
+#else
        char *ctype = nl_langinfo(CODESET);
 
-       return (strstr(ctype, "UTF-8") == 0 ||
-               strstr(ctype, "UTF8") == 0 ||
-               strstr(ctype, "utf8") == 0 ||
-               strstr(ctype, "utf-8") == 0);
+       return (!strstr(ctype, "UTF-8") ||
+               !strstr(ctype, "UTF8") ||
+               !strstr(ctype, "utf8") ||
+               !strstr(ctype, "utf-8"));
+#endif
 }
 
-/* Get global memory allocations out of the way.  Not strictly necessary in
- * single-threaded programs like 'imagex'. */
 WIMLIBAPI int
-wimlib_global_init()
+wimlib_global_init(int init_flags)
 {
        libxml_global_init();
-#ifdef WITH_NTFS_3G
-       libntfs3g_global_init();
-#endif
-       wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
+       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
@@ -704,4 +712,7 @@ wimlib_global_cleanup()
 {
        libxml_global_cleanup();
        iconv_global_cleanup();
+#ifdef __WIN32__
+       win32_global_cleanup();
+#endif
 }