1 /*- 2 * Copyright (c) 2006 Peter Wemm 3 * Copyright (c) 2019 Mitchell Horne 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 * 26 * From: FreeBSD: src/lib/libkvm/kvm_minidump_amd64.c r261799 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 /* 33 * RISC-V machine dependent routines for kvm and minidumps. 34 */ 35 36 #include <sys/param.h> 37 #include <stdint.h> 38 #include <stdlib.h> 39 #include <string.h> 40 #include <unistd.h> 41 #include <vm/vm.h> 42 #include <kvm.h> 43 44 #include "../../sys/riscv/include/minidump.h" 45 46 #include <limits.h> 47 48 #include "kvm_private.h" 49 #include "kvm_riscv.h" 50 51 #define riscv_round_page(x) roundup2((kvaddr_t)(x), RISCV_PAGE_SIZE) 52 53 struct vmstate { 54 struct minidumphdr hdr; 55 }; 56 57 static riscv_pt_entry_t 58 _riscv_pte_get(kvm_t *kd, u_long pteindex) 59 { 60 riscv_pt_entry_t *pte = _kvm_pmap_get(kd, pteindex, sizeof(*pte)); 61 62 return le64toh(*pte); 63 } 64 65 static int 66 _riscv_minidump_probe(kvm_t *kd) 67 { 68 69 return (_kvm_probe_elf_kernel(kd, ELFCLASS64, EM_RISCV) && 70 _kvm_is_minidump(kd)); 71 } 72 73 static void 74 _riscv_minidump_freevtop(kvm_t *kd) 75 { 76 struct vmstate *vm = kd->vmst; 77 78 free(vm); 79 kd->vmst = NULL; 80 } 81 82 static int 83 _riscv_minidump_initvtop(kvm_t *kd) 84 { 85 struct vmstate *vmst; 86 off_t off, dump_avail_off, sparse_off; 87 88 vmst = _kvm_malloc(kd, sizeof(*vmst)); 89 if (vmst == NULL) { 90 _kvm_err(kd, kd->program, "cannot allocate vm"); 91 return (-1); 92 } 93 kd->vmst = vmst; 94 if (pread(kd->pmfd, &vmst->hdr, sizeof(vmst->hdr), 0) != 95 sizeof(vmst->hdr)) { 96 _kvm_err(kd, kd->program, "cannot read dump header"); 97 return (-1); 98 } 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"); 102 return (-1); 103 } 104 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); 109 return (-1); 110 } 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; 120 121 /* Skip header and msgbuf */ 122 dump_avail_off = RISCV_PAGE_SIZE + riscv_round_page(vmst->hdr.msgbufsize); 123 124 /* Skip dump_avail */ 125 off = dump_avail_off + riscv_round_page(vmst->hdr.dumpavailsize); 126 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, 132 sizeof(uint64_t)) == -1) { 133 return (-1); 134 } 135 off += riscv_round_page(vmst->hdr.bitmapsize); 136 137 if (_kvm_pmap_init(kd, vmst->hdr.pmapsize, off) == -1) { 138 return (-1); 139 } 140 off += riscv_round_page(vmst->hdr.pmapsize); 141 142 return (0); 143 } 144 145 static int 146 _riscv_minidump_vatop(kvm_t *kd, kvaddr_t va, off_t *pa) 147 { 148 struct vmstate *vm; 149 riscv_physaddr_t offset; 150 riscv_pt_entry_t l3; 151 kvaddr_t l3_index; 152 riscv_physaddr_t a; 153 off_t ofs; 154 155 vm = kd->vmst; 156 offset = va & RISCV_PAGE_MASK; 157 158 if (va >= vm->hdr.dmapbase && va < vm->hdr.dmapend) { 159 a = (va - vm->hdr.dmapbase + vm->hdr.dmapphys) & 160 ~RISCV_PAGE_MASK; 161 ofs = _kvm_pt_find(kd, a, RISCV_PAGE_SIZE); 162 if (ofs == -1) { 163 _kvm_err(kd, kd->program, "_riscv_minidump_vatop: " 164 "direct map address 0x%jx not in minidump", 165 (uintmax_t)va); 166 goto invalid; 167 } 168 *pa = ofs + offset; 169 return (RISCV_PAGE_SIZE - offset); 170 } else if (va >= vm->hdr.kernbase) { 171 l3_index = (va - vm->hdr.kernbase) >> RISCV_L3_SHIFT; 172 if (l3_index >= vm->hdr.pmapsize / sizeof(l3)) 173 goto invalid; 174 l3 = _riscv_pte_get(kd, l3_index); 175 if ((l3 & RISCV_PTE_V) == 0 || (l3 & RISCV_PTE_RWX) == 0) { 176 _kvm_err(kd, kd->program, 177 "_riscv_minidump_vatop: pte not valid"); 178 goto invalid; 179 } 180 a = (l3 >> RISCV_PTE_PPN0_S) << RISCV_L3_SHIFT; 181 ofs = _kvm_pt_find(kd, a, RISCV_PAGE_SIZE); 182 if (ofs == -1) { 183 _kvm_err(kd, kd->program, "_riscv_minidump_vatop: " 184 "physical address 0x%jx not in minidump", 185 (uintmax_t)a); 186 goto invalid; 187 } 188 *pa = ofs + offset; 189 return (RISCV_PAGE_SIZE - offset); 190 } else { 191 _kvm_err(kd, kd->program, 192 "_riscv_minidump_vatop: virtual address 0x%jx not minidumped", 193 (uintmax_t)va); 194 goto invalid; 195 } 196 197 invalid: 198 _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va); 199 return (0); 200 } 201 202 static int 203 _riscv_minidump_kvatop(kvm_t *kd, kvaddr_t va, off_t *pa) 204 { 205 206 if (ISALIVE(kd)) { 207 _kvm_err(kd, 0, 208 "_riscv_minidump_kvatop called in live kernel!"); 209 return (0); 210 } 211 return (_riscv_minidump_vatop(kd, va, pa)); 212 } 213 214 static int 215 _riscv_native(kvm_t *kd __unused) 216 { 217 218 #ifdef __riscv 219 return (1); 220 #else 221 return (0); 222 #endif 223 } 224 225 static vm_prot_t 226 _riscv_entry_to_prot(riscv_pt_entry_t pte) 227 { 228 vm_prot_t prot = VM_PROT_READ; 229 230 if ((pte & RISCV_PTE_W) != 0) 231 prot |= VM_PROT_WRITE; 232 if ((pte & RISCV_PTE_X) != 0) 233 prot |= VM_PROT_EXECUTE; 234 return prot; 235 } 236 237 static int 238 _riscv_minidump_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *arg) 239 { 240 struct vmstate *vm = kd->vmst; 241 u_long nptes = vm->hdr.pmapsize / sizeof(riscv_pt_entry_t); 242 u_long bmindex, dva, pa, pteindex, va; 243 struct kvm_bitmap bm; 244 vm_prot_t prot; 245 int ret = 0; 246 247 if (!_kvm_bitmap_init(&bm, vm->hdr.bitmapsize, &bmindex)) 248 return (0); 249 250 for (pteindex = 0; pteindex < nptes; pteindex++) { 251 riscv_pt_entry_t pte = _riscv_pte_get(kd, pteindex); 252 253 if (((pte & RISCV_PTE_V) == 0) || 254 ((pte & RISCV_PTE_RWX) == 0)) 255 continue; 256 257 va = vm->hdr.kernbase + (pteindex << RISCV_L3_SHIFT); 258 pa = (pte >> RISCV_PTE_PPN0_S) << RISCV_L3_SHIFT; 259 dva = vm->hdr.dmapbase + pa; 260 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva, 261 _riscv_entry_to_prot(pte), RISCV_PAGE_SIZE, 0)) { 262 goto out; 263 } 264 } 265 266 while (_kvm_bitmap_next(&bm, &bmindex)) { 267 pa = _kvm_bit_id_pa(kd, bmindex, RISCV_PAGE_SIZE); 268 if (pa == _KVM_PA_INVALID) 269 break; 270 dva = vm->hdr.dmapbase + pa; 271 if (vm->hdr.dmapend < (dva + RISCV_PAGE_SIZE)) 272 break; 273 va = 0; 274 prot = VM_PROT_READ | VM_PROT_WRITE; 275 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva, 276 prot, RISCV_PAGE_SIZE, 0)) { 277 goto out; 278 } 279 } 280 ret = 1; 281 282 out: 283 _kvm_bitmap_deinit(&bm); 284 return (ret); 285 } 286 287 static struct kvm_arch kvm_riscv_minidump = { 288 .ka_probe = _riscv_minidump_probe, 289 .ka_initvtop = _riscv_minidump_initvtop, 290 .ka_freevtop = _riscv_minidump_freevtop, 291 .ka_kvatop = _riscv_minidump_kvatop, 292 .ka_native = _riscv_native, 293 .ka_walk_pages = _riscv_minidump_walk_pages, 294 }; 295 296 KVM_ARCH(kvm_riscv_minidump); 297