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

   1 /*
   2  * header.c
   3  *
   4  * Read, write, or create a WIM header.
   5  */
   6
   7 /*
   8  * Copyright (C) 2010 Carl Thijssen
   9  * Copyright (C) 2012 Eric Biggers
  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
  30 /* First 8 bytes in every WIM file. */
  31 static const u8 wim_magic_chars[WIM_MAGIC_LEN] = {
  32                         'M', 'S', 'W', 'I', 'M', '\0', '\0', '\0' };
  33
  34 /* Reads the header for a WIM file.  */
  35 int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
  36 {
  37         size_t bytes_read;
  38         u8 buf[WIM_HEADER_DISK_SIZE];
  39         size_t hdr_rem_size;
  40         const u8 *p;
  41
  42         u32 hdr_size;
  43         u32 wim_version;
  44         u32 chunk_size;
  45
  46         DEBUG("Reading WIM header.");
  47
  48         bytes_read = fread(buf, 1, WIM_MAGIC_LEN, fp);
  49
  50         if (bytes_read != WIM_MAGIC_LEN)
  51                 goto err;
  52
  53         /* Byte 8 */
  54
  55         if (memcmp(buf, wim_magic_chars, WIM_MAGIC_LEN) != 0) {
  56                 ERROR("Invalid magic characters in WIM header");
  57                 return WIMLIB_ERR_NOT_A_WIM_FILE;
  58         }
  59
  60         bytes_read = fread(&hdr_size, 1, sizeof(u32), fp);
  61         if (bytes_read != sizeof(u32))
  62                 goto err;
  63
  64         TO_LE32(hdr_size);
  65
  66         /* Byte 12 */
  67
  68         if (hdr_size != WIM_HEADER_DISK_SIZE) {
  69                 DEBUG("ERROR: Header is size %u (expected %u)",
  70                       hdr_size, WIM_HEADER_DISK_SIZE);
  71                 return WIMLIB_ERR_INVALID_HEADER_SIZE;
  72         }
  73
  74         /* Read the rest of the header into a buffer. */
  75
  76         hdr_rem_size = WIM_HEADER_DISK_SIZE - WIM_MAGIC_LEN - sizeof(u32);
  77
  78         bytes_read = fread(buf + WIM_MAGIC_LEN + sizeof(u32), 1,
  79                            hdr_rem_size, fp);
  80         if (bytes_read != hdr_rem_size)
  81                 goto err;
  82
  83         p = get_u32(buf + WIM_MAGIC_LEN + sizeof(u32), &wim_version);
  84
  85         if (wim_version != WIM_VERSION) {
  86                 ERROR("The WIM header says the WIM version is %u, but wimlib "
  87                       "only knows about version %u",
  88                       wim_version, WIM_VERSION);
  89                 return WIMLIB_ERR_UNKNOWN_VERSION;
  90         }
  91
  92         p = get_u32(p, &hdr->flags);
  93         p = get_u32(p, &chunk_size);
  94         if (chunk_size != WIM_CHUNK_SIZE &&
  95             (hdr->flags & WIM_HDR_FLAG_COMPRESSION)) {
  96                 ERROR("Unexpected chunk size of %u! Ask the author to "
  97                       "implement support for other chunk sizes.",
  98                       chunk_size);
  99                 ERROR("(Or it might just be that the WIM header is invalid.)");
 100                 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
 101         }
 102
 103         p = get_bytes(p, WIM_GID_LEN, hdr->guid);
 104         p = get_u16(p, &hdr->part_number);
 105         p = get_u16(p, &hdr->total_parts);
 106
 107         if (!split_ok && (hdr->part_number != 1 || hdr->total_parts != 1)) {
 108                 ERROR("This WIM is part %u of a %u-part WIM",
 109                       hdr->part_number, hdr->total_parts);
 110                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
 111         }
 112
 113         p = get_u32(p, &hdr->image_count);
 114
 115         DEBUG("part_number = %u, total_parts = %u, image_count = %u",
 116               hdr->part_number, hdr->total_parts, hdr->image_count);
 117
 118         /* Byte 48 */
 119
 120         p = get_resource_entry(p, &hdr->lookup_table_res_entry);
 121         p = get_resource_entry(p, &hdr->xml_res_entry);
 122         p = get_resource_entry(p, &hdr->boot_metadata_res_entry);
 123
 124         /* Byte 120 */
 125
 126         p = get_u32(p, &hdr->boot_idx);
 127
 128         /* Byte 124 */
 129
 130         p = get_resource_entry(p, &hdr->integrity);
 131
 132         /* Byte 148 */
 133
 134         /* 60 bytes of unused stuff. */
 135
 136         /* Byte 208 */
 137
 138         return 0;
 139
 140 err:
 141         if (feof(fp))
 142                 ERROR("Unexpected EOF while reading WIM header");
 143         else
 144                 ERROR_WITH_ERRNO("Error reading WIM header");
 145         return WIMLIB_ERR_READ;
 146 }
 147
 148 /*
 149  * Writes the header for a WIM file.
 150  *
 151  * @hdr:        A pointer to a struct wim_header structure that describes the header.
 152  * @out:        The FILE* for the output file, positioned at the appropriate
 153  *              place (the beginning of the file).
 154  * @return:     Zero on success, nonzero on failure.
 155  */
 156 int write_header(const struct wim_header *hdr, FILE *out_fp)
 157 {
 158         u8 buf[WIM_HEADER_DISK_SIZE];
 159         u8 *p;
 160         DEBUG("Writing WIM header.");
 161
 162         p = put_bytes(buf, WIM_MAGIC_LEN, wim_magic_chars);
 163         p = put_u32(p, WIM_HEADER_DISK_SIZE);
 164         p = put_u32(p, WIM_VERSION);
 165         p = put_u32(p, hdr->flags);
 166         p = put_u32(p, (hdr->flags & WIM_HDR_FLAG_COMPRESSION) ?
 167                                 WIM_CHUNK_SIZE : 0);
 168         /* byte 24 */
 169
 170         p = put_bytes(p, WIM_GID_LEN, hdr->guid);
 171         p = put_u16(p, hdr->part_number);
 172
 173         /* byte 40 */
 174
 175         p = put_u16(p, hdr->total_parts);
 176         p = put_u32(p, hdr->image_count);
 177         p = put_resource_entry(p, &hdr->lookup_table_res_entry);
 178         p = put_resource_entry(p, &hdr->xml_res_entry);
 179         p = put_resource_entry(p, &hdr->boot_metadata_res_entry);
 180         p = put_u32(p, hdr->boot_idx);
 181         p = put_resource_entry(p, &hdr->integrity);
 182         memset(p, 0, WIM_UNUSED_LEN);
 183         if (fwrite(buf, 1, sizeof(buf), out_fp) != sizeof(buf)) {
 184                 ERROR_WITH_ERRNO("Failed to write WIM header");
 185                 return WIMLIB_ERR_WRITE;
 186         }
 187         DEBUG("Done writing WIM header");
 188         return 0;
 189 }
 190
 191 /*
 192  * Initializes the header for a WIM file.
 193  */
 194 int init_header(struct wim_header *hdr, int ctype)
 195 {
 196         memset(hdr, 0, sizeof(struct wim_header));
 197         switch (ctype) {
 198         case WIM_COMPRESSION_TYPE_NONE:
 199                 hdr->flags = 0;
 200                 break;
 201         case WIM_COMPRESSION_TYPE_LZX:
 202                 hdr->flags = WIM_HDR_FLAG_COMPRESSION |
 203                              WIM_HDR_FLAG_COMPRESS_LZX;
 204                 break;
 205         case WIM_COMPRESSION_TYPE_XPRESS:
 206                 hdr->flags = WIM_HDR_FLAG_COMPRESSION |
 207                              WIM_HDR_FLAG_COMPRESS_XPRESS;
 208                 break;
 209         default:
 210                 ERROR("Invalid compression type specified (%d)", ctype);
 211                 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
 212         }
 213         hdr->total_parts = 1;
 214         hdr->part_number = 1;
 215         randomize_byte_array(hdr->guid, sizeof(hdr->guid));
 216         return 0;
 217 }
 218
 219 struct hdr_flag {
 220         u32 flag;
 221         const char *name;
 222 };
 223 struct hdr_flag hdr_flags[] = {
 224         {WIM_HDR_FLAG_RESERVED,         "RESERVED"},
 225         {WIM_HDR_FLAG_COMPRESSION,      "COMPRESSION"},
 226         {WIM_HDR_FLAG_READONLY,         "READONLY"},
 227         {WIM_HDR_FLAG_SPANNED,          "SPANNED"},
 228         {WIM_HDR_FLAG_RESOURCE_ONLY,    "RESOURCE_ONLY"},
 229         {WIM_HDR_FLAG_METADATA_ONLY,    "METADATA_ONLY"},
 230         {WIM_HDR_FLAG_WRITE_IN_PROGRESS,"WRITE_IN_PROGRESS"},
 231         {WIM_HDR_FLAG_RP_FIX,           "RP_FIX"},
 232         {WIM_HDR_FLAG_COMPRESS_RESERVED,"COMPRESS_RESERVED"},
 233         {WIM_HDR_FLAG_COMPRESS_LZX,     "COMPRESS_LZX"},
 234         {WIM_HDR_FLAG_COMPRESS_XPRESS,  "COMPRESS_XPRESS"},
 235 };
 236
 237 /* Prints information from the header of the WIM file associated with @w. */
 238 WIMLIBAPI void wimlib_print_header(const WIMStruct *w)
 239 {
 240         const struct wim_header *hdr = &w->hdr;
 241         uint i;
 242
 243         printf("Magic Characters            = MSWIM\\000\\000\\000\n");
 244         printf("Header Size                 = %u\n", WIM_HEADER_DISK_SIZE);
 245         printf("Version                     = 0x%x\n", WIM_VERSION);
 246
 247         printf("Flags                       = 0x%x\n", hdr->flags);
 248         for (i = 0; i < ARRAY_LEN(hdr_flags); i++)
 249                 if (hdr_flags[i].flag & hdr->flags)
 250                         printf("    WIM_HDR_FLAG_%s is set\n", hdr_flags[i].name);
 251
 252         printf("Chunk Size                  = %u\n", WIM_CHUNK_SIZE);
 253         fputs ("GUID                        = ", stdout);
 254         print_byte_field(hdr->guid, WIM_GID_LEN);
 255         putchar('\n');
 256         printf("Part Number                 = %hu\n", 1);
 257         printf("Total Parts                 = %hu\n", 1);
 258         printf("Image Count                 = %u\n", hdr->image_count);
 259         printf("Lookup Table Size           = %"PRIu64"\n",
 260                                 (u64)hdr->lookup_table_res_entry.size);
 261         printf("Lookup Table Flags          = 0x%hhx\n",
 262                                 hdr->lookup_table_res_entry.flags);
 263         printf("Lookup Table Offset         = %"PRIu64"\n",
 264                                 hdr->lookup_table_res_entry.offset);
 265         printf("Lookup Table Original_size  = %"PRIu64"\n",
 266                                 hdr->lookup_table_res_entry.original_size);
 267         printf("XML Data Size               = %"PRIu64"\n",
 268                                 (u64)hdr->xml_res_entry.size);
 269         printf("XML Data Flags              = 0x%hhx\n",
 270                                 hdr->xml_res_entry.flags);
 271         printf("XML Data Offset             = %"PRIu64"\n",
 272                                 hdr->xml_res_entry.offset);
 273         printf("XML Data Original Size      = %"PRIu64"\n",
 274                                 hdr->xml_res_entry.original_size);
 275         printf("Boot Metadata Size          = %"PRIu64"\n",
 276                                 (u64)hdr->boot_metadata_res_entry.size);
 277         printf("Boot Metadata Flags         = 0x%hhx\n",
 278                                 hdr->boot_metadata_res_entry.flags);
 279         printf("Boot Metadata Offset        = %"PRIu64"\n",
 280                                 hdr->boot_metadata_res_entry.offset);
 281         printf("Boot Metadata Original Size = %"PRIu64"\n",
 282                                 hdr->boot_metadata_res_entry.original_size);
 283         printf("Boot Index                  = %u\n", hdr->boot_idx);
 284         printf("Integrity Size              = %"PRIu64"\n",
 285                                         (u64)hdr->integrity.size);
 286         printf("Integrity Flags             = 0x%hhx\n",
 287                                         hdr->integrity.flags);
 288         printf("Integrity Offset            = %"PRIu64"\n",
 289                                         hdr->integrity.offset);
 290         printf("Integrity Original_size     = %"PRIu64"\n",
 291                                         hdr->integrity.original_size);
 292 }