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/version.h"
44 # include "wimlib/win32.h" /* for realpath() replacement */
50 # include <langinfo.h>
58 wim_default_pack_compression_type(void)
60 return WIMLIB_COMPRESSION_TYPE_LZMS;
64 wim_default_pack_chunk_size(int ctype) {
66 case WIMLIB_COMPRESSION_TYPE_LZMS:
67 return 1U << 25; /* 33554432 */
69 return 1U << 15; /* 32768 */
76 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
78 filedes_invalidate(&wim->in_fd);
79 filedes_invalidate(&wim->out_fd);
80 wim->out_pack_compression_type = wim_default_pack_compression_type();
81 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
82 wim->out_pack_compression_type);
83 INIT_LIST_HEAD(&wim->subwims);
88 /* Determine if the chunk size is valid for the specified compression type. */
90 wim_chunk_size_valid(u32 chunk_size, int ctype)
94 /* Chunk size is meaningless for uncompressed WIMs --- any value is
96 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
99 /* Chunk size must be power of 2. */
102 order = bsr32(chunk_size);
103 if (chunk_size != 1U << order)
122 /* See the documentation for the --chunk-size option of `wimlib-imagex
123 * capture' for information about allowed chunk sizes. */
125 case WIMLIB_COMPRESSION_TYPE_LZX:
126 return order >= 15 && order <= 21;
127 case WIMLIB_COMPRESSION_TYPE_XPRESS:
128 return order >= 12 && order <= 16;
129 case WIMLIB_COMPRESSION_TYPE_LZMS:
130 return order >= 15 && order <= 30;
135 /* Return the default chunk size to use for the specified compression type.
137 * See notes above in wim_chunk_size_valid(). */
139 wim_default_chunk_size(int ctype)
142 case WIMLIB_COMPRESSION_TYPE_LZMS:
143 return 1U << 17; /* 131072 */
145 return 1U << 15; /* 32768 */
150 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
151 * @visitor is called on the WIM once for each image, with each image selected
152 * as the current image in turn. If @image is a certain image, @visitor is
153 * called on the WIM only once, with that image selected.
156 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
163 if (image == WIMLIB_ALL_IMAGES) {
165 end = wim->hdr.image_count;
166 } else if (image >= 1 && image <= wim->hdr.image_count) {
170 return WIMLIB_ERR_INVALID_IMAGE;
172 for (i = start; i <= end; i++) {
173 ret = select_wim_image(wim, i);
183 /* API function documented in wimlib.h */
185 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
188 struct wim_lookup_table *table;
191 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
193 DEBUG("Creating new WIM with %"TS" compression.",
194 wimlib_get_compression_type_string(ctype));
196 /* Allocate the WIMStruct. */
197 wim = new_wim_struct();
199 return WIMLIB_ERR_NOMEM;
201 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
205 table = new_lookup_table(9001);
207 ret = WIMLIB_ERR_NOMEM;
210 wim->lookup_table = table;
212 wim->compression_type = ctype;
213 wim->out_compression_type = ctype;
214 wim->chunk_size = wim->hdr.chunk_size;
215 wim->out_chunk_size = wim->hdr.chunk_size;
224 destroy_image_metadata(struct wim_image_metadata *imd,
225 struct wim_lookup_table *table,
226 bool free_metadata_lte)
228 free_dentry_tree(imd->root_dentry, table);
229 imd->root_dentry = NULL;
230 free_wim_security_data(imd->security_data);
231 imd->security_data = NULL;
233 if (free_metadata_lte) {
234 free_lookup_table_entry(imd->metadata_lte);
235 imd->metadata_lte = NULL;
238 struct wim_lookup_table_entry *lte, *tmp;
239 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
240 free_lookup_table_entry(lte);
242 INIT_LIST_HEAD(&imd->unhashed_streams);
243 INIT_LIST_HEAD(&imd->inode_list);
246 do_ntfs_umount(imd->ntfs_vol);
247 imd->ntfs_vol = NULL;
253 put_image_metadata(struct wim_image_metadata *imd,
254 struct wim_lookup_table *table)
256 if (imd && --imd->refcnt == 0) {
257 destroy_image_metadata(imd, table, true);
262 /* Appends the specified image metadata structure to the array of image metadata
263 * for a WIM, and increments the image count. */
265 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
267 struct wim_image_metadata **imd_array;
269 DEBUG("Reallocating image metadata array for image_count = %u",
270 wim->hdr.image_count + 1);
271 imd_array = REALLOC(wim->image_metadata,
272 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
274 if (imd_array == NULL)
275 return WIMLIB_ERR_NOMEM;
276 wim->image_metadata = imd_array;
277 imd_array[wim->hdr.image_count++] = imd;
281 struct wim_image_metadata *
282 new_image_metadata(void)
284 struct wim_image_metadata *imd;
286 imd = CALLOC(1, sizeof(*imd));
289 INIT_LIST_HEAD(&imd->inode_list);
290 INIT_LIST_HEAD(&imd->unhashed_streams);
291 DEBUG("Created new image metadata (refcnt=1)");
293 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
298 static struct wim_image_metadata **
299 new_image_metadata_array(unsigned num_images)
301 struct wim_image_metadata **imd_array;
303 DEBUG("Creating new image metadata array for %u images",
306 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
308 if (imd_array == NULL) {
309 ERROR("Failed to allocate memory for %u image metadata structures",
313 for (unsigned i = 0; i < num_images; i++) {
314 imd_array[i] = new_image_metadata();
315 if (imd_array[i] == NULL) {
316 for (unsigned j = 0; j < i; j++)
317 put_image_metadata(imd_array[j], NULL);
327 * Load the metadata for the specified WIM image into memory and set it
328 * as the WIMStruct's currently selected image.
331 * The WIMStruct for the WIM.
333 * The 1-based index of the image in the WIM to select.
335 * On success, 0 will be returned, wim->current_image will be set to
336 * @image, and wim_get_current_image_metadata() can be used to retrieve
337 * metadata information for the image.
339 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
340 * or another error code will be returned.
343 select_wim_image(WIMStruct *wim, int image)
345 struct wim_image_metadata *imd;
348 DEBUG("Selecting image %d", image);
350 if (image == WIMLIB_NO_IMAGE) {
351 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
352 return WIMLIB_ERR_INVALID_IMAGE;
355 if (image == wim->current_image)
358 if (image < 1 || image > wim->hdr.image_count) {
359 ERROR("Cannot select image %d: There are only %u images",
360 image, wim->hdr.image_count);
361 return WIMLIB_ERR_INVALID_IMAGE;
364 if (!wim_has_metadata(wim)) {
365 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
366 if (wim->hdr.part_number != 1)
367 ERROR("Specify the first part of the split WIM instead.");
368 return WIMLIB_ERR_METADATA_NOT_FOUND;
371 /* If a valid image is currently selected, its metadata can be freed if
372 * it has not been modified. */
373 if (wim->current_image != WIMLIB_NO_IMAGE) {
374 imd = wim_get_current_image_metadata(wim);
375 if (!imd->modified) {
376 wimlib_assert(list_empty(&imd->unhashed_streams));
377 DEBUG("Freeing image %u", wim->current_image);
378 destroy_image_metadata(imd, NULL, false);
381 wim->current_image = image;
382 imd = wim_get_current_image_metadata(wim);
383 if (imd->root_dentry || imd->modified) {
386 ret = read_metadata_resource(wim, imd);
388 wim->current_image = WIMLIB_NO_IMAGE;
394 /* API function documented in wimlib.h */
395 WIMLIBAPI const tchar *
396 wimlib_get_compression_type_string(int ctype)
399 case WIMLIB_COMPRESSION_TYPE_NONE:
401 case WIMLIB_COMPRESSION_TYPE_LZX:
403 case WIMLIB_COMPRESSION_TYPE_XPRESS:
405 case WIMLIB_COMPRESSION_TYPE_LZMS:
412 /* API function documented in wimlib.h */
414 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
420 if (!image_name_or_num || !*image_name_or_num)
421 return WIMLIB_NO_IMAGE;
423 if (!tstrcasecmp(image_name_or_num, T("all"))
424 || !tstrcasecmp(image_name_or_num, T("*")))
425 return WIMLIB_ALL_IMAGES;
426 image = tstrtol(image_name_or_num, &p, 10);
427 if (p != image_name_or_num && *p == T('\0') && image > 0) {
428 if (image > wim->hdr.image_count)
429 return WIMLIB_NO_IMAGE;
432 for (i = 1; i <= wim->hdr.image_count; i++) {
433 if (!tstrcmp(image_name_or_num,
434 wimlib_get_image_name(wim, i)))
437 return WIMLIB_NO_IMAGE;
441 /* API function documented in wimlib.h */
443 wimlib_print_available_images(const WIMStruct *wim, int image)
449 if (image == WIMLIB_ALL_IMAGES) {
450 n = tprintf(T("Available Images:\n"));
452 last = wim->hdr.image_count;
453 } else if (image >= 1 && image <= wim->hdr.image_count) {
454 n = tprintf(T("Information for Image %d\n"), image);
458 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
462 for (i = 0; i < n - 1; i++)
465 for (i = first; i <= last; i++)
466 print_image_info(wim->wim_info, i);
469 /* API function documented in wimlib.h */
471 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
473 memset(info, 0, sizeof(struct wimlib_wim_info));
474 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
475 info->image_count = wim->hdr.image_count;
476 info->boot_index = wim->hdr.boot_idx;
477 info->wim_version = wim->hdr.wim_version;
478 info->chunk_size = wim->chunk_size;
479 info->part_number = wim->hdr.part_number;
480 info->total_parts = wim->hdr.total_parts;
481 info->compression_type = wim->compression_type;
482 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
483 info->has_integrity_table = wim_has_integrity_table(wim);
484 info->opened_from_file = (wim->filename != NULL);
485 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
486 (wim->hdr.total_parts != 1) ||
487 (wim->filename && taccess(wim->filename, W_OK));
488 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
489 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
490 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
491 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
492 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
493 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
494 info->pipable = wim_is_pipable(wim);
498 /* API function documented in wimlib.h */
500 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
504 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
506 WIMLIB_CHANGE_BOOT_INDEX |
507 WIMLIB_CHANGE_RPFIX_FLAG))
508 return WIMLIB_ERR_INVALID_PARAM;
510 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
511 if (info->is_marked_readonly)
512 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
514 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
517 if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
520 ret = can_modify_wim(wim);
524 if (which & WIMLIB_CHANGE_GUID)
525 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
527 if (which & WIMLIB_CHANGE_BOOT_INDEX) {
528 if (info->boot_index > wim->hdr.image_count) {
529 ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
531 return WIMLIB_ERR_INVALID_IMAGE;
533 wim->hdr.boot_idx = info->boot_index;
536 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
538 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
540 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
546 set_out_ctype(int ctype, u8 *out_ctype_p)
549 case WIMLIB_COMPRESSION_TYPE_NONE:
550 case WIMLIB_COMPRESSION_TYPE_LZX:
551 case WIMLIB_COMPRESSION_TYPE_XPRESS:
552 case WIMLIB_COMPRESSION_TYPE_LZMS:
553 *out_ctype_p = ctype;
556 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
559 /* API function documented in wimlib.h */
561 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
563 int ret = set_out_ctype(ctype, &wim->out_compression_type);
567 /* Reset the chunk size if it's no longer valid. */
568 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
569 wim->out_chunk_size = wim_default_chunk_size(ctype);
573 /* API function documented in wimlib.h */
575 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
577 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
581 /* Reset the chunk size if it's no longer valid. */
582 if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
583 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
588 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
590 if (!wim_chunk_size_valid(chunk_size, ctype)) {
591 ERROR("Invalid chunk size (%"PRIu32" bytes) "
592 "for compression type %"TS"!",
594 wimlib_get_compression_type_string(ctype));
595 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
598 *out_chunk_size_p = chunk_size;
602 /* API function documented in wimlib.h */
604 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
606 if (chunk_size == 0) {
607 wim->out_chunk_size =
608 wim_default_chunk_size(wim->out_compression_type);
612 return set_out_chunk_size(chunk_size,
613 wim->out_compression_type,
614 &wim->out_chunk_size);
617 /* API function documented in wimlib.h */
619 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
621 if (chunk_size == 0) {
622 wim->out_pack_chunk_size =
623 wim_default_pack_chunk_size(wim->out_pack_compression_type);
627 return set_out_chunk_size(chunk_size,
628 wim->out_pack_compression_type,
629 &wim->out_pack_chunk_size);
633 wimlib_register_progress_function(WIMStruct *wim,
634 wimlib_progress_func_t progfunc,
637 wim->progfunc = progfunc;
638 wim->progctx = progctx;
642 open_wim_file(const tchar *filename, struct filedes *fd_ret)
646 raw_fd = topen(filename, O_RDONLY | O_BINARY);
648 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
649 return WIMLIB_ERR_OPEN;
651 filedes_init(fd_ret, raw_fd);
656 * Begins the reading of a WIM file; opens the file and reads its header and
657 * lookup table, and optionally checks the integrity.
660 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
664 const tchar *wimfile;
666 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
668 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
669 wim->in_fd.is_pipe = 1;
671 wimfile = wim_filename_or_fd;
672 ret = open_wim_file(wimfile, &wim->in_fd);
676 /* The absolute path to the WIM is requested so that
677 * wimlib_overwrite() still works even if the process changes
678 * its working directory. This actually happens if a WIM is
679 * mounted read-write, since the FUSE thread changes directory
680 * to "/", and it needs to be able to find the WIM file again.
682 * This will break if the full path to the WIM changes in the
683 * intervening time...
685 * Warning: in Windows native builds, realpath() calls the
686 * replacement function in win32_replacements.c.
688 wim->filename = realpath(wimfile, NULL);
689 if (wim->filename == NULL) {
690 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
692 return WIMLIB_ERR_NOMEM;
694 return WIMLIB_ERR_OPEN;
698 ret = read_wim_header(wim, &wim->hdr);
702 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
703 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
704 " \"%"TS"\". It may be being changed by another process,\n"
705 " or a process may have crashed while writing the WIM.",
709 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
710 ret = can_modify_wim(wim);
715 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
716 (wim->hdr.total_parts != 1))
717 return WIMLIB_ERR_IS_SPLIT_WIM;
719 DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
721 /* If the boot index is invalid, print a warning and set it to 0 */
722 if (wim->hdr.boot_idx > wim->hdr.image_count) {
723 WARNING("In `%"TS"', image %u is marked as bootable, "
724 "but there are only %u images in the WIM",
725 wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
726 wim->hdr.boot_idx = 0;
729 /* Check and cache the compression type */
730 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
731 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
732 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
733 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
734 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
735 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
736 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
737 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
739 ERROR("The compression flag is set on \"%"TS"\", but "
740 "a flag for a recognized format is not",
742 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
745 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
747 wim->out_compression_type = wim->compression_type;
749 /* Check and cache the chunk size. */
750 wim->chunk_size = wim->hdr.chunk_size;
751 wim->out_chunk_size = wim->chunk_size;
752 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
753 ERROR("Invalid chunk size (%"PRIu32" bytes) "
754 "for compression type %"TS"!",
756 wimlib_get_compression_type_string(wim->compression_type));
757 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
760 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
761 ret = check_wim_integrity(wim);
762 if (ret == WIM_INTEGRITY_NONEXISTENT) {
763 WARNING("No integrity information for `%"TS"'; skipping "
764 "integrity check.", wimfile);
765 } else if (ret == WIM_INTEGRITY_NOT_OK) {
766 ERROR("WIM is not intact! (Failed integrity check)");
767 return WIMLIB_ERR_INTEGRITY;
768 } else if (ret != WIM_INTEGRITY_OK) {
773 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
774 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
775 if (wim->image_metadata == NULL)
776 return WIMLIB_ERR_NOMEM;
779 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
780 wim->lookup_table = new_lookup_table(9001);
781 if (wim->lookup_table == NULL)
782 return WIMLIB_ERR_NOMEM;
785 ret = read_wim_xml_data(wim);
789 xml_num_images = wim_info_get_num_images(wim->wim_info);
790 if (xml_num_images != wim->hdr.image_count) {
791 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
792 "in the XML data,", wimfile, xml_num_images);
793 ERROR("but %u images in the WIM! There must be exactly one "
794 "<IMAGE> element per image.", wim->hdr.image_count);
795 return WIMLIB_ERR_IMAGE_COUNT;
798 ret = read_wim_lookup_table(wim);
802 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
808 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
810 wimlib_progress_func_t progfunc, void *progctx)
815 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
816 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
818 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
820 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
823 return WIMLIB_ERR_INVALID_PARAM;
825 wim = new_wim_struct();
827 return WIMLIB_ERR_NOMEM;
829 wim->progfunc = progfunc;
830 wim->progctx = progctx;
832 ret = begin_read(wim, wim_filename_or_fd, open_flags);
838 DEBUG("Successfully opened WIM and created WIMStruct.");
843 /* API function documented in wimlib.h */
845 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
847 wimlib_progress_func_t progfunc, void *progctx)
849 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
850 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
851 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
852 return WIMLIB_ERR_INVALID_PARAM;
854 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
858 /* API function documented in wimlib.h */
860 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
862 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
866 /* Checksum all streams that are unhashed (other than the metadata streams),
867 * merging them into the lookup table as needed. This is a no-op unless the
868 * library has previously used to add or mount an image using the same
871 wim_checksum_unhashed_streams(WIMStruct *wim)
875 if (!wim_has_metadata(wim))
877 for (int i = 0; i < wim->hdr.image_count; i++) {
878 struct wim_lookup_table_entry *lte, *tmp;
879 struct wim_image_metadata *imd = wim->image_metadata[i];
880 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
881 struct wim_lookup_table_entry *new_lte;
882 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
886 free_lookup_table_entry(lte);
893 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
894 * it meets the following three conditions:
896 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
897 * 2. The WIM is not part of a spanned set.
898 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
900 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
903 can_modify_wim(WIMStruct *wim)
906 if (taccess(wim->filename, W_OK)) {
907 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
908 return WIMLIB_ERR_WIM_IS_READONLY;
911 if (wim->hdr.total_parts != 1) {
912 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
914 return WIMLIB_ERR_WIM_IS_READONLY;
916 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
917 ERROR("Cannot modify \"%"TS"\": is marked read-only",
919 return WIMLIB_ERR_WIM_IS_READONLY;
925 * can_delete_from_wim - Check if files or images can be deleted from a given
928 * This theoretically should be exactly the same as can_modify_wim(), but
929 * unfortunately, due to bugs in Microsoft's software that generate incorrect
930 * reference counts for some WIM resources, we need to run expensive
931 * verifications to make sure the reference counts are correct on all WIM
932 * resources. Otherwise we might delete a WIM resource whose reference count
933 * has fallen to 0, but is actually still referenced somewhere.
936 can_delete_from_wim(WIMStruct *wim)
940 ret = can_modify_wim(wim);
943 if (!wim->refcnts_ok) {
944 ret = wim_recalculate_refcnts(wim);
951 /* API function documented in wimlib.h */
953 wimlib_free(WIMStruct *wim)
958 DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
959 wim->filename, wim->hdr.image_count);
961 while (!list_empty(&wim->subwims)) {
964 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
965 list_del(&subwim->subwim_node);
966 DEBUG("Freeing subwim.");
970 if (filedes_valid(&wim->in_fd))
971 filedes_close(&wim->in_fd);
972 if (filedes_valid(&wim->out_fd))
973 filedes_close(&wim->out_fd);
975 free_lookup_table(wim->lookup_table);
977 wimlib_free_decompressor(wim->decompressor);
980 free_wim_info(wim->wim_info);
981 if (wim->image_metadata) {
982 for (unsigned i = 0; i < wim->hdr.image_count; i++)
983 put_image_metadata(wim->image_metadata[i], NULL);
984 FREE(wim->image_metadata);
990 test_locale_ctype_utf8(void)
995 char *ctype = nl_langinfo(CODESET);
997 return (!strstr(ctype, "UTF-8") ||
998 !strstr(ctype, "UTF8") ||
999 !strstr(ctype, "utf8") ||
1000 !strstr(ctype, "utf-8"));
1004 /* API function documented in wimlib.h */
1006 wimlib_get_version(void)
1008 return WIMLIB_VERSION_CODE;
1011 static bool lib_initialized = false;
1013 /* API function documented in wimlib.h */
1015 wimlib_global_init(int init_flags)
1017 if (lib_initialized)
1020 #ifdef ENABLE_ERROR_MESSAGES
1021 if (wimlib_error_file == NULL)
1022 wimlib_error_file = stderr;
1025 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
1026 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
1027 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
1028 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
1029 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
1030 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
1031 return WIMLIB_ERR_INVALID_PARAM;
1033 libxml_global_init();
1034 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
1035 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
1037 if (!wimlib_mbs_is_utf8)
1038 libntfs3g_global_init();
1043 int ret = win32_global_init(init_flags);
1048 iconv_global_init();
1050 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
1051 default_ignore_case = false;
1052 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
1053 default_ignore_case = true;
1054 lib_initialized = true;
1058 /* API function documented in wimlib.h */
1060 wimlib_global_cleanup(void)
1062 if (!lib_initialized)
1064 libxml_global_cleanup();
1065 iconv_global_cleanup();
1067 win32_global_cleanup();
1070 wimlib_set_error_file(NULL);
1071 lib_initialized = false;