1 #ifndef _WIMLIB_HEADER_H
2 #define _WIMLIB_HEADER_H
4 #include "wimlib/resource.h"
5 #include "wimlib/types.h"
9 /* Length of the WIM header on disk. */
10 #define WIM_HEADER_DISK_SIZE 208
12 /* Compressed resources in the WIM are divided into separated compressed chunks
14 #define WIM_CHUNK_SIZE 32768
16 /* Version of the WIM file. There is an older version, but we don't support it
17 * yet. The differences between the versions are undocumented. */
18 #define WIM_VERSION 0x10d00
20 /* Header at the very beginning of the WIM file. This is the in-memory
21 * representation and does not include all fields; see `struct wim_header_disk'
22 * for the on-disk structure. */
24 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
27 /* A unique identifier for the WIM file. */
30 /* Part number of the WIM file in a spanned set. */
33 /* Total number of parts in a spanned set. */
36 /* Number of images in the WIM file. */
39 /* Location, size, and flags of the lookup table of the WIM. */
40 struct resource_entry lookup_table_res_entry;
42 /* Location, size, and flags for the XML data of the WIM. */
43 struct resource_entry xml_res_entry;
45 /* Location, size, and flags for the boot metadata. This means the
46 * metadata resource for the image specified by boot_idx below. Should
47 * be zeroed out if boot_idx is 0. */
48 struct resource_entry boot_metadata_res_entry;
50 /* The index of the bootable image in the WIM file. If 0, there are no
51 * bootable images available. */
54 /* The location of the optional integrity table used to verify the
55 * integrity WIM. Zeroed out if there is no integrity table.*/
56 struct resource_entry integrity;
59 /* Flags for the `flags' field of the struct wim_header: */
61 /* Reserved for future use */
62 #define WIM_HDR_FLAG_RESERVED 0x00000001
64 /* Files and metadata in the WIM are compressed. */
65 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
67 /* WIM is read-only, so modifications should not be allowed even if the WIM is
68 * writable at the filesystem level. */
69 #define WIM_HDR_FLAG_READONLY 0x00000004
71 /* Resource data specified by images in this WIM may be contained in a different
72 * WIM. Or in other words, this WIM is part of a split WIM. */
73 #define WIM_HDR_FLAG_SPANNED 0x00000008
75 /* The WIM contains resources only; no filesystem metadata. wimlib ignores this
76 * flag, as it looks for resources in all the WIMs anyway. */
77 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
79 /* The WIM contains metadata only. wimlib ignores this flag. Note that all the
80 * metadata resources for a split WIM should be in the first part. */
81 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
83 /* The WIM is currently being written or appended to. */
84 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
86 /* Reparse point fixup flag. See docs for --rpfix and --norpfix in imagex, or
87 * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that
88 * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
89 * the WIM; it can still be overridder on a per-image basis. But there is no
90 * flag to set the default behavior for a specific image. */
91 #define WIM_HDR_FLAG_RP_FIX 0x00000080
93 /* Unused, reserved flag for another compression type */
94 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
96 /* Resources within the WIM are compressed using "XPRESS" compression, which is
97 * a LZ77-based compression algorithm. */
98 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
100 /* Resources within the WIM are compressed using "LZX" compression. This is also
101 * a LZ77-based algorithm. */
102 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
104 #endif /* _WIMLIB_HEADER_H */