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 #ifdef ENABLE_SECURITY_DATA
36 print_security_data(wim_security_data(w));
38 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
43 static int print_files(WIMStruct *w)
45 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
49 WIMStruct *new_wim_struct()
53 w = CALLOC(1, sizeof(WIMStruct));
56 w->link_type = WIM_LINK_TYPE_NONE;
57 w->current_image = WIM_NO_IMAGE;
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 *))
73 DEBUG("for_image(w = %p, image = %d, visitor = %p)", w, image, visitor);
75 if (image == WIM_ALL_IMAGES) {
77 end = w->hdr.image_count;
79 if (image < 1 || image > w->hdr.image_count)
80 return WIMLIB_ERR_INVALID_IMAGE;
84 for (; i <= end; i++) {
85 ret = wimlib_select_image(w, i);
95 static int sort_image_metadata_by_position(const void *p1, const void *p2)
97 struct image_metadata *bmd1 = (struct image_metadata*)p1;
98 struct image_metadata *bmd2 = (struct image_metadata*)p2;
99 u64 offset1 = bmd1->metadata_lte->resource_entry.offset;
100 u64 offset2 = bmd2->metadata_lte->resource_entry.offset;
101 if (offset1 < offset2)
103 else if (offset1 > offset2)
110 * If @lte points to a metadata resource, append it to the list of metadata
111 * resources in the WIMStruct. Otherwise, do nothing.
113 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
116 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 return 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;
150 int wim_resource_compression_type(const WIMStruct *w,
151 const struct resource_entry *entry)
153 int wim_ctype = wimlib_get_compression_type(w);
154 return resource_compression_type(wim_ctype, entry->flags);
157 WIMLIBAPI void wimlib_set_verbose(WIMStruct *w, bool verbose)
159 w->verbose = verbose;
163 * Creates a WIMStruct for a new WIM file.
165 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
168 struct lookup_table *table;
171 DEBUG("Creating new WIM with %s compression.",
172 wimlib_get_compression_type_string(ctype));
174 /* Allocate the WIMStruct. */
175 w = new_wim_struct();
177 return WIMLIB_ERR_NOMEM;
179 ret = init_header(&w->hdr, ctype);
183 table = new_lookup_table(9001);
185 ret = WIMLIB_ERR_NOMEM;
188 w->lookup_table = table;
196 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
198 return w->hdr.image_count;
201 int wimlib_select_image(WIMStruct *w, int image)
203 struct image_metadata *imd;
205 DEBUG("Selecting image %d", image);
207 if (image == w->current_image)
210 if (image < 1 || image > w->hdr.image_count) {
211 ERROR("Cannot select image %d: There are only %u images",
212 image, w->hdr.image_count);
213 return WIMLIB_ERR_INVALID_IMAGE;
217 /* If a valid image is currently selected, it can be freed if it is not
219 if (w->current_image != WIM_NO_IMAGE) {
220 imd = wim_get_current_image_metadata(w);
221 if (!imd->modified) {
222 DEBUG("Freeing image %u", w->current_image);
223 free_dentry_tree(imd->root_dentry, NULL, false);
224 imd->root_dentry = NULL;
225 #ifdef ENABLE_SECURITY_DATA
226 free_security_data(imd->security_data);
227 imd->security_data = NULL;
232 w->current_image = image;
233 imd = wim_get_current_image_metadata(w);
235 if (imd->root_dentry) {
239 DEBUG("Reading metadata resource specified by the following "
240 "lookup table entry:");
241 print_lookup_table_entry(imd->metadata_lte, NULL);
243 return read_metadata_resource(w->fp,
244 wimlib_get_compression_type(w),
250 /* Returns the compression type of the WIM file. */
251 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
253 return wim_hdr_flags_compression_type(w->hdr.flags);
256 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
259 case WIM_COMPRESSION_TYPE_NONE:
261 case WIM_COMPRESSION_TYPE_LZX:
263 case WIM_COMPRESSION_TYPE_XPRESS:
271 * Returns the number of an image in the WIM file, given a string that is either
272 * the number of the image, or the name of the image. The images are numbered
275 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
281 if (!image_name_or_num)
284 if (strcmp(image_name_or_num, "all") == 0)
285 return WIM_ALL_IMAGES;
286 image = strtol(image_name_or_num, &p, 10);
287 if (p != image_name_or_num && *p == '\0') {
288 if (image < 1 || image > w->hdr.image_count)
292 for (i = 1; i <= w->hdr.image_count; i++) {
293 if (strcmp(image_name_or_num,
294 wimlib_get_image_name(w, i)) == 0)
302 /* Prints some basic information about a WIM file. */
303 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
305 const struct wim_header *hdr;
308 puts("WIM Information:");
309 puts("----------------");
310 printf("Path: %s\n", w->filename);
311 fputs ("GUID: 0x", stdout);
312 print_byte_field(hdr->guid, WIM_GID_LEN);
314 printf("Image Count: %d\n", hdr->image_count);
315 printf("Compression: %s\n", wimlib_get_compression_type_string(
316 wimlib_get_compression_type(w)));
317 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
318 printf("Boot Index: %d\n", hdr->boot_idx);
319 printf("Size: %"PRIu64" bytes\n",
320 wim_info_get_total_bytes(w->wim_info));
321 printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
325 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
327 return w->hdr.integrity.size != 0;
330 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
332 if (image == WIM_ALL_IMAGES) {
333 puts("Available Images:");
334 puts("-----------------");
339 n = printf("Information for Image %d\n", image);
340 for (i = 0; i < n - 1; i++)
345 print_image_info(w->wim_info, image);
349 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
350 * not WIM_NO_IMAGE. */
351 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
353 return for_image(w, image, print_metadata);
356 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
358 return for_image(w, image, print_files);
361 /* Sets the index of the bootable image. */
362 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
364 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
365 return WIMLIB_ERR_INVALID_IMAGE;
366 w->hdr.boot_idx = boot_idx;
368 memset(&w->hdr.boot_metadata_res_entry, 0,
369 sizeof(struct resource_entry));
371 memcpy(&w->hdr.boot_metadata_res_entry,
373 boot_idx - 1].metadata_lte->resource_entry,
374 sizeof(struct resource_entry));
379 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
382 *total_parts_ret = w->hdr.total_parts;
383 return w->hdr.part_number;
387 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
389 return w->hdr.boot_idx;
393 * Begins the reading of a WIM file; opens the file and reads its header and
394 * lookup table, and optionally checks the integrity.
396 static int begin_read(WIMStruct *w, const char *in_wim_path, int flags)
401 DEBUG("Reading the WIM file `%s'", in_wim_path);
403 w->filename = STRDUP(in_wim_path);
405 ERROR("Failed to allocate memory for WIM filename");
406 return WIMLIB_ERR_NOMEM;
409 w->fp = fopen(in_wim_path, "rb");
412 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading");
413 return WIMLIB_ERR_OPEN;
416 ret = read_header(w->fp, &w->hdr, flags & WIMLIB_OPEN_FLAG_SPLIT_OK);
420 DEBUG("Wim file contains %u images", w->hdr.image_count);
422 /* If the boot index is invalid, print a warning and set it to 0 */
423 if (w->hdr.boot_idx > w->hdr.image_count) {
424 WARNING("In `%s', image %u is marked as bootable, "
425 "but there are only %u images",
426 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
430 if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
431 ERROR("Invalid compression type (WIM header flags = %x)",
433 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
437 if (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
438 int integrity_status;
439 ret = check_wim_integrity(w,
440 flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
443 ERROR("Error in check_wim_integrity()");
446 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
447 WARNING("No integrity information for `%s'; skipping "
448 "integrity check.", w->filename);
449 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
450 ERROR("WIM is not intact! (Failed integrity check)");
451 return WIMLIB_ERR_INTEGRITY;
455 if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
456 ERROR("Didn't expect a compressed lookup table!");
457 ERROR("Ask the author to implement support for this.");
458 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
461 ret = read_lookup_table(w->fp, w->hdr.lookup_table_res_entry.offset,
462 w->hdr.lookup_table_res_entry.size,
467 w->image_metadata = CALLOC(w->hdr.image_count,
468 sizeof(struct image_metadata));
470 if (!w->image_metadata) {
471 ERROR("Failed to allocate memory for %u metadata structures",
473 return WIMLIB_ERR_NOMEM;
475 w->current_image = 0;
477 DEBUG("Looking for metadata resources in the lookup table.");
479 /* Find the images in the WIM by searching the lookup table. */
480 ret = for_lookup_table_entry(w->lookup_table,
481 append_metadata_resource_entry, w);
486 /* Make sure all the expected images were found. (We already have
487 * returned false if *extra* images were found) */
488 if (w->current_image != w->hdr.image_count && w->hdr.part_number == 1) {
489 ERROR("Only found %u images in WIM, but expected %u",
490 w->current_image, w->hdr.image_count);
491 return WIMLIB_ERR_IMAGE_COUNT;
495 /* Sort images by the position of their metadata resources. I'm
496 * assuming that is what determines the other of the images in the WIM
497 * file, rather than their order in the lookup table, which is random
498 * because of hashing. */
499 qsort(w->image_metadata, w->current_image,
500 sizeof(struct image_metadata), sort_image_metadata_by_position);
502 w->current_image = WIM_NO_IMAGE;
504 /* Read the XML data. */
505 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
506 &w->xml_data, &w->wim_info);
509 ERROR("Missing or invalid XML data");
513 xml_num_images = wim_info_get_num_images(w->wim_info);
514 if (xml_num_images != w->hdr.image_count) {
515 ERROR("In the file `%s', there are %u <IMAGE> elements "
516 "in the XML data,", in_wim_path, xml_num_images);
517 ERROR("but %u images in the WIM! There must be exactly one "
518 "<IMAGE> element per image.", w->hdr.image_count);
519 return WIMLIB_ERR_IMAGE_COUNT;
522 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
528 * Opens a WIM file and creates a WIMStruct for it.
530 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int flags,
536 DEBUG("wim_file = `%s', flags = %#x", wim_file, flags);
537 w = new_wim_struct();
539 ERROR("Failed to allocate memory for WIMStruct");
540 return WIMLIB_ERR_NOMEM;
543 ret = begin_read(w, wim_file, flags);
545 ERROR("Could not begin reading the WIM file `%s'", wim_file);
553 /* Frees the memory for the WIMStruct, including all internal memory; also
554 * closes all files associated with the WIMStruct. */
555 WIMLIBAPI void wimlib_free(WIMStruct *w)
566 free_lookup_table(w->lookup_table);
571 free_wim_info(w->wim_info);
572 if (w->image_metadata) {
573 for (i = 0; i < w->hdr.image_count; i++) {
574 free_dentry_tree(w->image_metadata[i].root_dentry,
576 #ifdef ENABLE_SECURITY_DATA
577 free_security_data(w->image_metadata[i].security_data);
580 FREE(w->image_metadata);