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/.
34 #include <ntfs-3g/volume.h>
37 #include "wimlib_internal.h"
39 #include "lookup_table.h"
43 static int print_metadata(WIMStruct *w)
45 DEBUG("Printing metadata for image %d", w->current_image);
46 print_security_data(wim_security_data(w));
47 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
52 static int print_files(WIMStruct *w)
54 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
58 WIMStruct *new_wim_struct()
60 return CALLOC(1, sizeof(WIMStruct));
64 * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
65 * is called on the WIM once for each image, with each image selected as the
66 * current image in turn. If @image is a certain image, @visitor is called on
67 * the WIM only once, with that image selected.
69 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
76 if (image == WIM_ALL_IMAGES) {
78 end = w->hdr.image_count;
79 } else if (image >= 1 && image <= w->hdr.image_count) {
83 return WIMLIB_ERR_INVALID_IMAGE;
85 for (i = start; i <= end; i++) {
86 ret = select_wim_image(w, i);
96 static int sort_image_metadata_by_position(const void *p1, const void *p2)
98 const struct image_metadata *imd1 = p1;
99 const struct image_metadata *imd2 = p2;
100 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
101 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
102 if (offset1 < offset2)
104 else if (offset1 > offset2)
111 * If @lte points to a metadata resource, append it to the list of metadata
112 * resources in the WIMStruct. Otherwise, do nothing.
114 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
117 WIMStruct *w = wim_p;
120 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
121 if (w->current_image == w->hdr.image_count) {
122 ERROR("Expected only %u images, but found more",
124 ret = WIMLIB_ERR_IMAGE_COUNT;
126 DEBUG("Found metadata resource for image %u at "
128 w->current_image + 1,
129 lte->resource_entry.offset);
131 w->current_image++].metadata_lte = lte;
137 /* Returns the compression type given in the flags of a WIM header. */
138 int wim_hdr_flags_compression_type(int wim_hdr_flags)
140 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
141 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
142 return WIM_COMPRESSION_TYPE_LZX;
143 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
144 return WIM_COMPRESSION_TYPE_XPRESS;
146 return WIM_COMPRESSION_TYPE_INVALID;
148 return WIM_COMPRESSION_TYPE_NONE;
153 * Creates a WIMStruct for a new WIM file.
155 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
158 struct lookup_table *table;
161 DEBUG("Creating new WIM with %s compression.",
162 wimlib_get_compression_type_string(ctype));
164 /* Allocate the WIMStruct. */
165 w = new_wim_struct();
167 return WIMLIB_ERR_NOMEM;
169 ret = init_header(&w->hdr, ctype);
173 table = new_lookup_table(9001);
175 ret = WIMLIB_ERR_NOMEM;
178 w->lookup_table = table;
186 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
188 return w->hdr.image_count;
191 int select_wim_image(WIMStruct *w, int image)
193 struct image_metadata *imd;
195 DEBUG("Selecting image %d", image);
197 if (image == w->current_image)
200 if (image < 1 || image > w->hdr.image_count) {
201 ERROR("Cannot select image %d: There are only %u images",
202 image, w->hdr.image_count);
203 return WIMLIB_ERR_INVALID_IMAGE;
207 /* If a valid image is currently selected, it can be freed if it is not
209 if (w->current_image != WIM_NO_IMAGE) {
210 imd = wim_get_current_image_metadata(w);
211 if (!imd->modified) {
212 DEBUG("Freeing image %u", w->current_image);
213 destroy_image_metadata(imd, NULL);
214 imd->root_dentry = NULL;
215 imd->security_data = NULL;
219 w->current_image = image;
220 imd = wim_get_current_image_metadata(w);
222 if (imd->root_dentry) {
226 DEBUG("Reading metadata resource specified by the following "
227 "lookup table entry:");
228 print_lookup_table_entry(imd->metadata_lte);
230 return read_metadata_resource(w, imd);
235 /* Returns the compression type of the WIM file. */
236 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
238 return wim_hdr_flags_compression_type(w->hdr.flags);
241 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
244 case WIM_COMPRESSION_TYPE_NONE:
246 case WIM_COMPRESSION_TYPE_LZX:
248 case WIM_COMPRESSION_TYPE_XPRESS:
256 * Returns the number of an image in the WIM file, given a string that is either
257 * the number of the image, or the name of the image. The images are numbered
260 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
266 if (!image_name_or_num)
269 if (strcmp(image_name_or_num, "all") == 0
270 || strcmp(image_name_or_num, "*") == 0)
271 return WIM_ALL_IMAGES;
272 image = strtol(image_name_or_num, &p, 10);
273 if (p != image_name_or_num && *p == '\0') {
274 if (image < 1 || image > w->hdr.image_count)
278 for (i = 1; i <= w->hdr.image_count; i++) {
279 if (strcmp(image_name_or_num,
280 wimlib_get_image_name(w, i)) == 0)
288 /* Prints some basic information about a WIM file. */
289 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
291 const struct wim_header *hdr;
294 puts("WIM Information:");
295 puts("----------------");
296 printf("Path: %s\n", w->filename);
297 fputs ("GUID: 0x", stdout);
298 print_byte_field(hdr->guid, WIM_GID_LEN);
300 printf("Image Count: %d\n", hdr->image_count);
301 printf("Compression: %s\n", wimlib_get_compression_type_string(
302 wimlib_get_compression_type(w)));
303 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
304 printf("Boot Index: %d\n", hdr->boot_idx);
305 printf("Size: %"PRIu64" bytes\n",
306 wim_info_get_total_bytes(w->wim_info));
307 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
311 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
313 return w->hdr.integrity.size != 0;
316 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
322 if (image == WIM_ALL_IMAGES) {
323 n = printf("Available Images:\n");
325 last = w->hdr.image_count;
326 } else if (image >= 1 && image <= w->hdr.image_count) {
327 n = printf("Information for Image %d\n", image);
331 printf("wimlib_print_available_images(): Invalid image %d",
335 for (i = 0; i < n - 1; i++)
338 for (i = first; i <= last; i++)
339 print_image_info(w->wim_info, i);
343 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
344 * not WIM_NO_IMAGE. */
345 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
348 return WIMLIB_ERR_INVALID_PARAM;
349 if (w->hdr.part_number != 1) {
350 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
351 w->hdr.part_number, w->hdr.total_parts);
352 ERROR("Select the first part of the split WIM to see the metadata.");
353 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
355 return for_image(w, image, print_metadata);
358 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
361 return WIMLIB_ERR_INVALID_PARAM;
362 if (w->hdr.part_number != 1) {
363 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
364 w->hdr.part_number, w->hdr.total_parts);
365 ERROR("Select the first part of the split WIM if you'd like to list the files.");
366 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
368 return for_image(w, image, print_files);
371 /* Sets the index of the bootable image. */
372 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
375 return WIMLIB_ERR_INVALID_PARAM;
376 if (w->hdr.total_parts != 1) {
377 ERROR("Cannot modify the boot index of a split WIM!");
378 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
380 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
381 return WIMLIB_ERR_INVALID_IMAGE;
382 w->hdr.boot_idx = boot_idx;
386 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
389 *total_parts_ret = w->hdr.total_parts;
390 return w->hdr.part_number;
394 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
396 return w->hdr.boot_idx;
400 * Begins the reading of a WIM file; opens the file and reads its header and
401 * lookup table, and optionally checks the integrity.
403 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags)
408 DEBUG("Reading the WIM file `%s'", in_wim_path);
410 w->filename = STRDUP(in_wim_path);
412 ERROR("Failed to allocate memory for WIM filename");
413 return WIMLIB_ERR_NOMEM;
416 w->fp = fopen(in_wim_path, "rb");
419 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
421 return WIMLIB_ERR_OPEN;
424 ret = read_header(w->fp, &w->hdr, open_flags);
428 DEBUG("Wim file contains %u images", w->hdr.image_count);
430 /* If the boot index is invalid, print a warning and set it to 0 */
431 if (w->hdr.boot_idx > w->hdr.image_count) {
432 WARNING("In `%s', image %u is marked as bootable, "
433 "but there are only %u images in the WIM",
434 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
438 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
439 ERROR("Invalid compression type (WIM header flags = %x)",
441 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
445 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
446 int integrity_status;
447 ret = check_wim_integrity(w,
448 open_flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
452 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
453 WARNING("No integrity information for `%s'; skipping "
454 "integrity check.", w->filename);
455 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
456 ERROR("WIM is not intact! (Failed integrity check)");
457 return WIMLIB_ERR_INTEGRITY;
461 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
462 ERROR("Didn't expect a compressed lookup table!");
463 ERROR("Ask the author to implement support for this.");
464 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
467 ret = read_lookup_table(w);
471 w->image_metadata = CALLOC(w->hdr.image_count,
472 sizeof(struct image_metadata));
474 if (!w->image_metadata) {
475 ERROR("Failed to allocate memory for %u metadata structures",
477 return WIMLIB_ERR_NOMEM;
479 w->current_image = 0;
481 DEBUG("Looking for metadata resources in the lookup table.");
483 /* Find the images in the WIM by searching the lookup table. */
484 ret = for_lookup_table_entry(w->lookup_table,
485 append_metadata_resource_entry, w);
490 /* Make sure all the expected images were found. (We already have
491 * returned false if *extra* images were found) */
492 if (w->current_image != w->hdr.image_count &&
493 w->hdr.part_number == 1)
495 ERROR("Only found %u images in WIM, but expected %u",
496 w->current_image, w->hdr.image_count);
497 return WIMLIB_ERR_IMAGE_COUNT;
501 /* Sort images by the position of their metadata resources. I'm
502 * assuming that is what determines the other of the images in the WIM
503 * file, rather than their order in the lookup table, which is random
504 * because of hashing. */
505 qsort(w->image_metadata, w->current_image,
506 sizeof(struct image_metadata), sort_image_metadata_by_position);
508 w->current_image = WIM_NO_IMAGE;
510 /* Read the XML data. */
511 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
512 &w->xml_data, &w->wim_info);
515 ERROR("Missing or invalid XML data");
519 xml_num_images = wim_info_get_num_images(w->wim_info);
520 if (xml_num_images != w->hdr.image_count) {
521 ERROR("In the file `%s', there are %u <IMAGE> elements "
522 "in the XML data,", in_wim_path, xml_num_images);
523 ERROR("but %u images in the WIM! There must be exactly one "
524 "<IMAGE> element per image.", w->hdr.image_count);
525 return WIMLIB_ERR_IMAGE_COUNT;
528 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
534 * Opens a WIM file and creates a WIMStruct for it.
536 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
542 DEBUG("wim_file = `%s', open_flags = %#x", wim_file, open_flags);
543 w = new_wim_struct();
545 ERROR("Failed to allocate memory for WIMStruct");
546 return WIMLIB_ERR_NOMEM;
549 ret = begin_read(w, wim_file, open_flags);
553 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
559 /* Frees the memory for the WIMStruct, including all internal memory; also
560 * closes all files associated with the WIMStruct. */
561 WIMLIBAPI void wimlib_free(WIMStruct *w)
563 DEBUG2("Freeing WIMStruct");
572 free_lookup_table(w->lookup_table);
576 free_wim_info(w->wim_info);
577 if (w->image_metadata) {
578 for (uint i = 0; i < w->hdr.image_count; i++)
579 destroy_image_metadata(&w->image_metadata[i], NULL);
580 FREE(w->image_metadata);
584 DEBUG("Unmounting NTFS volume");
585 ntfs_umount(w->ntfs_vol, FALSE);