]> wimlib.net Git - wimlib/blobdiff - src/header.c
wimlib_print_header(): fix printing of magic number
[wimlib] / src / header.c
index 893874b5e953406fc8b6bf3313462b0c25cf192c..cbb1419978b663c5382a90d709039f95a5eff91c 100644 (file)
@@ -1,33 +1,37 @@
 /*
  * header.c
  *
- * Read, write, or create a WIM header.
+ * Read, write, or print a WIM header.
  */
 
 /*
- * Copyright (C) 2012, 2013 Eric Biggers
+ * Copyright (C) 2012, 2013, 2015 Eric Biggers
  *
- * This file is part of wimlib, a library for working with WIM files.
+ * This file 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 3 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.
- *
- * 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
+ * This file 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.
  *
- * You should have received a copy of the GNU General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this file; if not, see http://www.gnu.org/licenses/.
  */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
 
+#include <ctype.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+
 #include "wimlib.h"
+#include "wimlib/alloca.h"
 #include "wimlib/assert.h"
 #include "wimlib/endianness.h"
 #include "wimlib/error.h"
 #include "wimlib/util.h"
 #include "wimlib/wim.h"
 
-#include <limits.h>
-#include <string.h>
-#include <unistd.h>
-#ifdef HAVE_ALLOCA_H
-#  include <alloca.h>
-#else
-#  include <stdlib.h>
-#endif
-
 /*
  * Reads the header from a WIM file.
  *
  * @wim
- *     WIM to read the header from; @wim->in_fd must be positioned at the
- *     offset at which to read the header.
+ *     WIM to read the header from @wim->in_fd must be positioned at the
+ *     beginning of the file.
  *
  * @hdr
  *     Structure to read the header into.
@@ -89,12 +84,16 @@ read_wim_header(WIMStruct *wim, struct wim_header *hdr)
        if (ret)
                goto read_error;
 
-       if (disk_hdr.magic != WIM_MAGIC) {
-               if (disk_hdr.magic == PWM_MAGIC) {
+       hdr->magic = le64_to_cpu(disk_hdr.magic);
+
+       if (hdr->magic != WIM_MAGIC) {
+               if (hdr->magic == PWM_MAGIC) {
                        /* Pipable WIM:  Use header at end instead, unless
                         * actually reading from a pipe.  */
                        if (!in_fd->is_pipe) {
-                               lseek(in_fd->fd, -WIM_HEADER_DISK_SIZE, SEEK_END);
+                               ret = WIMLIB_ERR_READ;
+                               if (-1 == lseek(in_fd->fd, -WIM_HEADER_DISK_SIZE, SEEK_END))
+                                       goto read_error;
                                ret = full_read(in_fd, &disk_hdr, sizeof(disk_hdr));
                                if (ret)
                                        goto read_error;
@@ -104,7 +103,6 @@ read_wim_header(WIMStruct *wim, struct wim_header *hdr)
                        return WIMLIB_ERR_NOT_A_WIM_FILE;
                }
        }
-       hdr->magic = disk_hdr.magic;
 
        if (le32_to_cpu(disk_hdr.hdr_size) != sizeof(struct wim_header_disk)) {
                ERROR("\"%"TS"\": Header size is invalid (%u bytes)",
@@ -114,15 +112,16 @@ read_wim_header(WIMStruct *wim, struct wim_header *hdr)
 
        hdr->wim_version = le32_to_cpu(disk_hdr.wim_version);
        if (hdr->wim_version != WIM_VERSION_DEFAULT &&
-           hdr->wim_version != WIM_VERSION_PACKED_STREAMS)
+           hdr->wim_version != WIM_VERSION_SOLID)
        {
-               ERROR("\"%"TS"\": Unknown WIM version: %u", hdr->wim_version);
+               ERROR("\"%"TS"\": Unknown WIM version: %u",
+                     filename, hdr->wim_version);
                return WIMLIB_ERR_UNKNOWN_VERSION;
        }
 
        hdr->flags = le32_to_cpu(disk_hdr.wim_flags);
        hdr->chunk_size = le32_to_cpu(disk_hdr.chunk_size);
-       memcpy(hdr->guid, disk_hdr.guid, WIM_GID_LEN);
+       memcpy(hdr->guid, disk_hdr.guid, WIM_GUID_LEN);
        hdr->part_number = le16_to_cpu(disk_hdr.part_number);
        hdr->total_parts = le16_to_cpu(disk_hdr.total_parts);
 
@@ -139,13 +138,13 @@ read_wim_header(WIMStruct *wim, struct wim_header *hdr)
        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) {
+       if (unlikely(hdr->image_count > MAX_IMAGES)) {
                ERROR("\"%"TS"\": Invalid image count (%u)",
                      filename, hdr->image_count);
                return WIMLIB_ERR_IMAGE_COUNT;
        }
 
-       get_wim_reshdr(&disk_hdr.lookup_table_reshdr, &hdr->lookup_table_reshdr);
+       get_wim_reshdr(&disk_hdr.blob_table_reshdr, &hdr->blob_table_reshdr);
        get_wim_reshdr(&disk_hdr.xml_data_reshdr, &hdr->xml_data_reshdr);
        get_wim_reshdr(&disk_hdr.boot_metadata_reshdr, &hdr->boot_metadata_reshdr);
        hdr->boot_idx = le32_to_cpu(disk_hdr.boot_idx);
@@ -171,7 +170,7 @@ write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
              ((hdr->magic == PWM_MAGIC) ? "pipable " : ""),
              offset);
 
