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