2 * wim.c - High-level code dealing with WIMStructs and images.
6 * Copyright (C) 2012, 2013, 2014 Eric Biggers
8 * This file is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License as published by the Free
10 * Software Foundation; either version 3 of the License, or (at your option) any
13 * This file is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this file; if not, see http://www.gnu.org/licenses/.
27 #include "wimlib/bitops.h"
28 #include "wimlib/dentry.h"
29 #include "wimlib/encoding.h"
30 #include "wimlib/file_io.h"
31 #include "wimlib/integrity.h"
32 #include "wimlib/lookup_table.h"
33 #include "wimlib/metadata.h"
35 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
37 #include "wimlib/security.h"
38 #include "wimlib/wim.h"
39 #include "wimlib/xml.h"
40 #include "wimlib/version.h"
43 # include "wimlib/win32.h" /* for realpath() replacement */
49 # include <langinfo.h>
55 wim_default_pack_compression_type(void)
57 return WIMLIB_COMPRESSION_TYPE_LZMS;
61 wim_default_pack_chunk_size(int ctype) {
63 case WIMLIB_COMPRESSION_TYPE_LZMS:
64 return 1U << 25; /* 33554432 */
66 return 1U << 15; /* 32768 */
73 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
77 filedes_invalidate(&wim->in_fd);
78 filedes_invalidate(&wim->out_fd);
79 wim->out_pack_compression_type = wim_default_pack_compression_type();
80 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
81 wim->out_pack_compression_type);
82 INIT_LIST_HEAD(&wim->subwims);
86 /* Determine if the chunk size is valid for the specified compression type. */
88 wim_chunk_size_valid(u32 chunk_size, int ctype)
92 /* Chunk size is meaningless for uncompressed WIMs --- any value is
94 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
97 /* Chunk size must be power of 2. */
100 order = fls32(chunk_size);
101 if (chunk_size != 1U << order)
120 /* See the documentation for the --chunk-size option of `wimlib-imagex
121 * capture' for information about allowed chunk sizes. */
123 case WIMLIB_COMPRESSION_TYPE_LZX:
124 return order >= 15 && order <= 21;
125 case WIMLIB_COMPRESSION_TYPE_XPRESS:
126 return order >= 12 && order <= 16;
127 case WIMLIB_COMPRESSION_TYPE_LZMS:
128 return order >= 15 && order <= 30;
133 /* Return the default chunk size to use for the specified compression type.
135 * See notes above in wim_chunk_size_valid(). */
137 wim_default_chunk_size(int ctype)
140 case WIMLIB_COMPRESSION_TYPE_LZMS:
141 return 1U << 17; /* 131072 */
143 return 1U << 15; /* 32768 */
148 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
149 * @visitor is called on the WIM once for each image, with each image selected
150 * as the current image in turn. If @image is a certain image, @visitor is
151 * called on the WIM only once, with that image selected.
154 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
161 if (image == WIMLIB_ALL_IMAGES) {
163 end = wim->hdr.image_count;
164 } else if (image >= 1 && image <= wim->hdr.image_count) {
168 return WIMLIB_ERR_INVALID_IMAGE;
170 for (i = start; i <= end; i++) {
171 ret = select_wim_image(wim, i);
181 /* API function documented in wimlib.h */
183 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
186 struct wim_lookup_table *table;
189 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
193 wim = new_wim_struct();
195 return WIMLIB_ERR_NOMEM;
197 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
201 table = new_lookup_table(9001);
203 ret = WIMLIB_ERR_NOMEM;
206 wim->lookup_table = table;
207 wim->compression_type = ctype;
208 wim->out_compression_type = ctype;
209 wim->chunk_size = wim->hdr.chunk_size;
210 wim->out_chunk_size = wim->hdr.chunk_size;
220 destroy_image_metadata(struct wim_image_metadata *imd,
221 struct wim_lookup_table *table,
222 bool free_metadata_lte)
224 free_dentry_tree(imd->root_dentry, table);
225 imd->root_dentry = NULL;
226 free_wim_security_data(imd->security_data);
227 imd->security_data = NULL;
229 if (free_metadata_lte) {
230 free_lookup_table_entry(imd->metadata_lte);
231 imd->metadata_lte = NULL;
234 struct wim_lookup_table_entry *lte, *tmp;
235 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
236 free_lookup_table_entry(lte);
238 INIT_LIST_HEAD(&imd->unhashed_streams);
239 INIT_LIST_HEAD(&imd->inode_list);
242 do_ntfs_umount(imd->ntfs_vol);
243 imd->ntfs_vol = NULL;
249 put_image_metadata(struct wim_image_metadata *imd,
250 struct wim_lookup_table *table)
252 if (imd && --imd->refcnt == 0) {
253 destroy_image_metadata(imd, table, true);
258 /* Appends the specified image metadata structure to the array of image metadata
259 * for a WIM, and increments the image count. */
261 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
263 struct wim_image_metadata **imd_array;
265 imd_array = REALLOC(wim->image_metadata,
266 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
269 return WIMLIB_ERR_NOMEM;
270 wim->image_metadata = imd_array;
271 imd_array[wim->hdr.image_count++] = imd;
275 struct wim_image_metadata *
276 new_image_metadata(void)
278 struct wim_image_metadata *imd;
280 imd = CALLOC(1, sizeof(*imd));
283 INIT_LIST_HEAD(&imd->inode_list);
284 INIT_LIST_HEAD(&imd->unhashed_streams);
289 static struct wim_image_metadata **
290 new_image_metadata_array(unsigned num_images)
292 struct wim_image_metadata **imd_array;
294 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
298 for (unsigned i = 0; i < num_images; i++) {
299 imd_array[i] = new_image_metadata();
300 if (unlikely(!imd_array[i])) {
301 for (unsigned j = 0; j < i; j++)
302 put_image_metadata(imd_array[j], NULL);
312 * Load the metadata for the specified WIM image into memory and set it
313 * as the WIMStruct's currently selected image.
316 * The WIMStruct for the WIM.
318 * The 1-based index of the image in the WIM to select.
320 * On success, 0 will be returned, wim->current_image will be set to
321 * @image, and wim_get_current_image_metadata() can be used to retrieve
322 * metadata information for the image.
324 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
325 * or another error code will be returned.
328 select_wim_image(WIMStruct *wim, int image)
330 struct wim_image_metadata *imd;
333 if (image == WIMLIB_NO_IMAGE)
334 return WIMLIB_ERR_INVALID_IMAGE;
336 if (image == wim->current_image)
339 if (image < 1 || image > wim->hdr.image_count)
340 return WIMLIB_ERR_INVALID_IMAGE;
342 if (!wim_has_metadata(wim))
343 return WIMLIB_ERR_METADATA_NOT_FOUND;
345 /* If a valid image is currently selected, its metadata can be freed if
346 * it has not been modified. */
347 if (wim->current_image != WIMLIB_NO_IMAGE) {
348 imd = wim_get_current_image_metadata(wim);
349 if (!imd->modified) {
350 wimlib_assert(list_empty(&imd->unhashed_streams));
351 destroy_image_metadata(imd, NULL, false);
354 wim->current_image = image;
355 imd = wim_get_current_image_metadata(wim);
356 if (imd->root_dentry || imd->modified) {
359 ret = read_metadata_resource(imd);
361 wim->current_image = WIMLIB_NO_IMAGE;
367 /* API function documented in wimlib.h */
368 WIMLIBAPI const tchar *
369 wimlib_get_compression_type_string(int ctype)
372 case WIMLIB_COMPRESSION_TYPE_NONE:
374 case WIMLIB_COMPRESSION_TYPE_XPRESS:
376 case WIMLIB_COMPRESSION_TYPE_LZX:
378 case WIMLIB_COMPRESSION_TYPE_LZMS:
385 /* API function documented in wimlib.h */
387 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
393 if (!image_name_or_num || !*image_name_or_num)
394 return WIMLIB_NO_IMAGE;
396 if (!tstrcasecmp(image_name_or_num, T("all"))
397 || !tstrcasecmp(image_name_or_num, T("*")))
398 return WIMLIB_ALL_IMAGES;
399 image = tstrtol(image_name_or_num, &p, 10);
400 if (p != image_name_or_num && *p == T('\0') && image > 0) {
401 if (image > wim->hdr.image_count)
402 return WIMLIB_NO_IMAGE;
405 for (i = 1; i <= wim->hdr.image_count; i++) {
406 if (!tstrcmp(image_name_or_num,
407 wimlib_get_image_name(wim, i)))
410 return WIMLIB_NO_IMAGE;
414 /* API function documented in wimlib.h */
416 wimlib_print_available_images(const WIMStruct *wim, int image)
422 if (image == WIMLIB_ALL_IMAGES) {
423 n = tprintf(T("Available Images:\n"));
425 last = wim->hdr.image_count;
426 } else if (image >= 1 && image <= wim->hdr.image_count) {
427 n = tprintf(T("Information for Image %d\n"), image);
431 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
435 for (i = 0; i < n - 1; i++)
438 for (i = first; i <= last; i++)
439 print_image_info(wim->wim_info, i);
442 /* API function documented in wimlib.h */
444 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
446 memset(info, 0, sizeof(struct wimlib_wim_info));
447 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
448 info->image_count = wim->hdr.image_count;
449 info->boot_index = wim->hdr.boot_idx;
450 info->wim_version = wim->hdr.wim_version;
451 info->chunk_size = wim->chunk_size;
452 info->part_number = wim->hdr.part_number;
453 info->total_parts = wim->hdr.total_parts;
454 info->compression_type = wim->compression_type;
455 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
456 info->has_integrity_table = wim_has_integrity_table(wim);
457 info->opened_from_file = (wim->filename != NULL);
458 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
459 (wim->hdr.total_parts != 1) ||
460 (wim->filename && taccess(wim->filename, W_OK));
461 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
462 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
463 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
464 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
465 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
466 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
467 info->pipable = wim_is_pipable(wim);
471 /* API function documented in wimlib.h */
473 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
475 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
477 WIMLIB_CHANGE_BOOT_INDEX |
478 WIMLIB_CHANGE_RPFIX_FLAG))
479 return WIMLIB_ERR_INVALID_PARAM;
481 if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
482 info->boot_index > wim->hdr.image_count)
483 return WIMLIB_ERR_INVALID_IMAGE;
485 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
486 if (info->is_marked_readonly)
487 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
489 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
492 if (which & WIMLIB_CHANGE_GUID)
493 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
495 if (which & WIMLIB_CHANGE_BOOT_INDEX)
496 wim->hdr.boot_idx = info->boot_index;
498 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
500 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
502 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
508 set_out_ctype(int ctype, u8 *out_ctype_p)
511 case WIMLIB_COMPRESSION_TYPE_NONE:
512 case WIMLIB_COMPRESSION_TYPE_LZX:
513 case WIMLIB_COMPRESSION_TYPE_XPRESS:
514 case WIMLIB_COMPRESSION_TYPE_LZMS:
515 *out_ctype_p = ctype;
518 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
521 /* API function documented in wimlib.h */
523 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
525 int ret = set_out_ctype(ctype, &wim->out_compression_type);
529 /* Reset the chunk size if it's no longer valid. */
530 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
531 wim->out_chunk_size = wim_default_chunk_size(ctype);
535 /* API function documented in wimlib.h */
537 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
539 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
543 /* Reset the chunk size if it's no longer valid. */
544 if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
545 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
550 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
552 if (!wim_chunk_size_valid(chunk_size, ctype))
553 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
555 *out_chunk_size_p = chunk_size;
559 /* API function documented in wimlib.h */
561 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
563 if (chunk_size == 0) {
564 wim->out_chunk_size =
565 wim_default_chunk_size(wim->out_compression_type);
569 return set_out_chunk_size(chunk_size,
570 wim->out_compression_type,
571 &wim->out_chunk_size);
574 /* API function documented in wimlib.h */
576 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
578 if (chunk_size == 0) {
579 wim->out_pack_chunk_size =
580 wim_default_pack_chunk_size(wim->out_pack_compression_type);
584 return set_out_chunk_size(chunk_size,
585 wim->out_pack_compression_type,
586 &wim->out_pack_chunk_size);
590 wimlib_register_progress_function(WIMStruct *wim,
591 wimlib_progress_func_t progfunc,
594 wim->progfunc = progfunc;
595 wim->progctx = progctx;
599 open_wim_file(const tchar *filename, struct filedes *fd_ret)
603 raw_fd = topen(filename, O_RDONLY | O_BINARY);
605 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
606 return WIMLIB_ERR_OPEN;
608 filedes_init(fd_ret, raw_fd);
613 * Begins the reading of a WIM file; opens the file and reads its header and
614 * lookup table, and optionally checks the integrity.
617 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
621 const tchar *wimfile;
623 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
625 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
626 wim->in_fd.is_pipe = 1;
628 wimfile = wim_filename_or_fd;
629 ret = open_wim_file(wimfile, &wim->in_fd);
633 /* The absolute path to the WIM is requested so that
634 * wimlib_overwrite() still works even if the process changes
635 * its working directory. This actually happens if a WIM is
636 * mounted read-write, since the FUSE thread changes directory
637 * to "/", and it needs to be able to find the WIM file again.
639 * This will break if the full path to the WIM changes in the
640 * intervening time...
642 * Warning: in Windows native builds, realpath() calls the
643 * replacement function in win32_replacements.c.
645 wim->filename = realpath(wimfile, NULL);
646 if (!wim->filename) {
647 ERROR_WITH_ERRNO("Failed to get full path to file "
648 "\"%"TS"\"", wimfile);
650 return WIMLIB_ERR_NOMEM;
652 return WIMLIB_ERR_NO_FILENAME;
656 ret = read_wim_header(wim, &wim->hdr);
660 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
661 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
662 " \"%"TS"\". It may be being changed by another process,\n"
663 " or a process may have crashed while writing the WIM.",
667 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
668 ret = can_modify_wim(wim);
673 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
674 (wim->hdr.total_parts != 1))
675 return WIMLIB_ERR_IS_SPLIT_WIM;
677 /* If the boot index is invalid, print a warning and set it to 0 */
678 if (wim->hdr.boot_idx > wim->hdr.image_count) {
679 WARNING("Ignoring invalid boot index.");
680 wim->hdr.boot_idx = 0;
683 /* Check and cache the compression type */
684 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
685 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
686 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
687 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
688 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
689 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
690 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
691 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
693 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
696 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
698 wim->out_compression_type = wim->compression_type;
700 /* Check and cache the chunk size. */
701 wim->chunk_size = wim->hdr.chunk_size;
702 wim->out_chunk_size = wim->chunk_size;
703 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
704 ERROR("Invalid chunk size (%"PRIu32" bytes) "
705 "for compression type %"TS"!", wim->chunk_size,
706 wimlib_get_compression_type_string(wim->compression_type));
707 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
710 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
711 ret = check_wim_integrity(wim);
712 if (ret == WIM_INTEGRITY_NONEXISTENT) {
713 WARNING("\"%"TS"\" does not contain integrity "
714 "information. Skipping integrity check.",
716 } else if (ret == WIM_INTEGRITY_NOT_OK) {
717 return WIMLIB_ERR_INTEGRITY;
718 } else if (ret != WIM_INTEGRITY_OK) {
723 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
724 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
725 if (!wim->image_metadata)
726 return WIMLIB_ERR_NOMEM;
729 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
730 wim->lookup_table = new_lookup_table(9001);
731 if (!wim->lookup_table)
732 return WIMLIB_ERR_NOMEM;
735 ret = read_wim_xml_data(wim);
739 xml_num_images = wim_info_get_num_images(wim->wim_info);
740 if (xml_num_images != wim->hdr.image_count) {
741 ERROR("The WIM's header is inconsistent with its XML data.\n"
742 " Please submit a bug report if you believe this "
743 "WIM file should be considered valid.");
744 return WIMLIB_ERR_IMAGE_COUNT;
747 ret = read_wim_lookup_table(wim);
755 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
757 wimlib_progress_func_t progfunc, void *progctx)
762 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
766 wim = new_wim_struct();
768 return WIMLIB_ERR_NOMEM;
770 wim->progfunc = progfunc;
771 wim->progctx = progctx;
773 ret = begin_read(wim, wim_filename_or_fd, open_flags);
783 /* API function documented in wimlib.h */
785 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
787 wimlib_progress_func_t progfunc, void *progctx)
789 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
790 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
791 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
792 return WIMLIB_ERR_INVALID_PARAM;
794 if (!wimfile || !*wimfile || !wim_ret)
795 return WIMLIB_ERR_INVALID_PARAM;
797 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
801 /* API function documented in wimlib.h */
803 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
805 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
809 /* Checksum all streams that are unhashed (other than the metadata streams),
810 * merging them into the lookup table as needed. This is a no-op unless the
811 * library has previously used to add or mount an image using the same
814 wim_checksum_unhashed_streams(WIMStruct *wim)
818 if (!wim_has_metadata(wim))
820 for (int i = 0; i < wim->hdr.image_count; i++) {
821 struct wim_lookup_table_entry *lte, *tmp;
822 struct wim_image_metadata *imd = wim->image_metadata[i];
823 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
824 struct wim_lookup_table_entry *new_lte;
825 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
829 free_lookup_table_entry(lte);
836 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
837 * it meets the following three conditions:
839 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
840 * 2. The WIM is not part of a spanned set.
841 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
843 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
846 can_modify_wim(WIMStruct *wim)
849 if (taccess(wim->filename, W_OK)) {
850 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
851 return WIMLIB_ERR_WIM_IS_READONLY;
854 if (wim->hdr.total_parts != 1) {
855 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
857 return WIMLIB_ERR_WIM_IS_READONLY;
859 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
860 ERROR("Cannot modify \"%"TS"\": is marked read-only",
862 return WIMLIB_ERR_WIM_IS_READONLY;
867 /* API function documented in wimlib.h */
869 wimlib_free(WIMStruct *wim)
874 while (!list_empty(&wim->subwims)) {
877 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
878 list_del(&subwim->subwim_node);
882 if (filedes_valid(&wim->in_fd))
883 filedes_close(&wim->in_fd);
884 if (filedes_valid(&wim->out_fd))
885 filedes_close(&wim->out_fd);
887 free_lookup_table(wim->lookup_table);
889 wimlib_free_decompressor(wim->decompressor);
892 free_wim_info(wim->wim_info);
893 if (wim->image_metadata) {
894 for (unsigned i = 0; i < wim->hdr.image_count; i++)
895 put_image_metadata(wim->image_metadata[i], NULL);
896 FREE(wim->image_metadata);
902 test_locale_ctype_utf8(void)
907 char *ctype = nl_langinfo(CODESET);
909 return (!strstr(ctype, "UTF-8") ||
910 !strstr(ctype, "UTF8") ||
911 !strstr(ctype, "utf8") ||
912 !strstr(ctype, "utf-8"));
916 /* API function documented in wimlib.h */
918 wimlib_get_version(void)
920 return WIMLIB_VERSION_CODE;
923 static bool lib_initialized = false;
925 /* API function documented in wimlib.h */
927 wimlib_global_init(int init_flags)
932 #ifdef ENABLE_ERROR_MESSAGES
933 if (!wimlib_error_file)
934 wimlib_error_file = stderr;
937 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
938 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
939 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
940 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
941 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
942 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
943 return WIMLIB_ERR_INVALID_PARAM;
945 libxml_global_init();
946 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
947 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
949 if (!wimlib_mbs_is_utf8)
950 libntfs3g_global_init();
955 int ret = win32_global_init(init_flags);
962 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
963 default_ignore_case = false;
964 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
965 default_ignore_case = true;
966 lib_initialized = true;
970 /* API function documented in wimlib.h */
972 wimlib_global_cleanup(void)
974 if (!lib_initialized)
976 libxml_global_cleanup();
977 iconv_global_cleanup();
979 win32_global_cleanup();
982 wimlib_set_error_file(NULL);
983 lib_initialized = false;