]> wimlib.net Git - wimlib/blobdiff - src/wim.c
wim.c: Cleanup
[wimlib] / src / wim.c
index f91c98bc4b0b7d12add9c585c4314966a3493070..c0825687f7f3f38ab4141090dce344f1e5fc1715 100644 (file)
--- a/src/wim.c
+++ b/src/wim.c
@@ -70,11 +70,87 @@ new_wim_struct(void)
        if (wim) {
                wim->in_fd.fd = -1;
                wim->out_fd.fd = -1;
+               INIT_LIST_HEAD(&wim->subwims);
        }
-       INIT_LIST_HEAD(&wim->resource_wims);
        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
+        */
+       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) didn't seem to support XPRESS chunk size
+                * below 32768 bytes, but larger power-of-two sizes appear to be
+                * supported.  67108864 was the largest size that worked.
+                * (Note, however, that the offsets of XPRESS matches are still
+                * limited to 65535 bytes even when a much larger chunk size is
+                * used!)
+                *
+                * WIMGAPI (Windows 8) seemed to have removed the support for
+                * larger XPRESS chunk sizes and will refuse to open such WIMs.
+                *
+                * 2^15 = 32768 is the default value used for compatibility, but
+                * wimlib can actually use up to 2^26.  */
+               return order >= 15 && order <= 26;
+       }
+       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)
+{
+       return 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
@@ -124,21 +200,24 @@ wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
 
        /* 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->lookup_table = table;
        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:
@@ -293,7 +372,7 @@ 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_VERSION;
-       info->chunk_size = WIM_CHUNK_SIZE;
+       info->chunk_size = wim->hdr.chunk_size;
        info->part_number = wim->hdr.part_number;
        info->total_parts = wim->hdr.total_parts;
        info->compression_type = wim->compression_type;
@@ -333,8 +412,10 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic
        if (ret)
                return ret;
 
-       if (which & WIMLIB_CHANGE_GUID)
+       if (which & WIMLIB_CHANGE_GUID) {
                memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
+               wim->guid_set_explicitly = 1;
+       }
 
        if (which & WIMLIB_CHANGE_BOOT_INDEX) {
                if (info->boot_index > wim->hdr.image_count) {
@@ -354,6 +435,57 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic
        return 0;
 }
 
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
+{
+       switch (ctype) {
+       case WIMLIB_COMPRESSION_TYPE_INVALID:
+               break;
+       case WIMLIB_COMPRESSION_TYPE_NONE:
+       case WIMLIB_COMPRESSION_TYPE_LZX:
+       case WIMLIB_COMPRESSION_TYPE_XPRESS:
+               wim->out_compression_type = ctype;
+
+               /* Reset the chunk size if it's no longer valid.  */
+               if (!wim_chunk_size_valid(wim->out_chunk_size,
+                                         wim->out_compression_type))
+                       wim->out_chunk_size = wim_default_chunk_size(wim->out_compression_type);
+               return 0;
+       }
+       return WIMLIB_ERR_INVALID_PARAM;
+}
+
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
+{
+       if (!wim_chunk_size_valid(chunk_size, wim->out_compression_type)) {
+               ERROR("Invalid chunk size (%"PRIu32" bytes) "
+                     "for compression type %"TS"!",
+                     chunk_size,
+                     wimlib_get_compression_type_string(wim->out_compression_type));
+               switch (wim->out_compression_type) {
+               case WIMLIB_COMPRESSION_TYPE_XPRESS:
+                       ERROR("Valid chunk sizes for XPRESS are "
+                             "32768, 65536, 131072, ..., 67108864.");
+                       break;
+               case WIMLIB_COMPRESSION_TYPE_LZX:
+                       ERROR("Valid chunk sizes for LZX are "
+                             "32768, 65536, 131072, ..., 2097152.");
+                       break;
+               }
+               return WIMLIB_ERR_INVALID_CHUNK_SIZE;
+       }
+       if (chunk_size != 32768) {
+               WARNING  ("Changing the compression chunk size to any value other than\n"
+               "          the default of 32768 bytes eliminates compatibility with\n"
+               "          Microsoft's software!");
+       }
+       wim->out_chunk_size = chunk_size;
+       return 0;
+}
+
 static int
 do_open_wim(const tchar *filename, struct filedes *fd_ret)
 {
@@ -418,10 +550,10 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
                 * intervening time...
                 *
                 * Warning: in Windows native builds, realpath() calls the
-                * replacement function in win32.c.
+                * 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;
@@ -435,9 +567,10 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
                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) {
@@ -446,11 +579,9 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
                        return ret;
        }
 
