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 wim_default_pack_compression_type(void)
61 return WIMLIB_COMPRESSION_TYPE_LZMS;
65 wim_default_pack_chunk_size(int ctype) {
67 case WIMLIB_COMPRESSION_TYPE_LZMS:
68 /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible.
70 return 1U << 25; /* 33554432 */
72 return 1U << 15; /* 32768 */
79 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
81 filedes_invalidate(&wim->in_fd);
82 filedes_invalidate(&wim->out_fd);
83 wim->out_pack_compression_type = wim_default_pack_compression_type();
84 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
85 wim->out_pack_compression_type);
86 INIT_LIST_HEAD(&wim->subwims);
91 /* Determine if the chunk size is valid for the specified compression type. */
93 wim_chunk_size_valid(u32 chunk_size, int ctype)
97 /* Chunk size is meaningless for uncompressed WIMs --- any value is
99 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
102 /* Chunk size must be power of 2. */
105 order = bsr32(chunk_size);
106 if (chunk_size != 1U << order)
125 /* See the documentation for the --chunk-size option of `wimlib-imagex
126 * capture' for information about allowed chunk sizes. */
128 case WIMLIB_COMPRESSION_TYPE_LZX:
129 return order >= 15 && order <= 21;
131 case WIMLIB_COMPRESSION_TYPE_XPRESS:
132 case WIMLIB_COMPRESSION_TYPE_LZMS:
133 return order >= 15 && order <= 26;
138 /* Return the default chunk size to use for the specified compression type.
140 * See notes above in wim_chunk_size_valid(). */
142 wim_default_chunk_size(int ctype)
145 case WIMLIB_COMPRESSION_TYPE_LZMS:
146 return 1U << 17; /* 131072 */
148 return 1U << 15; /* 32768 */
153 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
154 * @visitor is called on the WIM once for each image, with each image selected
155 * as the current image in turn. If @image is a certain image, @visitor is
156 * called on the WIM only once, with that image selected.
159 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
166 if (image == WIMLIB_ALL_IMAGES) {
168 end = wim->hdr.image_count;
169 } else if (image >= 1 && image <= wim->hdr.image_count) {
173 return WIMLIB_ERR_INVALID_IMAGE;
175 for (i = start; i <= end; i++) {
176 ret = select_wim_image(wim, i);
186 /* API function documented in wimlib.h */
188 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
191 struct wim_lookup_table *table;
194 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
196 DEBUG("Creating new WIM with %"TS" compression.",
197 wimlib_get_compression_type_string(ctype));
199 /* Allocate the WIMStruct. */
200 wim = new_wim_struct();
202 return WIMLIB_ERR_NOMEM;
204 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
208 table = new_lookup_table(9001);
210 ret = WIMLIB_ERR_NOMEM;
213 wim->lookup_table = table;
215 wim->compression_type = ctype;
216 wim->out_compression_type = ctype;
217 wim->chunk_size = wim->hdr.chunk_size;
218 wim->out_chunk_size = wim->hdr.chunk_size;
227 select_wim_image(WIMStruct *wim, int image)
229 struct wim_image_metadata *imd;
232 DEBUG("Selecting image %d", image);
234 if (image == WIMLIB_NO_IMAGE) {
235 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
236 return WIMLIB_ERR_INVALID_IMAGE;
239 if (image == wim->current_image)
242 if (image < 1 || image > wim->hdr.image_count) {
243 ERROR("Cannot select image %d: There are only %u images",
244 image, wim->hdr.image_count);
245 return WIMLIB_ERR_INVALID_IMAGE;
248 if (!wim_has_metadata(wim)) {
249 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
250 if (wim->hdr.part_number != 1)
251 ERROR("Specify the first part of the split WIM instead.");
252 return WIMLIB_ERR_METADATA_NOT_FOUND;
255 /* If a valid image is currently selected, it can be freed if it is not
257 if (wim->current_image != WIMLIB_NO_IMAGE) {
258 imd = wim_get_current_image_metadata(wim);
259 if (!imd->modified) {
260 wimlib_assert(list_empty(&imd->unhashed_streams));
261 DEBUG("Freeing image %u", wim->current_image);
262 destroy_image_metadata(imd, NULL, false);
265 wim->current_image = image;
266 imd = wim_get_current_image_metadata(wim);
267 if (imd->root_dentry || imd->modified) {
270 ret = read_metadata_resource(wim, imd);
272 wim->current_image = WIMLIB_NO_IMAGE;
278 /* API function documented in wimlib.h */
279 WIMLIBAPI const tchar *
280 wimlib_get_compression_type_string(int ctype)
283 case WIMLIB_COMPRESSION_TYPE_NONE:
285 case WIMLIB_COMPRESSION_TYPE_LZX:
287 case WIMLIB_COMPRESSION_TYPE_XPRESS:
289 case WIMLIB_COMPRESSION_TYPE_LZMS:
296 /* API function documented in wimlib.h */
298 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
304 if (!image_name_or_num || !*image_name_or_num)
305 return WIMLIB_NO_IMAGE;
307 if (!tstrcasecmp(image_name_or_num, T("all"))
308 || !tstrcasecmp(image_name_or_num, T("*")))
309 return WIMLIB_ALL_IMAGES;
310 image = tstrtol(image_name_or_num, &p, 10);
311 if (p != image_name_or_num && *p == T('\0') && image > 0) {
312 if (image > wim->hdr.image_count)
313 return WIMLIB_NO_IMAGE;
316 for (i = 1; i <= wim->hdr.image_count; i++) {
317 if (!tstrcmp(image_name_or_num,
318 wimlib_get_image_name(wim, i)))
321 return WIMLIB_NO_IMAGE;
325 /* API function documented in wimlib.h */
327 wimlib_print_available_images(const WIMStruct *wim, int image)
333 if (image == WIMLIB_ALL_IMAGES) {
334 n = tprintf(T("Available Images:\n"));
336 last = wim->hdr.image_count;
337 } else if (image >= 1 && image <= wim->hdr.image_count) {
338 n = tprintf(T("Information for Image %d\n"), image);
342 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
346 for (i = 0; i < n - 1; i++)
349 for (i = first; i <= last; i++)
350 print_image_info(wim->wim_info, i);
353 /* TODO: Deprecated; remove this. */
355 wimlib_print_metadata(WIMStruct *wim, int image)
357 return WIMLIB_ERR_UNSUPPORTED;
360 /* API function documented in wimlib.h */
362 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
364 memset(info, 0, sizeof(struct wimlib_wim_info));
365 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
366 info->image_count = wim->hdr.image_count;
367 info->boot_index = wim->hdr.boot_idx;
368 info->wim_version = wim->hdr.wim_version;
369 info->chunk_size = wim->chunk_size;
370 info->part_number = wim->hdr.part_number;
371 info->total_parts = wim->hdr.total_parts;
372 info->compression_type = wim->compression_type;
373 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
374 info->has_integrity_table = wim_has_integrity_table(wim);
375 info->opened_from_file = (wim->filename != NULL);
376 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
377 (wim->hdr.total_parts != 1) ||
378 (wim->filename && taccess(wim->filename, W_OK));
379 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
380 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
381 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
382 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
383 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
384 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
385 info->pipable = wim_is_pipable(wim);
389 /* API function documented in wimlib.h */
391 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
395 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
397 WIMLIB_CHANGE_BOOT_INDEX |
398 WIMLIB_CHANGE_RPFIX_FLAG))
399 return WIMLIB_ERR_INVALID_PARAM;
401 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
402 if (info->is_marked_readonly)
403 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
405 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
408 if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
411 ret = can_modify_wim(wim);
415 if (which & WIMLIB_CHANGE_GUID) {
416 memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
417 wim->guid_set_explicitly = 1;
420 if (which & WIMLIB_CHANGE_BOOT_INDEX) {
421 if (info->boot_index > wim->hdr.image_count) {
422 ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
424 return WIMLIB_ERR_INVALID_IMAGE;
426 wim->hdr.boot_idx = info->boot_index;
429 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
431 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
433 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
439 set_out_ctype(int ctype, u8 *out_ctype_p)
442 case WIMLIB_COMPRESSION_TYPE_INVALID:
444 case WIMLIB_COMPRESSION_TYPE_NONE:
445 case WIMLIB_COMPRESSION_TYPE_LZX:
446 case WIMLIB_COMPRESSION_TYPE_XPRESS:
447 case WIMLIB_COMPRESSION_TYPE_LZMS:
448 *out_ctype_p = ctype;
451 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
454 /* API function documented in wimlib.h */
456 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
458 int ret = set_out_ctype(ctype, &wim->out_compression_type);
462 /* Reset the chunk size if it's no longer valid. */
463 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
464 wim->out_chunk_size = wim_default_chunk_size(ctype);
468 /* API function documented in wimlib.h */
470 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
472 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
476 /* Reset the chunk size if it's no longer valid. */
477 if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
478 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
483 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
485 if (!wim_chunk_size_valid(chunk_size, ctype)) {
486 ERROR("Invalid chunk size (%"PRIu32" bytes) "
487 "for compression type %"TS"!",
489 wimlib_get_compression_type_string(ctype));
490 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
493 *out_chunk_size_p = chunk_size;
497 /* API function documented in wimlib.h */
499 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
501 if (chunk_size == 0) {
502 wim->out_chunk_size =
503 wim_default_chunk_size(wim->out_compression_type);
507 return set_out_chunk_size(chunk_size,
508 wim->out_compression_type,
509 &wim->out_chunk_size);
512 /* API function documented in wimlib.h */
514 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
516 if (chunk_size == 0) {
517 wim->out_pack_chunk_size =
518 wim_default_pack_chunk_size(wim->out_pack_compression_type);
522 return set_out_chunk_size(chunk_size,
523 wim->out_pack_compression_type,
524 &wim->out_pack_chunk_size);
528 open_wim_file(const tchar *filename, struct filedes *fd_ret)
532 raw_fd = topen(filename, O_RDONLY | O_BINARY);
534 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
535 return WIMLIB_ERR_OPEN;
537 filedes_init(fd_ret, raw_fd);
542 * Begins the reading of a WIM file; opens the file and reads its header and
543 * lookup table, and optionally checks the integrity.
546 begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
547 int open_flags, wimlib_progress_func_t progress_func)
551 const tchar *wimfile;
553 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
555 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
556 wim->in_fd.is_pipe = 1;
558 wimfile = wim_filename_or_fd;
559 ret = open_wim_file(wimfile, &wim->in_fd);
563 /* The absolute path to the WIM is requested so that
564 * wimlib_overwrite() still works even if the process changes
565 * its working directory. This actually happens if a WIM is
566 * mounted read-write, since the FUSE thread changes directory
567 * to "/", and it needs to be able to find the WIM file again.
569 * This will break if the full path to the WIM changes in the
570 * intervening time...
572 * Warning: in Windows native builds, realpath() calls the
573 * replacement function in win32_replacements.c.
575 wim->filename = realpath(wimfile, NULL);
576 if (wim->filename == NULL) {
577 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
579 return WIMLIB_ERR_NOMEM;
581 return WIMLIB_ERR_OPEN;
585 ret = read_wim_header(wim, &wim->hdr);
589 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
590 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
591 " \"%"TS"\". It may be being changed by another process,\n"
592 " or a process may have crashed while writing the WIM.",
596 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
597 ret = can_modify_wim(wim);
602 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
603 (wim->hdr.total_parts != 1))
604 return WIMLIB_ERR_IS_SPLIT_WIM;
606 DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
608 /* If the boot index is invalid, print a warning and set it to 0 */
609 if (wim->hdr.boot_idx > wim->hdr.image_count) {
610 WARNING("In `%"TS"', image %u is marked as bootable, "
611 "but there are only %u images in the WIM",
612 wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
613 wim->hdr.boot_idx = 0;
616 /* Check and cache the compression type */
617 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
618 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
619 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
620 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
621 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
622 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
623 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
625 ERROR("The compression flag is set on \"%"TS"\", but "
626 "a flag for a recognized format is not",
628 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
631 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
633 wim->out_compression_type = wim->compression_type;
635 /* Check and cache the chunk size. */
636 wim->chunk_size = wim->hdr.chunk_size;
637 wim->out_chunk_size = wim->chunk_size;
638 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
639 ERROR("Invalid chunk size (%"PRIu32" bytes) "
640 "for compression type %"TS"!",
642 wimlib_get_compression_type_string(wim->compression_type));
643 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
646 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
647 ret = check_wim_integrity(wim, progress_func);
648 if (ret == WIM_INTEGRITY_NONEXISTENT) {
649 WARNING("No integrity information for `%"TS"'; skipping "
650 "integrity check.", wimfile);
651 } else if (ret == WIM_INTEGRITY_NOT_OK) {
652 ERROR("WIM is not intact! (Failed integrity check)");
653 return WIMLIB_ERR_INTEGRITY;
654 } else if (ret != WIM_INTEGRITY_OK) {
659 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
660 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
661 if (wim->image_metadata == NULL)
662 return WIMLIB_ERR_NOMEM;
665 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
666 wim->lookup_table = new_lookup_table(9001);
667 if (wim->lookup_table == NULL)
668 return WIMLIB_ERR_NOMEM;
671 ret = read_wim_xml_data(wim);
675 xml_num_images = wim_info_get_num_images(wim->wim_info);
676 if (xml_num_images != wim->hdr.image_count) {
677 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
678 "in the XML data,", wimfile, xml_num_images);
679 ERROR("but %u images in the WIM! There must be exactly one "
680 "<IMAGE> element per image.", wim->hdr.image_count);
681 return WIMLIB_ERR_IMAGE_COUNT;
684 ret = read_wim_lookup_table(wim);
688 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
694 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
695 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
700 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
701 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
703 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
705 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
708 return WIMLIB_ERR_INVALID_PARAM;
710 wim = new_wim_struct();
712 return WIMLIB_ERR_NOMEM;
714 ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func);
720 DEBUG("Successfully opened WIM and created WIMStruct.");
725 /* API function documented in wimlib.h */
727 wimlib_open_wim(const tchar *wimfile, int open_flags,
728 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
730 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
731 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
732 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
733 return WIMLIB_ERR_INVALID_PARAM;
735 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
740 destroy_image_metadata(struct wim_image_metadata *imd,
741 struct wim_lookup_table *table,
742 bool free_metadata_lte)
744 free_dentry_tree(imd->root_dentry, table);
745 imd->root_dentry = NULL;
746 free_wim_security_data(imd->security_data);
747 imd->security_data = NULL;
749 if (free_metadata_lte) {
750 free_lookup_table_entry(imd->metadata_lte);
751 imd->metadata_lte = NULL;
754 struct wim_lookup_table_entry *lte, *tmp;
755 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
756 free_lookup_table_entry(lte);
758 INIT_LIST_HEAD(&imd->unhashed_streams);
759 INIT_LIST_HEAD(&imd->inode_list);
762 do_ntfs_umount(imd->ntfs_vol);
763 imd->ntfs_vol = NULL;
769 put_image_metadata(struct wim_image_metadata *imd,
770 struct wim_lookup_table *table)
772 if (imd && --imd->refcnt == 0) {
773 destroy_image_metadata(imd, table, true);
778 /* Appends the specified image metadata structure to the array of image metadata
779 * for a WIM, and increments the image count. */
781 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
783 struct wim_image_metadata **imd_array;
785 DEBUG("Reallocating image metadata array for image_count = %u",
786 wim->hdr.image_count + 1);
787 imd_array = REALLOC(wim->image_metadata,
788 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
790 if (imd_array == NULL)
791 return WIMLIB_ERR_NOMEM;
792 wim->image_metadata = imd_array;
793 imd_array[wim->hdr.image_count++] = imd;
798 struct wim_image_metadata *
799 new_image_metadata(void)
801 struct wim_image_metadata *imd;
803 imd = CALLOC(1, sizeof(*imd));
806 INIT_LIST_HEAD(&imd->inode_list);
807 INIT_LIST_HEAD(&imd->unhashed_streams);
808 DEBUG("Created new image metadata (refcnt=1)");
810 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
815 struct wim_image_metadata **
816 new_image_metadata_array(unsigned num_images)
818 struct wim_image_metadata **imd_array;
820 DEBUG("Creating new image metadata array for %u images",
823 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
825 if (imd_array == NULL) {
826 ERROR("Failed to allocate memory for %u image metadata structures",
830 for (unsigned i = 0; i < num_images; i++) {
831 imd_array[i] = new_image_metadata();
832 if (imd_array[i] == NULL) {
833 for (unsigned j = 0; j < i; j++)
834 put_image_metadata(imd_array[j], NULL);
842 /* Checksum all streams that are unhashed (other than the metadata streams),
843 * merging them into the lookup table as needed. This is a no-op unless the
844 * library has previously used to add or mount an image using the same
847 wim_checksum_unhashed_streams(WIMStruct *wim)
851 if (!wim_has_metadata(wim))
853 for (int i = 0; i < wim->hdr.image_count; i++) {
854 struct wim_lookup_table_entry *lte, *tmp;
855 struct wim_image_metadata *imd = wim->image_metadata[i];
856 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
857 struct wim_lookup_table_entry *new_lte;
858 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
862 free_lookup_table_entry(lte);
869 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
870 * it meets the following three conditions:
872 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
873 * 2. The WIM is not part of a spanned set.
874 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
876 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
879 can_modify_wim(WIMStruct *wim)
882 if (taccess(wim->filename, W_OK)) {
883 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
884 return WIMLIB_ERR_WIM_IS_READONLY;
887 if (wim->hdr.total_parts != 1) {
888 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
890 return WIMLIB_ERR_WIM_IS_READONLY;
892 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
893 ERROR("Cannot modify \"%"TS"\": is marked read-only",
895 return WIMLIB_ERR_WIM_IS_READONLY;
901 * can_delete_from_wim - Check if files or images can be deleted from a given
904 * This theoretically should be exactly the same as can_modify_wim(), but
905 * unfortunately, due to bugs in Microsoft's software that generate incorrect
906 * reference counts for some WIM resources, we need to run expensive
907 * verifications to make sure the reference counts are correct on all WIM
908 * resources. Otherwise we might delete a WIM resource whose reference count
909 * has fallen to 0, but is actually still referenced somewhere.
912 can_delete_from_wim(WIMStruct *wim)
916 ret = can_modify_wim(wim);
919 if (!wim->refcnts_ok) {
920 ret = wim_recalculate_refcnts(wim);
927 /* API function documented in wimlib.h */
929 wimlib_free(WIMStruct *wim)
934 DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
935 wim->filename, wim->hdr.image_count);
937 while (!list_empty(&wim->subwims)) {
940 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
941 list_del(&subwim->subwim_node);
942 DEBUG("Freeing subwim.");
946 if (filedes_valid(&wim->in_fd))
947 filedes_close(&wim->in_fd);
948 if (filedes_valid(&wim->out_fd))
949 filedes_close(&wim->out_fd);
951 free_lookup_table(wim->lookup_table);
953 wimlib_free_decompressor(wim->decompressor);
956 free_wim_info(wim->wim_info);
957 if (wim->image_metadata) {
958 for (unsigned i = 0; i < wim->hdr.image_count; i++)
959 put_image_metadata(wim->image_metadata[i], NULL);
960 FREE(wim->image_metadata);
966 test_locale_ctype_utf8(void)
971 char *ctype = nl_langinfo(CODESET);
973 return (!strstr(ctype, "UTF-8") ||
974 !strstr(ctype, "UTF8") ||
975 !strstr(ctype, "utf8") ||
976 !strstr(ctype, "utf-8"));
980 /* API function documented in wimlib.h */
982 wimlib_global_init(int init_flags)
984 static bool already_inited = false;
989 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
990 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
991 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
992 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
993 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
994 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
995 return WIMLIB_ERR_INVALID_PARAM;
997 libxml_global_init();
998 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
999 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
1001 if (!wimlib_mbs_is_utf8)
1002 libntfs3g_global_init();
1007 int ret = win32_global_init(init_flags);
1013 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
1014 default_ignore_case = false;
1015 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
1016 default_ignore_case = true;
1017 already_inited = true;
1021 /* API function documented in wimlib.h */
1023 wimlib_global_cleanup(void)
1025 libxml_global_cleanup();
1026 iconv_global_cleanup();
1028 win32_global_cleanup();
1030 cleanup_decompressor_params();
1031 cleanup_compressor_params();