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 /* Compressed resources in the WIM are divided into separated compressed chunks
15 * of this size. This value is unfortunately not configurable (at least when
16 * compatibility with Microsoft's software is desired). */
17 #define WIM_CHUNK_SIZE 32768
19 /* Version of the WIM file. There is an older version (used for prerelease
20 * versions of Windows Vista), but wimlib doesn't support it. The differences
21 * between the versions are undocumented. */
22 #define WIM_VERSION 0x10d00
24 /* WIM magic characters, translated to a single 64-bit little endian number. */
26 cpu_to_le64(((u64)'M' << 0) | \
35 /* wimlib pipable WIM magic characters, translated to a single 64-bit little
38 cpu_to_le64(((u64)'W' << 0) | \
47 /* Header at the very beginning of the WIM file. This is the in-memory
48 * representation and does not include all fields; see `struct wim_header_disk'
49 * for the on-disk structure. */
52 /* Magic characters: either WIM_MAGIC or PWM_MAGIC. */
55 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
58 /* A unique identifier for the WIM file. */
61 /* Part number of the WIM file in a spanned set. */
64 /* Total number of parts in a spanned set. */
67 /* Number of images in the WIM file. */
70 /* Location, size, and flags of the lookup table of the WIM. */
71 struct resource_entry lookup_table_res_entry;
73 /* Location, size, and flags for the XML data of the WIM. */
74 struct resource_entry xml_res_entry;
76 /* Location, size, and flags for the boot metadata. This means the
77 * metadata resource for the image specified by boot_idx below. Should
78 * be zeroed out if boot_idx is 0. */
79 struct resource_entry boot_metadata_res_entry;
81 /* The index of the bootable image in the WIM file. If 0, there are no
82 * bootable images available. */
85 /* The location of the optional integrity table used to verify the
86 * integrity WIM. Zeroed out if there is no integrity table.*/
87 struct resource_entry integrity;
90 /* Flags for the `flags' field of the struct wim_header: */
92 /* Reserved for future use */
93 #define WIM_HDR_FLAG_RESERVED 0x00000001
95 /* Files and metadata in the WIM are compressed. */
96 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
98 /* WIM is read-only, so modifications should not be allowed even if the WIM is
99 * writable at the filesystem level. */
100 #define WIM_HDR_FLAG_READONLY 0x00000004
102 /* Resource data specified by images in this WIM may be contained in a different
103 * WIM. Or in other words, this WIM is part of a split WIM. */
104 #define WIM_HDR_FLAG_SPANNED 0x00000008
106 /* The WIM contains resources only; no filesystem metadata. wimlib ignores this
107 * flag, as it looks for resources in all the WIMs anyway. */
108 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
110 /* The WIM contains metadata only. wimlib ignores this flag. Note that all the
111 * metadata resources for a split WIM should be in the first part. */
112 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
114 /* The WIM is currently being written or appended to. */
115 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
117 /* Reparse point fixup flag. See docs for --rpfix and --norpfix in imagex, or
118 * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that
119 * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
120 * the WIM; it can still be overridder on a per-image basis. But there is no
121 * flag to set the default behavior for a specific image. */
122 #define WIM_HDR_FLAG_RP_FIX 0x00000080
124 /* Unused, reserved flag for another compression type */
125 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
127 /* Resources within the WIM are compressed using "XPRESS" compression, which is
128 * a LZ77-based compression algorithm. */
129 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
131 /* Resources within the WIM are compressed using "LZX" compression. This is also
132 * a LZ77-based algorithm. */
133 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
135 #endif /* _WIMLIB_HEADER_H */