2 * wim.c - Stuff that doesn't fit into any other file
6 * Copyright (C) 2012 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>
41 #include "wimlib_internal.h"
42 #include "buffer_io.h"
43 #include "lookup_table.h"
46 static int image_print_metadata(WIMStruct *w)
48 DEBUG("Printing metadata for image %d", w->current_image);
49 print_security_data(wim_security_data(w));
50 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
55 static int image_print_files(WIMStruct *w)
57 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
61 static WIMStruct *new_wim_struct()
63 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
65 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
66 ERROR_WITH_ERRNO("Failed to initialize mutex");
76 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
77 * is called on the WIM once for each image, with each image selected as the
78 * current image in turn. If @image is a certain image, @visitor is called on
79 * the WIM only once, with that image selected.
81 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
88 if (image == WIMLIB_ALL_IMAGES) {
90 end = w->hdr.image_count;
91 } else if (image >= 1 && image <= w->hdr.image_count) {
95 return WIMLIB_ERR_INVALID_IMAGE;
97 for (i = start; i <= end; i++) {
98 ret = select_wim_image(w, i);
108 static int sort_image_metadata_by_position(const void *p1, const void *p2)
110 const struct wim_image_metadata *imd1 = p1;
111 const struct wim_image_metadata *imd2 = p2;
112 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
113 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
114 if (offset1 < offset2)
116 else if (offset1 > offset2)
123 * If @lte points to a metadata resource, append it to the list of metadata
124 * resources in the WIMStruct. Otherwise, do nothing.
126 static int append_metadata_resource_entry(struct wim_lookup_table_entry *lte,
129 WIMStruct *w = wim_p;
132 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
133 if (w->current_image == w->hdr.image_count) {
134 ERROR("The WIM header says there are %u images in the WIM,\n"
135 " but we found more metadata resources than this",
137 ret = WIMLIB_ERR_IMAGE_COUNT;
139 DEBUG("Found metadata resource for image %u at "
141 w->current_image + 1,
142 lte->resource_entry.offset);
144 w->current_image++].metadata_lte = lte;
150 /* Returns the compression type given in the flags of a WIM header. */
151 static int wim_hdr_flags_compression_type(int wim_hdr_flags)
153 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
154 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
155 return WIMLIB_COMPRESSION_TYPE_LZX;
156 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
157 return WIMLIB_COMPRESSION_TYPE_XPRESS;
159 return WIMLIB_COMPRESSION_TYPE_INVALID;
161 return WIMLIB_COMPRESSION_TYPE_NONE;
166 * Creates a WIMStruct for a new WIM file.
168 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
171 struct wim_lookup_table *table;
174 DEBUG("Creating new WIM with %s compression.",
175 wimlib_get_compression_type_string(ctype));
177 /* Allocate the WIMStruct. */
178 w = new_wim_struct();
180 return WIMLIB_ERR_NOMEM;
182 ret = init_header(&w->hdr, ctype);
186 table = new_lookup_table(9001);
188 ret = WIMLIB_ERR_NOMEM;
191 w->lookup_table = table;
199 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
201 return w->hdr.image_count;
204 int select_wim_image(WIMStruct *w, int image)
206 struct wim_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);
236 w->current_image = WIMLIB_NO_IMAGE;
239 imd = wim_get_current_image_metadata(w);
240 if (imd->root_dentry) {
244 DEBUG("Reading metadata resource specified by the following "
245 "lookup table entry:");
246 print_lookup_table_entry(imd->metadata_lte, stdout);
248 ret = read_metadata_resource(w, imd);
251 w->current_image = image;
256 /* Returns the compression type of the WIM file. */
257 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
259 return wim_hdr_flags_compression_type(w->hdr.flags);
262 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
265 case WIMLIB_COMPRESSION_TYPE_NONE:
267 case WIMLIB_COMPRESSION_TYPE_LZX:
269 case WIMLIB_COMPRESSION_TYPE_XPRESS:
277 * Returns the number of an image in the WIM file, given a string that is either
278 * the number of the image, or the name of the image. The images are numbered
281 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
287 if (!image_name_or_num || !*image_name_or_num)
288 return WIMLIB_NO_IMAGE;
290 if (strcmp(image_name_or_num, "all") == 0
291 || strcmp(image_name_or_num, "*") == 0)
292 return WIMLIB_ALL_IMAGES;
293 image = strtol(image_name_or_num, &p, 10);
294 if (p != image_name_or_num && *p == '\0' && image > 0) {
295 if (image > w->hdr.image_count)
296 return WIMLIB_NO_IMAGE;
299 for (i = 1; i <= w->hdr.image_count; i++) {
300 if (strcmp(image_name_or_num,
301 wimlib_get_image_name(w, i)) == 0)
304 return WIMLIB_NO_IMAGE;
309 /* Prints some basic information about a WIM file. */
310 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
312 const struct wim_header *hdr;
315 puts("WIM Information:");
316 puts("----------------");
317 printf("Path: %s\n", w->filename);
318 fputs ("GUID: 0x", stdout);
319 print_byte_field(hdr->guid, WIM_GID_LEN);
321 printf("Image Count: %d\n", hdr->image_count);
322 printf("Compression: %s\n", wimlib_get_compression_type_string(
323 wimlib_get_compression_type(w)));
324 printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
325 printf("Boot Index: %d\n", hdr->boot_idx);
326 printf("Size: %"PRIu64" bytes\n",
327 wim_info_get_total_bytes(w->wim_info));
328 printf("Integrity Info: %s\n", (w->hdr.integrity.offset != 0) ? "yes" : "no");
332 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
334 return w->hdr.integrity.size != 0;
337 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
343 if (image == WIMLIB_ALL_IMAGES) {
344 n = printf("Available Images:\n");
346 last = w->hdr.image_count;
347 } else if (image >= 1 && image <= w->hdr.image_count) {
348 n = printf("Information for Image %d\n", image);
352 printf("wimlib_print_available_images(): Invalid image %d",
356 for (i = 0; i < n - 1; i++)
359 for (i = first; i <= last; i++)
360 print_image_info(w->wim_info, i);
364 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
365 * not WIMLIB_NO_IMAGE. */
366 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
368 if (w->hdr.part_number != 1) {
369 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
370 w->hdr.part_number, w->hdr.total_parts);
371 ERROR("Select the first part of the split WIM to see the metadata.");
372 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
374 return for_image(w, image, image_print_metadata);
377 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
379 if (w->hdr.part_number != 1) {
380 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
381 w->hdr.part_number, w->hdr.total_parts);
382 ERROR("Select the first part of the split WIM if you'd like to list the files.");
383 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
385 return for_image(w, image, image_print_files);
388 /* Sets the index of the bootable image. */
389 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
391 if (w->hdr.total_parts != 1) {
392 ERROR("Cannot modify the boot index of a split WIM!");
393 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
395 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
396 return WIMLIB_ERR_INVALID_IMAGE;
397 w->hdr.boot_idx = boot_idx;
400 memset(&w->hdr.boot_metadata_res_entry, 0,
401 sizeof(struct resource_entry));
403 memcpy(&w->hdr.boot_metadata_res_entry,
405 boot_idx - 1].metadata_lte->resource_entry,
406 sizeof(struct resource_entry));
412 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
415 *total_parts_ret = w->hdr.total_parts;
416 return w->hdr.part_number;
420 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
422 return w->hdr.boot_idx;
426 * Begins the reading of a WIM file; opens the file and reads its header and
427 * lookup table, and optionally checks the integrity.
429 static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
430 wimlib_progress_func_t progress_func)
435 DEBUG("Reading the WIM file `%s'", in_wim_path);
437 w->fp = fopen(in_wim_path, "rb");
439 ERROR_WITH_ERRNO("Failed to open `%s' for reading",
441 return WIMLIB_ERR_OPEN;
444 /* The absolute path to the WIM is requested so that wimlib_overwrite()
445 * still works even if the process changes its working directory. This
446 * actually happens if a WIM is mounted read-write, since the FUSE
447 * thread changes directory to "/", and it needs to be able to find the
450 * This will break if the full path to the WIM changes in the
451 * intervening time...
453 w->filename = realpath(in_wim_path, NULL);
455 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
457 return WIMLIB_ERR_NOMEM;
459 return WIMLIB_ERR_OPEN;
462 ret = read_header(w->fp, &w->hdr, open_flags);
466 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
468 /* If the boot index is invalid, print a warning and set it to 0 */
469 if (w->hdr.boot_idx > w->hdr.image_count) {
470 WARNING("In `%s', image %u is marked as bootable, "
471 "but there are only %u images in the WIM",
472 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
476 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
477 ERROR("Invalid compression type (WIM header flags = 0x%x)",
479 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
482 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
483 ret = check_wim_integrity(w, progress_func);
484 if (ret == WIM_INTEGRITY_NONEXISTENT) {
485 WARNING("No integrity information for `%s'; skipping "
486 "integrity check.", in_wim_path);
487 } else if (ret == WIM_INTEGRITY_NOT_OK) {
488 ERROR("WIM is not intact! (Failed integrity check)");
489 return WIMLIB_ERR_INTEGRITY;
490 } else if (ret != WIM_INTEGRITY_OK) {
495 ret = read_lookup_table(w);
499 if (w->hdr.image_count != 0) {
500 w->image_metadata = CALLOC(w->hdr.image_count,
501 sizeof(struct wim_image_metadata));
503 if (!w->image_metadata) {
504 ERROR("Failed to allocate memory for %u image metadata structures",
506 return WIMLIB_ERR_NOMEM;
509 w->current_image = 0;
511 DEBUG("Looking for metadata resources in the lookup table.");
513 /* Find the images in the WIM by searching the lookup table. */
514 ret = for_lookup_table_entry(w->lookup_table,
515 append_metadata_resource_entry, w);
520 /* Make sure all the expected images were found. (We already have
521 * returned WIMLIB_ERR_IMAGE_COUNT if *extra* images were found) */
522 if (w->current_image != w->hdr.image_count &&
523 w->hdr.part_number == 1)
525 ERROR("Only found %d images in WIM, but expected %u",
526 w->current_image, w->hdr.image_count);
527 return WIMLIB_ERR_IMAGE_COUNT;
530 /* Sort images by the position of their metadata resources. I'm
531 * assuming that is what determines the other of the images in the WIM
532 * file, rather than their order in the lookup table, which is random
533 * because of hashing. */
534 qsort(w->image_metadata, w->current_image,
535 sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
537 w->current_image = WIMLIB_NO_IMAGE;
539 /* Read the XML data. */
540 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
541 &w->xml_data, &w->wim_info);
546 xml_num_images = wim_info_get_num_images(w->wim_info);
547 if (xml_num_images != w->hdr.image_count) {
548 ERROR("In the file `%s', there are %u <IMAGE> elements "
549 "in the XML data,", in_wim_path, xml_num_images);
550 ERROR("but %u images in the WIM! There must be exactly one "
551 "<IMAGE> element per image.", w->hdr.image_count);
552 return WIMLIB_ERR_IMAGE_COUNT;
555 DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
561 * Opens a WIM file and creates a WIMStruct for it.
563 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
565 wimlib_progress_func_t progress_func)
570 if (!wim_file || !w_ret)
571 return WIMLIB_ERR_INVALID_PARAM;
573 w = new_wim_struct();
575 return WIMLIB_ERR_NOMEM;
577 ret = begin_read(w, wim_file, open_flags, progress_func);
585 void destroy_image_metadata(struct wim_image_metadata *imd,
586 struct wim_lookup_table *table)
588 free_dentry_tree(imd->root_dentry, table);
589 free_security_data(imd->security_data);
591 /* Get rid of the lookup table entry for this image's metadata resource
594 lookup_table_unlink(table, imd->metadata_lte);
595 free_lookup_table_entry(imd->metadata_lte);
599 /* Frees the memory for the WIMStruct, including all internal memory; also
600 * closes all files associated with the WIMStruct. */
601 WIMLIBAPI void wimlib_free(WIMStruct *w)
603 DEBUG2("Freeing WIMStruct");
614 for (size_t i = 0; i < w->num_allocated_fps; i++)
616 fclose(w->fp_tab[i]);
619 pthread_mutex_destroy(&w->fp_tab_mutex);
622 free_lookup_table(w->lookup_table);
626 free_wim_info(w->wim_info);
627 if (w->image_metadata) {
628 for (unsigned i = 0; i < w->hdr.image_count; i++)
629 destroy_image_metadata(&w->image_metadata[i], NULL);
630 FREE(w->image_metadata);
634 DEBUG("Unmounting NTFS volume");
635 ntfs_umount(w->ntfs_vol, FALSE);
641 /* Get global memory allocations out of the way. Not strictly necessary in
642 * single-threaded programs like 'imagex'. */
643 WIMLIBAPI int wimlib_global_init()
645 libxml_global_init();
646 return iconv_global_init();
649 /* Free global memory allocations. Not strictly necessary if the process using
650 * wimlib is just about to exit (as is the case for 'imagex'). */
651 WIMLIBAPI void wimlib_global_cleanup()
653 libxml_global_cleanup();
654 iconv_global_cleanup();