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/.
29 # include <langinfo.h>
36 #include "wimlib/assert.h"
37 #include "wimlib/blob_table.h"
38 #include "wimlib/bitops.h"
39 #include "wimlib/dentry.h"
40 #include "wimlib/encoding.h"
41 #include "wimlib/file_io.h"
42 #include "wimlib/integrity.h"
43 #include "wimlib/metadata.h"
45 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
47 #include "wimlib/security.h"
48 #include "wimlib/wim.h"
49 #include "wimlib/xml.h"
51 # include "wimlib/win32.h" /* for realpath() replacement */
55 wim_default_solid_compression_type(void)
57 return WIMLIB_COMPRESSION_TYPE_LZMS;
61 wim_default_solid_chunk_size(int ctype) {
63 case WIMLIB_COMPRESSION_TYPE_LZMS:
64 return (u32)1 << 26; /* 67108864 */
66 return (u32)1 << 15; /* 32768 */
73 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
77 filedes_invalidate(&wim->in_fd);
78 filedes_invalidate(&wim->out_fd);
79 wim->out_solid_compression_type = wim_default_solid_compression_type();
80 wim->out_solid_chunk_size = wim_default_solid_chunk_size(
81 wim->out_solid_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 is_blob_in_solid_resource(struct blob_descriptor *blob, void *_ignore)
150 return blob->blob_location == BLOB_IN_WIM &&
151 (blob->rdesc->flags & WIM_RESHDR_FLAG_SOLID);
155 wim_has_solid_resources(const WIMStruct *wim)
157 return for_blob_in_table(wim->blob_table, is_blob_in_solid_resource, NULL);
161 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
162 * @visitor is called on the WIM once for each image, with each image selected
163 * as the current image in turn. If @image is a certain image, @visitor is
164 * called on the WIM only once, with that image selected.
167 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
174 if (image == WIMLIB_ALL_IMAGES) {
176 end = wim->hdr.image_count;
177 } else if (image >= 1 && image <= wim->hdr.image_count) {
181 return WIMLIB_ERR_INVALID_IMAGE;
183 for (i = start; i <= end; i++) {
184 ret = select_wim_image(wim, i);
194 /* API function documented in wimlib.h */
196 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
201 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
205 wim = new_wim_struct();
207 return WIMLIB_ERR_NOMEM;
209 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
213 wim->blob_table = new_blob_table(9001);
214 if (!wim->blob_table) {
215 ret = WIMLIB_ERR_NOMEM;
218 wim->compression_type = ctype;
219 wim->out_compression_type = ctype;
220 wim->chunk_size = wim->hdr.chunk_size;
221 wim->out_chunk_size = wim->hdr.chunk_size;
231 destroy_image_metadata(struct wim_image_metadata *imd,
232 struct blob_table *table,
233 bool free_metadata_blob_descriptor)
235 free_dentry_tree(imd->root_dentry, table);
236 imd->root_dentry = NULL;
237 free_wim_security_data(imd->security_data);
238 imd->security_data = NULL;
240 if (free_metadata_blob_descriptor) {
241 free_blob_descriptor(imd->metadata_blob);
242 imd->metadata_blob = NULL;
245 struct blob_descriptor *blob, *tmp;
246 list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
247 free_blob_descriptor(blob);
249 INIT_LIST_HEAD(&imd->unhashed_blobs);
250 INIT_LIST_HEAD(&imd->inode_list);
253 do_ntfs_umount(imd->ntfs_vol);
254 imd->ntfs_vol = NULL;
260 put_image_metadata(struct wim_image_metadata *imd, struct blob_table *table)
262 if (imd && --imd->refcnt == 0) {
263 destroy_image_metadata(imd, table, true);
268 /* Appends the specified image metadata structure to the array of image metadata
269 * for a WIM, and increments the image count. */
271 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
273 struct wim_image_metadata **imd_array;
275 imd_array = REALLOC(wim->image_metadata,
276 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
279 return WIMLIB_ERR_NOMEM;
280 wim->image_metadata = imd_array;
281 imd_array[wim->hdr.image_count++] = imd;
285 struct wim_image_metadata *
286 new_image_metadata(void)
288 struct wim_image_metadata *imd;
290 imd = CALLOC(1, sizeof(*imd));
293 INIT_LIST_HEAD(&imd->inode_list);
294 INIT_LIST_HEAD(&imd->unhashed_blobs);
299 static struct wim_image_metadata **
300 new_image_metadata_array(unsigned num_images)
302 struct wim_image_metadata **imd_array;
304 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
308 for (unsigned i = 0; i < num_images; i++) {
309 imd_array[i] = new_image_metadata();
310 if (unlikely(!imd_array[i])) {
311 for (unsigned j = 0; j < i; j++)
312 put_image_metadata(imd_array[j], NULL);
322 * Load the metadata for the specified WIM image into memory and set it
323 * as the WIMStruct's currently selected image.
326 * The WIMStruct for the WIM.
328 * The 1-based index of the image in the WIM to select.
330 * On success, 0 will be returned, wim->current_image will be set to
331 * @image, and wim_get_current_image_metadata() can be used to retrieve
332 * metadata information for the image.
334 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
335 * or another error code will be returned.
338 select_wim_image(WIMStruct *wim, int image)
340 struct wim_image_metadata *imd;
343 if (image == WIMLIB_NO_IMAGE)
344 return WIMLIB_ERR_INVALID_IMAGE;
346 if (image == wim->current_image)
349 if (image < 1 || image > wim->hdr.image_count)
350 return WIMLIB_ERR_INVALID_IMAGE;
352 if (!wim_has_metadata(wim))
353 return WIMLIB_ERR_METADATA_NOT_FOUND;
355 /* If a valid image is currently selected, its metadata can be freed if
356 * it has not been modified. */
357 deselect_current_wim_image(wim);
358 wim->current_image = image;
359 imd = wim_get_current_image_metadata(wim);
360 if (imd->root_dentry || imd->modified) {
363 ret = read_metadata_resource(imd);
365 wim->current_image = WIMLIB_NO_IMAGE;
371 deselect_current_wim_image(WIMStruct *wim)
373 struct wim_image_metadata *imd;
374 if (wim->current_image == WIMLIB_NO_IMAGE)
376 imd = wim_get_current_image_metadata(wim);
377 if (!imd->modified) {
378 wimlib_assert(list_empty(&imd->unhashed_blobs));
379 destroy_image_metadata(imd, NULL, false);
381 wim->current_image = WIMLIB_NO_IMAGE;
384 /* API function documented in wimlib.h */
385 WIMLIBAPI const tchar *
386 wimlib_get_compression_type_string(int ctype)
389 case WIMLIB_COMPRESSION_TYPE_NONE:
391 case WIMLIB_COMPRESSION_TYPE_XPRESS:
393 case WIMLIB_COMPRESSION_TYPE_LZX:
395 case WIMLIB_COMPRESSION_TYPE_LZMS:
402 /* API function documented in wimlib.h */
404 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
410 if (!image_name_or_num || !*image_name_or_num)
411 return WIMLIB_NO_IMAGE;
413 if (!tstrcasecmp(image_name_or_num, T("all"))
414 || !tstrcasecmp(image_name_or_num, T("*")))
415 return WIMLIB_ALL_IMAGES;
416 image = tstrtol(image_name_or_num, &p, 10);
417 if (p != image_name_or_num && *p == T('\0') && image > 0) {
418 if (image > wim->hdr.image_count)
419 return WIMLIB_NO_IMAGE;
422 for (i = 1; i <= wim->hdr.image_count; i++) {
423 if (!tstrcmp(image_name_or_num,
424 wimlib_get_image_name(wim, i)))
427 return WIMLIB_NO_IMAGE;
431 /* API function documented in wimlib.h */
433 wimlib_print_available_images(const WIMStruct *wim, int image)
439 if (image == WIMLIB_ALL_IMAGES) {
440 n = tprintf(T("Available Images:\n"));
442 last = wim->hdr.image_count;
443 } else if (image >= 1 && image <= wim->hdr.image_count) {
444 n = tprintf(T("Information for Image %d\n"), image);
448 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
452 for (i = 0; i < n - 1; i++)
455 for (i = first; i <= last; i++)
456 print_image_info(wim->wim_info, i);
459 /* API function documented in wimlib.h */
461 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
463 memset(info, 0, sizeof(struct wimlib_wim_info));
464 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
465 info->image_count = wim->hdr.image_count;
466 info->boot_index = wim->hdr.boot_idx;
467 info->wim_version = wim->hdr.wim_version;
468 info->chunk_size = wim->chunk_size;
469 info->part_number = wim->hdr.part_number;
470 info->total_parts = wim->hdr.total_parts;
471 info->compression_type = wim->compression_type;
472 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
473 info->has_integrity_table = wim_has_integrity_table(wim);
474 info->opened_from_file = (wim->filename != NULL);
475 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
476 (wim->hdr.total_parts != 1) ||
477 (wim->filename && taccess(wim->filename, W_OK));
478 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
479 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
480 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
481 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
482 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
483 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
484 info->pipable = wim_is_pipable(wim);
488 /* API function documented in wimlib.h */
490 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
492 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
494 WIMLIB_CHANGE_BOOT_INDEX |
495 WIMLIB_CHANGE_RPFIX_FLAG))
496 return WIMLIB_ERR_INVALID_PARAM;
498 if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
499 info->boot_index > wim->hdr.image_count)
500 return WIMLIB_ERR_INVALID_IMAGE;
502 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
503 if (info->is_marked_readonly)
504 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
506 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
509 if (which & WIMLIB_CHANGE_GUID)
510 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
512 if (which & WIMLIB_CHANGE_BOOT_INDEX)
513 wim->hdr.boot_idx = info->boot_index;
515 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
517 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
519 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
525 set_out_ctype(int ctype, u8 *out_ctype_p)
528 case WIMLIB_COMPRESSION_TYPE_NONE:
529 case WIMLIB_COMPRESSION_TYPE_LZX:
530 case WIMLIB_COMPRESSION_TYPE_XPRESS:
531 case WIMLIB_COMPRESSION_TYPE_LZMS:
532 *out_ctype_p = ctype;
535 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
538 /* API function documented in wimlib.h */
540 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
542 int ret = set_out_ctype(ctype, &wim->out_compression_type);
546 /* Reset the chunk size if it's no longer valid. */
547 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
548 wim->out_chunk_size = wim_default_chunk_size(ctype);
552 /* API function documented in wimlib.h */
554 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
556 int ret = set_out_ctype(ctype, &wim->out_solid_compression_type);
560 /* Reset the chunk size if it's no longer valid. */
561 if (!wim_chunk_size_valid(wim->out_solid_chunk_size, ctype))
562 wim->out_solid_chunk_size = wim_default_solid_chunk_size(ctype);
567 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
569 if (!wim_chunk_size_valid(chunk_size, ctype))
570 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
572 *out_chunk_size_p = chunk_size;
576 /* API function documented in wimlib.h */
578 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
580 if (chunk_size == 0) {
581 wim->out_chunk_size =
582 wim_default_chunk_size(wim->out_compression_type);
586 return set_out_chunk_size(chunk_size,
587 wim->out_compression_type,
588 &wim->out_chunk_size);
591 /* API function documented in wimlib.h */
593 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
595 if (chunk_size == 0) {
596 wim->out_solid_chunk_size =
597 wim_default_solid_chunk_size(wim->out_solid_compression_type);
601 return set_out_chunk_size(chunk_size,
602 wim->out_solid_compression_type,
603 &wim->out_solid_chunk_size);
607 wimlib_register_progress_function(WIMStruct *wim,
608 wimlib_progress_func_t progfunc,
611 wim->progfunc = progfunc;
612 wim->progctx = progctx;
616 open_wim_file(const tchar *filename, struct filedes *fd_ret)
620 raw_fd = topen(filename, O_RDONLY | O_BINARY);
622 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
623 return WIMLIB_ERR_OPEN;
625 filedes_init(fd_ret, raw_fd);
630 * Begins the reading of a WIM file; opens the file and reads its header and
631 * blob table, and optionally checks the integrity.
634 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
638 const tchar *wimfile;
640 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
642 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
643 wim->in_fd.is_pipe = 1;
645 wimfile = wim_filename_or_fd;
646 ret = open_wim_file(wimfile, &wim->in_fd);
650 /* The absolute path to the WIM is requested so that
651 * wimlib_overwrite() still works even if the process changes
652 * its working directory. This actually happens if a WIM is
653 * mounted read-write, since the FUSE thread changes directory
654 * to "/", and it needs to be able to find the WIM file again.
656 * This will break if the full path to the WIM changes in the
657 * intervening time...
659 * Warning: in Windows native builds, realpath() calls the
660 * replacement function in win32_replacements.c.
662 wim->filename = realpath(wimfile, NULL);
663 if (!wim->filename) {
664 ERROR_WITH_ERRNO("Failed to get full path to file "
665 "\"%"TS"\"", wimfile);
667 return WIMLIB_ERR_NOMEM;
669 return WIMLIB_ERR_NO_FILENAME;
673 ret = read_wim_header(wim, &wim->hdr);
677 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
678 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
679 " \"%"TS"\". It may be being changed by another process,\n"
680 " or a process may have crashed while writing the WIM.",
684 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
685 ret = can_modify_wim(wim);
690 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
691 (wim->hdr.total_parts != 1))
692 return WIMLIB_ERR_IS_SPLIT_WIM;
694 /* If the boot index is invalid, print a warning and set it to 0 */
695 if (wim->hdr.boot_idx > wim->hdr.image_count) {
696 WARNING("Ignoring invalid boot index.");
697 wim->hdr.boot_idx = 0;
700 /* Check and cache the compression type */
701 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
702 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
703 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
704 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
705 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
706 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
707 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
708 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
710 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
713 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
715 wim->out_compression_type = wim->compression_type;
717 /* Check and cache the chunk size. */
718 wim->chunk_size = wim->hdr.chunk_size;
719 wim->out_chunk_size = wim->chunk_size;
720 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
721 ERROR("Invalid chunk size (%"PRIu32" bytes) "
722 "for compression type %"TS"!", wim->chunk_size,
723 wimlib_get_compression_type_string(wim->compression_type));
724 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
727 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
728 ret = check_wim_integrity(wim);
729 if (ret == WIM_INTEGRITY_NONEXISTENT) {
730 WARNING("\"%"TS"\" does not contain integrity "
731 "information. Skipping integrity check.",
733 } else if (ret == WIM_INTEGRITY_NOT_OK) {
734 return WIMLIB_ERR_INTEGRITY;
735 } else if (ret != WIM_INTEGRITY_OK) {
740 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
741 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
742 if (!wim->image_metadata)
743 return WIMLIB_ERR_NOMEM;
746 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
747 wim->blob_table = new_blob_table(9001);
748 if (!wim->blob_table)
749 return WIMLIB_ERR_NOMEM;
752 ret = read_wim_xml_data(wim);
756 xml_num_images = wim_info_get_num_images(wim->wim_info);
757 if (xml_num_images != wim->hdr.image_count) {
758 ERROR("The WIM's header is inconsistent with its XML data.\n"
759 " Please submit a bug report if you believe this "
760 "WIM file should be considered valid.");
761 return WIMLIB_ERR_IMAGE_COUNT;
764 ret = read_blob_table(wim);
772 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
774 wimlib_progress_func_t progfunc, void *progctx)
779 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
783 wim = new_wim_struct();
785 return WIMLIB_ERR_NOMEM;
787 wim->progfunc = progfunc;
788 wim->progctx = progctx;
790 ret = begin_read(wim, wim_filename_or_fd, open_flags);
800 /* API function documented in wimlib.h */
802 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
804 wimlib_progress_func_t progfunc, void *progctx)
806 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
807 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
808 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
809 return WIMLIB_ERR_INVALID_PARAM;
811 if (!wimfile || !*wimfile || !wim_ret)
812 return WIMLIB_ERR_INVALID_PARAM;
814 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
818 /* API function documented in wimlib.h */
820 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
822 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
826 /* Checksum all blobs that are unhashed (other than the metadata blobs), merging
827 * them into the blob table as needed. This is a no-op unless files have been
828 * added to an image in the same WIMStruct. */
830 wim_checksum_unhashed_blobs(WIMStruct *wim)
834 if (!wim_has_metadata(wim))
836 for (int i = 0; i < wim->hdr.image_count; i++) {
837 struct blob_descriptor *blob, *tmp;
838 struct wim_image_metadata *imd = wim->image_metadata[i];
839 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
840 struct blob_descriptor *new_blob;
841 ret = hash_unhashed_blob(blob, wim->blob_table, &new_blob);
844 if (new_blob != blob)
845 free_blob_descriptor(blob);
852 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
853 * it meets the following three conditions:
855 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
856 * 2. The WIM is not part of a spanned set.
857 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
859 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
862 can_modify_wim(WIMStruct *wim)
865 if (taccess(wim->filename, W_OK)) {
866 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
867 return WIMLIB_ERR_WIM_IS_READONLY;
870 if (wim->hdr.total_parts != 1) {
871 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
873 return WIMLIB_ERR_WIM_IS_READONLY;
875 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
876 ERROR("Cannot modify \"%"TS"\": is marked read-only",
878 return WIMLIB_ERR_WIM_IS_READONLY;
883 /* API function documented in wimlib.h */
885 wimlib_free(WIMStruct *wim)
890 while (!list_empty(&wim->subwims)) {
893 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
894 list_del(&subwim->subwim_node);
898 if (filedes_valid(&wim->in_fd))
899 filedes_close(&wim->in_fd);
900 if (filedes_valid(&wim->out_fd))
901 filedes_close(&wim->out_fd);
903 free_blob_table(wim->blob_table);
905 wimlib_free_decompressor(wim->decompressor);
908 free_wim_info(wim->wim_info);
909 if (wim->image_metadata) {
910 for (unsigned i = 0; i < wim->hdr.image_count; i++)
911 put_image_metadata(wim->image_metadata[i], NULL);
912 FREE(wim->image_metadata);
918 test_locale_ctype_utf8(void)
923 char *ctype = nl_langinfo(CODESET);
925 return (!strstr(ctype, "UTF-8") ||
926 !strstr(ctype, "UTF8") ||
927 !strstr(ctype, "utf8") ||
928 !strstr(ctype, "utf-8"));
932 /* API function documented in wimlib.h */
934 wimlib_get_version(void)
936 return (WIMLIB_MAJOR_VERSION << 20) |
937 (WIMLIB_MINOR_VERSION << 10) |
938 WIMLIB_PATCH_VERSION;
941 static bool lib_initialized = false;
942 static pthread_mutex_t lib_initialization_mutex = PTHREAD_MUTEX_INITIALIZER;
944 /* API function documented in wimlib.h */
946 wimlib_global_init(int init_flags)
953 pthread_mutex_lock(&lib_initialization_mutex);
959 #ifdef ENABLE_ERROR_MESSAGES
960 if (!wimlib_error_file)
961 wimlib_error_file = stderr;
964 ret = WIMLIB_ERR_INVALID_PARAM;
965 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
966 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
967 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
968 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
969 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
970 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
973 libxml_global_init();
974 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
975 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
977 if (!wimlib_mbs_is_utf8)
978 libntfs3g_global_init();
982 ret = win32_global_init(init_flags);
988 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
989 default_ignore_case = false;
990 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
991 default_ignore_case = true;
992 lib_initialized = true;
995 pthread_mutex_unlock(&lib_initialization_mutex);
999 /* API function documented in wimlib.h */
1001 wimlib_global_cleanup(void)
1003 if (!lib_initialized)
1006 pthread_mutex_lock(&lib_initialization_mutex);
1008 if (!lib_initialized)
1011 libxml_global_cleanup();
1012 iconv_global_cleanup();
1014 win32_global_cleanup();
1017 wimlib_set_error_file(NULL);
1018 lib_initialized = false;
1021 pthread_mutex_unlock(&lib_initialization_mutex);