X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fheader.c;h=bd2a0631ea31460eb57daef87af9c22c34d1ce0f;hp=a366930933afac24fe41174536ab541e7033c58b;hb=f8698b9c814a62a117982701b9551f699553b2a4;hpb=885632f08c75c1d7bb5d25436231c78f6ad7e0c0 diff --git a/src/header.c b/src/header.c index a3669309..bd2a0631 100644 --- a/src/header.c +++ b/src/header.c @@ -2,35 +2,38 @@ * header.c * * Read, write, or create a WIM header. + */ + +/* + * Copyright (C) 2012, 2013 Eric Biggers * - * Copyright (C) 2010 Carl Thijssen - * Copyright (C) 2012 Eric Biggers - * - * wimlib - Library for working with WIM files + * This file is part of wimlib, a library for working with WIM files. * - * This library is free software; you can redistribute it and/or modify it under - * the terms of the GNU Lesser General Public License as published by the Free - * Software Foundation; either version 2.1 of the License, or (at your option) any - * later version. + * wimlib is free software; you can redistribute it and/or modify it under the + * terms of the GNU General Public License as published by the Free + * Software Foundation; either version 3 of the License, or (at your option) + * any later version. * - * This library is distributed in the hope that it will be useful, but WITHOUT ANY - * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A - * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + * A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU Lesser General Public License along - * with this library; if not, write to the Free Software Foundation, Inc., 59 - * Temple Place, Suite 330, Boston, MA 02111-1307 USA + * You should have received a copy of the GNU General Public License + * along with wimlib; if not, see http://www.gnu.org/licenses/. */ #include "wimlib_internal.h" -#include "io.h" +#include "buffer_io.h" +#include /* First 8 bytes in every WIM file. */ -static const u8 wim_magic_chars[WIM_MAGIC_LEN] = { +static const u8 wim_magic_chars[WIM_MAGIC_LEN] = { 'M', 'S', 'W', 'I', 'M', '\0', '\0', '\0' }; /* Reads the header for a WIM file. */ -int read_header(FILE *fp, struct wim_header *hdr) +int +read_header(FILE *fp, struct wim_header *hdr, int open_flags) { size_t bytes_read; u8 buf[WIM_HEADER_DISK_SIZE]; @@ -40,11 +43,9 @@ int read_header(FILE *fp, struct wim_header *hdr) u32 hdr_size; u32 wim_version; u32 chunk_size; - u16 part_number; - u16 total_parts; - DEBUG("Reading WIM header.\n"); - + DEBUG("Reading WIM header."); + bytes_read = fread(buf, 1, WIM_MAGIC_LEN, fp); if (bytes_read != WIM_MAGIC_LEN) @@ -53,7 +54,7 @@ int read_header(FILE *fp, struct wim_header *hdr) /* Byte 8 */ if (memcmp(buf, wim_magic_chars, WIM_MAGIC_LEN) != 0) { - ERROR("Invalid magic characters in WIM header\n"); + ERROR("Invalid magic characters in WIM header"); return WIMLIB_ERR_NOT_A_WIM_FILE; } @@ -61,13 +62,13 @@ int read_header(FILE *fp, struct wim_header *hdr) if (bytes_read != sizeof(u32)) goto err; - TO_LE32(hdr_size); + hdr_size = le32_to_cpu(hdr_size); /* Byte 12 */ if (hdr_size != WIM_HEADER_DISK_SIZE) { - DEBUG("ERROR: Header is size %u (expected %u)\n", - hdr_size, WIM_HEADER_DISK_SIZE); + ERROR("Header is %u bytes (expected %u bytes)", + hdr_size, WIM_HEADER_DISK_SIZE); return WIMLIB_ERR_INVALID_HEADER_SIZE; } @@ -75,7 +76,7 @@ int read_header(FILE *fp, struct wim_header *hdr) hdr_rem_size = WIM_HEADER_DISK_SIZE - WIM_MAGIC_LEN - sizeof(u32); - bytes_read = fread(buf + WIM_MAGIC_LEN + sizeof(u32), 1, + bytes_read = fread(buf + WIM_MAGIC_LEN + sizeof(u32), 1, hdr_rem_size, fp); if (bytes_read != hdr_rem_size) goto err; @@ -83,36 +84,54 @@ int read_header(FILE *fp, struct wim_header *hdr) p = get_u32(buf + WIM_MAGIC_LEN + sizeof(u32), &wim_version); if (wim_version != WIM_VERSION) { - ERROR("The WIM header says the WIM version is %u, but Wimlib " - "only knows about version %u.\n", 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); 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 & WIM_HDR_FLAG_COMPRESSION)) { + if (chunk_size != WIM_CHUNK_SIZE && + (hdr->flags & WIM_HDR_FLAG_COMPRESSION)) { ERROR("Unexpected chunk size of %u! Ask the author to " - "implement support for other chunk sizes. " - "(Or it might just be that the WIM header is " - "invalid.)\n", chunk_size); + "implement support for other chunk sizes.", + 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, &part_number); - p = get_u16(p, &total_parts); - - if (part_number != 1 || total_parts != 1) { - ERROR("Error: This WIM is part %u of a %u-part WIM. Wimlib " - "does not support multi-part (split/spanned) " - "WIMs.\n", part_number, total_parts); - return WIMLIB_ERR_SPLIT; + p = get_u16(p, &hdr->part_number); + p = get_u16(p, &hdr->total_parts); + + if (hdr->total_parts == 0 || + hdr->part_number == 0 || + hdr->part_number > hdr->total_parts) + { + ERROR("Invalid WIM part number: %hu of %hu", + hdr->part_number, hdr->total_parts); + return WIMLIB_ERR_INVALID_PART_NUMBER; + } + + if (!(open_flags & WIMLIB_OPEN_FLAG_SPLIT_OK) && + hdr->total_parts != 1) + { + ERROR("This WIM is part %u of a %u-part WIM", + hdr->part_number, hdr->total_parts); + return WIMLIB_ERR_SPLIT_UNSUPPORTED; } p = get_u32(p, &hdr->image_count); + DEBUG("part_number = %u, total_parts = %u, image_count = %u", + hdr->part_number, hdr->total_parts, hdr->image_count); + + if (hdr->image_count >= INT_MAX) { + ERROR("Invalid image count (%u)", hdr->image_count); + return WIMLIB_ERR_IMAGE_COUNT; + } + /* Byte 48 */ p = get_resource_entry(p, &hdr->lookup_table_res_entry); @@ -137,36 +156,41 @@ int read_header(FILE *fp, struct wim_header *hdr) err: if (feof(fp)) - ERROR("Unexpected EOF while reading WIM header!\n"); + ERROR("Unexpected EOF while reading WIM header"); else - ERROR("Error reading WIM header: %m\n"); + 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: True on success, false on failure. + * @return: Zero on success, nonzero on failure. */ -int write_header(const struct wim_header *hdr, FILE *out) +int +write_header(const struct wim_header *hdr, FILE *out_fp) { u8 buf[WIM_HEADER_DISK_SIZE]; u8 *p; - DEBUG("Writing WIM header.\n"); + 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) ? + p = put_u32(p, (hdr->flags & WIM_HDR_FLAG_COMPRESSION) ? WIM_CHUNK_SIZE : 0); - randomize_byte_array(p, WIM_GID_LEN); - p += WIM_GID_LEN; - p = put_u16(p, 1); - p = put_u16(p, 1); + /* 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); @@ -174,92 +198,114 @@ int write_header(const struct wim_header *hdr, FILE *out) 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) != sizeof(buf)) { - DEBUG("Failed to write WIM header: %m\n"); + if (fwrite(buf, 1, sizeof(buf), out_fp) != sizeof(buf)) { + ERROR_WITH_ERRNO("Failed to write WIM header"); return WIMLIB_ERR_WRITE; } + DEBUG("Done writing WIM header"); return 0; } /* * 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 | - WIM_HDR_FLAG_COMPRESS_LZX; + 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 | - WIM_HDR_FLAG_COMPRESS_XPRESS; + case WIMLIB_COMPRESSION_TYPE_XPRESS: + hdr->flags = WIM_HDR_FLAG_COMPRESSION | + WIM_HDR_FLAG_COMPRESS_XPRESS; break; default: - ERROR("Invalid compression type specified (%d)!\n", ctype); + ERROR("Invalid compression type specified (%d)", ctype); return WIMLIB_ERR_INVALID_COMPRESSION_TYPE; } + hdr->total_parts = 1; + hdr->part_number = 1; randomize_byte_array(hdr->guid, sizeof(hdr->guid)); return 0; } +struct hdr_flag { + u32 flag; + const char *name; +}; +struct hdr_flag hdr_flags[] = { + {WIM_HDR_FLAG_RESERVED, "RESERVED"}, + {WIM_HDR_FLAG_COMPRESSION, "COMPRESSION"}, + {WIM_HDR_FLAG_READONLY, "READONLY"}, + {WIM_HDR_FLAG_SPANNED, "SPANNED"}, + {WIM_HDR_FLAG_RESOURCE_ONLY, "RESOURCE_ONLY"}, + {WIM_HDR_FLAG_METADATA_ONLY, "METADATA_ONLY"}, + {WIM_HDR_FLAG_WRITE_IN_PROGRESS,"WRITE_IN_PROGRESS"}, + {WIM_HDR_FLAG_RP_FIX, "RP_FIX"}, + {WIM_HDR_FLAG_COMPRESS_RESERVED,"COMPRESS_RESERVED"}, + {WIM_HDR_FLAG_COMPRESS_LZX, "COMPRESS_LZX"}, + {WIM_HDR_FLAG_COMPRESS_XPRESS, "COMPRESS_XPRESS"}, +}; + /* 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; - printf("Magic Characters = MSWIM\\000\\000\\000\n"); - printf("Header Size = %u\n", WIM_HEADER_DISK_SIZE); - printf("Version = 0x%x\n", WIM_VERSION); - printf("Flags = 0x%x\n", hdr->flags); - - if (hdr->flags & WIM_HDR_FLAG_COMPRESS_XPRESS) - printf(" COMPRESS XPRESS FLAG is set\n"); - - if (hdr->flags & WIM_HDR_FLAG_COMPRESS_LZX) - printf(" COMPRESS LZX FLAG is set\n"); - - 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", 1); - printf("Total Parts = %hu\n", 1); - printf("Image Count = %u\n", hdr->image_count); - printf("Lookup Table Size = %"PRIu64"\n", + + 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); + + 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) + 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); }