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, but wimlib doesn't
  20  * support it.  The differences between the versions are undocumented.  */
  21 #define WIM_VERSION 0x10d00
  22
  23 /* WIM magic characters, translated to a single 64-bit little endian number.  */
  24 #define WIM_MAGIC \
  25                 cpu_to_le64(((u64)'M' << 0) |           \
  26                             ((u64)'S' << 8) |           \
  27                             ((u64)'W' << 16) |          \
  28                             ((u64)'I' << 24) |          \
  29                             ((u64)'M' << 32) |          \
  30                             ((u64)'\0' << 40) |         \
  31                             ((u64)'\0' << 48) |         \
  32                             ((u64)'\0' << 54))
  33
  34 /* wimlib pipable WIM magic characters, translated to a single 64-bit little
  35  * endian number.  */
  36 #define PWM_MAGIC \
  37                 cpu_to_le64(((u64)'W' << 0) |           \
  38                             ((u64)'L' << 8) |           \
  39                             ((u64)'P' << 16) |          \
  40                             ((u64)'W' << 24) |          \
  41                             ((u64)'M' << 32) |          \
  42                             ((u64)'\0' << 40) |         \
  43                             ((u64)'\0' << 48) |         \
  44                             ((u64)'\0' << 54))
  45
  46 /* Header at the very beginning of the WIM file.  This is the in-memory
  47  * representation and does not include all fields; see `struct wim_header_disk'
  48  * for the on-disk structure.  */
  49 struct wim_header {
  50
  51         /* Magic characters: either WIM_MAGIC or PWM_MAGIC.  */
  52         le64 magic;
  53
  54         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
  55         u32 flags;
  56
  57         /* A unique identifier for the WIM file. */
  58         u8 guid[WIM_GID_LEN];
  59
  60         /* Part number of the WIM file in a spanned set. */
  61         u16 part_number;
  62
  63         /* Total number of parts in a spanned set. */
  64         u16 total_parts;
  65
  66         /* Number of images in the WIM file. */
  67         u32 image_count;
  68
  69         /* Location, size, and flags of the lookup table of the WIM. */
  70         struct resource_entry lookup_table_res_entry;
  71
  72         /* Location, size, and flags for the XML data of the WIM. */
  73         struct resource_entry xml_res_entry;
  74
  75         /* Location, size, and flags for the boot metadata.  This means the
  76          * metadata resource for the image specified by boot_idx below.  Should
  77          * be zeroed out if boot_idx is 0. */
  78         struct resource_entry boot_metadata_res_entry;
  79
  80         /* The index of the bootable image in the WIM file. If 0, there are no
  81          * bootable images available. */
  82         u32 boot_idx;
  83
  84         /* The location of the optional integrity table used to verify the
  85          * integrity WIM.  Zeroed out if there is no integrity table.*/
  86         struct resource_entry integrity;
  87 };
  88
  89 /* Flags for the `flags' field of the struct wim_header: */
  90
  91 /* Reserved for future use */
  92 #define WIM_HDR_FLAG_RESERVED           0x00000001
  93
  94 /* Files and metadata in the WIM are compressed. */
  95 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
  96
  97 /* WIM is read-only, so modifications should not be allowed even if the WIM is
  98  * writable at the filesystem level. */
  99 #define WIM_HDR_FLAG_READONLY           0x00000004
 100
 101 /* Resource data specified by images in this WIM may be contained in a different
 102  * WIM.  Or in other words, this WIM is part of a split WIM.  */
 103 #define WIM_HDR_FLAG_SPANNED            0x00000008
 104
 105 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
 106  * flag, as it looks for resources in all the WIMs anyway. */
 107 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 108
 109 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
 110  * metadata resources for a split WIM should be in the first part. */
 111 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 112
 113 /* The WIM is currently being written or appended to.  */
 114 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 115
 116 /* Reparse point fixup flag.  See docs for --rpfix and --norpfix in imagex, or
 117  * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h.  Note that
 118  * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
 119  * the WIM; it can still be overridder on a per-image basis.  But there is no
 120  * flag to set the default behavior for a specific image. */
 121 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 122
 123 /* Unused, reserved flag for another compression type */
 124 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 125
 126 /* Resources within the WIM are compressed using "XPRESS" compression, which is
 127  * a LZ77-based compression algorithm. */
 128 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
 129
 130 /* Resources within the WIM are compressed using "LZX" compression.  This is also
 131  * a LZ77-based algorithm. */
 132 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 133
 134 #endif /* _WIMLIB_HEADER_H */