-       disk_hdr.magic = hdr->magic;
+       disk_hdr.magic = cpu_to_le64(hdr->magic);
        disk_hdr.hdr_size = cpu_to_le32(sizeof(struct wim_header_disk));
        disk_hdr.wim_version = cpu_to_le32(hdr->wim_version);
        disk_hdr.wim_flags = cpu_to_le32(hdr->flags);
@@ -179,12 +178,12 @@ write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
                disk_hdr.chunk_size = cpu_to_le32(hdr->chunk_size);
        else
                disk_hdr.chunk_size = 0;
-       memcpy(disk_hdr.guid, hdr->guid, WIM_GID_LEN);
+       memcpy(disk_hdr.guid, hdr->guid, WIM_GUID_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_wim_reshdr(&hdr->lookup_table_reshdr, &disk_hdr.lookup_table_reshdr);
+       put_wim_reshdr(&hdr->blob_table_reshdr, &disk_hdr.blob_table_reshdr);
        put_wim_reshdr(&hdr->xml_data_reshdr, &disk_hdr.xml_data_reshdr);
        put_wim_reshdr(&hdr->boot_metadata_reshdr, &disk_hdr.boot_metadata_reshdr);
        disk_hdr.boot_idx = cpu_to_le32(hdr->boot_idx);
@@ -218,62 +217,54 @@ write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd)
                           offsetof(struct wim_header_disk, wim_flags));
 }
 
-int
-set_wim_hdr_cflags(int ctype, struct wim_header *hdr)
+void
+set_wim_hdr_cflags(enum wimlib_compression_type ctype, struct wim_header *hdr)
 {
        hdr->flags &= ~(WIM_HDR_FLAG_COMPRESSION |
-                       WIM_HDR_FLAG_COMPRESS_LZX |
                        WIM_HDR_FLAG_COMPRESS_RESERVED |
                        WIM_HDR_FLAG_COMPRESS_XPRESS |
-                       WIM_HDR_FLAG_COMPRESS_LZMS);
+                       WIM_HDR_FLAG_COMPRESS_LZX |
+                       WIM_HDR_FLAG_COMPRESS_LZMS |
+                       WIM_HDR_FLAG_COMPRESS_XPRESS_2);
        switch (ctype) {
-
        case WIMLIB_COMPRESSION_TYPE_NONE:
-               return 0;
-
-       case WIMLIB_COMPRESSION_TYPE_LZX:
-               hdr->flags |= WIM_HDR_FLAG_COMPRESSION | WIM_HDR_FLAG_COMPRESS_LZX;
-               return 0;
-
+               return;
        case WIMLIB_COMPRESSION_TYPE_XPRESS:
                hdr->flags |= WIM_HDR_FLAG_COMPRESSION | WIM_HDR_FLAG_COMPRESS_XPRESS;
-               return 0;
-
+               return;
+       case WIMLIB_COMPRESSION_TYPE_LZX:
+               hdr->flags |= WIM_HDR_FLAG_COMPRESSION | WIM_HDR_FLAG_COMPRESS_LZX;
+               return;
        case WIMLIB_COMPRESSION_TYPE_LZMS:
                hdr->flags |= WIM_HDR_FLAG_COMPRESSION | WIM_HDR_FLAG_COMPRESS_LZMS;
-               return 0;
-
-       default:
-               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+               return;
        }
+       wimlib_assert(0);
 }
 
