[qemu.git] / include / sysemu / dump.h

/*
 * QEMU dump
 *
 * Copyright Fujitsu, Corp. 2011, 2012
 *
 * Authors:
 *     Wen Congyang <[email protected]>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */

#ifndef DUMP_H
#define DUMP_H

#include "qapi/qapi-types-misc.h"

#define MAKEDUMPFILE_SIGNATURE      "makedumpfile"
#define MAX_SIZE_MDF_HEADER         (4096) /* max size of makedumpfile_header */
#define TYPE_FLAT_HEADER            (1)    /* type of flattened format */
#define VERSION_FLAT_HEADER         (1)    /* version of flattened format */
#define END_FLAG_FLAT_HEADER        (-1)

#ifndef ARCH_PFN_OFFSET
#define ARCH_PFN_OFFSET             (0)
#endif

/*
 * flag for compressed format
 */
#define DUMP_DH_COMPRESSED_ZLIB     (0x1)
#define DUMP_DH_COMPRESSED_LZO      (0x2)
#define DUMP_DH_COMPRESSED_SNAPPY   (0x4)

#define KDUMP_SIGNATURE             "KDUMP   "
#define SIG_LEN                     (sizeof(KDUMP_SIGNATURE) - 1)
#define DUMP_LEVEL                  (1)
#define DISKDUMP_HEADER_BLOCKS      (1)

#include "sysemu/dump-arch.h"
#include "sysemu/memory_mapping.h"

typedef struct QEMU_PACKED MakedumpfileHeader {
    char signature[16];     /* = "makedumpfile" */
    int64_t type;
    int64_t version;
} MakedumpfileHeader;

typedef struct QEMU_PACKED MakedumpfileDataHeader {
    int64_t offset;
    int64_t buf_size;
} MakedumpfileDataHeader;

typedef struct QEMU_PACKED NewUtsname {
    char sysname[65];
    char nodename[65];
    char release[65];
    char version[65];
    char machine[65];
    char domainname[65];
} NewUtsname;

typedef struct QEMU_PACKED DiskDumpHeader32 {
    char signature[SIG_LEN];        /* = "KDUMP   " */
    uint32_t header_version;        /* Dump header version */
    NewUtsname utsname;             /* copy of system_utsname */
    char timestamp[10];             /* Time stamp */
    uint32_t status;                /* Above flags */
    uint32_t block_size;            /* Size of a block in byte */
    uint32_t sub_hdr_size;          /* Size of arch dependent header in block */
    uint32_t bitmap_blocks;         /* Size of Memory bitmap in block */
    uint32_t max_mapnr;             /* = max_mapnr ,
                                       obsoleted in header_version 6 */
    uint32_t total_ram_blocks;      /* Number of blocks should be written */
    uint32_t device_blocks;         /* Number of total blocks in dump device */
    uint32_t written_blocks;        /* Number of written blocks */
    uint32_t current_cpu;           /* CPU# which handles dump */
    uint32_t nr_cpus;               /* Number of CPUs */
} DiskDumpHeader32;

typedef struct QEMU_PACKED DiskDumpHeader64 {
    char signature[SIG_LEN];        /* = "KDUMP   " */
    uint32_t header_version;        /* Dump header version */
    NewUtsname utsname;             /* copy of system_utsname */
    char timestamp[22];             /* Time stamp */
    uint32_t status;                /* Above flags */
    uint32_t block_size;            /* Size of a block in byte */
    uint32_t sub_hdr_size;          /* Size of arch dependent header in block */
    uint32_t bitmap_blocks;         /* Size of Memory bitmap in block */
    uint32_t max_mapnr;             /* = max_mapnr,
                                       obsoleted in header_version 6 */
    uint32_t total_ram_blocks;      /* Number of blocks should be written */
    uint32_t device_blocks;         /* Number of total blocks in dump device */
    uint32_t written_blocks;        /* Number of written blocks */
    uint32_t current_cpu;           /* CPU# which handles dump */
    uint32_t nr_cpus;               /* Number of CPUs */
} DiskDumpHeader64;

typedef struct QEMU_PACKED KdumpSubHeader32 {
    uint32_t phys_base;
    uint32_t dump_level;            /* header_version 1 and later */
    uint32_t split;                 /* header_version 2 and later */
    uint32_t start_pfn;             /* header_version 2 and later,
                                       obsoleted in header_version 6 */
    uint32_t end_pfn;               /* header_version 2 and later,
                                       obsoleted in header_version 6 */
    uint64_t offset_vmcoreinfo;     /* header_version 3 and later */
    uint32_t size_vmcoreinfo;       /* header_version 3 and later */
    uint64_t offset_note;           /* header_version 4 and later */
    uint32_t note_size;             /* header_version 4 and later */
    uint64_t offset_eraseinfo;      /* header_version 5 and later */
    uint32_t size_eraseinfo;        /* header_version 5 and later */
    uint64_t start_pfn_64;          /* header_version 6 and later */
    uint64_t end_pfn_64;            /* header_version 6 and later */
    uint64_t max_mapnr_64;          /* header_version 6 and later */
} KdumpSubHeader32;

