]> wimlib.net Git - wimlib/blobdiff - src/header.c
begin_read(): Remove redundant check
[wimlib] / src / header.c
index 6d00ccb46a7aaf319e876365c20be1d68174f36d..3d60138339e527c8d9383da3330170625e5cc618 100644 (file)
@@ -5,34 +5,34 @@
  */
 
 /*
- * Copyright (C) 2010 Carl Thijssen
  * Copyright (C) 2012 Eric Biggers
  *
  * This file is part of wimlib, a library for working with WIM files.
  *
  * wimlib 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)
+ * 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.
  *
  * 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 Lesser General Public License for more
+ * 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
+ * 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 <limits.h>
 
 /* 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 split_ok)
+int read_header(FILE *fp, struct wim_header *hdr, int open_flags)
 {
        size_t bytes_read;
        u8 buf[WIM_HEADER_DISK_SIZE];
@@ -43,8 +43,8 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
        u32 wim_version;
        u32 chunk_size;
 
-       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 +53,7 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
        /* 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 +61,13 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
        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 +75,7 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
 
        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,20 +83,20 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
        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;
        }
 
@@ -104,16 +104,32 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
        p = get_u16(p, &hdr->part_number);
        p = get_u16(p, &hdr->total_parts);
 
-       if (!split_ok && (hdr->part_number != 1 || hdr->total_parts != 1)) {
-               ERROR("This WIM is part %u of a %u-part WIM.\n",
-                       hdr->part_number, 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\n",
-                       hdr->part_number, hdr->total_parts, 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 */
 
@@ -139,31 +155,31 @@ int read_header(FILE *fp, struct wim_header *hdr, int split_ok)
 
 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);
        /* byte 24 */
 
@@ -180,10 +196,11 @@ 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;
 }
 
@@ -194,19 +211,19 @@ 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;
@@ -237,14 +254,13 @@ struct hdr_flag hdr_flags[] = {
 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);
 
        printf("Flags                       = 0x%x\n", hdr->flags);
-       for (i = 0; i < ARRAY_LEN(hdr_flags); i++)
+       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);
 
@@ -252,40 +268,40 @@ WIMLIBAPI void wimlib_print_header(const WIMStruct *w)
        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("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", 
+       printf("Lookup Table Size           = %"PRIu64"\n",
                                (u64)hdr->lookup_table_res_entry.size);
-       printf("Lookup Table Flags          = 0x%hhx\n", 
+       printf("Lookup Table Flags          = 0x%hhx\n",
                                hdr->lookup_table_res_entry.flags);
        printf("Lookup Table Offset         = %"PRIu64"\n",
                                hdr->lookup_table_res_entry.offset);
-       printf("Lookup Table Original_size  = %"PRIu64"\n", 
+       printf("Lookup Table Original_size  = %"PRIu64"\n",
                                hdr->lookup_table_res_entry.original_size);
-       printf("XML Data Size               = %"PRIu64"\n", 
+       printf("XML Data Size               = %"PRIu64"\n",
                                (u64)hdr->xml_res_entry.size);
-       printf("XML Data Flags              = 0x%hhx\n", 
+       printf("XML Data Flags              = 0x%hhx\n",
                                hdr->xml_res_entry.flags);
-       printf("XML Data Offset             = %"PRIu64"\n", 
+       printf("XML Data Offset             = %"PRIu64"\n",
                                hdr->xml_res_entry.offset);
-       printf("XML Data Original Size      = %"PRIu64"\n", 
+       printf("XML Data Original Size      = %"PRIu64"\n",
                                hdr->xml_res_entry.original_size);
-       printf("Boot Metadata Size          = %"PRIu64"\n", 
+       printf("Boot Metadata Size          = %"PRIu64"\n",
                                (u64)hdr->boot_metadata_res_entry.size);
-       printf("Boot Metadata Flags         = 0x%hhx\n", 
+       printf("Boot Metadata Flags         = 0x%hhx\n",
                                hdr->boot_metadata_res_entry.flags);
-       printf("Boot Metadata Offset        = %"PRIu64"\n", 
+       printf("Boot Metadata Offset        = %"PRIu64"\n",
                                hdr->boot_metadata_res_entry.offset);
-       printf("Boot Metadata Original Size = %"PRIu64"\n", 
+       printf("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", 
+       printf("Integrity Size              = %"PRIu64"\n",
                                        (u64)hdr->integrity.size);
-       printf("Integrity Flags             = 0x%hhx\n", 
+       printf("Integrity Flags             = 0x%hhx\n",
                                        hdr->integrity.flags);
-       printf("Integrity Offset            = %"PRIu64"\n", 
+       printf("Integrity Offset            = %"PRIu64"\n",
                                        hdr->integrity.offset);
-       printf("Integrity Original_size     = %"PRIu64"\n", 
+       printf("Integrity Original_size     = %"PRIu64"\n",
                                        hdr->integrity.original_size);
 }