2 * wim.c - Stuff that doesn't fit into any other file
6 * Copyright (C) 2012, 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
28 #include "wimlib/error.h"
29 #include "wimlib/dentry.h"
30 #include "wimlib/encoding.h"
31 #include "wimlib/file_io.h"
32 #include "wimlib/integrity.h"
33 #include "wimlib/lookup_table.h"
34 #include "wimlib/metadata.h"
36 # include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
38 #include "wimlib/security.h"
39 #include "wimlib/wim.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/compressor_ops.h"
42 #include "wimlib/decompressor_ops.h"
43 #include "wimlib/version.h"
46 # include "wimlib/win32.h" /* for realpath() replacement */
52 # include <langinfo.h>
60 wim_default_pack_compression_type(void)
62 return WIMLIB_COMPRESSION_TYPE_LZMS;
66 wim_default_pack_chunk_size(int ctype) {
68 case WIMLIB_COMPRESSION_TYPE_LZMS:
69 return 1U << 26; /* 67108864 */
71 return 1U << 15; /* 32768 */
78 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
80 filedes_invalidate(&wim->in_fd);
81 filedes_invalidate(&wim->out_fd);
82 wim->out_pack_compression_type = wim_default_pack_compression_type();
83 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
84 wim->out_pack_compression_type);
85 INIT_LIST_HEAD(&wim->subwims);
90 /* Determine if the chunk size is valid for the specified compression type. */
92 wim_chunk_size_valid(u32 chunk_size, int ctype)
96 /* Chunk size is meaningless for uncompressed WIMs --- any value is
98 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
101 /* Chunk size must be power of 2. */
104 order = bsr32(chunk_size);
105 if (chunk_size != 1U << order)
124 /* See the documentation for the --chunk-size option of `wimlib-imagex
125 * capture' for information about allowed chunk sizes. */
127 case WIMLIB_COMPRESSION_TYPE_LZX:
128 return order >= 15 && order <= 21;
130 case WIMLIB_COMPRESSION_TYPE_XPRESS:
131 return order >= 12 && order <= 26;
132 case WIMLIB_COMPRESSION_TYPE_LZMS:
133 return order >= 15 && order <= 30;
138 /* Return the default chunk size to use for the specified compression type.
140 * See notes above in wim_chunk_size_valid(). */
142 wim_default_chunk_size(int ctype)
145 case WIMLIB_COMPRESSION_TYPE_LZMS:
146 return 1U << 17; /* 131072 */
148 return 1U << 15; /* 32768 */
153 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
154 * @visitor is called on the WIM once for each image, with each image selected
155 * as the current image in turn. If @image is a certain image, @visitor is
156 * called on the WIM only once, with that image selected.
159 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
166 if (image == WIMLIB_ALL_IMAGES) {
168 end = wim->hdr.image_count;
169 } else if (image >= 1 && image <= wim->hdr.image_count) {
173 return WIMLIB_ERR_INVALID_IMAGE;
175 for (i = start; i <= end; i++) {
176 ret = select_wim_image(wim, i);
186 /* API function documented in wimlib.h */
188 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
191 struct wim_lookup_table *table;
194 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
196 DEBUG("Creating new WIM with %"TS" compression.",
197 wimlib_get_compression_type_string(ctype));
199 /* Allocate the WIMStruct. */
200 wim = new_wim_struct();
202 return WIMLIB_ERR_NOMEM;
204 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
208 table = new_lookup_table(9001);
210 ret = WIMLIB_ERR_NOMEM;
213 wim->lookup_table = table;
215 wim->compression_type = ctype;
216 wim->out_compression_type = ctype;
217 wim->chunk_size = wim->hdr.chunk_size;
218 wim->out_chunk_size = wim->hdr.chunk_size;
227 destroy_image_metadata(struct wim_image_metadata *imd,
228 struct wim_lookup_table *table,
229 bool free_metadata_lte)
231 free_dentry_tree(imd->root_dentry, table);
232 imd->root_dentry = NULL;
233 free_wim_security_data(imd->security_data);
234 imd->security_data = NULL;
236 if (free_metadata_lte) {
237 free_lookup_table_entry(imd->metadata_lte);
238 imd->metadata_lte = NULL;
241 struct wim_lookup_table_entry *lte, *tmp;
242 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
243 free_lookup_table_entry(lte);
245 INIT_LIST_HEAD(&imd->unhashed_streams);
246 INIT_LIST_HEAD(&imd->inode_list);
249 do_ntfs_umount(imd->ntfs_vol);
250 imd->ntfs_vol = NULL;
256 put_image_metadata(struct wim_image_metadata *imd,
257 struct wim_lookup_table *table)
259 if (imd && --imd->refcnt == 0) {
260 destroy_image_metadata(imd, table, true);
265 /* Appends the specified image metadata structure to the array of image metadata
266 * for a WIM, and increments the image count. */
268 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
270 struct wim_image_metadata **imd_array;
272 DEBUG("Reallocating image metadata array for image_count = %u",
273 wim->hdr.image_count + 1);
274 imd_array = REALLOC(wim->image_metadata,
275 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
277 if (imd_array == NULL)
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_streams);
294 DEBUG("Created new image metadata (refcnt=1)");
296 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
301 static struct wim_image_metadata **
302 new_image_metadata_array(unsigned num_images)
304 struct wim_image_metadata **imd_array;
306 DEBUG("Creating new image metadata array for %u images",
309 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
311 if (imd_array == NULL) {
312 ERROR("Failed to allocate memory for %u image metadata structures",
316 for (unsigned i = 0; i < num_images; i++) {
317 imd_array[i] = new_image_metadata();
318 if (imd_array[i] == NULL) {
319 for (unsigned j = 0; j < i; j++)
320 put_image_metadata(imd_array[j], NULL);
330 * Load the metadata for the specified WIM image into memory and set it
331 * as the WIMStruct's currently selected image.
334 * The WIMStruct for the WIM.
336 * The 1-based index of the image in the WIM to select.
338 * On success, 0 will be returned, wim->current_image will be set to
339 * @image, and wim_get_current_image_metadata() can be used to retrieve
340 * metadata information for the image.
342 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
343 * or another error code will be returned.
346 select_wim_image(WIMStruct *wim, int image)
348 struct wim_image_metadata *imd;
351 DEBUG("Selecting image %d", image);
353 if (image == WIMLIB_NO_IMAGE) {
354 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
355 return WIMLIB_ERR_INVALID_IMAGE;
358 if (image == wim->current_image)
361 if (image < 1 || image > wim->hdr.image_count) {
362 ERROR("Cannot select image %d: There are only %u images",
363 image, wim->hdr.image_count);
364 return WIMLIB_ERR_INVALID_IMAGE;
367 if (!wim_has_metadata(wim)) {
368 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
369 if (wim->hdr.part_number != 1)
370 ERROR("Specify the first part of the split WIM instead.");
371 return WIMLIB_ERR_METADATA_NOT_FOUND;
374 /* If a valid image is currently selected, its metadata can be freed if
375 * it has not been modified. */
376 if (wim->current_image != WIMLIB_NO_IMAGE) {
377 imd = wim_get_current_image_metadata(wim);
378 if (!imd->modified) {
379 wimlib_assert(list_empty(&imd->unhashed_streams));
380 DEBUG("Freeing image %u", wim->current_image);
381 destroy_image_metadata(imd, NULL, false);
384 wim->current_image = image;
385 imd = wim_get_current_image_metadata(wim);
386 if (imd->root_dentry || imd->modified) {
389 ret = read_metadata_resource(wim, imd);
391 wim->current_image = WIMLIB_NO_IMAGE;
397 /* API function documented in wimlib.h */
398 WIMLIBAPI const tchar *
399 wimlib_get_compression_type_string(int ctype)
402 case WIMLIB_COMPRESSION_TYPE_NONE:
404 case WIMLIB_COMPRESSION_TYPE_LZX:
406 case WIMLIB_COMPRESSION_TYPE_XPRESS:
408 case WIMLIB_COMPRESSION_TYPE_LZMS:
415 /* API function documented in wimlib.h */
417 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
423 if (!image_name_or_num || !*image_name_or_num)
424 return WIMLIB_NO_IMAGE;
426 if (!tstrcasecmp(image_name_or_num, T("all"))
427 || !tstrcasecmp(image_name_or_num, T("*")))
428 return WIMLIB_ALL_IMAGES;
429 image = tstrtol(image_name_or_num, &p, 10);
430 if (p != image_name_or_num && *p == T('\0') && image > 0) {
431 if (image > wim->hdr.image_count)
432 return WIMLIB_NO_IMAGE;
435 for (i = 1; i <= wim->hdr.image_count; i++) {
436 if (!tstrcmp(image_name_or_num,
437 wimlib_get_image_name(wim, i)))
440 return WIMLIB_NO_IMAGE;
444 /* API function documented in wimlib.h */
446 wimlib_print_available_images(const WIMStruct *wim, int image)
452 if (image == WIMLIB_ALL_IMAGES) {
453 n = tprintf(T("Available Images:\n"));
455 last = wim->hdr.image_count;
456 } else if (image >= 1 && image <= wim->hdr.image_count) {
457 n = tprintf(T("Information for Image %d\n"), image);
461 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
465 for (i = 0; i < n - 1; i++)
468 for (i = first; i <= last; i++)
469 print_image_info(wim->wim_info, i);
472 /* API function documented in wimlib.h */
474 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
476 memset(info, 0, sizeof(struct wimlib_wim_info));
477 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
478 info->image_count = wim->hdr.image_count;
479 info->boot_index = wim->hdr.boot_idx;
480 info->wim_version = wim->hdr.wim_version;
481 info->chunk_size = wim->chunk_size;
482 info->part_number = wim->hdr.part_number;
483 info->total_parts = wim->hdr.total_parts;
484 info->compression_type = wim->compression_type;
485 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
486 info->has_integrity_table = wim_has_integrity_table(wim);
487 info->opened_from_file = (wim->filename != NULL);
488 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
489 (wim->hdr.total_parts != 1) ||
490 (wim->filename && taccess(wim->filename, W_OK));
491 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
492 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
493 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
494 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
495 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
496 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
497 info->pipable = wim_is_pipable(wim);
501 /* API function documented in wimlib.h */
503 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
507 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
509 WIMLIB_CHANGE_BOOT_INDEX |
510 WIMLIB_CHANGE_RPFIX_FLAG))
511 return WIMLIB_ERR_INVALID_PARAM;
513 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
514 if (info->is_marked_readonly)
515 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
517 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
520 if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
523 ret = can_modify_wim(wim);
527 if (which & WIMLIB_CHANGE_GUID)
528 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
530 if (which & WIMLIB_CHANGE_BOOT_INDEX) {
531 if (info->boot_index > wim->hdr.image_count) {
532 ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
534 return WIMLIB_ERR_INVALID_IMAGE;
536 wim->hdr.boot_idx = info->boot_index;
539 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
541 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
543 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
549 set_out_ctype(int ctype, u8 *out_ctype_p)
552 case WIMLIB_COMPRESSION_TYPE_NONE:
553 case WIMLIB_COMPRESSION_TYPE_LZX:
554 case WIMLIB_COMPRESSION_TYPE_XPRESS:
555 case WIMLIB_COMPRESSION_TYPE_LZMS:
556 *out_ctype_p = ctype;
559 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
562 /* API function documented in wimlib.h */
564 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
566 int ret = set_out_ctype(ctype, &wim->out_compression_type);
570 /* Reset the chunk size if it's no longer valid. */
571 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
572 wim->out_chunk_size = wim_default_chunk_size(ctype);
576 /* API function documented in wimlib.h */
578 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
580 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
584 /* Reset the chunk size if it's no longer valid. */
585 if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
586 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
591 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
593 if (!wim_chunk_size_valid(chunk_size, ctype)) {
594 ERROR("Invalid chunk size (%"PRIu32" bytes) "
595 "for compression type %"TS"!",
597 wimlib_get_compression_type_string(ctype));
598 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
601 *out_chunk_size_p = chunk_size;
605 /* API function documented in wimlib.h */
607 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
609 if (chunk_size == 0) {
610 wim->out_chunk_size =
611 wim_default_chunk_size(wim->out_compression_type);
615 return set_out_chunk_size(chunk_size,
616 wim->out_compression_type,
617 &wim->out_chunk_size);
620 /* API function documented in wimlib.h */
622 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
624 if (chunk_size == 0) {
625 wim->out_pack_chunk_size =
626 wim_default_pack_chunk_size(wim->out_pack_compression_type);
630 return set_out_chunk_size(chunk_size,
631 wim->out_pack_compression_type,
632 &wim->out_pack_chunk_size);
636 wimlib_register_progress_function(WIMStruct *wim,
637 wimlib_progress_func_t progfunc,
640 wim->progfunc = progfunc;
641 wim->progctx = progctx;
645 open_wim_file(const tchar *filename, struct filedes *fd_ret)
649 raw_fd = topen(filename, O_RDONLY | O_BINARY);
651 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
652 return WIMLIB_ERR_OPEN;
654 filedes_init(fd_ret, raw_fd);
659 * Begins the reading of a WIM file; opens the file and reads its header and
660 * lookup table, and optionally checks the integrity.
663 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
667 const tchar *wimfile;
669 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
671 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
672 wim->in_fd.is_pipe = 1;
674 wimfile = wim_filename_or_fd;
675 ret = open_wim_file(wimfile, &wim->in_fd);
679 /* The absolute path to the WIM is requested so that
680 * wimlib_overwrite() still works even if the process changes
681 * its working directory. This actually happens if a WIM is
682 * mounted read-write, since the FUSE thread changes directory
683 * to "/", and it needs to be able to find the WIM file again.
685 * This will break if the full path to the WIM changes in the
686 * intervening time...
688 * Warning: in Windows native builds, realpath() calls the
689 * replacement function in win32_replacements.c.
691 wim->filename = realpath(wimfile, NULL);
692 if (wim->filename == NULL) {
693 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
695 return WIMLIB_ERR_NOMEM;
697 return WIMLIB_ERR_OPEN;
701 ret = read_wim_header(wim, &wim->hdr);
705 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
706 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
707 " \"%"TS"\". It may be being changed by another process,\n"
708 " or a process may have crashed while writing the WIM.",
712 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
713 ret = can_modify_wim(wim);
718 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
719 (wim->hdr.total_parts != 1))
720 return WIMLIB_ERR_IS_SPLIT_WIM;
722 DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
724 /* If the boot index is invalid, print a warning and set it to 0 */
725 if (wim->hdr.boot_idx > wim->hdr.image_count) {
726 WARNING("In `%"TS"', image %u is marked as bootable, "
727 "but there are only %u images in the WIM",
728 wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
729 wim->hdr.boot_idx = 0;
732 /* Check and cache the compression type */
733 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
734 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
735 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
736 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
737 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
738 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
739 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
740 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
742 ERROR("The compression flag is set on \"%"TS"\", but "
743 "a flag for a recognized format is not",
745 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
748 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
750 wim->out_compression_type = wim->compression_type;
752 /* Check and cache the chunk size. */
753 wim->chunk_size = wim->hdr.chunk_size;
754 wim->out_chunk_size = wim->chunk_size;
755 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
756 ERROR("Invalid chunk size (%"PRIu32" bytes) "
757 "for compression type %"TS"!",
759 wimlib_get_compression_type_string(wim->compression_type));
760 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
763 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
764 ret = check_wim_integrity(wim);
765 if (ret == WIM_INTEGRITY_NONEXISTENT) {
766 WARNING("No integrity information for `%"TS"'; skipping "
767 "integrity check.", wimfile);
768 } else if (ret == WIM_INTEGRITY_NOT_OK) {
769 ERROR("WIM is not intact! (Failed integrity check)");
770 return WIMLIB_ERR_INTEGRITY;
771 } else if (ret != WIM_INTEGRITY_OK) {
776 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
777 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
778 if (wim->image_metadata == NULL)
779 return WIMLIB_ERR_NOMEM;
782 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
783 wim->lookup_table = new_lookup_table(9001);
784 if (wim->lookup_table == NULL)
785 return WIMLIB_ERR_NOMEM;
788 ret = read_wim_xml_data(wim);
792 xml_num_images = wim_info_get_num_images(wim->wim_info);
793 if (xml_num_images != wim->hdr.image_count) {
794 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
795 "in the XML data,", wimfile, xml_num_images);
796 ERROR("but %u images in the WIM! There must be exactly one "
797 "<IMAGE> element per image.", wim->hdr.image_count);
798 return WIMLIB_ERR_IMAGE_COUNT;
801 ret = read_wim_lookup_table(wim);
805 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
811 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
813 wimlib_progress_func_t progfunc, void *progctx)
818 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
819 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
821 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
823 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
826 return WIMLIB_ERR_INVALID_PARAM;
828 wim = new_wim_struct();
830 return WIMLIB_ERR_NOMEM;
832 wim->progfunc = progfunc;
833 wim->progctx = progctx;
835 ret = begin_read(wim, wim_filename_or_fd, open_flags);
841 DEBUG("Successfully opened WIM and created WIMStruct.");
846 /* API function documented in wimlib.h */
848 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
850 wimlib_progress_func_t progfunc, void *progctx)
852 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
853 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
854 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
855 return WIMLIB_ERR_INVALID_PARAM;
857 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
861 /* API function documented in wimlib.h */
863 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
865 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
869 /* Checksum all streams that are unhashed (other than the metadata streams),
870 * merging them into the lookup table as needed. This is a no-op unless the
871 * library has previously used to add or mount an image using the same
874 wim_checksum_unhashed_streams(WIMStruct *wim)
878 if (!wim_has_metadata(wim))
880 for (int i = 0; i < wim->hdr.image_count; i++) {
881 struct wim_lookup_table_entry *lte, *tmp;
882 struct wim_image_metadata *imd = wim->image_metadata[i];
883 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
884 struct wim_lookup_table_entry *new_lte;
885 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
889 free_lookup_table_entry(lte);
896 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
897 * it meets the following three conditions:
899 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
900 * 2. The WIM is not part of a spanned set.
901 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
903 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
906 can_modify_wim(WIMStruct *wim)
909 if (taccess(wim->filename, W_OK)) {
910 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
911 return WIMLIB_ERR_WIM_IS_READONLY;
914 if (wim->hdr.total_parts != 1) {
915 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
917 return WIMLIB_ERR_WIM_IS_READONLY;
919 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
920 ERROR("Cannot modify \"%"TS"\": is marked read-only",
922 return WIMLIB_ERR_WIM_IS_READONLY;
928 * can_delete_from_wim - Check if files or images can be deleted from a given
931 * This theoretically should be exactly the same as can_modify_wim(), but
932 * unfortunately, due to bugs in Microsoft's software that generate incorrect
933 * reference counts for some WIM resources, we need to run expensive
934 * verifications to make sure the reference counts are correct on all WIM
935 * resources. Otherwise we might delete a WIM resource whose reference count
936 * has fallen to 0, but is actually still referenced somewhere.
939 can_delete_from_wim(WIMStruct *wim)
943 ret = can_modify_wim(wim);
946 if (!wim->refcnts_ok) {
947 ret = wim_recalculate_refcnts(wim);
954 /* API function documented in wimlib.h */
956 wimlib_free(WIMStruct *wim)
961 DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
962 wim->filename, wim->hdr.image_count);
964 while (!list_empty(&wim->subwims)) {
967 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
968 list_del(&subwim->subwim_node);
969 DEBUG("Freeing subwim.");
973 if (filedes_valid(&wim->in_fd))
974 filedes_close(&wim->in_fd);
975 if (filedes_valid(&wim->out_fd))
976 filedes_close(&wim->out_fd);
978 free_lookup_table(wim->lookup_table);
980 wimlib_free_decompressor(wim->decompressor);
983 free_wim_info(wim->wim_info);
984 if (wim->image_metadata) {
985 for (unsigned i = 0; i < wim->hdr.image_count; i++)
986 put_image_metadata(wim->image_metadata[i], NULL);
987 FREE(wim->image_metadata);
993 test_locale_ctype_utf8(void)
998 char *ctype = nl_langinfo(CODESET);
1000 return (!strstr(ctype, "UTF-8") ||
1001 !strstr(ctype, "UTF8") ||
1002 !strstr(ctype, "utf8") ||
1003 !strstr(ctype, "utf-8"));
1007 /* API function documented in wimlib.h */
1009 wimlib_get_version(void)
1011 return WIMLIB_VERSION_CODE;
1014 static bool lib_initialized = false;
1016 /* API function documented in wimlib.h */
1018 wimlib_global_init(int init_flags)
1020 if (lib_initialized)
1023 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
1024 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
1025 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
1026 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
1027 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
1028 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
1029 return WIMLIB_ERR_INVALID_PARAM;
1031 libxml_global_init();
1032 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
1033 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
1035 if (!wimlib_mbs_is_utf8)
1036 libntfs3g_global_init();
1041 int ret = win32_global_init(init_flags);
1046 iconv_global_init();
1048 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
1049 default_ignore_case = false;
1050 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
1051 default_ignore_case = true;
1052 lib_initialized = true;
1056 /* API function documented in wimlib.h */
1058 wimlib_global_cleanup(void)
1060 if (!lib_initialized)
1062 libxml_global_cleanup();
1063 iconv_global_cleanup();
1065 win32_global_cleanup();
1067 cleanup_decompressor_params();
1068 cleanup_compressor_params();
1069 lib_initialized = false;