typedef struct QEMU_PACKED KdumpSubHeader64 {
    uint64_t phys_base;
    uint32_t dump_level;            /* header_version 1 and later */
    uint32_t split;                 /* header_version 2 and later */
    uint64_t start_pfn;             /* header_version 2 and later,
                                       obsoleted in header_version 6 */
    uint64_t end_pfn;               /* header_version 2 and later,
                                       obsoleted in header_version 6 */
    uint64_t offset_vmcoreinfo;     /* header_version 3 and later */
    uint64_t size_vmcoreinfo;       /* header_version 3 and later */
    uint64_t offset_note;           /* header_version 4 and later */
    uint64_t note_size;             /* header_version 4 and later */
    uint64_t offset_eraseinfo;      /* header_version 5 and later */
    uint64_t size_eraseinfo;        /* header_version 5 and later */
    uint64_t start_pfn_64;          /* header_version 6 and later */
    uint64_t end_pfn_64;            /* header_version 6 and later */
    uint64_t max_mapnr_64;          /* header_version 6 and later */
} KdumpSubHeader64;

typedef struct DataCache {
    int fd;             /* fd of the file where to write the cached data */
    uint8_t *buf;       /* buffer for cached data */
    size_t buf_size;    /* size of the buf */
    size_t data_size;   /* size of cached data in buf */
    off_t offset;       /* offset of the file */
} DataCache;

typedef struct QEMU_PACKED PageDescriptor {
    uint64_t offset;                /* the offset of the page data*/
    uint32_t size;                  /* the size of this dump page */
    uint32_t flags;                 /* flags */
    uint64_t page_flags;            /* page flags */
} PageDescriptor;

typedef struct DumpState {
    GuestPhysBlockList guest_phys_blocks;
    ArchDumpInfo dump_info;
    MemoryMappingList list;
    uint16_t phdr_num;
    uint32_t sh_info;
    bool have_section;
    bool resume;
    bool detached;
    ssize_t note_size;
    hwaddr memory_offset;
    int fd;

    GuestPhysBlock *next_block;
    ram_addr_t start;
    bool has_filter;
    int64_t begin;
    int64_t length;

    uint8_t *note_buf;          /* buffer for notes */
    size_t note_buf_offset;     /* the writing place in note_buf */
    uint32_t nr_cpus;           /* number of guest's cpu */
    uint64_t max_mapnr;         /* the biggest guest's phys-mem's number */
    size_t len_dump_bitmap;     /* the size of the place used to store
                                   dump_bitmap in vmcore */
    off_t offset_dump_bitmap;   /* offset of dump_bitmap part in vmcore */
    off_t offset_page;          /* offset of page part in vmcore */
    size_t num_dumpable;        /* number of page that can be dumped */
    uint32_t flag_compress;     /* indicate the compression format */
    DumpStatus status;          /* current dump status */

    bool has_format;              /* whether format is provided */
    DumpGuestMemoryFormat format; /* valid only if has_format == true */
    QemuThread dump_thread;       /* thread for detached dump */

    int64_t total_size;          /* total memory size (in bytes) to
                                  * be dumped. When filter is
                                  * enabled, this will only count
                                  * those to be written. */
    int64_t written_size;        /* written memory size (in bytes),
                                  * this could be used to calculate
                                  * how much work we have
                                  * finished. */
    uint8_t *guest_note;         /* ELF note content */
    size_t guest_note_size;
} DumpState;

uint16_t cpu_to_dump16(DumpState *s, uint16_t val);
uint32_t cpu_to_dump32(DumpState *s, uint32_t val);
uint64_t cpu_to_dump64(DumpState *s, uint64_t val);
#endif
Commit	Line	Data
25ae9c1d WC	1	/*
	2	* QEMU dump
	3	*
	4	* Copyright Fujitsu, Corp. 2011, 2012
	5	*
	6	* Authors:
	7	* Wen Congyang <[email protected]>
	8	*
352666e2 SW	9	* This work is licensed under the terms of the GNU GPL, version 2 or later.
352666e2 SW	10	* See the COPYING file in the top-level directory.
25ae9c1d WC	11	*
	12	*/
	13
	14	#ifndef DUMP_H
	15	#define DUMP_H
	16
