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"
43 #include "wimlib/ntfs_3g.h" /* for libntfs3g_global_init() */
44 #include "wimlib/security.h"
45 #include "wimlib/wim.h"
46 #include "wimlib/xml.h"
47 #include "wimlib/win32.h"
49 /* Information about the available compression types for the WIM format. */
54 u32 default_nonsolid_chunk_size;
55 u32 default_solid_chunk_size;
56 } wim_ctype_info[] = {
57 [WIMLIB_COMPRESSION_TYPE_NONE] = {
61 .default_nonsolid_chunk_size = 0,
62 .default_solid_chunk_size = 0,
64 [WIMLIB_COMPRESSION_TYPE_XPRESS] = {
66 .min_chunk_size = 4096,
67 .max_chunk_size = 65536,
68 .default_nonsolid_chunk_size = 32768,
69 .default_solid_chunk_size = 32768,
71 [WIMLIB_COMPRESSION_TYPE_LZX] = {
73 .min_chunk_size = 32768,
74 .max_chunk_size = 2097152,
75 .default_nonsolid_chunk_size = 32768,
76 .default_solid_chunk_size = 32768,
78 [WIMLIB_COMPRESSION_TYPE_LZMS] = {
80 .min_chunk_size = 32768,
81 .max_chunk_size = 1073741824,
82 .default_nonsolid_chunk_size = 131072,
83 .default_solid_chunk_size = 67108864,
87 /* Is the specified compression type valid? */
89 wim_compression_type_valid(enum wimlib_compression_type ctype)
91 return (unsigned)ctype < ARRAY_LEN(wim_ctype_info) &&
92 wim_ctype_info[(unsigned)ctype].name != NULL;
95 /* Is the specified chunk size valid for the compression type? */
97 wim_chunk_size_valid(u32 chunk_size, enum wimlib_compression_type ctype)
99 if (!(chunk_size == 0 || is_power_of_2(chunk_size)))
102 return chunk_size >= wim_ctype_info[(unsigned)ctype].min_chunk_size &&
103 chunk_size <= wim_ctype_info[(unsigned)ctype].max_chunk_size;
106 /* Return the default chunk size to use for the specified compression type in
107 * non-solid resources. */
109 wim_default_nonsolid_chunk_size(enum wimlib_compression_type ctype)
111 return wim_ctype_info[(unsigned)ctype].default_nonsolid_chunk_size;
114 /* Return the default chunk size to use for the specified compression type in
115 * solid resources. */
117 wim_default_solid_chunk_size(enum wimlib_compression_type ctype)
119 return wim_ctype_info[(unsigned)ctype].default_solid_chunk_size;
122 /* Return the default compression type to use in solid resources. */
123 static enum wimlib_compression_type
124 wim_default_solid_compression_type(void)
126 return WIMLIB_COMPRESSION_TYPE_LZMS;
130 is_blob_in_solid_resource(struct blob_descriptor *blob, void *_ignore)
132 return blob->blob_location == BLOB_IN_WIM &&
133 (blob->rdesc->flags & WIM_RESHDR_FLAG_SOLID);
137 wim_has_solid_resources(const WIMStruct *wim)
139 return for_blob_in_table(wim->blob_table, is_blob_in_solid_resource, NULL);
145 WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
150 filedes_invalidate(&wim->in_fd);
151 filedes_invalidate(&wim->out_fd);
152 wim->out_solid_compression_type = wim_default_solid_compression_type();
153 wim->out_solid_chunk_size = wim_default_solid_chunk_size(
154 wim->out_solid_compression_type);
158 /* API function documented in wimlib.h */
160 wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret)
165 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
170 return WIMLIB_ERR_INVALID_PARAM;
172 if (!wim_compression_type_valid(ctype))
173 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
175 wim = new_wim_struct();
177 return WIMLIB_ERR_NOMEM;
179 wim->xml_info = xml_new_info_struct();
180 wim->blob_table = new_blob_table(9001);
181 if (!wim->xml_info || !wim->blob_table) {
183 return WIMLIB_ERR_NOMEM;
186 /* Fill in wim->hdr with default values */
187 wim->hdr.magic = WIM_MAGIC;
188 wim->hdr.wim_version = WIM_VERSION_DEFAULT;
190 wim->hdr.chunk_size = 0;
191 generate_guid(wim->hdr.guid);
192 wim->hdr.part_number = 1;
193 wim->hdr.total_parts = 1;
194 wim->hdr.image_count = 0;
195 wim->hdr.boot_idx = 0;
197 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
198 wim->chunk_size = wim->hdr.chunk_size;
200 /* Set the output compression type */
201 wim->out_compression_type = ctype;
202 wim->out_chunk_size = wim_default_nonsolid_chunk_size(ctype);
209 destroy_image_metadata(struct wim_image_metadata *imd,
210 struct blob_table *table,
211 bool free_metadata_blob_descriptor)
213 free_dentry_tree(imd->root_dentry, table);
214 imd->root_dentry = NULL;
215 free_wim_security_data(imd->security_data);
216 imd->security_data = NULL;
218 if (free_metadata_blob_descriptor) {
219 free_blob_descriptor(imd->metadata_blob);
220 imd->metadata_blob = NULL;
223 struct blob_descriptor *blob, *tmp;
224 list_for_each_entry_safe(blob, tmp, &imd->unhashed_blobs, unhashed_list)
225 free_blob_descriptor(blob);
227 INIT_LIST_HEAD(&imd->unhashed_blobs);
228 INIT_HLIST_HEAD(&imd->inode_list);
232 put_image_metadata(struct wim_image_metadata *imd, struct blob_table *table)
234 if (imd && --imd->refcnt == 0) {
235 destroy_image_metadata(imd, table, true);
240 /* Appends the specified image metadata structure to the array of image metadata
241 * for a WIM, and increments the image count. */
243 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
245 struct wim_image_metadata **imd_array;
247 imd_array = REALLOC(wim->image_metadata,
248 sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
251 return WIMLIB_ERR_NOMEM;
252 wim->image_metadata = imd_array;
253 imd_array[wim->hdr.image_count++] = imd;
257 struct wim_image_metadata *
258 new_image_metadata(void)
260 struct wim_image_metadata *imd;
262 imd = CALLOC(1, sizeof(*imd));
265 INIT_HLIST_HEAD(&imd->inode_list);
266 INIT_LIST_HEAD(&imd->unhashed_blobs);
271 static struct wim_image_metadata **
272 new_image_metadata_array(unsigned num_images)
274 struct wim_image_metadata **imd_array;
276 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
280 for (unsigned i = 0; i < num_images; i++) {
281 imd_array[i] = new_image_metadata();
282 if (unlikely(!imd_array[i])) {
283 for (unsigned j = 0; j < i; j++)
284 put_image_metadata(imd_array[j], NULL);
294 * Load the metadata for the specified WIM image into memory and set it
295 * as the WIMStruct's currently selected image.
298 * The WIMStruct for the WIM.
300 * The 1-based index of the image in the WIM to select.
302 * On success, 0 will be returned, wim->current_image will be set to
303 * @image, and wim_get_current_image_metadata() can be used to retrieve
304 * metadata information for the image.
306 * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
307 * or another error code will be returned.
310 select_wim_image(WIMStruct *wim, int image)
312 struct wim_image_metadata *imd;
315 if (image == WIMLIB_NO_IMAGE)
316 return WIMLIB_ERR_INVALID_IMAGE;
318 if (image == wim->current_image)
321 if (image < 1 || image > wim->hdr.image_count)
322 return WIMLIB_ERR_INVALID_IMAGE;
324 if (!wim_has_metadata(wim))
325 return WIMLIB_ERR_METADATA_NOT_FOUND;
327 /* If a valid image is currently selected, its metadata can be freed if
328 * it is not dirty and no other WIMStructs may have it selected. */
329 deselect_current_wim_image(wim);
330 wim->current_image = image;
331 imd = wim_get_current_image_metadata(wim);
332 if (imd->root_dentry || is_image_dirty(imd)) {
335 ret = read_metadata_resource(imd);
337 wim->current_image = WIMLIB_NO_IMAGE;
343 deselect_current_wim_image(WIMStruct *wim)
345 struct wim_image_metadata *imd;
346 if (wim->current_image == WIMLIB_NO_IMAGE)
348 imd = wim_get_current_image_metadata(wim);
349 if (!is_image_dirty(imd) && imd->refcnt == 1) {
350 wimlib_assert(list_empty(&imd->unhashed_blobs));
351 destroy_image_metadata(imd, NULL, false);
353 wim->current_image = WIMLIB_NO_IMAGE;
357 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
358 * @visitor is called on the WIM once for each image, with each image selected
359 * as the current image in turn. If @image is a certain image, @visitor is
360 * called on the WIM only once, with that image selected.
363 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
370 if (image == WIMLIB_ALL_IMAGES) {
372 end = wim->hdr.image_count;
373 } else if (image >= 1 && image <= wim->hdr.image_count) {
377 return WIMLIB_ERR_INVALID_IMAGE;
379 for (i = start; i <= end; i++) {
380 ret = select_wim_image(wim, i);
390 /* API function documented in wimlib.h */
392 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
398 if (!image_name_or_num || !*image_name_or_num)
399 return WIMLIB_NO_IMAGE;
401 if (!tstrcasecmp(image_name_or_num, T("all"))
402 || !tstrcasecmp(image_name_or_num, T("*")))
403 return WIMLIB_ALL_IMAGES;
404 image = tstrtol(image_name_or_num, &p, 10);
405 if (p != image_name_or_num && *p == T('\0') && image > 0) {
406 if (image > wim->hdr.image_count)
407 return WIMLIB_NO_IMAGE;
410 for (i = 1; i <= wim->hdr.image_count; i++) {
411 if (!tstrcmp(image_name_or_num,
412 wimlib_get_image_name(wim, i)))
415 return WIMLIB_NO_IMAGE;
419 /* API function documented in wimlib.h */
421 wimlib_print_available_images(const WIMStruct *wim, int image)
427 if (image == WIMLIB_ALL_IMAGES) {
428 n = tprintf(T("Available Images:\n"));
430 last = wim->hdr.image_count;
431 } else if (image >= 1 && image <= wim->hdr.image_count) {
432 n = tprintf(T("Information for Image %d\n"), image);
436 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
440 for (i = 0; i < n - 1; i++)
443 for (i = first; i <= last; i++)
444 xml_print_image_info(wim->xml_info, i);
447 /* API function documented in wimlib.h */
449 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
451 memset(info, 0, sizeof(struct wimlib_wim_info));
452 copy_guid(info->guid, wim->hdr.guid);
453 info->image_count = wim->hdr.image_count;
454 info->boot_index = wim->hdr.boot_idx;
455 info->wim_version = wim->hdr.wim_version;
456 info->chunk_size = wim->chunk_size;
457 info->part_number = wim->hdr.part_number;
458 info->total_parts = wim->hdr.total_parts;
459 info->compression_type = wim->compression_type;
460 info->total_bytes = xml_get_total_bytes(wim->xml_info);
461 info->has_integrity_table = wim_has_integrity_table(wim);
462 info->opened_from_file = (wim->filename != NULL);
463 info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
464 (wim->hdr.total_parts != 1) ||
465 (wim->filename && taccess(wim->filename, W_OK));
466 info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
467 info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
468 info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
469 info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
470 info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
471 info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
472 info->pipable = wim_is_pipable(wim);
476 /* API function documented in wimlib.h */
478 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
480 if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
482 WIMLIB_CHANGE_BOOT_INDEX |
483 WIMLIB_CHANGE_RPFIX_FLAG))
484 return WIMLIB_ERR_INVALID_PARAM;
486 if ((which & WIMLIB_CHANGE_BOOT_INDEX) &&
487 info->boot_index > wim->hdr.image_count)
488 return WIMLIB_ERR_INVALID_IMAGE;
490 if (which & WIMLIB_CHANGE_READONLY_FLAG) {
491 if (info->is_marked_readonly)
492 wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
494 wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
497 if (which & WIMLIB_CHANGE_GUID)
498 copy_guid(wim->hdr.guid, info->guid);
500 if (which & WIMLIB_CHANGE_BOOT_INDEX)
501 wim->hdr.boot_idx = info->boot_index;
503 if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
505 wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
507 wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
512 /* API function documented in wimlib.h */
514 wimlib_set_output_compression_type(WIMStruct *wim,
515 enum wimlib_compression_type ctype)
517 if (!wim_compression_type_valid(ctype))
518 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
520 wim->out_compression_type = ctype;
522 /* Reset the chunk size if it's no longer valid. */
523 if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
524 wim->out_chunk_size = wim_default_nonsolid_chunk_size(ctype);
528 /* API function documented in wimlib.h */
530 wimlib_set_output_pack_compression_type(WIMStruct *wim,
531 enum wimlib_compression_type ctype)
533 if (!wim_compression_type_valid(ctype))
534 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
536 /* Solid resources can't be uncompressed. */
537 if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
538 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
540 wim->out_solid_compression_type = ctype;
542 /* Reset the chunk size if it's no longer valid. */
543 if (!wim_chunk_size_valid(wim->out_solid_chunk_size, ctype))
544 wim->out_solid_chunk_size = wim_default_solid_chunk_size(ctype);
548 /* API function documented in wimlib.h */
550 wimlib_set_output_chunk_size(WIMStruct *wim, u32 chunk_size)
552 if (chunk_size == 0) {
553 wim->out_chunk_size =
554 wim_default_nonsolid_chunk_size(wim->out_compression_type);
558 if (!wim_chunk_size_valid(chunk_size, wim->out_compression_type))
559 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
561 wim->out_chunk_size = chunk_size;
565 /* API function documented in wimlib.h */
567 wimlib_set_output_pack_chunk_size(WIMStruct *wim, u32 chunk_size)
569 if (chunk_size == 0) {
570 wim->out_solid_chunk_size =
571 wim_default_solid_chunk_size(wim->out_solid_compression_type);
575 if (!wim_chunk_size_valid(chunk_size, wim->out_solid_compression_type))
576 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
578 wim->out_solid_chunk_size = chunk_size;
582 /* API function documented in wimlib.h */
583 WIMLIBAPI const tchar *
584 wimlib_get_compression_type_string(enum wimlib_compression_type ctype)
586 if (!wim_compression_type_valid(ctype))
589 return wim_ctype_info[(unsigned)ctype].name;
593 wimlib_register_progress_function(WIMStruct *wim,
594 wimlib_progress_func_t progfunc,
597 wim->progfunc = progfunc;
598 wim->progctx = progctx;
602 open_wim_file(const tchar *filename, struct filedes *fd_ret)
606 raw_fd = topen(filename, O_RDONLY | O_BINARY);
608 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
609 return WIMLIB_ERR_OPEN;
611 filedes_init(fd_ret, raw_fd);
616 * Begins the reading of a WIM file; opens the file and reads its header and
617 * blob table, and optionally checks the integrity.
620 begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
623 const tchar *wimfile;
625 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
627 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
628 wim->in_fd.is_pipe = 1;
630 wimfile = wim_filename_or_fd;
631 ret = open_wim_file(wimfile, &wim->in_fd);
635 /* The absolute path to the WIM is requested so that
636 * wimlib_overwrite() still works even if the process changes
637 * its working directory. This actually happens if a WIM is
638 * mounted read-write, since the FUSE thread changes directory
639 * to "/", and it needs to be able to find the WIM file again.
641 * This will break if the full path to the WIM changes in the
642 * intervening time...
644 * Warning: in Windows native builds, realpath() calls the
645 * replacement function in win32_replacements.c.
647 wim->filename = realpath(wimfile, NULL);
648 if (!wim->filename) {
649 ERROR_WITH_ERRNO("Failed to get full path to file "
650 "\"%"TS"\"", wimfile);
652 return WIMLIB_ERR_NOMEM;
654 return WIMLIB_ERR_NO_FILENAME;
658 ret = read_wim_header(wim, &wim->hdr);
662 if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
663 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
664 " \"%"TS"\". It may be being changed by another process,\n"
665 " or a process may have crashed while writing the WIM.",
669 if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
670 ret = can_modify_wim(wim);
675 if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
676 (wim->hdr.total_parts != 1))
677 return WIMLIB_ERR_IS_SPLIT_WIM;
679 /* If the boot index is invalid, print a warning and set it to 0 */
680 if (wim->hdr.boot_idx > wim->hdr.image_count) {
681 WARNING("Ignoring invalid boot index.");
682 wim->hdr.boot_idx = 0;
685 /* Check and cache the compression type */
686 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
687 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
688 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
689 } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
690 WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
691 wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
692 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
693 wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
695 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
698 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
700 wim->out_compression_type = wim->compression_type;
702 /* Check and cache the chunk size. */
703 wim->chunk_size = wim->hdr.chunk_size;
704 wim->out_chunk_size = wim->chunk_size;
705 if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
706 ERROR("Invalid chunk size (%"PRIu32" bytes) "
707 "for compression type %"TS"!", wim->chunk_size,
708 wimlib_get_compression_type_string(wim->compression_type));
709 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
712 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
713 ret = check_wim_integrity(wim);
714 if (ret == WIM_INTEGRITY_NONEXISTENT) {
715 WARNING("\"%"TS"\" does not contain integrity "
716 "information. Skipping integrity check.",
718 } else if (ret == WIM_INTEGRITY_NOT_OK) {
719 return WIMLIB_ERR_INTEGRITY;
720 } else if (ret != WIM_INTEGRITY_OK) {
725 if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
726 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
727 if (!wim->image_metadata)
728 return WIMLIB_ERR_NOMEM;
731 if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
732 wim->blob_table = new_blob_table(9001);
733 if (!wim->blob_table)
734 return WIMLIB_ERR_NOMEM;
736 if (wim->hdr.blob_table_reshdr.uncompressed_size == 0 &&
737 wim->hdr.xml_data_reshdr.uncompressed_size == 0)
738 return WIMLIB_ERR_WIM_IS_INCOMPLETE;
740 ret = read_wim_xml_data(wim);
744 if (xml_get_image_count(wim->xml_info) != wim->hdr.image_count) {
745 ERROR("The WIM's header is inconsistent with its XML data.\n"
746 " Please submit a bug report if you believe this "
747 "WIM file should be considered valid.");
748 return WIMLIB_ERR_IMAGE_COUNT;
751 ret = read_blob_table(wim);
759 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
761 wimlib_progress_func_t progfunc, void *progctx)
766 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
770 wim = new_wim_struct();
772 return WIMLIB_ERR_NOMEM;
774 wim->progfunc = progfunc;
775 wim->progctx = progctx;
777 ret = begin_read(wim, wim_filename_or_fd, open_flags);
787 /* API function documented in wimlib.h */
789 wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
791 wimlib_progress_func_t progfunc, void *progctx)
793 if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
794 WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
795 WIMLIB_OPEN_FLAG_WRITE_ACCESS))
796 return WIMLIB_ERR_INVALID_PARAM;
798 if (!wimfile || !*wimfile || !wim_ret)
799 return WIMLIB_ERR_INVALID_PARAM;
801 return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
805 /* API function documented in wimlib.h */
807 wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
809 return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
813 /* Checksum all blobs that are unhashed (other than the metadata blobs), merging
814 * them into the blob table as needed. This is a no-op unless files have been
815 * added to an image in the same WIMStruct. */
817 wim_checksum_unhashed_blobs(WIMStruct *wim)
821 if (!wim_has_metadata(wim))
823 for (int i = 0; i < wim->hdr.image_count; i++) {
824 struct blob_descriptor *blob, *tmp;
825 struct wim_image_metadata *imd = wim->image_metadata[i];
826 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
827 struct blob_descriptor *new_blob;
828 ret = hash_unhashed_blob(blob, wim->blob_table, &new_blob);
831 if (new_blob != blob)
832 free_blob_descriptor(blob);
839 * can_modify_wim - Check if a given WIM is writeable. This is only the case if
840 * it meets the following three conditions:
842 * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
843 * 2. The WIM is not part of a spanned set.
844 * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
846 * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
849 can_modify_wim(WIMStruct *wim)
852 if (taccess(wim->filename, W_OK)) {
853 ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
854 return WIMLIB_ERR_WIM_IS_READONLY;
857 if (wim->hdr.total_parts != 1) {
858 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
860 return WIMLIB_ERR_WIM_IS_READONLY;
862 if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
863 ERROR("Cannot modify \"%"TS"\": is marked read-only",
865 return WIMLIB_ERR_WIM_IS_READONLY;
870 /* Free a WIMStruct after no more resources reference it. */
872 finalize_wim_struct(WIMStruct *wim)
874 if (filedes_valid(&wim->in_fd))
875 filedes_close(&wim->in_fd);
876 if (filedes_valid(&wim->out_fd))
877 filedes_close(&wim->out_fd);
878 wimlib_free_decompressor(wim->decompressor);
879 xml_free_info_struct(wim->xml_info);
884 /* API function documented in wimlib.h */
886 wimlib_free(WIMStruct *wim)
891 /* The blob table and image metadata are freed immediately, but other
892 * members of the WIMStruct such as the input file descriptor are
893 * retained until no more exported resources reference the WIMStruct. */
895 free_blob_table(wim->blob_table);
896 wim->blob_table = NULL;
897 if (wim->image_metadata != NULL) {
898 for (int i = 0; i < wim->hdr.image_count; i++)
899 put_image_metadata(wim->image_metadata[i], NULL);
900 FREE(wim->image_metadata);
901 wim->image_metadata = NULL;
904 wimlib_assert(wim->refcnt > 0);
905 if (--wim->refcnt == 0)
906 finalize_wim_struct(wim);
910 test_locale_ctype_utf8(void)
915 char *ctype = nl_langinfo(CODESET);
917 return (!strstr(ctype, "UTF-8") ||
918 !strstr(ctype, "UTF8") ||
919 !strstr(ctype, "utf8") ||
920 !strstr(ctype, "utf-8"));
924 /* API function documented in wimlib.h */
926 wimlib_get_version(void)
928 return (WIMLIB_MAJOR_VERSION << 20) |
929 (WIMLIB_MINOR_VERSION << 10) |
930 WIMLIB_PATCH_VERSION;
933 static bool lib_initialized = false;
934 static pthread_mutex_t lib_initialization_mutex = PTHREAD_MUTEX_INITIALIZER;
936 /* API function documented in wimlib.h */
938 wimlib_global_init(int init_flags)
945 pthread_mutex_lock(&lib_initialization_mutex);
950 #ifdef ENABLE_ERROR_MESSAGES
951 if (!wimlib_error_file)
952 wimlib_error_file = stderr;
955 ret = WIMLIB_ERR_INVALID_PARAM;
956 if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
957 WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
958 WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
959 WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
960 WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
961 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
964 ret = WIMLIB_ERR_INVALID_PARAM;
965 if ((init_flags & (WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
966 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
967 == (WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
968 WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
972 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
973 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
975 if (!wimlib_mbs_is_utf8)
976 libntfs3g_global_init();
980 ret = win32_global_init(init_flags);
986 if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
987 default_ignore_case = false;
988 else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
989 default_ignore_case = true;
990 lib_initialized = true;
993 pthread_mutex_unlock(&lib_initialization_mutex);
998 /* API function documented in wimlib.h */
1000 wimlib_global_cleanup(void)
1002 if (!lib_initialized)
1005 pthread_mutex_lock(&lib_initialization_mutex);
1007 if (!lib_initialized)
1010 xml_global_cleanup();
1011 iconv_global_cleanup();
1013 win32_global_cleanup();
1016 wimlib_set_error_file(NULL);
1017 lib_initialized = false;
1020 pthread_mutex_unlock(&lib_initialization_mutex);