4 * Read, write, or print a WIM header.
8 * Copyright (C) 2012, 2013, 2015 Eric Biggers
10 * This file is free software; you can redistribute it and/or modify it under
11 * the terms of the GNU Lesser General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option) any
15 * This file is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this file; if not, see http://www.gnu.org/licenses/.
34 #include "wimlib/alloca.h"
35 #include "wimlib/assert.h"
36 #include "wimlib/endianness.h"
37 #include "wimlib/error.h"
38 #include "wimlib/file_io.h"
39 #include "wimlib/header.h"
40 #include "wimlib/util.h"
41 #include "wimlib/wim.h"
44 * Reads the header from a WIM file.
47 * WIM to read the header from. @wim->in_fd must be positioned at the
48 * beginning of the file.
51 * Structure to read the header into.
54 * WIMLIB_ERR_SUCCESS (0)
55 * WIMLIB_ERR_IMAGE_COUNT
56 * WIMLIB_ERR_INVALID_PART_NUMBER
57 * WIMLIB_ERR_NOT_A_WIM_FILE
59 * WIMLIB_ERR_UNEXPECTED_END_OF_FILE
60 * WIMLIB_ERR_UNKNOWN_VERSION
63 read_wim_header(WIMStruct *wim, struct wim_header *hdr)
65 struct wim_header_disk disk_hdr _aligned_attribute(8);
66 struct filedes *in_fd = &wim->in_fd;
67 const tchar *filename = wim->filename;
71 wimlib_assert(in_fd->offset == 0);
73 if (filename == NULL) {
74 pipe_str = alloca(40);
75 tsprintf(pipe_str, T("[fd %d]"), in_fd->fd);
79 BUILD_BUG_ON(sizeof(struct wim_header_disk) != WIM_HEADER_DISK_SIZE);
81 DEBUG("Reading WIM header from \"%"TS"\"", filename);
83 ret = full_read(in_fd, &disk_hdr, sizeof(disk_hdr));
87 hdr->magic = le64_to_cpu(disk_hdr.magic);
89 if (hdr->magic != WIM_MAGIC) {
90 if (hdr->magic == PWM_MAGIC) {
91 /* Pipable WIM: Use header at end instead, unless
92 * actually reading from a pipe. */
93 if (!in_fd->is_pipe) {
94 ret = WIMLIB_ERR_READ;
95 if (-1 == lseek(in_fd->fd, -WIM_HEADER_DISK_SIZE, SEEK_END))
97 ret = full_read(in_fd, &disk_hdr, sizeof(disk_hdr));
102 ERROR("\"%"TS"\": Invalid magic characters in header", filename);
103 return WIMLIB_ERR_NOT_A_WIM_FILE;
107 if (le32_to_cpu(disk_hdr.hdr_size) != sizeof(struct wim_header_disk)) {
108 ERROR("\"%"TS"\": Header size is invalid (%u bytes)",
109 filename, le32_to_cpu(disk_hdr.hdr_size));
110 return WIMLIB_ERR_INVALID_HEADER;
113 hdr->wim_version = le32_to_cpu(disk_hdr.wim_version);
114 if (hdr->wim_version != WIM_VERSION_DEFAULT &&
115 hdr->wim_version != WIM_VERSION_SOLID)
117 ERROR("\"%"TS"\": Unknown WIM version: %u",
118 filename, hdr->wim_version);
119 return WIMLIB_ERR_UNKNOWN_VERSION;
122 hdr->flags = le32_to_cpu(disk_hdr.wim_flags);
123 hdr->chunk_size = le32_to_cpu(disk_hdr.chunk_size);
124 copy_guid(hdr->guid, disk_hdr.guid);
125 hdr->part_number = le16_to_cpu(disk_hdr.part_number);
126 hdr->total_parts = le16_to_cpu(disk_hdr.total_parts);
128 if (hdr->total_parts == 0 || hdr->part_number == 0 ||
129 hdr->part_number > hdr->total_parts)
131 ERROR("\"%"TS"\": Invalid WIM part number: %hu of %hu",
132 filename, hdr->part_number, hdr->total_parts);
133 return WIMLIB_ERR_INVALID_PART_NUMBER;
136 hdr->image_count = le32_to_cpu(disk_hdr.image_count);
138 DEBUG("part_number = %u, total_parts = %u, image_count = %u",
139 hdr->part_number, hdr->total_parts, hdr->image_count);
141 if (unlikely(hdr->image_count > MAX_IMAGES)) {
142 ERROR("\"%"TS"\": Invalid image count (%u)",
143 filename, hdr->image_count);
144 return WIMLIB_ERR_IMAGE_COUNT;
147 get_wim_reshdr(&disk_hdr.blob_table_reshdr, &hdr->blob_table_reshdr);
148 get_wim_reshdr(&disk_hdr.xml_data_reshdr, &hdr->xml_data_reshdr);
149 get_wim_reshdr(&disk_hdr.boot_metadata_reshdr, &hdr->boot_metadata_reshdr);
150 hdr->boot_idx = le32_to_cpu(disk_hdr.boot_idx);
151 get_wim_reshdr(&disk_hdr.integrity_table_reshdr, &hdr->integrity_table_reshdr);
155 ERROR_WITH_ERRNO("\"%"TS"\": Error reading header", filename);
159 /* Writes the header for a WIM file at the specified offset. If the offset
160 * specified is the current one, the position is advanced by the size of the
163 write_wim_header(const struct wim_header *hdr, struct filedes *out_fd,
166 struct wim_header_disk disk_hdr _aligned_attribute(8);
169 DEBUG("Writing %sWIM header at offset %"PRIu64,
170 ((hdr->magic == PWM_MAGIC) ? "pipable " : ""),
173 disk_hdr.magic = cpu_to_le64(hdr->magic);
174 disk_hdr.hdr_size = cpu_to_le32(sizeof(struct wim_header_disk));
175 disk_hdr.wim_version = cpu_to_le32(hdr->wim_version);
176 disk_hdr.wim_flags = cpu_to_le32(hdr->flags);
177 disk_hdr.chunk_size = cpu_to_le32(hdr->chunk_size);
178 copy_guid(disk_hdr.guid, hdr->guid);
179 disk_hdr.part_number = cpu_to_le16(hdr->part_number);
180 disk_hdr.total_parts = cpu_to_le16(hdr->total_parts);
181 disk_hdr.image_count = cpu_to_le32(hdr->image_count);
182 put_wim_reshdr(&hdr->blob_table_reshdr, &disk_hdr.blob_table_reshdr);
183 put_wim_reshdr(&hdr->xml_data_reshdr, &disk_hdr.xml_data_reshdr);
184 put_wim_reshdr(&hdr->boot_metadata_reshdr, &disk_hdr.boot_metadata_reshdr);
185 disk_hdr.boot_idx = cpu_to_le32(hdr->boot_idx);
186 put_wim_reshdr(&hdr->integrity_table_reshdr, &disk_hdr.integrity_table_reshdr);
187 memset(disk_hdr.unused, 0, sizeof(disk_hdr.unused));
189 if (offset == out_fd->offset)
190 ret = full_write(out_fd, &disk_hdr, sizeof(disk_hdr));
192 ret = full_pwrite(out_fd, &disk_hdr, sizeof(disk_hdr), offset);
194 ERROR_WITH_ERRNO("Failed to write WIM header");
198 /* Update just the wim_flags field. */
200 write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd)
202 le32 flags = cpu_to_le32(hdr_flags);
204 return full_pwrite(out_fd, &flags, sizeof(flags),
205 offsetof(struct wim_header_disk, wim_flags));
208 static const struct {
212 {WIM_HDR_FLAG_RESERVED, "RESERVED"},
213 {WIM_HDR_FLAG_COMPRESSION, "COMPRESSION"},
214 {WIM_HDR_FLAG_READONLY, "READONLY"},
215 {WIM_HDR_FLAG_SPANNED, "SPANNED"},
216 {WIM_HDR_FLAG_RESOURCE_ONLY, "RESOURCE_ONLY"},
217 {WIM_HDR_FLAG_METADATA_ONLY, "METADATA_ONLY"},
218 {WIM_HDR_FLAG_WRITE_IN_PROGRESS,"WRITE_IN_PROGRESS"},
219 {WIM_HDR_FLAG_RP_FIX, "RP_FIX"},
220 {WIM_HDR_FLAG_COMPRESS_RESERVED,"COMPRESS_RESERVED"},
221 {WIM_HDR_FLAG_COMPRESS_LZX, "COMPRESS_LZX"},
222 {WIM_HDR_FLAG_COMPRESS_XPRESS, "COMPRESS_XPRESS"},
223 {WIM_HDR_FLAG_COMPRESS_LZMS, "COMPRESS_LZMS"},
224 {WIM_HDR_FLAG_COMPRESS_XPRESS_2,"COMPRESS_XPRESS_2"},
227 /* API function documented in wimlib.h */
229 wimlib_print_header(const WIMStruct *wim)
231 const struct wim_header *hdr = &wim->hdr;
233 tprintf(T("Magic Characters = "));
234 for (int i = 0; i < sizeof(hdr->magic); i++) {
235 tchar c = (u8)(hdr->magic >> ((8 * i)));
239 tprintf(T("\\%o"), c);
242 tprintf(T("Header Size = %u\n"), WIM_HEADER_DISK_SIZE);
243 tprintf(T("Version = 0x%x\n"), hdr->wim_version);
245 tprintf(T("Flags = 0x%x\n"), hdr->flags);
246 for (size_t i = 0; i < ARRAY_LEN(hdr_flags); i++)
247 if (hdr_flags[i].flag & hdr->flags)
248 tprintf(T(" WIM_HDR_FLAG_%s is set\n"), hdr_flags[i].name);
250 tprintf(T("Chunk Size = %u\n"), hdr->chunk_size);
251 tfputs (T("GUID = "), stdout);
252 print_byte_field(hdr->guid, GUID_SIZE, stdout);
254 tprintf(T("Part Number = %hu\n"), hdr->part_number);
255 tprintf(T("Total Parts = %hu\n"), hdr->total_parts);
256 tprintf(T("Image Count = %u\n"), hdr->image_count);
257 tprintf(T("Blob Table Size = %"PRIu64"\n"),
258 (u64)hdr->blob_table_reshdr.size_in_wim);
259 tprintf(T("Blob Table Flags = 0x%hhx\n"),
260 (u8)hdr->blob_table_reshdr.flags);
261 tprintf(T("Blob Table Offset = %"PRIu64"\n"),
262 hdr->blob_table_reshdr.offset_in_wim);
263 tprintf(T("Blob Table Original_size = %"PRIu64"\n"),
264 hdr->blob_table_reshdr.uncompressed_size);
265 tprintf(T("XML Data Size = %"PRIu64"\n"),
266 (u64)hdr->xml_data_reshdr.size_in_wim);
267 tprintf(T("XML Data Flags = 0x%hhx\n"),
268 (u8)hdr->xml_data_reshdr.flags);
269 tprintf(T("XML Data Offset = %"PRIu64"\n"),
270 hdr->xml_data_reshdr.offset_in_wim);
271 tprintf(T("XML Data Original Size = %"PRIu64"\n"),
272 hdr->xml_data_reshdr.uncompressed_size);
273 tprintf(T("Boot Metadata Size = %"PRIu64"\n"),
274 (u64)hdr->boot_metadata_reshdr.size_in_wim);
275 tprintf(T("Boot Metadata Flags = 0x%hhx\n"),
276 (u8)hdr->boot_metadata_reshdr.flags);
277 tprintf(T("Boot Metadata Offset = %"PRIu64"\n"),
278 hdr->boot_metadata_reshdr.offset_in_wim);
279 tprintf(T("Boot Metadata Original Size = %"PRIu64"\n"),
280 hdr->boot_metadata_reshdr.uncompressed_size);
281 tprintf(T("Boot Index = %u\n"), hdr->boot_idx);
282 tprintf(T("Integrity Size = %"PRIu64"\n"),
283 (u64)hdr->integrity_table_reshdr.size_in_wim);
284 tprintf(T("Integrity Flags = 0x%hhx\n"),
285 (u8)hdr->integrity_table_reshdr.flags);
286 tprintf(T("Integrity Offset = %"PRIu64"\n"),
287 hdr->integrity_table_reshdr.offset_in_wim);
288 tprintf(T("Integrity Original_size = %"PRIu64"\n"),
289 hdr->integrity_table_reshdr.uncompressed_size);