112ed241	17	#include "qapi/qapi-types-misc.h"
9af23989	18
fda05387 QN	19	#define MAKEDUMPFILE_SIGNATURE "makedumpfile"
	20	#define MAX_SIZE_MDF_HEADER (4096) /* max size of makedumpfile_header */
	21	#define TYPE_FLAT_HEADER (1) /* type of flattened format */
	22	#define VERSION_FLAT_HEADER (1) /* version of flattened format */
	23	#define END_FLAG_FLAT_HEADER (-1)
	24
8161befd	25	#ifndef ARCH_PFN_OFFSET
7aad248d	26	#define ARCH_PFN_OFFSET (0)
8161befd	27	#endif
7aad248d	28
298f1168 QN	29	/*
	30	* flag for compressed format
	31	*/
	32	#define DUMP_DH_COMPRESSED_ZLIB (0x1)
	33	#define DUMP_DH_COMPRESSED_LZO (0x2)
	34	#define DUMP_DH_COMPRESSED_SNAPPY (0x4)
	35
	36	#define KDUMP_SIGNATURE "KDUMP "
	37	#define SIG_LEN (sizeof(KDUMP_SIGNATURE) - 1)
298f1168 QN	38	#define DUMP_LEVEL (1)
	39	#define DISKDUMP_HEADER_BLOCKS (1)
	40
acb0ef58 BR	41	#include "sysemu/dump-arch.h"
acb0ef58 BR	42	#include "sysemu/memory_mapping.h"
25ae9c1d	43
fda05387 QN	44	typedef struct QEMU_PACKED MakedumpfileHeader {
	45	char signature[16]; /* = "makedumpfile" */
	46	int64_t type;
	47	int64_t version;
	48	} MakedumpfileHeader;
	49
	50	typedef struct QEMU_PACKED MakedumpfileDataHeader {
	51	int64_t offset;
	52	int64_t buf_size;
	53	} MakedumpfileDataHeader;
	54
298f1168 QN	55	typedef struct QEMU_PACKED NewUtsname {
	56	char sysname[65];
	57	char nodename[65];
	58	char release[65];
	59	char version[65];
	60	char machine[65];
	61	char domainname[65];
	62	} NewUtsname;
	63
	64	typedef struct QEMU_PACKED DiskDumpHeader32 {
	65	char signature[SIG_LEN]; /* = "KDUMP " */
	66	uint32_t header_version; /* Dump header version */
	67	NewUtsname utsname; /* copy of system_utsname */
	68	char timestamp[10]; /* Time stamp */
	69	uint32_t status; /* Above flags */
	70	uint32_t block_size; /* Size of a block in byte */
	71	uint32_t sub_hdr_size; /* Size of arch dependent header in block */
	72	uint32_t bitmap_blocks; /* Size of Memory bitmap in block */
	73	uint32_t max_mapnr; /* = max_mapnr ,
	74	obsoleted in header_version 6 */
	75	uint32_t total_ram_blocks; /* Number of blocks should be written */
	76	uint32_t device_blocks; /* Number of total blocks in dump device */
	77	uint32_t written_blocks; /* Number of written blocks */
	78	uint32_t current_cpu; /* CPU# which handles dump */
	79	uint32_t nr_cpus; /* Number of CPUs */
	80	} DiskDumpHeader32;
	81
	82	typedef struct QEMU_PACKED DiskDumpHeader64 {
	83	char signature[SIG_LEN]; /* = "KDUMP " */
	84	uint32_t header_version; /* Dump header version */
	85	NewUtsname utsname; /* copy of system_utsname */
	86	char timestamp[22]; /* Time stamp */
	87	uint32_t status; /* Above flags */
	88	uint32_t block_size; /* Size of a block in byte */
	89	uint32_t sub_hdr_size; /* Size of arch dependent header in block */
	90	uint32_t bitmap_blocks; /* Size of Memory bitmap in block */
	91	uint32_t max_mapnr; /* = max_mapnr,
	92	obsoleted in header_version 6 */
	93	uint32_t total_ram_blocks; /* Number of blocks should be written */
	94	uint32_t device_blocks; /* Number of total blocks in dump device */
	95	uint32_t written_blocks; /* Number of written blocks */
	96	uint32_t current_cpu; /* CPU# which handles dump */
	97	uint32_t nr_cpus; /* Number of CPUs */
	98	} DiskDumpHeader64;
	99
	100	typedef struct QEMU_PACKED KdumpSubHeader32 {
	101	uint32_t phys_base;
	102	uint32_t dump_level; /* header_version 1 and later */
	103	uint32_t split; /* header_version 2 and later */
	104	uint32_t start_pfn; /* header_version 2 and later,
	105	obsoleted in header_version 6 */
	106	uint32_t end_pfn; /* header_version 2 and later,
	107	obsoleted in header_version 6 */
	108	uint64_t offset_vmcoreinfo; /* header_version 3 and later */
	109	uint32_t size_vmcoreinfo; /* header_version 3 and later */
	110	uint64_t offset_note; /* header_version 4 and later */
	111	uint32_t note_size; /* header_version 4 and later */
	112	uint64_t offset_eraseinfo; /* header_version 5 and later */
	113	uint32_t size_eraseinfo; /* header_version 5 and later */
	114	uint64_t start_pfn_64; /* header_version 6 and later */
	115	uint64_t end_pfn_64; /* header_version 6 and later */
	116	uint64_t max_mapnr_64; /* header_version 6 and later */
	117	} KdumpSubHeader32;
	118
