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 /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible.
71 return 1U << 25; /* 33554432 */
73 return 1U << 15; /* 32768 */
80 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
82 filedes_invalidate(&wim->in_fd);
83 filedes_invalidate(&wim->out_fd);
84 wim->out_pack_compression_type = wim_default_pack_compression_type();
85 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
86 wim->out_pack_compression_type);
87 INIT_LIST_HEAD(&wim->subwims);
92 /* Determine if the chunk size is valid for the specified compression type. */
94 wim_chunk_size_valid(u32 chunk_size, int ctype)
98 /* Chunk size is meaningless for uncompressed WIMs --- any value is
100 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
103 /* Chunk size must be power of 2. */
106 order = bsr32(chunk_size);
107 if (chunk_size != 1U << order)
126 /* See the documentation for the --chunk-size option of `wimlib-imagex
127 * capture' for information about allowed chunk sizes. */
129 case WIMLIB_COMPRESSION_TYPE_LZX:
130 return order >= 15 && order <= 21;
132 case WIMLIB_COMPRESSION_TYPE_XPRESS:
133 return order >= 12 && order <= 26;
134 case WIMLIB_COMPRESSION_TYPE_LZMS:
135 return order >= 15 && order <= 30;
140 /* Return the default chunk size to use for the specified compression type.
142 * See notes above in wim_chunk_size_valid(). */
144 wim_default_chunk_size(int ctype)
147 case WIMLIB_COMPRESSION_TYPE_LZMS:
148 return 1U << 17; /* 131072 */
150 return 1U << 15; /* 32768 */
155 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
156 * @visitor is called on the WIM once for each image, with each image selected
157 * as the current image in turn. If @image is a certain image, @visitor is
158 * called on the WIM only once, with that image selected.
161 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
168 if (image == WIMLIB_ALL_IMAGES) {
170 end = wim->hdr.image_count;
171 } else if (image >= 1 && image <= wim->hdr.image_count) {
175 return WIMLIB_ERR_INVALID_IMAGE;
177 for (i = start; i <= end; i++) {
178 ret = select_wim_image(wim, i);
188 /* API function documented in wimlib.h */
190 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
193 struct wim_lookup_table *table;
196 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
198 DEBUG("Creating new WIM with %"TS" compression.",
199 wimlib_get_compression_type_string(ctype));
201 /* Allocate the WIMStruct. */
202 wim = new_wim_struct();
204 return WIMLIB_ERR_NOMEM;
206 ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
210 table = new_lookup_table(9001);
212 ret = WIMLIB_ERR_NOMEM;
215 wim->lookup_table = table;
217 wim->compression_type = ctype;
218 wim->out_compression_type = ctype;
219 wim->chunk_size = wim->hdr.chunk_size;
220 wim->out_chunk_size = wim->hdr.chunk_size;
229 destroy_image_metadata(struct wim_image_metadata *imd,
230 struct wim_lookup_table *table,
231 bool free_metadata_lte)
233 free_dentry_tree(imd->root_dentry, table);
234 imd->root_dentry = NULL;
235 free_wim_security_data(imd->security_data);
236 imd->security_data = NULL;
238 if (free_metadata_lte) {
239 free_lookup_table_entry(imd->metadata_lte);
240 imd->metadata_lte = NULL;
243 struct wim_lookup_table_entry *lte, *tmp;
244 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
245 free_lookup_table_entry(lte);
247 INIT_LIST_HEAD(&imd->unhashed_streams);
248 INIT_LIST_HEAD(&imd->inode_list);
251 do_ntfs_umount(imd->ntfs_vol);
252 imd->ntfs_vol = NULL;
258 put_image_metadata(struct wim_image_metadata *imd,
259 struct wim_lookup_table *table)
261 if (imd && --imd->refcnt == 0) {
262 destroy_image_metadata(imd, table, true);
267 /* Appends the specified image metadata structure to the array of image metadata
268 * for a WIM, and increments the image count. */
270 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
272 struct wim_image_metadata **imd_array;
274 DEBUG("Reallocating image metadata array for image_count = %u",
275 wim->hdr.image_count + 1);
276 imd_array = REALLOC(wim->image_metadata,
277 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
279 if (imd_array == NULL)
280 return WIMLIB_ERR_NOMEM;
281 wim->image_metadata = imd_array;
282 imd_array[wim->hdr.image_count++] = imd;
286 struct wim_image_metadata *
287 new_image_metadata(void)
289 struct wim_image_metadata *imd;
291 imd = CALLOC(1, sizeof(*imd));
294 INIT_LIST_HEAD(&imd->inode_list);
295 INIT_LIST_HEAD(&imd->unhashed_streams);
296 DEBUG("Created new image metadata (refcnt=1)");
298 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
303 static struct wim_image_metadata **
304 new_image_metadata_array(unsigned num_images)
306 struct wim_image_metadata **imd_array;
308 DEBUG("Creating new image metadata array for %u images",
311 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
313 if (imd_array == NULL) {
314 ERROR("Failed to allocate memory for %u image metadata structures",
318 for (unsigned i = 0; i < num_images; i++) {
319 imd_array[i] = new_image_metadata();
320 if (imd_array[i] == NULL) {
321 for (unsigned j = 0; j < i; j++)
322 put_image_metadata(imd_array[j], NULL);
332 * Load the metadata for the specified WIM image into memory and set it
333 * as the WIMStruct's currently selected image.
336 * The WIMStruct for the WIM.
338 * The 1-based index of the image in the WIM to select.
340 * On success, 0 will be returned, wim->current_image will be set to
341 * @image, and wim_get_current_image_metadata() can be used to retrieve
342 * metadata information for the image.
344 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
345 * or another error code will be returned.
348 select_wim_image(WIMStruct *wim, int image)
350 struct wim_image_metadata *imd;
353 DEBUG("Selecting image %d", image);
355 if (image == WIMLIB_NO_IMAGE) {
356 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
357 return WIMLIB_ERR_INVALID_IMAGE;
360 if (image == wim->current_image)
363 if (image < 1 || image > wim->hdr.image_count) {
364 ERROR("Cannot select image %d: There are only %u images",
365 image, wim->hdr.image_count);
366 return WIMLIB_ERR_INVALID_IMAGE;
369 if (!wim_has_metadata(wim)) {
370 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
371 if (wim->hdr.part_number != 1)
372 ERROR("Specify the first part of the split WIM instead.");
373 return WIMLIB_ERR_METADATA_NOT_FOUND;
376 /* If a valid image is currently selected, its metadata can be freed if
377 * it has not been modified. */
378 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_streams));
382 DEBUG("Freeing image %u", wim->current_image);
383 destroy_image_metadata(imd, NULL, false);
386 wim->current_image = image;
387 imd = wim_get_current_image_metadata(wim);
388 if (imd->root_dentry || imd->modified) {
391 ret = read_metadata_resource(wim, imd);
393 wim->current_image = WIMLIB_NO_IMAGE;
399 /* API function documented in wimlib.h */
400 WIMLIBAPI const tchar *
401 wimlib_get_compression_type_string(int ctype)
404 case WIMLIB_COMPRESSION_TYPE_NONE:
406 case WIMLIB_COMPRESSION_TYPE_LZX:
408 case WIMLIB_COMPRESSION_TYPE_XPRESS:
410 case WIMLIB_COMPRESSION_TYPE_LZMS:
417 /* API function documented in wimlib.h */
419 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
425 if (!image_name_or_num || !*image_name_or_num)
426 return WIMLIB_NO_IMAGE;
428 if (!tstrcasecmp(image_name_or_num, T("all"))
429 || !tstrcasecmp(image_name_or_num, T("*")))
430 return WIMLIB_ALL_IMAGES;
431 image = tstrtol(image_name_or_num, &p, 10);
432 if (p != image_name_or_num && *p == T('\0') && image > 0) {
433 if (image > wim->hdr.image_count)
434 return WIMLIB_NO_IMAGE;
437 for (i = 1; i <= wim->hdr.image_count; i++) {
438 if (!tstrcmp(image_name_or_num,
439 wimlib_get_image_name(wim, i)))
442 return WIMLIB_NO_IMAGE;
446 /* API function documented in wimlib.h */
448 wimlib_print_available_images(const WIMStruct *wim, int image)
454 if (image == WIMLIB_ALL_IMAGES) {
455 n = tprintf(T("Available Images:\n"));
457 last = wim->hdr.image_count;
458 } else if (image >= 1 && image <= wim->hdr.image_count) {
459 n = tprintf(T("Information for Image %d\n"), image);
463 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
467 for (i = 0; i < n - 1; i++)
470 for (i = first; i <= last; i++)
471 print_image_info(wim->wim_info, i);
474 /* API function documented in wimlib.h */
476 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
478 memset(info, 0, sizeof(struct wimlib_wim_info));
479 memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
480 info->image_count = wim->hdr.image_count;
481 info->boot_index = wim->hdr.boot_idx;
482 info->wim_version = wim->hdr.wim_version;
483 info->chunk_size = wim->chunk_size;
484 info->part_number = wim->hdr.part_number;
485 info->total_parts = wim->hdr.total_parts;
486 info->compression_type = wim->compression_type;
487 info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
488 info->has_integrity_table = wim_has_integrity_table(wim);
489 info->opened_from_file = (wim->filename != NULL);
490 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
491 (wim->hdr.total_parts != 1) ||
492 (wim->filename && taccess(wim->filename, W_OK));
493 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
494 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
495 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
496 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
497 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
498 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
499 info->pipable = wim_is_pipable(wim);
503 /* API function documented in wimlib.h */
505 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
509 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
511 WIMLIB_CHANGE_BOOT_INDEX |
512 WIMLIB_CHANGE_RPFIX_FLAG))
513 return WIMLIB_ERR_INVALID_PARAM;
515 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
516 if (info->is_marked_readonly)
517 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
519 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
522 if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
525 ret = can_modify_wim(wim);
529 if (which & WIMLIB_CHANGE_GUID)
530 memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
532 if (which & WIMLIB_CHANGE_BOOT_INDEX) {
533 if (info->boot_index > wim->hdr.image_count) {
534 ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
536 return WIMLIB_ERR_INVALID_IMAGE;
538 wim->hdr.boot_idx = info->boot_index;
541 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
543 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
545 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
551 set_out_ctype(int ctype, u8 *out_ctype_p)
554 case WIMLIB_COMPRESSION_TYPE_INVALID:
556 case WIMLIB_COMPRESSION_TYPE_NONE:
557 case WIMLIB_COMPRESSION_TYPE_LZX:
558 case WIMLIB_COMPRESSION_TYPE_XPRESS:
559 case WIMLIB_COMPRESSION_TYPE_LZMS:
560 *out_ctype_p = ctype;
563 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
566 /* API function documented in wimlib.h */
568 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
570 int ret = set_out_ctype(ctype, &wim->out_compression_type);
574 /* Reset the chunk size if it's no longer valid. */
575 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
576 wim->out_chunk_size = wim_default_chunk_size(ctype);
580 /* API function documented in wimlib.h */
582 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
584 int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
588 /* Reset the chunk size if it's no longer valid. */
589 if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
590 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
595 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
597 if (!wim_chunk_size_valid(chunk_size, ctype)) {
598 ERROR("Invalid chunk size (%"PRIu32" bytes) "
599 "for compression type %"TS"!",
601 wimlib_get_compression_type_string(ctype));
602 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
605 *out_chunk_size_p = chunk_size;
609 /* API function documented in wimlib.h */
611 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
613 if (chunk_size == 0) {
614 wim->out_chunk_size =
615 wim_default_chunk_size(wim->out_compression_type);
619 return set_out_chunk_size(chunk_size,
620 wim->out_compression_type,
621 &wim->out_chunk_size);
624 /* API function documented in wimlib.h */
626 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
628 if (chunk_size == 0) {
629 wim->out_pack_chunk_size =
630 wim_default_pack_chunk_size(wim->out_pack_compression_type);
634 return set_out_chunk_size(chunk_size,
635 wim->out_pack_compression_type,
636 &wim->out_pack_chunk_size);
640 wimlib_register_progress_function(WIMStruct *wim,
641 wimlib_progress_func_t progfunc,
644 wim->progfunc = progfunc;
645 wim->progctx = progctx;
649 open_wim_file(const tchar *filename, struct filedes *fd_ret)
653 raw_fd = topen(filename, O_RDONLY | O_BINARY);
655 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
656 return WIMLIB_ERR_OPEN;
658 filedes_init(fd_ret, raw_fd);
663 * Begins the reading of a WIM file; opens the file and reads its header and
664 * lookup table, and optionally checks the integrity.
667 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
671 const tchar *wimfile;
673 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
675 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
676 wim->in_fd.is_pipe = 1;
678 wimfile = wim_filename_or_fd;
679 ret = open_wim_file(wimfile, &wim->in_fd);
683 /* The absolute path to the WIM is requested so that
684 * wimlib_overwrite() still works even if the process changes
685 * its working directory. This actually happens if a WIM is
686 * mounted read-write, since the FUSE thread changes directory
687 * to "/", and it needs to be able to find the WIM file again.
689 * This will break if the full path to the WIM changes in the
690 * intervening time...
692 * Warning: in Windows native builds, realpath() calls the
693 * replacement function in win32_replacements.c.
695 wim->filename = realpath(wimfile, NULL);
696 if (wim->filename == NULL) {
697 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
699 return WIMLIB_ERR_NOMEM;
701 return WIMLIB_ERR_OPEN;
705 ret = read_wim_header(wim, &wim->hdr);
709 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
710 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
711 " \"%"TS"\". It may be being changed by another process,\n"
712 " or a process may have crashed while writing the WIM.",
716 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
717 ret = can_modify_wim(wim);
722 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
723 (wim->hdr.total_parts != 1))
724 return WIMLIB_ERR_IS_SPLIT_WIM;
726 DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
728 /* If the boot index is invalid, print a warning and set it to 0 */
729 if (wim->hdr.boot_idx > wim->hdr.image_count) {
730 WARNING("In `%"TS"', image %u is marked as bootable, "
731 "but there are only %u images in the WIM",
732 wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
733 wim->hdr.boot_idx = 0;
736 /* Check and cache the compression type */
737 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
738 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
739 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
740 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
741 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
742 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
743 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
744 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
746 ERROR("The compression flag is set on \"%"TS"\", but "
747 "a flag for a recognized format is not",
749 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
752 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
754 wim->out_compression_type = wim->compression_type;
756 /* Check and cache the chunk size. */
757 wim->chunk_size = wim->hdr.chunk_size;
758 wim->out_chunk_size = wim->chunk_size;
759 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
760 ERROR("Invalid chunk size (%"PRIu32" bytes) "
761 "for compression type %"TS"!",
763 wimlib_get_compression_type_string(wim->compression_type));
764 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
767 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
768 ret = check_wim_integrity(wim);
769 if (ret == WIM_INTEGRITY_NONEXISTENT) {
770 WARNING("No integrity information for `%"TS"'; skipping "
771 "integrity check.", wimfile);
772 } else if (ret == WIM_INTEGRITY_NOT_OK) {
773 ERROR("WIM is not intact! (Failed integrity check)");
774 return WIMLIB_ERR_INTEGRITY;
775 } else if (ret != WIM_INTEGRITY_OK) {
780 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
781 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
782 if (wim->image_metadata == NULL)
783 return WIMLIB_ERR_NOMEM;
786 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
787 wim->lookup_table = new_lookup_table(9001);
788 if (wim->lookup_table == NULL)
789 return WIMLIB_ERR_NOMEM;
792 ret = read_wim_xml_data(wim);
796 xml_num_images = wim_info_get_num_images(wim->wim_info);
797 if (xml_num_images != wim->hdr.image_count) {
798 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
799 "in the XML data,", wimfile, xml_num_images);
800 ERROR("but %u images in the WIM! There must be exactly one "
801 "<IMAGE> element per image.", wim->hdr.image_count);
802 return WIMLIB_ERR_IMAGE_COUNT;
805 ret = read_wim_lookup_table(wim);
809 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
815 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
817 wimlib_progress_func_t progfunc, void *progctx)
822 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
823 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
825 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
827 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
830 return WIMLIB_ERR_INVALID_PARAM;
832 wim = new_wim_struct();
834 return WIMLIB_ERR_NOMEM;
836 wim->progfunc = progfunc;
837 wim->progctx = progctx;
839 ret = begin_read(wim, wim_filename_or_fd, open_flags);
845 DEBUG("Successfully opened WIM and created WIMStruct.");
850 /* API function documented in wimlib.h */
852 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
854 wimlib_progress_func_t progfunc, void *progctx)
856 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
857 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
858 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
859 return WIMLIB_ERR_INVALID_PARAM;
861 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
865 /* API function documented in wimlib.h */
867 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
869 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
873 /* Checksum all streams that are unhashed (other than the metadata streams),
874 * merging them into the lookup table as needed. This is a no-op unless the
875 * library has previously used to add or mount an image using the same
878 wim_checksum_unhashed_streams(WIMStruct *wim)
882 if (!wim_has_metadata(wim))
884 for (int i = 0; i < wim->hdr.image_count; i++) {
885 struct wim_lookup_table_entry *lte, *tmp;
886 struct wim_image_metadata *imd = wim->image_metadata[i];
887 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
888 struct wim_lookup_table_entry *new_lte;
889 ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
893 free_lookup_table_entry(lte);
900 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
901 * it meets the following three conditions:
903 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
904 * 2. The WIM is not part of a spanned set.
905 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
907 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
910 can_modify_wim(WIMStruct *wim)
913 if (taccess(wim->filename, W_OK)) {
914 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
915 return WIMLIB_ERR_WIM_IS_READONLY;
918 if (wim->hdr.total_parts != 1) {
919 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
921 return WIMLIB_ERR_WIM_IS_READONLY;
923 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
924 ERROR("Cannot modify \"%"TS"\": is marked read-only",
926 return WIMLIB_ERR_WIM_IS_READONLY;
932 * can_delete_from_wim - Check if files or images can be deleted from a given
935 * This theoretically should be exactly the same as can_modify_wim(), but
936 * unfortunately, due to bugs in Microsoft's software that generate incorrect
937 * reference counts for some WIM resources, we need to run expensive
938 * verifications to make sure the reference counts are correct on all WIM
939 * resources. Otherwise we might delete a WIM resource whose reference count
940 * has fallen to 0, but is actually still referenced somewhere.
943 can_delete_from_wim(WIMStruct *wim)
947 ret = can_modify_wim(wim);
950 if (!wim->refcnts_ok) {
951 ret = wim_recalculate_refcnts(wim);
958 /* API function documented in wimlib.h */
960 wimlib_free(WIMStruct *wim)
965 DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
966 wim->filename, wim->hdr.image_count);
968 while (!list_empty(&wim->subwims)) {
971 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
972 list_del(&subwim->subwim_node);
973 DEBUG("Freeing subwim.");
977 if (filedes_valid(&wim->in_fd))
978 filedes_close(&wim->in_fd);
979 if (filedes_valid(&wim->out_fd))
980 filedes_close(&wim->out_fd);
982 free_lookup_table(wim->lookup_table);
984 wimlib_free_decompressor(wim->decompressor);
987 free_wim_info(wim->wim_info);
988 if (wim->image_metadata) {
989 for (unsigned i = 0; i < wim->hdr.image_count; i++)
990 put_image_metadata(wim->image_metadata[i], NULL);
991 FREE(wim->image_metadata);
997 test_locale_ctype_utf8(void)
1002 char *ctype = nl_langinfo(CODESET);
1004 return (!strstr(ctype, "UTF-8") ||
1005 !strstr(ctype, "UTF8") ||
1006 !strstr(ctype, "utf8") ||
1007 !strstr(ctype, "utf-8"));
1011 /* API function documented in wimlib.h */
1013 wimlib_get_version(void)
1015 return WIMLIB_VERSION_CODE;
1018 /* API function documented in wimlib.h */
1020 wimlib_global_init(int init_flags)
1022 static bool already_inited = false;
1027 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
1028 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
1029 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
1030 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
1031 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
1032 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
1033 return WIMLIB_ERR_INVALID_PARAM;
1035 libxml_global_init();
1036 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
1037 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
1039 if (!wimlib_mbs_is_utf8)
1040 libntfs3g_global_init();
1045 int ret = win32_global_init(init_flags);
1051 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
1052 default_ignore_case = false;
1053 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
1054 default_ignore_case = true;
1055 already_inited = true;
1059 /* API function documented in wimlib.h */
1061 wimlib_global_cleanup(void)
1063 libxml_global_cleanup();
1064 iconv_global_cleanup();
1066 win32_global_cleanup();
1068 cleanup_decompressor_params();
1069 cleanup_compressor_params();