wimlib.net Git - wimlib/blob - src/wim.c

   1 /*
   2  * wim.c - Stuff that doesn't fit into any other file
   3  */
   4
   5 /*
   6  * Copyright (C) 2012, 2013 Eric Biggers
   7  *
   8  * This file is part of wimlib, a library for working with WIM files.
   9  *
  10  * wimlib is free software; you can redistribute it and/or modify it under the
  11  * terms of the GNU General Public License as published by the Free
  12  * Software Foundation; either version 3 of the License, or (at your option)
  13  * any later version.
  14  *
  15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 #include "wimlib/error.h"
  29 #include "wimlib/dentry.h"
  30 #include "wimlib/encoding.h"
  31 #include "wimlib/file_io.h"
  32 #include "wimlib/integrity.h"
  33 #include "wimlib/lookup_table.h"
  34 #include "wimlib/metadata.h"
  35 #ifdef WITH_NTFS_3G
  36 #  include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
  37 #endif
  38 #include "wimlib/security.h"
  39 #include "wimlib/wim.h"
  40 #include "wimlib/xml.h"
  41
  42 #ifdef __WIN32__
  43 #  include "wimlib/win32.h" /* for realpath() replacement */
  44 #endif
  45
  46 #include <errno.h>
  47 #include <fcntl.h>
  48 #ifndef __WIN32__
  49 #  include <langinfo.h>
  50 #endif
  51 #include <limits.h>
  52 #include <stdarg.h>
  53 #include <stdlib.h>
  54 #include <unistd.h>
  55
  56 static int
  57 image_print_metadata(WIMStruct *w)
  58 {
  59         DEBUG("Printing metadata for image %d", w->current_image);
  60         print_wim_security_data(wim_security_data(w));
  61         return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
  62                                   w->lookup_table);
  63 }
  64
  65
  66 static int
  67 image_print_files(WIMStruct *w)
  68 {
  69         return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
  70                                   NULL);
  71 }
  72
  73 static WIMStruct *
  74 new_wim_struct(void)
  75 {
  76         WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
  77         if (w) {
  78                 w->in_fd = -1;
  79                 w->out_fd = -1;
  80         }
  81         return w;
  82 }
  83
  84 /*
  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.
  89  */
  90 int
  91 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
  92 {
  93         int ret;
  94         int start;
  95         int end;
  96         int i;
  97
  98         if (image == WIMLIB_ALL_IMAGES) {
  99                 start = 1;
 100                 end = w->hdr.image_count;
 101         } else if (image >= 1 && image <= w->hdr.image_count) {
 102                 start = image;
 103                 end = image;
 104         } else {
 105                 return WIMLIB_ERR_INVALID_IMAGE;
 106         }
 107         for (i = start; i <= end; i++) {
 108                 ret = select_wim_image(w, i);
 109                 if (ret != 0)
 110                         return ret;
 111                 ret = visitor(w);
 112                 if (ret != 0)
 113                         return ret;
 114         }
 115         return 0;
 116 }
 117
 118 /* Returns the compression type given in the flags of a WIM header. */
 119 static int
 120 wim_hdr_flags_compression_type(int wim_hdr_flags)
 121 {
 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;
 127                 else
 128                         return WIMLIB_COMPRESSION_TYPE_INVALID;
 129         } else {
 130                 return WIMLIB_COMPRESSION_TYPE_NONE;
 131         }
 132 }
 133
 134 /*
 135  * Creates a WIMStruct for a new WIM file.
 136  */
 137 WIMLIBAPI int
 138 wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
 139 {
 140         WIMStruct *w;
 141         struct wim_lookup_table *table;
 142         int ret;
 143
 144         DEBUG("Creating new WIM with %"TS" compression.",
 145               wimlib_get_compression_type_string(ctype));
 146
 147         /* Allocate the WIMStruct. */
 148         w = new_wim_struct();
 149         if (!w)
 150                 return WIMLIB_ERR_NOMEM;
 151
 152         ret = init_header(&w->hdr, ctype);
 153         if (ret != 0)
 154                 goto out_free;
 155
 156         table = new_lookup_table(9001);
 157         if (!table) {
 158                 ret = WIMLIB_ERR_NOMEM;
 159                 goto out_free;
 160         }
 161         w->lookup_table = table;
 162         *w_ret = w;
 163         return 0;
 164 out_free:
 165         FREE(w);
 166         return ret;
 167 }
 168
 169 WIMLIBAPI int
 170 wimlib_get_num_images(const WIMStruct *w)
 171 {
 172         return w->hdr.image_count;
 173 }
 174
 175 int
 176 select_wim_image(WIMStruct *w, int image)
 177 {
 178         struct wim_image_metadata *imd;
 179         int ret;
 180
 181         DEBUG("Selecting image %d", image);
 182
 183         if (image == WIMLIB_NO_IMAGE) {
 184                 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
 185                 return WIMLIB_ERR_INVALID_IMAGE;
 186         }
 187
 188         if (image == w->current_image)
 189                 return 0;
 190
 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;
 195         }
 196
 197         /* If a valid image is currently selected, it can be freed if it is not
 198          * modified.  */
 199         if (w->current_image != WIMLIB_NO_IMAGE) {
 200                 imd = wim_get_current_image_metadata(w);
 201                 if (!imd->modified) {
 202                         wimlib_assert(list_empty(&imd->unhashed_streams));
 203                         DEBUG("Freeing image %u", w->current_image);
 204                         destroy_image_metadata(imd, NULL, false);
 205                 }
 206         }
 207         w->current_image = image;
 208         imd = wim_get_current_image_metadata(w);
 209         if (imd->root_dentry || imd->modified) {
 210                 ret = 0;
 211         } else {
 212                 #ifdef ENABLE_DEBUG
 213                 DEBUG("Reading metadata resource specified by the following "
 214                       "lookup table entry:");
 215                 print_lookup_table_entry(imd->metadata_lte, stderr);
 216                 #endif
 217                 ret = read_metadata_resource(w, imd);
 218                 if (ret)
 219                         w->current_image = WIMLIB_NO_IMAGE;
 220         }
 221         return ret;
 222 }
 223
 224
 225 /* Returns the compression type of the WIM file. */
 226 WIMLIBAPI int
 227 wimlib_get_compression_type(const WIMStruct *w)
 228 {
 229         return wim_hdr_flags_compression_type(w->hdr.flags);
 230 }
 231
 232 WIMLIBAPI const tchar *
 233 wimlib_get_compression_type_string(int ctype)
 234 {
 235         switch (ctype) {
 236                 case WIMLIB_COMPRESSION_TYPE_NONE:
 237                         return T("None");
 238                 case WIMLIB_COMPRESSION_TYPE_LZX:
 239                         return T("LZX");
 240                 case WIMLIB_COMPRESSION_TYPE_XPRESS:
 241                         return T("XPRESS");
 242                 default:
 243                         return T("Invalid");
 244         }
 245 }
 246
 247 /*
 248  * Returns the number of an image in the WIM file, given a string that is either
 249  * the number of the image, or the name of the image.  The images are numbered
 250  * starting at 1.
 251  */
 252 WIMLIBAPI int
 253 wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
 254 {
 255         tchar *p;
 256         long image;
 257         int i;
 258
 259         if (!image_name_or_num || !*image_name_or_num)
 260                 return WIMLIB_NO_IMAGE;
 261
 262         if (!tstrcasecmp(image_name_or_num, T("all"))
 263             || !tstrcasecmp(image_name_or_num, T("*")))
 264                 return WIMLIB_ALL_IMAGES;
 265         image = tstrtol(image_name_or_num, &p, 10);
 266         if (p != image_name_or_num && *p == T('\0') && image > 0) {
 267                 if (image > w->hdr.image_count)
 268                         return WIMLIB_NO_IMAGE;
 269                 return image;
 270         } else {
 271                 for (i = 1; i <= w->hdr.image_count; i++) {
 272                         if (!tstrcmp(image_name_or_num,
 273                                      wimlib_get_image_name(w, i)))
 274                                 return i;
 275                 }
 276                 return WIMLIB_NO_IMAGE;
 277         }
 278 }
 279
 280 /* Prints some basic information about a WIM file. */
 281 WIMLIBAPI void
 282 wimlib_print_wim_information(const WIMStruct *w)
 283 {
 284         const struct wim_header *hdr;
 285
 286         hdr = &w->hdr;
 287         tputs(T("WIM Information:"));
 288         tputs(T("----------------"));
 289         tprintf(T("Path:           %"TS"\n"), w->filename);
 290         tfputs(T("GUID:           0x"), stdout);
 291         print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
 292         tputchar(T('\n'));
 293         tprintf(T("Image Count:    %d\n"), hdr->image_count);
 294         tprintf(T("Compression:    %"TS"\n"),
 295                 wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
 296         tprintf(T("Part Number:    %d/%d\n"), hdr->part_number, hdr->total_parts);
 297         tprintf(T("Boot Index:     %d\n"), hdr->boot_idx);
 298         tprintf(T("Size:           %"PRIu64" bytes\n"),
 299                 wim_info_get_total_bytes(w->wim_info));
 300         tprintf(T("Integrity Info: %"TS"\n"),
 301                 (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
 302         tprintf(T("Relative path junction: %"TS"\n"),
 303                 (hdr->flags & WIM_HDR_FLAG_RP_FIX) ? T("yes") : T("no"));
 304         tputchar(T('\n'));
 305 }
 306
 307 WIMLIBAPI bool
 308 wimlib_has_integrity_table(const WIMStruct *w)
 309 {
 310         return w->hdr.integrity.size != 0;
 311 }
 312
 313 WIMLIBAPI void
 314 wimlib_print_available_images(const WIMStruct *w, int image)
 315 {
 316         int first;
 317         int last;
 318         int i;
 319         int n;
 320         if (image == WIMLIB_ALL_IMAGES) {
 321                 n = tprintf(T("Available Images:\n"));
 322                 first = 1;
 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);
 326                 first = image;
 327                 last = image;
 328         } else {
 329                 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
 330                         image);
 331                 return;
 332         }
 333         for (i = 0; i < n - 1; i++)
 334                 tputchar(T('-'));
 335         tputchar(T('\n'));
 336         for (i = first; i <= last; i++)
 337                 print_image_info(w->wim_info, i);
 338 }
 339
 340
 341 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
 342  * not WIMLIB_NO_IMAGE. */
 343 WIMLIBAPI int
 344 wimlib_print_metadata(WIMStruct *w, int image)
 345 {
 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;
 351         }
 352         return for_image(w, image, image_print_metadata);
 353 }
 354
 355 WIMLIBAPI int
 356 wimlib_print_files(WIMStruct *w, int image)
 357 {
 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;
 363         }
 364         return for_image(w, image, image_print_files);
 365 }
 366
 367 /* Sets the index of the bootable image. */
 368 WIMLIBAPI int
 369 wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
 370 {
 371         if (w->hdr.total_parts != 1) {
 372                 ERROR("Cannot modify the boot index of a split WIM!");
 373                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
 374         }
 375         if (boot_idx < 0 || boot_idx > w->hdr.image_count)
 376                 return WIMLIB_ERR_INVALID_IMAGE;
 377         w->hdr.boot_idx = boot_idx;
 378         return 0;
 379 }
 380
 381 WIMLIBAPI int
 382 wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
 383 {
 384         if (total_parts_ret)
 385                 *total_parts_ret = w->hdr.total_parts;
 386         return w->hdr.part_number;
 387 }
 388
 389
 390 WIMLIBAPI int
 391 wimlib_get_boot_idx(const WIMStruct *w)
 392 {
 393         return w->hdr.boot_idx;
 394 }
 395
 396 static int
 397 do_open_wim(const tchar *filename, int *fd_ret)
 398 {
 399         int fd;
 400
 401         fd = topen(filename, O_RDONLY | O_BINARY);
 402         if (fd == -1) {
 403                 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
 404                 return WIMLIB_ERR_OPEN;
 405         }
 406         *fd_ret = fd;
 407         return 0;
 408 }
 409
 410 int
 411 reopen_wim(WIMStruct *w)
 412 {
 413         wimlib_assert(w->in_fd == -1);
 414         return do_open_wim(w->filename, &w->in_fd);
 415 }
 416
 417 int
 418 close_wim(WIMStruct *w)
 419 {
 420         if (w->in_fd != -1) {
 421                 close(w->in_fd);
 422                 w->in_fd = -1;
 423         }
 424         return 0;
 425 }
 426
 427 /*
 428  * Begins the reading of a WIM file; opens the file and reads its header and
 429  * lookup table, and optionally checks the integrity.
 430  */
 431 static int
 432 begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
 433            wimlib_progress_func_t progress_func)
 434 {
 435         int ret;
 436         int xml_num_images;
 437
 438         DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
 439
 440         ret = do_open_wim(in_wim_path, &w->in_fd);
 441         if (ret)
 442                 return ret;
 443
 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
 448          * WIM file again.
 449          *
 450          * This will break if the full path to the WIM changes in the
 451          * intervening time...
 452          *
 453          * Warning: in Windows native builds, realpath() calls the replacement
 454          * function in win32.c.
 455          */
 456         w->filename = realpath(in_wim_path, NULL);
 457         if (!w->filename) {
 458                 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
 459                 if (errno == ENOMEM)
 460                         return WIMLIB_ERR_NOMEM;
 461                 else
 462                         return WIMLIB_ERR_OPEN;
 463         }
 464
 465         ret = read_header(w->filename, w->in_fd, &w->hdr, open_flags);
 466         if (ret)
 467                 return ret;
 468
 469         DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
 470
 471         /* If the boot index is invalid, print a warning and set it to 0 */
 472         if (w->hdr.boot_idx > w->hdr.image_count) {
 473                 WARNING("In `%"TS"', image %u is marked as bootable, "
 474                         "but there are only %u images in the WIM",
 475                         in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
 476                 w->hdr.boot_idx = 0;
 477         }
 478
 479         if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
 480                 ERROR("Invalid compression type (WIM header flags = 0x%x)",
 481                       w->hdr.flags);
 482                 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
 483         }
 484
 485         if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
 486                 ret = check_wim_integrity(w, progress_func);
 487                 if (ret == WIM_INTEGRITY_NONEXISTENT) {
 488                         WARNING("No integrity information for `%"TS"'; skipping "
 489                                 "integrity check.", in_wim_path);
 490                 } else if (ret == WIM_INTEGRITY_NOT_OK) {
 491                         ERROR("WIM is not intact! (Failed integrity check)");
 492                         return WIMLIB_ERR_INTEGRITY;
 493                 } else if (ret != WIM_INTEGRITY_OK) {
 494                         return ret;
 495                 }
 496         }
 497
 498         if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
 499                 w->image_metadata = new_image_metadata_array(w->hdr.image_count);
 500                 if (!w->image_metadata)
 501                         return WIMLIB_ERR_NOMEM;
 502         }
 503
 504         ret = read_lookup_table(w);
 505         if (ret)
 506                 return ret;
 507
 508         ret = read_xml_data(w->in_fd, &w->hdr.xml_res_entry, &w->wim_info);
 509         if (ret)
 510                 return ret;
 511
 512         xml_num_images = wim_info_get_num_images(w->wim_info);
 513         if (xml_num_images != w->hdr.image_count) {
 514                 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
 515                       "in the XML data,", in_wim_path, xml_num_images);
 516                 ERROR("but %u images in the WIM!  There must be exactly one "
 517                       "<IMAGE> element per image.", w->hdr.image_count);
 518                 return WIMLIB_ERR_IMAGE_COUNT;
 519         }
 520
 521         DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
 522         return 0;
 523 }
 524
 525 /*
 526  * Opens a WIM file and creates a WIMStruct for it.
 527  */
 528 WIMLIBAPI int
 529 wimlib_open_wim(const tchar *wim_file, int open_flags,
 530                 WIMStruct **w_ret,
 531                 wimlib_progress_func_t progress_func)
 532 {
 533         WIMStruct *w;
 534         int ret;
 535
 536         if (!wim_file || !w_ret)
 537                 return WIMLIB_ERR_INVALID_PARAM;
 538
 539         w = new_wim_struct();
 540         if (!w)
 541                 return WIMLIB_ERR_NOMEM;
 542
 543         ret = begin_read(w, wim_file, open_flags, progress_func);
 544         if (ret == 0)
 545                 *w_ret = w;
 546         else
 547                 wimlib_free(w);
 548         return ret;
 549 }
 550
 551 void
 552 destroy_image_metadata(struct wim_image_metadata *imd,
 553                        struct wim_lookup_table *table,
 554                        bool free_metadata_lte)
 555 {
 556         free_dentry_tree(imd->root_dentry, table);
 557         imd->root_dentry = NULL;
 558         free_wim_security_data(imd->security_data);
 559         imd->security_data = NULL;
 560
 561         if (free_metadata_lte) {
 562                 free_lookup_table_entry(imd->metadata_lte);
 563                 imd->metadata_lte = NULL;
 564         }
 565         if (!table) {
 566                 struct wim_lookup_table_entry *lte, *tmp;
 567                 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
 568                         free_lookup_table_entry(lte);
 569         }
 570         INIT_LIST_HEAD(&imd->unhashed_streams);
 571         INIT_LIST_HEAD(&imd->inode_list);
 572 #ifdef WITH_NTFS_3G
 573         if (imd->ntfs_vol) {
 574                 do_ntfs_umount(imd->ntfs_vol);
 575                 imd->ntfs_vol = NULL;
 576         }
 577 #endif
 578 }
 579
 580 void
 581 put_image_metadata(struct wim_image_metadata *imd,
 582                    struct wim_lookup_table *table)
 583 {
 584         if (imd && --imd->refcnt == 0) {
 585                 destroy_image_metadata(imd, table, true);
 586                 FREE(imd);
 587         }
 588 }
 589
 590 /* Appends the specified image metadata structure to the array of image metadata
 591  * for a WIM, and increments the image count. */
 592 int
 593 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd)
 594 {
 595         struct wim_image_metadata **imd_array;
 596
 597         DEBUG("Reallocating image metadata array for image_count = %u",
 598               w->hdr.image_count + 1);
 599         imd_array = REALLOC(w->image_metadata,
 600                             sizeof(w->image_metadata[0]) * (w->hdr.image_count + 1));
 601
 602         if (!imd_array)
 603                 return WIMLIB_ERR_NOMEM;
 604         w->image_metadata = imd_array;
 605         imd_array[w->hdr.image_count++] = imd;
 606         return 0;
 607 }
 608
 609
 610 struct wim_image_metadata *
 611 new_image_metadata(void)
 612 {
 613         struct wim_image_metadata *imd;
 614
 615         imd = CALLOC(1, sizeof(*imd));
 616         if (imd) {
 617                 imd->refcnt = 1;
 618                 INIT_LIST_HEAD(&imd->inode_list);
 619                 INIT_LIST_HEAD(&imd->unhashed_streams);
 620                 DEBUG("Created new image metadata (refcnt=1)");
 621         } else {
 622                 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
 623         }
 624         return imd;
 625 }
 626
 627 struct wim_image_metadata **
 628 new_image_metadata_array(unsigned num_images)
 629 {
 630         struct wim_image_metadata **imd_array;
 631
 632         DEBUG("Creating new image metadata array for %u images",
 633               num_images);
 634
 635         imd_array = CALLOC(num_images, sizeof(imd_array[0]));
 636
 637         if (!imd_array) {
 638                 ERROR("Failed to allocate memory for %u image metadata structures",
 639                       num_images);
 640                 return NULL;
 641         }
 642         for (unsigned i = 0; i < num_images; i++) {
 643                 imd_array[i] = new_image_metadata();
 644                 if (!imd_array[i]) {
 645                         for (unsigned j = 0; j < i; j++)
 646                                 put_image_metadata(imd_array[j], NULL);
 647                         FREE(imd_array);
 648                         return NULL;
 649                 }
 650         }
 651         return imd_array;
 652 }
 653
 654 /* Checksum all streams that are unhashed (other than the metadata streams),
 655  * merging them into the lookup table as needed.  This is a no-op unless the
 656  * library has previously used to add or mount an image using the same
 657  * WIMStruct. */
 658 int
 659 wim_checksum_unhashed_streams(WIMStruct *w)
 660 {
 661         int ret;
 662         for (int i = 0; i < w->hdr.image_count; i++) {
 663                 struct wim_lookup_table_entry *lte, *tmp;
 664                 struct wim_image_metadata *imd = w->image_metadata[i];
 665                 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
 666                         ret = hash_unhashed_stream(lte, w->lookup_table, NULL);
 667                         if (ret)
 668                                 return ret;
 669                 }
 670         }
 671         return 0;
 672 }
 673
 674 /* Frees the memory for the WIMStruct, including all internal memory; also
 675  * closes all files associated with the WIMStruct.  */
 676 WIMLIBAPI void
 677 wimlib_free(WIMStruct *w)
 678 {
 679         DEBUG("Freeing WIMStruct");
 680
 681         if (!w)
 682                 return;
 683         if (w->in_fd != -1)
 684                 close(w->in_fd);
 685         if (w->out_fd != -1)
 686                 close(w->out_fd);
 687
 688         free_lookup_table(w->lookup_table);
 689
 690         FREE(w->filename);
 691         free_wim_info(w->wim_info);
 692         if (w->image_metadata) {
 693                 for (unsigned i = 0; i < w->hdr.image_count; i++)
 694                         put_image_metadata(w->image_metadata[i], NULL);
 695                 FREE(w->image_metadata);
 696         }
 697         FREE(w);
 698         DEBUG("Freed WIMStruct");
 699 }
 700
 701 static bool
 702 test_locale_ctype_utf8(void)
 703 {
 704 #ifdef __WIN32__
 705         return false;
 706 #else
 707         char *ctype = nl_langinfo(CODESET);
 708
 709         return (!strstr(ctype, "UTF-8") ||
 710                 !strstr(ctype, "UTF8") ||
 711                 !strstr(ctype, "utf8") ||
 712                 !strstr(ctype, "utf-8"));
 713 #endif
 714 }
 715
 716 WIMLIBAPI int
 717 wimlib_global_init(int init_flags)
 718 {
 719         libxml_global_init();
 720         if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
 721                 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
 722         #ifdef WITH_NTFS_3G
 723                 if (!wimlib_mbs_is_utf8)
 724                         libntfs3g_global_init();
 725         #endif
 726         }
 727 #ifdef __WIN32__
 728         win32_global_init();
 729 #endif
 730         return 0;
 731 }
 732
 733 /* Free global memory allocations.  Not strictly necessary if the process using
 734  * wimlib is just about to exit (as is the case for 'imagex'). */
 735 WIMLIBAPI void
 736 wimlib_global_cleanup(void)
 737 {
 738         libxml_global_cleanup();
 739         iconv_global_cleanup();
 740 #ifdef __WIN32__
 741         win32_global_cleanup();
 742 #endif
 743 }