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);
206 return WIMLIB_ERR_INVALID_PARAM;
208 wim = new_wim_struct();
210 return WIMLIB_ERR_NOMEM;
212 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
216 wim->blob_table = new_blob_table(9001);
217 if (!wim->blob_table) {
218 ret = WIMLIB_ERR_NOMEM;
221 wim->compression_type = ctype;
222 wim->out_compression_type = ctype;
223 wim->chunk_size = wim->hdr.chunk_size;
224 wim->out_chunk_size = wim->hdr.chunk_size;
234 destroy_image_metadata(struct wim_image_metadata *imd,
235 struct blob_table *table,
236 bool free_metadata_blob_descriptor)
238 free_dentry_tree(imd->root_dentry, table);
239 imd->root_dentry = NULL;
240 free_wim_security_data(imd->security_data);
241 imd->security_data = NULL;
243 if (free_metadata_blob_descriptor) {
244 free_blob_descriptor(imd->metadata_blob);
245 imd->metadata_blob = NULL;
248 struct blob_descriptor *blob, *tmp;
249 list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
250 free_blob_descriptor(blob);
252 INIT_LIST_HEAD(&imd->unhashed_blobs);
253 INIT_LIST_HEAD(&imd->inode_list);
256 do_ntfs_umount(imd->ntfs_vol);
257 imd->ntfs_vol = NULL;
263 put_image_metadata(struct wim_image_metadata *imd, struct blob_table *table)
265 if (imd && --imd->refcnt == 0) {
266 destroy_image_metadata(imd, table, true);
271 /* Appends the specified image metadata structure to the array of image metadata
272 * for a WIM, and increments the image count. */
274 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
276 struct wim_image_metadata **imd_array;
278 imd_array = REALLOC(wim->image_metadata,
279 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
282 return WIMLIB_ERR_NOMEM;
283 wim->image_metadata = imd_array;
284 imd_array[wim->hdr.image_count++] = imd;
288 struct wim_image_metadata *
289 new_image_metadata(void)
291 struct wim_image_metadata *imd;
293 imd = CALLOC(1, sizeof(*imd));
296 INIT_LIST_HEAD(&imd->inode_list);
297 INIT_LIST_HEAD(&imd->unhashed_blobs);
302 static struct wim_image_metadata **
303 new_image_metadata_array(unsigned num_images)
305 struct wim_image_metadata **imd_array;
307 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
311 for (unsigned i = 0; i < num_images; i++) {
312 imd_array[i] = new_image_metadata();
313 if (unlikely(!imd_array[i])) {
314 for (unsigned j = 0; j < i; j++)
315 put_image_metadata(imd_array[j], NULL);
325 * Load the metadata for the specified WIM image into memory and set it
326 * as the WIMStruct's currently selected image.
329 * The WIMStruct for the WIM.
331 * The 1-based index of the image in the WIM to select.
333 * On success, 0 will be returned, wim->current_image will be set to
334 * @image, and wim_get_current_image_metadata() can be used to retrieve
335 * metadata information for the image.
337 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
338 * or another error code will be returned.
341 select_wim_image(WIMStruct *wim, int image)
343 struct wim_image_metadata *imd;
346 if (image == WIMLIB_NO_IMAGE)
347 return WIMLIB_ERR_INVALID_IMAGE;
349 if (image == wim->current_image)
352 if (image < 1 || image > wim->hdr.image_count)
353 return WIMLIB_ERR_INVALID_IMAGE;
355 if (!wim_has_metadata(wim))
356 return WIMLIB_ERR_METADATA_NOT_FOUND;
358 /* If a valid image is currently selected, its metadata can be freed if
359 * it has not been modified. */
360 deselect_current_wim_image(wim);
361 wim->current_image = image;
362 imd = wim_get_current_image_metadata(wim);
363 if (imd->root_dentry || imd->modified) {
366 ret = read_metadata_resource(imd);
368 wim->current_image = WIMLIB_NO_IMAGE;
374 deselect_current_wim_image(WIMStruct *wim)
376 struct wim_image_metadata *imd;
377 if (wim->current_image == WIMLIB_NO_IMAGE)
379 imd = wim_get_current_image_metadata(wim);
380 if (!imd->modified) {
381 wimlib_assert(list_empty(&imd->unhashed_blobs));
382 destroy_image_metadata(imd, NULL, false);
384 wim->current_image = WIMLIB_NO_IMAGE;
387 /* API function documented in wimlib.h */
388 WIMLIBAPI const tchar *
389 wimlib_get_compression_type_string(int ctype)
392 case WIMLIB_COMPRESSION_TYPE_NONE:
394 case WIMLIB_COMPRESSION_TYPE_XPRESS:
396 case WIMLIB_COMPRESSION_TYPE_LZX:
398 case WIMLIB_COMPRESSION_TYPE_LZMS:
405 /* API function documented in wimlib.h */
407 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
413 if (!image_name_or_num || !*image_name_or_num)
414 return WIMLIB_NO_IMAGE;
416 if (!tstrcasecmp(image_name_or_num, T("all"))
417 || !tstrcasecmp(image_name_or_num, T("*")))
418 return WIMLIB_ALL_IMAGES;
419 image = tstrtol(image_name_or_num, &p, 10);
420 if (p != image_name_or_num && *p == T('\0') && image > 0) {
421 if (image > wim->hdr.image_count)
422 return WIMLIB_NO_IMAGE;
425 for (i = 1; i <= wim->hdr.image_count; i++) {
426 if (!tstrcmp(image_name_or_num,
427 wimlib_get_image_name(wim, i)))
430 return WIMLIB_NO_IMAGE;
434 /* API function documented in wimlib.h */
436 wimlib_print_available_images(const WIMStruct *wim, int image)
442 if (image == WIMLIB_ALL_IMAGES) {
443 n = tprintf(T("Available Images:\n"));
445 last = wim->hdr.image_count;
446 } else if (image >= 1 && image <= wim->hdr.image_count) {
447 n = tprintf(T("Information for Image %d\n"), image);
451 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
455 for (i = 0; i < n - 1; i++)
458 for (i = first; i <= last; i++)
459 print_image_info(wim->wim_info, i);
462 /* API function documented in wimlib.h */
464 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
466 memset(info, 0, sizeof(struct wimlib_wim_info));
467 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
468 info->image_count = wim->hdr.image_count;
469 info->boot_index = wim->hdr.boot_idx;
470 info->wim_version = wim->hdr.wim_version;
471 info->chunk_size = wim->chunk_size;
472 info->part_number = wim->hdr.part_number;
473 info->total_parts = wim->hdr.total_parts;
474 info->compression_type = wim->compression_type;
475 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
476 info->has_integrity_table = wim_has_integrity_table(wim);
477 info->opened_from_file = (wim->filename != NULL);
478 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
479 (wim->hdr.total_parts != 1) ||
480 (wim->filename && taccess(wim->filename, W_OK));
481 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
482 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
483 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
484 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
485 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
486 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
487 info->pipable = wim_is_pipable(wim);
491 /* API function documented in wimlib.h */
493 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
495 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
497 WIMLIB_CHANGE_BOOT_INDEX |
498 WIMLIB_CHANGE_RPFIX_FLAG))
499 return WIMLIB_ERR_INVALID_PARAM;
501 if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
502 info->boot_index > wim->hdr.image_count)
503 return WIMLIB_ERR_INVALID_IMAGE;
505 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
506 if (info->is_marked_readonly)
507 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
509 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
512 if (which & WIMLIB_CHANGE_GUID)
513 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
515 if (which & WIMLIB_CHANGE_BOOT_INDEX)
516 wim->hdr.boot_idx = info->boot_index;
518 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
520 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
522 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
528 set_out_ctype(int ctype, u8 *out_ctype_p)
531 case WIMLIB_COMPRESSION_TYPE_NONE:
532 case WIMLIB_COMPRESSION_TYPE_LZX:
533 case WIMLIB_COMPRESSION_TYPE_XPRESS:
534 case WIMLIB_COMPRESSION_TYPE_LZMS:
535 *out_ctype_p = ctype;
538 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
541 /* API function documented in wimlib.h */
543 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
545 int ret = set_out_ctype(ctype, &wim->out_compression_type);
549 /* Reset the chunk size if it's no longer valid. */
550 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
551 wim->out_chunk_size = wim_default_chunk_size(ctype);
555 /* API function documented in wimlib.h */
557 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
559 int ret = set_out_ctype(ctype, &wim->out_solid_compression_type);
563 /* Reset the chunk size if it's no longer valid. */
564 if (!wim_chunk_size_valid(wim->out_solid_chunk_size, ctype))
565 wim->out_solid_chunk_size = wim_default_solid_chunk_size(ctype);
570 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
572 if (!wim_chunk_size_valid(chunk_size, ctype))
573 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
575 *out_chunk_size_p = chunk_size;
579 /* API function documented in wimlib.h */
581 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
583 if (chunk_size == 0) {
584 wim->out_chunk_size =
585 wim_default_chunk_size(wim->out_compression_type);
589 return set_out_chunk_size(chunk_size,
590 wim->out_compression_type,
591 &wim->out_chunk_size);
594 /* API function documented in wimlib.h */
596 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
598 if (chunk_size == 0) {
599 wim->out_solid_chunk_size =
600 wim_default_solid_chunk_size(wim->out_solid_compression_type);
604 return set_out_chunk_size(chunk_size,
605 wim->out_solid_compression_type,
606 &wim->out_solid_chunk_size);
610 wimlib_register_progress_function(WIMStruct *wim,
611 wimlib_progress_func_t progfunc,
614 wim->progfunc = progfunc;
615 wim->progctx = progctx;
619 open_wim_file(const tchar *filename, struct filedes *fd_ret)
623 raw_fd = topen(filename, O_RDONLY | O_BINARY);
625 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
626 return WIMLIB_ERR_OPEN;
628 filedes_init(fd_ret, raw_fd);
633 * Begins the reading of a WIM file; opens the file and reads its header and
634 * blob table, and optionally checks the integrity.
637 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
641 const tchar *wimfile;
643 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
645 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
646 wim->in_fd.is_pipe = 1;
648 wimfile = wim_filename_or_fd;
649 ret = open_wim_file(wimfile, &wim->in_fd);
653 /* The absolute path to the WIM is requested so that
654 * wimlib_overwrite() still works even if the process changes
655 * its working directory. This actually happens if a WIM is
656 * mounted read-write, since the FUSE thread changes directory
657 * to "/", and it needs to be able to find the WIM file again.
659 * This will break if the full path to the WIM changes in the
660 * intervening time...
662 * Warning: in Windows native builds, realpath() calls the
663 * replacement function in win32_replacements.c.
665 wim->filename = realpath(wimfile, NULL);
666 if (!wim->filename) {
667 ERROR_WITH_ERRNO("Failed to get full path to file "
668 "\"%"TS"\"", wimfile);
670 return WIMLIB_ERR_NOMEM;
672 return WIMLIB_ERR_NO_FILENAME;
676 ret = read_wim_header(wim, &wim->hdr);
680 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
681 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
682 " \"%"TS"\". It may be being changed by another process,\n"
683 " or a process may have crashed while writing the WIM.",
687 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
688 ret = can_modify_wim(wim);
693 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
694 (wim->hdr.total_parts != 1))
695 return WIMLIB_ERR_IS_SPLIT_WIM;
697 /* If the boot index is invalid, print a warning and set it to 0 */
698 if (wim->hdr.boot_idx > wim->hdr.image_count) {
699 WARNING("Ignoring invalid boot index.");
700 wim->hdr.boot_idx = 0;
703 /* Check and cache the compression type */
704 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
705 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
706 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
707 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
708 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
709 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
710 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
711 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
713 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
716 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
718 wim->out_compression_type = wim->compression_type;
720 /* Check and cache the chunk size. */
721 wim->chunk_size = wim->hdr.chunk_size;
722 wim->out_chunk_size = wim->chunk_size;
723 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
724 ERROR("Invalid chunk size (%"PRIu32" bytes) "
725 "for compression type %"TS"!", wim->chunk_size,
726 wimlib_get_compression_type_string(wim->compression_type));
727 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
730 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
731 ret = check_wim_integrity(wim);
732 if (ret == WIM_INTEGRITY_NONEXISTENT) {
733 WARNING("\"%"TS"\" does not contain integrity "
734 "information. Skipping integrity check.",
736 } else if (ret == WIM_INTEGRITY_NOT_OK) {
737 return WIMLIB_ERR_INTEGRITY;
738 } else if (ret != WIM_INTEGRITY_OK) {
743 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
744 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
745 if (!wim->image_metadata)
746 return WIMLIB_ERR_NOMEM;
749 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
750 wim->blob_table = new_blob_table(9001);
751 if (!wim->blob_table)
752 return WIMLIB_ERR_NOMEM;
755 ret = read_wim_xml_data(wim);
759 xml_num_images = wim_info_get_num_images(wim->wim_info);
760 if (xml_num_images != wim->hdr.image_count) {
761 ERROR("The WIM's header is inconsistent with its XML data.\n"
762 " Please submit a bug report if you believe this "
763 "WIM file should be considered valid.");
764 return WIMLIB_ERR_IMAGE_COUNT;
767 ret = read_blob_table(wim);
775 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
777 wimlib_progress_func_t progfunc, void *progctx)
782 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
786 wim = new_wim_struct();
788 return WIMLIB_ERR_NOMEM;
790 wim->progfunc = progfunc;
791 wim->progctx = progctx;
793 ret = begin_read(wim, wim_filename_or_fd, open_flags);
803 /* API function documented in wimlib.h */
805 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
807 wimlib_progress_func_t progfunc, void *progctx)
809 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
810 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
811 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
812 return WIMLIB_ERR_INVALID_PARAM;
814 if (!wimfile || !*wimfile || !wim_ret)
815 return WIMLIB_ERR_INVALID_PARAM;
817 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
821 /* API function documented in wimlib.h */
823 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
825 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
829 /* Checksum all blobs that are unhashed (other than the metadata blobs), merging
830 * them into the blob table as needed. This is a no-op unless files have been
831 * added to an image in the same WIMStruct. */
833 wim_checksum_unhashed_blobs(WIMStruct *wim)
837 if (!wim_has_metadata(wim))
839 for (int i = 0; i < wim->hdr.image_count; i++) {
840 struct blob_descriptor *blob, *tmp;
841 struct wim_image_metadata *imd = wim->image_metadata[i];
842 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
843 struct blob_descriptor *new_blob;
844 ret = hash_unhashed_blob(blob, wim->blob_table, &new_blob);
847 if (new_blob != blob)
848 free_blob_descriptor(blob);
855 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
856 * it meets the following three conditions:
858 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
859 * 2. The WIM is not part of a spanned set.
860 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
862 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
865 can_modify_wim(WIMStruct *wim)
868 if (taccess(wim->filename, W_OK)) {
869 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
870 return WIMLIB_ERR_WIM_IS_READONLY;
873 if (wim->hdr.total_parts != 1) {
874 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
876 return WIMLIB_ERR_WIM_IS_READONLY;
878 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
879 ERROR("Cannot modify \"%"TS"\": is marked read-only",
881 return WIMLIB_ERR_WIM_IS_READONLY;
886 /* API function documented in wimlib.h */
888 wimlib_free(WIMStruct *wim)
893 while (!list_empty(&wim->subwims)) {
896 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
897 list_del(&subwim->subwim_node);
901 if (filedes_valid(&wim->in_fd))
902 filedes_close(&wim->in_fd);
903 if (filedes_valid(&wim->out_fd))
904 filedes_close(&wim->out_fd);
906 free_blob_table(wim->blob_table);
908 wimlib_free_decompressor(wim->decompressor);
911 free_wim_info(wim->wim_info);
912 if (wim->image_metadata) {
913 for (unsigned i = 0; i < wim->hdr.image_count; i++)
914 put_image_metadata(wim->image_metadata[i], NULL);
915 FREE(wim->image_metadata);
921 test_locale_ctype_utf8(void)
926 char *ctype = nl_langinfo(CODESET);
928 return (!strstr(ctype, "UTF-8") ||
929 !strstr(ctype, "UTF8") ||
930 !strstr(ctype, "utf8") ||
931 !strstr(ctype, "utf-8"));
935 /* API function documented in wimlib.h */
937 wimlib_get_version(void)
939 return (WIMLIB_MAJOR_VERSION << 20) |
940 (WIMLIB_MINOR_VERSION << 10) |
941 WIMLIB_PATCH_VERSION;
944 static bool lib_initialized = false;
945 static pthread_mutex_t lib_initialization_mutex = PTHREAD_MUTEX_INITIALIZER;
947 /* API function documented in wimlib.h */
949 wimlib_global_init(int init_flags)
956 pthread_mutex_lock(&lib_initialization_mutex);
962 #ifdef ENABLE_ERROR_MESSAGES
963 if (!wimlib_error_file)
964 wimlib_error_file = stderr;
967 ret = WIMLIB_ERR_INVALID_PARAM;
968 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
969 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
970 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
971 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
972 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
973 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
976 libxml_global_init();
977 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
978 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
980 if (!wimlib_mbs_is_utf8)
981 libntfs3g_global_init();
985 ret = win32_global_init(init_flags);
991 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
992 default_ignore_case = false;
993 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
994 default_ignore_case = true;
995 lib_initialized = true;
998 pthread_mutex_unlock(&lib_initialization_mutex);
1002 /* API function documented in wimlib.h */
1004 wimlib_global_cleanup(void)
1006 if (!lib_initialized)
1009 pthread_mutex_lock(&lib_initialization_mutex);
1011 if (!lib_initialized)
1014 libxml_global_cleanup();
1015 iconv_global_cleanup();
1017 win32_global_cleanup();
1020 wimlib_set_error_file(NULL);
1021 lib_initialized = false;
1024 pthread_mutex_unlock(&lib_initialization_mutex);