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 * i386 machine dependent routines for kvm and minidumps.
35 #include <sys/param.h>
36 #include <sys/endian.h>
44 #include "../../sys/i386/include/minidump.h"
48 #include "kvm_private.h"
51 #define i386_round_page(x) roundup2((kvaddr_t)(x), I386_PAGE_SIZE)
54 struct minidumphdr hdr;
58 _i386_pte_pae_get(kvm_t *kd, u_long pteindex)
60 i386_pte_pae_t *pte = _kvm_pmap_get(kd, pteindex, sizeof(*pte));
66 _i386_pte_get(kvm_t *kd, u_long pteindex)
68 i386_pte_t *pte = _kvm_pmap_get(kd, pteindex, sizeof(*pte));
74 _i386_minidump_probe(kvm_t *kd)
77 return (_kvm_probe_elf_kernel(kd, ELFCLASS32, EM_386) &&
78 _kvm_is_minidump(kd));
82 _i386_minidump_freevtop(kvm_t *kd)
84 struct vmstate *vm = kd->vmst;
91 _i386_minidump_initvtop(kvm_t *kd)
94 off_t off, dump_avail_off, sparse_off;
96 vmst = _kvm_malloc(kd, sizeof(*vmst));
98 _kvm_err(kd, kd->program, "cannot allocate vm");
102 if (pread(kd->pmfd, &vmst->hdr, sizeof(vmst->hdr), 0) !=
104 _kvm_err(kd, kd->program, "cannot read dump header");
107 if (strncmp(MINIDUMP_MAGIC, vmst->hdr.magic, sizeof(vmst->hdr.magic)) != 0) {
108 _kvm_err(kd, kd->program, "not a minidump for this platform");
111 vmst->hdr.version = le32toh(vmst->hdr.version);
112 if (vmst->hdr.version != MINIDUMP_VERSION && vmst->hdr.version != 1) {
113 _kvm_err(kd, kd->program, "wrong minidump version. expected %d got %d",
114 MINIDUMP_VERSION, vmst->hdr.version);
117 vmst->hdr.msgbufsize = le32toh(vmst->hdr.msgbufsize);
118 vmst->hdr.bitmapsize = le32toh(vmst->hdr.bitmapsize);
119 vmst->hdr.ptesize = le32toh(vmst->hdr.ptesize);
120 vmst->hdr.kernbase = le32toh(vmst->hdr.kernbase);
121 vmst->hdr.paemode = le32toh(vmst->hdr.paemode);
122 vmst->hdr.dumpavailsize = vmst->hdr.version == MINIDUMP_VERSION ?
123 le32toh(vmst->hdr.dumpavailsize) : 0;
125 /* Skip header and msgbuf */
126 dump_avail_off = I386_PAGE_SIZE + i386_round_page(vmst->hdr.msgbufsize);
128 /* Skip dump_avail */
129 off = dump_avail_off + i386_round_page(vmst->hdr.dumpavailsize);
131 sparse_off = off + i386_round_page(vmst->hdr.bitmapsize) +
132 i386_round_page(vmst->hdr.ptesize);
133 if (_kvm_pt_init(kd, vmst->hdr.dumpavailsize, dump_avail_off,
134 vmst->hdr.bitmapsize, off, sparse_off, I386_PAGE_SIZE) == -1) {
137 off += i386_round_page(vmst->hdr.bitmapsize);
139 if (_kvm_pmap_init(kd, vmst->hdr.ptesize, off) == -1) {
142 off += i386_round_page(vmst->hdr.ptesize);
148 _i386_minidump_vatop_pae(kvm_t *kd, kvaddr_t va, off_t *pa)
151 i386_physaddr_pae_t offset;
154 i386_physaddr_pae_t a;
158 offset = va & I386_PAGE_MASK;
160 if (va >= vm->hdr.kernbase) {
161 pteindex = (va - vm->hdr.kernbase) >> I386_PAGE_SHIFT;
162 if (pteindex >= vm->hdr.ptesize / sizeof(pte))
164 pte = _i386_pte_pae_get(kd, pteindex);
165 if ((pte & I386_PG_V) == 0) {
166 _kvm_err(kd, kd->program,
167 "_i386_minidump_vatop_pae: pte not valid");
170 a = pte & I386_PG_FRAME_PAE;
171 ofs = _kvm_pt_find(kd, a, I386_PAGE_SIZE);
173 _kvm_err(kd, kd->program,
174 "_i386_minidump_vatop_pae: physical address 0x%jx not in minidump",
179 return (I386_PAGE_SIZE - offset);
181 _kvm_err(kd, kd->program,
182 "_i386_minidump_vatop_pae: virtual address 0x%jx not minidumped",
188 _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
193 _i386_minidump_vatop(kvm_t *kd, kvaddr_t va, off_t *pa)
196 i386_physaddr_t offset;
203 offset = va & I386_PAGE_MASK;
205 if (va >= vm->hdr.kernbase) {
206 pteindex = (va - vm->hdr.kernbase) >> I386_PAGE_SHIFT;
207 if (pteindex >= vm->hdr.ptesize / sizeof(pte))
209 pte = _i386_pte_get(kd, pteindex);
210 if ((pte & I386_PG_V) == 0) {
211 _kvm_err(kd, kd->program,
212 "_i386_minidump_vatop: pte not valid");
215 a = pte & I386_PG_FRAME;
216 ofs = _kvm_pt_find(kd, a, I386_PAGE_SIZE);
218 _kvm_err(kd, kd->program,
219 "_i386_minidump_vatop: physical address 0x%jx not in minidump",
224 return (I386_PAGE_SIZE - offset);
226 _kvm_err(kd, kd->program,
227 "_i386_minidump_vatop: virtual address 0x%jx not minidumped",
233 _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
238 _i386_minidump_kvatop(kvm_t *kd, kvaddr_t va, off_t *pa)
242 _kvm_err(kd, 0, "_i386_minidump_kvatop called in live kernel!");
245 if (kd->vmst->hdr.paemode)
246 return (_i386_minidump_vatop_pae(kd, va, pa));
248 return (_i386_minidump_vatop(kd, va, pa));
252 _i386_entry_to_prot(uint64_t pte)
254 vm_prot_t prot = VM_PROT_READ;
256 /* Source: i386/pmap.c:pmap_protect() */
257 if (pte & I386_PG_RW)
258 prot |= VM_PROT_WRITE;
259 if ((pte & I386_PG_NX) == 0)
260 prot |= VM_PROT_EXECUTE;
272 _i386_iterator_init(struct i386_iter *it, kvm_t *kd)
274 struct vmstate *vm = kd->vmst;
278 if (vm->hdr.paemode) {
279 it->nptes = vm->hdr.ptesize / sizeof(i386_pte_pae_t);
281 it->nptes = vm->hdr.ptesize / sizeof(i386_pte_t);
287 _i386_iterator_next(struct i386_iter *it, u_long *pa, u_long *va, u_long *dva,
290 struct vmstate *vm = it->kd->vmst;
292 i386_pte_pae_t pte64;
300 for (; it->pteindex < it->nptes && found == 0; it->pteindex++) {
301 if (vm->hdr.paemode) {
302 pte64 = _i386_pte_pae_get(it->kd, it->pteindex);
303 if ((pte64 & I386_PG_V) == 0)
305 *prot = _i386_entry_to_prot(pte64);
306 *pa = pte64 & I386_PG_FRAME_PAE;
308 pte32 = _i386_pte_get(it->kd, it->pteindex);
309 if ((pte32 & I386_PG_V) == 0)
311 *prot = _i386_entry_to_prot(pte32);
312 *pa = pte32 & I386_PG_FRAME;
314 *va = vm->hdr.kernbase + (it->pteindex << I386_PAGE_SHIFT);
321 _i386_minidump_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *arg)
327 _i386_iterator_init(&it, kd);
328 while (_i386_iterator_next(&it, &pa, &va, &dva, &prot)) {
329 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
330 prot, I386_PAGE_SIZE, 0)) {
337 static struct kvm_arch kvm_i386_minidump = {
338 .ka_probe = _i386_minidump_probe,
339 .ka_initvtop = _i386_minidump_initvtop,
340 .ka_freevtop = _i386_minidump_freevtop,
341 .ka_kvatop = _i386_minidump_kvatop,
342 .ka_native = _i386_native,
343 .ka_walk_pages = _i386_minidump_walk_pages,
346 KVM_ARCH(kvm_i386_minidump);