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));
68 w->in_fd = INVALID_FILEDES;
69 w->out_fd = INVALID_FILEDES;
70 w->current_image = WIMLIB_NO_IMAGE;
75 * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
76 * is called on the WIM once for each image, with each image selected as the
77 * current image in turn. If @image is a certain image, @visitor is called on
78 * the WIM only once, with that image selected.
81 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 /* Returns the compression type given in the flags of a WIM header. */
110 wim_hdr_flags_compression_type(int wim_hdr_flags)
112 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
113 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
114 return WIMLIB_COMPRESSION_TYPE_LZX;
115 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
116 return WIMLIB_COMPRESSION_TYPE_XPRESS;
118 return WIMLIB_COMPRESSION_TYPE_INVALID;
120 return WIMLIB_COMPRESSION_TYPE_NONE;
125 * Creates a WIMStruct for a new WIM file.
128 wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
131 struct wim_lookup_table *table;
134 DEBUG("Creating new WIM with %"TS" compression.",
135 wimlib_get_compression_type_string(ctype));
137 /* Allocate the WIMStruct. */
138 w = new_wim_struct();
140 return WIMLIB_ERR_NOMEM;
142 ret = init_header(&w->hdr, ctype);
146 table = new_lookup_table(9001);
148 ret = WIMLIB_ERR_NOMEM;
151 w->lookup_table = table;
160 wimlib_get_num_images(const WIMStruct *w)
162 return w->hdr.image_count;
166 select_wim_image(WIMStruct *w, int image)
168 struct wim_image_metadata *imd;
171 DEBUG("Selecting image %d", image);
173 if (image == WIMLIB_NO_IMAGE) {
174 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
175 return WIMLIB_ERR_INVALID_IMAGE;
178 if (image == w->current_image)
181 if (image < 1 || image > w->hdr.image_count) {
182 ERROR("Cannot select image %d: There are only %u images",
183 image, w->hdr.image_count);
184 return WIMLIB_ERR_INVALID_IMAGE;
187 /* If a valid image is currently selected, it can be freed if it is not
189 if (w->current_image != WIMLIB_NO_IMAGE) {
190 imd = wim_get_current_image_metadata(w);
191 if (!imd->modified) {
192 wimlib_assert(list_empty(&imd->unhashed_streams));
193 DEBUG("Freeing image %u", w->current_image);
194 destroy_image_metadata(imd, NULL, false);
197 w->current_image = image;
198 imd = wim_get_current_image_metadata(w);
199 if (imd->root_dentry) {
203 DEBUG("Reading metadata resource specified by the following "
204 "lookup table entry:");
205 print_lookup_table_entry(imd->metadata_lte, stderr);
207 ret = read_metadata_resource(w, imd);
209 w->current_image = WIMLIB_NO_IMAGE;
215 /* Returns the compression type of the WIM file. */
217 wimlib_get_compression_type(const WIMStruct *w)
219 return wim_hdr_flags_compression_type(w->hdr.flags);
222 WIMLIBAPI const tchar *
223 wimlib_get_compression_type_string(int ctype)
226 case WIMLIB_COMPRESSION_TYPE_NONE:
228 case WIMLIB_COMPRESSION_TYPE_LZX:
230 case WIMLIB_COMPRESSION_TYPE_XPRESS:
238 * Returns the number of an image in the WIM file, given a string that is either
239 * the number of the image, or the name of the image. The images are numbered
243 wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
249 if (!image_name_or_num || !*image_name_or_num)
250 return WIMLIB_NO_IMAGE;
252 if (!tstrcasecmp(image_name_or_num, T("all"))
253 || !tstrcasecmp(image_name_or_num, T("*")))
254 return WIMLIB_ALL_IMAGES;
255 image = tstrtol(image_name_or_num, &p, 10);
256 if (p != image_name_or_num && *p == T('\0') && image > 0) {
257 if (image > w->hdr.image_count)
258 return WIMLIB_NO_IMAGE;
261 for (i = 1; i <= w->hdr.image_count; i++) {
262 if (!tstrcmp(image_name_or_num,
263 wimlib_get_image_name(w, i)))
266 return WIMLIB_NO_IMAGE;
270 /* Prints some basic information about a WIM file. */
272 wimlib_print_wim_information(const WIMStruct *w)
274 const struct wim_header *hdr;
277 tputs(T("WIM Information:"));
278 tputs(T("----------------"));
279 tprintf(T("Path: %"TS"\n"), w->filename);
280 tfputs(T("GUID: 0x"), stdout);
281 print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
283 tprintf(T("Image Count: %d\n"), hdr->image_count);
284 tprintf(T("Compression: %"TS"\n"),
285 wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
286 tprintf(T("Part Number: %d/%d\n"), hdr->part_number, hdr->total_parts);
287 tprintf(T("Boot Index: %d\n"), hdr->boot_idx);
288 tprintf(T("Size: %"PRIu64" bytes\n"),
289 wim_info_get_total_bytes(w->wim_info));
290 tprintf(T("Integrity Info: %"TS"\n"),
291 (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
292 tprintf(T("Relative path junction: %"TS"\n"),
293 (hdr->flags & WIM_HDR_FLAG_RP_FIX) ? T("yes") : T("no"));
298 wimlib_has_integrity_table(const WIMStruct *w)
300 return w->hdr.integrity.size != 0;
304 wimlib_print_available_images(const WIMStruct *w, int image)
310 if (image == WIMLIB_ALL_IMAGES) {
311 n = tprintf(T("Available Images:\n"));
313 last = w->hdr.image_count;
314 } else if (image >= 1 && image <= w->hdr.image_count) {
315 n = tprintf(T("Information for Image %d\n"), image);
319 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
323 for (i = 0; i < n - 1; i++)
326 for (i = first; i <= last; i++)
327 print_image_info(w->wim_info, i);
331 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
332 * not WIMLIB_NO_IMAGE. */
334 wimlib_print_metadata(WIMStruct *w, int image)
336 if (w->hdr.part_number != 1) {
337 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
338 w->hdr.part_number, w->hdr.total_parts);
339 ERROR("Select the first part of the split WIM to see the metadata.");
340 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
342 return for_image(w, image, image_print_metadata);
346 wimlib_print_files(WIMStruct *w, int image)
348 if (w->hdr.part_number != 1) {
349 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
350 w->hdr.part_number, w->hdr.total_parts);
351 ERROR("Select the first part of the split WIM if you'd like to list the files.");
352 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
354 return for_image(w, image, image_print_files);
357 /* Sets the index of the bootable image. */
359 wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
361 if (w->hdr.total_parts != 1) {
362 ERROR("Cannot modify the boot index of a split WIM!");
363 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
365 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
366 return WIMLIB_ERR_INVALID_IMAGE;
367 w->hdr.boot_idx = boot_idx;
372 wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
375 *total_parts_ret = w->hdr.total_parts;
376 return w->hdr.part_number;
381 wimlib_get_boot_idx(const WIMStruct *w)
383 return w->hdr.boot_idx;
387 do_open_wim(const tchar *filename, filedes_t *fd_ret)
391 fd = open(filename, O_RDONLY);
393 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
394 return WIMLIB_ERR_OPEN;
401 reopen_wim(WIMStruct *w)
403 wimlib_assert(w->in_fd == INVALID_FILEDES);
404 return do_open_wim(w->filename, &w->in_fd);
408 close_wim(WIMStruct *w)
411 w->in_fd = INVALID_FILEDES;
416 * Begins the reading of a WIM file; opens the file and reads its header and
417 * lookup table, and optionally checks the integrity.
420 begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
421 wimlib_progress_func_t progress_func)
426 DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
428 ret = do_open_wim(in_wim_path, &w->in_fd);
432 /* The absolute path to the WIM is requested so that wimlib_overwrite()
433 * still works even if the process changes its working directory. This
434 * actually happens if a WIM is mounted read-write, since the FUSE
435 * thread changes directory to "/", and it needs to be able to find the
438 * This will break if the full path to the WIM changes in the
439 * intervening time...
441 * Warning: in Windows native builds, realpath() calls the replacement
442 * function in win32.c.
444 w->filename = realpath(in_wim_path, NULL);
446 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
448 return WIMLIB_ERR_NOMEM;
450 return WIMLIB_ERR_OPEN;
453 ret = read_header(w->in_fd, &w->hdr, open_flags);
457 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
459 /* If the boot index is invalid, print a warning and set it to 0 */
460 if (w->hdr.boot_idx > w->hdr.image_count) {
461 WARNING("In `%"TS"', image %u is marked as bootable, "
462 "but there are only %u images in the WIM",
463 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
467 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
468 ERROR("Invalid compression type (WIM header flags = 0x%x)",
470 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
473 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
474 ret = check_wim_integrity(w, progress_func);
475 if (ret == WIM_INTEGRITY_NONEXISTENT) {
476 WARNING("No integrity information for `%"TS"'; skipping "
477 "integrity check.", in_wim_path);
478 } else if (ret == WIM_INTEGRITY_NOT_OK) {
479 ERROR("WIM is not intact! (Failed integrity check)");
480 return WIMLIB_ERR_INTEGRITY;
481 } else if (ret != WIM_INTEGRITY_OK) {
486 if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
487 w->image_metadata = new_image_metadata_array(w->hdr.image_count);
488 if (!w->image_metadata)
489 return WIMLIB_ERR_NOMEM;
492 ret = read_lookup_table(w);
496 ret = read_xml_data(w->in_fd, &w->hdr.xml_res_entry, &w->wim_info);
500 xml_num_images = wim_info_get_num_images(w->wim_info);
501 if (xml_num_images != w->hdr.image_count) {
502 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
503 "in the XML data,", in_wim_path, xml_num_images);
504 ERROR("but %u images in the WIM! There must be exactly one "
505 "<IMAGE> element per image.", w->hdr.image_count);
506 return WIMLIB_ERR_IMAGE_COUNT;
509 DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
514 * Opens a WIM file and creates a WIMStruct for it.
517 wimlib_open_wim(const tchar *wim_file, int open_flags,
519 wimlib_progress_func_t progress_func)
524 if (!wim_file || !w_ret)
525 return WIMLIB_ERR_INVALID_PARAM;
527 w = new_wim_struct();
529 return WIMLIB_ERR_NOMEM;
531 ret = begin_read(w, wim_file, open_flags, progress_func);
540 destroy_image_metadata(struct wim_image_metadata *imd,
541 struct wim_lookup_table *table,
542 bool free_metadata_lte)
544 free_dentry_tree(imd->root_dentry, table);
545 imd->root_dentry = NULL;
546 free_security_data(imd->security_data);
547 imd->security_data = NULL;
549 if (free_metadata_lte) {
550 free_lookup_table_entry(imd->metadata_lte);
551 imd->metadata_lte = NULL;
554 struct wim_lookup_table_entry *lte, *tmp;
555 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
556 free_lookup_table_entry(lte);
558 INIT_LIST_HEAD(&imd->unhashed_streams);
559 INIT_LIST_HEAD(&imd->inode_list);
562 do_ntfs_umount(imd->ntfs_vol);
563 imd->ntfs_vol = NULL;
569 put_image_metadata(struct wim_image_metadata *imd,
570 struct wim_lookup_table *table)
572 if (imd && --imd->refcnt == 0) {
573 destroy_image_metadata(imd, table, true);
578 /* Appends the specified image metadata structure to the array of image metadata
579 * for a WIM, and increments the image count. */
581 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd)
583 struct wim_image_metadata **imd_array;
585 DEBUG("Reallocating image metadata array for image_count = %u",
586 w->hdr.image_count + 1);
587 imd_array = REALLOC(w->image_metadata,
588 sizeof(w->image_metadata[0]) * (w->hdr.image_count + 1));
591 return WIMLIB_ERR_NOMEM;
592 w->image_metadata = imd_array;
593 imd_array[w->hdr.image_count++] = imd;
598 struct wim_image_metadata *
601 struct wim_image_metadata *imd;
603 imd = CALLOC(1, sizeof(*imd));
606 INIT_LIST_HEAD(&imd->inode_list);
607 INIT_LIST_HEAD(&imd->unhashed_streams);
608 DEBUG("Created new image metadata (refcnt=1)");
610 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
615 struct wim_image_metadata **
616 new_image_metadata_array(unsigned num_images)
618 struct wim_image_metadata **imd_array;
620 DEBUG("Creating new image metadata array for %u images",
623 imd_array = CALLOC(num_images, sizeof(imd_array[0]));
626 ERROR("Failed to allocate memory for %u image metadata structures",
630 for (unsigned i = 0; i < num_images; i++) {
631 imd_array[i] = new_image_metadata();
633 for (unsigned j = 0; j < i; j++)
634 put_image_metadata(imd_array[j], NULL);
642 /* Checksum all streams that are unhashed (other than the metadata streams),
643 * merging them into the lookup table as needed. This is a no-op unless the
644 * library has previously used to add or mount an image using the same
647 wim_checksum_unhashed_streams(WIMStruct *w)
650 for (int i = 0; i < w->hdr.image_count; i++) {
651 struct wim_lookup_table_entry *lte, *tmp;
652 struct wim_image_metadata *imd = w->image_metadata[i];
653 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
654 ret = hash_unhashed_stream(lte, w->lookup_table, NULL);
662 /* Frees the memory for the WIMStruct, including all internal memory; also
663 * closes all files associated with the WIMStruct. */
665 wimlib_free(WIMStruct *w)
667 DEBUG("Freeing WIMStruct");
671 if (w->in_fd != INVALID_FILEDES)
673 if (w->out_fd != INVALID_FILEDES)
676 free_lookup_table(w->lookup_table);
679 free_wim_info(w->wim_info);
680 if (w->image_metadata) {
681 for (unsigned i = 0; i < w->hdr.image_count; i++)
682 put_image_metadata(w->image_metadata[i], NULL);
683 FREE(w->image_metadata);
686 DEBUG("Freed WIMStruct");
690 test_locale_ctype_utf8()
695 char *ctype = nl_langinfo(CODESET);
697 return (!strstr(ctype, "UTF-8") ||
698 !strstr(ctype, "UTF8") ||
699 !strstr(ctype, "utf8") ||
700 !strstr(ctype, "utf-8"));
705 wimlib_global_init(int init_flags)
707 libxml_global_init();
708 if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
709 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
711 if (!wimlib_mbs_is_utf8)
712 libntfs3g_global_init();
721 /* Free global memory allocations. Not strictly necessary if the process using
722 * wimlib is just about to exit (as is the case for 'imagex'). */
724 wimlib_global_cleanup()
726 libxml_global_cleanup();
727 iconv_global_cleanup();
729 win32_global_cleanup();