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/.
32 #include <ntfs-3g/volume.h>
35 #include "wimlib_internal.h"
37 #include "lookup_table.h"
41 static int print_metadata(WIMStruct *w)
43 DEBUG("Printing metadata for image %d", w->current_image);
44 print_security_data(wim_security_data(w));
45 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
50 static int print_files(WIMStruct *w)
52 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
56 WIMStruct *new_wim_struct()
58 return CALLOC(1, sizeof(WIMStruct));
62 * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
63 * is called on the WIM once for each image, with each image selected as the
64 * current image in turn. If @image is a certain image, @visitor is called on
65 * the WIM only once, with that image selected.
67 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
74 if (image == WIM_ALL_IMAGES) {
76 end = w->hdr.image_count;
77 } else if (image >= 1 && image <= w->hdr.image_count) {
81 return WIMLIB_ERR_INVALID_IMAGE;
83 for (i = start; i <= end; i++) {
84 ret = select_wim_image(w, i);
94 static int sort_image_metadata_by_position(const void *p1, const void *p2)
96 const struct image_metadata *imd1 = p1;
97 const struct image_metadata *imd2 = p2;
98 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
99 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
100 if (offset1 < offset2)
102 else if (offset1 > offset2)
109 * If @lte points to a metadata resource, append it to the list of metadata
110 * resources in the WIMStruct. Otherwise, do nothing.
112 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
115 WIMStruct *w = wim_p;
118 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
119 if (w->current_image == w->hdr.image_count) {
120 ERROR("Expected only %u images, but found more",
122 ret = WIMLIB_ERR_IMAGE_COUNT;
124 DEBUG("Found metadata resource for image %u at "
126 w->current_image + 1,
127 lte->resource_entry.offset);
129 w->current_image++].metadata_lte = lte;
135 /* Returns the compression type given in the flags of a WIM header. */
136 int wim_hdr_flags_compression_type(int wim_hdr_flags)
138 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
139 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
140 return WIM_COMPRESSION_TYPE_LZX;
141 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
142 return WIM_COMPRESSION_TYPE_XPRESS;
144 return WIM_COMPRESSION_TYPE_INVALID;
146 return WIM_COMPRESSION_TYPE_NONE;
151 * Creates a WIMStruct for a new WIM file.
153 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
156 struct lookup_table *table;
159 DEBUG("Creating new WIM with %s compression.",
160 wimlib_get_compression_type_string(ctype));
162 /* Allocate the WIMStruct. */
163 w = new_wim_struct();
165 return WIMLIB_ERR_NOMEM;
167 ret = init_header(&w->hdr, ctype);
171 table = new_lookup_table(9001);
173 ret = WIMLIB_ERR_NOMEM;
176 w->lookup_table = table;
184 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
186 return w->hdr.image_count;
189 int select_wim_image(WIMStruct *w, int image)
191 struct image_metadata *imd;
193 DEBUG("Selecting image %d", image);
195 if (image == w->current_image)
198 if (image < 1 || image > w->hdr.image_count) {
199 ERROR("Cannot select image %d: There are only %u images",
200 image, w->hdr.image_count);
201 return WIMLIB_ERR_INVALID_IMAGE;
205 /* If a valid image is currently selected, it can be freed if it is not
207 if (w->current_image != WIM_NO_IMAGE) {
208 imd = wim_get_current_image_metadata(w);
209 if (!imd->modified) {
210 DEBUG("Freeing image %u", w->current_image);
211 destroy_image_metadata(imd, NULL);
212 imd->root_dentry = NULL;
213 imd->security_data = NULL;
217 w->current_image = image;
218 imd = wim_get_current_image_metadata(w);
220 if (imd->root_dentry) {
224 DEBUG("Reading metadata resource specified by the following "
225 "lookup table entry:");
226 print_lookup_table_entry(imd->metadata_lte);
228 return read_metadata_resource(w, imd);
233 /* Returns the compression type of the WIM file. */
234 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
236 return wim_hdr_flags_compression_type(w->hdr.flags);
239 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
242 case WIM_COMPRESSION_TYPE_NONE:
244 case WIM_COMPRESSION_TYPE_LZX:
246 case WIM_COMPRESSION_TYPE_XPRESS:
254 * Returns the number of an image in the WIM file, given a string that is either
255 * the number of the image, or the name of the image. The images are numbered
258 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
264 if (!image_name_or_num)
267 if (strcmp(image_name_or_num, "all") == 0
268 || strcmp(image_name_or_num, "*") == 0)
269 return WIM_ALL_IMAGES;
270 image = strtol(image_name_or_num, &p, 10);
271 if (p != image_name_or_num && *p == '\0') {
272 if (image < 1 || image > w->hdr.image_count)
276 for (i = 1; i <= w->hdr.image_count; i++) {
277 if (strcmp(image_name_or_num,
278 wimlib_get_image_name(w, i)) == 0)
286 /* Prints some basic information about a WIM file. */
287 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
289 const struct wim_header *hdr;
292 puts("WIM Information:");
293 puts("----------------");
294 printf("Path: %s\n", w->filename);
295 fputs ("GUID: 0x", stdout);
296 print_byte_field(hdr->guid, WIM_GID_LEN);
298 printf("Image Count: %d\n", hdr->image_count);
299 printf("Compression: %s\n", wimlib_get_compression_type_string(
300 wimlib_get_compression_type(w)));
301 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
302 printf("Boot Index: %d\n", hdr->boot_idx);
303 printf("Size: %"PRIu64" bytes\n",
304 wim_info_get_total_bytes(w->wim_info));
305 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
309 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
311 return w->hdr.integrity.size != 0;
314 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
320 if (image == WIM_ALL_IMAGES) {
321 n = printf("Available Images:\n");
323 last = w->hdr.image_count;
324 } else if (image >= 1 && image <= w->hdr.image_count) {
325 n = printf("Information for Image %d\n", image);
329 printf("wimlib_print_available_images(): Invalid image %d",
333 for (i = 0; i < n - 1; i++)
336 for (i = first; i <= last; i++)
337 print_image_info(w->wim_info, i);
341 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
342 * not WIM_NO_IMAGE. */
343 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
346 return WIMLIB_ERR_INVALID_PARAM;
347 if (w->hdr.part_number != 1) {
348 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
349 w->hdr.part_number, w->hdr.total_parts);
350 ERROR("Select the first part of the split WIM to see the metadata.");
351 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
353 return for_image(w, image, print_metadata);
356 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
359 return WIMLIB_ERR_INVALID_PARAM;
360 if (w->hdr.part_number != 1) {
361 ERROR("Cannot list the files 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 if you'd like to list the files.");
364 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
366 return for_image(w, image, print_files);
369 /* Sets the index of the bootable image. */
370 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
373 return WIMLIB_ERR_INVALID_PARAM;
374 if (w->hdr.total_parts != 1) {
375 ERROR("Cannot modify the boot index of a split WIM!");
376 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
378 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
379 return WIMLIB_ERR_INVALID_IMAGE;
380 w->hdr.boot_idx = boot_idx;
384 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
387 *total_parts_ret = w->hdr.total_parts;
388 return w->hdr.part_number;
392 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
394 return w->hdr.boot_idx;
398 * Begins the reading of a WIM file; opens the file and reads its header and
399 * lookup table, and optionally checks the integrity.
401 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
406 DEBUG("Reading the WIM file `%s'", in_wim_path);
408 w->filename = STRDUP(in_wim_path);
410 ERROR("Failed to allocate memory for WIM filename");
411 return WIMLIB_ERR_NOMEM;
414 w->fp = fopen(in_wim_path, "rb");
417 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
419 return WIMLIB_ERR_OPEN;
422 ret = read_header(w->fp, &w->hdr, open_flags);
426 DEBUG("Wim file contains %u images", w->hdr.image_count);
428 /* If the boot index is invalid, print a warning and set it to 0 */
429 if (w->hdr.boot_idx > w->hdr.image_count) {
430 WARNING("In `%s', image %u is marked as bootable, "
431 "but there are only %u images in the WIM",
432 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
436 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
437 ERROR("Invalid compression type (WIM header flags = %x)",
439 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
443 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
444 int integrity_status;
445 ret = check_wim_integrity(w,
446 open_flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
450 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
451 WARNING("No integrity information for `%s'; skipping "
452 "integrity check.", w->filename);
453 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
454 ERROR("WIM is not intact! (Failed integrity check)");
455 return WIMLIB_ERR_INTEGRITY;
459 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
460 ERROR("Didn't expect a compressed lookup table!");
461 ERROR("Ask the author to implement support for this.");
462 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
465 ret = read_lookup_table(w);
469 w->image_metadata = CALLOC(w->hdr.image_count,
470 sizeof(struct image_metadata));
472 if (!w->image_metadata) {
473 ERROR("Failed to allocate memory for %u metadata structures",
475 return WIMLIB_ERR_NOMEM;
477 w->current_image = 0;
479 DEBUG("Looking for metadata resources in the lookup table.");
481 /* Find the images in the WIM by searching the lookup table. */
482 ret = for_lookup_table_entry(w->lookup_table,
483 append_metadata_resource_entry, w);
488 /* Make sure all the expected images were found. (We already have
489 * returned false if *extra* images were found) */
490 if (w->current_image != w->hdr.image_count &&
491 w->hdr.part_number == 1)
493 ERROR("Only found %u images in WIM, but expected %u",
494 w->current_image, w->hdr.image_count);
495 return WIMLIB_ERR_IMAGE_COUNT;
499 /* Sort images by the position of their metadata resources. I'm
500 * assuming that is what determines the other of the images in the WIM
501 * file, rather than their order in the lookup table, which is random
502 * because of hashing. */
503 qsort(w->image_metadata, w->current_image,
504 sizeof(struct image_metadata), sort_image_metadata_by_position);
506 w->current_image = WIM_NO_IMAGE;
508 /* Read the XML data. */
509 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
510 &w->xml_data, &w->wim_info);
513 ERROR("Missing or invalid XML data");
517 xml_num_images = wim_info_get_num_images(w->wim_info);
518 if (xml_num_images != w->hdr.image_count) {
519 ERROR("In the file `%s', there are %u <IMAGE> elements "
520 "in the XML data,", in_wim_path, xml_num_images);
521 ERROR("but %u images in the WIM! There must be exactly one "
522 "<IMAGE> element per image.", w->hdr.image_count);
523 return WIMLIB_ERR_IMAGE_COUNT;
526 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
532 * Opens a WIM file and creates a WIMStruct for it.
534 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
540 DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
541 w = new_wim_struct();
543 ERROR("Failed to allocate memory for WIMStruct");
544 return WIMLIB_ERR_NOMEM;
547 ret = begin_read(w, wim_file, open_flags);
551 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
557 /* Frees the memory for the WIMStruct, including all internal memory; also
558 * closes all files associated with the WIMStruct. */
559 WIMLIBAPI void wimlib_free(WIMStruct *w)
561 DEBUG2("Freeing WIMStruct");
570 free_lookup_table(w->lookup_table);
574 free_wim_info(w->wim_info);
575 if (w->image_metadata) {
576 for (uint i = 0; i < w->hdr.image_count; i++)
577 destroy_image_metadata(&w->image_metadata[i], NULL);
578 FREE(w->image_metadata);
582 DEBUG("Unmounting NTFS volume");
583 ntfs_umount(w->ntfs_vol, FALSE);