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/guid.h"
   7 #include "wimlib/resource.h"
   8 #include "wimlib/types.h"
   9
  10 /* Length of the WIM header on disk.  wimlib currently requires that the header
  11  * be exactly this size.  */
  12 #define WIM_HEADER_DISK_SIZE 208
  13
  14 /* Default WIM version number.  Blobs are always compressed independently.  */
  15 #define WIM_VERSION_DEFAULT 0x10d00
  16
  17 /* Version number used for WIMs that allow multiple blobs combined into one
  18  * resource ("solid resources", marked by WIM_RESHDR_FLAG_SOLID) and also a new
  19  * compression format (LZMS).  This version is new as of Windows 8 WIMGAPI.
  20  * Although it is used by Windows 8 web downloader, it is not yet documented by
  21  * Microsoft.  */
  22 #define WIM_VERSION_SOLID 0xe00
  23
  24 /* Note: there is another WIM version from Vista pre-releases, but it is not
  25  * supported by wimlib.  */
  26
  27 /* WIM magic characters, translated to a single 64-bit number.  */
  28 #define WIM_MAGIC                               \
  29                 (((u64)'M'  <<  0) |            \
  30                  ((u64)'S'  <<  8) |            \
  31                  ((u64)'W'  << 16) |            \
  32                  ((u64)'I'  << 24) |            \
  33                  ((u64)'M'  << 32) |            \
  34                  ((u64)'\0' << 40) |            \
  35                  ((u64)'\0' << 48) |            \
  36                  ((u64)'\0' << 54))
  37
  38 /* wimlib pipable WIM magic characters, translated to a single 64-bit number.
  39  * */
  40 #define PWM_MAGIC                               \
  41                 (((u64)'W'  <<  0) |            \
  42                  ((u64)'L'  <<  8) |            \
  43                  ((u64)'P'  << 16) |            \
  44                  ((u64)'W'  << 24) |            \
  45                  ((u64)'M'  << 32) |            \
  46                  ((u64)'\0' << 40) |            \
  47                  ((u64)'\0' << 48) |            \
  48                  ((u64)'\0' << 54))
  49
  50 /* On-disk format of the WIM header.  */
  51 struct wim_header_disk {
  52
  53         /* +0x00: Magic characters WIM_MAGIC or PWM_MAGIC.  */
  54         le64 magic;
  55
  56         /* +0x08: Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE
  57          * expected (currently the only supported value).  */
  58         le32 hdr_size;
  59
  60         /* +0x0c: Version of the WIM file.  Recognized values are the
  61          * WIM_VERSION_* constants from above.  */
  62         le32 wim_version;
  63
  64         /* +0x10: Flags for the WIM file (WIM_HDR_FLAG_*).  */
  65         le32 wim_flags;
  66
  67         /* +0x14: Uncompressed chunk size for non-solid compressed resources in
  68          * the WIM or 0 if the WIM is uncompressed.  */
  69         le32 chunk_size;
  70
  71         /* +0x18: Globally unique identifier for the WIM file.  Basically a
  72          * bunch of random bytes.  */
  73         u8 guid[GUID_SIZE];
  74
  75         /* +0x28: Number of this WIM part in the split WIM file, indexed from 1,
  76          * or 1 if the WIM is not split.  */
  77         le16 part_number;
  78
  79         /* +0x2a: Total number of parts of the split WIM file, or 1 if the WIM
  80          * is not split.  */
  81         le16 total_parts;
  82
  83         /* +0x2c: Number of images in the WIM.  WIMGAPI requires that this be at
  84          * least 1.  wimlib allows 0.  */
  85         le32 image_count;
  86
  87         /* +0x30: Location and size of the WIM's blob table.  */
  88         struct wim_reshdr_disk blob_table_reshdr;
  89
  90         /* +0x48: Location and size of the WIM's XML data.  */
  91         struct wim_reshdr_disk xml_data_reshdr;
  92
  93         /* +0x60: Location and size of metadata resource for the bootable image
  94          * of the WIM, or all zeroes if no image is bootable.  */
  95         struct wim_reshdr_disk boot_metadata_reshdr;
  96
  97         /* +0x78: 1-based index of the bootable image of the WIM, or 0 if no
  98          * image is bootable.  */
  99         le32 boot_idx;
 100
 101         /* +0x7c: Location and size of the WIM's integrity table, or all zeroes
 102          * if the WIM has no integrity table.
 103          *
 104          * Note the integrity_table_reshdr here is 4-byte aligned even though it
 105          * would ordinarily be 8-byte aligned--- hence, the
 106          * __attribute__((packed)) on this structure is essential.  */
 107         struct wim_reshdr_disk integrity_table_reshdr;
 108
 109         /* +0x94: Unused bytes.  */
 110         u8 unused[60];
 111
 112         /* +0xd0 (208)  */
 113 } __attribute__((packed));
 114
 115 /*
 116  * Arbitrarily limit the maximum number of images to 65535, to prevent huge
 117  * memory allocations when processing fuzzed files.  This can be increased if
 118  * ever needed (up to INT_MAX - 1).
 119  */
 120 #define MAX_IMAGES      65535
 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[GUID_SIZE];
 130         u16 part_number;
 131         u16 total_parts;
 132         u32 image_count;
 133         struct wim_reshdr blob_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 blobs included in the WIM's blob 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 blobs included in the WIM's blob table are metadata (have
 164  * WIM_RESHDR_FLAG_METADATA set).  wimlib ignores this flag and clears it on new
 165  * 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_SOLID.  Also, this flag is only supported in wimlib
 193  * 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 */