2 * wim.c - Stuff that doesn't fit into any other file
6 * Copyright (C) 2012, 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
28 #include "wimlib/error.h"
29 #include "wimlib/dentry.h"
30 #include "wimlib/encoding.h"
31 #include "wimlib/file_io.h"
32 #include "wimlib/integrity.h"
33 #include "wimlib/lookup_table.h"
34 #include "wimlib/metadata.h"
36 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
38 #include "wimlib/security.h"
39 #include "wimlib/wim.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/compressor_ops.h"
42 #include "wimlib/decompressor_ops.h"
45 # include "wimlib/win32.h" /* for realpath() replacement */
51 # include <langinfo.h>
59 image_print_metadata(WIMStruct *wim)
61 DEBUG("Printing metadata for image %d", wim->current_image);
62 print_wim_security_data(wim_security_data(wim));
63 return for_dentry_in_tree(wim_root_dentry(wim), print_dentry,
68 wim_default_pack_compression_type(void)
70 return WIMLIB_COMPRESSION_TYPE_LZMS;
74 wim_default_pack_chunk_size(int ctype) {
76 case WIMLIB_COMPRESSION_TYPE_LZMS:
77 /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible.
79 return 1U << 25; /* 33554432 */
81 return 1U << 15; /* 32768 */
88 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
90 filedes_invalidate(&wim->in_fd);
91 filedes_invalidate(&wim->out_fd);
92 wim->out_pack_compression_type = wim_default_pack_compression_type();
93 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
94 wim->out_pack_compression_type);
95 INIT_LIST_HEAD(&wim->subwims);
100 /* Determine if the chunk size is valid for the specified compression type. */
102 wim_chunk_size_valid(u32 chunk_size, int ctype)
106 /* Chunk size is meaningless for uncompressed WIMs --- any value is
108 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
111 /* Chunk size must be power of 2. */
114 order = bsr32(chunk_size);
115 if (chunk_size != 1U << order)
134 /* See the documentation for the --chunk-size option of `wimlib-imagex
135 * capture' for information about allowed chunk sizes. */
137 case WIMLIB_COMPRESSION_TYPE_LZX:
138 return order >= 15 && order <= 21;
140 case WIMLIB_COMPRESSION_TYPE_XPRESS:
141 case WIMLIB_COMPRESSION_TYPE_LZMS:
142 return order >= 15 && order <= 26;
147 /* Return the default chunk size to use for the specified compression type.
149 * See notes above in wim_chunk_size_valid(). */
151 wim_default_chunk_size(int ctype)
154 case WIMLIB_COMPRESSION_TYPE_LZMS:
155 return 1U << 17; /* 131072 */
157 return 1U << 15; /* 32768 */
162 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
163 * @visitor is called on the WIM once for each image, with each image selected
164 * as the current image in turn. If @image is a certain image, @visitor is
165 * called on the WIM only once, with that image selected.
168 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
175 if (image == WIMLIB_ALL_IMAGES) {
177 end = wim->hdr.image_count;
178 } else if (image >= 1 && image <= wim->hdr.image_count) {
182 return WIMLIB_ERR_INVALID_IMAGE;
184 for (i = start; i <= end; i++) {
185 ret = select_wim_image(wim, i);
195 /* API function documented in wimlib.h */
197 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
200 struct wim_lookup_table *table;
203 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
205 DEBUG("Creating new WIM with %"TS" compression.",
206 wimlib_get_compression_type_string(ctype));
208 /* Allocate the WIMStruct. */
209 wim = new_wim_struct();
211 return WIMLIB_ERR_NOMEM;
213 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
217 table = new_lookup_table(9001);
219 ret = WIMLIB_ERR_NOMEM;
222 wim->lookup_table = table;
224 wim->compression_type = ctype;
225 wim->out_compression_type = ctype;
226 wim->chunk_size = wim->hdr.chunk_size;
227 wim->out_chunk_size = wim->hdr.chunk_size;
236 select_wim_image(WIMStruct *wim, int image)
238 struct wim_image_metadata *imd;
241 DEBUG("Selecting image %d", image);
243 if (image == WIMLIB_NO_IMAGE) {
244 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
245 return WIMLIB_ERR_INVALID_IMAGE;
248 if (image == wim->current_image)
251 if (image < 1 || image > wim->hdr.image_count) {
252 ERROR("Cannot select image %d: There are only %u images",
253 image, wim->hdr.image_count);
254 return WIMLIB_ERR_INVALID_IMAGE;
257 if (!wim_has_metadata(wim)) {
258 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
259 if (wim->hdr.part_number != 1)
260 ERROR("Specify the first part of the split WIM instead.");
261 return WIMLIB_ERR_METADATA_NOT_FOUND;
264 /* If a valid image is currently selected, it can be freed if it is not
266 if (wim->current_image != WIMLIB_NO_IMAGE) {
267 imd = wim_get_current_image_metadata(wim);
268 if (!imd->modified) {
269 wimlib_assert(list_empty(&imd->unhashed_streams));
270 DEBUG("Freeing image %u", wim->current_image);
271 destroy_image_metadata(imd, NULL, false);
274 wim->current_image = image;
275 imd = wim_get_current_image_metadata(wim);
276 if (imd->root_dentry || imd->modified) {
280 DEBUG("Reading metadata resource specified by the following "
281 "lookup table entry:");
282 print_lookup_table_entry(imd->metadata_lte, stderr);
284 ret = read_metadata_resource(wim, imd);
286 wim->current_image = WIMLIB_NO_IMAGE;
292 /* API function documented in wimlib.h */
293 WIMLIBAPI const tchar *
294 wimlib_get_compression_type_string(int ctype)
297 case WIMLIB_COMPRESSION_TYPE_NONE:
299 case WIMLIB_COMPRESSION_TYPE_LZX:
301 case WIMLIB_COMPRESSION_TYPE_XPRESS:
303 case WIMLIB_COMPRESSION_TYPE_LZMS:
310 /* API function documented in wimlib.h */
312 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
318 if (!image_name_or_num || !*image_name_or_num)
319 return WIMLIB_NO_IMAGE;
321 if (!tstrcasecmp(image_name_or_num, T("all"))
322 || !tstrcasecmp(image_name_or_num, T("*")))
323 return WIMLIB_ALL_IMAGES;
324 image = tstrtol(image_name_or_num, &p, 10);
325 if (p != image_name_or_num && *p == T('\0') && image > 0) {
326 if (image > wim->hdr.image_count)
327 return WIMLIB_NO_IMAGE;
330 for (i = 1; i <= wim->hdr.image_count; i++) {
331 if (!tstrcmp(image_name_or_num,
332 wimlib_get_image_name(wim, i)))
335 return WIMLIB_NO_IMAGE;
339 /* API function documented in wimlib.h */
341 wimlib_print_available_images(const WIMStruct *wim, int image)
347 if (image == WIMLIB_ALL_IMAGES) {
348 n = tprintf(T("Available Images:\n"));
350 last = wim->hdr.image_count;
351 } else if (image >= 1 && image <= wim->hdr.image_count) {
352 n = tprintf(T("Information for Image %d\n"), image);
356 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
360 for (i = 0; i < n - 1; i++)
363 for (i = first; i <= last; i++)
364 print_image_info(wim->wim_info, i);
368 /* API function documented in wimlib.h */
370 wimlib_print_metadata(WIMStruct *wim, int image)
372 return for_image(wim, image, image_print_metadata);
375 /* API function documented in wimlib.h */
377 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
379 memset(info, 0, sizeof(struct wimlib_wim_info));
380 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
381 info->image_count = wim->hdr.image_count;
382 info->boot_index = wim->hdr.boot_idx;
383 info->wim_version = wim->hdr.wim_version;
384 info->chunk_size = wim->chunk_size;
385 info->part_number = wim->hdr.part_number;
386 info->total_parts = wim->hdr.total_parts;
387 info->compression_type = wim->compression_type;
388 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
389 info->has_integrity_table = wim_has_integrity_table(wim);
390 info->opened_from_file = (wim->filename != NULL);
391 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
392 (wim->hdr.total_parts != 1) ||
393 (wim->filename && taccess(wim->filename, W_OK));
394 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
395 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
396 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
397 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
398 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
399 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
400 info->pipable = wim_is_pipable(wim);
404 /* API function documented in wimlib.h */
406 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
410 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
411 if (info->is_marked_readonly)
412 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
414 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
417 if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
420 ret = can_modify_wim(wim);
424 if (which & WIMLIB_CHANGE_GUID) {
425 memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
426 wim->guid_set_explicitly = 1;
429 if (which & WIMLIB_CHANGE_BOOT_INDEX) {
430 if (info->boot_index > wim->hdr.image_count) {
431 ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
433 return WIMLIB_ERR_INVALID_IMAGE;
435 wim->hdr.boot_idx = info->boot_index;
438 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
440 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
442 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
448 set_out_ctype(int ctype, u8 *out_ctype_p)
451 case WIMLIB_COMPRESSION_TYPE_INVALID:
453 case WIMLIB_COMPRESSION_TYPE_NONE:
454 case WIMLIB_COMPRESSION_TYPE_LZX:
455 case WIMLIB_COMPRESSION_TYPE_XPRESS:
456 case WIMLIB_COMPRESSION_TYPE_LZMS:
457 *out_ctype_p = ctype;
460 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
463 /* API function documented in wimlib.h */
465 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
467 int ret = set_out_ctype(ctype, &wim->out_compression_type);
471 /* Reset the chunk size if it's no longer valid. */
472 if (!wim_chunk_size_valid(ctype, wim->out_chunk_size))
473 wim->out_chunk_size = wim_default_chunk_size(ctype);
477 /* API function documented in wimlib.h */
479 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
481 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
485 /* Reset the chunk size if it's no longer valid. */
486 if (!wim_chunk_size_valid(ctype, wim->out_pack_chunk_size))
487 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
492 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
494 if (!wim_chunk_size_valid(chunk_size, ctype)) {
495 ERROR("Invalid chunk size (%"PRIu32" bytes) "
496 "for compression type %"TS"!",
498 wimlib_get_compression_type_string(ctype));
499 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
502 *out_chunk_size_p = chunk_size;
506 /* API function documented in wimlib.h */
508 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
510 if (chunk_size == 0) {
511 wim->out_chunk_size =
512 wim_default_chunk_size(wim->out_compression_type);
516 return set_out_chunk_size(chunk_size,
517 wim->out_compression_type,
518 &wim->out_chunk_size);
521 /* API function documented in wimlib.h */
523 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
525 if (chunk_size == 0) {
526 wim->out_pack_chunk_size =
527 wim_default_pack_chunk_size(wim->out_pack_compression_type);
531 return set_out_chunk_size(chunk_size,
532 wim->out_pack_compression_type,
533 &wim->out_pack_chunk_size);
537 open_wim_file(const tchar *filename, struct filedes *fd_ret)
541 raw_fd = topen(filename, O_RDONLY | O_BINARY);
543 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
544 return WIMLIB_ERR_OPEN;
546 filedes_init(fd_ret, raw_fd);
551 * Begins the reading of a WIM file; opens the file and reads its header and
552 * lookup table, and optionally checks the integrity.
555 begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
556 int open_flags, wimlib_progress_func_t progress_func)
560 const tchar *wimfile;
562 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
564 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
565 wim->in_fd.is_pipe = 1;
567 wimfile = wim_filename_or_fd;
568 ret = open_wim_file(wimfile, &wim->in_fd);
572 /* The absolute path to the WIM is requested so that
573 * wimlib_overwrite() still works even if the process changes
574 * its working directory. This actually happens if a WIM is
575 * mounted read-write, since the FUSE thread changes directory
576 * to "/", and it needs to be able to find the WIM file again.
578 * This will break if the full path to the WIM changes in the
579 * intervening time...
581 * Warning: in Windows native builds, realpath() calls the
582 * replacement function in win32_replacements.c.
584 wim->filename = realpath(wimfile, NULL);
585 if (wim->filename == NULL) {
586 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
588 return WIMLIB_ERR_NOMEM;
590 return WIMLIB_ERR_OPEN;
594 ret = read_wim_header(wim, &wim->hdr);
598 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
599 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
600 " \"%"TS"\". It may be being changed by another process,\n"
601 " or a process may have crashed while writing the WIM.",
605 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
606 ret = can_modify_wim(wim);
611 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
612 (wim->hdr.total_parts != 1))
613 return WIMLIB_ERR_IS_SPLIT_WIM;
615 DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
617 /* If the boot index is invalid, print a warning and set it to 0 */
618 if (wim->hdr.boot_idx > wim->hdr.image_count) {
619 WARNING("In `%"TS"', image %u is marked as bootable, "
620 "but there are only %u images in the WIM",
621 wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
622 wim->hdr.boot_idx = 0;
625 /* Check and cache the compression type */
626 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
627 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
628 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
629 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
630 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
631 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
632 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
634 ERROR("The compression flag is set on \"%"TS"\", but "
635 "a flag for a recognized format is not",
637 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
640 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
642 wim->out_compression_type = wim->compression_type;
644 /* Check and cache the chunk size. */
645 wim->chunk_size = wim->hdr.chunk_size;
646 wim->out_chunk_size = wim->chunk_size;
647 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
648 ERROR("Invalid chunk size (%"PRIu32" bytes) "
649 "for compression type %"TS"!",
651 wimlib_get_compression_type_string(wim->compression_type));
652 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
655 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
656 ret = check_wim_integrity(wim, progress_func);
657 if (ret == WIM_INTEGRITY_NONEXISTENT) {
658 WARNING("No integrity information for `%"TS"'; skipping "
659 "integrity check.", wimfile);
660 } else if (ret == WIM_INTEGRITY_NOT_OK) {
661 ERROR("WIM is not intact! (Failed integrity check)");
662 return WIMLIB_ERR_INTEGRITY;
663 } else if (ret != WIM_INTEGRITY_OK) {
668 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
669 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
670 if (wim->image_metadata == NULL)
671 return WIMLIB_ERR_NOMEM;
674 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
675 wim->lookup_table = new_lookup_table(9001);
676 if (wim->lookup_table == NULL)
677 return WIMLIB_ERR_NOMEM;
680 ret = read_wim_xml_data(wim);
684 xml_num_images = wim_info_get_num_images(wim->wim_info);
685 if (xml_num_images != wim->hdr.image_count) {
686 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
687 "in the XML data,", wimfile, xml_num_images);
688 ERROR("but %u images in the WIM! There must be exactly one "
689 "<IMAGE> element per image.", wim->hdr.image_count);
690 return WIMLIB_ERR_IMAGE_COUNT;
693 ret = read_wim_lookup_table(wim);
697 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
703 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
704 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
709 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
710 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
712 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
714 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
717 return WIMLIB_ERR_INVALID_PARAM;
719 wim = new_wim_struct();
721 return WIMLIB_ERR_NOMEM;
723 ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func);
729 DEBUG("Successfully opened WIM and created WIMStruct.");
734 /* API function documented in wimlib.h */
736 wimlib_open_wim(const tchar *wimfile, int open_flags,
737 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
739 open_flags &= WIMLIB_OPEN_MASK_PUBLIC;
740 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
745 destroy_image_metadata(struct wim_image_metadata *imd,
746 struct wim_lookup_table *table,
747 bool free_metadata_lte)
749 free_dentry_tree(imd->root_dentry, table);
750 imd->root_dentry = NULL;
751 free_wim_security_data(imd->security_data);
752 imd->security_data = NULL;
754 if (free_metadata_lte) {
755 free_lookup_table_entry(imd->metadata_lte);
756 imd->metadata_lte = NULL;
759 struct wim_lookup_table_entry *lte, *tmp;
760 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
761 free_lookup_table_entry(lte);
763 INIT_LIST_HEAD(&imd->unhashed_streams);
764 INIT_LIST_HEAD(&imd->inode_list);
767 do_ntfs_umount(imd->ntfs_vol);
768 imd->ntfs_vol = NULL;
774 put_image_metadata(struct wim_image_metadata *imd,
775 struct wim_lookup_table *table)
777 if (imd && --imd->refcnt == 0) {
778 destroy_image_metadata(imd, table, true);
783 /* Appends the specified image metadata structure to the array of image metadata
784 * for a WIM, and increments the image count. */
786 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
788 struct wim_image_metadata **imd_array;
790 DEBUG("Reallocating image metadata array for image_count = %u",
791 wim->hdr.image_count + 1);
792 imd_array = REALLOC(wim->image_metadata,
793 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
795 if (imd_array == NULL)
796 return WIMLIB_ERR_NOMEM;
797 wim->image_metadata = imd_array;
798 imd_array[wim->hdr.image_count++] = imd;
803 struct wim_image_metadata *
804 new_image_metadata(void)
806 struct wim_image_metadata *imd;
808 imd = CALLOC(1, sizeof(*imd));
811 INIT_LIST_HEAD(&imd->inode_list);
812 INIT_LIST_HEAD(&imd->unhashed_streams);
813 DEBUG("Created new image metadata (refcnt=1)");
815 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
820 struct wim_image_metadata **
821 new_image_metadata_array(unsigned num_images)
823 struct wim_image_metadata **imd_array;
825 DEBUG("Creating new image metadata array for %u images",
828 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
830 if (imd_array == NULL) {
831 ERROR("Failed to allocate memory for %u image metadata structures",
835 for (unsigned i = 0; i < num_images; i++) {
836 imd_array[i] = new_image_metadata();
837 if (imd_array[i] == NULL) {
838 for (unsigned j = 0; j < i; j++)
839 put_image_metadata(imd_array[j], NULL);
847 /* Checksum all streams that are unhashed (other than the metadata streams),
848 * merging them into the lookup table as needed. This is a no-op unless the
849 * library has previously used to add or mount an image using the same
852 wim_checksum_unhashed_streams(WIMStruct *wim)
856 if (!wim_has_metadata(wim))
858 for (int i = 0; i < wim->hdr.image_count; i++) {
859 struct wim_lookup_table_entry *lte, *tmp;
860 struct wim_image_metadata *imd = wim->image_metadata[i];
861 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
862 struct wim_lookup_table_entry *new_lte;
863 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
867 free_lookup_table_entry(lte);
874 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
875 * it meets the following three conditions:
877 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
878 * 2. The WIM is not part of a spanned set.
879 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
881 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
884 can_modify_wim(WIMStruct *wim)
887 if (taccess(wim->filename, W_OK)) {
888 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
889 return WIMLIB_ERR_WIM_IS_READONLY;
892 if (wim->hdr.total_parts != 1) {
893 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
895 return WIMLIB_ERR_WIM_IS_READONLY;
897 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
898 ERROR("Cannot modify \"%"TS"\": is marked read-only",
900 return WIMLIB_ERR_WIM_IS_READONLY;
906 * can_delete_from_wim - Check if files or images can be deleted from a given
909 * This theoretically should be exactly the same as can_modify_wim(), but
910 * unfortunately, due to bugs in Microsoft's software that generate incorrect
911 * reference counts for some WIM resources, we need to run expensive
912 * verifications to make sure the reference counts are correct on all WIM
913 * resources. Otherwise we might delete a WIM resource whose reference count
914 * has fallen to 0, but is actually still referenced somewhere.
917 can_delete_from_wim(WIMStruct *wim)
921 ret = can_modify_wim(wim);
924 if (!wim->refcnts_ok) {
925 ret = wim_recalculate_refcnts(wim);
932 /* API function documented in wimlib.h */
934 wimlib_free(WIMStruct *wim)
939 DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
940 wim->filename, wim->hdr.image_count);
942 while (!list_empty(&wim->subwims)) {
945 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
946 list_del(&subwim->subwim_node);
947 DEBUG("Freeing subwim.");
951 if (filedes_valid(&wim->in_fd))
952 filedes_close(&wim->in_fd);
953 if (filedes_valid(&wim->out_fd))
954 filedes_close(&wim->out_fd);
956 free_lookup_table(wim->lookup_table);
958 wimlib_free_decompressor(wim->decompressor);
961 free_wim_info(wim->wim_info);
962 if (wim->image_metadata) {
963 for (unsigned i = 0; i < wim->hdr.image_count; i++)
964 put_image_metadata(wim->image_metadata[i], NULL);
965 FREE(wim->image_metadata);
971 test_locale_ctype_utf8(void)
976 char *ctype = nl_langinfo(CODESET);
978 return (!strstr(ctype, "UTF-8") ||
979 !strstr(ctype, "UTF8") ||
980 !strstr(ctype, "utf8") ||
981 !strstr(ctype, "utf-8"));
985 /* API function documented in wimlib.h */
987 wimlib_global_init(int init_flags)
989 static bool already_inited = false;
993 libxml_global_init();
994 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
995 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
997 if (!wimlib_mbs_is_utf8)
998 libntfs3g_global_init();
1003 int ret = win32_global_init(init_flags);
1009 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
1010 default_ignore_case = false;
1011 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
1012 default_ignore_case = true;
1013 already_inited = true;
1017 /* API function documented in wimlib.h */
1019 wimlib_global_cleanup(void)
1021 libxml_global_cleanup();
1022 iconv_global_cleanup();
1024 win32_global_cleanup();
1026 cleanup_decompressor_params();
1027 cleanup_compressor_params();