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/.
39 #include <ntfs-3g/volume.h>
42 #include "wimlib_internal.h"
44 #include "lookup_table.h"
47 static int print_metadata(WIMStruct *w)
49 DEBUG("Printing metadata for image %d", w->current_image);
50 print_security_data(wim_security_data(w));
51 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
56 static int print_files(WIMStruct *w)
58 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
62 WIMStruct *new_wim_struct()
64 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
66 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
67 ERROR_WITH_ERRNO("Failed to initialize mutex");
77 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
78 * is called on the WIM once for each image, with each image selected as the
79 * current image in turn. If @image is a certain image, @visitor is called on
80 * the WIM only once, with that image selected.
82 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
89 if (image == WIMLIB_ALL_IMAGES) {
91 end = w->hdr.image_count;
92 } else if (image >= 1 && image <= w->hdr.image_count) {
96 return WIMLIB_ERR_INVALID_IMAGE;
98 for (i = start; i <= end; i++) {
99 ret = select_wim_image(w, i);
109 static int sort_image_metadata_by_position(const void *p1, const void *p2)
111 const struct image_metadata *imd1 = p1;
112 const struct image_metadata *imd2 = p2;
113 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
114 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
115 if (offset1 < offset2)
117 else if (offset1 > offset2)
124 * If @lte points to a metadata resource, append it to the list of metadata
125 * resources in the WIMStruct. Otherwise, do nothing.
127 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
130 WIMStruct *w = wim_p;
133 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
134 if (w->current_image == w->hdr.image_count) {
135 ERROR("The WIM header says there are %u images in the WIM,\n"
136 " but we found more metadata resources than this",
138 ret = WIMLIB_ERR_IMAGE_COUNT;
140 DEBUG("Found metadata resource for image %u at "
142 w->current_image + 1,
143 lte->resource_entry.offset);
145 w->current_image++].metadata_lte = lte;
151 /* Returns the compression type given in the flags of a WIM header. */
152 int wim_hdr_flags_compression_type(int wim_hdr_flags)
154 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
155 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
156 return WIMLIB_COMPRESSION_TYPE_LZX;
157 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
158 return WIMLIB_COMPRESSION_TYPE_XPRESS;
160 return WIMLIB_COMPRESSION_TYPE_INVALID;
162 return WIMLIB_COMPRESSION_TYPE_NONE;
167 * Creates a WIMStruct for a new WIM file.
169 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
172 struct lookup_table *table;
175 DEBUG("Creating new WIM with %s compression.",
176 wimlib_get_compression_type_string(ctype));
178 /* Allocate the WIMStruct. */
179 w = new_wim_struct();
181 return WIMLIB_ERR_NOMEM;
183 ret = init_header(&w->hdr, ctype);
187 table = new_lookup_table(9001);
189 ret = WIMLIB_ERR_NOMEM;
192 w->lookup_table = table;
200 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
202 return w->hdr.image_count;
205 int select_wim_image(WIMStruct *w, int image)
207 struct image_metadata *imd;
209 DEBUG("Selecting image %d", image);
211 if (image == WIMLIB_NO_IMAGE) {
212 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
213 return WIMLIB_ERR_INVALID_IMAGE;
216 if (image == w->current_image)
219 if (image < 1 || image > w->hdr.image_count) {
220 ERROR("Cannot select image %d: There are only %u images",
221 image, w->hdr.image_count);
222 return WIMLIB_ERR_INVALID_IMAGE;
225 /* If a valid image is currently selected, it can be freed if it is not
227 if (w->current_image != WIMLIB_NO_IMAGE) {
228 imd = wim_get_current_image_metadata(w);
229 if (!imd->modified) {
230 DEBUG("Freeing image %u", w->current_image);
231 destroy_image_metadata(imd, NULL);
232 imd->root_dentry = NULL;
233 imd->security_data = NULL;
234 INIT_HLIST_HEAD(&imd->inode_list);
238 w->current_image = image;
239 imd = wim_get_current_image_metadata(w);
241 if (imd->root_dentry) {
245 DEBUG("Reading metadata resource specified by the following "
246 "lookup table entry:");
247 print_lookup_table_entry(imd->metadata_lte);
249 return read_metadata_resource(w, imd);
254 /* Returns the compression type of the WIM file. */
255 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
257 return wim_hdr_flags_compression_type(w->hdr.flags);
260 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
263 case WIMLIB_COMPRESSION_TYPE_NONE:
265 case WIMLIB_COMPRESSION_TYPE_LZX:
267 case WIMLIB_COMPRESSION_TYPE_XPRESS:
275 * Returns the number of an image in the WIM file, given a string that is either
276 * the number of the image, or the name of the image. The images are numbered
279 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
285 if (!image_name_or_num || !*image_name_or_num)
286 return WIMLIB_NO_IMAGE;
288 if (strcmp(image_name_or_num, "all") == 0
289 || strcmp(image_name_or_num, "*") == 0)
290 return WIMLIB_ALL_IMAGES;
291 image = strtol(image_name_or_num, &p, 10);
292 if (p != image_name_or_num && *p == '\0' && image > 0) {
293 if (image > w->hdr.image_count)
294 return WIMLIB_NO_IMAGE;
297 for (i = 1; i <= w->hdr.image_count; i++) {
298 if (strcmp(image_name_or_num,
299 wimlib_get_image_name(w, i)) == 0)
302 return WIMLIB_NO_IMAGE;
307 /* Prints some basic information about a WIM file. */
308 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
310 const struct wim_header *hdr;
313 puts("WIM Information:");
314 puts("----------------");
315 printf("Path: %s\n", w->filename);
316 fputs ("GUID: 0x", stdout);
317 print_byte_field(hdr->guid, WIM_GID_LEN);
319 printf("Image Count: %d\n", hdr->image_count);
320 printf("Compression: %s\n", wimlib_get_compression_type_string(
321 wimlib_get_compression_type(w)));
322 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
323 printf("Boot Index: %d\n", hdr->boot_idx);
324 printf("Size: %"PRIu64" bytes\n",
325 wim_info_get_total_bytes(w->wim_info));
326 printf("Integrity Info: %s\n", (w->hdr.integrity.offset != 0) ? "yes" : "no");
330 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
332 return w->hdr.integrity.size != 0;
335 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
341 if (image == WIMLIB_ALL_IMAGES) {
342 n = printf("Available Images:\n");
344 last = w->hdr.image_count;
345 } else if (image >= 1 && image <= w->hdr.image_count) {
346 n = printf("Information for Image %d\n", image);
350 printf("wimlib_print_available_images(): Invalid image %d",
354 for (i = 0; i < n - 1; i++)
357 for (i = first; i <= last; i++)
358 print_image_info(w->wim_info, i);
362 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
363 * not WIMLIB_NO_IMAGE. */
364 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
366 if (w->hdr.part_number != 1) {
367 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
368 w->hdr.part_number, w->hdr.total_parts);
369 ERROR("Select the first part of the split WIM to see the metadata.");
370 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
372 return for_image(w, image, print_metadata);
375 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
377 if (w->hdr.part_number != 1) {
378 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
379 w->hdr.part_number, w->hdr.total_parts);
380 ERROR("Select the first part of the split WIM if you'd like to list the files.");
381 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
383 return for_image(w, image, print_files);
386 /* Sets the index of the bootable image. */
387 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
389 if (w->hdr.total_parts != 1) {
390 ERROR("Cannot modify the boot index of a split WIM!");
391 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
393 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
394 return WIMLIB_ERR_INVALID_IMAGE;
395 w->hdr.boot_idx = boot_idx;
398 memset(&w->hdr.boot_metadata_res_entry, 0,
399 sizeof(struct resource_entry));
401 memcpy(&w->hdr.boot_metadata_res_entry,
403 boot_idx - 1].metadata_lte->resource_entry,
404 sizeof(struct resource_entry));
410 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
413 *total_parts_ret = w->hdr.total_parts;
414 return w->hdr.part_number;
418 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
420 return w->hdr.boot_idx;
424 * Begins the reading of a WIM file; opens the file and reads its header and
425 * lookup table, and optionally checks the integrity.
427 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
428 wimlib_progress_func_t progress_func)
433 DEBUG("Reading the WIM file `%s'", in_wim_path);
435 w->fp = fopen(in_wim_path, "rb");
437 ERROR_WITH_ERRNO("Failed to open `%s' for reading",
439 return WIMLIB_ERR_OPEN;
442 /* The absolute path to the WIM is requested so that wimlib_overwrite()
443 * still works even if the process changes its working directory. This
444 * actually happens if a WIM is mounted read-write, since the FUSE
445 * thread changes directory to "/", and it needs to be able to find the
448 * This will break if the full path to the WIM changes in the
449 * intervening time...
451 w->filename = realpath(in_wim_path, NULL);
453 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
455 return WIMLIB_ERR_NOMEM;
457 return WIMLIB_ERR_OPEN;
460 ret = read_header(w->fp, &w->hdr, open_flags);
464 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
466 /* If the boot index is invalid, print a warning and set it to 0 */
467 if (w->hdr.boot_idx > w->hdr.image_count) {
468 WARNING("In `%s', image %u is marked as bootable, "
469 "but there are only %u images in the WIM",
470 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
474 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
475 ERROR("Invalid compression type (WIM header flags = 0x%x)",
477 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
480 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
481 ret = check_wim_integrity(w, progress_func);
482 if (ret == WIM_INTEGRITY_NONEXISTENT) {
483 WARNING("No integrity information for `%s'; skipping "
484 "integrity check.", in_wim_path);
485 } else if (ret == WIM_INTEGRITY_NOT_OK) {
486 ERROR("WIM is not intact! (Failed integrity check)");
487 return WIMLIB_ERR_INTEGRITY;
488 } else if (ret != WIM_INTEGRITY_OK) {
493 ret = read_lookup_table(w);
497 if (w->hdr.image_count != 0) {
498 w->image_metadata = CALLOC(w->hdr.image_count,
499 sizeof(struct image_metadata));
501 if (!w->image_metadata) {
502 ERROR("Failed to allocate memory for %u image metadata structures",
504 return WIMLIB_ERR_NOMEM;
507 w->current_image = 0;
509 DEBUG("Looking for metadata resources in the lookup table.");
511 /* Find the images in the WIM by searching the lookup table. */
512 ret = for_lookup_table_entry(w->lookup_table,
513 append_metadata_resource_entry, w);
518 /* Make sure all the expected images were found. (We already have
519 * returned false if *extra* images were found) */
520 if (w->current_image != w->hdr.image_count &&
521 w->hdr.part_number == 1)
523 ERROR("Only found %d images in WIM, but expected %u",
524 w->current_image, w->hdr.image_count);
525 return WIMLIB_ERR_IMAGE_COUNT;
528 /* Sort images by the position of their metadata resources. I'm
529 * assuming that is what determines the other of the images in the WIM
530 * file, rather than their order in the lookup table, which is random
531 * because of hashing. */
532 qsort(w->image_metadata, w->current_image,
533 sizeof(struct image_metadata), sort_image_metadata_by_position);
535 w->current_image = WIMLIB_NO_IMAGE;
537 /* Read the XML data. */
538 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
539 &w->xml_data, &w->wim_info);
544 xml_num_images = wim_info_get_num_images(w->wim_info);
545 if (xml_num_images != w->hdr.image_count) {
546 ERROR("In the file `%s', there are %u <IMAGE> elements "
547 "in the XML data,", in_wim_path, xml_num_images);
548 ERROR("but %u images in the WIM! There must be exactly one "
549 "<IMAGE> element per image.", w->hdr.image_count);
550 return WIMLIB_ERR_IMAGE_COUNT;
553 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
559 * Opens a WIM file and creates a WIMStruct for it.
561 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
563 wimlib_progress_func_t progress_func)
568 if (!wim_file || !w_ret)
569 return WIMLIB_ERR_INVALID_PARAM;
571 w = new_wim_struct();
573 return WIMLIB_ERR_NOMEM;
575 ret = begin_read(w, wim_file, open_flags, progress_func);
583 /* Frees the memory for the WIMStruct, including all internal memory; also
584 * closes all files associated with the WIMStruct. */
585 WIMLIBAPI void wimlib_free(WIMStruct *w)
587 DEBUG2("Freeing WIMStruct");
598 for (size_t i = 0; i < w->num_allocated_fps; i++)
600 fclose(w->fp_tab[i]);
603 pthread_mutex_destroy(&w->fp_tab_mutex);
606 free_lookup_table(w->lookup_table);
610 free_wim_info(w->wim_info);
611 if (w->image_metadata) {
612 for (unsigned i = 0; i < w->hdr.image_count; i++)
613 destroy_image_metadata(&w->image_metadata[i], NULL);
614 FREE(w->image_metadata);
618 DEBUG("Unmounting NTFS volume");
619 ntfs_umount(w->ntfs_vol, FALSE);