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 /* Version of the WIM file. There is an older version (used for prerelease
15 * versions of Windows Vista), but wimlib doesn't support it. The differences
16 * between the versions are undocumented. */
17 #define WIM_VERSION 0x10d00
19 /* Version number used for a different WIM format, which as of Windows 8 can be
20 * created by passing 0x20000000 in dwFlagsAndAttributes to WIMGAPI's
21 * WIMCreateFile() and specifying either NONE, XPRESS, or LZMS compression.
22 * This format is, however, currently undocumented by Microsoft and is seemingly
23 * incompatible with their own ImageX and Dism programs. wimlib does not yet
24 * support this format. */
25 #define WIM_MYSTERY_VERSION 0xe00
27 /* WIM magic characters, translated to a single 64-bit little endian number. */
29 cpu_to_le64(((u64)'M' << 0) | \
38 /* wimlib pipable WIM magic characters, translated to a single 64-bit little
41 cpu_to_le64(((u64)'W' << 0) | \
50 /* On-disk format of the WIM header. */
51 struct wim_header_disk {
53 /* Magic characters "MSWIM\0\0\0" */
56 /* Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE expected
57 * (currently the only supported value). */
60 /* Version of the WIM file; WIM_VERSION expected (currently the only
61 * supported value). */
64 /* Flags for the WIM file (WIM_HDR_FLAG_*) */
67 /* Chunk size for compressed resources in the WIM, or 0 if the WIM is
71 /* Globally unique identifier for the WIM file. Basically a bunch of
75 /* Number of this WIM part in the split WIM file, indexed from 1, or 1
76 * if the WIM is not split. */
79 /* Total number of parts of the split WIM file, or 1 if the WIM is not
83 /* Number of images in the WIM. */
86 /* Location and size of the WIM's lookup table. */
87 struct resource_entry_disk lookup_table_res_entry;
89 /* Location and size of the WIM's XML data. */
90 struct resource_entry_disk xml_data_res_entry;
92 /* Location and size of metadata resource for the bootable image of the
93 * WIM, or all zeroes if no image is bootable. */
94 struct resource_entry_disk boot_metadata_res_entry;
96 /* 1-based index of the bootable image of the WIM, or 0 if no image is
100 /* Location and size of the WIM's integrity table, or all zeroes if the
101 * WIM has no integrity table.
103 * Note the integrity_table_res_entry here is 4-byte aligned even though
104 * it would ordinarily be 8-byte aligned--- hence, the _packed_attribute
105 * on the `struct wim_header_disk' is essential. */
106 struct resource_entry_disk integrity_table_res_entry;
113 /* Header at the very beginning of the WIM file. This is the in-memory
114 * representation and does not include all fields; see `struct wim_header_disk'
115 * for the on-disk structure. */
118 /* Magic characters: either WIM_MAGIC or PWM_MAGIC. */
121 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
124 /* Compressed resource chunk size */
127 /* A unique identifier for the WIM file. */
128 u8 guid[WIM_GID_LEN];
130 /* Part number of the WIM file in a spanned set. */
133 /* Total number of parts in a spanned set. */
136 /* Number of images in the WIM file. */
139 /* Location, size, and flags of the lookup table of the WIM. */
140 struct resource_entry lookup_table_res_entry;
142 /* Location, size, and flags for the XML data of the WIM. */
143 struct resource_entry xml_res_entry;
145 /* Location, size, and flags for the boot metadata. This means the
146 * metadata resource for the image specified by boot_idx below. Should
147 * be zeroed out if boot_idx is 0. */
148 struct resource_entry boot_metadata_res_entry;
150 /* The index of the bootable image in the WIM file. If 0, there are no
151 * bootable images available. */
154 /* The location of the optional integrity table used to verify the
155 * integrity WIM. Zeroed out if there is no integrity table.*/
156 struct resource_entry integrity;
159 /* Flags for the `flags' field of the struct wim_header: */
161 /* Reserved for future use */
162 #define WIM_HDR_FLAG_RESERVED 0x00000001
164 /* Files and metadata in the WIM are compressed. */
165 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
167 /* WIM is read-only, so modifications should not be allowed even if the WIM is
168 * writable at the filesystem level. */
169 #define WIM_HDR_FLAG_READONLY 0x00000004
171 /* Resource data specified by images in this WIM may be contained in a different
172 * WIM. Or in other words, this WIM is part of a split WIM. */
173 #define WIM_HDR_FLAG_SPANNED 0x00000008
175 /* The WIM contains resources only; no filesystem metadata. wimlib ignores this
176 * flag, as it looks for resources in all the WIMs anyway. */
177 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
179 /* The WIM contains metadata only. wimlib ignores this flag. Note that all the
180 * metadata resources for a split WIM should be in the first part. */
181 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
183 /* The WIM is currently being written or appended to. */
184 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
186 /* Reparse point fixup flag. See docs for --rpfix and --norpfix in imagex, or
187 * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that
188 * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
189 * the WIM; it can still be overridder on a per-image basis. But there is no
190 * flag to set the default behavior for a specific image. */
191 #define WIM_HDR_FLAG_RP_FIX 0x00000080
193 /* Unused, reserved flag for another compression type */
194 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
196 /* Resources within the WIM are compressed using "XPRESS" compression, which is
197 * a LZ77-based compression algorithm. */
198 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
200 /* Resources within the WIM are compressed using "LZX" compression. This is also
201 * a LZ77-based algorithm. */
202 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
204 /* Starting in Windows 8, WIMGAPI can create WIMs using LZMS compression, and
205 * this flag is set on such WIMs. However, an additional undocumented flag
206 * needs to be provided to WIMCreateFile() to create such WIMs, and the version
207 * number in the header of the resulting WIMs is different (3584). None of this
208 * is actually documented, and wimlib does not yet support this compression
210 #define WIM_HDR_FLAG_COMPRESS_LZMS 0x00080000
212 #endif /* _WIMLIB_HEADER_H */