xref: /freebsd/lib/libkvm/kvm_minidump_powerpc64.c (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
1 /*-
2  * Copyright (c) 2006 Peter Wemm
3  * Copyright (c) 2019 Leandro Lupori
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_riscv.c
27  */
28 
29 #include <sys/cdefs.h>
30 #include <sys/param.h>
31 
32 #include <kvm.h>
33 
34 #include <limits.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <unistd.h>
38 
39 #include "../../sys/powerpc/include/minidump.h"
40 #include "kvm_private.h"
41 #include "kvm_powerpc64.h"
42 
43 
44 static int
45 _powerpc64_minidump_probe(kvm_t *kd)
46 {
47 	return (_kvm_probe_elf_kernel(kd, ELFCLASS64, EM_PPC64) &&
48 	    _kvm_is_minidump(kd));
49 }
50 
51 static void
52 _powerpc64_minidump_freevtop(kvm_t *kd)
53 {
54 	struct vmstate *vm = kd->vmst;
55 
56 	if (vm == NULL)
57 		return;
58 	if (PPC64_MMU_OPS(kd))
59 		PPC64_MMU_OP(kd, cleanup);
60 	free(vm);
61 	kd->vmst = NULL;
62 }
63 
64 static int
65 _powerpc64_minidump_initvtop(kvm_t *kd)
66 {
67 	struct vmstate *vmst;
68 	struct minidumphdr *hdr;
69 	off_t dump_avail_off, bitmap_off, pmap_off, sparse_off;
70 	const char *mmu_name;
71 
72 	/* Alloc VM */
73 	vmst = _kvm_malloc(kd, sizeof(*vmst));
74 	if (vmst == NULL) {
75 		_kvm_err(kd, kd->program, "cannot allocate vm");
76 		return (-1);
77 	}
78 	hdr = &vmst->hdr;
79 	kd->vmst = vmst;
80 	PPC64_MMU_OPS(kd) = NULL;
81 	/* Read minidump header */
82 	if (pread(kd->pmfd, hdr, sizeof(*hdr), 0) != sizeof(*hdr)) {
83 		_kvm_err(kd, kd->program, "cannot read minidump header");
84 		goto failed;
85 	}
86 	/* Check magic */
87 	if (strncmp(MINIDUMP_MAGIC, hdr->magic, sizeof(hdr->magic)) != 0) {
88 		_kvm_err(kd, kd->program, "not a minidump for this platform");
89 		goto failed;
90 	}
91 	/* Check version */
92 	hdr->version = be32toh(hdr->version);
93 	if (hdr->version != MINIDUMP_VERSION && hdr->version != 1) {
94 		_kvm_err(kd, kd->program, "wrong minidump version. "
95 		    "Expected %d got %d", MINIDUMP_VERSION, hdr->version);
96 		goto failed;
97 	}
98 	/* Convert header fields to host endian */
99 	hdr->msgbufsize		= be32toh(hdr->msgbufsize);
100 	hdr->bitmapsize		= be32toh(hdr->bitmapsize);
101 	hdr->pmapsize		= be32toh(hdr->pmapsize);
102 	hdr->kernbase		= be64toh(hdr->kernbase);
103 	hdr->kernend		= be64toh(hdr->kernend);
104 	hdr->dmapbase		= be64toh(hdr->dmapbase);
105 	hdr->dmapend		= be64toh(hdr->dmapend);
106 	hdr->hw_direct_map	= be32toh(hdr->hw_direct_map);
107 	hdr->startkernel	= be64toh(hdr->startkernel);
108 	hdr->endkernel		= be64toh(hdr->endkernel);
109 	hdr->dumpavailsize	= hdr->version == MINIDUMP_VERSION ?
110 	    be32toh(hdr->dumpavailsize) : 0;
111 
112 	vmst->kimg_start = PPC64_KERNBASE;
113 	vmst->kimg_end = PPC64_KERNBASE + hdr->endkernel - hdr->startkernel;
114 
115 	/* dump header */
116 	dprintf("%s: mmu_name=%s,\n\t"
117 	    "msgbufsize=0x%jx, bitmapsize=0x%jx, pmapsize=0x%jx, "
118 	    "kernbase=0x%jx, kernend=0x%jx,\n\t"
119 	    "dmapbase=0x%jx, dmapend=0x%jx, hw_direct_map=%d, "
120 	    "startkernel=0x%jx, endkernel=0x%jx\n\t"
121 	    "kimg_start=0x%jx, kimg_end=0x%jx\n",
122 	    __func__, hdr->mmu_name,
123 	    (uintmax_t)hdr->msgbufsize,
124 	    (uintmax_t)hdr->bitmapsize, (uintmax_t)hdr->pmapsize,
125 	    (uintmax_t)hdr->kernbase, (uintmax_t)hdr->kernend,
126 	    (uintmax_t)hdr->dmapbase, (uintmax_t)hdr->dmapend,
127 	    hdr->hw_direct_map, hdr->startkernel, hdr->endkernel,
128 	    (uintmax_t)vmst->kimg_start, (uintmax_t)vmst->kimg_end);
129 
130 	/* Detect and initialize MMU */
131 	mmu_name = hdr->mmu_name;
132 	if (strcmp(mmu_name, PPC64_MMU_G5) == 0 ||
133 	    strcmp(mmu_name, PPC64_MMU_PHYP) == 0)
134 		PPC64_MMU_OPS(kd) = ppc64_mmu_ops_hpt;
135 	else {
136 		_kvm_err(kd, kd->program, "unsupported MMU: %s", mmu_name);
137 		goto failed;
138 	}
139 	if (PPC64_MMU_OP(kd, init) == -1)
140 		goto failed;
141 
142 	/* Get dump parts' offsets */
143 	dump_avail_off	= PPC64_PAGE_SIZE + ppc64_round_page(hdr->msgbufsize);
144 	bitmap_off	= dump_avail_off + ppc64_round_page(hdr->dumpavailsize);
145 	pmap_off	= bitmap_off + ppc64_round_page(hdr->bitmapsize);
146 	sparse_off	= pmap_off + ppc64_round_page(hdr->pmapsize);
147 
148 	/* dump offsets */
149 	dprintf("%s: msgbuf_off=0x%jx, bitmap_off=0x%jx, pmap_off=0x%jx, "
150 	    "sparse_off=0x%jx\n",
151 	    __func__, (uintmax_t)PPC64_PAGE_SIZE, (uintmax_t)bitmap_off,
152 	    (uintmax_t)pmap_off, (uintmax_t)sparse_off);
153 
154 	/* build physical address lookup table for sparse pages */
155 	if (_kvm_pt_init(kd, hdr->dumpavailsize, dump_avail_off,
156 	    hdr->bitmapsize, bitmap_off, sparse_off, PPC64_PAGE_SIZE) == -1)
157 		goto failed;
158 
159 	if (_kvm_pmap_init(kd, hdr->pmapsize, pmap_off) == -1)
160 		goto failed;
161 	return (0);
162 
163 failed:
164 	_powerpc64_minidump_freevtop(kd);
165 	return (-1);
166 }
167 
168 static int
169 _powerpc64_minidump_kvatop(kvm_t *kd, kvaddr_t va, off_t *pa)
170 {
171 	if (ISALIVE(kd)) {
172 		_kvm_err(kd, 0, "%s called in live kernel!", __func__);
173 		return (0);
174 	}
175 	return (PPC64_MMU_OP(kd, kvatop, va, pa));
176 }
177 
178 static int
179 _powerpc64_native(kvm_t *kd __unused)
180 {
181 #ifdef __powerpc64__
182 	return (1);
183 #else
184 	return (0);
185 #endif
186 }
187 
188 static kssize_t
189 _powerpc64_kerndisp(kvm_t *kd)
190 {
191 	return (kd->vmst->hdr.startkernel - PPC64_KERNBASE);
192 }
193 
194 static int
195 _powerpc64_minidump_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *arg)
196 {
197 	return (PPC64_MMU_OP(kd, walk_pages, cb, arg));
198 }
199 
200 static struct kvm_arch kvm_powerpc64_minidump = {
201 	.ka_probe	= _powerpc64_minidump_probe,
202 	.ka_initvtop	= _powerpc64_minidump_initvtop,
203 	.ka_freevtop	= _powerpc64_minidump_freevtop,
204 	.ka_kvatop	= _powerpc64_minidump_kvatop,
205 	.ka_walk_pages	= _powerpc64_minidump_walk_pages,
206 	.ka_native	= _powerpc64_native,
207 	.ka_kerndisp	= _powerpc64_kerndisp,
208 };
209 
210 KVM_ARCH(kvm_powerpc64_minidump);
211