2 * wim.c - High-level code dealing with WIMStructs and images.
6 * Copyright (C) 2012, 2013, 2014, 2015 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/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 */
53 /* Information about the available compression types for the WIM format. */
58 u32 default_nonsolid_chunk_size;
59 u32 default_solid_chunk_size;
60 } wim_ctype_info[] = {
61 [WIMLIB_COMPRESSION_TYPE_NONE] = {
65 .default_nonsolid_chunk_size = 0,
66 .default_solid_chunk_size = 0,
68 [WIMLIB_COMPRESSION_TYPE_XPRESS] = {
70 .min_chunk_size = 4096,
71 .max_chunk_size = 65536,
72 .default_nonsolid_chunk_size = 32768,
73 .default_solid_chunk_size = 32768,
75 [WIMLIB_COMPRESSION_TYPE_LZX] = {
77 .min_chunk_size = 32768,
78 .max_chunk_size = 2097152,
79 .default_nonsolid_chunk_size = 32768,
80 .default_solid_chunk_size = 32768,
82 [WIMLIB_COMPRESSION_TYPE_LZMS] = {
84 .min_chunk_size = 32768,
85 .max_chunk_size = 1073741824,
86 .default_nonsolid_chunk_size = 131072,
87 .default_solid_chunk_size = 67108864,
91 /* Is the specified compression type valid? */
93 wim_compression_type_valid(enum wimlib_compression_type ctype)
95 return ctype >= 0 && ctype < ARRAY_LEN(wim_ctype_info) &&
96 wim_ctype_info[ctype].name != NULL;
99 /* Is the specified chunk size valid for the compression type? */
101 wim_chunk_size_valid(u32 chunk_size, enum wimlib_compression_type ctype)
103 if (!(chunk_size == 0 || is_power_of_2(chunk_size)))
106 return chunk_size >= wim_ctype_info[ctype].min_chunk_size &&
107 chunk_size <= wim_ctype_info[ctype].max_chunk_size;
110 /* Return the default chunk size to use for the specified compression type in
111 * non-solid resources. */
113 wim_default_nonsolid_chunk_size(enum wimlib_compression_type ctype)
115 return wim_ctype_info[ctype].default_nonsolid_chunk_size;
118 /* Return the default chunk size to use for the specified compression type in
119 * solid resources. */
121 wim_default_solid_chunk_size(enum wimlib_compression_type ctype)
123 return wim_ctype_info[ctype].default_solid_chunk_size;
126 /* Return the default compression type to use in solid resources. */
127 static enum wimlib_compression_type
128 wim_default_solid_compression_type(void)
130 return WIMLIB_COMPRESSION_TYPE_LZMS;
134 is_blob_in_solid_resource(struct blob_descriptor *blob, void *_ignore)
136 return blob->blob_location == BLOB_IN_WIM &&
137 (blob->rdesc->flags & WIM_RESHDR_FLAG_SOLID);
141 wim_has_solid_resources(const WIMStruct *wim)
143 return for_blob_in_table(wim->blob_table, is_blob_in_solid_resource, NULL);
149 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
153 filedes_invalidate(&wim->in_fd);
154 filedes_invalidate(&wim->out_fd);
155 wim->out_solid_compression_type = wim_default_solid_compression_type();
156 wim->out_solid_chunk_size = wim_default_solid_chunk_size(
157 wim->out_solid_compression_type);
158 INIT_LIST_HEAD(&wim->subwims);
162 /* API function documented in wimlib.h */
164 wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret)
169 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
174 return WIMLIB_ERR_INVALID_PARAM;
176 if (!wim_compression_type_valid(ctype))
177 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
179 wim = new_wim_struct();
181 return WIMLIB_ERR_NOMEM;
183 wim->blob_table = new_blob_table(9001);
184 if (!wim->blob_table) {
186 return WIMLIB_ERR_NOMEM;
189 init_wim_header(&wim->hdr, ctype,
190 wim_default_nonsolid_chunk_size(ctype));
191 wim->compression_type = ctype;
192 wim->out_compression_type = ctype;
193 wim->chunk_size = wim->hdr.chunk_size;
194 wim->out_chunk_size = wim->hdr.chunk_size;
201 destroy_image_metadata(struct wim_image_metadata *imd,
202 struct blob_table *table,
203 bool free_metadata_blob_descriptor)
205 free_dentry_tree(imd->root_dentry, table);
206 imd->root_dentry = NULL;
207 free_wim_security_data(imd->security_data);
208 imd->security_data = NULL;
210 if (free_metadata_blob_descriptor) {
211 free_blob_descriptor(imd->metadata_blob);
212 imd->metadata_blob = NULL;
215 struct blob_descriptor *blob, *tmp;
216 list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
217 free_blob_descriptor(blob);
219 INIT_LIST_HEAD(&imd->unhashed_blobs);
220 INIT_HLIST_HEAD(&imd->inode_list);
223 do_ntfs_umount(imd->ntfs_vol);
224 imd->ntfs_vol = NULL;
230 put_image_metadata(struct wim_image_metadata *imd, struct blob_table *table)
232 if (imd && --imd->refcnt == 0) {
233 destroy_image_metadata(imd, table, true);
238 /* Appends the specified image metadata structure to the array of image metadata
239 * for a WIM, and increments the image count. */
241 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
243 struct wim_image_metadata **imd_array;
245 imd_array = REALLOC(wim->image_metadata,
246 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
249 return WIMLIB_ERR_NOMEM;
250 wim->image_metadata = imd_array;
251 imd_array[wim->hdr.image_count++] = imd;
255 struct wim_image_metadata *
256 new_image_metadata(void)
258 struct wim_image_metadata *imd;
260 imd = CALLOC(1, sizeof(*imd));
263 INIT_HLIST_HEAD(&imd->inode_list);
264 INIT_LIST_HEAD(&imd->unhashed_blobs);
269 static struct wim_image_metadata **
270 new_image_metadata_array(unsigned num_images)
272 struct wim_image_metadata **imd_array;
274 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
278 for (unsigned i = 0; i < num_images; i++) {
279 imd_array[i] = new_image_metadata();
280 if (unlikely(!imd_array[i])) {
281 for (unsigned j = 0; j < i; j++)
282 put_image_metadata(imd_array[j], NULL);
292 * Load the metadata for the specified WIM image into memory and set it
293 * as the WIMStruct's currently selected image.
296 * The WIMStruct for the WIM.
298 * The 1-based index of the image in the WIM to select.
300 * On success, 0 will be returned, wim->current_image will be set to
301 * @image, and wim_get_current_image_metadata() can be used to retrieve
302 * metadata information for the image.
304 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
305 * or another error code will be returned.
308 select_wim_image(WIMStruct *wim, int image)
310 struct wim_image_metadata *imd;
313 if (image == WIMLIB_NO_IMAGE)
314 return WIMLIB_ERR_INVALID_IMAGE;
316 if (image == wim->current_image)
319 if (image < 1 || image > wim->hdr.image_count)
320 return WIMLIB_ERR_INVALID_IMAGE;
322 if (!wim_has_metadata(wim))
323 return WIMLIB_ERR_METADATA_NOT_FOUND;
325 /* If a valid image is currently selected, its metadata can be freed if
326 * it has not been modified. */
327 deselect_current_wim_image(wim);
328 wim->current_image = image;
329 imd = wim_get_current_image_metadata(wim);
330 if (imd->root_dentry || imd->modified) {
333 ret = read_metadata_resource(imd);
335 wim->current_image = WIMLIB_NO_IMAGE;
341 deselect_current_wim_image(WIMStruct *wim)
343 struct wim_image_metadata *imd;
344 if (wim->current_image == WIMLIB_NO_IMAGE)
346 imd = wim_get_current_image_metadata(wim);
347 if (!imd->modified) {
348 wimlib_assert(list_empty(&imd->unhashed_blobs));
349 destroy_image_metadata(imd, NULL, false);
351 wim->current_image = WIMLIB_NO_IMAGE;
355 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
356 * @visitor is called on the WIM once for each image, with each image selected
357 * as the current image in turn. If @image is a certain image, @visitor is
358 * called on the WIM only once, with that image selected.
361 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
368 if (image == WIMLIB_ALL_IMAGES) {
370 end = wim->hdr.image_count;
371 } else if (image >= 1 && image <= wim->hdr.image_count) {
375 return WIMLIB_ERR_INVALID_IMAGE;
377 for (i = start; i <= end; i++) {
378 ret = select_wim_image(wim, i);
388 /* API function documented in wimlib.h */
390 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
396 if (!image_name_or_num || !*image_name_or_num)
397 return WIMLIB_NO_IMAGE;
399 if (!tstrcasecmp(image_name_or_num, T("all"))
400 || !tstrcasecmp(image_name_or_num, T("*")))
401 return WIMLIB_ALL_IMAGES;
402 image = tstrtol(image_name_or_num, &p, 10);
403 if (p != image_name_or_num && *p == T('\0') && image > 0) {
404 if (image > wim->hdr.image_count)
405 return WIMLIB_NO_IMAGE;
408 for (i = 1; i <= wim->hdr.image_count; i++) {
409 if (!tstrcmp(image_name_or_num,
410 wimlib_get_image_name(wim, i)))
413 return WIMLIB_NO_IMAGE;
417 /* API function documented in wimlib.h */
419 wimlib_print_available_images(const WIMStruct *wim, int image)
425 if (image == WIMLIB_ALL_IMAGES) {
426 n = tprintf(T("Available Images:\n"));
428 last = wim->hdr.image_count;
429 } else if (image >= 1 && image <= wim->hdr.image_count) {
430 n = tprintf(T("Information for Image %d\n"), image);
434 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
438 for (i = 0; i < n - 1; i++)
441 for (i = first; i <= last; i++)
442 print_image_info(wim->wim_info, i);
445 /* API function documented in wimlib.h */
447 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
449 memset(info, 0, sizeof(struct wimlib_wim_info));
450 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
451 info->image_count = wim->hdr.image_count;
452 info->boot_index = wim->hdr.boot_idx;
453 info->wim_version = wim->hdr.wim_version;
454 info->chunk_size = wim->chunk_size;
455 info->part_number = wim->hdr.part_number;
456 info->total_parts = wim->hdr.total_parts;
457 info->compression_type = wim->compression_type;
458 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
459 info->has_integrity_table = wim_has_integrity_table(wim);
460 info->opened_from_file = (wim->filename != NULL);
461 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
462 (wim->hdr.total_parts != 1) ||
463 (wim->filename && taccess(wim->filename, W_OK));
464 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
465 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
466 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
467 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
468 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
469 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
470 info->pipable = wim_is_pipable(wim);
474 /* API function documented in wimlib.h */
476 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
478 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
480 WIMLIB_CHANGE_BOOT_INDEX |
481 WIMLIB_CHANGE_RPFIX_FLAG))
482 return WIMLIB_ERR_INVALID_PARAM;
484 if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
485 info->boot_index > wim->hdr.image_count)
486 return WIMLIB_ERR_INVALID_IMAGE;
488 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
489 if (info->is_marked_readonly)
490 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
492 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
495 if (which & WIMLIB_CHANGE_GUID)
496 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
498 if (which & WIMLIB_CHANGE_BOOT_INDEX)
499 wim->hdr.boot_idx = info->boot_index;
501 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
503 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
505 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
510 /* API function documented in wimlib.h */
512 wimlib_set_output_compression_type(WIMStruct *wim,
513 enum wimlib_compression_type ctype)
515 if (!wim_compression_type_valid(ctype))
516 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
518 wim->out_compression_type = ctype;
520 /* Reset the chunk size if it's no longer valid. */
521 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
522 wim->out_chunk_size = wim_default_nonsolid_chunk_size(ctype);
526 /* API function documented in wimlib.h */
528 wimlib_set_output_pack_compression_type(WIMStruct *wim,
529 enum wimlib_compression_type ctype)
531 if (!wim_compression_type_valid(ctype))
532 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
534 /* Solid resources can't be uncompressed. */
535 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
536 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
538 wim->out_solid_compression_type = ctype;
540 /* Reset the chunk size if it's no longer valid. */
541 if (!wim_chunk_size_valid(wim->out_solid_chunk_size, ctype))
542 wim->out_solid_chunk_size = wim_default_solid_chunk_size(ctype);
546 /* API function documented in wimlib.h */
548 wimlib_set_output_chunk_size(WIMStruct *wim, u32 chunk_size)
550 if (chunk_size == 0) {
551 wim->out_chunk_size =
552 wim_default_nonsolid_chunk_size(wim->out_compression_type);
556 if (!wim_chunk_size_valid(chunk_size, wim->out_compression_type))
557 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
559 wim->out_chunk_size = chunk_size;
563 /* API function documented in wimlib.h */
565 wimlib_set_output_pack_chunk_size(WIMStruct *wim, u32 chunk_size)
567 if (chunk_size == 0) {
568 wim->out_solid_chunk_size =
569 wim_default_solid_chunk_size(wim->out_solid_compression_type);
573 if (!wim_chunk_size_valid(chunk_size, wim->out_solid_compression_type))
574 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
576 wim->out_solid_chunk_size = chunk_size;
580 /* API function documented in wimlib.h */
581 WIMLIBAPI const tchar *
582 wimlib_get_compression_type_string(enum wimlib_compression_type ctype)
584 if (!wim_compression_type_valid(ctype))
587 return wim_ctype_info[ctype].name;
591 wimlib_register_progress_function(WIMStruct *wim,
592 wimlib_progress_func_t progfunc,
595 wim->progfunc = progfunc;
596 wim->progctx = progctx;
600 open_wim_file(const tchar *filename, struct filedes *fd_ret)
604 raw_fd = topen(filename, O_RDONLY | O_BINARY);
606 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
607 return WIMLIB_ERR_OPEN;
609 filedes_init(fd_ret, raw_fd);
614 * Begins the reading of a WIM file; opens the file and reads its header and
615 * blob table, and optionally checks the integrity.
618 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
622 const tchar *wimfile;
624 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
626 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
627 wim->in_fd.is_pipe = 1;
629 wimfile = wim_filename_or_fd;
630 ret = open_wim_file(wimfile, &wim->in_fd);
634 /* The absolute path to the WIM is requested so that
635 * wimlib_overwrite() still works even if the process changes
636 * its working directory. This actually happens if a WIM is
637 * mounted read-write, since the FUSE thread changes directory
638 * to "/", and it needs to be able to find the WIM file again.
640 * This will break if the full path to the WIM changes in the
641 * intervening time...
643 * Warning: in Windows native builds, realpath() calls the
644 * replacement function in win32_replacements.c.
646 wim->filename = realpath(wimfile, NULL);
647 if (!wim->filename) {
648 ERROR_WITH_ERRNO("Failed to get full path to file "
649 "\"%"TS"\"", wimfile);
651 return WIMLIB_ERR_NOMEM;
653 return WIMLIB_ERR_NO_FILENAME;
657 ret = read_wim_header(wim, &wim->hdr);
661 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
662 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
663 " \"%"TS"\". It may be being changed by another process,\n"
664 " or a process may have crashed while writing the WIM.",
668 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
669 ret = can_modify_wim(wim);
674 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
675 (wim->hdr.total_parts != 1))
676 return WIMLIB_ERR_IS_SPLIT_WIM;
678 /* If the boot index is invalid, print a warning and set it to 0 */
679 if (wim->hdr.boot_idx > wim->hdr.image_count) {
680 WARNING("Ignoring invalid boot index.");
681 wim->hdr.boot_idx = 0;
684 /* Check and cache the compression type */
685 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
686 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
687 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
688 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
689 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
690 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
691 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
692 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
694 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
697 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
699 wim->out_compression_type = wim->compression_type;
701 /* Check and cache the chunk size. */
702 wim->chunk_size = wim->hdr.chunk_size;
703 wim->out_chunk_size = wim->chunk_size;
704 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
705 ERROR("Invalid chunk size (%"PRIu32" bytes) "
706 "for compression type %"TS"!", wim->chunk_size,
707 wimlib_get_compression_type_string(wim->compression_type));
708 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
711 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
712 ret = check_wim_integrity(wim);
713 if (ret == WIM_INTEGRITY_NONEXISTENT) {
714 WARNING("\"%"TS"\" does not contain integrity "
715 "information. Skipping integrity check.",
717 } else if (ret == WIM_INTEGRITY_NOT_OK) {
718 return WIMLIB_ERR_INTEGRITY;
719 } else if (ret != WIM_INTEGRITY_OK) {
724 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
725 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
726 if (!wim->image_metadata)
727 return WIMLIB_ERR_NOMEM;
730 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
731 wim->blob_table = new_blob_table(9001);
732 if (!wim->blob_table)
733 return WIMLIB_ERR_NOMEM;
736 ret = read_wim_xml_data(wim);
740 xml_num_images = wim_info_get_num_images(wim->wim_info);
741 if (xml_num_images != wim->hdr.image_count) {
742 ERROR("The WIM's header is inconsistent with its XML data.\n"
743 " Please submit a bug report if you believe this "
744 "WIM file should be considered valid.");
745 return WIMLIB_ERR_IMAGE_COUNT;
748 ret = read_blob_table(wim);
756 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
758 wimlib_progress_func_t progfunc, void *progctx)
763 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
767 wim = new_wim_struct();
769 return WIMLIB_ERR_NOMEM;
771 wim->progfunc = progfunc;
772 wim->progctx = progctx;
774 ret = begin_read(wim, wim_filename_or_fd, open_flags);
784 /* API function documented in wimlib.h */
786 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
788 wimlib_progress_func_t progfunc, void *progctx)
790 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
791 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
792 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
793 return WIMLIB_ERR_INVALID_PARAM;
795 if (!wimfile || !*wimfile || !wim_ret)
796 return WIMLIB_ERR_INVALID_PARAM;
798 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
802 /* API function documented in wimlib.h */
804 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
806 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
810 /* Checksum all blobs that are unhashed (other than the metadata blobs), merging
811 * them into the blob table as needed. This is a no-op unless files have been
812 * added to an image in the same WIMStruct. */
814 wim_checksum_unhashed_blobs(WIMStruct *wim)
818 if (!wim_has_metadata(wim))
820 for (int i = 0; i < wim->hdr.image_count; i++) {
821 struct blob_descriptor *blob, *tmp;
822 struct wim_image_metadata *imd = wim->image_metadata[i];
823 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
824 struct blob_descriptor *new_blob;
825 ret = hash_unhashed_blob(blob, wim->blob_table, &new_blob);
828 if (new_blob != blob)
829 free_blob_descriptor(blob);
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_blob_table(wim->blob_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_MAJOR_VERSION << 20) |
921 (WIMLIB_MINOR_VERSION << 10) |
922 WIMLIB_PATCH_VERSION;
925 static bool lib_initialized = false;
926 static pthread_mutex_t lib_initialization_mutex = PTHREAD_MUTEX_INITIALIZER;
928 /* API function documented in wimlib.h */
930 wimlib_global_init(int init_flags)
937 pthread_mutex_lock(&lib_initialization_mutex);
942 #ifdef ENABLE_ERROR_MESSAGES
943 if (!wimlib_error_file)
944 wimlib_error_file = stderr;
947 ret = WIMLIB_ERR_INVALID_PARAM;
948 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
949 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
950 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
951 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
952 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
953 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
956 ret = WIMLIB_ERR_INVALID_PARAM;
957 if ((init_flags & (WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
958 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
959 == (WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
960 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
963 libxml_global_init();
964 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
965 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
967 if (!wimlib_mbs_is_utf8)
968 libntfs3g_global_init();
972 ret = win32_global_init(init_flags);
978 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
979 default_ignore_case = false;
980 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
981 default_ignore_case = true;
982 lib_initialized = true;
985 pthread_mutex_unlock(&lib_initialization_mutex);
990 /* API function documented in wimlib.h */
992 wimlib_global_cleanup(void)
994 if (!lib_initialized)
997 pthread_mutex_lock(&lib_initialization_mutex);
999 if (!lib_initialized)
1002 libxml_global_cleanup();
1003 iconv_global_cleanup();
1005 win32_global_cleanup();
1008 wimlib_set_error_file(NULL);
1009 lib_initialized = false;
1012 pthread_mutex_unlock(&lib_initialization_mutex);