X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fheader.c;h=5b164161e82bce404a1e8235f57d72c047a87778;hp=e7dd900904a93b0a883725799a85df1bd922b5d5;hb=19fd5bbc4f64cc8bf735f7c2c0bb864876998cf4;hpb=b350e1fe2c3fd6614b3e1e79e3c3d933fda7a4e4 diff --git a/src/header.c b/src/header.c index e7dd9009..5b164161 100644 --- a/src/header.c +++ b/src/header.c @@ -5,8 +5,7 @@ */ /* - * Copyright (C) 2010 Carl Thijssen - * Copyright (C) 2012 Eric Biggers + * Copyright (C) 2012, 2013 Eric Biggers * * This file is part of wimlib, a library for working with WIM files. * @@ -24,163 +23,212 @@ * along with wimlib; if not, see http://www.gnu.org/licenses/. */ -#include "wimlib_internal.h" -#include "io.h" +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#include "wimlib.h" +#include "wimlib/assert.h" +#include "wimlib/endianness.h" +#include "wimlib/error.h" +#include "wimlib/file_io.h" +#include "wimlib/header.h" +#include "wimlib/util.h" +#include "wimlib/wim.h" + +#include +#include + +/* WIM magic characters, translated to a single 64-bit little endian number. */ +#define WIM_MAGIC \ + cpu_to_le64(((u64)'M' << 0) | \ + ((u64)'S' << 8) | \ + ((u64)'W' << 16) | \ + ((u64)'I' << 24) | \ + ((u64)'M' << 32) | \ + ((u64)'\0' << 40) | \ + ((u64)'\0' << 48) | \ + ((u64)'\0' << 54)) + +/* On-disk format of the WIM header. */ +struct wim_header_disk { + + /* Magic characters "MSWIM\0\0\0" */ + le64 magic; + + /* Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE expected + * (currently the only supported value). */ + u32 hdr_size; -/* First 8 bytes in every WIM file. */ -static const u8 wim_magic_chars[WIM_MAGIC_LEN] = { - 'M', 'S', 'W', 'I', 'M', '\0', '\0', '\0' }; + /* Version of the WIM file; WIM_VERSION expected (currently the only + * supported value). */ + u32 wim_version; -/* Reads the header for a WIM file. */ -int read_header(FILE *fp, struct wim_header *hdr, int split_ok) -{ - size_t bytes_read; - u8 buf[WIM_HEADER_DISK_SIZE]; - size_t hdr_rem_size; - const u8 *p; + /* Flags for the WIM file (WIM_HDR_FLAG_*) */ + u32 wim_flags; - u32 hdr_size; - u32 wim_version; + /* Uncompressed chunk size of resources in the WIM. 0 if the WIM is + * uncompressed. If compressed, WIM_CHUNK_SIZE is expected (currently + * the only supported value). */ u32 chunk_size; - DEBUG("Reading WIM header."); - - bytes_read = fread(buf, 1, WIM_MAGIC_LEN, fp); + /* Globally unique identifier for the WIM file. Basically a bunch of + * random bytes. */ + u8 guid[WIM_GID_LEN]; - if (bytes_read != WIM_MAGIC_LEN) - goto err; + /* Number of this WIM part in the split WIM file, indexed from 1, or 1 + * if the WIM is not split. */ + u16 part_number; - /* Byte 8 */ + /* Total number of parts of the split WIM file, or 1 if the WIM is not + * split. */ + u16 total_parts; - if (memcmp(buf, wim_magic_chars, WIM_MAGIC_LEN) != 0) { - ERROR("Invalid magic characters in WIM header"); - return WIMLIB_ERR_NOT_A_WIM_FILE; - } + /* Number of images in the WIM. */ + u32 image_count; - bytes_read = fread(&hdr_size, 1, sizeof(u32), fp); - if (bytes_read != sizeof(u32)) - goto err; + /* Location and size of the WIM's lookup table. */ + struct resource_entry_disk lookup_table_res_entry; - TO_LE32(hdr_size); + /* Location and size of the WIM's XML data. */ + struct resource_entry_disk xml_data_res_entry; - /* Byte 12 */ + /* Location and size of metadata resource for the bootable image of the + * WIM, or all zeroes if no image is bootable. */ + struct resource_entry_disk boot_metadata_res_entry; - if (hdr_size != WIM_HEADER_DISK_SIZE) { - DEBUG("ERROR: Header is size %u (expected %u)", - hdr_size, WIM_HEADER_DISK_SIZE); - return WIMLIB_ERR_INVALID_HEADER_SIZE; - } + /* 1-based index of the bootable image of the WIM, or 0 if no image is + * bootable. */ + u32 boot_idx; - /* Read the rest of the header into a buffer. */ + /* Location and size of the WIM's integrity table, or all zeroes if the + * WIM has no integrity table. + * + * Note the integrity_table_res_entry here is 4-byte aligned even though + * it would ordinarily be 8-byte aligned--- hence, the _packed_attribute + * on the `struct wim_header_disk' is essential. */ + struct resource_entry_disk integrity_table_res_entry; - hdr_rem_size = WIM_HEADER_DISK_SIZE - WIM_MAGIC_LEN - sizeof(u32); + /* Unused bytes. */ + u8 unused[60]; +} _packed_attribute; - bytes_read = fread(buf + WIM_MAGIC_LEN + sizeof(u32), 1, - hdr_rem_size, fp); - if (bytes_read != hdr_rem_size) - goto err; +/* Reads the header from a WIM file. */ +int +read_header(const tchar *filename, int in_fd, + struct wim_header *hdr, int open_flags) +{ + struct wim_header_disk disk_hdr _aligned_attribute(8); + + BUILD_BUG_ON(sizeof(struct wim_header_disk) != WIM_HEADER_DISK_SIZE); + + DEBUG("Reading WIM header from \"%"TS"\"", filename); + + if (full_pread(in_fd, &disk_hdr, sizeof(disk_hdr), 0) != sizeof(disk_hdr)) { + ERROR_WITH_ERRNO("\"%"TS"\": Error reading header", filename); + return WIMLIB_ERR_READ; + } + + if (disk_hdr.magic != WIM_MAGIC) { + ERROR("\"%"TS"\": Invalid magic characters in header", filename); + return WIMLIB_ERR_NOT_A_WIM_FILE; + } - p = get_u32(buf + WIM_MAGIC_LEN + sizeof(u32), &wim_version); + if (le32_to_cpu(disk_hdr.hdr_size) != sizeof(struct wim_header_disk)) { + ERROR("\"%"TS"\": Header size is invalid (%u bytes)", + filename, le32_to_cpu(disk_hdr.hdr_size)); + return WIMLIB_ERR_INVALID_HEADER_SIZE; + } - if (wim_version != WIM_VERSION) { - ERROR("The WIM header says the WIM version is %u, but wimlib " - "only knows about version %u", - wim_version, WIM_VERSION); + if (le32_to_cpu(disk_hdr.wim_version) != WIM_VERSION) { + ERROR("\"%"TS"\": The WIM header says the WIM version is %u, " + "but wimlib only knows about version %u", + filename, le32_to_cpu(disk_hdr.wim_version), WIM_VERSION); return WIMLIB_ERR_UNKNOWN_VERSION; } - p = get_u32(p, &hdr->flags); - p = get_u32(p, &chunk_size); - if (chunk_size != WIM_CHUNK_SIZE && + hdr->flags = le32_to_cpu(disk_hdr.wim_flags); + if (le32_to_cpu(disk_hdr.chunk_size) != WIM_CHUNK_SIZE && (hdr->flags & WIM_HDR_FLAG_COMPRESSION)) { - ERROR("Unexpected chunk size of %u! Ask the author to " + ERROR("\"%"TS"\": Unexpected chunk size of %u! Ask the author to " "implement support for other chunk sizes.", - chunk_size); + filename, le32_to_cpu(disk_hdr.chunk_size)); ERROR("(Or it might just be that the WIM header is invalid.)"); return WIMLIB_ERR_INVALID_CHUNK_SIZE; } - p = get_bytes(p, WIM_GID_LEN, hdr->guid); - p = get_u16(p, &hdr->part_number); - p = get_u16(p, &hdr->total_parts); + memcpy(hdr->guid, disk_hdr.guid, WIM_GID_LEN); + + hdr->part_number = le16_to_cpu(disk_hdr.part_number); + hdr->total_parts = le16_to_cpu(disk_hdr.total_parts); + + if (hdr->total_parts == 0 || hdr->part_number == 0 || + hdr->part_number > hdr->total_parts) + { + ERROR("\"%"TS"\": Invalid WIM part number: %hu of %hu", + filename, hdr->part_number, hdr->total_parts); + return WIMLIB_ERR_INVALID_PART_NUMBER; + } - if (!split_ok && (hdr->part_number != 1 || hdr->total_parts != 1)) { - ERROR("This WIM is part %u of a %u-part WIM", - hdr->part_number, hdr->total_parts); + if (!(open_flags & WIMLIB_OPEN_FLAG_SPLIT_OK) && hdr->total_parts != 1) + { + ERROR("\"%"TS"\": This WIM is part %u of a %u-part WIM", + filename, hdr->part_number, hdr->total_parts); return WIMLIB_ERR_SPLIT_UNSUPPORTED; } - p = get_u32(p, &hdr->image_count); + hdr->image_count = le32_to_cpu(disk_hdr.image_count); DEBUG("part_number = %u, total_parts = %u, image_count = %u", hdr->part_number, hdr->total_parts, hdr->image_count); - /* Byte 48 */ - - p = get_resource_entry(p, &hdr->lookup_table_res_entry); - p = get_resource_entry(p, &hdr->xml_res_entry); - p = get_resource_entry(p, &hdr->boot_metadata_res_entry); - - /* Byte 120 */ - - p = get_u32(p, &hdr->boot_idx); - - /* Byte 124 */ - - p = get_resource_entry(p, &hdr->integrity); - - /* Byte 148 */ - - /* 60 bytes of unused stuff. */ - - /* Byte 208 */ + if (hdr->image_count >= INT_MAX) { + ERROR("\"%"TS"\": Invalid image count (%u)", + filename, hdr->image_count); + return WIMLIB_ERR_IMAGE_COUNT; + } + get_resource_entry(&disk_hdr.lookup_table_res_entry, &hdr->lookup_table_res_entry); + get_resource_entry(&disk_hdr.xml_data_res_entry, &hdr->xml_res_entry); + get_resource_entry(&disk_hdr.boot_metadata_res_entry, &hdr->boot_metadata_res_entry); + hdr->boot_idx = le32_to_cpu(disk_hdr.boot_idx); + get_resource_entry(&disk_hdr.integrity_table_res_entry, &hdr->integrity); return 0; - -err: - if (feof(fp)) - ERROR("Unexpected EOF while reading WIM header"); - else - ERROR_WITH_ERRNO("Error reading WIM header"); - return WIMLIB_ERR_READ; } -/* +/* * Writes the header for a WIM file. * * @hdr: A pointer to a struct wim_header structure that describes the header. - * @out: The FILE* for the output file, positioned at the appropriate - * place (the beginning of the file). - * @return: Zero on success, nonzero on failure. + * @out_fd: The file descriptor to the WIM file, opened for writing. + * + * Returns zero on success, nonzero on failure. */ -int write_header(const struct wim_header *hdr, FILE *out_fp) +int +write_header(const struct wim_header *hdr, int out_fd) { - u8 buf[WIM_HEADER_DISK_SIZE]; - u8 *p; + struct wim_header_disk disk_hdr _aligned_attribute(8); DEBUG("Writing WIM header."); - p = put_bytes(buf, WIM_MAGIC_LEN, wim_magic_chars); - p = put_u32(p, WIM_HEADER_DISK_SIZE); - p = put_u32(p, WIM_VERSION); - p = put_u32(p, hdr->flags); - p = put_u32(p, (hdr->flags & WIM_HDR_FLAG_COMPRESSION) ? - WIM_CHUNK_SIZE : 0); - /* byte 24 */ - - p = put_bytes(p, WIM_GID_LEN, hdr->guid); - p = put_u16(p, hdr->part_number); - - /* byte 40 */ - - p = put_u16(p, hdr->total_parts); - p = put_u32(p, hdr->image_count); - p = put_resource_entry(p, &hdr->lookup_table_res_entry); - p = put_resource_entry(p, &hdr->xml_res_entry); - p = put_resource_entry(p, &hdr->boot_metadata_res_entry); - p = put_u32(p, hdr->boot_idx); - p = put_resource_entry(p, &hdr->integrity); - memset(p, 0, WIM_UNUSED_LEN); - if (fwrite(buf, 1, sizeof(buf), out_fp) != sizeof(buf)) { + disk_hdr.magic = WIM_MAGIC; + disk_hdr.hdr_size = cpu_to_le32(sizeof(struct wim_header_disk)); + disk_hdr.wim_version = cpu_to_le32(WIM_VERSION); + disk_hdr.wim_flags = cpu_to_le32(hdr->flags); + disk_hdr.chunk_size = cpu_to_le32((hdr->flags & WIM_HDR_FLAG_COMPRESSION) ? + WIM_CHUNK_SIZE : 0); + memcpy(disk_hdr.guid, hdr->guid, WIM_GID_LEN); + + disk_hdr.part_number = cpu_to_le16(hdr->part_number); + disk_hdr.total_parts = cpu_to_le16(hdr->total_parts); + disk_hdr.image_count = cpu_to_le32(hdr->image_count); + put_resource_entry(&hdr->lookup_table_res_entry, &disk_hdr.lookup_table_res_entry); + put_resource_entry(&hdr->xml_res_entry, &disk_hdr.xml_data_res_entry); + put_resource_entry(&hdr->boot_metadata_res_entry, &disk_hdr.boot_metadata_res_entry); + disk_hdr.boot_idx = cpu_to_le32(hdr->boot_idx); + put_resource_entry(&hdr->integrity, &disk_hdr.integrity_table_res_entry); + memset(disk_hdr.unused, 0, sizeof(disk_hdr.unused)); + + if (full_pwrite(out_fd, &disk_hdr, sizeof(disk_hdr), 0) != sizeof(disk_hdr)) { ERROR_WITH_ERRNO("Failed to write WIM header"); return WIMLIB_ERR_WRITE; } @@ -191,19 +239,20 @@ int write_header(const struct wim_header *hdr, FILE *out_fp) /* * Initializes the header for a WIM file. */ -int init_header(struct wim_header *hdr, int ctype) +int +init_header(struct wim_header *hdr, int ctype) { memset(hdr, 0, sizeof(struct wim_header)); switch (ctype) { - case WIM_COMPRESSION_TYPE_NONE: + case WIMLIB_COMPRESSION_TYPE_NONE: hdr->flags = 0; break; - case WIM_COMPRESSION_TYPE_LZX: - hdr->flags = WIM_HDR_FLAG_COMPRESSION | + case WIMLIB_COMPRESSION_TYPE_LZX: + hdr->flags = WIM_HDR_FLAG_COMPRESSION | WIM_HDR_FLAG_COMPRESS_LZX; break; - case WIM_COMPRESSION_TYPE_XPRESS: - hdr->flags = WIM_HDR_FLAG_COMPRESSION | + case WIMLIB_COMPRESSION_TYPE_XPRESS: + hdr->flags = WIM_HDR_FLAG_COMPRESSION | WIM_HDR_FLAG_COMPRESS_XPRESS; break; default: @@ -235,58 +284,58 @@ struct hdr_flag hdr_flags[] = { }; /* Prints information from the header of the WIM file associated with @w. */ -WIMLIBAPI void wimlib_print_header(const WIMStruct *w) +WIMLIBAPI void +wimlib_print_header(const WIMStruct *w) { const struct wim_header *hdr = &w->hdr; - uint i; - printf("Magic Characters = MSWIM\\000\\000\\000\n"); - printf("Header Size = %u\n", WIM_HEADER_DISK_SIZE); - printf("Version = 0x%x\n", WIM_VERSION); + tprintf(T("Magic Characters = MSWIM\\000\\000\\000\n")); + tprintf(T("Header Size = %u\n"), WIM_HEADER_DISK_SIZE); + tprintf(T("Version = 0x%x\n"), WIM_VERSION); - printf("Flags = 0x%x\n", hdr->flags); - for (i = 0; i < ARRAY_LEN(hdr_flags); i++) + tprintf(T("Flags = 0x%x\n"), hdr->flags); + for (size_t i = 0; i < ARRAY_LEN(hdr_flags); i++) if (hdr_flags[i].flag & hdr->flags) - printf(" WIM_HDR_FLAG_%s is set\n", hdr_flags[i].name); - - printf("Chunk Size = %u\n", WIM_CHUNK_SIZE); - fputs ("GUID = ", stdout); - print_byte_field(hdr->guid, WIM_GID_LEN); - putchar('\n'); - printf("Part Number = %hu\n", w->hdr.part_number); - printf("Total Parts = %hu\n", w->hdr.total_parts); - printf("Image Count = %u\n", hdr->image_count); - printf("Lookup Table Size = %"PRIu64"\n", + tprintf(T(" WIM_HDR_FLAG_%s is set\n"), hdr_flags[i].name); + + tprintf(T("Chunk Size = %u\n"), WIM_CHUNK_SIZE); + tfputs (T("GUID = "), stdout); + print_byte_field(hdr->guid, WIM_GID_LEN, stdout); + tputchar(T('\n')); + tprintf(T("Part Number = %hu\n"), w->hdr.part_number); + tprintf(T("Total Parts = %hu\n"), w->hdr.total_parts); + tprintf(T("Image Count = %u\n"), hdr->image_count); + tprintf(T("Lookup Table Size = %"PRIu64"\n"), (u64)hdr->lookup_table_res_entry.size); - printf("Lookup Table Flags = 0x%hhx\n", - hdr->lookup_table_res_entry.flags); - printf("Lookup Table Offset = %"PRIu64"\n", + tprintf(T("Lookup Table Flags = 0x%hhx\n"), + (u8)hdr->lookup_table_res_entry.flags); + tprintf(T("Lookup Table Offset = %"PRIu64"\n"), hdr->lookup_table_res_entry.offset); - printf("Lookup Table Original_size = %"PRIu64"\n", + tprintf(T("Lookup Table Original_size = %"PRIu64"\n"), hdr->lookup_table_res_entry.original_size); - printf("XML Data Size = %"PRIu64"\n", + tprintf(T("XML Data Size = %"PRIu64"\n"), (u64)hdr->xml_res_entry.size); - printf("XML Data Flags = 0x%hhx\n", - hdr->xml_res_entry.flags); - printf("XML Data Offset = %"PRIu64"\n", + tprintf(T("XML Data Flags = 0x%hhx\n"), + (u8)hdr->xml_res_entry.flags); + tprintf(T("XML Data Offset = %"PRIu64"\n"), hdr->xml_res_entry.offset); - printf("XML Data Original Size = %"PRIu64"\n", + tprintf(T("XML Data Original Size = %"PRIu64"\n"), hdr->xml_res_entry.original_size); - printf("Boot Metadata Size = %"PRIu64"\n", + tprintf(T("Boot Metadata Size = %"PRIu64"\n"), (u64)hdr->boot_metadata_res_entry.size); - printf("Boot Metadata Flags = 0x%hhx\n", - hdr->boot_metadata_res_entry.flags); - printf("Boot Metadata Offset = %"PRIu64"\n", + tprintf(T("Boot Metadata Flags = 0x%hhx\n"), + (u8)hdr->boot_metadata_res_entry.flags); + tprintf(T("Boot Metadata Offset = %"PRIu64"\n"), hdr->boot_metadata_res_entry.offset); - printf("Boot Metadata Original Size = %"PRIu64"\n", + tprintf(T("Boot Metadata Original Size = %"PRIu64"\n"), hdr->boot_metadata_res_entry.original_size); - printf("Boot Index = %u\n", hdr->boot_idx); - printf("Integrity Size = %"PRIu64"\n", - (u64)hdr->integrity.size); - printf("Integrity Flags = 0x%hhx\n", - hdr->integrity.flags); - printf("Integrity Offset = %"PRIu64"\n", - hdr->integrity.offset); - printf("Integrity Original_size = %"PRIu64"\n", - hdr->integrity.original_size); + tprintf(T("Boot Index = %u\n"), hdr->boot_idx); + tprintf(T("Integrity Size = %"PRIu64"\n"), + (u64)hdr->integrity.size); + tprintf(T("Integrity Flags = 0x%hhx\n"), + (u8)hdr->integrity.flags); + tprintf(T("Integrity Offset = %"PRIu64"\n"), + hdr->integrity.offset); + tprintf(T("Integrity Original_size = %"PRIu64"\n"), + hdr->integrity.original_size); }