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"
43 #include "wimlib/version.h"
46 # include "wimlib/win32.h" /* for realpath() replacement */
52 # include <langinfo.h>
60 wim_default_pack_compression_type(void)
62 return WIMLIB_COMPRESSION_TYPE_LZMS;
66 wim_default_pack_chunk_size(int ctype) {
68 case WIMLIB_COMPRESSION_TYPE_LZMS:
69 /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible.
71 return 1U << 25; /* 33554432 */
73 return 1U << 15; /* 32768 */
80 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
82 filedes_invalidate(&wim->in_fd);
83 filedes_invalidate(&wim->out_fd);
84 wim->out_pack_compression_type = wim_default_pack_compression_type();
85 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
86 wim->out_pack_compression_type);
87 INIT_LIST_HEAD(&wim->subwims);
92 /* Determine if the chunk size is valid for the specified compression type. */
94 wim_chunk_size_valid(u32 chunk_size, int ctype)
98 /* Chunk size is meaningless for uncompressed WIMs --- any value is
100 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
103 /* Chunk size must be power of 2. */
106 order = bsr32(chunk_size);
107 if (chunk_size != 1U << order)
126 /* See the documentation for the --chunk-size option of `wimlib-imagex
127 * capture' for information about allowed chunk sizes. */
129 case WIMLIB_COMPRESSION_TYPE_LZX:
130 return order >= 15 && order <= 21;
132 case WIMLIB_COMPRESSION_TYPE_XPRESS:
133 case WIMLIB_COMPRESSION_TYPE_LZMS:
134 return order >= 15 && order <= 26;
139 /* Return the default chunk size to use for the specified compression type.
141 * See notes above in wim_chunk_size_valid(). */
143 wim_default_chunk_size(int ctype)
146 case WIMLIB_COMPRESSION_TYPE_LZMS:
147 return 1U << 17; /* 131072 */
149 return 1U << 15; /* 32768 */
154 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
155 * @visitor is called on the WIM once for each image, with each image selected
156 * as the current image in turn. If @image is a certain image, @visitor is
157 * called on the WIM only once, with that image selected.
160 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
167 if (image == WIMLIB_ALL_IMAGES) {
169 end = wim->hdr.image_count;
170 } else if (image >= 1 && image <= wim->hdr.image_count) {
174 return WIMLIB_ERR_INVALID_IMAGE;
176 for (i = start; i <= end; i++) {
177 ret = select_wim_image(wim, i);
187 /* API function documented in wimlib.h */
189 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
192 struct wim_lookup_table *table;
195 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
197 DEBUG("Creating new WIM with %"TS" compression.",
198 wimlib_get_compression_type_string(ctype));
200 /* Allocate the WIMStruct. */
201 wim = new_wim_struct();
203 return WIMLIB_ERR_NOMEM;
205 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
209 table = new_lookup_table(9001);
211 ret = WIMLIB_ERR_NOMEM;
214 wim->lookup_table = table;
216 wim->compression_type = ctype;
217 wim->out_compression_type = ctype;
218 wim->chunk_size = wim->hdr.chunk_size;
219 wim->out_chunk_size = wim->hdr.chunk_size;
228 select_wim_image(WIMStruct *wim, int image)
230 struct wim_image_metadata *imd;
233 DEBUG("Selecting image %d", image);
235 if (image == WIMLIB_NO_IMAGE) {
236 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
237 return WIMLIB_ERR_INVALID_IMAGE;
240 if (image == wim->current_image)
243 if (image < 1 || image > wim->hdr.image_count) {
244 ERROR("Cannot select image %d: There are only %u images",
245 image, wim->hdr.image_count);
246 return WIMLIB_ERR_INVALID_IMAGE;
249 if (!wim_has_metadata(wim)) {
250 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
251 if (wim->hdr.part_number != 1)
252 ERROR("Specify the first part of the split WIM instead.");
253 return WIMLIB_ERR_METADATA_NOT_FOUND;
256 /* If a valid image is currently selected, it can be freed if it is not
258 if (wim->current_image != WIMLIB_NO_IMAGE) {
259 imd = wim_get_current_image_metadata(wim);
260 if (!imd->modified) {
261 wimlib_assert(list_empty(&imd->unhashed_streams));
262 DEBUG("Freeing image %u", wim->current_image);
263 destroy_image_metadata(imd, NULL, false);
266 wim->current_image = image;
267 imd = wim_get_current_image_metadata(wim);
268 if (imd->root_dentry || imd->modified) {
271 ret = read_metadata_resource(wim, imd);
273 wim->current_image = WIMLIB_NO_IMAGE;
279 /* API function documented in wimlib.h */
280 WIMLIBAPI const tchar *
281 wimlib_get_compression_type_string(int ctype)
284 case WIMLIB_COMPRESSION_TYPE_NONE:
286 case WIMLIB_COMPRESSION_TYPE_LZX:
288 case WIMLIB_COMPRESSION_TYPE_XPRESS:
290 case WIMLIB_COMPRESSION_TYPE_LZMS:
297 /* API function documented in wimlib.h */
299 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
305 if (!image_name_or_num || !*image_name_or_num)
306 return WIMLIB_NO_IMAGE;
308 if (!tstrcasecmp(image_name_or_num, T("all"))
309 || !tstrcasecmp(image_name_or_num, T("*")))
310 return WIMLIB_ALL_IMAGES;
311 image = tstrtol(image_name_or_num, &p, 10);
312 if (p != image_name_or_num && *p == T('\0') && image > 0) {
313 if (image > wim->hdr.image_count)
314 return WIMLIB_NO_IMAGE;
317 for (i = 1; i <= wim->hdr.image_count; i++) {
318 if (!tstrcmp(image_name_or_num,
319 wimlib_get_image_name(wim, i)))
322 return WIMLIB_NO_IMAGE;
326 /* API function documented in wimlib.h */
328 wimlib_print_available_images(const WIMStruct *wim, int image)
334 if (image == WIMLIB_ALL_IMAGES) {
335 n = tprintf(T("Available Images:\n"));
337 last = wim->hdr.image_count;
338 } else if (image >= 1 && image <= wim->hdr.image_count) {
339 n = tprintf(T("Information for Image %d\n"), image);
343 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
347 for (i = 0; i < n - 1; i++)
350 for (i = first; i <= last; i++)
351 print_image_info(wim->wim_info, i);
354 /* TODO: Deprecated; remove this. */
356 wimlib_print_metadata(WIMStruct *wim, int image)
358 return WIMLIB_ERR_UNSUPPORTED;
361 /* API function documented in wimlib.h */
363 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
365 memset(info, 0, sizeof(struct wimlib_wim_info));
366 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
367 info->image_count = wim->hdr.image_count;
368 info->boot_index = wim->hdr.boot_idx;
369 info->wim_version = wim->hdr.wim_version;
370 info->chunk_size = wim->chunk_size;
371 info->part_number = wim->hdr.part_number;
372 info->total_parts = wim->hdr.total_parts;
373 info->compression_type = wim->compression_type;
374 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
375 info->has_integrity_table = wim_has_integrity_table(wim);
376 info->opened_from_file = (wim->filename != NULL);
377 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
378 (wim->hdr.total_parts != 1) ||
379 (wim->filename && taccess(wim->filename, W_OK));
380 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
381 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
382 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
383 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
384 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
385 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
386 info->pipable = wim_is_pipable(wim);
390 /* API function documented in wimlib.h */
392 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
396 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
398 WIMLIB_CHANGE_BOOT_INDEX |
399 WIMLIB_CHANGE_RPFIX_FLAG))
400 return WIMLIB_ERR_INVALID_PARAM;
402 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
403 if (info->is_marked_readonly)
404 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
406 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
409 if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
412 ret = can_modify_wim(wim);
416 if (which & WIMLIB_CHANGE_GUID) {
417 memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
418 wim->guid_set_explicitly = 1;
421 if (which & WIMLIB_CHANGE_BOOT_INDEX) {
422 if (info->boot_index > wim->hdr.image_count) {
423 ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
425 return WIMLIB_ERR_INVALID_IMAGE;
427 wim->hdr.boot_idx = info->boot_index;
430 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
432 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
434 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
440 set_out_ctype(int ctype, u8 *out_ctype_p)
443 case WIMLIB_COMPRESSION_TYPE_INVALID:
445 case WIMLIB_COMPRESSION_TYPE_NONE:
446 case WIMLIB_COMPRESSION_TYPE_LZX:
447 case WIMLIB_COMPRESSION_TYPE_XPRESS:
448 case WIMLIB_COMPRESSION_TYPE_LZMS:
449 *out_ctype_p = ctype;
452 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
455 /* API function documented in wimlib.h */
457 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
459 int ret = set_out_ctype(ctype, &wim->out_compression_type);
463 /* Reset the chunk size if it's no longer valid. */
464 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
465 wim->out_chunk_size = wim_default_chunk_size(ctype);
469 /* API function documented in wimlib.h */
471 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
473 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
477 /* Reset the chunk size if it's no longer valid. */
478 if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
479 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
484 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
486 if (!wim_chunk_size_valid(chunk_size, ctype)) {
487 ERROR("Invalid chunk size (%"PRIu32" bytes) "
488 "for compression type %"TS"!",
490 wimlib_get_compression_type_string(ctype));
491 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
494 *out_chunk_size_p = chunk_size;
498 /* API function documented in wimlib.h */
500 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
502 if (chunk_size == 0) {
503 wim->out_chunk_size =
504 wim_default_chunk_size(wim->out_compression_type);
508 return set_out_chunk_size(chunk_size,
509 wim->out_compression_type,
510 &wim->out_chunk_size);
513 /* API function documented in wimlib.h */
515 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
517 if (chunk_size == 0) {
518 wim->out_pack_chunk_size =
519 wim_default_pack_chunk_size(wim->out_pack_compression_type);
523 return set_out_chunk_size(chunk_size,
524 wim->out_pack_compression_type,
525 &wim->out_pack_chunk_size);
529 open_wim_file(const tchar *filename, struct filedes *fd_ret)
533 raw_fd = topen(filename, O_RDONLY | O_BINARY);
535 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
536 return WIMLIB_ERR_OPEN;
538 filedes_init(fd_ret, raw_fd);
543 * Begins the reading of a WIM file; opens the file and reads its header and
544 * lookup table, and optionally checks the integrity.
547 begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
548 int open_flags, wimlib_progress_func_t progress_func)
552 const tchar *wimfile;
554 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
556 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
557 wim->in_fd.is_pipe = 1;
559 wimfile = wim_filename_or_fd;
560 ret = open_wim_file(wimfile, &wim->in_fd);
564 /* The absolute path to the WIM is requested so that
565 * wimlib_overwrite() still works even if the process changes
566 * its working directory. This actually happens if a WIM is
567 * mounted read-write, since the FUSE thread changes directory
568 * to "/", and it needs to be able to find the WIM file again.
570 * This will break if the full path to the WIM changes in the
571 * intervening time...
573 * Warning: in Windows native builds, realpath() calls the
574 * replacement function in win32_replacements.c.
576 wim->filename = realpath(wimfile, NULL);
577 if (wim->filename == NULL) {
578 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
580 return WIMLIB_ERR_NOMEM;
582 return WIMLIB_ERR_OPEN;
586 ret = read_wim_header(wim, &wim->hdr);
590 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
591 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
592 " \"%"TS"\". It may be being changed by another process,\n"
593 " or a process may have crashed while writing the WIM.",
597 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
598 ret = can_modify_wim(wim);
603 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
604 (wim->hdr.total_parts != 1))
605 return WIMLIB_ERR_IS_SPLIT_WIM;
607 DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
609 /* If the boot index is invalid, print a warning and set it to 0 */
610 if (wim->hdr.boot_idx > wim->hdr.image_count) {
611 WARNING("In `%"TS"', image %u is marked as bootable, "
612 "but there are only %u images in the WIM",
613 wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
614 wim->hdr.boot_idx = 0;
617 /* Check and cache the compression type */
618 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
619 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
620 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
621 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
622 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
623 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
624 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
626 ERROR("The compression flag is set on \"%"TS"\", but "
627 "a flag for a recognized format is not",
629 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
632 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
634 wim->out_compression_type = wim->compression_type;
636 /* Check and cache the chunk size. */
637 wim->chunk_size = wim->hdr.chunk_size;
638 wim->out_chunk_size = wim->chunk_size;
639 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
640 ERROR("Invalid chunk size (%"PRIu32" bytes) "
641 "for compression type %"TS"!",
643 wimlib_get_compression_type_string(wim->compression_type));
644 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
647 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
648 ret = check_wim_integrity(wim, progress_func);
649 if (ret == WIM_INTEGRITY_NONEXISTENT) {
650 WARNING("No integrity information for `%"TS"'; skipping "
651 "integrity check.", wimfile);
652 } else if (ret == WIM_INTEGRITY_NOT_OK) {
653 ERROR("WIM is not intact! (Failed integrity check)");
654 return WIMLIB_ERR_INTEGRITY;
655 } else if (ret != WIM_INTEGRITY_OK) {
660 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
661 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
662 if (wim->image_metadata == NULL)
663 return WIMLIB_ERR_NOMEM;
666 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
667 wim->lookup_table = new_lookup_table(9001);
668 if (wim->lookup_table == NULL)
669 return WIMLIB_ERR_NOMEM;
672 ret = read_wim_xml_data(wim);
676 xml_num_images = wim_info_get_num_images(wim->wim_info);
677 if (xml_num_images != wim->hdr.image_count) {
678 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
679 "in the XML data,", wimfile, xml_num_images);
680 ERROR("but %u images in the WIM! There must be exactly one "
681 "<IMAGE> element per image.", wim->hdr.image_count);
682 return WIMLIB_ERR_IMAGE_COUNT;
685 ret = read_wim_lookup_table(wim);
689 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
695 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
696 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
701 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
702 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
704 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
706 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
709 return WIMLIB_ERR_INVALID_PARAM;
711 wim = new_wim_struct();
713 return WIMLIB_ERR_NOMEM;
715 ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func);
721 DEBUG("Successfully opened WIM and created WIMStruct.");
726 /* API function documented in wimlib.h */
728 wimlib_open_wim(const tchar *wimfile, int open_flags,
729 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
731 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
732 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
733 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
734 return WIMLIB_ERR_INVALID_PARAM;
736 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
741 destroy_image_metadata(struct wim_image_metadata *imd,
742 struct wim_lookup_table *table,
743 bool free_metadata_lte)
745 free_dentry_tree(imd->root_dentry, table);
746 imd->root_dentry = NULL;
747 free_wim_security_data(imd->security_data);
748 imd->security_data = NULL;
750 if (free_metadata_lte) {
751 free_lookup_table_entry(imd->metadata_lte);
752 imd->metadata_lte = NULL;
755 struct wim_lookup_table_entry *lte, *tmp;
756 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
757 free_lookup_table_entry(lte);
759 INIT_LIST_HEAD(&imd->unhashed_streams);
760 INIT_LIST_HEAD(&imd->inode_list);
763 do_ntfs_umount(imd->ntfs_vol);
764 imd->ntfs_vol = NULL;
770 put_image_metadata(struct wim_image_metadata *imd,
771 struct wim_lookup_table *table)
773 if (imd && --imd->refcnt == 0) {
774 destroy_image_metadata(imd, table, true);
779 /* Appends the specified image metadata structure to the array of image metadata
780 * for a WIM, and increments the image count. */
782 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
784 struct wim_image_metadata **imd_array;
786 DEBUG("Reallocating image metadata array for image_count = %u",
787 wim->hdr.image_count + 1);
788 imd_array = REALLOC(wim->image_metadata,
789 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
791 if (imd_array == NULL)
792 return WIMLIB_ERR_NOMEM;
793 wim->image_metadata = imd_array;
794 imd_array[wim->hdr.image_count++] = imd;
799 struct wim_image_metadata *
800 new_image_metadata(void)
802 struct wim_image_metadata *imd;
804 imd = CALLOC(1, sizeof(*imd));
807 INIT_LIST_HEAD(&imd->inode_list);
808 INIT_LIST_HEAD(&imd->unhashed_streams);
809 DEBUG("Created new image metadata (refcnt=1)");
811 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
816 struct wim_image_metadata **
817 new_image_metadata_array(unsigned num_images)
819 struct wim_image_metadata **imd_array;
821 DEBUG("Creating new image metadata array for %u images",
824 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
826 if (imd_array == NULL) {
827 ERROR("Failed to allocate memory for %u image metadata structures",
831 for (unsigned i = 0; i < num_images; i++) {
832 imd_array[i] = new_image_metadata();
833 if (imd_array[i] == NULL) {
834 for (unsigned j = 0; j < i; j++)
835 put_image_metadata(imd_array[j], NULL);
843 /* Checksum all streams that are unhashed (other than the metadata streams),
844 * merging them into the lookup table as needed. This is a no-op unless the
845 * library has previously used to add or mount an image using the same
848 wim_checksum_unhashed_streams(WIMStruct *wim)
852 if (!wim_has_metadata(wim))
854 for (int i = 0; i < wim->hdr.image_count; i++) {
855 struct wim_lookup_table_entry *lte, *tmp;
856 struct wim_image_metadata *imd = wim->image_metadata[i];
857 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
858 struct wim_lookup_table_entry *new_lte;
859 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
863 free_lookup_table_entry(lte);
870 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
871 * it meets the following three conditions:
873 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
874 * 2. The WIM is not part of a spanned set.
875 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
877 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
880 can_modify_wim(WIMStruct *wim)
883 if (taccess(wim->filename, W_OK)) {
884 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
885 return WIMLIB_ERR_WIM_IS_READONLY;
888 if (wim->hdr.total_parts != 1) {
889 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
891 return WIMLIB_ERR_WIM_IS_READONLY;
893 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
894 ERROR("Cannot modify \"%"TS"\": is marked read-only",
896 return WIMLIB_ERR_WIM_IS_READONLY;
902 * can_delete_from_wim - Check if files or images can be deleted from a given
905 * This theoretically should be exactly the same as can_modify_wim(), but
906 * unfortunately, due to bugs in Microsoft's software that generate incorrect
907 * reference counts for some WIM resources, we need to run expensive
908 * verifications to make sure the reference counts are correct on all WIM
909 * resources. Otherwise we might delete a WIM resource whose reference count
910 * has fallen to 0, but is actually still referenced somewhere.
913 can_delete_from_wim(WIMStruct *wim)
917 ret = can_modify_wim(wim);
920 if (!wim->refcnts_ok) {
921 ret = wim_recalculate_refcnts(wim);
928 /* API function documented in wimlib.h */
930 wimlib_free(WIMStruct *wim)
935 DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
936 wim->filename, wim->hdr.image_count);
938 while (!list_empty(&wim->subwims)) {
941 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
942 list_del(&subwim->subwim_node);
943 DEBUG("Freeing subwim.");
947 if (filedes_valid(&wim->in_fd))
948 filedes_close(&wim->in_fd);
949 if (filedes_valid(&wim->out_fd))
950 filedes_close(&wim->out_fd);
952 free_lookup_table(wim->lookup_table);
954 wimlib_free_decompressor(wim->decompressor);
957 free_wim_info(wim->wim_info);
958 if (wim->image_metadata) {
959 for (unsigned i = 0; i < wim->hdr.image_count; i++)
960 put_image_metadata(wim->image_metadata[i], NULL);
961 FREE(wim->image_metadata);
967 test_locale_ctype_utf8(void)
972 char *ctype = nl_langinfo(CODESET);
974 return (!strstr(ctype, "UTF-8") ||
975 !strstr(ctype, "UTF8") ||
976 !strstr(ctype, "utf8") ||
977 !strstr(ctype, "utf-8"));
981 /* API function documented in wimlib.h */
983 wimlib_get_version(void)
985 return WIMLIB_VERSION_CODE;
988 /* API function documented in wimlib.h */
990 wimlib_global_init(int init_flags)
992 static bool already_inited = false;
997 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
998 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
999 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
1000 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
1001 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
1002 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
1003 return WIMLIB_ERR_INVALID_PARAM;
1005 libxml_global_init();
1006 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
1007 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
1009 if (!wimlib_mbs_is_utf8)
1010 libntfs3g_global_init();
1015 int ret = win32_global_init(init_flags);
1021 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
1022 default_ignore_case = false;
1023 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
1024 default_ignore_case = true;
1025 already_inited = true;
1029 /* API function documented in wimlib.h */
1031 wimlib_global_cleanup(void)
1033 libxml_global_cleanup();
1034 iconv_global_cleanup();
1036 win32_global_cleanup();
1038 cleanup_decompressor_params();
1039 cleanup_compressor_params();