2 * Copyright (c) 2006 Peter Wemm
3 * Copyright (c) 2019 Mitchell Horne
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * From: FreeBSD: src/lib/libkvm/kvm_minidump_amd64.c r261799
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
33 * RISC-V machine dependent routines for kvm and minidumps.
36 #include <sys/param.h>
44 #include "../../sys/riscv/include/minidump.h"
48 #include "kvm_private.h"
49 #include "kvm_riscv.h"
51 #define riscv_round_page(x) roundup2((kvaddr_t)(x), RISCV_PAGE_SIZE)
54 struct minidumphdr hdr;
57 static riscv_pt_entry_t
58 _riscv_pte_get(kvm_t *kd, u_long pteindex)
60 riscv_pt_entry_t *pte = _kvm_pmap_get(kd, pteindex, sizeof(*pte));
66 _riscv_minidump_probe(kvm_t *kd)
69 return (_kvm_probe_elf_kernel(kd, ELFCLASS64, EM_RISCV) &&
70 _kvm_is_minidump(kd));
74 _riscv_minidump_freevtop(kvm_t *kd)
76 struct vmstate *vm = kd->vmst;
83 _riscv_minidump_initvtop(kvm_t *kd)
86 off_t off, dump_avail_off, sparse_off;
88 vmst = _kvm_malloc(kd, sizeof(*vmst));
90 _kvm_err(kd, kd->program, "cannot allocate vm");
94 if (pread(kd->pmfd, &vmst->hdr, sizeof(vmst->hdr), 0) !=
96 _kvm_err(kd, kd->program, "cannot read dump header");
99 if (strncmp(MINIDUMP_MAGIC, vmst->hdr.magic,
100 sizeof(vmst->hdr.magic)) != 0) {
101 _kvm_err(kd, kd->program, "not a minidump for this platform");
105 vmst->hdr.version = le32toh(vmst->hdr.version);
106 if (vmst->hdr.version != MINIDUMP_VERSION && vmst->hdr.version != 1) {
107 _kvm_err(kd, kd->program, "wrong minidump version. "
108 "Expected %d got %d", MINIDUMP_VERSION, vmst->hdr.version);
111 vmst->hdr.msgbufsize = le32toh(vmst->hdr.msgbufsize);
112 vmst->hdr.bitmapsize = le32toh(vmst->hdr.bitmapsize);
113 vmst->hdr.pmapsize = le32toh(vmst->hdr.pmapsize);
114 vmst->hdr.kernbase = le64toh(vmst->hdr.kernbase);
115 vmst->hdr.dmapphys = le64toh(vmst->hdr.dmapphys);
116 vmst->hdr.dmapbase = le64toh(vmst->hdr.dmapbase);
117 vmst->hdr.dmapend = le64toh(vmst->hdr.dmapend);
118 vmst->hdr.dumpavailsize = vmst->hdr.version == MINIDUMP_VERSION ?
119 le32toh(vmst->hdr.dumpavailsize) : 0;
121 /* Skip header and msgbuf */
122 dump_avail_off = RISCV_PAGE_SIZE + riscv_round_page(vmst->hdr.msgbufsize);
124 /* Skip dump_avail */
125 off = dump_avail_off + riscv_round_page(vmst->hdr.dumpavailsize);
127 /* build physical address lookup table for sparse pages */
128 sparse_off = off + riscv_round_page(vmst->hdr.bitmapsize) +
129 riscv_round_page(vmst->hdr.pmapsize);
130 if (_kvm_pt_init(kd, vmst->hdr.dumpavailsize, dump_avail_off,
131 vmst->hdr.bitmapsize, off, sparse_off, RISCV_PAGE_SIZE) == -1) {
134 off += riscv_round_page(vmst->hdr.bitmapsize);
136 if (_kvm_pmap_init(kd, vmst->hdr.pmapsize, off) == -1) {
139 off += riscv_round_page(vmst->hdr.pmapsize);
145 _riscv_minidump_vatop(kvm_t *kd, kvaddr_t va, off_t *pa)
148 riscv_physaddr_t offset;
155 offset = va & RISCV_PAGE_MASK;
157 if (va >= vm->hdr.dmapbase && va < vm->hdr.dmapend) {
158 a = (va - vm->hdr.dmapbase + vm->hdr.dmapphys) &
160 ofs = _kvm_pt_find(kd, a, RISCV_PAGE_SIZE);
162 _kvm_err(kd, kd->program, "_riscv_minidump_vatop: "
163 "direct map address 0x%jx not in minidump",
168 return (RISCV_PAGE_SIZE - offset);
169 } else if (va >= vm->hdr.kernbase) {
170 l3_index = (va - vm->hdr.kernbase) >> RISCV_L3_SHIFT;
171 if (l3_index >= vm->hdr.pmapsize / sizeof(l3))
173 l3 = _riscv_pte_get(kd, l3_index);
174 if ((l3 & RISCV_PTE_V) == 0 || (l3 & RISCV_PTE_RWX) == 0) {
175 _kvm_err(kd, kd->program,
176 "_riscv_minidump_vatop: pte not valid");
179 a = (l3 >> RISCV_PTE_PPN0_S) << RISCV_L3_SHIFT;
180 ofs = _kvm_pt_find(kd, a, RISCV_PAGE_SIZE);
182 _kvm_err(kd, kd->program, "_riscv_minidump_vatop: "
183 "physical address 0x%jx not in minidump",
188 return (RISCV_PAGE_SIZE - offset);
190 _kvm_err(kd, kd->program,
191 "_riscv_minidump_vatop: virtual address 0x%jx not minidumped",
197 _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
202 _riscv_minidump_kvatop(kvm_t *kd, kvaddr_t va, off_t *pa)
207 "_riscv_minidump_kvatop called in live kernel!");
210 return (_riscv_minidump_vatop(kd, va, pa));
214 _riscv_native(kvm_t *kd __unused)
225 _riscv_entry_to_prot(riscv_pt_entry_t pte)
227 vm_prot_t prot = VM_PROT_READ;
229 if ((pte & RISCV_PTE_W) != 0)
230 prot |= VM_PROT_WRITE;
231 if ((pte & RISCV_PTE_X) != 0)
232 prot |= VM_PROT_EXECUTE;
237 _riscv_minidump_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *arg)
239 struct vmstate *vm = kd->vmst;
240 u_long nptes = vm->hdr.pmapsize / sizeof(riscv_pt_entry_t);
241 u_long bmindex, dva, pa, pteindex, va;
242 struct kvm_bitmap bm;
246 if (!_kvm_bitmap_init(&bm, vm->hdr.bitmapsize, &bmindex))
249 for (pteindex = 0; pteindex < nptes; pteindex++) {
250 riscv_pt_entry_t pte = _riscv_pte_get(kd, pteindex);
252 if (((pte & RISCV_PTE_V) == 0) ||
253 ((pte & RISCV_PTE_RWX) == 0))
256 va = vm->hdr.kernbase + (pteindex << RISCV_L3_SHIFT);
257 pa = (pte >> RISCV_PTE_PPN0_S) << RISCV_L3_SHIFT;
258 dva = vm->hdr.dmapbase + pa;
259 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
260 _riscv_entry_to_prot(pte), RISCV_PAGE_SIZE, 0)) {
265 while (_kvm_bitmap_next(&bm, &bmindex)) {
266 pa = _kvm_bit_id_pa(kd, bmindex, RISCV_PAGE_SIZE);
267 if (pa == _KVM_PA_INVALID)
269 dva = vm->hdr.dmapbase + pa;
270 if (vm->hdr.dmapend < (dva + RISCV_PAGE_SIZE))
273 prot = VM_PROT_READ | VM_PROT_WRITE;
274 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
275 prot, RISCV_PAGE_SIZE, 0)) {
282 _kvm_bitmap_deinit(&bm);
286 static struct kvm_arch kvm_riscv_minidump = {
287 .ka_probe = _riscv_minidump_probe,
288 .ka_initvtop = _riscv_minidump_initvtop,
289 .ka_freevtop = _riscv_minidump_freevtop,
290 .ka_kvatop = _riscv_minidump_kvatop,
291 .ka_native = _riscv_native,
292 .ka_walk_pages = _riscv_minidump_walk_pages,
295 KVM_ARCH(kvm_riscv_minidump);