-/*
- * Initializes the header for a WIM file.
- */
-int
-init_wim_header(struct wim_header *hdr, int ctype, u32 chunk_size)
+/* Initialize the header for a WIM file.  */
+void
+init_wim_header(struct wim_header *hdr,
+               enum wimlib_compression_type ctype, u32 chunk_size)
 {
        memset(hdr, 0, sizeof(struct wim_header));
        hdr->magic = WIM_MAGIC;
-       hdr->wim_version = WIM_VERSION_DEFAULT;
-       if (set_wim_hdr_cflags(ctype, hdr)) {
-               ERROR("Invalid compression type specified (%d)", ctype);
-               return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
-       }
+       if (ctype == WIMLIB_COMPRESSION_TYPE_LZMS)
+               hdr->wim_version = WIM_VERSION_SOLID;
+       else
+               hdr->wim_version = WIM_VERSION_DEFAULT;
+       set_wim_hdr_cflags(ctype, hdr);
        hdr->chunk_size = chunk_size;
        hdr->total_parts = 1;
        hdr->part_number = 1;
        randomize_byte_array(hdr->guid, sizeof(hdr->guid));
-       return 0;
 }
 
-struct hdr_flag {
+static const struct {
        u32 flag;
        const char *name;
-};
-struct hdr_flag hdr_flags[] = {
-       {WIM_HDR_FLAG_RESERVED,         "RESERVED"},
+} hdr_flags[] = {
+       {WIM_HDR_FLAG_RESERVED,         "RESERVED"},
        {WIM_HDR_FLAG_COMPRESSION,      "COMPRESSION"},
        {WIM_HDR_FLAG_READONLY,         "READONLY"},
        {WIM_HDR_FLAG_SPANNED,          "SPANNED"},
@@ -284,6 +275,8 @@ struct hdr_flag hdr_flags[] = {
        {WIM_HDR_FLAG_COMPRESS_RESERVED,"COMPRESS_RESERVED"},
        {WIM_HDR_FLAG_COMPRESS_LZX,     "COMPRESS_LZX"},
        {WIM_HDR_FLAG_COMPRESS_XPRESS,  "COMPRESS_XPRESS"},
+       {WIM_HDR_FLAG_COMPRESS_LZMS,    "COMPRESS_LZMS"},
+       {WIM_HDR_FLAG_COMPRESS_XPRESS_2,"COMPRESS_XPRESS_2"},
 };
 
 /* API function documented in wimlib.h  */
@@ -292,7 +285,15 @@ wimlib_print_header(const WIMStruct *wim)
 {
        const struct wim_header *hdr = &wim->hdr;
 
-       tprintf(T("Magic Characters            = MSWIM\\000\\000\\000\n"));
+       tprintf(T("Magic Characters            = "));
+       for (int i = 0; i < sizeof(hdr->magic); i++) {
+               tchar c = (u8)(hdr->magic >> ((8 * i)));
+               if (istalpha(c))
+                       tputchar(c);
+               else
+                       tprintf(T("\\%o"), c);
+       }
+       tputchar(T('\n'));
        tprintf(T("Header Size                 = %u\n"), WIM_HEADER_DISK_SIZE);
        tprintf(T("Version                     = 0x%x\n"), hdr->wim_version);
 
@@ -303,19 +304,19 @@ wimlib_print_header(const WIMStruct *wim)
 
        tprintf(T("Chunk Size                  = %u\n"), hdr->chunk_size);
        tfputs (T("GUID                        = "), stdout);
-       print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
+       print_byte_field(hdr->guid, WIM_GUID_LEN, stdout);
        tputchar(T('\n'));
        tprintf(T("Part Number                 = %hu\n"), hdr->part_number);
        tprintf(T("Total Parts                 = %hu\n"), hdr->total_parts);
        tprintf(T("Image Count                 = %u\n"), hdr->image_count);
-       tprintf(T("Lookup Table Size           = %"PRIu64"\n"),
-                               (u64)hdr->lookup_table_reshdr.size_in_wim);
-       tprintf(T("Lookup Table Flags          = 0x%hhx\n"),
-                               (u8)hdr->lookup_table_reshdr.flags);
-       tprintf(T("Lookup Table Offset         = %"PRIu64"\n"),
-                               hdr->lookup_table_reshdr.offset_in_wim);
-       tprintf(T("Lookup Table Original_size  = %"PRIu64"\n"),
-                               hdr->lookup_table_reshdr.uncompressed_size);
+       tprintf(T("Blob Table Size             = %"PRIu64"\n"),
+                               (u64)hdr->blob_table_reshdr.size_in_wim);
+       tprintf(T("Blob Table Flags            = 0x%hhx\n"),
+                               (u8)hdr->blob_table_reshdr.flags);
+       tprintf(T("Blob Table Offset           = %"PRIu64"\n"),
+                               hdr->blob_table_reshdr.offset_in_wim);
+       tprintf(T("Blob Table Original_size    = %"PRIu64"\n"),
+                               hdr->blob_table_reshdr.uncompressed_size);
        tprintf(T("XML Data Size               = %"PRIu64"\n"),
                                (u64)hdr->xml_data_reshdr.size_in_wim);
        tprintf(T("XML Data Flags              = 0x%hhx\n"),