2 * wim.c - Stuff that doesn't fit into any other file
6 * Copyright (C) 2012, 2013 Eric Biggers
8 * wimlib - Library for working with WIM files
10 * This file is part of wimlib, a library for working with WIM files.
12 * wimlib is free software; you can redistribute it and/or modify it under the
13 * terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your option)
17 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 * A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with wimlib; if not, see http://www.gnu.org/licenses/.
38 # include <ntfs-3g/volume.h>
45 #include "buffer_io.h"
47 #include "lookup_table.h"
48 #include "wimlib_internal.h"
51 static int image_print_metadata(WIMStruct *w)
53 DEBUG("Printing metadata for image %d", w->current_image);
54 print_security_data(wim_security_data(w));
55 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
60 static int image_print_files(WIMStruct *w)
62 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
66 static WIMStruct *new_wim_struct()
68 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
70 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
71 ERROR_WITH_ERRNO("Failed to initialize mutex");
81 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
82 * is called on the WIM once for each image, with each image selected as the
83 * current image in turn. If @image is a certain image, @visitor is called on
84 * the WIM only once, with that image selected.
86 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
93 if (image == WIMLIB_ALL_IMAGES) {
95 end = w->hdr.image_count;
96 } else if (image >= 1 && image <= w->hdr.image_count) {
100 return WIMLIB_ERR_INVALID_IMAGE;
102 for (i = start; i <= end; i++) {
103 ret = select_wim_image(w, i);
113 static int sort_image_metadata_by_position(const void *p1, const void *p2)
115 const struct wim_image_metadata *imd1 = p1;
116 const struct wim_image_metadata *imd2 = p2;
117 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
118 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
119 if (offset1 < offset2)
121 else if (offset1 > offset2)
128 * If @lte points to a metadata resource, append it to the list of metadata
129 * resources in the WIMStruct. Otherwise, do nothing.
131 static int append_metadata_resource_entry(struct wim_lookup_table_entry *lte,
134 WIMStruct *w = wim_p;
137 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
138 if (w->current_image == w->hdr.image_count) {
139 ERROR("The WIM header says there are %u images in the WIM,\n"
140 " but we found more metadata resources than this",
142 ret = WIMLIB_ERR_IMAGE_COUNT;
144 DEBUG("Found metadata resource for image %u at "
146 w->current_image + 1,
147 lte->resource_entry.offset);
149 w->current_image++].metadata_lte = lte;
155 /* Returns the compression type given in the flags of a WIM header. */
156 static int wim_hdr_flags_compression_type(int wim_hdr_flags)
158 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
159 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
160 return WIMLIB_COMPRESSION_TYPE_LZX;
161 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
162 return WIMLIB_COMPRESSION_TYPE_XPRESS;
164 return WIMLIB_COMPRESSION_TYPE_INVALID;
166 return WIMLIB_COMPRESSION_TYPE_NONE;
171 * Creates a WIMStruct for a new WIM file.
173 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
176 struct wim_lookup_table *table;
179 DEBUG("Creating new WIM with %s compression.",
180 wimlib_get_compression_type_string(ctype));
182 /* Allocate the WIMStruct. */
183 w = new_wim_struct();
185 return WIMLIB_ERR_NOMEM;
187 ret = init_header(&w->hdr, ctype);
191 table = new_lookup_table(9001);
193 ret = WIMLIB_ERR_NOMEM;
196 w->lookup_table = table;
204 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
206 return w->hdr.image_count;
209 int select_wim_image(WIMStruct *w, int image)
211 struct wim_image_metadata *imd;
214 DEBUG("Selecting image %d", image);
216 if (image == WIMLIB_NO_IMAGE) {
217 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
218 return WIMLIB_ERR_INVALID_IMAGE;
221 if (image == w->current_image)
224 if (image < 1 || image > w->hdr.image_count) {
225 ERROR("Cannot select image %d: There are only %u images",
226 image, w->hdr.image_count);
227 return WIMLIB_ERR_INVALID_IMAGE;
230 /* If a valid image is currently selected, it can be freed if it is not
232 if (w->current_image != WIMLIB_NO_IMAGE) {
233 imd = wim_get_current_image_metadata(w);
234 if (!imd->modified) {
235 DEBUG("Freeing image %u", w->current_image);
236 destroy_image_metadata(imd, NULL);
237 imd->root_dentry = NULL;
238 imd->security_data = NULL;
239 INIT_HLIST_HEAD(&imd->inode_list);
242 w->current_image = image;
243 imd = &w->image_metadata[image - 1];
244 if (imd->root_dentry) {
248 DEBUG("Reading metadata resource specified by the following "
249 "lookup table entry:");
250 print_lookup_table_entry(imd->metadata_lte, stdout);
252 ret = read_metadata_resource(w, imd);
254 w->current_image = WIMLIB_NO_IMAGE;
260 /* Returns the compression type of the WIM file. */
261 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
263 return wim_hdr_flags_compression_type(w->hdr.flags);
266 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
269 case WIMLIB_COMPRESSION_TYPE_NONE:
271 case WIMLIB_COMPRESSION_TYPE_LZX:
273 case WIMLIB_COMPRESSION_TYPE_XPRESS:
281 * Returns the number of an image in the WIM file, given a string that is either
282 * the number of the image, or the name of the image. The images are numbered
285 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
291 if (!image_name_or_num || !*image_name_or_num)
292 return WIMLIB_NO_IMAGE;
294 if (strcmp(image_name_or_num, "all") == 0
295 || strcmp(image_name_or_num, "*") == 0)
296 return WIMLIB_ALL_IMAGES;
297 image = strtol(image_name_or_num, &p, 10);
298 if (p != image_name_or_num && *p == '\0' && image > 0) {
299 if (image > w->hdr.image_count)
300 return WIMLIB_NO_IMAGE;
303 for (i = 1; i <= w->hdr.image_count; i++) {
304 if (strcmp(image_name_or_num,
305 wimlib_get_image_name(w, i)) == 0)
308 return WIMLIB_NO_IMAGE;
313 /* Prints some basic information about a WIM file. */
314 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
316 const struct wim_header *hdr;
319 puts("WIM Information:");
320 puts("----------------");
321 printf("Path: %s\n", w->filename);
322 fputs ("GUID: 0x", stdout);
323 print_byte_field(hdr->guid, WIM_GID_LEN);
325 printf("Image Count: %d\n", hdr->image_count);
326 printf("Compression: %s\n", wimlib_get_compression_type_string(
327 wimlib_get_compression_type(w)));
328 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
329 printf("Boot Index: %d\n", hdr->boot_idx);
330 printf("Size: %"PRIu64" bytes\n",
331 wim_info_get_total_bytes(w->wim_info));
332 printf("Integrity Info: %s\n", (w->hdr.integrity.offset != 0) ? "yes" : "no");
336 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
338 return w->hdr.integrity.size != 0;
341 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
347 if (image == WIMLIB_ALL_IMAGES) {
348 n = printf("Available Images:\n");
350 last = w->hdr.image_count;
351 } else if (image >= 1 && image <= w->hdr.image_count) {
352 n = printf("Information for Image %d\n", image);
356 printf("wimlib_print_available_images(): Invalid image %d",
360 for (i = 0; i < n - 1; i++)
363 for (i = first; i <= last; i++)
364 print_image_info(w->wim_info, i);
368 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
369 * not WIMLIB_NO_IMAGE. */
370 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
372 if (w->hdr.part_number != 1) {
373 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
374 w->hdr.part_number, w->hdr.total_parts);
375 ERROR("Select the first part of the split WIM to see the metadata.");
376 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
378 return for_image(w, image, image_print_metadata);
381 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
383 if (w->hdr.part_number != 1) {
384 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
385 w->hdr.part_number, w->hdr.total_parts);
386 ERROR("Select the first part of the split WIM if you'd like to list the files.");
387 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
389 return for_image(w, image, image_print_files);
392 /* Sets the index of the bootable image. */
393 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
395 if (w->hdr.total_parts != 1) {
396 ERROR("Cannot modify the boot index of a split WIM!");
397 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
399 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
400 return WIMLIB_ERR_INVALID_IMAGE;
401 w->hdr.boot_idx = boot_idx;
404 memset(&w->hdr.boot_metadata_res_entry, 0,
405 sizeof(struct resource_entry));
407 memcpy(&w->hdr.boot_metadata_res_entry,
409 boot_idx - 1].metadata_lte->resource_entry,
410 sizeof(struct resource_entry));
416 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
419 *total_parts_ret = w->hdr.total_parts;
420 return w->hdr.part_number;
424 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
426 return w->hdr.boot_idx;
430 * Begins the reading of a WIM file; opens the file and reads its header and
431 * lookup table, and optionally checks the integrity.
433 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
434 wimlib_progress_func_t progress_func)
439 DEBUG("Reading the WIM file `%s'", in_wim_path);
441 w->fp = fopen(in_wim_path, "rb");
443 ERROR_WITH_ERRNO("Failed to open `%s' for reading",
445 return WIMLIB_ERR_OPEN;
448 /* The absolute path to the WIM is requested so that wimlib_overwrite()
449 * still works even if the process changes its working directory. This
450 * actually happens if a WIM is mounted read-write, since the FUSE
451 * thread changes directory to "/", and it needs to be able to find the
454 * This will break if the full path to the WIM changes in the
455 * intervening time...
457 * Warning: in Windows native builds, realpath() calls the replacement
458 * function in win32.c.
460 w->filename = realpath(in_wim_path, NULL);
462 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
464 return WIMLIB_ERR_NOMEM;
466 return WIMLIB_ERR_OPEN;
469 ret = read_header(w->fp, &w->hdr, open_flags);
473 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
475 /* If the boot index is invalid, print a warning and set it to 0 */
476 if (w->hdr.boot_idx > w->hdr.image_count) {
477 WARNING("In `%s', image %u is marked as bootable, "
478 "but there are only %u images in the WIM",
479 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
483 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
484 ERROR("Invalid compression type (WIM header flags = 0x%x)",
486 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
489 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
490 ret = check_wim_integrity(w, progress_func);
491 if (ret == WIM_INTEGRITY_NONEXISTENT) {
492 WARNING("No integrity information for `%s'; skipping "
493 "integrity check.", in_wim_path);
494 } else if (ret == WIM_INTEGRITY_NOT_OK) {
495 ERROR("WIM is not intact! (Failed integrity check)");
496 return WIMLIB_ERR_INTEGRITY;
497 } else if (ret != WIM_INTEGRITY_OK) {
502 ret = read_lookup_table(w);
506 if (w->hdr.image_count != 0) {
507 w->image_metadata = CALLOC(w->hdr.image_count,
508 sizeof(struct wim_image_metadata));
510 if (!w->image_metadata) {
511 ERROR("Failed to allocate memory for %u image metadata structures",
513 return WIMLIB_ERR_NOMEM;
516 w->current_image = 0;
518 DEBUG("Looking for metadata resources in the lookup table.");
520 /* Find the images in the WIM by searching the lookup table. */
521 ret = for_lookup_table_entry(w->lookup_table,
522 append_metadata_resource_entry, w);
527 /* Make sure all the expected images were found. (We already have
528 * returned WIMLIB_ERR_IMAGE_COUNT if *extra* images were found) */
529 if (w->current_image != w->hdr.image_count &&
530 w->hdr.part_number == 1)
532 ERROR("Only found %d images in WIM, but expected %u",
533 w->current_image, w->hdr.image_count);
534 return WIMLIB_ERR_IMAGE_COUNT;
537 /* Sort images by the position of their metadata resources. I'm
538 * assuming that is what determines the other of the images in the WIM
539 * file, rather than their order in the lookup table, which is random
540 * because of hashing. */
541 qsort(w->image_metadata, w->current_image,
542 sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
544 w->current_image = WIMLIB_NO_IMAGE;
546 /* Read the XML data. */
547 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
548 &w->xml_data, &w->wim_info);
553 xml_num_images = wim_info_get_num_images(w->wim_info);
554 if (xml_num_images != w->hdr.image_count) {
555 ERROR("In the file `%s', there are %u <IMAGE> elements "
556 "in the XML data,", in_wim_path, xml_num_images);
557 ERROR("but %u images in the WIM! There must be exactly one "
558 "<IMAGE> element per image.", w->hdr.image_count);
559 return WIMLIB_ERR_IMAGE_COUNT;
562 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
568 * Opens a WIM file and creates a WIMStruct for it.
570 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
572 wimlib_progress_func_t progress_func)
577 if (!wim_file || !w_ret)
578 return WIMLIB_ERR_INVALID_PARAM;
580 w = new_wim_struct();
582 return WIMLIB_ERR_NOMEM;
584 ret = begin_read(w, wim_file, open_flags, progress_func);
592 void destroy_image_metadata(struct wim_image_metadata *imd,
593 struct wim_lookup_table *table)
595 free_dentry_tree(imd->root_dentry, table);
596 free_security_data(imd->security_data);
598 /* Get rid of the lookup table entry for this image's metadata resource
601 lookup_table_unlink(table, imd->metadata_lte);
602 free_lookup_table_entry(imd->metadata_lte);
606 /* Frees the memory for the WIMStruct, including all internal memory; also
607 * closes all files associated with the WIMStruct. */
608 WIMLIBAPI void wimlib_free(WIMStruct *w)
610 DEBUG("Freeing WIMStruct");
621 for (size_t i = 0; i < w->num_allocated_fps; i++)
623 fclose(w->fp_tab[i]);
626 pthread_mutex_destroy(&w->fp_tab_mutex);
629 free_lookup_table(w->lookup_table);
633 free_wim_info(w->wim_info);
634 if (w->image_metadata) {
635 for (unsigned i = 0; i < w->hdr.image_count; i++)
636 destroy_image_metadata(&w->image_metadata[i], NULL);
637 FREE(w->image_metadata);
641 DEBUG("Unmounting NTFS volume");
642 ntfs_umount(w->ntfs_vol, FALSE);
646 DEBUG("Freed WIMStruct");
649 bool wimlib_mbs_is_utf8;
651 /* Get global memory allocations out of the way. Not strictly necessary in
652 * single-threaded programs like 'imagex'. */
653 WIMLIBAPI int wimlib_global_init()
657 libxml_global_init();
658 wimlib_mbs_is_utf8 = (strcmp(nl_langinfo(CODESET), "UTF-8") == 0);
659 return iconv_global_init();
662 /* Free global memory allocations. Not strictly necessary if the process using
663 * wimlib is just about to exit (as is the case for 'imagex'). */
664 WIMLIBAPI void wimlib_global_cleanup()
666 libxml_global_cleanup();
667 iconv_global_cleanup();