X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=include%2Fwimlib%2Fheader.h;h=2841b827ca1bfb9eb2620750a8f99ca9ea594afa;hb=dc688119fee4dcd1cf146ceb0da285c7983a27bb;hp=cd68486b0d9f118f90b8c82c04443d6ddad2db03;hpb=7da3252cecc5f8fd25672d3f5ffd3d16d4d7b675;p=wimlib diff --git a/include/wimlib/header.h b/include/wimlib/header.h index cd68486b..2841b827 100644 --- a/include/wimlib/header.h +++ b/include/wimlib/header.h @@ -11,152 +11,122 @@ /* Length of the WIM header on disk. */ #define WIM_HEADER_DISK_SIZE 208 -/* Compressed resources in the WIM are divided into separated compressed chunks - * of this size. This value is unfortunately not configurable (at least when - * compatibility with Microsoft's software is desired). */ -#define WIM_CHUNK_SIZE 32768 - -/* Version of the WIM file. There is an older version (used for prerelease - * versions of Windows Vista), but wimlib doesn't support it. The differences - * between the versions are undocumented. */ -#define WIM_VERSION 0x10d00 - -/* Version number used for a different WIM format, which as of Windows 8 can be - * created by passing 0x20000000 in dwFlagsAndAttributes to WIMGAPI's - * WIMCreateFile() and specifying either NONE, XPRESS, or LZMS compression. - * This format is, however, currently undocumented by Microsoft and is seemingly - * incompatible with their own ImageX and Dism programs. wimlib does not yet - * support this format. */ -#define WIM_MYSTERY_VERSION 0xe00 - -/* WIM magic characters, translated to a single 64-bit little endian number. */ -#define WIM_MAGIC \ - cpu_to_le64(((u64)'M' << 0) | \ - ((u64)'S' << 8) | \ - ((u64)'W' << 16) | \ - ((u64)'I' << 24) | \ - ((u64)'M' << 32) | \ - ((u64)'\0' << 40) | \ - ((u64)'\0' << 48) | \ - ((u64)'\0' << 54)) - -/* wimlib pipable WIM magic characters, translated to a single 64-bit little - * endian number. */ -#define PWM_MAGIC \ - cpu_to_le64(((u64)'W' << 0) | \ - ((u64)'L' << 8) | \ - ((u64)'P' << 16) | \ - ((u64)'W' << 24) | \ - ((u64)'M' << 32) | \ - ((u64)'\0' << 40) | \ - ((u64)'\0' << 48) | \ - ((u64)'\0' << 54)) +/* Default WIM version number. Streams are always compressed independently. */ +#define WIM_VERSION_DEFAULT 0x10d00 + +/* Version number used for WIMs that allow multiple streams packed into one + * resource (WIM_RESHDR_FLAG_PACKED_STREAMS). New as of Windows 8 WIMGAPI; used + * for the Windows 8 web downloader, but yet not yet properly documented by + * Microsoft. This WIM format also allows a new compression format (LZMS). */ +#define WIM_VERSION_PACKED_STREAMS 0xe00 + +/* Note: there is another WIM version from Vista pre-releases, but it is not + * supported by wimlib. */ + +/* WIM magic characters, translated to a single 64-bit number. */ +#define WIM_MAGIC \ + (((u64)'M' << 0) | \ + ((u64)'S' << 8) | \ + ((u64)'W' << 16) | \ + ((u64)'I' << 24) | \ + ((u64)'M' << 32) | \ + ((u64)'\0' << 40) | \ + ((u64)'\0' << 48) | \ + ((u64)'\0' << 54)) + +/* wimlib pipable WIM magic characters, translated to a single 64-bit number. + * */ +#define PWM_MAGIC \ + (((u64)'W' << 0) | \ + ((u64)'L' << 8) | \ + ((u64)'P' << 16) | \ + ((u64)'W' << 24) | \ + ((u64)'M' << 32) | \ + ((u64)'\0' << 40) | \ + ((u64)'\0' << 48) | \ + ((u64)'\0' << 54)) /* On-disk format of the WIM header. */ struct wim_header_disk { - /* Magic characters "MSWIM\0\0\0" */ + /* +0x00: Magic characters "MSWIM\0\0\0". */ le64 magic; - /* Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE expected - * (currently the only supported value). */ + /* +0x08: Size of the WIM header, in bytes; WIM_HEADER_DISK_SIZE + * expected (currently the only supported value). */ u32 hdr_size; - /* Version of the WIM file; WIM_VERSION expected (currently the only - * supported value). */ + /* +0x0c: Version of the WIM file. Recognized values are the + * WIM_VERSION_* constants from above. */ u32 wim_version; - /* Flags for the WIM file (WIM_HDR_FLAG_*) */ + /* +0x10: Flags for the WIM file (WIM_HDR_FLAG_*). */ u32 wim_flags; - /* Uncompressed chunk size of resources in the WIM. 0 if the WIM is - * uncompressed. If compressed, WIM_CHUNK_SIZE is expected (currently - * the only supported value). */ + /* +0x14: Uncompressed chunk size for compressed resources in the WIM + * other than packed resources, or 0 if the WIM is uncompressed. */ u32 chunk_size; - /* Globally unique identifier for the WIM file. Basically a bunch of - * random bytes. */ + /* +0x18: Globally unique identifier for the WIM file. Basically a + * bunch of random bytes. */ u8 guid[WIM_GID_LEN]; - /* Number of this WIM part in the split WIM file, indexed from 1, or 1 - * if the WIM is not split. */ + /* +0x28: Number of this WIM part in the split WIM file, indexed from 1, + * or 1 if the WIM is not split. */ u16 part_number; - /* Total number of parts of the split WIM file, or 1 if the WIM is not - * split. */ + /* +0x2a: Total number of parts of the split WIM file, or 1 if the WIM + * is not split. */ u16 total_parts; - /* Number of images in the WIM. */ + /* +0x2c: Number of images in the WIM. */ u32 image_count; - /* Location and size of the WIM's lookup table. */ - struct resource_entry_disk lookup_table_res_entry; + /* +0x30: Location and size of the WIM's lookup table. */ + struct wim_reshdr_disk lookup_table_reshdr; - /* Location and size of the WIM's XML data. */ - struct resource_entry_disk xml_data_res_entry; + /* +0x48: Location and size of the WIM's XML data. */ + struct wim_reshdr_disk xml_data_reshdr; - /* Location and size of metadata resource for the bootable image of the - * WIM, or all zeroes if no image is bootable. */ - struct resource_entry_disk boot_metadata_res_entry; + /* +0x60: Location and size of metadata resource for the bootable image + * of the WIM, or all zeroes if no image is bootable. */ + struct wim_reshdr_disk boot_metadata_reshdr; - /* 1-based index of the bootable image of the WIM, or 0 if no image is - * bootable. */ + /* +0x78: 1-based index of the bootable image of the WIM, or 0 if no + * image is bootable. */ u32 boot_idx; - /* Location and size of the WIM's integrity table, or all zeroes if the - * WIM has no integrity table. + /* +0x7c: Location and size of the WIM's integrity table, or all zeroes + * if the WIM has no integrity table. * - * Note the integrity_table_res_entry here is 4-byte aligned even though - * it would ordinarily be 8-byte aligned--- hence, the _packed_attribute - * on the `struct wim_header_disk' is essential. */ - struct resource_entry_disk integrity_table_res_entry; + * Note the integrity_table_reshdr here is 4-byte aligned even though it + * would ordinarily be 8-byte aligned--- hence, the _packed_attribute on + * this structure is essential. */ + struct wim_reshdr_disk integrity_table_reshdr; - /* Unused bytes. */ + /* +0x94: Unused bytes. */ u8 unused[60]; + + /* +0xd0 (208) */ } _packed_attribute; -/* Header at the very beginning of the WIM file. This is the in-memory - * representation and does not include all fields; see `struct wim_header_disk' - * for the on-disk structure. */ +/* In-memory representation of a WIM header. See `struct wim_header_disk' for + * field descriptions. */ struct wim_header { - - /* Magic characters: either WIM_MAGIC or PWM_MAGIC. */ - le64 magic; - - /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */ + u64 magic; + u32 wim_version; u32 flags; - - /* A unique identifier for the WIM file. */ + u32 chunk_size; u8 guid[WIM_GID_LEN]; - - /* Part number of the WIM file in a spanned set. */ u16 part_number; - - /* Total number of parts in a spanned set. */ u16 total_parts; - - /* Number of images in the WIM file. */ u32 image_count; - - /* Location, size, and flags of the lookup table of the WIM. */ - struct resource_entry lookup_table_res_entry; - - /* Location, size, and flags for the XML data of the WIM. */ - struct resource_entry xml_res_entry; - - /* Location, size, and flags for the boot metadata. This means the - * metadata resource for the image specified by boot_idx below. Should - * be zeroed out if boot_idx is 0. */ - struct resource_entry boot_metadata_res_entry; - - /* The index of the bootable image in the WIM file. If 0, there are no - * bootable images available. */ + struct wim_reshdr lookup_table_reshdr; + struct wim_reshdr xml_data_reshdr; + struct wim_reshdr boot_metadata_reshdr; u32 boot_idx; - - /* The location of the optional integrity table used to verify the - * integrity WIM. Zeroed out if there is no integrity table.*/ - struct resource_entry integrity; + struct wim_reshdr integrity_table_reshdr; }; /* Flags for the `flags' field of the struct wim_header: */