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 /* Compressed resources in the WIM are divided into separated compressed chunks
  15  * of this size.  This value is unfortunately not configurable (at least when
  16  * compatibility with Microsoft's software is desired).  */
  17 #define WIM_CHUNK_SIZE 32768
  18
  19 /* Version of the WIM file.  There is an older version (used for prerelease
  20  * versions of Windows Vista), but wimlib doesn't support it.  The differences
  21  * between the versions are undocumented.  */
  22 #define WIM_VERSION 0x10d00
  23
  24 /* WIM magic characters, translated to a single 64-bit little endian number.  */
  25 #define WIM_MAGIC \
  26                 cpu_to_le64(((u64)'M' << 0) |           \
  27                             ((u64)'S' << 8) |           \
  28                             ((u64)'W' << 16) |          \
  29                             ((u64)'I' << 24) |          \
  30                             ((u64)'M' << 32) |          \
  31                             ((u64)'\0' << 40) |         \
  32                             ((u64)'\0' << 48) |         \
  33                             ((u64)'\0' << 54))
  34
  35 /* wimlib pipable WIM magic characters, translated to a single 64-bit little
  36  * endian number.  */
  37 #define PWM_MAGIC \
  38                 cpu_to_le64(((u64)'W' << 0) |           \
  39                             ((u64)'L' << 8) |           \
  40                             ((u64)'P' << 16) |          \
  41                             ((u64)'W' << 24) |          \
  42                             ((u64)'M' << 32) |          \
  43                             ((u64)'\0' << 40) |         \
  44                             ((u64)'\0' << 48) |         \
  45                             ((u64)'\0' << 54))
  46
  47 /* On-disk format of the WIM header. */
  48 struct wim_header_disk {
  49
  50         /* Magic characters "MSWIM\0\0\0" */
  51         le64 magic;
  52
  53         /* Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE expected
  54          * (currently the only supported value). */
  55         u32 hdr_size;
  56
  57         /* Version of the WIM file; WIM_VERSION expected (currently the only
  58          * supported value). */
  59         u32 wim_version;
  60
  61         /* Flags for the WIM file (WIM_HDR_FLAG_*) */
  62         u32 wim_flags;
  63
  64         /* Uncompressed chunk size of resources in the WIM.  0 if the WIM is
  65          * uncompressed.  If compressed, WIM_CHUNK_SIZE is expected (currently
  66          * the only supported value).  */
  67         u32 chunk_size;
  68
  69         /* Globally unique identifier for the WIM file.  Basically a bunch of
  70          * random bytes. */
  71         u8 guid[WIM_GID_LEN];
  72
  73         /* Number of this WIM part in the split WIM file, indexed from 1, or 1
  74          * if the WIM is not split. */
  75         u16 part_number;
  76
  77         /* Total number of parts of the split WIM file, or 1 if the WIM is not
  78          * split. */
  79         u16 total_parts;
  80
  81         /* Number of images in the WIM. */
  82         u32 image_count;
  83
  84         /* Location and size of the WIM's lookup table. */
  85         struct resource_entry_disk lookup_table_res_entry;
  86
  87         /* Location and size of the WIM's XML data. */
  88         struct resource_entry_disk xml_data_res_entry;
  89
  90         /* Location and size of metadata resource for the bootable image of the
  91          * WIM, or all zeroes if no image is bootable. */
  92         struct resource_entry_disk boot_metadata_res_entry;
  93
  94         /* 1-based index of the bootable image of the WIM, or 0 if no image is
  95          * bootable. */
  96         u32 boot_idx;
  97
  98         /* Location and size of the WIM's integrity table, or all zeroes if the
  99          * WIM has no integrity table.
 100          *
 101          * Note the integrity_table_res_entry here is 4-byte aligned even though
 102          * it would ordinarily be 8-byte aligned--- hence, the _packed_attribute
 103          * on the `struct wim_header_disk' is essential. */
 104         struct resource_entry_disk integrity_table_res_entry;
 105
 106         /* Unused bytes. */
 107         u8 unused[60];
 108 } _packed_attribute;
 109
 110
 111 /* Header at the very beginning of the WIM file.  This is the in-memory
 112  * representation and does not include all fields; see `struct wim_header_disk'
 113  * for the on-disk structure.  */
 114 struct wim_header {
 115
 116         /* Magic characters: either WIM_MAGIC or PWM_MAGIC.  */
 117         le64 magic;
 118
 119         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
 120         u32 flags;
 121
 122         /* A unique identifier for the WIM file. */
 123         u8 guid[WIM_GID_LEN];
 124
 125         /* Part number of the WIM file in a spanned set. */
 126         u16 part_number;
 127
 128         /* Total number of parts in a spanned set. */
 129         u16 total_parts;
 130
 131         /* Number of images in the WIM file. */
 132         u32 image_count;
 133
 134         /* Location, size, and flags of the lookup table of the WIM. */
 135         struct resource_entry lookup_table_res_entry;
 136
 137         /* Location, size, and flags for the XML data of the WIM. */
 138         struct resource_entry xml_res_entry;
 139
 140         /* Location, size, and flags for the boot metadata.  This means the
 141          * metadata resource for the image specified by boot_idx below.  Should
 142          * be zeroed out if boot_idx is 0. */
 143         struct resource_entry boot_metadata_res_entry;
 144
 145         /* The index of the bootable image in the WIM file. If 0, there are no
 146          * bootable images available. */
 147         u32 boot_idx;
 148
 149         /* The location of the optional integrity table used to verify the
 150          * integrity WIM.  Zeroed out if there is no integrity table.*/
 151         struct resource_entry integrity;
 152 };
 153
 154 /* Flags for the `flags' field of the struct wim_header: */
 155
 156 /* Reserved for future use */
 157 #define WIM_HDR_FLAG_RESERVED           0x00000001
 158
 159 /* Files and metadata in the WIM are compressed. */
 160 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 161
 162 /* WIM is read-only, so modifications should not be allowed even if the WIM is
 163  * writable at the filesystem level. */
 164 #define WIM_HDR_FLAG_READONLY           0x00000004
 165
 166 /* Resource data specified by images in this WIM may be contained in a different
 167  * WIM.  Or in other words, this WIM is part of a split WIM.  */
 168 #define WIM_HDR_FLAG_SPANNED            0x00000008
 169
 170 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
 171  * flag, as it looks for resources in all the WIMs anyway. */
 172 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 173
 174 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
 175  * metadata resources for a split WIM should be in the first part. */
 176 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 177
 178 /* The WIM is currently being written or appended to.  */
 179 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 180
 181 /* Reparse point fixup flag.  See docs for --rpfix and --norpfix in imagex, or
 182  * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h.  Note that
 183  * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
 184  * the WIM; it can still be overridder on a per-image basis.  But there is no
 185  * flag to set the default behavior for a specific image. */
 186 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 187
 188 /* Unused, reserved flag for another compression type */
 189 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 190
 191 /* Resources within the WIM are compressed using "XPRESS" compression, which is
 192  * a LZ77-based compression algorithm. */
 193 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
 194
 195 /* Resources within the WIM are compressed using "LZX" compression.  This is also
 196  * a LZ77-based algorithm. */
 197 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 198
 199 #endif /* _WIMLIB_HEADER_H */