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);
118 /* Returns the compression type given in the flags of a WIM header. */
120 wim_hdr_flags_compression_type(int wim_hdr_flags)
122 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
123 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
124 return WIMLIB_COMPRESSION_TYPE_LZX;
125 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
126 return WIMLIB_COMPRESSION_TYPE_XPRESS;
128 return WIMLIB_COMPRESSION_TYPE_INVALID;
130 return WIMLIB_COMPRESSION_TYPE_NONE;
135 * Creates a WIMStruct for a new WIM file.
138 wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
141 struct wim_lookup_table *table;
144 DEBUG("Creating new WIM with %"TS" compression.",
145 wimlib_get_compression_type_string(ctype));
147 /* Allocate the WIMStruct. */
148 w = new_wim_struct();
150 return WIMLIB_ERR_NOMEM;
152 ret = init_header(&w->hdr, ctype);
156 table = new_lookup_table(9001);
158 ret = WIMLIB_ERR_NOMEM;
161 w->lookup_table = table;
170 wimlib_get_num_images(const WIMStruct *w)
172 return w->hdr.image_count;
176 select_wim_image(WIMStruct *w, int image)
178 struct wim_image_metadata *imd;
181 DEBUG("Selecting image %d", image);
183 if (image == WIMLIB_NO_IMAGE) {
184 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
185 return WIMLIB_ERR_INVALID_IMAGE;
188 if (image == w->current_image)
191 if (image < 1 || image > w->hdr.image_count) {
192 ERROR("Cannot select image %d: There are only %u images",
193 image, w->hdr.image_count);
194 return WIMLIB_ERR_INVALID_IMAGE;
197 /* If a valid image is currently selected, it can be freed if it is not
199 if (w->current_image != WIMLIB_NO_IMAGE) {
200 imd = wim_get_current_image_metadata(w);
201 if (!imd->modified) {
202 DEBUG("Freeing image %u", w->current_image);
203 destroy_image_metadata(imd, NULL);
204 imd->root_dentry = NULL;
205 imd->security_data = NULL;
206 INIT_HLIST_HEAD(&imd->inode_list);
209 w->current_image = image;
210 imd = &w->image_metadata[image - 1];
211 if (imd->root_dentry) {
215 DEBUG("Reading metadata resource specified by the following "
216 "lookup table entry:");
217 print_lookup_table_entry(imd->metadata_lte, stderr);
219 ret = read_metadata_resource(w, imd);
221 w->current_image = WIMLIB_NO_IMAGE;
227 /* Returns the compression type of the WIM file. */
229 wimlib_get_compression_type(const WIMStruct *w)
231 return wim_hdr_flags_compression_type(w->hdr.flags);
234 WIMLIBAPI const tchar *
235 wimlib_get_compression_type_string(int ctype)
238 case WIMLIB_COMPRESSION_TYPE_NONE:
240 case WIMLIB_COMPRESSION_TYPE_LZX:
242 case WIMLIB_COMPRESSION_TYPE_XPRESS:
250 * Returns the number of an image in the WIM file, given a string that is either
251 * the number of the image, or the name of the image. The images are numbered
255 wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
261 if (!image_name_or_num || !*image_name_or_num)
262 return WIMLIB_NO_IMAGE;
264 if (!tstrcasecmp(image_name_or_num, T("all"))
265 || !tstrcasecmp(image_name_or_num, T("*")))
266 return WIMLIB_ALL_IMAGES;
267 image = tstrtol(image_name_or_num, &p, 10);
268 if (p != image_name_or_num && *p == T('\0') && image > 0) {
269 if (image > w->hdr.image_count)
270 return WIMLIB_NO_IMAGE;
273 for (i = 1; i <= w->hdr.image_count; i++) {
274 if (tstrcmp(image_name_or_num,
275 wimlib_get_image_name(w, i)) == 0)
278 return WIMLIB_NO_IMAGE;
282 /* Prints some basic information about a WIM file. */
284 wimlib_print_wim_information(const WIMStruct *w)
286 const struct wim_header *hdr;
289 tputs(T("WIM Information:"));
290 tputs(T("----------------"));
291 tprintf(T("Path: %"TS"\n"), w->filename);
292 tfputs(T("GUID: 0x"), stdout);
293 print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
295 tprintf(T("Image Count: %d\n"), hdr->image_count);
296 tprintf(T("Compression: %"TS"\n"),
297 wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
298 tprintf(T("Part Number: %d/%d\n"), hdr->part_number, hdr->total_parts);
299 tprintf(T("Boot Index: %d\n"), hdr->boot_idx);
300 tprintf(T("Size: %"PRIu64" bytes\n"),
301 wim_info_get_total_bytes(w->wim_info));
302 tprintf(T("Integrity Info: %"TS"\n"),
303 (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
308 wimlib_has_integrity_table(const WIMStruct *w)
310 return w->hdr.integrity.size != 0;
314 wimlib_print_available_images(const WIMStruct *w, int image)
320 if (image == WIMLIB_ALL_IMAGES) {
321 n = tprintf(T("Available Images:\n"));
323 last = w->hdr.image_count;
324 } else if (image >= 1 && image <= w->hdr.image_count) {
325 n = tprintf(T("Information for Image %d\n"), image);
329 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
333 for (i = 0; i < n - 1; i++)
336 for (i = first; i <= last; i++)
337 print_image_info(w->wim_info, i);
341 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
342 * not WIMLIB_NO_IMAGE. */
344 wimlib_print_metadata(WIMStruct *w, int image)
346 if (w->hdr.part_number != 1) {
347 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
348 w->hdr.part_number, w->hdr.total_parts);
349 ERROR("Select the first part of the split WIM to see the metadata.");
350 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
352 return for_image(w, image, image_print_metadata);
356 wimlib_print_files(WIMStruct *w, int image)
358 if (w->hdr.part_number != 1) {
359 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
360 w->hdr.part_number, w->hdr.total_parts);
361 ERROR("Select the first part of the split WIM if you'd like to list the files.");
362 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
364 return for_image(w, image, image_print_files);
367 /* Sets the index of the bootable image. */
369 wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
371 if (w->hdr.total_parts != 1) {
372 ERROR("Cannot modify the boot index of a split WIM!");
373 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
375 if (boot_idx < 0 || boot_idx > w->hdr.image_count)
376 return WIMLIB_ERR_INVALID_IMAGE;
377 w->hdr.boot_idx = boot_idx;
380 memset(&w->hdr.boot_metadata_res_entry, 0,
381 sizeof(struct resource_entry));
383 memcpy(&w->hdr.boot_metadata_res_entry,
385 boot_idx - 1].metadata_lte->resource_entry,
386 sizeof(struct resource_entry));
393 wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
396 *total_parts_ret = w->hdr.total_parts;
397 return w->hdr.part_number;
402 wimlib_get_boot_idx(const WIMStruct *w)
404 return w->hdr.boot_idx;
408 * Begins the reading of a WIM file; opens the file and reads its header and
409 * lookup table, and optionally checks the integrity.
412 begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
413 wimlib_progress_func_t progress_func)
418 DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
420 w->fp = tfopen(in_wim_path, T("rb"));
422 ERROR_WITH_ERRNO("Failed to open `%"TS"' for reading",
424 return WIMLIB_ERR_OPEN;
427 /* The absolute path to the WIM is requested so that wimlib_overwrite()
428 * still works even if the process changes its working directory. This
429 * actually happens if a WIM is mounted read-write, since the FUSE
430 * thread changes directory to "/", and it needs to be able to find the
433 * This will break if the full path to the WIM changes in the
434 * intervening time...
436 * Warning: in Windows native builds, realpath() calls the replacement
437 * function in win32.c.
439 w->filename = realpath(in_wim_path, NULL);
441 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
443 return WIMLIB_ERR_NOMEM;
445 return WIMLIB_ERR_OPEN;
448 ret = read_header(w->fp, &w->hdr, open_flags);
452 DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
454 /* If the boot index is invalid, print a warning and set it to 0 */
455 if (w->hdr.boot_idx > w->hdr.image_count) {
456 WARNING("In `%"TS"', image %u is marked as bootable, "
457 "but there are only %u images in the WIM",
458 in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
462 if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
463 ERROR("Invalid compression type (WIM header flags = 0x%x)",
465 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
468 if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
469 ret = check_wim_integrity(w, progress_func);
470 if (ret == WIM_INTEGRITY_NONEXISTENT) {
471 WARNING("No integrity information for `%"TS"'; skipping "
472 "integrity check.", in_wim_path);
473 } else if (ret == WIM_INTEGRITY_NOT_OK) {
474 ERROR("WIM is not intact! (Failed integrity check)");
475 return WIMLIB_ERR_INTEGRITY;
476 } else if (ret != WIM_INTEGRITY_OK) {
481 if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
482 w->image_metadata = CALLOC(w->hdr.image_count,
483 sizeof(struct wim_image_metadata));
485 if (!w->image_metadata) {
486 ERROR("Failed to allocate memory for %u image metadata structures",
488 return WIMLIB_ERR_NOMEM;
492 ret = read_lookup_table(w);
496 ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
497 &w->xml_data, &w->wim_info);
501 xml_num_images = wim_info_get_num_images(w->wim_info);
502 if (xml_num_images != w->hdr.image_count) {
503 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
504 "in the XML data,", in_wim_path, xml_num_images);
505 ERROR("but %u images in the WIM! There must be exactly one "
506 "<IMAGE> element per image.", w->hdr.image_count);
507 return WIMLIB_ERR_IMAGE_COUNT;
510 DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
515 * Opens a WIM file and creates a WIMStruct for it.
518 wimlib_open_wim(const tchar *wim_file, int open_flags,
520 wimlib_progress_func_t progress_func)
525 if (!wim_file || !w_ret)
526 return WIMLIB_ERR_INVALID_PARAM;
528 w = new_wim_struct();
530 return WIMLIB_ERR_NOMEM;
532 ret = begin_read(w, wim_file, open_flags, progress_func);
541 destroy_image_metadata(struct wim_image_metadata *imd,
542 struct wim_lookup_table *table)
544 free_dentry_tree(imd->root_dentry, table);
545 free_security_data(imd->security_data);
547 free_lookup_table_entry(imd->metadata_lte);
550 /* Frees the memory for the WIMStruct, including all internal memory; also
551 * closes all files associated with the WIMStruct. */
553 wimlib_free(WIMStruct *w)
555 DEBUG("Freeing WIMStruct");
566 for (size_t i = 0; i < w->num_allocated_fps; i++)
568 fclose(w->fp_tab[i]);
571 pthread_mutex_destroy(&w->fp_tab_mutex);
574 free_lookup_table(w->lookup_table);
578 free_wim_info(w->wim_info);
579 if (w->image_metadata) {
580 for (unsigned i = 0; i < w->hdr.image_count; i++) {
581 destroy_image_metadata(&w->image_metadata[i], NULL);
582 free_lookup_table_entry(w->image_metadata[i].metadata_lte);
584 FREE(w->image_metadata);
588 DEBUG("Unmounting NTFS volume");
589 ntfs_umount(w->ntfs_vol, FALSE);
593 DEBUG("Freed WIMStruct");
597 test_locale_ctype_utf8()
599 char *ctype = nl_langinfo(CODESET);
601 return (!strstr(ctype, "UTF-8") ||
602 !strstr(ctype, "UTF8") ||
603 !strstr(ctype, "utf8") ||
604 !strstr(ctype, "utf-8"));
607 /* Get global memory allocations out of the way,
608 * single-threaded programs like 'imagex'. */
612 libxml_global_init();
614 libntfs3g_global_init();
616 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
623 /* Free global memory allocations. Not strictly necessary if the process using
624 * wimlib is just about to exit (as is the case for 'imagex'). */
626 wimlib_global_cleanup()
628 libxml_global_cleanup();
629 iconv_global_cleanup();
631 win32_global_cleanup();