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/.
36 #include <ntfs-3g/volume.h>
39 #include "wimlib_internal.h"
41 #include "lookup_table.h"
45 static int print_metadata(WIMStruct *w)
47 DEBUG("Printing metadata for image %d", w->current_image);
48 print_security_data(wim_security_data(w));
49 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
54 static int print_files(WIMStruct *w)
56 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
60 WIMStruct *new_wim_struct()
62 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
64 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
65 ERROR_WITH_ERRNO("Failed to initialize mutex");
75 * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
76 * is called on the WIM once for each image, with each image selected as the
77 * current image in turn. If @image is a certain image, @visitor is called on
78 * the WIM only once, with that image selected.
80 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
87 if (image == WIM_ALL_IMAGES) {
89 end = w->hdr.image_count;
90 } else if (image >= 1 && image <= w->hdr.image_count) {
94 return WIMLIB_ERR_INVALID_IMAGE;
96 for (i = start; i <= end; i++) {
97 ret = select_wim_image(w, i);
107 static int sort_image_metadata_by_position(const void *p1, const void *p2)
109 const struct image_metadata *imd1 = p1;
110 const struct image_metadata *imd2 = p2;
111 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
112 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
113 if (offset1 < offset2)
115 else if (offset1 > offset2)
122 * If @lte points to a metadata resource, append it to the list of metadata
123 * resources in the WIMStruct. Otherwise, do nothing.
125 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
128 WIMStruct *w = wim_p;
131 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
132 if (w->current_image == w->hdr.image_count) {
133 ERROR("Expected only %u images, but found more",
135 ret = WIMLIB_ERR_IMAGE_COUNT;
137 DEBUG("Found metadata resource for image %u at "
139 w->current_image + 1,
140 lte->resource_entry.offset);
142 w->current_image++].metadata_lte = lte;
148 /* Returns the compression type given in the flags of a WIM header. */
149 int wim_hdr_flags_compression_type(int wim_hdr_flags)
151 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
152 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
153 return WIM_COMPRESSION_TYPE_LZX;
154 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
155 return WIM_COMPRESSION_TYPE_XPRESS;
157 return WIM_COMPRESSION_TYPE_INVALID;
159 return WIM_COMPRESSION_TYPE_NONE;
164 * Creates a WIMStruct for a new WIM file.
166 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
169 struct lookup_table *table;
172 DEBUG("Creating new WIM with %s compression.",
173 wimlib_get_compression_type_string(ctype));
175 /* Allocate the WIMStruct. */
176 w = new_wim_struct();
178 return WIMLIB_ERR_NOMEM;
180 ret = init_header(&w->hdr, ctype);
184 table = new_lookup_table(9001);
186 ret = WIMLIB_ERR_NOMEM;
189 w->lookup_table = table;
197 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
199 return w->hdr.image_count;
202 int select_wim_image(WIMStruct *w, int image)
204 struct image_metadata *imd;
206 DEBUG("Selecting image %d", image);
208 if (image == w->current_image)
211 if (image < 1 || image > w->hdr.image_count) {
212 ERROR("Cannot select image %d: There are only %u images",
213 image, w->hdr.image_count);
214 return WIMLIB_ERR_INVALID_IMAGE;
218 /* If a valid image is currently selected, it can be freed if it is not
220 if (w->current_image != WIM_NO_IMAGE) {
221 imd = wim_get_current_image_metadata(w);
222 if (!imd->modified) {
223 DEBUG("Freeing image %u", w->current_image);
224 destroy_image_metadata(imd, NULL);
225 imd->root_dentry = NULL;
226 imd->security_data = NULL;
230 w->current_image = image;
231 imd = wim_get_current_image_metadata(w);
233 if (imd->root_dentry) {
237 DEBUG("Reading metadata resource specified by the following "
238 "lookup table entry:");
239 print_lookup_table_entry(imd->metadata_lte);
241 return read_metadata_resource(w, imd);
246 /* Returns the compression type of the WIM file. */
247 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
249 return wim_hdr_flags_compression_type(w->hdr.flags);
252 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
255 case WIM_COMPRESSION_TYPE_NONE:
257 case WIM_COMPRESSION_TYPE_LZX:
259 case WIM_COMPRESSION_TYPE_XPRESS:
267 * Returns the number of an image in the WIM file, given a string that is either
268 * the number of the image, or the name of the image. The images are numbered
271 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
277 if (!image_name_or_num)
280 if (strcmp(image_name_or_num, "all") == 0
281 || strcmp(image_name_or_num, "*") == 0)
282 return WIM_ALL_IMAGES;
283 image = strtol(image_name_or_num, &p, 10);
284 if (p != image_name_or_num && *p == '\0') {
285 if (image < 1 || image > w->hdr.image_count)
289 for (i = 1; i <= w->hdr.image_count; i++) {
290 if (strcmp(image_name_or_num,
291 wimlib_get_image_name(w, i)) == 0)
299 /* Prints some basic information about a WIM file. */
300 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
302 const struct wim_header *hdr;
305 puts("WIM Information:");
306 puts("----------------");
307 printf("Path: %s\n", w->filename);
308 fputs ("GUID: 0x", stdout);
309 print_byte_field(hdr->guid, WIM_GID_LEN);
311 printf("Image Count: %d\n", hdr->image_count);
312 printf("Compression: %s\n", wimlib_get_compression_type_string(
313 wimlib_get_compression_type(w)));
314 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
315 printf("Boot Index: %d\n", hdr->boot_idx);
316 printf("Size: %"PRIu64" bytes\n",
317 wim_info_get_total_bytes(w->wim_info));
318 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
322 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
324 return w->hdr.integrity.size != 0;
327 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
333 if (image == WIM_ALL_IMAGES) {
334 n = printf("Available Images:\n");
336 last = w->hdr.image_count;
337 } else if (image >= 1 && image <= w->hdr.image_count) {
338 n = printf("Information for Image %d\n", image);
342 printf("wimlib_print_available_images(): Invalid image %d",
346 for (i = 0; i < n - 1; i++)
349 for (i = first; i <= last; i++)
350 print_image_info(w->wim_info, i);
354 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
355 * not WIM_NO_IMAGE. */
356 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
359 return WIMLIB_ERR_INVALID_PARAM;
360 if (w->hdr.part_number != 1) {
361 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
362 w->hdr.part_number, w->hdr.total_parts);
363 ERROR("Select the first part of the split WIM to see the metadata.");
364 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
366 return for_image(w, image, print_metadata);
369 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
372 return WIMLIB_ERR_INVALID_PARAM;
373 if (w->hdr.part_number != 1) {
374 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
375 w->hdr.part_number, w->hdr.total_parts);
376 ERROR("Select the first part of the split WIM if you'd like to list the files.");
377 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
379 return for_image(w, image, print_files);
382 /* Sets the index of the bootable image. */
383 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
386 return WIMLIB_ERR_INVALID_PARAM;
387 if (w->hdr.total_parts != 1) {
388 ERROR("Cannot modify the boot index of a split WIM!");
389 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
391 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
392 return WIMLIB_ERR_INVALID_IMAGE;
393 w->hdr.boot_idx = boot_idx;
397 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
400 *total_parts_ret = w->hdr.total_parts;
401 return w->hdr.part_number;
405 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
407 return w->hdr.boot_idx;
411 * Begins the reading of a WIM file; opens the file and reads its header and
412 * lookup table, and optionally checks the integrity.
414 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
419 DEBUG("Reading the WIM file `%s'", in_wim_path);
421 w->filename = realpath(in_wim_path, NULL);
423 ERROR("Failed to allocate memory for WIM filename");
424 return WIMLIB_ERR_NOMEM;
427 w->fp = fopen(in_wim_path, "rb");
430 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
432 return WIMLIB_ERR_OPEN;
435 ret = read_header(w->fp, &w->hdr, open_flags);
439 DEBUG("Wim file contains %u images", w->hdr.image_count);
441 /* If the boot index is invalid, print a warning and set it to 0 */
442 if (w->hdr.boot_idx > w->hdr.image_count) {
443 WARNING("In `%s', image %u is marked as bootable, "
444 "but there are only %u images in the WIM",
445 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
449 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
450 ERROR("Invalid compression type (WIM header flags = %x)",
452 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
456 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
457 int integrity_status;
458 ret = check_wim_integrity(w,
459 open_flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
463 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
464 WARNING("No integrity information for `%s'; skipping "
465 "integrity check.", w->filename);
466 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
467 ERROR("WIM is not intact! (Failed integrity check)");
468 return WIMLIB_ERR_INTEGRITY;
472 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
473 ERROR("Didn't expect a compressed lookup table!");
474 ERROR("Ask the author to implement support for this.");
475 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
478 ret = read_lookup_table(w);
482 w->image_metadata = CALLOC(w->hdr.image_count,
483 sizeof(struct image_metadata));
485 if (!w->image_metadata) {
486 ERROR("Failed to allocate memory for %u metadata structures",
488 return WIMLIB_ERR_NOMEM;
490 w->current_image = 0;
492 DEBUG("Looking for metadata resources in the lookup table.");
494 /* Find the images in the WIM by searching the lookup table. */
495 ret = for_lookup_table_entry(w->lookup_table,
496 append_metadata_resource_entry, w);
501 /* Make sure all the expected images were found. (We already have
502 * returned false if *extra* images were found) */
503 if (w->current_image != w->hdr.image_count &&
504 w->hdr.part_number == 1)
506 ERROR("Only found %u images in WIM, but expected %u",
507 w->current_image, w->hdr.image_count);
508 return WIMLIB_ERR_IMAGE_COUNT;
512 /* Sort images by the position of their metadata resources. I'm
513 * assuming that is what determines the other of the images in the WIM
514 * file, rather than their order in the lookup table, which is random
515 * because of hashing. */
516 qsort(w->image_metadata, w->current_image,
517 sizeof(struct image_metadata), sort_image_metadata_by_position);
519 w->current_image = WIM_NO_IMAGE;
521 /* Read the XML data. */
522 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
523 &w->xml_data, &w->wim_info);
526 ERROR("Missing or invalid XML data");
530 xml_num_images = wim_info_get_num_images(w->wim_info);
531 if (xml_num_images != w->hdr.image_count) {
532 ERROR("In the file `%s', there are %u <IMAGE> elements "
533 "in the XML data,", in_wim_path, xml_num_images);
534 ERROR("but %u images in the WIM! There must be exactly one "
535 "<IMAGE> element per image.", w->hdr.image_count);
536 return WIMLIB_ERR_IMAGE_COUNT;
539 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
545 * Opens a WIM file and creates a WIMStruct for it.
547 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
553 DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
554 w = new_wim_struct();
556 ERROR("Failed to allocate memory for WIMStruct");
557 return WIMLIB_ERR_NOMEM;
560 ret = begin_read(w, wim_file, open_flags);
564 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
570 /* Frees the memory for the WIMStruct, including all internal memory; also
571 * closes all files associated with the WIMStruct. */
572 WIMLIBAPI void wimlib_free(WIMStruct *w)
574 DEBUG2("Freeing WIMStruct");
585 for (size_t i = 0; i < w->num_allocated_fps; i++)
587 fclose(w->fp_tab[i]);
590 pthread_mutex_destroy(&w->fp_tab_mutex);
593 free_lookup_table(w->lookup_table);
597 free_wim_info(w->wim_info);
598 if (w->image_metadata) {
599 for (uint i = 0; i < w->hdr.image_count; i++)
600 destroy_image_metadata(&w->image_metadata[i], NULL);
601 FREE(w->image_metadata);
605 DEBUG("Unmounting NTFS volume");
606 ntfs_umount(w->ntfs_vol, FALSE);