119	typedef struct QEMU_PACKED KdumpSubHeader64 {
120	uint64_t phys_base;
121	uint32_t dump_level; /* header_version 1 and later */
122	uint32_t split; /* header_version 2 and later */
123	uint64_t start_pfn; /* header_version 2 and later,
124	obsoleted in header_version 6 */
125	uint64_t end_pfn; /* header_version 2 and later,
126	obsoleted in header_version 6 */
127	uint64_t offset_vmcoreinfo; /* header_version 3 and later */
128	uint64_t size_vmcoreinfo; /* header_version 3 and later */
129	uint64_t offset_note; /* header_version 4 and later */
130	uint64_t note_size; /* header_version 4 and later */
131	uint64_t offset_eraseinfo; /* header_version 5 and later */
132	uint64_t size_eraseinfo; /* header_version 5 and later */
133	uint64_t start_pfn_64; /* header_version 6 and later */
134	uint64_t end_pfn_64; /* header_version 6 and later */
135	uint64_t max_mapnr_64; /* header_version 6 and later */
136	} KdumpSubHeader64;
137
64cfba6a QN	138	typedef struct DataCache {
	139	int fd; /* fd of the file where to write the cached data */
	140	uint8_t buf; / buffer for cached data */
	141	size_t buf_size; /* size of the buf */
	142	size_t data_size; /* size of cached data in buf */
	143	off_t offset; /* offset of the file */
	144	} DataCache;
	145
d12f57ec QN	146	typedef struct QEMU_PACKED PageDescriptor {
	147	uint64_t offset; /* the offset of the page data*/
	148	uint32_t size; /* the size of this dump page */
	149	uint32_t flags; /* flags */
	150	uint64_t page_flags; /* page flags */
	151	} PageDescriptor;
	152
acb0ef58 BR	153	typedef struct DumpState {
	154	GuestPhysBlockList guest_phys_blocks;
	155	ArchDumpInfo dump_info;
	156	MemoryMappingList list;
	157	uint16_t phdr_num;
	158	uint32_t sh_info;
	159	bool have_section;
	160	bool resume;
6796b400	161	bool detached;
acb0ef58 BR	162	ssize_t note_size;
	163	hwaddr memory_offset;
	164	int fd;
	165
	166	GuestPhysBlock *next_block;
	167	ram_addr_t start;
	168	bool has_filter;
	169	int64_t begin;
	170	int64_t length;
	171
	172	uint8_t note_buf; / buffer for notes */
	173	size_t note_buf_offset; /* the writing place in note_buf */
	174	uint32_t nr_cpus; /* number of guest's cpu */
	175	uint64_t max_mapnr; /* the biggest guest's phys-mem's number */
	176	size_t len_dump_bitmap; /* the size of the place used to store
	177	dump_bitmap in vmcore */
	178	off_t offset_dump_bitmap; /* offset of dump_bitmap part in vmcore */
	179	off_t offset_page; /* offset of page part in vmcore */
	180	size_t num_dumpable; /* number of page that can be dumped */
	181	uint32_t flag_compress; /* indicate the compression format */
baf28f57	182	DumpStatus status; /* current dump status */
ca1fc8c9 PX	183
	184	bool has_format; /* whether format is provided */
	185	DumpGuestMemoryFormat format; /* valid only if has_format == true */
1fbeff72	186	QemuThread dump_thread; /* thread for detached dump */
2264c2c9 PX	187
	188	int64_t total_size; /* total memory size (in bytes) to
	189	* be dumped. When filter is
	190	* enabled, this will only count
	191	* those to be written. */
	192	int64_t written_size; /* written memory size (in bytes),
	193	* this could be used to calculate
	194	* how much work we have
	195	* finished. */
903ef734 MAL	196	uint8_t guest_note; / ELF note content */
903ef734 MAL	197	size_t guest_note_size;
acb0ef58 BR	198	} DumpState;
	199
	200	uint16_t cpu_to_dump16(DumpState *s, uint16_t val);
	201	uint32_t cpu_to_dump32(DumpState *s, uint32_t val);
	202	uint64_t cpu_to_dump64(DumpState *s, uint64_t val);
25ae9c1d	203	#endif