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

   1 /*
   2  * wim.c
   3  */
   4
   5 /*
   6  * Copyright (C) 2010 Carl Thijssen
   7  * Copyright (C) 2012 Eric Biggers
   8  *
   9  * wimlib - Library for working with WIM files
  10  *
  11  * This file is part of wimlib, a library for working with WIM files.
  12  *
  13  * wimlib is free software; you can redistribute it and/or modify it under the
  14  * terms of the GNU Lesser General Public License as published by the Free
  15  * Software Foundation; either version 2.1 of the License, or (at your option)
  16  * any later version.
  17  *
  18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20  * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public License
  24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  25  */
  26
  27 #include "wimlib_internal.h"
  28 #include "io.h"
  29 #include "lookup_table.h"
  30 #include "xml.h"
  31 #include <stdlib.h>
  32
  33 static int print_metadata(WIMStruct *w)
  34 {
  35         print_security_data(wim_security_data(w));
  36         return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
  37                                   w->lookup_table);
  38 }
  39
  40
  41 static int print_files(WIMStruct *w)
  42 {
  43         return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
  44                                   NULL);
  45 }
  46
  47 WIMStruct *new_wim_struct()
  48 {
  49         return CALLOC(1, sizeof(WIMStruct));
  50 }
  51
  52 /*
  53  * Calls a function on images in the WIM.  If @image is WIM_ALL_IMAGES, @visitor
  54  * is called on the WIM once for each image, with each image selected as the
  55  * current image in turn.  If @image is a certain image, @visitor is called on
  56  * the WIM only once, with that image selected.
  57  */
  58 int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
  59 {
  60         int ret;
  61         int i;
  62         int end;
  63
  64         DEBUG("for_image(w = %p, image = %d, visitor = %p)", w, image, visitor);
  65
  66         if (image == WIM_ALL_IMAGES) {
  67                 i = 1;
  68                 end = w->hdr.image_count;
  69         } else {
  70                 if (image < 1 || image > w->hdr.image_count)
  71                         return WIMLIB_ERR_INVALID_IMAGE;
  72                 i = image;
  73                 end = image;
  74         }
  75         for (; i <= end; i++) {
  76                 ret = wimlib_select_image(w, i);
  77                 if (ret != 0)
  78                         return ret;
  79                 ret = visitor(w);
  80                 if (ret != 0)
  81                         return ret;
  82         }
  83         return 0;
  84 }
  85
  86 static int sort_image_metadata_by_position(const void *p1, const void *p2)
  87 {
  88         struct image_metadata *bmd1 = (struct image_metadata*)p1;
  89         struct image_metadata *bmd2 = (struct image_metadata*)p2;
  90         u64 offset1 = bmd1->metadata_lte->resource_entry.offset;
  91         u64 offset2 = bmd2->metadata_lte->resource_entry.offset;
  92         if (offset1 < offset2)
  93                 return -1;
  94         else if (offset1 > offset2)
  95                 return 1;
  96         else
  97                 return 0;
  98 }
  99
 100 /*
 101  * If @lte points to a metadata resource, append it to the list of metadata
 102  * resources in the WIMStruct.  Otherwise, do nothing.
 103  */
 104 static int append_metadata_resource_entry(struct lookup_table_entry *lte,
 105                                           void *wim_p)
 106 {
 107         WIMStruct *w = wim_p;
 108
 109         if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
 110                 /*fprintf(stderr, "found mlte at %u\n", lte->resource_entry.offset);*/
 111                 if (w->current_image == w->hdr.image_count) {
 112                         ERROR("Expected only %u images, but found more",
 113                               w->hdr.image_count);
 114                         return WIMLIB_ERR_IMAGE_COUNT;
 115                 } else {
 116                         DEBUG("Found metadata resource for image %u at "
 117                               "offset %"PRIu64".",
 118                               w->current_image + 1,
 119                               lte->resource_entry.offset);
 120                         w->image_metadata[
 121                                 w->current_image++].metadata_lte = lte;
 122                 }
 123         }
 124         return 0;
 125 }
 126
 127 /* Returns the compression type given in the flags of a WIM header. */
 128 int wim_hdr_flags_compression_type(int wim_hdr_flags)
 129 {
 130         if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
 131                 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
 132                         return WIM_COMPRESSION_TYPE_LZX;
 133                 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
 134                         return WIM_COMPRESSION_TYPE_XPRESS;
 135                 else
 136                         return WIM_COMPRESSION_TYPE_INVALID;
 137         } else {
 138                 return WIM_COMPRESSION_TYPE_NONE;
 139         }
 140 }
 141
 142 int wim_resource_compression_type(const WIMStruct *w,
 143                                   const struct resource_entry *entry)
 144 {
 145         int wim_ctype = wimlib_get_compression_type(w);
 146         return resource_compression_type(wim_ctype, entry->flags);
 147 }
 148
 149 /*
 150  * Creates a WIMStruct for a new WIM file.
 151  */
 152 WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
 153 {
 154         WIMStruct *w;
 155         struct lookup_table *table;
 156         int ret;
 157
 158         DEBUG("Creating new WIM with %s compression.",
 159               wimlib_get_compression_type_string(ctype));
 160
 161         /* Allocate the WIMStruct. */
 162         w = new_wim_struct();
 163         if (!w)
 164                 return WIMLIB_ERR_NOMEM;
 165
 166         ret = init_header(&w->hdr, ctype);
 167         if (ret != 0)
 168                 goto out_free;
 169
 170         table = new_lookup_table(9001);
 171         if (!table) {
 172                 ret = WIMLIB_ERR_NOMEM;
 173                 goto out_free;
 174         }
 175         w->lookup_table = table;
 176         *w_ret = w;
 177         return 0;
 178 out_free:
 179         FREE(w);
 180         return ret;
 181 }
 182
 183 WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
 184 {
 185         return w->hdr.image_count;
 186 }
 187
 188 int wimlib_select_image(WIMStruct *w, int image)
 189 {
 190         struct image_metadata *imd;
 191
 192         DEBUG("Selecting image %d", image);
 193
 194         if (image == w->current_image)
 195                 return 0;
 196
 197         if (image < 1 || image > w->hdr.image_count) {
 198                 ERROR("Cannot select image %d: There are only %u images",
 199                       image, w->hdr.image_count);
 200                 return WIMLIB_ERR_INVALID_IMAGE;
 201         }
 202
 203
 204         /* If a valid image is currently selected, it can be freed if it is not
 205          * modified.  */
 206         if (w->current_image != WIM_NO_IMAGE) {
 207                 imd = wim_get_current_image_metadata(w);
 208                 if (!imd->modified) {
 209                         DEBUG("Freeing image %u", w->current_image);
 210                         destroy_image_metadata(imd, NULL);
 211                         imd->root_dentry = NULL;
 212                         imd->security_data = NULL;
 213                         imd->lgt = NULL;
 214                 }
 215         }
 216
 217         w->current_image = image;
 218         imd = wim_get_current_image_metadata(w);
 219
 220         if (imd->root_dentry) {
 221                 return 0;
 222         } else {
 223                 #ifdef ENABLE_DEBUG
 224                 DEBUG("Reading metadata resource specified by the following "
 225                       "lookup table entry:");
 226                 print_lookup_table_entry(imd->metadata_lte);
 227                 #endif
 228                 return read_metadata_resource(w->fp,
 229                                               wimlib_get_compression_type(w),
 230                                               imd);
 231         }
 232 }
 233
 234
 235 /* Returns the compression type of the WIM file. */
 236 WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
 237 {
 238         return wim_hdr_flags_compression_type(w->hdr.flags);
 239 }
 240
 241 WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
 242 {
 243         switch (ctype) {
 244                 case WIM_COMPRESSION_TYPE_NONE:
 245                         return "None";
 246                 case WIM_COMPRESSION_TYPE_LZX:
 247                         return "LZX";
 248                 case WIM_COMPRESSION_TYPE_XPRESS:
 249                         return "XPRESS";
 250                 default:
 251                         return "Invalid";
 252         }
 253 }
 254
 255 /*
 256  * Returns the number of an image in the WIM file, given a string that is either
 257  * the number of the image, or the name of the image.  The images are numbered
 258  * starting at 1.
 259  */
 260 WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
 261 {
 262         char *p;
 263         int image;
 264         int i;
 265
 266         if (!image_name_or_num)
 267                 return WIM_NO_IMAGE;
 268
 269         if (strcmp(image_name_or_num, "all") == 0)
 270                 return WIM_ALL_IMAGES;
 271         image = strtol(image_name_or_num, &p, 10);
 272         if (p != image_name_or_num && *p == '\0') {
 273                 if (image < 1 || image > w->hdr.image_count)
 274                         return WIM_NO_IMAGE;
 275                 return image;
 276         } else {
 277                 for (i = 1; i <= w->hdr.image_count; i++) {
 278                         if (strcmp(image_name_or_num,
 279                                    wimlib_get_image_name(w, i)) == 0)
 280                                 return i;
 281                 }
 282                 return WIM_NO_IMAGE;
 283         }
 284 }
 285
 286
 287 /* Prints some basic information about a WIM file. */
 288 WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
 289 {
 290         const struct wim_header *hdr;
 291
 292         hdr = &w->hdr;
 293         puts("WIM Information:");
 294         puts("----------------");
 295         printf("Path:           %s\n", w->filename);
 296         fputs ("GUID:           0x", stdout);
 297         print_byte_field(hdr->guid, WIM_GID_LEN);
 298         putchar('\n');
 299         printf("Image Count:    %d\n", hdr->image_count);
 300         printf("Compression:    %s\n", wimlib_get_compression_type_string(
 301                                                 wimlib_get_compression_type(w)));
 302         printf("Part Number:    %d/%d\n", hdr->part_number, hdr->total_parts);
 303         printf("Boot Index:     %d\n", hdr->boot_idx);
 304         printf("Size:           %"PRIu64" bytes\n",
 305                                 wim_info_get_total_bytes(w->wim_info));
 306         printf("Integrity Info: %s\n", (w->hdr.integrity.size != 0) ? "yes" : "no");
 307         putchar('\n');
 308 }
 309
 310 WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
 311 {
 312         return w->hdr.integrity.size != 0;
 313 }
 314
 315 WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
 316 {
 317         if (image == WIM_ALL_IMAGES) {
 318                 puts("Available Images:");
 319                 puts("-----------------");
 320         } else {
 321                 int n;
 322                 int i;
 323
 324                 n = printf("Information for Image %d\n", image);
 325                 for (i = 0; i < n - 1; i++)
 326                         putchar('-');
 327                 putchar('\n');
 328
 329         }
 330         print_image_info(w->wim_info, image);
 331 }
 332
 333
 334 /* Prints the metadata for the specified image, which may be WIM_ALL_IMAGES, but
 335  * not WIM_NO_IMAGE. */
 336 WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
 337 {
 338         return for_image(w, image, print_metadata);
 339 }
 340
 341 WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
 342 {
 343         return for_image(w, image, print_files);
 344 }
 345
 346 /* Sets the index of the bootable image. */
 347 WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
 348 {
 349         if (boot_idx < 0 || boot_idx > w->hdr.image_count)
 350                 return WIMLIB_ERR_INVALID_IMAGE;
 351         w->hdr.boot_idx = boot_idx;
 352         if (boot_idx == 0) {
 353                 memset(&w->hdr.boot_metadata_res_entry, 0,
 354                        sizeof(struct resource_entry));
 355         } else {
 356                 memcpy(&w->hdr.boot_metadata_res_entry,
 357                        &w->image_metadata[
 358                                 boot_idx - 1].metadata_lte->resource_entry,
 359                        sizeof(struct resource_entry));
 360         }
 361         return 0;
 362 }
 363
 364 WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
 365 {
 366         if (total_parts_ret)
 367                 *total_parts_ret = w->hdr.total_parts;
 368         return w->hdr.part_number;
 369 }
 370
 371
 372 WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
 373 {
 374         return w->hdr.boot_idx;
 375 }
 376
 377 /*
 378  * Begins the reading of a WIM file; opens the file and reads its header and
 379  * lookup table, and optionally checks the integrity.
 380  */
 381 static int begin_read(WIMStruct *w, const char *in_wim_path, int flags)
 382 {
 383         int ret;
 384         uint xml_num_images;
 385
 386         DEBUG("Reading the WIM file `%s'", in_wim_path);
 387
 388         w->filename = STRDUP(in_wim_path);
 389         if (!w->filename) {
 390                 ERROR("Failed to allocate memory for WIM filename");
 391                 return WIMLIB_ERR_NOMEM;
 392         }
 393
 394         w->fp = fopen(in_wim_path, "rb");
 395
 396         if (!w->fp) {
 397                 ERROR_WITH_ERRNO("Failed to open the file `%s' for reading",
 398                                  in_wim_path);
 399                 return WIMLIB_ERR_OPEN;
 400         }
 401
 402         ret = read_header(w->fp, &w->hdr, flags & WIMLIB_OPEN_FLAG_SPLIT_OK);
 403         if (ret != 0)
 404                 return ret;
 405
 406         DEBUG("Wim file contains %u images", w->hdr.image_count);
 407
 408         /* If the boot index is invalid, print a warning and set it to 0 */
 409         if (w->hdr.boot_idx > w->hdr.image_count) {
 410                 WARNING("In `%s', image %u is marked as bootable, "
 411                         "but there are only %u images",
 412                          in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
 413                 w->hdr.boot_idx = 0;
 414         }
 415
 416         if (wimlib_get_compression_type(w) == WIM_COMPRESSION_TYPE_INVALID) {
 417                 ERROR("Invalid compression type (WIM header flags = %x)",
 418                       w->hdr.flags);
 419                 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
 420         }
 421
 422
 423         if (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
 424                 int integrity_status;
 425                 ret = check_wim_integrity(w,
 426                                           flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS,
 427                                           &integrity_status);
 428                 if (ret != 0) {
 429                         ERROR("Error in check_wim_integrity()");
 430                         return ret;
 431                 }
 432                 if (integrity_status == WIM_INTEGRITY_NONEXISTENT) {
 433                         WARNING("No integrity information for `%s'; skipping "
 434                                 "integrity check.", w->filename);
 435                 } else if (integrity_status == WIM_INTEGRITY_NOT_OK) {
 436                         ERROR("WIM is not intact! (Failed integrity check)");
 437                         return WIMLIB_ERR_INTEGRITY;
 438                 }
 439         }
 440
 441         if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) {
 442                 ERROR("Didn't expect a compressed lookup table!");
 443                 ERROR("Ask the author to implement support for this.");
 444                 return WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE;
 445         }
 446
 447         ret = read_lookup_table(w->fp, w->hdr.lookup_table_res_entry.offset,
 448                                 w->hdr.lookup_table_res_entry.size,
 449                                 &w->lookup_table);
 450         if (ret != 0)
 451                 return ret;
 452
 453         w->image_metadata = CALLOC(w->hdr.image_count,
 454                                    sizeof(struct image_metadata));
 455
 456         if (!w->image_metadata) {
 457                 ERROR("Failed to allocate memory for %u metadata structures",
 458                       w->hdr.image_count);
 459                 return WIMLIB_ERR_NOMEM;
 460         }
 461         w->current_image = 0;
 462
 463         DEBUG("Looking for metadata resources in the lookup table.");
 464
 465         /* Find the images in the WIM by searching the lookup table. */
 466         ret = for_lookup_table_entry(w->lookup_table,
 467                                      append_metadata_resource_entry, w);
 468
 469         if (ret != 0)
 470                 return ret;
 471
 472         /* Make sure all the expected images were found.  (We already have
 473          * returned false if *extra* images were found) */
 474         if (w->current_image != w->hdr.image_count && w->hdr.part_number == 1) {
 475                 ERROR("Only found %u images in WIM, but expected %u",
 476                       w->current_image, w->hdr.image_count);
 477                 return WIMLIB_ERR_IMAGE_COUNT;
 478         }
 479
 480
 481         /* Sort images by the position of their metadata resources.  I'm
 482          * assuming that is what determines the other of the images in the WIM
 483          * file, rather than their order in the lookup table, which is random
 484          * because of hashing. */
 485         qsort(w->image_metadata, w->current_image,
 486               sizeof(struct image_metadata), sort_image_metadata_by_position);
 487
 488         w->current_image = WIM_NO_IMAGE;
 489
 490         /* Read the XML data. */
 491         ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
 492                             &w->xml_data, &w->wim_info);
 493
 494         if (ret != 0) {
 495                 ERROR("Missing or invalid XML data");
 496                 return ret;
 497         }
 498
 499         xml_num_images = wim_info_get_num_images(w->wim_info);
 500         if (xml_num_images != w->hdr.image_count) {
 501                 ERROR("In the file `%s', there are %u <IMAGE> elements "
 502                       "in the XML data,", in_wim_path, xml_num_images);
 503                 ERROR("but %u images in the WIM!  There must be exactly one "
 504                       "<IMAGE> element per image.", w->hdr.image_count);
 505                 return WIMLIB_ERR_IMAGE_COUNT;
 506         }
 507
 508         DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
 509         return 0;
 510 }
 511
 512
 513 /*
 514  * Opens a WIM file and creates a WIMStruct for it.
 515  */
 516 WIMLIBAPI int wimlib_open_wim(const char *wim_file, int flags,
 517                               WIMStruct **w_ret)
 518 {
 519         WIMStruct *w;
 520         int ret;
 521
 522         DEBUG("wim_file = `%s', flags = %#x", wim_file, flags);
 523         w = new_wim_struct();
 524         if (!w) {
 525                 ERROR("Failed to allocate memory for WIMStruct");
 526                 return WIMLIB_ERR_NOMEM;
 527         }
 528
 529         ret = begin_read(w, wim_file, flags);
 530         if (ret != 0) {
 531                 DEBUG("Could not begin reading the WIM file `%s'", wim_file);
 532                 wimlib_free(w);
 533                 return ret;
 534         }
 535         *w_ret = w;
 536         return 0;
 537 }
 538
 539 /* Frees the memory for the WIMStruct, including all internal memory; also
 540  * closes all files associated with the WIMStruct.  */
 541 WIMLIBAPI void wimlib_free(WIMStruct *w)
 542 {
 543         DEBUG("Freeing WIMStruct");
 544
 545         if (!w)
 546                 return;
 547         if (w->fp)
 548                 fclose(w->fp);
 549         if (w->out_fp)
 550                 fclose(w->out_fp);
 551
 552         free_lookup_table(w->lookup_table);
 553
 554         FREE(w->filename);
 555         FREE(w->xml_data);
 556         free_wim_info(w->wim_info);
 557         if (w->image_metadata) {
 558                 for (uint i = 0; i < w->hdr.image_count; i++)
 559                         destroy_image_metadata(&w->image_metadata[i], NULL);
 560                 FREE(w->image_metadata);
 561         }
 562         FREE(w);
 563 }
 564