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