/*
* 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/.
*/
-#include "wimlib_internal.h"
-#include "buffer_io.h"
-#include <limits.h>
-
-/* First 8 bytes in every WIM file. */
-static const u8 wim_magic_chars[WIM_MAGIC_LEN] = {
- 'M', 'S', 'W', 'I', 'M', '\0', '\0', '\0' };
+#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/file_io.h"
+#include "wimlib/header.h"
+#include "wimlib/util.h"
+#include "wimlib/wim.h"
-/* Reads the header from a WIM file. */
+/*
+ * Reads the header from a WIM file.
+ *
+ * @wim
+ * 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.
+ *
+ * Return values:
+ * WIMLIB_ERR_SUCCESS (0)
+ * WIMLIB_ERR_IMAGE_COUNT
+ * WIMLIB_ERR_INVALID_PART_NUMBER
+ * WIMLIB_ERR_NOT_A_WIM_FILE
+ * WIMLIB_ERR_READ
+ * WIMLIB_ERR_UNEXPECTED_END_OF_FILE
+ * WIMLIB_ERR_UNKNOWN_VERSION
+ */
int
-read_header(const tchar *filename, int in_fd,
- struct wim_header *hdr, int open_flags)
+read_wim_header(WIMStruct *wim, struct wim_header *hdr)
{
- size_t bytes_read;
- u8 buf[WIM_HEADER_DISK_SIZE];
- const void *p;
-
- u32 hdr_size;
- u32 wim_version;
- u32 chunk_size;
-
- DEBUG("Reading WIM header from \"%"TS"\".", filename);
-
- bytes_read = full_pread(in_fd, buf, WIM_HEADER_DISK_SIZE, 0);
-
- if (bytes_read != WIM_HEADER_DISK_SIZE) {
- ERROR_WITH_ERRNO("\"%"TS"\": Error reading header", filename);
- return WIMLIB_ERR_READ;
+ struct wim_header_disk disk_hdr _aligned_attribute(8);
+ struct filedes *in_fd = &wim->in_fd;
+ const tchar *filename = wim->filename;
+ int ret;
+ tchar *pipe_str;
+
+ wimlib_assert(in_fd->offset == 0);
+
+ if (filename == NULL) {
+ pipe_str = alloca(40);
+ tsprintf(pipe_str, T("[fd %d]"), in_fd->fd);
+ filename = pipe_str;
}
- p = buf;
- if (memcmp(p, wim_magic_chars, WIM_MAGIC_LEN)) {
- ERROR("\"%"TS"\": Invalid magic characters in header", filename);
- return WIMLIB_ERR_NOT_A_WIM_FILE;
+ BUILD_BUG_ON(sizeof(struct wim_header_disk) != WIM_HEADER_DISK_SIZE);
+
+ ret = full_read(in_fd, &disk_hdr, sizeof(disk_hdr));
+ if (ret)
+ goto read_error;
+
+ 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) {
+ 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;
+ }
+ } else {
+ ERROR("\"%"TS"\": Invalid magic characters in header", filename);
+ return WIMLIB_ERR_NOT_A_WIM_FILE;
+ }
}
- /* Byte 8 */
- p = get_u32(p + 8, &hdr_size);
- if (hdr_size != WIM_HEADER_DISK_SIZE) {
- ERROR("\"%"TS"\": Header is %u bytes (expected %u bytes)",
- filename, hdr_size, WIM_HEADER_DISK_SIZE);
- return WIMLIB_ERR_INVALID_HEADER_SIZE;
+ 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;
}
- /* Byte 12 */
- p = get_u32(buf + WIM_MAGIC_LEN + sizeof(u32), &wim_version);
- if (wim_version != WIM_VERSION) {
- ERROR("\"%"TS"\": The WIM header says the WIM version is %u, "
- "but wimlib only knows about version %u",
- filename, wim_version, WIM_VERSION);
+ hdr->wim_version = le32_to_cpu(disk_hdr.wim_version);
+ if (hdr->wim_version != WIM_VERSION_DEFAULT &&
+ hdr->wim_version != WIM_VERSION_SOLID)
+ {
+ ERROR("\"%"TS"\": Unknown WIM version: %u",
+ filename, hdr->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)) {
- ERROR("\"%"TS"\": Unexpected chunk size of %u! Ask the author to "
- "implement support for other chunk sizes.",
- filename, chunk_size);
- ERROR("(Or it might just be that the WIM header is invalid.)");
- return WIMLIB_ERR_INVALID_CHUNK_SIZE;
- }
+ hdr->flags = le32_to_cpu(disk_hdr.wim_flags);
+ hdr->chunk_size = le32_to_cpu(disk_hdr.chunk_size);
+ copy_guid(hdr->guid, disk_hdr.guid);
+ hdr->part_number = le16_to_cpu(disk_hdr.part_number);
+ hdr->total_parts = le16_to_cpu(disk_hdr.total_parts);
- p = get_bytes(p, WIM_GID_LEN, hdr->guid);
- p = get_u16(p, &hdr->part_number);
- p = get_u16(p, &hdr->total_parts);
-
- if (hdr->total_parts == 0 ||
- hdr->part_number == 0 ||
+ if (hdr->total_parts == 0 || hdr->part_number == 0 ||
hdr->part_number > hdr->total_parts)
{
ERROR("\"%"TS"\": Invalid WIM part number: %hu of %hu",
return WIMLIB_ERR_INVALID_PART_NUMBER;
}
- 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);
-
- DEBUG("part_number = %u, total_parts = %u, image_count = %u",
- hdr->part_number, hdr->total_parts, hdr->image_count);
+ hdr->image_count = le32_to_cpu(disk_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;
}
- /* 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 */
-
+ 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);
+ get_wim_reshdr(&disk_hdr.integrity_table_reshdr, &hdr->integrity_table_reshdr);
return 0;
+
+read_error:
+ ERROR_WITH_ERRNO("\"%"TS"\": Error reading header", filename);
+ return ret;
}
-/*
- * Writes the header for a WIM file.
- *
- * @hdr: A pointer to a struct wim_header structure that describes the header.
- * @out_fd: The file descriptor to the WIM file, opened for writing.
- *
- * Returns zero on success, nonzero on failure.
- */
+/* Writes the header for a WIM file at the specified offset. If the offset
+ * specified is the current one, the position is advanced by the size of the
+ * header. */
int
-write_header(const struct wim_header *hdr, int out_fd)
+write_wim_header(const struct wim_header *hdr, struct filedes *out_fd,
+ off_t offset)
{
- u8 buf[WIM_HEADER_DISK_SIZE];
- u8 *p;
- 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);
- p = put_zeroes(p, WIM_UNUSED_LEN);
- wimlib_assert(p - buf == sizeof(buf));
-
- if (full_pwrite(out_fd, buf, sizeof(buf), 0) != sizeof(buf)) {
+ struct wim_header_disk disk_hdr _aligned_attribute(8);
+ int ret;
+
+ 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);
+ disk_hdr.chunk_size = cpu_to_le32(hdr->chunk_size);
+ copy_guid(disk_hdr.guid, hdr->guid);
+ 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->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);
+ put_wim_reshdr(&hdr->integrity_table_reshdr, &disk_hdr.integrity_table_reshdr);
+ memset(disk_hdr.unused, 0, sizeof(disk_hdr.unused));
+
+ if (offset == out_fd->offset)
+ ret = full_write(out_fd, &disk_hdr, sizeof(disk_hdr));
+ else
+ ret = full_pwrite(out_fd, &disk_hdr, sizeof(disk_hdr), offset);
+ if (ret)
ERROR_WITH_ERRNO("Failed to write WIM header");
- return WIMLIB_ERR_WRITE;
- }
- DEBUG("Done writing WIM header");
- return 0;
+ return ret;
}
-/*
- * Initializes the header for a WIM file.
- */
+/* Update just the wim_flags field. */
int
-init_header(struct wim_header *hdr, int ctype)
+write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd)
{
- memset(hdr, 0, sizeof(struct wim_header));
- switch (ctype) {
- case WIMLIB_COMPRESSION_TYPE_NONE:
- hdr->flags = 0;
- break;
- case WIMLIB_COMPRESSION_TYPE_LZX:
- hdr->flags = WIM_HDR_FLAG_COMPRESSION |
- WIM_HDR_FLAG_COMPRESS_LZX;
- break;
- case WIMLIB_COMPRESSION_TYPE_XPRESS:
- hdr->flags = WIM_HDR_FLAG_COMPRESSION |
- WIM_HDR_FLAG_COMPRESS_XPRESS;
- break;
- default:
- 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;
+ le32 flags = cpu_to_le32(hdr_flags);
+
+ return full_pwrite(out_fd, &flags, sizeof(flags),
+ offsetof(struct wim_header_disk, wim_flags));
}
-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"},
{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"},
};
-/* Prints information from the header of the WIM file associated with @w. */
+/* API function documented in wimlib.h */
WIMLIBAPI void
-wimlib_print_header(const WIMStruct *w)
+wimlib_print_header(const WIMStruct *wim)
{
- const struct wim_header *hdr = &w->hdr;
-
- tprintf(T("Magic Characters = MSWIM\\000\\000\\000\n"));
+ const struct wim_header *hdr = &wim->hdr;
+
+ 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"), WIM_VERSION);
+ tprintf(T("Version = 0x%x\n"), hdr->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);
+ 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, GUID_SIZE, 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("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_res_entry.size);
- 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);
- tprintf(T("Lookup Table Original_size = %"PRIu64"\n"),
- hdr->lookup_table_res_entry.original_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_res_entry.size);
+ (u64)hdr->xml_data_reshdr.size_in_wim);
tprintf(T("XML Data Flags = 0x%hhx\n"),
- (u8)hdr->xml_res_entry.flags);
+ (u8)hdr->xml_data_reshdr.flags);
tprintf(T("XML Data Offset = %"PRIu64"\n"),
- hdr->xml_res_entry.offset);
+ hdr->xml_data_reshdr.offset_in_wim);
tprintf(T("XML Data Original Size = %"PRIu64"\n"),
- hdr->xml_res_entry.original_size);
+ hdr->xml_data_reshdr.uncompressed_size);
tprintf(T("Boot Metadata Size = %"PRIu64"\n"),
- (u64)hdr->boot_metadata_res_entry.size);
+ (u64)hdr->boot_metadata_reshdr.size_in_wim);
tprintf(T("Boot Metadata Flags = 0x%hhx\n"),
- (u8)hdr->boot_metadata_res_entry.flags);
+ (u8)hdr->boot_metadata_reshdr.flags);
tprintf(T("Boot Metadata Offset = %"PRIu64"\n"),
- hdr->boot_metadata_res_entry.offset);
+ hdr->boot_metadata_reshdr.offset_in_wim);
tprintf(T("Boot Metadata Original Size = %"PRIu64"\n"),
- hdr->boot_metadata_res_entry.original_size);
+ hdr->boot_metadata_reshdr.uncompressed_size);
tprintf(T("Boot Index = %u\n"), hdr->boot_idx);
tprintf(T("Integrity Size = %"PRIu64"\n"),
- (u64)hdr->integrity.size);
+ (u64)hdr->integrity_table_reshdr.size_in_wim);
tprintf(T("Integrity Flags = 0x%hhx\n"),
- (u8)hdr->integrity.flags);
+ (u8)hdr->integrity_table_reshdr.flags);
tprintf(T("Integrity Offset = %"PRIu64"\n"),
- hdr->integrity.offset);
+ hdr->integrity_table_reshdr.offset_in_wim);
tprintf(T("Integrity Original_size = %"PRIu64"\n"),
- hdr->integrity.original_size);
+ hdr->integrity_table_reshdr.uncompressed_size);
}
git://wimlib.net / wimlib / blobdiff