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