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