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/.
27 #include "wimlib_internal.h"
29 #include "lookup_table.h"
34 #include <ntfs-3g/volume.h>
37 static int print_metadata(WIMStruct *w)
39 print_security_data(wim_security_data(w));
40 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
45 static int print_files(WIMStruct *w)
47 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
51 WIMStruct *new_wim_struct()
53 return CALLOC(1, sizeof(WIMStruct));
57 * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
58 * is called on the WIM once for each image, with each image selected as the
59 * current image in turn. If @image is a certain image, @visitor is called on
60 * the WIM only once, with that image selected.
62 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
68 if (image == WIM_ALL_IMAGES) {
70 end = w->hdr.image_count;
72 if (image < 1 || image > w->hdr.image_count)
73 return WIMLIB_ERR_INVALID_IMAGE;
77 for (; i <= end; i++) {
78 ret = wimlib_select_image(w, i);
88 static int sort_image_metadata_by_position(const void *p1, const void *p2)
90 struct image_metadata *bmd1 = (struct image_metadata*)p1;
91 struct image_metadata *bmd2 = (struct image_metadata*)p2;
92 u64 offset1 = bmd1->metadata_lte->resource_entry.offset;
93 u64 offset2 = bmd2->metadata_lte->resource_entry.offset;
94 if (offset1 < offset2)
96 else if (offset1 > offset2)
103 * If @lte points to a metadata resource, append it to the list of metadata
104 * resources in the WIMStruct. Otherwise, do nothing.
106 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
109 WIMStruct *w = wim_p;
111 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
112 /*fprintf(stderr, "found mlte at %u\n", lte->resource_entry.offset);*/
113 if (w->current_image == w->hdr.image_count) {
114 ERROR("Expected only %u images, but found more",
116 return WIMLIB_ERR_IMAGE_COUNT;
118 DEBUG("Found metadata resource for image %u at "
120 w->current_image + 1,
121 lte->resource_entry.offset);
123 w->current_image++].metadata_lte = lte;
129 /* Returns the compression type given in the flags of a WIM header. */
130 int wim_hdr_flags_compression_type(int wim_hdr_flags)
132 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
133 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
134 return WIM_COMPRESSION_TYPE_LZX;
135 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
136 return WIM_COMPRESSION_TYPE_XPRESS;
138 return WIM_COMPRESSION_TYPE_INVALID;
140 return WIM_COMPRESSION_TYPE_NONE;
145 * Creates a WIMStruct for a new WIM file.
147 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
150 struct lookup_table *table;
153 DEBUG("Creating new WIM with %s compression.",
154 wimlib_get_compression_type_string(ctype));
156 /* Allocate the WIMStruct. */
157 w = new_wim_struct();
159 return WIMLIB_ERR_NOMEM;
161 ret = init_header(&w->hdr, ctype);
165 table = new_lookup_table(9001);
167 ret = WIMLIB_ERR_NOMEM;
170 w->lookup_table = table;
178 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
180 return w->hdr.image_count;
183 int wimlib_select_image(WIMStruct *w, int image)
185 struct image_metadata *imd;
187 DEBUG("Selecting image %d", image);
189 if (image == w->current_image)
192 if (image < 1 || image > w->hdr.image_count) {
193 ERROR("Cannot select image %d: There are only %u images",
194 image, w->hdr.image_count);
195 return WIMLIB_ERR_INVALID_IMAGE;
199 /* If a valid image is currently selected, it can be freed if it is not
201 if (w->current_image != WIM_NO_IMAGE) {
202 imd = wim_get_current_image_metadata(w);
203 if (!imd->modified) {
204 DEBUG("Freeing image %u", w->current_image);
205 destroy_image_metadata(imd, NULL);
206 imd->root_dentry = NULL;
207 imd->security_data = NULL;
212 w->current_image = image;
213 imd = wim_get_current_image_metadata(w);
215 if (imd->root_dentry) {
219 DEBUG("Reading metadata resource specified by the following "
220 "lookup table entry:");
221 print_lookup_table_entry(imd->metadata_lte);
223 return read_metadata_resource(w, imd);
228 /* Returns the compression type of the WIM file. */
229 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
231 return wim_hdr_flags_compression_type(w->hdr.flags);
234 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
237 case WIM_COMPRESSION_TYPE_NONE:
239 case WIM_COMPRESSION_TYPE_LZX:
241 case WIM_COMPRESSION_TYPE_XPRESS:
249 * Returns the number of an image in the WIM file, given a string that is either
250 * the number of the image, or the name of the image. The images are numbered
253 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
259 if (!image_name_or_num)
262 if (strcmp(image_name_or_num, "all") == 0)
263 return WIM_ALL_IMAGES;
264 image = strtol(image_name_or_num, &p, 10);
265 if (p != image_name_or_num && *p == '\0') {
266 if (image < 1 || image > w->hdr.image_count)
270 for (i = 1; i <= w->hdr.image_count; i++) {
271 if (strcmp(image_name_or_num,
272 wimlib_get_image_name(w, i)) == 0)
280 /* Prints some basic information about a WIM file. */
281 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
283 const struct wim_header *hdr;
286 puts("WIM Information:");
287 puts("----------------");
288 printf("Path: %s\n", w->filename);
289 fputs ("GUID: 0x", stdout);
290 print_byte_field(hdr->guid, WIM_GID_LEN);
292 printf("Image Count: %d\n", hdr->image_count);
293 printf("Compression: %s\n", wimlib_get_compression_type_string(
294 wimlib_get_compression_type(w)));
295 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
296 printf("Boot Index: %d\n", hdr->boot_idx);
297 printf("Size: %"PRIu64" bytes\n",
298 wim_info_get_total_bytes(w->wim_info));
299 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
303 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
305 return w->hdr.integrity.size != 0;
308 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
310 if (image == WIM_ALL_IMAGES) {
311 puts("Available Images:");
312 puts("-----------------");
317 n = printf("Information for Image %d\n", image);
318 for (i = 0; i < n - 1; i++)
323 print_image_info(w->wim_info, image);
327 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
328 * not WIM_NO_IMAGE. */
329 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
331 if (image == WIM_ALL_IMAGES)
332 DEBUG("Printing metadata for all images");
334 DEBUG("Printing metadata for image %d", image);
335 return for_image(w, image, print_metadata);
338 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
340 return for_image(w, image, print_files);
343 /* Sets the index of the bootable image. */
344 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
346 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
347 return WIMLIB_ERR_INVALID_IMAGE;
348 w->hdr.boot_idx = boot_idx;
350 memset(&w->hdr.boot_metadata_res_entry, 0,
351 sizeof(struct resource_entry));
353 memcpy(&w->hdr.boot_metadata_res_entry,
355 boot_idx - 1].metadata_lte->resource_entry,
356 sizeof(struct resource_entry));
361 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
364 *total_parts_ret = w->hdr.total_parts;
365 return w->hdr.part_number;
369 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
371 return w->hdr.boot_idx;
375 * Begins the reading of a WIM file; opens the file and reads its header and
376 * lookup table, and optionally checks the integrity.
378 static int begin_read(WIMStruct *w, const char *in_wim_path, int flags)
383 DEBUG("Reading the WIM file `%s'", in_wim_path);
385 w->filename = STRDUP(in_wim_path);
387 ERROR("Failed to allocate memory for WIM filename");
388 return WIMLIB_ERR_NOMEM;
391 w->fp = fopen(in_wim_path, "rb");
394 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
396 return WIMLIB_ERR_OPEN;
399 ret = read_header(w->fp, &w->hdr, flags & WIMLIB_OPEN_FLAG_SPLIT_OK);
403 DEBUG("Wim file contains %u images", w->hdr.image_count);
405 /* If the boot index is invalid, print a warning and set it to 0 */
406 if (w->hdr.boot_idx > w->hdr.image_count) {
407 WARNING("In `%s', image %u is marked as bootable, "
408 "but there are only %u images",
409 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
413 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
414 ERROR("Invalid compression type (WIM header flags = %x)",
416 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
420 if (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
421 int integrity_status;
422 ret = check_wim_integrity(w,
423 flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
426 ERROR("Error in check_wim_integrity()");
429 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
430 WARNING("No integrity information for `%s'; skipping "
431 "integrity check.", w->filename);
432 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
433 ERROR("WIM is not intact! (Failed integrity check)");
434 return WIMLIB_ERR_INTEGRITY;
438 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
439 ERROR("Didn't expect a compressed lookup table!");
440 ERROR("Ask the author to implement support for this.");
441 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
444 ret = read_lookup_table(w);
448 w->image_metadata = CALLOC(w->hdr.image_count,
449 sizeof(struct image_metadata));
451 if (!w->image_metadata) {
452 ERROR("Failed to allocate memory for %u metadata structures",
454 return WIMLIB_ERR_NOMEM;
456 w->current_image = 0;
458 DEBUG("Looking for metadata resources in the lookup table.");
460 /* Find the images in the WIM by searching the lookup table. */
461 ret = for_lookup_table_entry(w->lookup_table,
462 append_metadata_resource_entry, w);
467 /* Make sure all the expected images were found. (We already have
468 * returned false if *extra* images were found) */
469 if (w->current_image != w->hdr.image_count && w->hdr.part_number == 1) {
470 ERROR("Only found %u images in WIM, but expected %u",
471 w->current_image, w->hdr.image_count);
472 return WIMLIB_ERR_IMAGE_COUNT;
476 /* Sort images by the position of their metadata resources. I'm
477 * assuming that is what determines the other of the images in the WIM
478 * file, rather than their order in the lookup table, which is random
479 * because of hashing. */
480 qsort(w->image_metadata, w->current_image,
481 sizeof(struct image_metadata), sort_image_metadata_by_position);
483 w->current_image = WIM_NO_IMAGE;
485 /* Read the XML data. */
486 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
487 &w->xml_data, &w->wim_info);
490 ERROR("Missing or invalid XML data");
494 xml_num_images = wim_info_get_num_images(w->wim_info);
495 if (xml_num_images != w->hdr.image_count) {
496 ERROR("In the file `%s', there are %u <IMAGE> elements "
497 "in the XML data,", in_wim_path, xml_num_images);
498 ERROR("but %u images in the WIM! There must be exactly one "
499 "<IMAGE> element per image.", w->hdr.image_count);
500 return WIMLIB_ERR_IMAGE_COUNT;
503 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
509 * Opens a WIM file and creates a WIMStruct for it.
511 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int flags,
517 DEBUG("wim_file = `%s', flags = %#x", wim_file, flags);
518 w = new_wim_struct();
520 ERROR("Failed to allocate memory for WIMStruct");
521 return WIMLIB_ERR_NOMEM;
524 ret = begin_read(w, wim_file, flags);
526 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
534 /* Frees the memory for the WIMStruct, including all internal memory; also
535 * closes all files associated with the WIMStruct. */
536 WIMLIBAPI void wimlib_free(WIMStruct *w)
538 DEBUG("Freeing WIMStruct");
547 free_lookup_table(w->lookup_table);
551 free_wim_info(w->wim_info);
552 if (w->image_metadata) {
553 for (uint i = 0; i < w->hdr.image_count; i++)
554 destroy_image_metadata(&w->image_metadata[i], NULL);
555 FREE(w->image_metadata);
559 DEBUG("Unmounting NTFS volume");
560 ntfs_umount(w->ntfs_vol, FALSE);