6 * Copyright (C) 2010 Carl Thijssen
7 * Copyright (C) 2012 Eric Biggers
9 * wimlib - Library for working with WIM files
11 * This file is part of wimlib, a library for working with WIM files.
13 * wimlib is free software; you can redistribute it and/or modify it under the
14 * terms of the GNU General Public License as published by the Free
15 * Software Foundation; either version 3 of the License, or (at your option)
18 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20 * A PARTICULAR PURPOSE. See the GNU General Public License for more
23 * You should have received a copy of the GNU General Public License
24 * along with wimlib; if not, see http://www.gnu.org/licenses/.
38 #include <ntfs-3g/volume.h>
41 #include "wimlib_internal.h"
43 #include "lookup_table.h"
47 static int print_metadata(WIMStruct *w)
49 DEBUG("Printing metadata for image %d", w->current_image);
50 print_security_data(wim_security_data(w));
51 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
56 static int print_files(WIMStruct *w)
58 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
62 WIMStruct *new_wim_struct()
64 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
66 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
67 ERROR_WITH_ERRNO("Failed to initialize mutex");
77 * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
78 * is called on the WIM once for each image, with each image selected as the
79 * current image in turn. If @image is a certain image, @visitor is called on
80 * the WIM only once, with that image selected.
82 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
89 if (image == WIM_ALL_IMAGES) {
91 end = w->hdr.image_count;
92 } else if (image >= 1 && image <= w->hdr.image_count) {
96 return WIMLIB_ERR_INVALID_IMAGE;
98 for (i = start; i <= end; i++) {
99 ret = select_wim_image(w, i);
109 static int sort_image_metadata_by_position(const void *p1, const void *p2)
111 const struct image_metadata *imd1 = p1;
112 const struct image_metadata *imd2 = p2;
113 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
114 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
115 if (offset1 < offset2)
117 else if (offset1 > offset2)
124 * If @lte points to a metadata resource, append it to the list of metadata
125 * resources in the WIMStruct. Otherwise, do nothing.
127 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
130 WIMStruct *w = wim_p;
133 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
134 if (w->current_image == w->hdr.image_count) {
135 ERROR("Expected only %u images, but found more",
137 ret = WIMLIB_ERR_IMAGE_COUNT;
139 DEBUG("Found metadata resource for image %u at "
141 w->current_image + 1,
142 lte->resource_entry.offset);
144 w->current_image++].metadata_lte = lte;
150 /* Returns the compression type given in the flags of a WIM header. */
151 int wim_hdr_flags_compression_type(int wim_hdr_flags)
153 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
154 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
155 return WIM_COMPRESSION_TYPE_LZX;
156 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
157 return WIM_COMPRESSION_TYPE_XPRESS;
159 return WIM_COMPRESSION_TYPE_INVALID;
161 return WIM_COMPRESSION_TYPE_NONE;
166 * Creates a WIMStruct for a new WIM file.
168 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
171 struct lookup_table *table;
174 DEBUG("Creating new WIM with %s compression.",
175 wimlib_get_compression_type_string(ctype));
177 /* Allocate the WIMStruct. */
178 w = new_wim_struct();
180 return WIMLIB_ERR_NOMEM;
182 ret = init_header(&w->hdr, ctype);
186 table = new_lookup_table(9001);
188 ret = WIMLIB_ERR_NOMEM;
191 w->lookup_table = table;
199 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
201 return w->hdr.image_count;
204 int select_wim_image(WIMStruct *w, int image)
206 struct image_metadata *imd;
208 DEBUG("Selecting image %d", image);
210 if (image == w->current_image)
213 if (image < 1 || image > w->hdr.image_count) {
214 ERROR("Cannot select image %d: There are only %u images",
215 image, w->hdr.image_count);
216 return WIMLIB_ERR_INVALID_IMAGE;
219 /* If a valid image is currently selected, it can be freed if it is not
221 if (w->current_image != WIM_NO_IMAGE) {
222 imd = wim_get_current_image_metadata(w);
223 if (!imd->modified) {
224 DEBUG("Freeing image %u", w->current_image);
225 destroy_image_metadata(imd, NULL);
226 imd->root_dentry = NULL;
227 imd->security_data = NULL;
231 w->current_image = image;
232 imd = wim_get_current_image_metadata(w);
234 if (imd->root_dentry) {
238 DEBUG("Reading metadata resource specified by the following "
239 "lookup table entry:");
240 print_lookup_table_entry(imd->metadata_lte);
242 return read_metadata_resource(w, imd);
247 /* Returns the compression type of the WIM file. */
248 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
250 return wim_hdr_flags_compression_type(w->hdr.flags);
253 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
256 case WIM_COMPRESSION_TYPE_NONE:
258 case WIM_COMPRESSION_TYPE_LZX:
260 case WIM_COMPRESSION_TYPE_XPRESS:
268 * Returns the number of an image in the WIM file, given a string that is either
269 * the number of the image, or the name of the image. The images are numbered
272 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
278 if (!image_name_or_num)
281 if (strcmp(image_name_or_num, "all") == 0
282 || strcmp(image_name_or_num, "*") == 0)
283 return WIM_ALL_IMAGES;
284 image = strtol(image_name_or_num, &p, 10);
285 if (p != image_name_or_num && *p == '\0') {
286 if (image < 1 || image > w->hdr.image_count)
290 for (i = 1; i <= w->hdr.image_count; i++) {
291 if (strcmp(image_name_or_num,
292 wimlib_get_image_name(w, i)) == 0)
300 /* Prints some basic information about a WIM file. */
301 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
303 const struct wim_header *hdr;
306 puts("WIM Information:");
307 puts("----------------");
308 printf("Path: %s\n", w->filename);
309 fputs ("GUID: 0x", stdout);
310 print_byte_field(hdr->guid, WIM_GID_LEN);
312 printf("Image Count: %d\n", hdr->image_count);
313 printf("Compression: %s\n", wimlib_get_compression_type_string(
314 wimlib_get_compression_type(w)));
315 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
316 printf("Boot Index: %d\n", hdr->boot_idx);
317 printf("Size: %"PRIu64" bytes\n",
318 wim_info_get_total_bytes(w->wim_info));
319 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
323 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
325 return w->hdr.integrity.size != 0;
328 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
334 if (image == WIM_ALL_IMAGES) {
335 n = printf("Available Images:\n");
337 last = w->hdr.image_count;
338 } else if (image >= 1 && image <= w->hdr.image_count) {
339 n = printf("Information for Image %d\n", image);
343 printf("wimlib_print_available_images(): Invalid image %d",
347 for (i = 0; i < n - 1; i++)
350 for (i = first; i <= last; i++)
351 print_image_info(w->wim_info, i);
355 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
356 * not WIM_NO_IMAGE. */
357 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
360 return WIMLIB_ERR_INVALID_PARAM;
361 if (w->hdr.part_number != 1) {
362 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
363 w->hdr.part_number, w->hdr.total_parts);
364 ERROR("Select the first part of the split WIM to see the metadata.");
365 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
367 return for_image(w, image, print_metadata);
370 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
373 return WIMLIB_ERR_INVALID_PARAM;
374 if (w->hdr.part_number != 1) {
375 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
376 w->hdr.part_number, w->hdr.total_parts);
377 ERROR("Select the first part of the split WIM if you'd like to list the files.");
378 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
380 return for_image(w, image, print_files);
383 /* Sets the index of the bootable image. */
384 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
387 return WIMLIB_ERR_INVALID_PARAM;
388 if (w->hdr.total_parts != 1) {
389 ERROR("Cannot modify the boot index of a split WIM!");
390 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
392 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
393 return WIMLIB_ERR_INVALID_IMAGE;
394 w->hdr.boot_idx = boot_idx;
397 memset(&w->hdr.boot_metadata_res_entry, 0,
398 sizeof(struct resource_entry));
400 memcpy(&w->hdr.boot_metadata_res_entry,
402 boot_idx - 1].metadata_lte->resource_entry,
403 sizeof(struct resource_entry));
409 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
412 *total_parts_ret = w->hdr.total_parts;
413 return w->hdr.part_number;
417 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
419 return w->hdr.boot_idx;
422 /* Opens a WIM readable */
423 int open_wim_readable(WIMStruct *w, const char *path)
427 wimlib_assert(path != NULL);
428 w->fp = fopen(path, "rb");
430 ERROR_WITH_ERRNO("Failed to open `%s' for reading",
432 return WIMLIB_ERR_OPEN;
437 /* Opens a WIM writable */
438 int open_wim_writable(WIMStruct *w, const char *path,
439 bool trunc, bool readable)
450 DEBUG("Opening `%s' read-write", path);
451 wimlib_assert(w->out_fp == NULL);
452 wimlib_assert(path != NULL);
453 w->out_fp = fopen(path, mode);
455 ERROR_WITH_ERRNO("Failed to open `%s' for writing", path);
456 return WIMLIB_ERR_OPEN;
462 * Begins the reading of a WIM file; opens the file and reads its header and
463 * lookup table, and optionally checks the integrity.
465 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
470 DEBUG("Reading the WIM file `%s'", in_wim_path);
472 ret = open_wim_readable(w, in_wim_path);
476 w->filename = realpath(in_wim_path, NULL);
478 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
479 ret = WIMLIB_ERR_NOMEM;
483 ret = read_header(w->fp, &w->hdr, open_flags);
487 DEBUG("Wim file contains %u images", w->hdr.image_count);
489 /* If the boot index is invalid, print a warning and set it to 0 */
490 if (w->hdr.boot_idx > w->hdr.image_count) {
491 WARNING("In `%s', image %u is marked as bootable, "
492 "but there are only %u images in the WIM",
493 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
497 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
498 ERROR("Invalid compression type (WIM header flags = %x)",
500 ret = WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
504 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
505 ret = check_wim_integrity(w,
506 (open_flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS) != 0);
507 if (ret == WIM_INTEGRITY_NONEXISTENT) {
508 WARNING("No integrity information for `%s'; skipping "
509 "integrity check.", w->filename);
510 } else if (ret == WIM_INTEGRITY_NOT_OK) {
511 ERROR("WIM is not intact! (Failed integrity check)");
512 ret = WIMLIB_ERR_INTEGRITY;
514 } else if (ret != 0) {
519 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
520 ERROR("Didn't expect a compressed lookup table!");
521 ERROR("Ask the author to implement support for this.");
522 ret = WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
526 ret = read_lookup_table(w);
530 w->image_metadata = CALLOC(w->hdr.image_count,
531 sizeof(struct image_metadata));
533 if (!w->image_metadata) {
534 ERROR("Failed to allocate memory for %u metadata structures",
536 ret = WIMLIB_ERR_NOMEM;
537 goto out_free_lookup_table;
539 w->current_image = 0;
541 DEBUG("Looking for metadata resources in the lookup table.");
543 /* Find the images in the WIM by searching the lookup table. */
544 ret = for_lookup_table_entry(w->lookup_table,
545 append_metadata_resource_entry, w);
548 goto out_free_image_metadata;
550 /* Make sure all the expected images were found. (We already have
551 * returned false if *extra* images were found) */
552 if (w->current_image != w->hdr.image_count &&
553 w->hdr.part_number == 1)
555 ERROR("Only found %u images in WIM, but expected %u",
556 w->current_image, w->hdr.image_count);
557 ret = WIMLIB_ERR_IMAGE_COUNT;
558 goto out_free_image_metadata;
561 /* Sort images by the position of their metadata resources. I'm
562 * assuming that is what determines the other of the images in the WIM
563 * file, rather than their order in the lookup table, which is random
564 * because of hashing. */
565 qsort(w->image_metadata, w->current_image,
566 sizeof(struct image_metadata), sort_image_metadata_by_position);
568 w->current_image = WIM_NO_IMAGE;
570 /* Read the XML data. */
571 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
572 &w->xml_data, &w->wim_info);
575 goto out_free_image_metadata;
577 xml_num_images = wim_info_get_num_images(w->wim_info);
578 if (xml_num_images != w->hdr.image_count) {
579 ERROR("In the file `%s', there are %u <IMAGE> elements "
580 "in the XML data,", in_wim_path, xml_num_images);
581 ERROR("but %u images in the WIM! There must be exactly one "
582 "<IMAGE> element per image.", w->hdr.image_count);
583 ret = WIMLIB_ERR_IMAGE_COUNT;
584 goto out_free_xml_data;
587 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
591 // Everything is freed in wimlib_free() anyway, so no need to roll back
595 /*FREE(w->xml_data);*/
596 /*w->xml_data = NULL;*/
597 /*free_wim_info(w->wim_info);*/
598 /*w->wim_info = NULL;*/
599 out_free_image_metadata:
600 /*FREE(w->image_metadata);*/
601 /*w->image_metadata = NULL;*/
602 /*w->current_image = WIM_NO_IMAGE;*/
603 out_free_lookup_table:
604 /*free_lookup_table(w->lookup_table);*/
605 /*w->lookup_table = NULL;*/
615 * Opens a WIM file and creates a WIMStruct for it.
617 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
623 DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
624 w = new_wim_struct();
626 ERROR("Failed to allocate memory for WIMStruct");
627 return WIMLIB_ERR_NOMEM;
630 ret = begin_read(w, wim_file, open_flags);
634 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
640 /* Frees the memory for the WIMStruct, including all internal memory; also
641 * closes all files associated with the WIMStruct. */
642 WIMLIBAPI void wimlib_free(WIMStruct *w)
644 DEBUG2("Freeing WIMStruct");
655 for (size_t i = 0; i < w->num_allocated_fps; i++)
657 fclose(w->fp_tab[i]);
660 pthread_mutex_destroy(&w->fp_tab_mutex);
663 free_lookup_table(w->lookup_table);
667 free_wim_info(w->wim_info);
668 if (w->image_metadata) {
669 for (uint i = 0; i < w->hdr.image_count; i++)
670 destroy_image_metadata(&w->image_metadata[i], NULL);
671 FREE(w->image_metadata);
675 DEBUG("Unmounting NTFS volume");
676 ntfs_umount(w->ntfs_vol, FALSE);