66e46bd0d74bfd97e613945cb33a6159dbd604e3
[wimlib] / include / wimlib / header.h
1 #ifndef _WIMLIB_HEADER_H
2 #define _WIMLIB_HEADER_H
3
4 #include <limits.h>
5
6 #include "wimlib/resource.h"
7 #include "wimlib/types.h"
8
9 /* Length of "Globally Unique ID" field in WIM header.  */
10 #define WIM_GUID_LEN    16
11
12 /* Length of the WIM header on disk.  wimlib currently requires that the header
13  * be exactly this size.  */
14 #define WIM_HEADER_DISK_SIZE 208
15
16 /* Default WIM version number.  Blobs are always compressed independently.  */
17 #define WIM_VERSION_DEFAULT 0x10d00
18
19 /* Version number used for WIMs that allow multiple blobs combined into one
20  * resource ("solid resources", marked by WIM_RESHDR_FLAG_SOLID) and also a new
21  * compression format (LZMS).  This version is new as of Windows 8 WIMGAPI.
22  * Although it is used by Windows 8 web downloader, it is not yet documented by
23  * Microsoft.  */
24 #define WIM_VERSION_SOLID 0xe00
25
26 /* Note: there is another WIM version from Vista pre-releases, but it is not
27  * supported by wimlib.  */
28
29 /* WIM magic characters, translated to a single 64-bit number.  */
30 #define WIM_MAGIC                               \
31                 (((u64)'M'  <<  0) |            \
32                  ((u64)'S'  <<  8) |            \
33                  ((u64)'W'  << 16) |            \
34                  ((u64)'I'  << 24) |            \
35                  ((u64)'M'  << 32) |            \
36                  ((u64)'\0' << 40) |            \
37                  ((u64)'\0' << 48) |            \
38                  ((u64)'\0' << 54))
39
40 /* wimlib pipable WIM magic characters, translated to a single 64-bit number.
41  * */
42 #define PWM_MAGIC                               \
43                 (((u64)'W'  <<  0) |            \
44                  ((u64)'L'  <<  8) |            \
45                  ((u64)'P'  << 16) |            \
46                  ((u64)'W'  << 24) |            \
47                  ((u64)'M'  << 32) |            \
48                  ((u64)'\0' << 40) |            \
49                  ((u64)'\0' << 48) |            \
50                  ((u64)'\0' << 54))
51
52 /* On-disk format of the WIM header.  */
53 struct wim_header_disk {
54
55         /* +0x00: Magic characters WIM_MAGIC or PWM_MAGIC.  */
56         le64 magic;
57
58         /* +0x08: Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE
59          * expected (currently the only supported value).  */
60         u32 hdr_size;
61
62         /* +0x0c: Version of the WIM file.  Recognized values are the
63          * WIM_VERSION_* constants from above.  */
64         u32 wim_version;
65
66         /* +0x10: Flags for the WIM file (WIM_HDR_FLAG_*).  */
67         u32 wim_flags;
68
69         /* +0x14: Uncompressed chunk size for non-solid compressed resources in
70          * the WIM or 0 if the WIM is uncompressed.  */
71         u32 chunk_size;
72
73         /* +0x18: Globally unique identifier for the WIM file.  Basically a
74          * bunch of random bytes.  */
75         u8 guid[WIM_GUID_LEN];
76
77         /* +0x28: Number of this WIM part in the split WIM file, indexed from 1,
78          * or 1 if the WIM is not split.  */
79         u16 part_number;
80
81         /* +0x2a: Total number of parts of the split WIM file, or 1 if the WIM
82          * is not split.  */
83         u16 total_parts;
84
85         /* +0x2c: Number of images in the WIM.  WIMGAPI requires that this be at
86          * least 1.  wimlib allows 0.  */
87         u32 image_count;
88
89         /* +0x30: Location and size of the WIM's blob table.  */
90         struct wim_reshdr_disk blob_table_reshdr;
91
92         /* +0x48: Location and size of the WIM's XML data.  */
93         struct wim_reshdr_disk xml_data_reshdr;
94
95         /* +0x60: Location and size of metadata resource for the bootable image
96          * of the WIM, or all zeroes if no image is bootable.  */
97         struct wim_reshdr_disk boot_metadata_reshdr;
98
99         /* +0x78: 1-based index of the bootable image of the WIM, or 0 if no
100          * image is bootable.  */
101         u32 boot_idx;
102
103         /* +0x7c: Location and size of the WIM's integrity table, or all zeroes
104          * if the WIM has no integrity table.
105          *
106          * Note the integrity_table_reshdr here is 4-byte aligned even though it
107          * would ordinarily be 8-byte aligned--- hence, the _packed_attribute on
108          * this structure is essential.  */
109         struct wim_reshdr_disk integrity_table_reshdr;
110
111         /* +0x94: Unused bytes.  */
112         u8 unused[60];
113
114         /* +0xd0 (208)  */
115 } _packed_attribute;
116
117 #define MAX_IMAGES (((INT_MAX < INT32_MAX) ? INT_MAX : INT32_MAX) - 1)
118
119 /* In-memory representation of a WIM header.  See `struct wim_header_disk' for
120  * field descriptions.  */
121 struct wim_header {
122         u64 magic;
123         u32 wim_version;
124         u32 flags;
125         u32 chunk_size;
126         u8 guid[WIM_GUID_LEN];
127         u16 part_number;
128         u16 total_parts;
129         u32 image_count;
130         struct wim_reshdr blob_table_reshdr;
131         struct wim_reshdr xml_data_reshdr;
132         struct wim_reshdr boot_metadata_reshdr;
133         u32 boot_idx;
134         struct wim_reshdr integrity_table_reshdr;
135 };
136
137 /* WIM header flags ('wim_flags' field of 'struct wim_header_disk'):  */
138
139 /* Reserved flag.  */
140 #define WIM_HDR_FLAG_RESERVED           0x00000001
141
142 /* The WIM may contain compressed resources --- specifically, resources with
143  * WIM_RESHDR_FLAG_COMPRESSED set in their headers.  Exactly one of the more
144  * specific WIM_HDR_FLAG_COMPRESSION_* flags must be set to specify the
145  * compression format used.  */
146 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
147
148 /* The WIM is read-only, so modifications should not be allowed even if the WIM
149  * is writable at the filesystem level.  */
150 #define WIM_HDR_FLAG_READONLY           0x00000004
151
152 /* The WIM is part of a split WIM.  */
153 #define WIM_HDR_FLAG_SPANNED            0x00000008
154
155 /* All blobs included in the WIM's blob table are non-metadata (do not have
156  * WIM_RESHDR_FLAG_METADATA set).  wimlib ignores this flag and clears it on new
157  * WIM files it writes.  */
158 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
159
160 /* All blobs included in the WIM's blob table are metadata (have
161  * WIM_RESHDR_FLAG_METADATA set).  wimlib ignores this flag and clears it on new
162  * WIM files it writes.  */
163 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
164
165 /* The WIM is currently being written or appended to.  */
166 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
167
168 /* Reparse point fixup flag.  See docs for the --rpfix and --norpfix options to
169  * 'wimlib-imagex capture', or the WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} flags in
170  * wimlib.h.  Note that WIM_HDR_FLAG_RP_FIX is a header flag and just sets the
171  * default behavior for the WIM; it can still be programatically overridden on a
172  * per-image basis.  But there is no flag in the file format to set the default
173  * behavior for a specific image.  */
174 #define WIM_HDR_FLAG_RP_FIX             0x00000080
175
176 /* Unused, reserved flag for another compression type.  */
177 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
178
179 /* Resources in the WIM with WIM_RESHDR_FLAG_COMPRESSED set in their headers are
180  * compressed with XPRESS compression.  */
181 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
182
183 /* Resources in the WIM with WIM_RESHDR_FLAG_COMPRESSED set in their headers are
184  * compressed with LZX compression.  */
185 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
186
187 /* Resources in the WIM with WIM_RESHDR_FLAG_COMPRESSED set in their headers are
188  * compressed with LZMS compression.  Note: this flag is only valid if the WIM
189  * version is WIM_VERSION_SOLID.  Also, this flag is only supported in wimlib
190  * v1.6.0 and later and WIMGAPI Windows 8 and later.  */
191 #define WIM_HDR_FLAG_COMPRESS_LZMS      0x00080000
192
193 /* XPRESS, with small chunk size???  */
194 #define WIM_HDR_FLAG_COMPRESS_XPRESS_2  0x00200000
195
196 #endif /* _WIMLIB_HEADER_H */