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"
46 static int print_metadata(WIMStruct *w)
48 DEBUG("Printing metadata for image %d", w->current_image);
49 print_security_data(wim_security_data(w));
50 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
55 static int print_files(WIMStruct *w)
57 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
61 WIMStruct *new_wim_struct()
63 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
65 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
66 ERROR_WITH_ERRNO("Failed to initialize mutex");
76 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
77 * is called on the WIM once for each image, with each image selected as the
78 * current image in turn. If @image is a certain image, @visitor is called on
79 * the WIM only once, with that image selected.
81 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
88 if (image == WIMLIB_ALL_IMAGES) {
90 end = w->hdr.image_count;
91 } else if (image >= 1 && image <= w->hdr.image_count) {
95 return WIMLIB_ERR_INVALID_IMAGE;
97 for (i = start; i <= end; i++) {
98 ret = select_wim_image(w, i);
108 static int sort_image_metadata_by_position(const void *p1, const void *p2)
110 const struct image_metadata *imd1 = p1;
111 const struct image_metadata *imd2 = p2;
112 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
113 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
114 if (offset1 < offset2)
116 else if (offset1 > offset2)
123 * If @lte points to a metadata resource, append it to the list of metadata
124 * resources in the WIMStruct. Otherwise, do nothing.
126 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
129 WIMStruct *w = wim_p;
132 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
133 if (w->current_image == w->hdr.image_count) {
134 ERROR("The WIM header says there are %u images in the WIM,\n"
135 " but we found more metadata resources than this",
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 WIMLIB_COMPRESSION_TYPE_LZX;
156 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
157 return WIMLIB_COMPRESSION_TYPE_XPRESS;
159 return WIMLIB_COMPRESSION_TYPE_INVALID;
161 return WIMLIB_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 == WIMLIB_NO_IMAGE) {
211 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
212 return WIMLIB_ERR_INVALID_IMAGE;
215 if (image == w->current_image)
218 if (image < 1 || image > w->hdr.image_count) {
219 ERROR("Cannot select image %d: There are only %u images",
220 image, w->hdr.image_count);
221 return WIMLIB_ERR_INVALID_IMAGE;
224 /* If a valid image is currently selected, it can be freed if it is not
226 if (w->current_image != WIMLIB_NO_IMAGE) {
227 imd = wim_get_current_image_metadata(w);
228 if (!imd->modified) {
229 DEBUG("Freeing image %u", w->current_image);
230 destroy_image_metadata(imd, NULL);
231 imd->root_dentry = NULL;
232 imd->security_data = NULL;
233 INIT_HLIST_HEAD(&imd->inode_list);
237 w->current_image = image;
238 imd = wim_get_current_image_metadata(w);
240 if (imd->root_dentry) {
244 DEBUG("Reading metadata resource specified by the following "
245 "lookup table entry:");
246 print_lookup_table_entry(imd->metadata_lte);
248 return read_metadata_resource(w, imd);
253 /* Returns the compression type of the WIM file. */
254 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
256 return wim_hdr_flags_compression_type(w->hdr.flags);
259 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
262 case WIMLIB_COMPRESSION_TYPE_NONE:
264 case WIMLIB_COMPRESSION_TYPE_LZX:
266 case WIMLIB_COMPRESSION_TYPE_XPRESS:
274 * Returns the number of an image in the WIM file, given a string that is either
275 * the number of the image, or the name of the image. The images are numbered
278 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
284 if (!image_name_or_num || !*image_name_or_num)
285 return WIMLIB_NO_IMAGE;
287 if (strcmp(image_name_or_num, "all") == 0
288 || strcmp(image_name_or_num, "*") == 0)
289 return WIMLIB_ALL_IMAGES;
290 image = strtol(image_name_or_num, &p, 10);
291 if (p != image_name_or_num && *p == '\0' && image > 0) {
292 if (image > w->hdr.image_count)
293 return WIMLIB_NO_IMAGE;
296 for (i = 1; i <= w->hdr.image_count; i++) {
297 if (strcmp(image_name_or_num,
298 wimlib_get_image_name(w, i)) == 0)
301 return WIMLIB_NO_IMAGE;
306 /* Prints some basic information about a WIM file. */
307 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
309 const struct wim_header *hdr;
312 puts("WIM Information:");
313 puts("----------------");
314 printf("Path: %s\n", w->filename);
315 fputs ("GUID: 0x", stdout);
316 print_byte_field(hdr->guid, WIM_GID_LEN);
318 printf("Image Count: %d\n", hdr->image_count);
319 printf("Compression: %s\n", wimlib_get_compression_type_string(
320 wimlib_get_compression_type(w)));
321 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
322 printf("Boot Index: %d\n", hdr->boot_idx);
323 printf("Size: %"PRIu64" bytes\n",
324 wim_info_get_total_bytes(w->wim_info));
325 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
329 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
331 return w->hdr.integrity.size != 0;
334 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
340 if (image == WIMLIB_ALL_IMAGES) {
341 n = printf("Available Images:\n");
343 last = w->hdr.image_count;
344 } else if (image >= 1 && image <= w->hdr.image_count) {
345 n = printf("Information for Image %d\n", image);
349 printf("wimlib_print_available_images(): Invalid image %d",
353 for (i = 0; i < n - 1; i++)
356 for (i = first; i <= last; i++)
357 print_image_info(w->wim_info, i);
361 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
362 * not WIMLIB_NO_IMAGE. */
363 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
366 return WIMLIB_ERR_INVALID_PARAM;
367 if (w->hdr.part_number != 1) {
368 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
369 w->hdr.part_number, w->hdr.total_parts);
370 ERROR("Select the first part of the split WIM to see the metadata.");
371 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
373 return for_image(w, image, print_metadata);
376 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
379 return WIMLIB_ERR_INVALID_PARAM;
380 if (w->hdr.part_number != 1) {
381 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
382 w->hdr.part_number, w->hdr.total_parts);
383 ERROR("Select the first part of the split WIM if you'd like to list the files.");
384 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
386 return for_image(w, image, print_files);
389 /* Sets the index of the bootable image. */
390 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
393 return WIMLIB_ERR_INVALID_PARAM;
394 if (w->hdr.total_parts != 1) {
395 ERROR("Cannot modify the boot index of a split WIM!");
396 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
398 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
399 return WIMLIB_ERR_INVALID_IMAGE;
400 w->hdr.boot_idx = boot_idx;
403 memset(&w->hdr.boot_metadata_res_entry, 0,
404 sizeof(struct resource_entry));
406 memcpy(&w->hdr.boot_metadata_res_entry,
408 boot_idx - 1].metadata_lte->resource_entry,
409 sizeof(struct resource_entry));
415 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
418 *total_parts_ret = w->hdr.total_parts;
419 return w->hdr.part_number;
423 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
425 return w->hdr.boot_idx;
429 * Begins the reading of a WIM file; opens the file and reads its header and
430 * lookup table, and optionally checks the integrity.
432 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
433 wimlib_progress_func_t progress_func)
438 DEBUG("Reading the WIM file `%s'", in_wim_path);
440 w->fp = fopen(in_wim_path, "rb");
442 ERROR_WITH_ERRNO("Failed to open `%s' for reading",
444 return WIMLIB_ERR_OPEN;
447 /* The absolute path to the WIM is requested so that wimlib_overwrite()
448 * still works even if the process changes its working directory. This
449 * actually happens if a WIM is mounted read-write, since the FUSE
450 * thread changes directory to "/", and it needs to be able to find the
453 * This will break if the full path to the WIM changes in the
454 * intervening time...
456 w->filename = realpath(in_wim_path, NULL);
458 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
459 ret = WIMLIB_ERR_NOMEM;
463 ret = read_header(w->fp, &w->hdr, open_flags);
467 DEBUG("Wim file contains %u images", w->hdr.image_count);
469 /* If the boot index is invalid, print a warning and set it to 0 */
470 if (w->hdr.boot_idx > w->hdr.image_count) {
471 WARNING("In `%s', image %u is marked as bootable, "
472 "but there are only %u images in the WIM",
473 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
477 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
478 ERROR("Invalid compression type (WIM header flags = %x)",
480 ret = WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
484 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
485 ret = check_wim_integrity(w, progress_func);
486 if (ret == WIM_INTEGRITY_NONEXISTENT) {
487 WARNING("No integrity information for `%s'; skipping "
488 "integrity check.", w->filename);
489 } else if (ret == WIM_INTEGRITY_NOT_OK) {
490 ERROR("WIM is not intact! (Failed integrity check)");
491 ret = WIMLIB_ERR_INTEGRITY;
493 } else if (ret != 0) {
498 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
499 ERROR("Didn't expect a compressed lookup table!");
500 ERROR("Ask the author to implement support for this.");
501 ret = WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
505 ret = read_lookup_table(w);
509 w->image_metadata = CALLOC(w->hdr.image_count,
510 sizeof(struct image_metadata));
512 if (!w->image_metadata) {
513 ERROR("Failed to allocate memory for %u metadata structures",
515 ret = WIMLIB_ERR_NOMEM;
516 goto out_free_lookup_table;
518 w->current_image = 0;
520 DEBUG("Looking for metadata resources in the lookup table.");
522 /* Find the images in the WIM by searching the lookup table. */
523 ret = for_lookup_table_entry(w->lookup_table,
524 append_metadata_resource_entry, w);
527 goto out_free_image_metadata;
529 /* Make sure all the expected images were found. (We already have
530 * returned false if *extra* images were found) */
531 if (w->current_image != w->hdr.image_count &&
532 w->hdr.part_number == 1)
534 ERROR("Only found %u images in WIM, but expected %u",
535 w->current_image, w->hdr.image_count);
536 ret = WIMLIB_ERR_IMAGE_COUNT;
537 goto out_free_image_metadata;
540 /* Sort images by the position of their metadata resources. I'm
541 * assuming that is what determines the other of the images in the WIM
542 * file, rather than their order in the lookup table, which is random
543 * because of hashing. */
544 qsort(w->image_metadata, w->current_image,
545 sizeof(struct image_metadata), sort_image_metadata_by_position);
547 w->current_image = WIMLIB_NO_IMAGE;
549 /* Read the XML data. */
550 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
551 &w->xml_data, &w->wim_info);
554 goto out_free_image_metadata;
556 xml_num_images = wim_info_get_num_images(w->wim_info);
557 if (xml_num_images != w->hdr.image_count) {
558 ERROR("In the file `%s', there are %u <IMAGE> elements "
559 "in the XML data,", in_wim_path, xml_num_images);
560 ERROR("but %u images in the WIM! There must be exactly one "
561 "<IMAGE> element per image.", w->hdr.image_count);
562 ret = WIMLIB_ERR_IMAGE_COUNT;
563 goto out_free_xml_data;
566 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
570 // Everything is freed in wimlib_free() anyway, so no need to roll back
574 /*FREE(w->xml_data);*/
575 /*w->xml_data = NULL;*/
576 /*free_wim_info(w->wim_info);*/
577 /*w->wim_info = NULL;*/
578 out_free_image_metadata:
579 /*FREE(w->image_metadata);*/
580 /*w->image_metadata = NULL;*/
581 /*w->current_image = WIMLIB_NO_IMAGE;*/
582 out_free_lookup_table:
583 /*free_lookup_table(w->lookup_table);*/
584 /*w->lookup_table = NULL;*/
594 * Opens a WIM file and creates a WIMStruct for it.
596 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
598 wimlib_progress_func_t progress_func)
603 if (!wim_file || !w_ret)
604 return WIMLIB_ERR_INVALID_PARAM;
605 w = new_wim_struct();
607 ERROR("Failed to allocate memory for WIMStruct");
608 return WIMLIB_ERR_NOMEM;
611 ret = begin_read(w, wim_file, open_flags, progress_func);
615 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
621 /* Frees the memory for the WIMStruct, including all internal memory; also
622 * closes all files associated with the WIMStruct. */
623 WIMLIBAPI void wimlib_free(WIMStruct *w)
625 DEBUG2("Freeing WIMStruct");
636 for (size_t i = 0; i < w->num_allocated_fps; i++)
638 fclose(w->fp_tab[i]);
641 pthread_mutex_destroy(&w->fp_tab_mutex);
644 free_lookup_table(w->lookup_table);
648 free_wim_info(w->wim_info);
649 if (w->image_metadata) {
650 for (uint i = 0; i < w->hdr.image_count; i++)
651 destroy_image_metadata(&w->image_metadata[i], NULL);
652 FREE(w->image_metadata);
656 DEBUG("Unmounting NTFS volume");
657 ntfs_umount(w->ntfs_vol, FALSE);