19c17d615SPaolo Bonzini /* 29c17d615SPaolo Bonzini * QEMU dump 39c17d615SPaolo Bonzini * 49c17d615SPaolo Bonzini * Copyright Fujitsu, Corp. 2011, 2012 59c17d615SPaolo Bonzini * 69c17d615SPaolo Bonzini * Authors: 79c17d615SPaolo Bonzini * Wen Congyang <wency@cn.fujitsu.com> 89c17d615SPaolo Bonzini * 99c17d615SPaolo Bonzini * This work is licensed under the terms of the GNU GPL, version 2 or later. 109c17d615SPaolo Bonzini * See the COPYING file in the top-level directory. 119c17d615SPaolo Bonzini * 129c17d615SPaolo Bonzini */ 139c17d615SPaolo Bonzini 149c17d615SPaolo Bonzini #ifndef DUMP_H 159c17d615SPaolo Bonzini #define DUMP_H 169c17d615SPaolo Bonzini 17fda05387Sqiaonuohan #define MAKEDUMPFILE_SIGNATURE "makedumpfile" 18fda05387Sqiaonuohan #define MAX_SIZE_MDF_HEADER (4096) /* max size of makedumpfile_header */ 19fda05387Sqiaonuohan #define TYPE_FLAT_HEADER (1) /* type of flattened format */ 20fda05387Sqiaonuohan #define VERSION_FLAT_HEADER (1) /* version of flattened format */ 21fda05387Sqiaonuohan #define END_FLAG_FLAT_HEADER (-1) 22fda05387Sqiaonuohan 237aad248dSqiaonuohan #define ARCH_PFN_OFFSET (0) 247aad248dSqiaonuohan 2522227f12SLaszlo Ersek #define paddr_to_pfn(X) \ 2622227f12SLaszlo Ersek (((unsigned long long)(X) >> TARGET_PAGE_BITS) - ARCH_PFN_OFFSET) 2722227f12SLaszlo Ersek #define pfn_to_paddr(X) \ 2822227f12SLaszlo Ersek (((unsigned long long)(X) + ARCH_PFN_OFFSET) << TARGET_PAGE_BITS) 297aad248dSqiaonuohan 30298f1168Sqiaonuohan /* 31298f1168Sqiaonuohan * flag for compressed format 32298f1168Sqiaonuohan */ 33298f1168Sqiaonuohan #define DUMP_DH_COMPRESSED_ZLIB (0x1) 34298f1168Sqiaonuohan #define DUMP_DH_COMPRESSED_LZO (0x2) 35298f1168Sqiaonuohan #define DUMP_DH_COMPRESSED_SNAPPY (0x4) 36298f1168Sqiaonuohan 37298f1168Sqiaonuohan #define KDUMP_SIGNATURE "KDUMP " 38298f1168Sqiaonuohan #define SIG_LEN (sizeof(KDUMP_SIGNATURE) - 1) 39298f1168Sqiaonuohan #define PHYS_BASE (0) 40298f1168Sqiaonuohan #define DUMP_LEVEL (1) 41298f1168Sqiaonuohan #define DISKDUMP_HEADER_BLOCKS (1) 42d0686c72Sqiaonuohan #define BUFSIZE_BITMAP (TARGET_PAGE_SIZE) 43d0686c72Sqiaonuohan #define PFN_BUFBITMAP (CHAR_BIT * BUFSIZE_BITMAP) 4464cfba6aSqiaonuohan #define BUFSIZE_DATA_CACHE (TARGET_PAGE_SIZE * 4) 45298f1168Sqiaonuohan 46*acb0ef58SBharata B Rao #include "sysemu/dump-arch.h" 47*acb0ef58SBharata B Rao #include "sysemu/memory_mapping.h" 489c17d615SPaolo Bonzini 49fda05387Sqiaonuohan typedef struct QEMU_PACKED MakedumpfileHeader { 50fda05387Sqiaonuohan char signature[16]; /* = "makedumpfile" */ 51fda05387Sqiaonuohan int64_t type; 52fda05387Sqiaonuohan int64_t version; 53fda05387Sqiaonuohan } MakedumpfileHeader; 54fda05387Sqiaonuohan 55fda05387Sqiaonuohan typedef struct QEMU_PACKED MakedumpfileDataHeader { 56fda05387Sqiaonuohan int64_t offset; 57fda05387Sqiaonuohan int64_t buf_size; 58fda05387Sqiaonuohan } MakedumpfileDataHeader; 59fda05387Sqiaonuohan 60298f1168Sqiaonuohan typedef struct QEMU_PACKED NewUtsname { 61298f1168Sqiaonuohan char sysname[65]; 62298f1168Sqiaonuohan char nodename[65]; 63298f1168Sqiaonuohan char release[65]; 64298f1168Sqiaonuohan char version[65]; 65298f1168Sqiaonuohan char machine[65]; 66298f1168Sqiaonuohan char domainname[65]; 67298f1168Sqiaonuohan } NewUtsname; 68298f1168Sqiaonuohan 69298f1168Sqiaonuohan typedef struct QEMU_PACKED DiskDumpHeader32 { 70298f1168Sqiaonuohan char signature[SIG_LEN]; /* = "KDUMP " */ 71298f1168Sqiaonuohan uint32_t header_version; /* Dump header version */ 72298f1168Sqiaonuohan NewUtsname utsname; /* copy of system_utsname */ 73298f1168Sqiaonuohan char timestamp[10]; /* Time stamp */ 74298f1168Sqiaonuohan uint32_t status; /* Above flags */ 75298f1168Sqiaonuohan uint32_t block_size; /* Size of a block in byte */ 76298f1168Sqiaonuohan uint32_t sub_hdr_size; /* Size of arch dependent header in block */ 77298f1168Sqiaonuohan uint32_t bitmap_blocks; /* Size of Memory bitmap in block */ 78298f1168Sqiaonuohan uint32_t max_mapnr; /* = max_mapnr , 79298f1168Sqiaonuohan obsoleted in header_version 6 */ 80298f1168Sqiaonuohan uint32_t total_ram_blocks; /* Number of blocks should be written */ 81298f1168Sqiaonuohan uint32_t device_blocks; /* Number of total blocks in dump device */ 82298f1168Sqiaonuohan uint32_t written_blocks; /* Number of written blocks */ 83298f1168Sqiaonuohan uint32_t current_cpu; /* CPU# which handles dump */ 84298f1168Sqiaonuohan uint32_t nr_cpus; /* Number of CPUs */ 85298f1168Sqiaonuohan } DiskDumpHeader32; 86298f1168Sqiaonuohan 87298f1168Sqiaonuohan typedef struct QEMU_PACKED DiskDumpHeader64 { 88298f1168Sqiaonuohan char signature[SIG_LEN]; /* = "KDUMP " */ 89298f1168Sqiaonuohan uint32_t header_version; /* Dump header version */ 90298f1168Sqiaonuohan NewUtsname utsname; /* copy of system_utsname */ 91298f1168Sqiaonuohan char timestamp[22]; /* Time stamp */ 92298f1168Sqiaonuohan uint32_t status; /* Above flags */ 93298f1168Sqiaonuohan uint32_t block_size; /* Size of a block in byte */ 94298f1168Sqiaonuohan uint32_t sub_hdr_size; /* Size of arch dependent header in block */ 95298f1168Sqiaonuohan uint32_t bitmap_blocks; /* Size of Memory bitmap in block */ 96298f1168Sqiaonuohan uint32_t max_mapnr; /* = max_mapnr, 97298f1168Sqiaonuohan obsoleted in header_version 6 */ 98298f1168Sqiaonuohan uint32_t total_ram_blocks; /* Number of blocks should be written */ 99298f1168Sqiaonuohan uint32_t device_blocks; /* Number of total blocks in dump device */ 100298f1168Sqiaonuohan uint32_t written_blocks; /* Number of written blocks */ 101298f1168Sqiaonuohan uint32_t current_cpu; /* CPU# which handles dump */ 102298f1168Sqiaonuohan uint32_t nr_cpus; /* Number of CPUs */ 103298f1168Sqiaonuohan } DiskDumpHeader64; 104298f1168Sqiaonuohan 105298f1168Sqiaonuohan typedef struct QEMU_PACKED KdumpSubHeader32 { 106298f1168Sqiaonuohan uint32_t phys_base; 107298f1168Sqiaonuohan uint32_t dump_level; /* header_version 1 and later */ 108298f1168Sqiaonuohan uint32_t split; /* header_version 2 and later */ 109298f1168Sqiaonuohan uint32_t start_pfn; /* header_version 2 and later, 110298f1168Sqiaonuohan obsoleted in header_version 6 */ 111298f1168Sqiaonuohan uint32_t end_pfn; /* header_version 2 and later, 112298f1168Sqiaonuohan obsoleted in header_version 6 */ 113298f1168Sqiaonuohan uint64_t offset_vmcoreinfo; /* header_version 3 and later */ 114298f1168Sqiaonuohan uint32_t size_vmcoreinfo; /* header_version 3 and later */ 115298f1168Sqiaonuohan uint64_t offset_note; /* header_version 4 and later */ 116298f1168Sqiaonuohan uint32_t note_size; /* header_version 4 and later */ 117298f1168Sqiaonuohan uint64_t offset_eraseinfo; /* header_version 5 and later */ 118298f1168Sqiaonuohan uint32_t size_eraseinfo; /* header_version 5 and later */ 119298f1168Sqiaonuohan uint64_t start_pfn_64; /* header_version 6 and later */ 120298f1168Sqiaonuohan uint64_t end_pfn_64; /* header_version 6 and later */ 121298f1168Sqiaonuohan uint64_t max_mapnr_64; /* header_version 6 and later */ 122298f1168Sqiaonuohan } KdumpSubHeader32; 123298f1168Sqiaonuohan 124298f1168Sqiaonuohan typedef struct QEMU_PACKED KdumpSubHeader64 { 125298f1168Sqiaonuohan uint64_t phys_base; 126298f1168Sqiaonuohan uint32_t dump_level; /* header_version 1 and later */ 127298f1168Sqiaonuohan uint32_t split; /* header_version 2 and later */ 128298f1168Sqiaonuohan uint64_t start_pfn; /* header_version 2 and later, 129298f1168Sqiaonuohan obsoleted in header_version 6 */ 130298f1168Sqiaonuohan uint64_t end_pfn; /* header_version 2 and later, 131298f1168Sqiaonuohan obsoleted in header_version 6 */ 132298f1168Sqiaonuohan uint64_t offset_vmcoreinfo; /* header_version 3 and later */ 133298f1168Sqiaonuohan uint64_t size_vmcoreinfo; /* header_version 3 and later */ 134298f1168Sqiaonuohan uint64_t offset_note; /* header_version 4 and later */ 135298f1168Sqiaonuohan uint64_t note_size; /* header_version 4 and later */ 136298f1168Sqiaonuohan uint64_t offset_eraseinfo; /* header_version 5 and later */ 137298f1168Sqiaonuohan uint64_t size_eraseinfo; /* header_version 5 and later */ 138298f1168Sqiaonuohan uint64_t start_pfn_64; /* header_version 6 and later */ 139298f1168Sqiaonuohan uint64_t end_pfn_64; /* header_version 6 and later */ 140298f1168Sqiaonuohan uint64_t max_mapnr_64; /* header_version 6 and later */ 141298f1168Sqiaonuohan } KdumpSubHeader64; 142298f1168Sqiaonuohan 14364cfba6aSqiaonuohan typedef struct DataCache { 14464cfba6aSqiaonuohan int fd; /* fd of the file where to write the cached data */ 14564cfba6aSqiaonuohan uint8_t *buf; /* buffer for cached data */ 14664cfba6aSqiaonuohan size_t buf_size; /* size of the buf */ 14764cfba6aSqiaonuohan size_t data_size; /* size of cached data in buf */ 14864cfba6aSqiaonuohan off_t offset; /* offset of the file */ 14964cfba6aSqiaonuohan } DataCache; 15064cfba6aSqiaonuohan 151d12f57ecSqiaonuohan typedef struct QEMU_PACKED PageDescriptor { 152d12f57ecSqiaonuohan uint64_t offset; /* the offset of the page data*/ 153d12f57ecSqiaonuohan uint32_t size; /* the size of this dump page */ 154d12f57ecSqiaonuohan uint32_t flags; /* flags */ 155d12f57ecSqiaonuohan uint64_t page_flags; /* page flags */ 156d12f57ecSqiaonuohan } PageDescriptor; 157d12f57ecSqiaonuohan 158*acb0ef58SBharata B Rao typedef struct DumpState { 159*acb0ef58SBharata B Rao GuestPhysBlockList guest_phys_blocks; 160*acb0ef58SBharata B Rao ArchDumpInfo dump_info; 161*acb0ef58SBharata B Rao MemoryMappingList list; 162*acb0ef58SBharata B Rao uint16_t phdr_num; 163*acb0ef58SBharata B Rao uint32_t sh_info; 164*acb0ef58SBharata B Rao bool have_section; 165*acb0ef58SBharata B Rao bool resume; 166*acb0ef58SBharata B Rao ssize_t note_size; 167*acb0ef58SBharata B Rao hwaddr memory_offset; 168*acb0ef58SBharata B Rao int fd; 1699c17d615SPaolo Bonzini 170*acb0ef58SBharata B Rao GuestPhysBlock *next_block; 171*acb0ef58SBharata B Rao ram_addr_t start; 172*acb0ef58SBharata B Rao bool has_filter; 173*acb0ef58SBharata B Rao int64_t begin; 174*acb0ef58SBharata B Rao int64_t length; 175*acb0ef58SBharata B Rao 176*acb0ef58SBharata B Rao uint8_t *note_buf; /* buffer for notes */ 177*acb0ef58SBharata B Rao size_t note_buf_offset; /* the writing place in note_buf */ 178*acb0ef58SBharata B Rao uint32_t nr_cpus; /* number of guest's cpu */ 179*acb0ef58SBharata B Rao uint64_t max_mapnr; /* the biggest guest's phys-mem's number */ 180*acb0ef58SBharata B Rao size_t len_dump_bitmap; /* the size of the place used to store 181*acb0ef58SBharata B Rao dump_bitmap in vmcore */ 182*acb0ef58SBharata B Rao off_t offset_dump_bitmap; /* offset of dump_bitmap part in vmcore */ 183*acb0ef58SBharata B Rao off_t offset_page; /* offset of page part in vmcore */ 184*acb0ef58SBharata B Rao size_t num_dumpable; /* number of page that can be dumped */ 185*acb0ef58SBharata B Rao uint32_t flag_compress; /* indicate the compression format */ 186*acb0ef58SBharata B Rao } DumpState; 187*acb0ef58SBharata B Rao 188*acb0ef58SBharata B Rao uint16_t cpu_to_dump16(DumpState *s, uint16_t val); 189*acb0ef58SBharata B Rao uint32_t cpu_to_dump32(DumpState *s, uint32_t val); 190*acb0ef58SBharata B Rao uint64_t cpu_to_dump64(DumpState *s, uint64_t val); 1919c17d615SPaolo Bonzini #endif 192