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 Lesser General Public License as published by the Free
15 * Software Foundation; either version 2.1 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 Lesser General Public License for more
23 * You should have received a copy of the GNU Lesser 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"
33 static int print_metadata(WIMStruct *w)
35 print_security_data(wim_security_data(w));
36 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
41 static int print_files(WIMStruct *w)
43 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
47 WIMStruct *new_wim_struct()
49 return CALLOC(1, sizeof(WIMStruct));
53 * Calls a function on images in the WIM. If @image is WIM_ALL_IMAGES, @visitor
54 * is called on the WIM once for each image, with each image selected as the
55 * current image in turn. If @image is a certain image, @visitor is called on
56 * the WIM only once, with that image selected.
58 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
64 DEBUG("for_image(w = %p, image = %d, visitor = %p)", w, image, visitor);
66 if (image == WIM_ALL_IMAGES) {
68 end = w->hdr.image_count;
70 if (image < 1 || image > w->hdr.image_count)
71 return WIMLIB_ERR_INVALID_IMAGE;
75 for (; i <= end; i++) {
76 ret = wimlib_select_image(w, i);
86 static int sort_image_metadata_by_position(const void *p1, const void *p2)
88 struct image_metadata *bmd1 = (struct image_metadata*)p1;
89 struct image_metadata *bmd2 = (struct image_metadata*)p2;
90 u64 offset1 = bmd1->metadata_lte->resource_entry.offset;
91 u64 offset2 = bmd2->metadata_lte->resource_entry.offset;
92 if (offset1 < offset2)
94 else if (offset1 > offset2)
101 * If @lte points to a metadata resource, append it to the list of metadata
102 * resources in the WIMStruct. Otherwise, do nothing.
104 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
107 WIMStruct *w = wim_p;
109 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
110 /*fprintf(stderr, "found mlte at %u\n", lte->resource_entry.offset);*/
111 if (w->current_image == w->hdr.image_count) {
112 ERROR("Expected only %u images, but found more",
114 return WIMLIB_ERR_IMAGE_COUNT;
116 DEBUG("Found metadata resource for image %u at "
118 w->current_image + 1,
119 lte->resource_entry.offset);
121 w->current_image++].metadata_lte = lte;
127 /* Returns the compression type given in the flags of a WIM header. */
128 int wim_hdr_flags_compression_type(int wim_hdr_flags)
130 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
131 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
132 return WIM_COMPRESSION_TYPE_LZX;
133 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
134 return WIM_COMPRESSION_TYPE_XPRESS;
136 return WIM_COMPRESSION_TYPE_INVALID;
138 return WIM_COMPRESSION_TYPE_NONE;
142 int wim_resource_compression_type(const WIMStruct *w,
143 const struct resource_entry *entry)
145 int wim_ctype = wimlib_get_compression_type(w);
146 return resource_compression_type(wim_ctype, entry->flags);
150 * Creates a WIMStruct for a new WIM file.
152 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
155 struct lookup_table *table;
158 DEBUG("Creating new WIM with %s compression.",
159 wimlib_get_compression_type_string(ctype));
161 /* Allocate the WIMStruct. */
162 w = new_wim_struct();
164 return WIMLIB_ERR_NOMEM;
166 ret = init_header(&w->hdr, ctype);
170 table = new_lookup_table(9001);
172 ret = WIMLIB_ERR_NOMEM;
175 w->lookup_table = table;
183 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
185 return w->hdr.image_count;
188 int wimlib_select_image(WIMStruct *w, int image)
190 struct image_metadata *imd;
192 DEBUG("Selecting image %d", image);
194 if (image == w->current_image)
197 if (image < 1 || image > w->hdr.image_count) {
198 ERROR("Cannot select image %d: There are only %u images",
199 image, w->hdr.image_count);
200 return WIMLIB_ERR_INVALID_IMAGE;
204 /* If a valid image is currently selected, it can be freed if it is not
206 if (w->current_image != WIM_NO_IMAGE) {
207 imd = wim_get_current_image_metadata(w);
208 if (!imd->modified) {
209 DEBUG("Freeing image %u", w->current_image);
210 destroy_image_metadata(imd, NULL);
211 imd->root_dentry = NULL;
212 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->fp,
229 wimlib_get_compression_type(w),
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 return WIM_ALL_IMAGES;
271 image = strtol(image_name_or_num, &p, 10);
272 if (p != image_name_or_num && *p == '\0') {
273 if (image < 1 || image > w->hdr.image_count)
277 for (i = 1; i <= w->hdr.image_count; i++) {
278 if (strcmp(image_name_or_num,
279 wimlib_get_image_name(w, i)) == 0)
287 /* Prints some basic information about a WIM file. */
288 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
290 const struct wim_header *hdr;
293 puts("WIM Information:");
294 puts("----------------");
295 printf("Path: %s\n", w->filename);
296 fputs ("GUID: 0x", stdout);
297 print_byte_field(hdr->guid, WIM_GID_LEN);
299 printf("Image Count: %d\n", hdr->image_count);
300 printf("Compression: %s\n", wimlib_get_compression_type_string(
301 wimlib_get_compression_type(w)));
302 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
303 printf("Boot Index: %d\n", hdr->boot_idx);
304 printf("Size: %"PRIu64" bytes\n",
305 wim_info_get_total_bytes(w->wim_info));
306 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
310 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
312 return w->hdr.integrity.size != 0;
315 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
317 if (image == WIM_ALL_IMAGES) {
318 puts("Available Images:");
319 puts("-----------------");
324 n = printf("Information for Image %d\n", image);
325 for (i = 0; i < n - 1; i++)
330 print_image_info(w->wim_info, image);
334 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
335 * not WIM_NO_IMAGE. */
336 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
338 return for_image(w, image, print_metadata);
341 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
343 return for_image(w, image, print_files);
346 /* Sets the index of the bootable image. */
347 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
349 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
350 return WIMLIB_ERR_INVALID_IMAGE;
351 w->hdr.boot_idx = boot_idx;
353 memset(&w->hdr.boot_metadata_res_entry, 0,
354 sizeof(struct resource_entry));
356 memcpy(&w->hdr.boot_metadata_res_entry,
358 boot_idx - 1].metadata_lte->resource_entry,
359 sizeof(struct resource_entry));
364 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
367 *total_parts_ret = w->hdr.total_parts;
368 return w->hdr.part_number;
372 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
374 return w->hdr.boot_idx;
378 * Begins the reading of a WIM file; opens the file and reads its header and
379 * lookup table, and optionally checks the integrity.
381 static int begin_read(WIMStruct *w, const char *in_wim_path, int flags)
386 DEBUG("Reading the WIM file `%s'", in_wim_path);
388 w->filename = STRDUP(in_wim_path);
390 ERROR("Failed to allocate memory for WIM filename");
391 return WIMLIB_ERR_NOMEM;
394 w->fp = fopen(in_wim_path, "rb");
397 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
399 return WIMLIB_ERR_OPEN;
402 ret = read_header(w->fp, &w->hdr, flags & WIMLIB_OPEN_FLAG_SPLIT_OK);
406 DEBUG("Wim file contains %u images", w->hdr.image_count);
408 /* If the boot index is invalid, print a warning and set it to 0 */
409 if (w->hdr.boot_idx > w->hdr.image_count) {
410 WARNING("In `%s', image %u is marked as bootable, "
411 "but there are only %u images",
412 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
416 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
417 ERROR("Invalid compression type (WIM header flags = %x)",
419 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
423 if (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
424 int integrity_status;
425 ret = check_wim_integrity(w,
426 flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
429 ERROR("Error in check_wim_integrity()");
432 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
433 WARNING("No integrity information for `%s'; skipping "
434 "integrity check.", w->filename);
435 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
436 ERROR("WIM is not intact! (Failed integrity check)");
437 return WIMLIB_ERR_INTEGRITY;
441 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
442 ERROR("Didn't expect a compressed lookup table!");
443 ERROR("Ask the author to implement support for this.");
444 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
447 ret = read_lookup_table(w->fp, w->hdr.lookup_table_res_entry.offset,
448 w->hdr.lookup_table_res_entry.size,
453 w->image_metadata = CALLOC(w->hdr.image_count,
454 sizeof(struct image_metadata));
456 if (!w->image_metadata) {
457 ERROR("Failed to allocate memory for %u metadata structures",
459 return WIMLIB_ERR_NOMEM;
461 w->current_image = 0;
463 DEBUG("Looking for metadata resources in the lookup table.");
465 /* Find the images in the WIM by searching the lookup table. */
466 ret = for_lookup_table_entry(w->lookup_table,
467 append_metadata_resource_entry, w);
472 /* Make sure all the expected images were found. (We already have
473 * returned false if *extra* images were found) */
474 if (w->current_image != w->hdr.image_count && w->hdr.part_number == 1) {
475 ERROR("Only found %u images in WIM, but expected %u",
476 w->current_image, w->hdr.image_count);
477 return WIMLIB_ERR_IMAGE_COUNT;
481 /* Sort images by the position of their metadata resources. I'm
482 * assuming that is what determines the other of the images in the WIM
483 * file, rather than their order in the lookup table, which is random
484 * because of hashing. */
485 qsort(w->image_metadata, w->current_image,
486 sizeof(struct image_metadata), sort_image_metadata_by_position);
488 w->current_image = WIM_NO_IMAGE;
490 /* Read the XML data. */
491 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
492 &w->xml_data, &w->wim_info);
495 ERROR("Missing or invalid XML data");
499 xml_num_images = wim_info_get_num_images(w->wim_info);
500 if (xml_num_images != w->hdr.image_count) {
501 ERROR("In the file `%s', there are %u <IMAGE> elements "
502 "in the XML data,", in_wim_path, xml_num_images);
503 ERROR("but %u images in the WIM! There must be exactly one "
504 "<IMAGE> element per image.", w->hdr.image_count);
505 return WIMLIB_ERR_IMAGE_COUNT;
508 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
514 * Opens a WIM file and creates a WIMStruct for it.
516 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int flags,
522 DEBUG("wim_file = `%s', flags = %#x", wim_file, flags);
523 w = new_wim_struct();
525 ERROR("Failed to allocate memory for WIMStruct");
526 return WIMLIB_ERR_NOMEM;
529 ret = begin_read(w, wim_file, flags);
531 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
539 /* Frees the memory for the WIMStruct, including all internal memory; also
540 * closes all files associated with the WIMStruct. */
541 WIMLIBAPI void wimlib_free(WIMStruct *w)
543 DEBUG("Freeing WIMStruct");
552 free_lookup_table(w->lookup_table);
556 free_wim_info(w->wim_info);
557 if (w->image_metadata) {
558 for (uint i = 0; i < w->hdr.image_count; i++)
559 destroy_image_metadata(&w->image_metadata[i], NULL);
560 FREE(w->image_metadata);