2fe76d4cad8c05eff420fb77c95a59a59f586e8b
[wimlib] / include / wimlib / header.h
1 #ifndef _WIMLIB_HEADER_H
2 #define _WIMLIB_HEADER_H
3
4 #include "wimlib/resource.h"
5 #include "wimlib/types.h"
6 #include "wimlib/endianness.h"
7
8 /* Length of "Globally Unique ID" field in WIM header.  */
9 #define WIM_GID_LEN    16
10
11 /* Length of the WIM header on disk.  */
12 #define WIM_HEADER_DISK_SIZE 208
13
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_DEFAULT 0x10d00
18
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 currently undocumented by Microsoft and is seemingly
23  * incompatible with their own ImageX and Dism programs; however, it seems to be
24  * used for Windows 8 updates.  The format appears to feature a new flag (0x10)
25  * in resource entries, which I've named WIM_RESHDR_FLAG_CONCAT.  */
26 #define WIM_VERSION_STREAM_CONCAT 0xe00
27
28 /* WIM magic characters, translated to a single 64-bit little endian number.  */
29 #define WIM_MAGIC \
30                 cpu_to_le64(((u64)'M' << 0) |           \
31                             ((u64)'S' << 8) |           \
32                             ((u64)'W' << 16) |          \
33                             ((u64)'I' << 24) |          \
34                             ((u64)'M' << 32) |          \
35                             ((u64)'\0' << 40) |         \
36                             ((u64)'\0' << 48) |         \
37                             ((u64)'\0' << 54))
38
39 /* wimlib pipable WIM magic characters, translated to a single 64-bit little
40  * endian number.  */
41 #define PWM_MAGIC \
42                 cpu_to_le64(((u64)'W' << 0) |           \
43                             ((u64)'L' << 8) |           \
44                             ((u64)'P' << 16) |          \
45                             ((u64)'W' << 24) |          \
46                             ((u64)'M' << 32) |          \
47                             ((u64)'\0' << 40) |         \
48                             ((u64)'\0' << 48) |         \
49                             ((u64)'\0' << 54))
50
51 /* On-disk format of the WIM header. */
52 struct wim_header_disk {
53
54         /* Magic characters "MSWIM\0\0\0" */
55         le64 magic;
56
57         /* Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE expected
58          * (currently the only supported value). */
59         u32 hdr_size;
60
61         /* Version of the WIM file
62          * TODO  */
63         u32 wim_version;
64
65         /* Flags for the WIM file (WIM_HDR_FLAG_*) */
66         u32 wim_flags;
67
68         /* Chunk size for compressed resources in the WIM, or 0 if the WIM is
69          * uncompressed.  */
70         u32 chunk_size;
71
72         /* Globally unique identifier for the WIM file.  Basically a bunch of
73          * random bytes. */
74         u8 guid[WIM_GID_LEN];
75
76         /* Number of this WIM part in the split WIM file, indexed from 1, or 1
77          * if the WIM is not split. */
78         u16 part_number;
79
80         /* Total number of parts of the split WIM file, or 1 if the WIM is not
81          * split. */
82         u16 total_parts;
83
84         /* Number of images in the WIM. */
85         u32 image_count;
86
87         /* Location and size of the WIM's lookup table. */
88         struct wim_reshdr_disk lookup_table_reshdr;
89
90         /* Location and size of the WIM's XML data. */
91         struct wim_reshdr_disk xml_data_reshdr;
92
93         /* Location and size of metadata resource for the bootable image of the
94          * WIM, or all zeroes if no image is bootable. */
95         struct wim_reshdr_disk boot_metadata_reshdr;
96
97         /* 1-based index of the bootable image of the WIM, or 0 if no image is
98          * bootable. */
99         u32 boot_idx;
100
101         /* Location and size of the WIM's integrity table, or all zeroes if the
102          * WIM has no integrity table.
103          *
104          * Note the integrity_table_reshdr here is 4-byte aligned even though
105          * it would ordinarily be 8-byte aligned--- hence, the _packed_attribute
106          * on the `struct wim_header_disk' is essential. */
107         struct wim_reshdr_disk integrity_table_reshdr;
108
109         /* Unused bytes. */
110         u8 unused[60];
111 } _packed_attribute;
112
113
114 /* Header at the very beginning of the WIM file.  This is the in-memory
115  * representation and does not include all fields; see `struct wim_header_disk'
116  * for the on-disk structure.  */
117 struct wim_header {
118
119         /* Magic characters: either WIM_MAGIC or PWM_MAGIC.  */
120         le64 magic;
121
122         /* Version of the WIM file  */
123         u32 wim_version;
124
125         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
126         u32 flags;
127
128         /* Compressed resource chunk size  */
129         u32 chunk_size;
130
131         /* A unique identifier for the WIM file. */
132         u8 guid[WIM_GID_LEN];
133
134         /* Part number of the WIM file in a spanned set. */
135         u16 part_number;
136
137         /* Total number of parts in a spanned set. */
138         u16 total_parts;
139
140         /* Number of images in the WIM file. */
141         u32 image_count;
142
143         /* Location, size, and flags of the lookup table of the WIM. */
144         struct wim_reshdr lookup_table_reshdr;
145
146         /* Location, size, and flags for the XML data of the WIM. */
147         struct wim_reshdr xml_data_reshdr;
148
149         /* Location, size, and flags for the boot metadata.  This means the
150          * metadata resource for the image specified by boot_idx below.  Should
151          * be zeroed out if boot_idx is 0. */
152         struct wim_reshdr boot_metadata_reshdr;
153
154         /* The index of the bootable image in the WIM file. If 0, there are no
155          * bootable images available. */
156         u32 boot_idx;
157
158         /* The location of the optional integrity table used to verify the
159          * integrity WIM.  Zeroed out if there is no integrity table.*/
160         struct wim_reshdr integrity_table_reshdr;
161 };
162
163 /* Flags for the `flags' field of the struct wim_header: */
164
165 /* Reserved for future use */
166 #define WIM_HDR_FLAG_RESERVED           0x00000001
167
168 /* Files and metadata in the WIM are compressed. */
169 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
170
171 /* WIM is read-only, so modifications should not be allowed even if the WIM is
172  * writable at the filesystem level. */
173 #define WIM_HDR_FLAG_READONLY           0x00000004
174
175 /* Resource data specified by images in this WIM may be contained in a different
176  * WIM.  Or in other words, this WIM is part of a split WIM.  */
177 #define WIM_HDR_FLAG_SPANNED            0x00000008
178
179 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
180  * flag, as it looks for resources in all the WIMs anyway. */
181 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
182
183 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
184  * metadata resources for a split WIM should be in the first part. */
185 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
186
187 /* The WIM is currently being written or appended to.  */
188 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
189
190 /* Reparse point fixup flag.  See docs for --rpfix and --norpfix in imagex, or
191  * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h.  Note that
192  * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
193  * the WIM; it can still be overridder on a per-image basis.  But there is no
194  * flag to set the default behavior for a specific image. */
195 #define WIM_HDR_FLAG_RP_FIX             0x00000080
196
197 /* Unused, reserved flag for another compression type */
198 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
199
200 /* Resources within the WIM are compressed using "XPRESS" compression, which is
201  * a LZ77-based compression algorithm.  */
202 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
203
204 /* Resources within the WIM are compressed using "LZX" compression.  This is also
205  * a LZ77-based algorithm. */
206 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
207
208 /* Starting in Windows 8, WIMGAPI can create WIMs using LZMS compression, and
209  * this flag is set on such WIMs.  However, an additional undocumented flag
210  * needs to be provided to WIMCreateFile() to create such WIMs, and the version
211  * number in the header of the resulting WIMs is different (3584).  None of this
212  * is actually documented, and wimlib does not yet support this compression
213  * format.  */
214 #define WIM_HDR_FLAG_COMPRESS_LZMS      0x00080000
215
216 #endif /* _WIMLIB_HEADER_H */