-       if (wim->hdr.total_parts != 1 && !(open_flags & WIMLIB_OPEN_FLAG_SPLIT_OK)) {
-               ERROR("\"%"TS"\": This WIM is part %u of a %u-part WIM",
-                     wimfile, wim->hdr.part_number, wim->hdr.total_parts);
-               return WIMLIB_ERR_SPLIT_UNSUPPORTED;
-       }
+       if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
+           (wim->hdr.total_parts != 1))
+               return WIMLIB_ERR_IS_SPLIT_WIM;
 
        DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
 
@@ -482,6 +613,17 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
        } else {
                wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
        }
+       wim->out_compression_type = wim->compression_type;
+
+       /* Check and cache the chunk size.  */
+       wim->chunk_size = wim->out_chunk_size = wim->hdr.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);
@@ -498,13 +640,13 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
 
        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);
@@ -537,26 +679,21 @@ open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
 
        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;
        *wim_ret = wim;
-       goto out;
-out_wimlib_free:
-       wimlib_free(wim);
-out:
-       return ret;
+       return 0;
 }
 
 /* API function documented in wimlib.h  */
@@ -583,7 +720,7 @@ destroy_image_metadata(struct wim_image_metadata *imd,
                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);
@@ -620,7 +757,7 @@ append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
        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;
@@ -655,14 +792,14 @@ new_image_metadata_array(unsigned num_images)
 
        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);
@@ -680,6 +817,9 @@ int
 wim_checksum_unhashed_streams(WIMStruct *wim)
 {
        int ret;
+
+       if (!wim_has_metadata(wim))
+               return 0;
        for (int i = 0; i < wim->hdr.image_count; i++) {
                struct wim_lookup_table_entry *lte, *tmp;
                struct wim_image_metadata *imd = wim->image_metadata[i];
@@ -712,7 +852,7 @@ can_modify_wim(WIMStruct *wim)
                }
        }
        if (wim->hdr.total_parts != 1) {
-               ERROR("Cannot modify \"%"TS"\": is part of a spanned set",
+               ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
                      wim->filename);
                return WIMLIB_ERR_WIM_IS_READONLY;
        }
@@ -743,8 +883,11 @@ can_delete_from_wim(WIMStruct *wim)
        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;
 }
 
@@ -752,22 +895,19 @@ can_delete_from_wim(WIMStruct *wim)
 WIMLIBAPI void
 wimlib_free(WIMStruct *wim)
 {
-       DEBUG("Freeing WIMStruct");
-
-       if (!wim)
+       if (wim == NULL)
                return;
 
-       while (!list_empty(&wim->resource_wims)) {
-               WIMStruct *resource_wim;
+       DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
+             wim->filename, wim->hdr.image_count);
 
-               resource_wim = list_entry(wim->resource_wims.next,
-                                         WIMStruct, resource_wim_node);
-               if (resource_wim->is_owned_by_master) {
-                       list_del(&resource_wim->resource_wim_node);
-                       wimlib_free(resource_wim);
-               } else {
-                       wimlib_unreference_resources(wim, &resource_wim, 1);
-               }
+       while (!list_empty(&wim->subwims)) {
+               WIMStruct *subwim;
+
+               subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
+               list_del(&subwim->subwim_node);
+               DEBUG("Freeing subwim.");
+               wimlib_free(subwim);
        }
 
        if (filedes_valid(&wim->in_fd))
@@ -775,6 +915,7 @@ wimlib_free(WIMStruct *wim)
        if (filedes_valid(&wim->out_fd))
                filedes_close(&wim->out_fd);
 
+       wimlib_lzx_free_context(wim->lzx_context);
 
        free_lookup_table(wim->lookup_table);
 
@@ -786,7 +927,6 @@ wimlib_free(WIMStruct *wim)
                FREE(wim->image_metadata);
        }
        FREE(wim);
-       DEBUG("Freed WIMStruct");
 }
 
 static bool