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"
8 /* Length of "Globally Unique ID" field in WIM header. */
11 /* Length of the WIM header on disk. */
12 #define WIM_HEADER_DISK_SIZE 208
14 /* Default WIM version number. Streams are always compressed independently. */
15 #define WIM_VERSION_DEFAULT 0x10d00
17 /* Version number used for WIMs that allow multiple streams packed into one
18 * resource (WIM_RESHDR_FLAG_PACKED_STREAMS). New as of Windows 8 WIMGAPI; used
19 * for the Windows 8 web downloader, but yet properly documented by Microsoft.
21 #define WIM_VERSION_PACKED_STREAMS 0xe00
23 /* Note: there is another WIM version from Vista pre-releases, but it is not
24 * supported by wimlib. */
26 /* WIM magic characters, translated to a single 64-bit little endian number. */
28 cpu_to_le64(((u64)'M' << 0) | \
37 /* wimlib pipable WIM magic characters, translated to a single 64-bit little
40 cpu_to_le64(((u64)'W' << 0) | \
49 /* On-disk format of the WIM header. */
50 struct wim_header_disk {
52 /* Magic characters "MSWIM\0\0\0" */
55 /* Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE expected
56 * (currently the only supported value). */
59 /* Version of the WIM file
63 /* Flags for the WIM file (WIM_HDR_FLAG_*) */
66 /* Chunk size for compressed resources in the WIM, or 0 if the WIM is
70 /* Globally unique identifier for the WIM file. Basically a bunch of
74 /* Number of this WIM part in the split WIM file, indexed from 1, or 1
75 * if the WIM is not split. */
78 /* Total number of parts of the split WIM file, or 1 if the WIM is not
82 /* Number of images in the WIM. */
85 /* Location and size of the WIM's lookup table. */
86 struct wim_reshdr_disk lookup_table_reshdr;
88 /* Location and size of the WIM's XML data. */
89 struct wim_reshdr_disk xml_data_reshdr;
91 /* Location and size of metadata resource for the bootable image of the
92 * WIM, or all zeroes if no image is bootable. */
93 struct wim_reshdr_disk boot_metadata_reshdr;
95 /* 1-based index of the bootable image of the WIM, or 0 if no image is
99 /* Location and size of the WIM's integrity table, or all zeroes if the
100 * WIM has no integrity table.
102 * Note the integrity_table_reshdr here is 4-byte aligned even though
103 * it would ordinarily be 8-byte aligned--- hence, the _packed_attribute
104 * on the `struct wim_header_disk' is essential. */
105 struct wim_reshdr_disk integrity_table_reshdr;
112 /* Header at the very beginning of the WIM file. This is the in-memory
113 * representation and does not include all fields; see `struct wim_header_disk'
114 * for the on-disk structure. */
117 /* Magic characters: either WIM_MAGIC or PWM_MAGIC. */
120 /* Version of the WIM file */
123 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
126 /* Compressed resource chunk size */
129 /* A unique identifier for the WIM file. */
130 u8 guid[WIM_GID_LEN];
132 /* Part number of the WIM file in a spanned set. */
135 /* Total number of parts in a spanned set. */
138 /* Number of images in the WIM file. */
141 /* Location, size, and flags of the lookup table of the WIM. */
142 struct wim_reshdr lookup_table_reshdr;
144 /* Location, size, and flags for the XML data of the WIM. */
145 struct wim_reshdr xml_data_reshdr;
147 /* Location, size, and flags for the boot metadata. This means the
148 * metadata resource for the image specified by boot_idx below. Should
149 * be zeroed out if boot_idx is 0. */
150 struct wim_reshdr boot_metadata_reshdr;
152 /* The index of the bootable image in the WIM file. If 0, there are no
153 * bootable images available. */
156 /* The location of the optional integrity table used to verify the
157 * integrity WIM. Zeroed out if there is no integrity table.*/
158 struct wim_reshdr integrity_table_reshdr;
161 /* Flags for the `flags' field of the struct wim_header: */
163 /* Reserved for future use */
164 #define WIM_HDR_FLAG_RESERVED 0x00000001
166 /* Files and metadata in the WIM are compressed. */
167 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
169 /* WIM is read-only, so modifications should not be allowed even if the WIM is
170 * writable at the filesystem level. */
171 #define WIM_HDR_FLAG_READONLY 0x00000004
173 /* Resource data specified by images in this WIM may be contained in a different
174 * WIM. Or in other words, this WIM is part of a split WIM. */
175 #define WIM_HDR_FLAG_SPANNED 0x00000008
177 /* The WIM contains resources only; no filesystem metadata. wimlib ignores this
178 * flag, as it looks for resources in all the WIMs anyway. */
179 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
181 /* The WIM contains metadata only. wimlib ignores this flag. Note that all the
182 * metadata resources for a split WIM should be in the first part. */
183 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
185 /* The WIM is currently being written or appended to. */
186 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
188 /* Reparse point fixup flag. See docs for --rpfix and --norpfix in imagex, or
189 * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that
190 * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
191 * the WIM; it can still be overridder on a per-image basis. But there is no
192 * flag to set the default behavior for a specific image. */
193 #define WIM_HDR_FLAG_RP_FIX 0x00000080
195 /* Unused, reserved flag for another compression type */
196 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
198 /* Resources within the WIM are compressed using "XPRESS" compression, which is
199 * a LZ77-based compression algorithm. */
200 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
202 /* Resources within the WIM are compressed using "LZX" compression. This is also
203 * a LZ77-based algorithm. */
204 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
206 /* Starting in Windows 8, WIMGAPI can create WIMs using LZMS compression, and
207 * this flag is set on such WIMs. However, an additional undocumented flag
208 * needs to be provided to WIMCreateFile() to create such WIMs, and the version
209 * number in the header of the resulting WIMs is different (3584). None of this
210 * is actually documented, and wimlib does not yet support this compression
212 #define WIM_HDR_FLAG_COMPRESS_LZMS 0x00080000
214 #endif /* _WIMLIB_HEADER_H */