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/.
37 # include <ntfs-3g/volume.h>
43 # include <langinfo.h>
46 #include "buffer_io.h"
48 #include "lookup_table.h"
49 #include "wimlib_internal.h"
53 image_print_metadata(WIMStruct *w)
55 DEBUG("Printing metadata for image %d", w->current_image);
56 print_security_data(wim_security_data(w));
57 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
63 image_print_files(WIMStruct *w)
65 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
72 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
74 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
75 ERROR_WITH_ERRNO("Failed to initialize mutex");
85 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
86 * is called on the WIM once for each image, with each image selected as the
87 * current image in turn. If @image is a certain image, @visitor is called on
88 * the WIM only once, with that image selected.
91 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
98 if (image == WIMLIB_ALL_IMAGES) {
100 end = w->hdr.image_count;
101 } else if (image >= 1 && image <= w->hdr.image_count) {
105 return WIMLIB_ERR_INVALID_IMAGE;
107 for (i = start; i <= end; i++) {
108 ret = select_wim_image(w, i);
119 sort_image_metadata_by_position(const void *p1, const void *p2)
121 const struct wim_image_metadata *imd1 = p1;
122 const struct wim_image_metadata *imd2 = p2;
123 u64 offset1 = imd1->metadata_lte->resource_entry.offset;
124 u64 offset2 = imd2->metadata_lte->resource_entry.offset;
125 if (offset1 < offset2)
127 else if (offset1 > offset2)
134 * If @lte points to a metadata resource, append it to the list of metadata
135 * resources in the WIMStruct. Otherwise, do nothing.
138 append_metadata_resource_entry(struct wim_lookup_table_entry *lte, void *wim_p)
140 WIMStruct *w = wim_p;
143 if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
144 if (w->current_image == w->hdr.image_count) {
145 ERROR("The WIM header says there are %u images in the WIM,\n"
146 " but we found more metadata resources than this",
148 ret = WIMLIB_ERR_IMAGE_COUNT;
150 DEBUG("Found metadata resource for image %u at "
152 w->current_image + 1,
153 lte->resource_entry.offset);
155 w->current_image++].metadata_lte = lte;
161 /* Returns the compression type given in the flags of a WIM header. */
163 wim_hdr_flags_compression_type(int wim_hdr_flags)
165 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
166 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
167 return WIMLIB_COMPRESSION_TYPE_LZX;
168 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
169 return WIMLIB_COMPRESSION_TYPE_XPRESS;
171 return WIMLIB_COMPRESSION_TYPE_INVALID;
173 return WIMLIB_COMPRESSION_TYPE_NONE;
178 * Creates a WIMStruct for a new WIM file.
181 wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
184 struct wim_lookup_table *table;
187 DEBUG("Creating new WIM with %"TS" compression.",
188 wimlib_get_compression_type_string(ctype));
190 /* Allocate the WIMStruct. */
191 w = new_wim_struct();
193 return WIMLIB_ERR_NOMEM;
195 ret = init_header(&w->hdr, ctype);
199 table = new_lookup_table(9001);
201 ret = WIMLIB_ERR_NOMEM;
204 w->lookup_table = table;
213 wimlib_get_num_images(const WIMStruct *w)
215 return w->hdr.image_count;
219 select_wim_image(WIMStruct *w, int image)
221 struct wim_image_metadata *imd;
224 DEBUG("Selecting image %d", image);
226 if (image == WIMLIB_NO_IMAGE) {
227 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
228 return WIMLIB_ERR_INVALID_IMAGE;
231 if (image == w->current_image)
234 if (image < 1 || image > w->hdr.image_count) {
235 ERROR("Cannot select image %d: There are only %u images",
236 image, w->hdr.image_count);
237 return WIMLIB_ERR_INVALID_IMAGE;
240 /* If a valid image is currently selected, it can be freed if it is not
242 if (w->current_image != WIMLIB_NO_IMAGE) {
243 imd = wim_get_current_image_metadata(w);
244 if (!imd->modified) {
245 DEBUG("Freeing image %u", w->current_image);
246 destroy_image_metadata(imd, NULL);
247 imd->root_dentry = NULL;
248 imd->security_data = NULL;
249 INIT_HLIST_HEAD(&imd->inode_list);
252 w->current_image = image;
253 imd = &w->image_metadata[image - 1];
254 if (imd->root_dentry) {
258 DEBUG("Reading metadata resource specified by the following "
259 "lookup table entry:");
260 print_lookup_table_entry(imd->metadata_lte, stdout);
262 ret = read_metadata_resource(w, imd);
264 w->current_image = WIMLIB_NO_IMAGE;
270 /* Returns the compression type of the WIM file. */
272 wimlib_get_compression_type(const WIMStruct *w)
274 return wim_hdr_flags_compression_type(w->hdr.flags);
277 WIMLIBAPI const tchar *
278 wimlib_get_compression_type_string(int ctype)
281 case WIMLIB_COMPRESSION_TYPE_NONE:
283 case WIMLIB_COMPRESSION_TYPE_LZX:
285 case WIMLIB_COMPRESSION_TYPE_XPRESS:
293 * Returns the number of an image in the WIM file, given a string that is either
294 * the number of the image, or the name of the image. The images are numbered
298 wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
304 if (!image_name_or_num || !*image_name_or_num)
305 return WIMLIB_NO_IMAGE;
307 if (!tstrcasecmp(image_name_or_num, T("all"))
308 || !tstrcasecmp(image_name_or_num, T("*")))
309 return WIMLIB_ALL_IMAGES;
310 image = tstrtol(image_name_or_num, &p, 10);
311 if (p != image_name_or_num && *p == T('\0') && image > 0) {
312 if (image > w->hdr.image_count)
313 return WIMLIB_NO_IMAGE;
316 for (i = 1; i <= w->hdr.image_count; i++) {
317 if (tstrcmp(image_name_or_num,
318 wimlib_get_image_name(w, i)) == 0)
321 return WIMLIB_NO_IMAGE;
325 /* Prints some basic information about a WIM file. */
327 wimlib_print_wim_information(const WIMStruct *w)
329 const struct wim_header *hdr;
332 tputs(T("WIM Information:"));
333 tputs(T("----------------"));
334 tprintf(T("Path: %"TS"\n"), w->filename);
335 tfputs(T("GUID: 0x"), stdout);
336 print_byte_field(hdr->guid, WIM_GID_LEN);
338 tprintf(T("Image Count: %d\n"), hdr->image_count);
339 tprintf(T("Compression: %"TS"\n"),
340 wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
341 tprintf(T("Part Number: %d/%d\n"), hdr->part_number, hdr->total_parts);
342 tprintf(T("Boot Index: %d\n"), hdr->boot_idx);
343 tprintf(T("Size: %"PRIu64" bytes\n"),
344 wim_info_get_total_bytes(w->wim_info));
345 tprintf(T("Integrity Info: %"TS"\n"),
346 (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
351 wimlib_has_integrity_table(const WIMStruct *w)
353 return w->hdr.integrity.size != 0;
357 wimlib_print_available_images(const WIMStruct *w, int image)
363 if (image == WIMLIB_ALL_IMAGES) {
364 n = tprintf(T("Available Images:\n"));
366 last = w->hdr.image_count;
367 } else if (image >= 1 && image <= w->hdr.image_count) {
368 n = tprintf(T("Information for Image %d\n"), image);
372 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
376 for (i = 0; i < n - 1; i++)
379 for (i = first; i <= last; i++)
380 print_image_info(w->wim_info, i);
384 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
385 * not WIMLIB_NO_IMAGE. */
387 wimlib_print_metadata(WIMStruct *w, int image)
389 if (w->hdr.part_number != 1) {
390 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
391 w->hdr.part_number, w->hdr.total_parts);
392 ERROR("Select the first part of the split WIM to see the metadata.");
393 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
395 return for_image(w, image, image_print_metadata);
399 wimlib_print_files(WIMStruct *w, int image)
401 if (w->hdr.part_number != 1) {
402 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
403 w->hdr.part_number, w->hdr.total_parts);
404 ERROR("Select the first part of the split WIM if you'd like to list the files.");
405 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
407 return for_image(w, image, image_print_files);
410 /* Sets the index of the bootable image. */
412 wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
414 if (w->hdr.total_parts != 1) {
415 ERROR("Cannot modify the boot index of a split WIM!");
416 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
418 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
419 return WIMLIB_ERR_INVALID_IMAGE;
420 w->hdr.boot_idx = boot_idx;
423 memset(&w->hdr.boot_metadata_res_entry, 0,
424 sizeof(struct resource_entry));
426 memcpy(&w->hdr.boot_metadata_res_entry,
428 boot_idx - 1].metadata_lte->resource_entry,
429 sizeof(struct resource_entry));
436 wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
439 *total_parts_ret = w->hdr.total_parts;
440 return w->hdr.part_number;
445 wimlib_get_boot_idx(const WIMStruct *w)
447 return w->hdr.boot_idx;
451 * Begins the reading of a WIM file; opens the file and reads its header and
452 * lookup table, and optionally checks the integrity.
455 begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
456 wimlib_progress_func_t progress_func)
461 DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
463 w->fp = tfopen(in_wim_path, T("rb"));
465 ERROR_WITH_ERRNO("Failed to open `%"TS"' for reading",
467 return WIMLIB_ERR_OPEN;
470 /* The absolute path to the WIM is requested so that wimlib_overwrite()
471 * still works even if the process changes its working directory. This
472 * actually happens if a WIM is mounted read-write, since the FUSE
473 * thread changes directory to "/", and it needs to be able to find the
476 * This will break if the full path to the WIM changes in the
477 * intervening time...
479 * Warning: in Windows native builds, realpath() calls the replacement
480 * function in win32.c.
482 w->filename = realpath(in_wim_path, NULL);
484 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
486 return WIMLIB_ERR_NOMEM;
488 return WIMLIB_ERR_OPEN;
491 ret = read_header(w->fp, &w->hdr, open_flags);
495 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
497 /* If the boot index is invalid, print a warning and set it to 0 */
498 if (w->hdr.boot_idx > w->hdr.image_count) {
499 WARNING("In `%"TS"', image %u is marked as bootable, "
500 "but there are only %u images in the WIM",
501 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
505 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
506 ERROR("Invalid compression type (WIM header flags = 0x%x)",
508 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
511 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
512 ret = check_wim_integrity(w, progress_func);
513 if (ret == WIM_INTEGRITY_NONEXISTENT) {
514 WARNING("No integrity information for `%"TS"'; skipping "
515 "integrity check.", in_wim_path);
516 } else if (ret == WIM_INTEGRITY_NOT_OK) {
517 ERROR("WIM is not intact! (Failed integrity check)");
518 return WIMLIB_ERR_INTEGRITY;
519 } else if (ret != WIM_INTEGRITY_OK) {
524 ret = read_lookup_table(w);
528 if (w->hdr.image_count != 0) {
529 w->image_metadata = CALLOC(w->hdr.image_count,
530 sizeof(struct wim_image_metadata));
532 if (!w->image_metadata) {
533 ERROR("Failed to allocate memory for %u image metadata structures",
535 return WIMLIB_ERR_NOMEM;
538 w->current_image = 0;
540 DEBUG("Looking for metadata resources in the lookup table.");
542 /* Find the images in the WIM by searching the lookup table. */
543 ret = for_lookup_table_entry(w->lookup_table,
544 append_metadata_resource_entry, w);
549 /* Make sure all the expected images were found. (We already have
550 * returned WIMLIB_ERR_IMAGE_COUNT if *extra* images were found) */
551 if (w->current_image != w->hdr.image_count &&
552 w->hdr.part_number == 1)
554 ERROR("Only found %d images in WIM, but expected %u",
555 w->current_image, w->hdr.image_count);
556 return WIMLIB_ERR_IMAGE_COUNT;
559 /* Sort images by the position of their metadata resources. I'm
560 * assuming that is what determines the other of the images in the WIM
561 * file, rather than their order in the lookup table, which is random
562 * because of hashing. */
563 qsort(w->image_metadata, w->current_image,
564 sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
566 w->current_image = WIMLIB_NO_IMAGE;
568 /* Read the XML data. */
569 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
570 &w->xml_data, &w->wim_info);
575 xml_num_images = wim_info_get_num_images(w->wim_info);
576 if (xml_num_images != w->hdr.image_count) {
577 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
578 "in the XML data,", in_wim_path, xml_num_images);
579 ERROR("but %u images in the WIM! There must be exactly one "
580 "<IMAGE> element per image.", w->hdr.image_count);
581 return WIMLIB_ERR_IMAGE_COUNT;
584 DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
589 * Opens a WIM file and creates a WIMStruct for it.
592 wimlib_open_wim(const tchar *wim_file, int open_flags,
594 wimlib_progress_func_t progress_func)
599 if (!wim_file || !w_ret)
600 return WIMLIB_ERR_INVALID_PARAM;
602 w = new_wim_struct();
604 return WIMLIB_ERR_NOMEM;
606 ret = begin_read(w, wim_file, open_flags, progress_func);
615 destroy_image_metadata(struct wim_image_metadata *imd,
616 struct wim_lookup_table *table)
618 free_dentry_tree(imd->root_dentry, table);
619 free_security_data(imd->security_data);
621 /* Get rid of the lookup table entry for this image's metadata resource
624 lookup_table_unlink(table, imd->metadata_lte);
625 free_lookup_table_entry(imd->metadata_lte);
629 /* Frees the memory for the WIMStruct, including all internal memory; also
630 * closes all files associated with the WIMStruct. */
632 wimlib_free(WIMStruct *w)
634 DEBUG("Freeing WIMStruct");
645 for (size_t i = 0; i < w->num_allocated_fps; i++)
647 fclose(w->fp_tab[i]);
650 pthread_mutex_destroy(&w->fp_tab_mutex);
653 free_lookup_table(w->lookup_table);
657 free_wim_info(w->wim_info);
658 if (w->image_metadata) {
659 for (unsigned i = 0; i < w->hdr.image_count; i++)
660 destroy_image_metadata(&w->image_metadata[i], NULL);
661 FREE(w->image_metadata);
665 DEBUG("Unmounting NTFS volume");
666 ntfs_umount(w->ntfs_vol, FALSE);
670 DEBUG("Freed WIMStruct");
674 test_locale_ctype_utf8()
676 char *ctype = nl_langinfo(CODESET);
678 return (!strstr(ctype, "UTF-8") ||
679 !strstr(ctype, "UTF8") ||
680 !strstr(ctype, "utf8") ||
681 !strstr(ctype, "utf-8"));
684 /* Get global memory allocations out of the way,
685 * single-threaded programs like 'imagex'. */
689 libxml_global_init();
691 libntfs3g_global_init();
693 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
700 /* Free global memory allocations. Not strictly necessary if the process using
701 * wimlib is just about to exit (as is the case for 'imagex'). */
703 wimlib_global_cleanup()
705 libxml_global_cleanup();
706 iconv_global_cleanup();
708 win32_global_cleanup();