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 <langinfo.h>
41 #include "buffer_io.h"
43 #include "lookup_table.h"
44 #include "wimlib_internal.h"
48 image_print_metadata(WIMStruct *w)
50 DEBUG("Printing metadata for image %d", w->current_image);
51 print_security_data(wim_security_data(w));
52 return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
58 image_print_files(WIMStruct *w)
60 return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
67 WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
69 if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
70 ERROR_WITH_ERRNO("Failed to initialize mutex");
80 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
81 * is called on the WIM once for each image, with each image selected as the
82 * current image in turn. If @image is a certain image, @visitor is called on
83 * the WIM only once, with that image selected.
86 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 /* Returns the compression type given in the flags of a WIM header. */
115 wim_hdr_flags_compression_type(int wim_hdr_flags)
117 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
118 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
119 return WIMLIB_COMPRESSION_TYPE_LZX;
120 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
121 return WIMLIB_COMPRESSION_TYPE_XPRESS;
123 return WIMLIB_COMPRESSION_TYPE_INVALID;
125 return WIMLIB_COMPRESSION_TYPE_NONE;
130 * Creates a WIMStruct for a new WIM file.
133 wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
136 struct wim_lookup_table *table;
139 DEBUG("Creating new WIM with %"TS" compression.",
140 wimlib_get_compression_type_string(ctype));
142 /* Allocate the WIMStruct. */
143 w = new_wim_struct();
145 return WIMLIB_ERR_NOMEM;
147 ret = init_header(&w->hdr, ctype);
151 table = new_lookup_table(9001);
153 ret = WIMLIB_ERR_NOMEM;
156 w->lookup_table = table;
165 wimlib_get_num_images(const WIMStruct *w)
167 return w->hdr.image_count;
171 select_wim_image(WIMStruct *w, int image)
173 struct wim_image_metadata *imd;
176 DEBUG("Selecting image %d", image);
178 if (image == WIMLIB_NO_IMAGE) {
179 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
180 return WIMLIB_ERR_INVALID_IMAGE;
183 if (image == w->current_image)
186 if (image < 1 || image > w->hdr.image_count) {
187 ERROR("Cannot select image %d: There are only %u images",
188 image, w->hdr.image_count);
189 return WIMLIB_ERR_INVALID_IMAGE;
192 /* If a valid image is currently selected, it can be freed if it is not
194 if (w->current_image != WIMLIB_NO_IMAGE) {
195 imd = wim_get_current_image_metadata(w);
196 if (!imd->modified) {
197 wimlib_assert(list_empty(&imd->unhashed_streams));
198 DEBUG("Freeing image %u", w->current_image);
199 destroy_image_metadata(imd, NULL, false);
202 w->current_image = image;
203 imd = wim_get_current_image_metadata(w);
204 if (imd->root_dentry) {
208 DEBUG("Reading metadata resource specified by the following "
209 "lookup table entry:");
210 print_lookup_table_entry(imd->metadata_lte, stderr);
212 ret = read_metadata_resource(w, imd);
214 w->current_image = WIMLIB_NO_IMAGE;
220 /* Returns the compression type of the WIM file. */
222 wimlib_get_compression_type(const WIMStruct *w)
224 return wim_hdr_flags_compression_type(w->hdr.flags);
227 WIMLIBAPI const tchar *
228 wimlib_get_compression_type_string(int ctype)
231 case WIMLIB_COMPRESSION_TYPE_NONE:
233 case WIMLIB_COMPRESSION_TYPE_LZX:
235 case WIMLIB_COMPRESSION_TYPE_XPRESS:
243 * Returns the number of an image in the WIM file, given a string that is either
244 * the number of the image, or the name of the image. The images are numbered
248 wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
254 if (!image_name_or_num || !*image_name_or_num)
255 return WIMLIB_NO_IMAGE;
257 if (!tstrcasecmp(image_name_or_num, T("all"))
258 || !tstrcasecmp(image_name_or_num, T("*")))
259 return WIMLIB_ALL_IMAGES;
260 image = tstrtol(image_name_or_num, &p, 10);
261 if (p != image_name_or_num && *p == T('\0') && image > 0) {
262 if (image > w->hdr.image_count)
263 return WIMLIB_NO_IMAGE;
266 for (i = 1; i <= w->hdr.image_count; i++) {
267 if (!tstrcmp(image_name_or_num,
268 wimlib_get_image_name(w, i)))
271 return WIMLIB_NO_IMAGE;
275 /* Prints some basic information about a WIM file. */
277 wimlib_print_wim_information(const WIMStruct *w)
279 const struct wim_header *hdr;
282 tputs(T("WIM Information:"));
283 tputs(T("----------------"));
284 tprintf(T("Path: %"TS"\n"), w->filename);
285 tfputs(T("GUID: 0x"), stdout);
286 print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
288 tprintf(T("Image Count: %d\n"), hdr->image_count);
289 tprintf(T("Compression: %"TS"\n"),
290 wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
291 tprintf(T("Part Number: %d/%d\n"), hdr->part_number, hdr->total_parts);
292 tprintf(T("Boot Index: %d\n"), hdr->boot_idx);
293 tprintf(T("Size: %"PRIu64" bytes\n"),
294 wim_info_get_total_bytes(w->wim_info));
295 tprintf(T("Integrity Info: %"TS"\n"),
296 (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
301 wimlib_has_integrity_table(const WIMStruct *w)
303 return w->hdr.integrity.size != 0;
307 wimlib_print_available_images(const WIMStruct *w, int image)
313 if (image == WIMLIB_ALL_IMAGES) {
314 n = tprintf(T("Available Images:\n"));
316 last = w->hdr.image_count;
317 } else if (image >= 1 && image <= w->hdr.image_count) {
318 n = tprintf(T("Information for Image %d\n"), image);
322 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
326 for (i = 0; i < n - 1; i++)
329 for (i = first; i <= last; i++)
330 print_image_info(w->wim_info, i);
334 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
335 * not WIMLIB_NO_IMAGE. */
337 wimlib_print_metadata(WIMStruct *w, int image)
339 if (w->hdr.part_number != 1) {
340 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
341 w->hdr.part_number, w->hdr.total_parts);
342 ERROR("Select the first part of the split WIM to see the metadata.");
343 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
345 return for_image(w, image, image_print_metadata);
349 wimlib_print_files(WIMStruct *w, int image)
351 if (w->hdr.part_number != 1) {
352 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
353 w->hdr.part_number, w->hdr.total_parts);
354 ERROR("Select the first part of the split WIM if you'd like to list the files.");
355 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
357 return for_image(w, image, image_print_files);
360 /* Sets the index of the bootable image. */
362 wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
364 if (w->hdr.total_parts != 1) {
365 ERROR("Cannot modify the boot index of a split WIM!");
366 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
368 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
369 return WIMLIB_ERR_INVALID_IMAGE;
370 w->hdr.boot_idx = boot_idx;
375 wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
378 *total_parts_ret = w->hdr.total_parts;
379 return w->hdr.part_number;
384 wimlib_get_boot_idx(const WIMStruct *w)
386 return w->hdr.boot_idx;
390 * Begins the reading of a WIM file; opens the file and reads its header and
391 * lookup table, and optionally checks the integrity.
394 begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
395 wimlib_progress_func_t progress_func)
400 DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
402 w->fp = tfopen(in_wim_path, T("rb"));
404 ERROR_WITH_ERRNO("Failed to open `%"TS"' for reading",
406 return WIMLIB_ERR_OPEN;
409 /* The absolute path to the WIM is requested so that wimlib_overwrite()
410 * still works even if the process changes its working directory. This
411 * actually happens if a WIM is mounted read-write, since the FUSE
412 * thread changes directory to "/", and it needs to be able to find the
415 * This will break if the full path to the WIM changes in the
416 * intervening time...
418 * Warning: in Windows native builds, realpath() calls the replacement
419 * function in win32.c.
421 w->filename = realpath(in_wim_path, NULL);
423 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
425 return WIMLIB_ERR_NOMEM;
427 return WIMLIB_ERR_OPEN;
430 ret = read_header(w->fp, &w->hdr, open_flags);
434 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
436 /* If the boot index is invalid, print a warning and set it to 0 */
437 if (w->hdr.boot_idx > w->hdr.image_count) {
438 WARNING("In `%"TS"', image %u is marked as bootable, "
439 "but there are only %u images in the WIM",
440 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
444 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
445 ERROR("Invalid compression type (WIM header flags = 0x%x)",
447 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
450 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
451 ret = check_wim_integrity(w, progress_func);
452 if (ret == WIM_INTEGRITY_NONEXISTENT) {
453 WARNING("No integrity information for `%"TS"'; skipping "
454 "integrity check.", in_wim_path);
455 } else if (ret == WIM_INTEGRITY_NOT_OK) {
456 ERROR("WIM is not intact! (Failed integrity check)");
457 return WIMLIB_ERR_INTEGRITY;
458 } else if (ret != WIM_INTEGRITY_OK) {
463 if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
464 w->image_metadata = new_image_metadata_array(w->hdr.image_count);
465 if (!w->image_metadata)
466 return WIMLIB_ERR_NOMEM;
469 ret = read_lookup_table(w);
473 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
474 &w->xml_data, &w->wim_info);
478 xml_num_images = wim_info_get_num_images(w->wim_info);
479 if (xml_num_images != w->hdr.image_count) {
480 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
481 "in the XML data,", in_wim_path, xml_num_images);
482 ERROR("but %u images in the WIM! There must be exactly one "
483 "<IMAGE> element per image.", w->hdr.image_count);
484 return WIMLIB_ERR_IMAGE_COUNT;
487 DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
492 * Opens a WIM file and creates a WIMStruct for it.
495 wimlib_open_wim(const tchar *wim_file, int open_flags,
497 wimlib_progress_func_t progress_func)
502 if (!wim_file || !w_ret)
503 return WIMLIB_ERR_INVALID_PARAM;
505 w = new_wim_struct();
507 return WIMLIB_ERR_NOMEM;
509 ret = begin_read(w, wim_file, open_flags, progress_func);
518 destroy_image_metadata(struct wim_image_metadata *imd,
519 struct wim_lookup_table *table,
520 bool free_metadata_lte)
522 free_dentry_tree(imd->root_dentry, table);
523 imd->root_dentry = NULL;
524 free_security_data(imd->security_data);
525 imd->security_data = NULL;
527 if (free_metadata_lte) {
528 free_lookup_table_entry(imd->metadata_lte);
529 imd->metadata_lte = NULL;
532 struct wim_lookup_table_entry *lte, *tmp;
533 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
534 free_lookup_table_entry(lte);
536 INIT_LIST_HEAD(&imd->unhashed_streams);
537 INIT_LIST_HEAD(&imd->inode_list);
540 do_ntfs_umount(imd->ntfs_vol);
541 imd->ntfs_vol = NULL;
547 put_image_metadata(struct wim_image_metadata *imd,
548 struct wim_lookup_table *table)
550 if (imd && --imd->refcnt == 0) {
551 destroy_image_metadata(imd, table, true);
556 /* Appends the specified image metadata structure to the array of image metadata
557 * for a WIM, and increments the image count. */
559 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd)
561 struct wim_image_metadata **imd_array;
563 DEBUG("Reallocating image metadata array for image_count = %u",
564 w->hdr.image_count + 1);
565 imd_array = REALLOC(w->image_metadata,
566 sizeof(w->image_metadata[0]) * (w->hdr.image_count + 1));
569 return WIMLIB_ERR_NOMEM;
570 w->image_metadata = imd_array;
571 imd_array[w->hdr.image_count++] = imd;
576 struct wim_image_metadata *
579 struct wim_image_metadata *imd;
581 imd = CALLOC(1, sizeof(*imd));
584 INIT_LIST_HEAD(&imd->inode_list);
585 INIT_LIST_HEAD(&imd->unhashed_streams);
586 DEBUG("Created new image metadata (refcnt=1)");
588 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
593 struct wim_image_metadata **
594 new_image_metadata_array(unsigned num_images)
596 struct wim_image_metadata **imd_array;
598 DEBUG("Creating new image metadata array for %u images",
601 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
604 ERROR("Failed to allocate memory for %u image metadata structures",
608 for (unsigned i = 0; i < num_images; i++) {
609 imd_array[i] = new_image_metadata();
611 for (unsigned j = 0; j < i; j++)
612 put_image_metadata(imd_array[j], NULL);
620 /* Checksum all streams that are unhashed (other than the metadata streams),
621 * merging them into the lookup table as needed. This is a no-op unless the
622 * library has previously used to add or mount an image using the same
625 wim_checksum_unhashed_streams(WIMStruct *w)
628 for (int i = 0; i < w->hdr.image_count; i++) {
629 struct wim_lookup_table_entry *lte, *tmp;
630 list_for_each_entry_safe(lte, tmp,
631 &w->image_metadata[i]->unhashed_streams,
634 ret = hash_unhashed_stream(lte, w->lookup_table, NULL);
642 /* Frees the memory for the WIMStruct, including all internal memory; also
643 * closes all files associated with the WIMStruct. */
645 wimlib_free(WIMStruct *w)
647 DEBUG("Freeing WIMStruct");
658 for (size_t i = 0; i < w->num_allocated_fps; i++)
660 fclose(w->fp_tab[i]);
663 pthread_mutex_destroy(&w->fp_tab_mutex);
666 free_lookup_table(w->lookup_table);
670 free_wim_info(w->wim_info);
671 if (w->image_metadata) {
672 for (unsigned i = 0; i < w->hdr.image_count; i++)
673 put_image_metadata(w->image_metadata[i], NULL);
674 FREE(w->image_metadata);
677 DEBUG("Freed WIMStruct");
681 test_locale_ctype_utf8()
686 char *ctype = nl_langinfo(CODESET);
688 return (!strstr(ctype, "UTF-8") ||
689 !strstr(ctype, "UTF8") ||
690 !strstr(ctype, "utf8") ||
691 !strstr(ctype, "utf-8"));
695 /* Get global memory allocations out of the way,
696 * single-threaded programs like 'imagex'. */
700 libxml_global_init();
702 libntfs3g_global_init();
704 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
711 /* Free global memory allocations. Not strictly necessary if the process using
712 * wimlib is just about to exit (as is the case for 'imagex'). */
714 wimlib_global_cleanup()
716 libxml_global_cleanup();
717 iconv_global_cleanup();
719 win32_global_cleanup();