2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 Peter Wemm
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 * AMD64 machine dependent routines for kvm and minidumps.
35 #include <sys/param.h>
36 #include <sys/endian.h>
44 #include "../../sys/amd64/include/minidump.h"
48 #include "kvm_private.h"
49 #include "kvm_amd64.h"
51 #define amd64_round_page(x) roundup2((kvaddr_t)(x), AMD64_PAGE_SIZE)
52 #define VM_IS_V1(vm) (vm->hdr.version == 1)
53 #define VA_OFF(vm, va) \
54 (VM_IS_V1(vm) ? ((va) & (AMD64_PAGE_SIZE - 1)) : ((va) & AMD64_PAGE_MASK))
57 struct minidumphdr hdr;
61 _amd64_entry_to_prot(uint64_t entry)
63 vm_prot_t prot = VM_PROT_READ;
65 if ((entry & AMD64_PG_RW) != 0)
66 prot |= VM_PROT_WRITE;
67 if ((entry & AMD64_PG_NX) == 0)
68 prot |= VM_PROT_EXECUTE;
73 * Version 2 minidumps use page directory entries, while version 1 use page
78 _amd64_pde_get(kvm_t *kd, u_long pdeindex)
80 amd64_pde_t *pde = _kvm_pmap_get(kd, pdeindex, sizeof(*pde));
86 _amd64_pte_get(kvm_t *kd, u_long pteindex)
88 amd64_pte_t *pte = _kvm_pmap_get(kd, pteindex, sizeof(*pte));
93 /* Get the first page table entry for a given page directory index. */
95 _amd64_pde_first_pte(kvm_t *kd, u_long pdeindex)
99 pa = _kvm_pmap_get(kd, pdeindex, sizeof(amd64_pde_t));
102 return _kvm_map_get(kd, *pa & AMD64_PG_FRAME, AMD64_PAGE_SIZE);
106 _amd64_minidump_probe(kvm_t *kd)
109 return (_kvm_probe_elf_kernel(kd, ELFCLASS64, EM_X86_64) &&
110 _kvm_is_minidump(kd));
114 _amd64_minidump_freevtop(kvm_t *kd)
116 struct vmstate *vm = kd->vmst;
123 _amd64_minidump_initvtop(kvm_t *kd)
125 struct vmstate *vmst;
126 off_t off, sparse_off;
128 vmst = _kvm_malloc(kd, sizeof(*vmst));
130 _kvm_err(kd, kd->program, "cannot allocate vm");
134 if (pread(kd->pmfd, &vmst->hdr, sizeof(vmst->hdr), 0) !=
136 _kvm_err(kd, kd->program, "cannot read dump header");
139 if (strncmp(MINIDUMP_MAGIC, vmst->hdr.magic, sizeof(vmst->hdr.magic)) != 0) {
140 _kvm_err(kd, kd->program, "not a minidump for this platform");
145 * NB: amd64 minidump header is binary compatible between version 1
146 * and version 2; this may not be the case for the future versions.
148 vmst->hdr.version = le32toh(vmst->hdr.version);
149 if (vmst->hdr.version != MINIDUMP_VERSION && vmst->hdr.version != 1) {
150 _kvm_err(kd, kd->program, "wrong minidump version. expected %d got %d",
151 MINIDUMP_VERSION, vmst->hdr.version);
154 vmst->hdr.msgbufsize = le32toh(vmst->hdr.msgbufsize);
155 vmst->hdr.bitmapsize = le32toh(vmst->hdr.bitmapsize);
156 vmst->hdr.pmapsize = le32toh(vmst->hdr.pmapsize);
157 vmst->hdr.kernbase = le64toh(vmst->hdr.kernbase);
158 vmst->hdr.dmapbase = le64toh(vmst->hdr.dmapbase);
159 vmst->hdr.dmapend = le64toh(vmst->hdr.dmapend);
161 /* Skip header and msgbuf */
162 off = AMD64_PAGE_SIZE + amd64_round_page(vmst->hdr.msgbufsize);
164 sparse_off = off + amd64_round_page(vmst->hdr.bitmapsize) +
165 amd64_round_page(vmst->hdr.pmapsize);
166 if (_kvm_pt_init(kd, vmst->hdr.bitmapsize, off, sparse_off,
167 AMD64_PAGE_SIZE, sizeof(uint64_t)) == -1) {
170 off += amd64_round_page(vmst->hdr.bitmapsize);
172 if (_kvm_pmap_init(kd, vmst->hdr.pmapsize, off) == -1) {
175 off += amd64_round_page(vmst->hdr.pmapsize);
181 _amd64_minidump_vatop_v1(kvm_t *kd, kvaddr_t va, off_t *pa)
184 amd64_physaddr_t offset;
191 offset = va & AMD64_PAGE_MASK;
193 if (va >= vm->hdr.kernbase) {
194 pteindex = (va - vm->hdr.kernbase) >> AMD64_PAGE_SHIFT;
195 if (pteindex >= vm->hdr.pmapsize / sizeof(pte))
197 pte = _amd64_pte_get(kd, pteindex);
198 if ((pte & AMD64_PG_V) == 0) {
199 _kvm_err(kd, kd->program,
200 "_amd64_minidump_vatop_v1: pte not valid");
203 a = pte & AMD64_PG_FRAME;
204 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
206 _kvm_err(kd, kd->program,
207 "_amd64_minidump_vatop_v1: physical address 0x%jx not in minidump",
212 return (AMD64_PAGE_SIZE - offset);
213 } else if (va >= vm->hdr.dmapbase && va < vm->hdr.dmapend) {
214 a = (va - vm->hdr.dmapbase) & ~AMD64_PAGE_MASK;
215 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
217 _kvm_err(kd, kd->program,
218 "_amd64_minidump_vatop_v1: direct map address 0x%jx not in minidump",
223 return (AMD64_PAGE_SIZE - offset);
225 _kvm_err(kd, kd->program,
226 "_amd64_minidump_vatop_v1: virtual address 0x%jx not minidumped",
232 _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
237 _amd64_minidump_vatop(kvm_t *kd, kvaddr_t va, off_t *pa)
239 amd64_pte_t pt[AMD64_NPTEPG];
241 amd64_physaddr_t offset;
250 offset = va & AMD64_PAGE_MASK;
252 if (va >= vm->hdr.kernbase) {
253 pdeindex = (va - vm->hdr.kernbase) >> AMD64_PDRSHIFT;
254 if (pdeindex >= vm->hdr.pmapsize / sizeof(pde))
256 pde = _amd64_pde_get(kd, pdeindex);
257 if ((pde & AMD64_PG_V) == 0) {
258 _kvm_err(kd, kd->program,
259 "_amd64_minidump_vatop: pde not valid");
262 if ((pde & AMD64_PG_PS) == 0) {
263 a = pde & AMD64_PG_FRAME;
264 /* TODO: Just read the single PTE */
265 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
267 _kvm_err(kd, kd->program,
268 "cannot find page table entry for %ju",
272 if (pread(kd->pmfd, &pt, AMD64_PAGE_SIZE, ofs) !=
274 _kvm_err(kd, kd->program,
275 "cannot read page table entry for %ju",
279 pteindex = (va >> AMD64_PAGE_SHIFT) &
281 pte = le64toh(pt[pteindex]);
282 if ((pte & AMD64_PG_V) == 0) {
283 _kvm_err(kd, kd->program,
284 "_amd64_minidump_vatop: pte not valid");
287 a = pte & AMD64_PG_FRAME;
289 a = pde & AMD64_PG_PS_FRAME;
290 a += (va & AMD64_PDRMASK) ^ offset;
292 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
294 _kvm_err(kd, kd->program,
295 "_amd64_minidump_vatop: physical address 0x%jx not in minidump",
300 return (AMD64_PAGE_SIZE - offset);
301 } else if (va >= vm->hdr.dmapbase && va < vm->hdr.dmapend) {
302 a = (va - vm->hdr.dmapbase) & ~AMD64_PAGE_MASK;
303 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
305 _kvm_err(kd, kd->program,
306 "_amd64_minidump_vatop: direct map address 0x%jx not in minidump",
311 return (AMD64_PAGE_SIZE - offset);
313 _kvm_err(kd, kd->program,
314 "_amd64_minidump_vatop: virtual address 0x%jx not minidumped",
320 _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
325 _amd64_minidump_kvatop(kvm_t *kd, kvaddr_t va, off_t *pa)
330 "_amd64_minidump_kvatop called in live kernel!");
333 if (((struct vmstate *)kd->vmst)->hdr.version == 1)
334 return (_amd64_minidump_vatop_v1(kd, va, pa));
336 return (_amd64_minidump_vatop(kd, va, pa));
340 _amd64_minidump_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *arg)
342 struct vmstate *vm = kd->vmst;
343 u_long npdes = vm->hdr.pmapsize / sizeof(amd64_pde_t);
344 u_long bmindex, dva, pa, pdeindex, va;
345 struct kvm_bitmap bm;
348 unsigned int pgsz = AMD64_PAGE_SIZE;
350 if (vm->hdr.version < 2)
353 if (!_kvm_bitmap_init(&bm, vm->hdr.bitmapsize, &bmindex))
356 for (pdeindex = 0; pdeindex < npdes; pdeindex++) {
357 amd64_pde_t pde = _amd64_pde_get(kd, pdeindex);
361 va = vm->hdr.kernbase + (pdeindex << AMD64_PDRSHIFT);
362 if ((pde & AMD64_PG_V) == 0)
365 if ((pde & AMD64_PG_PS) != 0) {
367 * Large page. Iterate on each 4K page section
368 * within this page. This differs from 4K pages in
369 * that every page here uses the same PDE to
370 * generate permissions.
372 pa = (pde & AMD64_PG_PS_FRAME) +
373 ((va & AMD64_PDRMASK) ^ VA_OFF(vm, va));
374 dva = vm->hdr.dmapbase + pa;
375 _kvm_bitmap_set(&bm, pa, AMD64_PAGE_SIZE);
376 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
377 _amd64_entry_to_prot(pde), AMD64_NBPDR, pgsz)) {
383 /* 4K pages: pde references another page of entries. */
384 ptes = _amd64_pde_first_pte(kd, pdeindex);
385 /* Ignore page directory pages that were not dumped. */
389 for (i = 0; i < AMD64_NPTEPG; i++) {
390 amd64_pte_t pte = (u_long)ptes[i];
392 pa = pte & AMD64_PG_FRAME;
393 dva = vm->hdr.dmapbase + pa;
394 if ((pte & AMD64_PG_V) != 0) {
395 _kvm_bitmap_set(&bm, pa, AMD64_PAGE_SIZE);
396 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
397 _amd64_entry_to_prot(pte), pgsz, 0)) {
401 va += AMD64_PAGE_SIZE;
405 while (_kvm_bitmap_next(&bm, &bmindex)) {
406 pa = bmindex * AMD64_PAGE_SIZE;
407 dva = vm->hdr.dmapbase + pa;
408 if (vm->hdr.dmapend < (dva + pgsz))
411 /* amd64/pmap.c: create_pagetables(): dmap always R|W. */
412 prot = VM_PROT_READ | VM_PROT_WRITE;
413 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva, prot, pgsz, 0)) {
421 _kvm_bitmap_deinit(&bm);
425 static struct kvm_arch kvm_amd64_minidump = {
426 .ka_probe = _amd64_minidump_probe,
427 .ka_initvtop = _amd64_minidump_initvtop,
428 .ka_freevtop = _amd64_minidump_freevtop,
429 .ka_kvatop = _amd64_minidump_kvatop,
430 .ka_native = _amd64_native,
431 .ka_walk_pages = _amd64_minidump_walk_pages,
434 KVM_ARCH(kvm_amd64_minidump);