1 #ifndef _WIMLIB_HEADER_H
2 #define _WIMLIB_HEADER_H
4 #include "wimlib/resource.h"
5 #include "wimlib/types.h"
6 #include "wimlib/endianness.h"
10 /* Length of "Globally Unique ID" field in WIM header. */
11 #define WIM_GUID_LEN 16
13 /* Length of the WIM header on disk. wimlib currently requires that the header
14 * be exactly this size. */
15 #define WIM_HEADER_DISK_SIZE 208
17 /* Default WIM version number. Streams are always compressed independently. */
18 #define WIM_VERSION_DEFAULT 0x10d00
20 /* Version number used for WIMs that allow multiple streams packed into one
21 * resource ("solid blocks", marked by WIM_RESHDR_FLAG_PACKED_STREAMS) and also
22 * a new compression format (LZMS). This version is new as of Windows 8
23 * WIMGAPI. Although it is used by Windows 8 web downloader, it is not yet
24 * properly documented by Microsoft. */
25 #define WIM_VERSION_PACKED_STREAMS 0xe00
27 /* Note: there is another WIM version from Vista pre-releases, but it is not
28 * supported by wimlib. */
30 /* WIM magic characters, translated to a single 64-bit number. */
41 /* wimlib pipable WIM magic characters, translated to a single 64-bit number.
53 /* On-disk format of the WIM header. */
54 struct wim_header_disk {
56 /* +0x00: Magic characters WIM_MAGIC or PWM_MAGIC. */
59 /* +0x08: Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE
60 * expected (currently the only supported value). */
63 /* +0x0c: Version of the WIM file. Recognized values are the
64 * WIM_VERSION_* constants from above. */
67 /* +0x10: Flags for the WIM file (WIM_HDR_FLAG_*). */
70 /* +0x14: Uncompressed chunk size for compressed resources in the WIM
71 * other than packed resources, or 0 if the WIM is uncompressed.
72 * (However wimlib will currently accept any value here if the WIM is
76 /* +0x18: Globally unique identifier for the WIM file. Basically a
77 * bunch of random bytes. */
78 u8 guid[WIM_GUID_LEN];
80 /* +0x28: Number of this WIM part in the split WIM file, indexed from 1,
81 * or 1 if the WIM is not split. */
84 /* +0x2a: Total number of parts of the split WIM file, or 1 if the WIM
88 /* +0x2c: Number of images in the WIM. WIMGAPI requires that this be at
89 * least 1. wimlib allows 0. */
92 /* +0x30: Location and size of the WIM's lookup table. */
93 struct wim_reshdr_disk lookup_table_reshdr;
95 /* +0x48: Location and size of the WIM's XML data. */
96 struct wim_reshdr_disk xml_data_reshdr;
98 /* +0x60: Location and size of metadata resource for the bootable image
99 * of the WIM, or all zeroes if no image is bootable. */
100 struct wim_reshdr_disk boot_metadata_reshdr;
102 /* +0x78: 1-based index of the bootable image of the WIM, or 0 if no
103 * image is bootable. */
106 /* +0x7c: Location and size of the WIM's integrity table, or all zeroes
107 * if the WIM has no integrity table.
109 * Note the integrity_table_reshdr here is 4-byte aligned even though it
110 * would ordinarily be 8-byte aligned--- hence, the _packed_attribute on
111 * this structure is essential. */
112 struct wim_reshdr_disk integrity_table_reshdr;
114 /* +0x94: Unused bytes. */
120 #define MAX_IMAGES (((INT_MAX < INT32_MAX) ? INT_MAX : INT32_MAX) - 1)
122 /* In-memory representation of a WIM header. See `struct wim_header_disk' for
123 * field descriptions. */
129 u8 guid[WIM_GUID_LEN];
133 struct wim_reshdr lookup_table_reshdr;
134 struct wim_reshdr xml_data_reshdr;
135 struct wim_reshdr boot_metadata_reshdr;
137 struct wim_reshdr integrity_table_reshdr;
140 /* WIM header flags ('wim_flags' field of 'struct wim_header_disk'): */
143 #define WIM_HDR_FLAG_RESERVED 0x00000001
145 /* The WIM may contain compressed resources --- specifically, resources with
146 * WIM_RESHDR_FLAG_COMPRESSED set in their headers. Exactly one of the more
147 * specific WIM_HDR_FLAG_COMPRESSION_* flags must be set to specify the
148 * compression format used. */
149 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
151 /* The WIM is read-only, so modifications should not be allowed even if the WIM
152 * is writable at the filesystem level. */
153 #define WIM_HDR_FLAG_READONLY 0x00000004
155 /* The WIM is part of a split WIM. */
156 #define WIM_HDR_FLAG_SPANNED 0x00000008
158 /* All streams included in the WIM's lookup table are non-metadata (do not have
159 * WIM_RESHDR_FLAG_METADATA set). wimlib ignores this flag and clears it on new
160 * WIM files it writes. */
161 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
163 /* All streams included in the WIM's lookup table are metadata (have
164 * WIM_RESHDR_FLAG_METADATA set). wimlib ignores this flag and clears it on
165 * new WIM files it writes. */
166 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
168 /* The WIM is currently being written or appended to. */
169 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
171 /* Reparse point fixup flag. See docs for the --rpfix and --norpfix options to
172 * 'wimlib-imagex capture', or the WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} flags in
173 * wimlib.h. Note that WIM_HDR_FLAG_RP_FIX is a header flag and just sets the
174 * default behavior for the WIM; it can still be programatically overridden on a
175 * per-image basis. But there is no flag in the file format to set the default
176 * behavior for a specific image. */
177 #define WIM_HDR_FLAG_RP_FIX 0x00000080
179 /* Unused, reserved flag for another compression type. */
180 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
182 /* Resources in the WIM with WIM_RESHDR_FLAG_COMPRESSED set in their headers are
183 * compressed with XPRESS compression. */
184 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
186 /* Resources in the WIM with WIM_RESHDR_FLAG_COMPRESSED set in their headers are
187 * compressed with LZX compression. */
188 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
190 /* Resources in the WIM with WIM_RESHDR_FLAG_COMPRESSED set in their headers are
191 * compressed with LZMS compression. Note: this flag is only valid if the WIM
192 * version is WIM_VERSION_PACKED_STREAMS. Also, this flag is only supported in
193 * wimlib v1.6.0 and later and WIMGAPI Windows 8 and later. */
194 #define WIM_HDR_FLAG_COMPRESS_LZMS 0x00080000
196 /* XPRESS, with small chunk size??? */
197 #define WIM_HDR_FLAG_COMPRESS_XPRESS_2 0x00200000
199 #endif /* _WIMLIB_HEADER_H */