4 * Copyright Fujitsu, Corp. 2011, 2012
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
14 #include "qemu-common.h"
17 #include "exec/cpu-all.h"
18 #include "exec/hwaddr.h"
19 #include "monitor/monitor.h"
20 #include "sysemu/kvm.h"
21 #include "sysemu/dump.h"
22 #include "sysemu/sysemu.h"
23 #include "sysemu/memory_mapping.h"
24 #include "sysemu/cpus.h"
25 #include "qapi/error.h"
26 #include "qmp-commands.h"
28 static uint16_t cpu_convert_to_target16(uint16_t val, int endian)
30 if (endian == ELFDATA2LSB) {
31 val = cpu_to_le16(val);
33 val = cpu_to_be16(val);
39 static uint32_t cpu_convert_to_target32(uint32_t val, int endian)
41 if (endian == ELFDATA2LSB) {
42 val = cpu_to_le32(val);
44 val = cpu_to_be32(val);
50 static uint64_t cpu_convert_to_target64(uint64_t val, int endian)
52 if (endian == ELFDATA2LSB) {
53 val = cpu_to_le64(val);
55 val = cpu_to_be64(val);
61 typedef struct DumpState {
62 GuestPhysBlockList guest_phys_blocks;
63 ArchDumpInfo dump_info;
64 MemoryMappingList list;
73 GuestPhysBlock *next_block;
80 uint8_t *note_buf; /* buffer for notes */
81 size_t note_buf_offset; /* the writing place in note_buf */
82 uint32_t nr_cpus; /* number of guest's cpu */
83 size_t page_size; /* guest's page size */
84 uint32_t page_shift; /* guest's page shift */
85 uint64_t max_mapnr; /* the biggest guest's phys-mem's number */
86 size_t len_dump_bitmap; /* the size of the place used to store
87 dump_bitmap in vmcore */
88 off_t offset_dump_bitmap; /* offset of dump_bitmap part in vmcore */
89 off_t offset_page; /* offset of page part in vmcore */
90 size_t num_dumpable; /* number of page that can be dumped */
91 uint32_t flag_compress; /* indicate the compression format */
94 static int dump_cleanup(DumpState *s)
98 guest_phys_blocks_free(&s->guest_phys_blocks);
99 memory_mapping_list_free(&s->list);
110 static void dump_error(DumpState *s, const char *reason)
115 static int fd_write_vmcore(const void *buf, size_t size, void *opaque)
117 DumpState *s = opaque;
120 written_size = qemu_write_full(s->fd, buf, size);
121 if (written_size != size) {
128 static int write_elf64_header(DumpState *s)
130 Elf64_Ehdr elf_header;
132 int endian = s->dump_info.d_endian;
134 memset(&elf_header, 0, sizeof(Elf64_Ehdr));
135 memcpy(&elf_header, ELFMAG, SELFMAG);
136 elf_header.e_ident[EI_CLASS] = ELFCLASS64;
137 elf_header.e_ident[EI_DATA] = s->dump_info.d_endian;
138 elf_header.e_ident[EI_VERSION] = EV_CURRENT;
139 elf_header.e_type = cpu_convert_to_target16(ET_CORE, endian);
140 elf_header.e_machine = cpu_convert_to_target16(s->dump_info.d_machine,
142 elf_header.e_version = cpu_convert_to_target32(EV_CURRENT, endian);
143 elf_header.e_ehsize = cpu_convert_to_target16(sizeof(elf_header), endian);
144 elf_header.e_phoff = cpu_convert_to_target64(sizeof(Elf64_Ehdr), endian);
145 elf_header.e_phentsize = cpu_convert_to_target16(sizeof(Elf64_Phdr),
147 elf_header.e_phnum = cpu_convert_to_target16(s->phdr_num, endian);
148 if (s->have_section) {
149 uint64_t shoff = sizeof(Elf64_Ehdr) + sizeof(Elf64_Phdr) * s->sh_info;
151 elf_header.e_shoff = cpu_convert_to_target64(shoff, endian);
152 elf_header.e_shentsize = cpu_convert_to_target16(sizeof(Elf64_Shdr),
154 elf_header.e_shnum = cpu_convert_to_target16(1, endian);
157 ret = fd_write_vmcore(&elf_header, sizeof(elf_header), s);
159 dump_error(s, "dump: failed to write elf header.\n");
166 static int write_elf32_header(DumpState *s)
168 Elf32_Ehdr elf_header;
170 int endian = s->dump_info.d_endian;
172 memset(&elf_header, 0, sizeof(Elf32_Ehdr));
173 memcpy(&elf_header, ELFMAG, SELFMAG);
174 elf_header.e_ident[EI_CLASS] = ELFCLASS32;
175 elf_header.e_ident[EI_DATA] = endian;
176 elf_header.e_ident[EI_VERSION] = EV_CURRENT;
177 elf_header.e_type = cpu_convert_to_target16(ET_CORE, endian);
178 elf_header.e_machine = cpu_convert_to_target16(s->dump_info.d_machine,
180 elf_header.e_version = cpu_convert_to_target32(EV_CURRENT, endian);
181 elf_header.e_ehsize = cpu_convert_to_target16(sizeof(elf_header), endian);
182 elf_header.e_phoff = cpu_convert_to_target32(sizeof(Elf32_Ehdr), endian);
183 elf_header.e_phentsize = cpu_convert_to_target16(sizeof(Elf32_Phdr),
185 elf_header.e_phnum = cpu_convert_to_target16(s->phdr_num, endian);
186 if (s->have_section) {
187 uint32_t shoff = sizeof(Elf32_Ehdr) + sizeof(Elf32_Phdr) * s->sh_info;
189 elf_header.e_shoff = cpu_convert_to_target32(shoff, endian);
190 elf_header.e_shentsize = cpu_convert_to_target16(sizeof(Elf32_Shdr),
192 elf_header.e_shnum = cpu_convert_to_target16(1, endian);
195 ret = fd_write_vmcore(&elf_header, sizeof(elf_header), s);
197 dump_error(s, "dump: failed to write elf header.\n");
204 static int write_elf64_load(DumpState *s, MemoryMapping *memory_mapping,
205 int phdr_index, hwaddr offset,
210 int endian = s->dump_info.d_endian;
212 memset(&phdr, 0, sizeof(Elf64_Phdr));
213 phdr.p_type = cpu_convert_to_target32(PT_LOAD, endian);
214 phdr.p_offset = cpu_convert_to_target64(offset, endian);
215 phdr.p_paddr = cpu_convert_to_target64(memory_mapping->phys_addr, endian);
216 phdr.p_filesz = cpu_convert_to_target64(filesz, endian);
217 phdr.p_memsz = cpu_convert_to_target64(memory_mapping->length, endian);
218 phdr.p_vaddr = cpu_convert_to_target64(memory_mapping->virt_addr, endian);
220 assert(memory_mapping->length >= filesz);
222 ret = fd_write_vmcore(&phdr, sizeof(Elf64_Phdr), s);
224 dump_error(s, "dump: failed to write program header table.\n");
231 static int write_elf32_load(DumpState *s, MemoryMapping *memory_mapping,
232 int phdr_index, hwaddr offset,
237 int endian = s->dump_info.d_endian;
239 memset(&phdr, 0, sizeof(Elf32_Phdr));
240 phdr.p_type = cpu_convert_to_target32(PT_LOAD, endian);
241 phdr.p_offset = cpu_convert_to_target32(offset, endian);
242 phdr.p_paddr = cpu_convert_to_target32(memory_mapping->phys_addr, endian);
243 phdr.p_filesz = cpu_convert_to_target32(filesz, endian);
244 phdr.p_memsz = cpu_convert_to_target32(memory_mapping->length, endian);
245 phdr.p_vaddr = cpu_convert_to_target32(memory_mapping->virt_addr, endian);
247 assert(memory_mapping->length >= filesz);
249 ret = fd_write_vmcore(&phdr, sizeof(Elf32_Phdr), s);
251 dump_error(s, "dump: failed to write program header table.\n");
258 static int write_elf64_note(DumpState *s)
261 int endian = s->dump_info.d_endian;
262 hwaddr begin = s->memory_offset - s->note_size;
265 memset(&phdr, 0, sizeof(Elf64_Phdr));
266 phdr.p_type = cpu_convert_to_target32(PT_NOTE, endian);
267 phdr.p_offset = cpu_convert_to_target64(begin, endian);
269 phdr.p_filesz = cpu_convert_to_target64(s->note_size, endian);
270 phdr.p_memsz = cpu_convert_to_target64(s->note_size, endian);
273 ret = fd_write_vmcore(&phdr, sizeof(Elf64_Phdr), s);
275 dump_error(s, "dump: failed to write program header table.\n");
282 static inline int cpu_index(CPUState *cpu)
284 return cpu->cpu_index + 1;
287 static int write_elf64_notes(WriteCoreDumpFunction f, DumpState *s)
295 ret = cpu_write_elf64_note(f, cpu, id, s);
297 dump_error(s, "dump: failed to write elf notes.\n");
303 ret = cpu_write_elf64_qemunote(f, cpu, s);
305 dump_error(s, "dump: failed to write CPU status.\n");
313 static int write_elf32_note(DumpState *s)
315 hwaddr begin = s->memory_offset - s->note_size;
317 int endian = s->dump_info.d_endian;
320 memset(&phdr, 0, sizeof(Elf32_Phdr));
321 phdr.p_type = cpu_convert_to_target32(PT_NOTE, endian);
322 phdr.p_offset = cpu_convert_to_target32(begin, endian);
324 phdr.p_filesz = cpu_convert_to_target32(s->note_size, endian);
325 phdr.p_memsz = cpu_convert_to_target32(s->note_size, endian);
328 ret = fd_write_vmcore(&phdr, sizeof(Elf32_Phdr), s);
330 dump_error(s, "dump: failed to write program header table.\n");
337 static int write_elf32_notes(WriteCoreDumpFunction f, DumpState *s)
345 ret = cpu_write_elf32_note(f, cpu, id, s);
347 dump_error(s, "dump: failed to write elf notes.\n");
353 ret = cpu_write_elf32_qemunote(f, cpu, s);
355 dump_error(s, "dump: failed to write CPU status.\n");
363 static int write_elf_section(DumpState *s, int type)
367 int endian = s->dump_info.d_endian;
373 shdr_size = sizeof(Elf32_Shdr);
374 memset(&shdr32, 0, shdr_size);
375 shdr32.sh_info = cpu_convert_to_target32(s->sh_info, endian);
378 shdr_size = sizeof(Elf64_Shdr);
379 memset(&shdr64, 0, shdr_size);
380 shdr64.sh_info = cpu_convert_to_target32(s->sh_info, endian);
384 ret = fd_write_vmcore(&shdr, shdr_size, s);
386 dump_error(s, "dump: failed to write section header table.\n");
393 static int write_data(DumpState *s, void *buf, int length)
397 ret = fd_write_vmcore(buf, length, s);
399 dump_error(s, "dump: failed to save memory.\n");
406 /* write the memroy to vmcore. 1 page per I/O. */
407 static int write_memory(DumpState *s, GuestPhysBlock *block, ram_addr_t start,
413 for (i = 0; i < size / TARGET_PAGE_SIZE; i++) {
414 ret = write_data(s, block->host_addr + start + i * TARGET_PAGE_SIZE,
421 if ((size % TARGET_PAGE_SIZE) != 0) {
422 ret = write_data(s, block->host_addr + start + i * TARGET_PAGE_SIZE,
423 size % TARGET_PAGE_SIZE);
432 /* get the memory's offset and size in the vmcore */
433 static void get_offset_range(hwaddr phys_addr,
434 ram_addr_t mapping_length,
439 GuestPhysBlock *block;
440 hwaddr offset = s->memory_offset;
441 int64_t size_in_block, start;
443 /* When the memory is not stored into vmcore, offset will be -1 */
448 if (phys_addr < s->begin || phys_addr >= s->begin + s->length) {
453 QTAILQ_FOREACH(block, &s->guest_phys_blocks.head, next) {
455 if (block->target_start >= s->begin + s->length ||
456 block->target_end <= s->begin) {
457 /* This block is out of the range */
461 if (s->begin <= block->target_start) {
462 start = block->target_start;
467 size_in_block = block->target_end - start;
468 if (s->begin + s->length < block->target_end) {
469 size_in_block -= block->target_end - (s->begin + s->length);
472 start = block->target_start;
473 size_in_block = block->target_end - block->target_start;
476 if (phys_addr >= start && phys_addr < start + size_in_block) {
477 *p_offset = phys_addr - start + offset;
479 /* The offset range mapped from the vmcore file must not spill over
480 * the GuestPhysBlock, clamp it. The rest of the mapping will be
481 * zero-filled in memory at load time; see
482 * <http://refspecs.linuxbase.org/elf/gabi4+/ch5.pheader.html>.
484 *p_filesz = phys_addr + mapping_length <= start + size_in_block ?
486 size_in_block - (phys_addr - start);
490 offset += size_in_block;
494 static int write_elf_loads(DumpState *s)
496 hwaddr offset, filesz;
497 MemoryMapping *memory_mapping;
498 uint32_t phdr_index = 1;
502 if (s->have_section) {
503 max_index = s->sh_info;
505 max_index = s->phdr_num;
508 QTAILQ_FOREACH(memory_mapping, &s->list.head, next) {
509 get_offset_range(memory_mapping->phys_addr,
510 memory_mapping->length,
511 s, &offset, &filesz);
512 if (s->dump_info.d_class == ELFCLASS64) {
513 ret = write_elf64_load(s, memory_mapping, phdr_index++, offset,
516 ret = write_elf32_load(s, memory_mapping, phdr_index++, offset,
524 if (phdr_index >= max_index) {
532 /* write elf header, PT_NOTE and elf note to vmcore. */
533 static int dump_begin(DumpState *s)
538 * the vmcore's format is:
557 * we only know where the memory is saved after we write elf note into
561 /* write elf header to vmcore */
562 if (s->dump_info.d_class == ELFCLASS64) {
563 ret = write_elf64_header(s);
565 ret = write_elf32_header(s);
571 if (s->dump_info.d_class == ELFCLASS64) {
572 /* write PT_NOTE to vmcore */
573 if (write_elf64_note(s) < 0) {
577 /* write all PT_LOAD to vmcore */
578 if (write_elf_loads(s) < 0) {
582 /* write section to vmcore */
583 if (s->have_section) {
584 if (write_elf_section(s, 1) < 0) {
589 /* write notes to vmcore */
590 if (write_elf64_notes(fd_write_vmcore, s) < 0) {
595 /* write PT_NOTE to vmcore */
596 if (write_elf32_note(s) < 0) {
600 /* write all PT_LOAD to vmcore */
601 if (write_elf_loads(s) < 0) {
605 /* write section to vmcore */
606 if (s->have_section) {
607 if (write_elf_section(s, 0) < 0) {
612 /* write notes to vmcore */
613 if (write_elf32_notes(fd_write_vmcore, s) < 0) {
621 /* write PT_LOAD to vmcore */
622 static int dump_completed(DumpState *s)
628 static int get_next_block(DumpState *s, GuestPhysBlock *block)
631 block = QTAILQ_NEXT(block, next);
638 s->next_block = block;
640 if (block->target_start >= s->begin + s->length ||
641 block->target_end <= s->begin) {
642 /* This block is out of the range */
646 if (s->begin > block->target_start) {
647 s->start = s->begin - block->target_start;
655 /* write all memory to vmcore */
656 static int dump_iterate(DumpState *s)
658 GuestPhysBlock *block;
663 block = s->next_block;
665 size = block->target_end - block->target_start;
668 if (s->begin + s->length < block->target_end) {
669 size -= block->target_end - (s->begin + s->length);
672 ret = write_memory(s, block, s->start, size);
677 ret = get_next_block(s, block);
685 static int create_vmcore(DumpState *s)
694 ret = dump_iterate(s);
702 static int write_start_flat_header(int fd)
705 MakedumpfileHeader mh;
708 memset(&mh, 0, sizeof(mh));
709 strncpy(mh.signature, MAKEDUMPFILE_SIGNATURE,
710 strlen(MAKEDUMPFILE_SIGNATURE));
712 mh.type = cpu_to_be64(TYPE_FLAT_HEADER);
713 mh.version = cpu_to_be64(VERSION_FLAT_HEADER);
715 buf = g_malloc0(MAX_SIZE_MDF_HEADER);
716 memcpy(buf, &mh, sizeof(mh));
719 written_size = qemu_write_full(fd, buf, MAX_SIZE_MDF_HEADER);
720 if (written_size != MAX_SIZE_MDF_HEADER) {
728 static int write_end_flat_header(int fd)
730 MakedumpfileDataHeader mdh;
732 mdh.offset = END_FLAG_FLAT_HEADER;
733 mdh.buf_size = END_FLAG_FLAT_HEADER;
736 written_size = qemu_write_full(fd, &mdh, sizeof(mdh));
737 if (written_size != sizeof(mdh)) {
744 static int write_buffer(int fd, off_t offset, const void *buf, size_t size)
747 MakedumpfileDataHeader mdh;
749 mdh.offset = cpu_to_be64(offset);
750 mdh.buf_size = cpu_to_be64(size);
752 written_size = qemu_write_full(fd, &mdh, sizeof(mdh));
753 if (written_size != sizeof(mdh)) {
757 written_size = qemu_write_full(fd, buf, size);
758 if (written_size != size) {
765 static int buf_write_note(const void *buf, size_t size, void *opaque)
767 DumpState *s = opaque;
769 /* note_buf is not enough */
770 if (s->note_buf_offset + size > s->note_size) {
774 memcpy(s->note_buf + s->note_buf_offset, buf, size);
776 s->note_buf_offset += size;
781 static ram_addr_t get_start_block(DumpState *s)
783 GuestPhysBlock *block;
785 if (!s->has_filter) {
786 s->next_block = QTAILQ_FIRST(&s->guest_phys_blocks.head);
790 QTAILQ_FOREACH(block, &s->guest_phys_blocks.head, next) {
791 if (block->target_start >= s->begin + s->length ||
792 block->target_end <= s->begin) {
793 /* This block is out of the range */
797 s->next_block = block;
798 if (s->begin > block->target_start) {
799 s->start = s->begin - block->target_start;
809 static void get_max_mapnr(DumpState *s)
811 GuestPhysBlock *last_block;
813 last_block = QTAILQ_LAST(&s->guest_phys_blocks.head, GuestPhysBlockHead);
814 s->max_mapnr = paddr_to_pfn(last_block->target_end, s->page_shift);
817 static int dump_init(DumpState *s, int fd, bool paging, bool has_filter,
818 int64_t begin, int64_t length, Error **errp)
825 if (runstate_is_running()) {
826 vm_stop(RUN_STATE_SAVE_VM);
832 /* If we use KVM, we should synchronize the registers before we get dump
833 * info or physmap info.
835 cpu_synchronize_all_states();
843 s->has_filter = has_filter;
847 guest_phys_blocks_init(&s->guest_phys_blocks);
848 guest_phys_blocks_append(&s->guest_phys_blocks);
850 s->start = get_start_block(s);
851 if (s->start == -1) {
852 error_set(errp, QERR_INVALID_PARAMETER, "begin");
856 /* get dump info: endian, class and architecture.
857 * If the target architecture is not supported, cpu_get_dump_info() will
860 ret = cpu_get_dump_info(&s->dump_info, &s->guest_phys_blocks);
862 error_set(errp, QERR_UNSUPPORTED);
866 s->note_size = cpu_get_note_size(s->dump_info.d_class,
867 s->dump_info.d_machine, nr_cpus);
868 if (s->note_size < 0) {
869 error_set(errp, QERR_UNSUPPORTED);
873 /* get memory mapping */
874 memory_mapping_list_init(&s->list);
876 qemu_get_guest_memory_mapping(&s->list, &s->guest_phys_blocks, &err);
878 error_propagate(errp, err);
882 qemu_get_guest_simple_memory_mapping(&s->list, &s->guest_phys_blocks);
885 s->nr_cpus = nr_cpus;
886 s->page_size = TARGET_PAGE_SIZE;
887 s->page_shift = ffs(s->page_size) - 1;
892 tmp = DIV_ROUND_UP(DIV_ROUND_UP(s->max_mapnr, CHAR_BIT), s->page_size);
893 s->len_dump_bitmap = tmp * s->page_size;
896 memory_mapping_filter(&s->list, s->begin, s->length);
902 * the type of ehdr->e_phnum is uint16_t, so we should avoid overflow
904 s->phdr_num = 1; /* PT_NOTE */
905 if (s->list.num < UINT16_MAX - 2) {
906 s->phdr_num += s->list.num;
907 s->have_section = false;
909 s->have_section = true;
910 s->phdr_num = PN_XNUM;
911 s->sh_info = 1; /* PT_NOTE */
913 /* the type of shdr->sh_info is uint32_t, so we should avoid overflow */
914 if (s->list.num <= UINT32_MAX - 1) {
915 s->sh_info += s->list.num;
917 s->sh_info = UINT32_MAX;
921 if (s->dump_info.d_class == ELFCLASS64) {
922 if (s->have_section) {
923 s->memory_offset = sizeof(Elf64_Ehdr) +
924 sizeof(Elf64_Phdr) * s->sh_info +
925 sizeof(Elf64_Shdr) + s->note_size;
927 s->memory_offset = sizeof(Elf64_Ehdr) +
928 sizeof(Elf64_Phdr) * s->phdr_num + s->note_size;
931 if (s->have_section) {
932 s->memory_offset = sizeof(Elf32_Ehdr) +
933 sizeof(Elf32_Phdr) * s->sh_info +
934 sizeof(Elf32_Shdr) + s->note_size;
936 s->memory_offset = sizeof(Elf32_Ehdr) +
937 sizeof(Elf32_Phdr) * s->phdr_num + s->note_size;
944 guest_phys_blocks_free(&s->guest_phys_blocks);
953 void qmp_dump_guest_memory(bool paging, const char *file, bool has_begin,
954 int64_t begin, bool has_length, int64_t length,
962 if (has_begin && !has_length) {
963 error_set(errp, QERR_MISSING_PARAMETER, "length");
966 if (!has_begin && has_length) {
967 error_set(errp, QERR_MISSING_PARAMETER, "begin");
972 if (strstart(file, "fd:", &p)) {
973 fd = monitor_get_fd(cur_mon, p, errp);
980 if (strstart(file, "file:", &p)) {
981 fd = qemu_open(p, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, S_IRUSR);
983 error_setg_file_open(errp, errno, p);
989 error_set(errp, QERR_INVALID_PARAMETER, "protocol");
993 s = g_malloc0(sizeof(DumpState));
995 ret = dump_init(s, fd, paging, has_begin, begin, length, errp);
1001 if (create_vmcore(s) < 0 && !error_is_set(s->errp)) {
1002 error_set(errp, QERR_IO_ERROR);