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>
35 #include "wimlib/assert.h"
36 #include "wimlib/blob_table.h"
37 #include "wimlib/bitops.h"
38 #include "wimlib/dentry.h"
39 #include "wimlib/encoding.h"
40 #include "wimlib/file_io.h"
41 #include "wimlib/integrity.h"
42 #include "wimlib/metadata.h"
44 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
46 #include "wimlib/security.h"
47 #include "wimlib/wim.h"
48 #include "wimlib/xml.h"
50 # include "wimlib/win32.h" /* for realpath() replacement */
54 wim_default_solid_compression_type(void)
56 return WIMLIB_COMPRESSION_TYPE_LZMS;
60 wim_default_solid_chunk_size(int ctype) {
62 case WIMLIB_COMPRESSION_TYPE_LZMS:
63 return (u32)1 << 26; /* 67108864 */
65 return (u32)1 << 15; /* 32768 */
72 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
76 filedes_invalidate(&wim->in_fd);
77 filedes_invalidate(&wim->out_fd);
78 wim->out_solid_compression_type = wim_default_solid_compression_type();
79 wim->out_solid_chunk_size = wim_default_solid_chunk_size(
80 wim->out_solid_compression_type);
81 INIT_LIST_HEAD(&wim->subwims);
85 /* Determine if the chunk size is valid for the specified compression type. */
87 wim_chunk_size_valid(u32 chunk_size, int ctype)
91 /* Chunk size is meaningless for uncompressed WIMs --- any value is
93 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
96 /* Chunk size must be power of 2. */
99 order = fls32(chunk_size);
100 if (chunk_size != 1U << order)
119 /* See the documentation for the --chunk-size option of `wimlib-imagex
120 * capture' for information about allowed chunk sizes. */
122 case WIMLIB_COMPRESSION_TYPE_LZX:
123 return order >= 15 && order <= 21;
124 case WIMLIB_COMPRESSION_TYPE_XPRESS:
125 return order >= 12 && order <= 16;
126 case WIMLIB_COMPRESSION_TYPE_LZMS:
127 return order >= 15 && order <= 30;
132 /* Return the default chunk size to use for the specified compression type.
134 * See notes above in wim_chunk_size_valid(). */
136 wim_default_chunk_size(int ctype)
139 case WIMLIB_COMPRESSION_TYPE_LZMS:
140 return 1U << 17; /* 131072 */
142 return 1U << 15; /* 32768 */
147 is_blob_in_solid_resource(struct blob_descriptor *blob, void *_ignore)
149 return blob->blob_location == BLOB_IN_WIM &&
150 (blob->rdesc->flags & WIM_RESHDR_FLAG_SOLID);
154 wim_has_solid_resources(const WIMStruct *wim)
156 return for_blob_in_table(wim->blob_table, is_blob_in_solid_resource, NULL);
160 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
161 * @visitor is called on the WIM once for each image, with each image selected
162 * as the current image in turn. If @image is a certain image, @visitor is
163 * called on the WIM only once, with that image selected.
166 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
173 if (image == WIMLIB_ALL_IMAGES) {
175 end = wim->hdr.image_count;
176 } else if (image >= 1 && image <= wim->hdr.image_count) {
180 return WIMLIB_ERR_INVALID_IMAGE;
182 for (i = start; i <= end; i++) {
183 ret = select_wim_image(wim, i);
193 /* API function documented in wimlib.h */
195 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
200 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
204 wim = new_wim_struct();
206 return WIMLIB_ERR_NOMEM;
208 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
212 wim->blob_table = new_blob_table(9001);
213 if (!wim->blob_table) {
214 ret = WIMLIB_ERR_NOMEM;
217 wim->compression_type = ctype;
218 wim->out_compression_type = ctype;
219 wim->chunk_size = wim->hdr.chunk_size;
220 wim->out_chunk_size = wim->hdr.chunk_size;
230 destroy_image_metadata(struct wim_image_metadata *imd,
231 struct blob_table *table,
232 bool free_metadata_blob_descriptor)
234 free_dentry_tree(imd->root_dentry, table);
235 imd->root_dentry = NULL;
236 free_wim_security_data(imd->security_data);
237 imd->security_data = NULL;
239 if (free_metadata_blob_descriptor) {
240 free_blob_descriptor(imd->metadata_blob);
241 imd->metadata_blob = NULL;
244 struct blob_descriptor *blob, *tmp;
245 list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
246 free_blob_descriptor(blob);
248 INIT_LIST_HEAD(&imd->unhashed_blobs);
249 INIT_LIST_HEAD(&imd->inode_list);
252 do_ntfs_umount(imd->ntfs_vol);
253 imd->ntfs_vol = NULL;
259 put_image_metadata(struct wim_image_metadata *imd, struct blob_table *table)
261 if (imd && --imd->refcnt == 0) {
262 destroy_image_metadata(imd, table, true);
267 /* Appends the specified image metadata structure to the array of image metadata
268 * for a WIM, and increments the image count. */
270 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
272 struct wim_image_metadata **imd_array;
274 imd_array = REALLOC(wim->image_metadata,
275 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
278 return WIMLIB_ERR_NOMEM;
279 wim->image_metadata = imd_array;
280 imd_array[wim->hdr.image_count++] = imd;
284 struct wim_image_metadata *
285 new_image_metadata(void)
287 struct wim_image_metadata *imd;
289 imd = CALLOC(1, sizeof(*imd));
292 INIT_LIST_HEAD(&imd->inode_list);
293 INIT_LIST_HEAD(&imd->unhashed_blobs);
298 static struct wim_image_metadata **
299 new_image_metadata_array(unsigned num_images)
301 struct wim_image_metadata **imd_array;
303 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
307 for (unsigned i = 0; i < num_images; i++) {
308 imd_array[i] = new_image_metadata();
309 if (unlikely(!imd_array[i])) {
310 for (unsigned j = 0; j < i; j++)
311 put_image_metadata(imd_array[j], NULL);
321 * Load the metadata for the specified WIM image into memory and set it
322 * as the WIMStruct's currently selected image.
325 * The WIMStruct for the WIM.
327 * The 1-based index of the image in the WIM to select.
329 * On success, 0 will be returned, wim->current_image will be set to
330 * @image, and wim_get_current_image_metadata() can be used to retrieve
331 * metadata information for the image.
333 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
334 * or another error code will be returned.
337 select_wim_image(WIMStruct *wim, int image)
339 struct wim_image_metadata *imd;
342 if (image == WIMLIB_NO_IMAGE)
343 return WIMLIB_ERR_INVALID_IMAGE;
345 if (image == wim->current_image)
348 if (image < 1 || image > wim->hdr.image_count)
349 return WIMLIB_ERR_INVALID_IMAGE;
351 if (!wim_has_metadata(wim))
352 return WIMLIB_ERR_METADATA_NOT_FOUND;
354 /* If a valid image is currently selected, its metadata can be freed if
355 * it has not been modified. */
356 deselect_current_wim_image(wim);
357 wim->current_image = image;
358 imd = wim_get_current_image_metadata(wim);
359 if (imd->root_dentry || imd->modified) {
362 ret = read_metadata_resource(imd);
364 wim->current_image = WIMLIB_NO_IMAGE;
370 deselect_current_wim_image(WIMStruct *wim)
372 struct wim_image_metadata *imd;
373 if (wim->current_image == WIMLIB_NO_IMAGE)
375 imd = wim_get_current_image_metadata(wim);
376 if (!imd->modified) {
377 wimlib_assert(list_empty(&imd->unhashed_blobs));
378 destroy_image_metadata(imd, NULL, false);
380 wim->current_image = WIMLIB_NO_IMAGE;
383 /* API function documented in wimlib.h */
384 WIMLIBAPI const tchar *
385 wimlib_get_compression_type_string(int ctype)
388 case WIMLIB_COMPRESSION_TYPE_NONE:
390 case WIMLIB_COMPRESSION_TYPE_XPRESS:
392 case WIMLIB_COMPRESSION_TYPE_LZX:
394 case WIMLIB_COMPRESSION_TYPE_LZMS:
401 /* API function documented in wimlib.h */
403 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
409 if (!image_name_or_num || !*image_name_or_num)
410 return WIMLIB_NO_IMAGE;
412 if (!tstrcasecmp(image_name_or_num, T("all"))
413 || !tstrcasecmp(image_name_or_num, T("*")))
414 return WIMLIB_ALL_IMAGES;
415 image = tstrtol(image_name_or_num, &p, 10);
416 if (p != image_name_or_num && *p == T('\0') && image > 0) {
417 if (image > wim->hdr.image_count)
418 return WIMLIB_NO_IMAGE;
421 for (i = 1; i <= wim->hdr.image_count; i++) {
422 if (!tstrcmp(image_name_or_num,
423 wimlib_get_image_name(wim, i)))
426 return WIMLIB_NO_IMAGE;
430 /* API function documented in wimlib.h */
432 wimlib_print_available_images(const WIMStruct *wim, int image)
438 if (image == WIMLIB_ALL_IMAGES) {
439 n = tprintf(T("Available Images:\n"));
441 last = wim->hdr.image_count;
442 } else if (image >= 1 && image <= wim->hdr.image_count) {
443 n = tprintf(T("Information for Image %d\n"), image);
447 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
451 for (i = 0; i < n - 1; i++)
454 for (i = first; i <= last; i++)
455 print_image_info(wim->wim_info, i);
458 /* API function documented in wimlib.h */
460 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
462 memset(info, 0, sizeof(struct wimlib_wim_info));
463 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
464 info->image_count = wim->hdr.image_count;
465 info->boot_index = wim->hdr.boot_idx;
466 info->wim_version = wim->hdr.wim_version;
467 info->chunk_size = wim->chunk_size;
468 info->part_number = wim->hdr.part_number;
469 info->total_parts = wim->hdr.total_parts;
470 info->compression_type = wim->compression_type;
471 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
472 info->has_integrity_table = wim_has_integrity_table(wim);
473 info->opened_from_file = (wim->filename != NULL);
474 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
475 (wim->hdr.total_parts != 1) ||
476 (wim->filename && taccess(wim->filename, W_OK));
477 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
478 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
479 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
480 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
481 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
482 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
483 info->pipable = wim_is_pipable(wim);
487 /* API function documented in wimlib.h */
489 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
491 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
493 WIMLIB_CHANGE_BOOT_INDEX |
494 WIMLIB_CHANGE_RPFIX_FLAG))
495 return WIMLIB_ERR_INVALID_PARAM;
497 if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
498 info->boot_index > wim->hdr.image_count)
499 return WIMLIB_ERR_INVALID_IMAGE;
501 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
502 if (info->is_marked_readonly)
503 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
505 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
508 if (which & WIMLIB_CHANGE_GUID)
509 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
511 if (which & WIMLIB_CHANGE_BOOT_INDEX)
512 wim->hdr.boot_idx = info->boot_index;
514 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
516 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
518 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
524 set_out_ctype(int ctype, u8 *out_ctype_p)
527 case WIMLIB_COMPRESSION_TYPE_NONE:
528 case WIMLIB_COMPRESSION_TYPE_LZX:
529 case WIMLIB_COMPRESSION_TYPE_XPRESS:
530 case WIMLIB_COMPRESSION_TYPE_LZMS:
531 *out_ctype_p = ctype;
534 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
537 /* API function documented in wimlib.h */
539 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
541 int ret = set_out_ctype(ctype, &wim->out_compression_type);
545 /* Reset the chunk size if it's no longer valid. */
546 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
547 wim->out_chunk_size = wim_default_chunk_size(ctype);
551 /* API function documented in wimlib.h */
553 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
555 int ret = set_out_ctype(ctype, &wim->out_solid_compression_type);
559 /* Reset the chunk size if it's no longer valid. */
560 if (!wim_chunk_size_valid(wim->out_solid_chunk_size, ctype))
561 wim->out_solid_chunk_size = wim_default_solid_chunk_size(ctype);
566 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
568 if (!wim_chunk_size_valid(chunk_size, ctype))
569 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
571 *out_chunk_size_p = chunk_size;
575 /* API function documented in wimlib.h */
577 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
579 if (chunk_size == 0) {
580 wim->out_chunk_size =
581 wim_default_chunk_size(wim->out_compression_type);
585 return set_out_chunk_size(chunk_size,
586 wim->out_compression_type,
587 &wim->out_chunk_size);
590 /* API function documented in wimlib.h */
592 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
594 if (chunk_size == 0) {
595 wim->out_solid_chunk_size =
596 wim_default_solid_chunk_size(wim->out_solid_compression_type);
600 return set_out_chunk_size(chunk_size,
601 wim->out_solid_compression_type,
602 &wim->out_solid_chunk_size);
606 wimlib_register_progress_function(WIMStruct *wim,
607 wimlib_progress_func_t progfunc,
610 wim->progfunc = progfunc;
611 wim->progctx = progctx;
615 open_wim_file(const tchar *filename, struct filedes *fd_ret)
619 raw_fd = topen(filename, O_RDONLY | O_BINARY);
621 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
622 return WIMLIB_ERR_OPEN;
624 filedes_init(fd_ret, raw_fd);
629 * Begins the reading of a WIM file; opens the file and reads its header and
630 * blob table, and optionally checks the integrity.
633 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
637 const tchar *wimfile;
639 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
641 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
642 wim->in_fd.is_pipe = 1;
644 wimfile = wim_filename_or_fd;
645 ret = open_wim_file(wimfile, &wim->in_fd);
649 /* The absolute path to the WIM is requested so that
650 * wimlib_overwrite() still works even if the process changes
651 * its working directory. This actually happens if a WIM is
652 * mounted read-write, since the FUSE thread changes directory
653 * to "/", and it needs to be able to find the WIM file again.
655 * This will break if the full path to the WIM changes in the
656 * intervening time...
658 * Warning: in Windows native builds, realpath() calls the
659 * replacement function in win32_replacements.c.
661 wim->filename = realpath(wimfile, NULL);
662 if (!wim->filename) {
663 ERROR_WITH_ERRNO("Failed to get full path to file "
664 "\"%"TS"\"", wimfile);
666 return WIMLIB_ERR_NOMEM;
668 return WIMLIB_ERR_NO_FILENAME;
672 ret = read_wim_header(wim, &wim->hdr);
676 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
677 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
678 " \"%"TS"\". It may be being changed by another process,\n"
679 " or a process may have crashed while writing the WIM.",
683 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
684 ret = can_modify_wim(wim);
689 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
690 (wim->hdr.total_parts != 1))
691 return WIMLIB_ERR_IS_SPLIT_WIM;
693 /* If the boot index is invalid, print a warning and set it to 0 */
694 if (wim->hdr.boot_idx > wim->hdr.image_count) {
695 WARNING("Ignoring invalid boot index.");
696 wim->hdr.boot_idx = 0;
699 /* Check and cache the compression type */
700 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
701 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
702 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
703 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
704 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
705 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
706 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
707 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
709 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
712 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
714 wim->out_compression_type = wim->compression_type;
716 /* Check and cache the chunk size. */
717 wim->chunk_size = wim->hdr.chunk_size;
718 wim->out_chunk_size = wim->chunk_size;
719 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
720 ERROR("Invalid chunk size (%"PRIu32" bytes) "
721 "for compression type %"TS"!", wim->chunk_size,
722 wimlib_get_compression_type_string(wim->compression_type));
723 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
726 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
727 ret = check_wim_integrity(wim);
728 if (ret == WIM_INTEGRITY_NONEXISTENT) {
729 WARNING("\"%"TS"\" does not contain integrity "
730 "information. Skipping integrity check.",
732 } else if (ret == WIM_INTEGRITY_NOT_OK) {
733 return WIMLIB_ERR_INTEGRITY;
734 } else if (ret != WIM_INTEGRITY_OK) {
739 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
740 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
741 if (!wim->image_metadata)
742 return WIMLIB_ERR_NOMEM;
745 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
746 wim->blob_table = new_blob_table(9001);
747 if (!wim->blob_table)
748 return WIMLIB_ERR_NOMEM;
751 ret = read_wim_xml_data(wim);
755 xml_num_images = wim_info_get_num_images(wim->wim_info);
756 if (xml_num_images != wim->hdr.image_count) {
757 ERROR("The WIM's header is inconsistent with its XML data.\n"
758 " Please submit a bug report if you believe this "
759 "WIM file should be considered valid.");
760 return WIMLIB_ERR_IMAGE_COUNT;
763 ret = read_blob_table(wim);
771 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
773 wimlib_progress_func_t progfunc, void *progctx)
778 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
782 wim = new_wim_struct();
784 return WIMLIB_ERR_NOMEM;
786 wim->progfunc = progfunc;
787 wim->progctx = progctx;
789 ret = begin_read(wim, wim_filename_or_fd, open_flags);
799 /* API function documented in wimlib.h */
801 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
803 wimlib_progress_func_t progfunc, void *progctx)
805 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
806 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
807 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
808 return WIMLIB_ERR_INVALID_PARAM;
810 if (!wimfile || !*wimfile || !wim_ret)
811 return WIMLIB_ERR_INVALID_PARAM;
813 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
817 /* API function documented in wimlib.h */
819 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
821 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
825 /* Checksum all blobs that are unhashed (other than the metadata blobs), merging
826 * them into the blob table as needed. This is a no-op unless files have been
827 * added to an image in the same WIMStruct. */
829 wim_checksum_unhashed_blobs(WIMStruct *wim)
833 if (!wim_has_metadata(wim))
835 for (int i = 0; i < wim->hdr.image_count; i++) {
836 struct blob_descriptor *blob, *tmp;
837 struct wim_image_metadata *imd = wim->image_metadata[i];
838 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
839 struct blob_descriptor *new_blob;
840 ret = hash_unhashed_blob(blob, wim->blob_table, &new_blob);
843 if (new_blob != blob)
844 free_blob_descriptor(blob);
851 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
852 * it meets the following three conditions:
854 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
855 * 2. The WIM is not part of a spanned set.
856 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
858 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
861 can_modify_wim(WIMStruct *wim)
864 if (taccess(wim->filename, W_OK)) {
865 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
866 return WIMLIB_ERR_WIM_IS_READONLY;
869 if (wim->hdr.total_parts != 1) {
870 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
872 return WIMLIB_ERR_WIM_IS_READONLY;
874 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
875 ERROR("Cannot modify \"%"TS"\": is marked read-only",
877 return WIMLIB_ERR_WIM_IS_READONLY;
882 /* API function documented in wimlib.h */
884 wimlib_free(WIMStruct *wim)
889 while (!list_empty(&wim->subwims)) {
892 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
893 list_del(&subwim->subwim_node);
897 if (filedes_valid(&wim->in_fd))
898 filedes_close(&wim->in_fd);
899 if (filedes_valid(&wim->out_fd))
900 filedes_close(&wim->out_fd);
902 free_blob_table(wim->blob_table);
904 wimlib_free_decompressor(wim->decompressor);
907 free_wim_info(wim->wim_info);
908 if (wim->image_metadata) {
909 for (unsigned i = 0; i < wim->hdr.image_count; i++)
910 put_image_metadata(wim->image_metadata[i], NULL);
911 FREE(wim->image_metadata);
917 test_locale_ctype_utf8(void)
922 char *ctype = nl_langinfo(CODESET);
924 return (!strstr(ctype, "UTF-8") ||
925 !strstr(ctype, "UTF8") ||
926 !strstr(ctype, "utf8") ||
927 !strstr(ctype, "utf-8"));
931 /* API function documented in wimlib.h */
933 wimlib_get_version(void)
935 return (WIMLIB_MAJOR_VERSION << 20) |
936 (WIMLIB_MINOR_VERSION << 10) |
937 WIMLIB_PATCH_VERSION;
940 static bool lib_initialized = false;
942 /* API function documented in wimlib.h */
944 wimlib_global_init(int init_flags)
949 #ifdef ENABLE_ERROR_MESSAGES
950 if (!wimlib_error_file)
951 wimlib_error_file = stderr;
954 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
955 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
956 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
957 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
958 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
959 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
960 return WIMLIB_ERR_INVALID_PARAM;
962 libxml_global_init();
963 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
964 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
966 if (!wimlib_mbs_is_utf8)
967 libntfs3g_global_init();
972 int ret = win32_global_init(init_flags);
979 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
980 default_ignore_case = false;
981 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
982 default_ignore_case = true;
983 lib_initialized = true;
987 /* API function documented in wimlib.h */
989 wimlib_global_cleanup(void)
991 if (!lib_initialized)
993 libxml_global_cleanup();
994 iconv_global_cleanup();
996 win32_global_cleanup();
999 wimlib_set_error_file(NULL);
1000 lib_initialized = false;