2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 Peter Wemm
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include "opt_watchdog.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/kerneldump.h>
40 #include <sys/msgbuf.h>
41 #include <sys/watchdog.h>
43 #include <vm/vm_param.h>
44 #include <vm/vm_page.h>
45 #include <vm/vm_phys.h>
46 #include <vm/vm_dumpset.h>
48 #include <machine/atomic.h>
49 #include <machine/elf.h>
50 #include <machine/md_var.h>
51 #include <machine/minidump.h>
53 CTASSERT(sizeof(struct kerneldumpheader) == 512);
55 #define MD_ALIGN(x) (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
56 #define DEV_ALIGN(x) roundup2((off_t)(x), DEV_BSIZE)
58 static struct kerneldumpheader kdh;
60 /* Handle chunked writes. */
65 blk_flush(struct dumperinfo *di)
72 error = dump_append(di, dump_va, fragsz);
78 blk_write(struct dumperinfo *di, char *ptr, vm_paddr_t pa, size_t sz)
84 maxdumpsz = min(di->maxiosize, MAXDUMPPGS * PAGE_SIZE);
85 if (maxdumpsz == 0) /* seatbelt */
86 maxdumpsz = PAGE_SIZE;
88 if ((sz % PAGE_SIZE) != 0) {
89 printf("size not page aligned\n");
92 if (ptr != NULL && pa != 0) {
93 printf("cant have both va and pa!\n");
96 if (pa != 0 && (((uintptr_t)ptr) % PAGE_SIZE) != 0) {
97 printf("address not page aligned\n");
101 /* If we're doing a virtual dump, flush any pre-existing pa pages */
102 error = blk_flush(di);
107 len = maxdumpsz - fragsz;
111 dumpsys_pb_progress(len);
112 wdog_kern_pat(WD_LASTVAL);
115 error = dump_append(di, ptr, len);
121 for (i = 0; i < len; i += PAGE_SIZE)
122 dump_va = pmap_kenter_temporary(pa + i, (i + fragsz) >> PAGE_SHIFT);
126 if (fragsz == maxdumpsz) {
127 error = blk_flush(di);
133 /* Check for user abort. */
138 printf(" (CTRL-C to abort) ");
144 /* A fake page table page, to avoid having to handle both 4K and 2M pages */
145 static pt_entry_t fakept[NPTEPG];
148 #define cpu_minidumpsys cpu_minidumpsys_pae
149 #define IdlePTD IdlePTD_pae
151 #define cpu_minidumpsys cpu_minidumpsys_nopae
152 #define IdlePTD IdlePTD_nopae
156 cpu_minidumpsys(struct dumperinfo *di, const struct minidumpstate *state)
160 vm_offset_t va, kva_end;
166 struct minidumphdr mdhdr;
169 /* Snapshot the KVA upper bound in case it grows. */
170 kva_end = kernel_vm_end;
173 * Walk the kernel page table pages, setting the active entries in the
176 * NB: for a live dump, we may be racing with updates to the page
177 * tables, so care must be taken to read each entry only once.
180 for (va = KERNBASE; va < kva_end; va += NBPDR) {
182 * We always write a page, even if it is zero. Each
183 * page written corresponds to 2MB of space
185 ptesize += PAGE_SIZE;
186 pd = IdlePTD; /* always mapped! */
187 pde = pte_load(&pd[va >> PDRSHIFT]);
188 if ((pde & (PG_PS | PG_V)) == (PG_PS | PG_V)) {
189 /* This is an entire 2M page. */
190 pa = pde & PG_PS_FRAME;
191 for (k = 0; k < NPTEPG; k++) {
192 if (vm_phys_is_dumpable(pa))
193 vm_page_dump_add(state->dump_bitset,
199 if ((pde & PG_V) == PG_V) {
200 /* set bit for each valid page in this 2MB block */
201 pt = pmap_kenter_temporary(pde & PG_FRAME, 0);
202 for (k = 0; k < NPTEPG; k++) {
203 pte = pte_load(&pt[k]);
204 if ((pte & PG_V) == PG_V) {
206 if (vm_phys_is_dumpable(pa))
208 state->dump_bitset, pa);
212 /* nothing, we're going to dump a null page */
216 /* Calculate dump size. */
217 mbp = state->msgbufp;
219 dumpsize += round_page(mbp->msg_size);
220 dumpsize += round_page(sizeof(dump_avail));
221 dumpsize += round_page(BITSET_SIZE(vm_page_dump_pages));
222 VM_PAGE_DUMP_FOREACH(state->dump_bitset, pa) {
223 /* Clear out undumpable pages now if needed */
224 if (vm_phys_is_dumpable(pa)) {
225 dumpsize += PAGE_SIZE;
227 vm_page_dump_drop(state->dump_bitset, pa);
230 dumpsize += PAGE_SIZE;
232 dumpsys_pb_init(dumpsize);
234 /* Initialize mdhdr */
235 bzero(&mdhdr, sizeof(mdhdr));
236 strcpy(mdhdr.magic, MINIDUMP_MAGIC);
237 mdhdr.version = MINIDUMP_VERSION;
238 mdhdr.msgbufsize = mbp->msg_size;
239 mdhdr.bitmapsize = round_page(BITSET_SIZE(vm_page_dump_pages));
240 mdhdr.ptesize = ptesize;
241 mdhdr.kernbase = KERNBASE;
242 mdhdr.paemode = pae_mode;
243 mdhdr.dumpavailsize = round_page(sizeof(dump_avail));
245 dump_init_header(di, &kdh, KERNELDUMPMAGIC, KERNELDUMP_I386_VERSION,
248 error = dump_start(di, &kdh);
252 printf("Physical memory: %ju MB\n", ptoa((uintmax_t)physmem) / 1048576);
253 printf("Dumping %llu MB:", (long long)dumpsize >> 20);
256 bzero(&fakept, sizeof(fakept));
257 bcopy(&mdhdr, &fakept, sizeof(mdhdr));
258 error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
262 /* Dump msgbuf up front */
263 error = blk_write(di, (char *)mbp->msg_ptr, 0,
264 round_page(mbp->msg_size));
268 /* Dump dump_avail */
269 _Static_assert(sizeof(dump_avail) <= sizeof(fakept),
270 "Large dump_avail not handled");
271 bzero(fakept, sizeof(fakept));
272 memcpy(fakept, dump_avail, sizeof(dump_avail));
273 error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
278 error = blk_write(di, (char *)vm_page_dump, 0,
279 round_page(BITSET_SIZE(vm_page_dump_pages)));
283 /* Dump kernel page table pages */
284 for (va = KERNBASE; va < kva_end; va += NBPDR) {
285 /* We always write a page, even if it is zero */
286 pd = IdlePTD; /* always mapped! */
287 pde = pte_load(&pd[va >> PDRSHIFT]);
288 if ((pde & (PG_PS | PG_V)) == (PG_PS | PG_V)) {
289 /* This is a single 2M block. Generate a fake PTP */
290 pa = pde & PG_PS_FRAME;
291 for (k = 0; k < NPTEPG; k++) {
292 fakept[k] = (pa + (k * PAGE_SIZE)) | PG_V | PG_RW | PG_A | PG_M;
294 error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
297 /* flush, in case we reuse fakept in the same block */
298 error = blk_flush(di);
303 if ((pde & PG_V) == PG_V) {
305 error = blk_write(di, 0, pa, PAGE_SIZE);
309 bzero(fakept, sizeof(fakept));
310 error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
313 /* flush, in case we reuse fakept in the same block */
314 error = blk_flush(di);
320 /* Dump memory chunks */
321 VM_PAGE_DUMP_FOREACH(state->dump_bitset, pa) {
322 error = blk_write(di, 0, pa, PAGE_SIZE);
327 error = blk_flush(di);
331 error = dump_finish(di, &kdh);
335 printf("\nDump complete\n");
342 if (error == ECANCELED)
343 printf("\nDump aborted\n");
344 else if (error == E2BIG || error == ENOSPC) {
345 printf("\nDump failed. Partition too small (about %lluMB were "
346 "needed this time).\n", (long long)dumpsize >> 20);
348 printf("\n** DUMP FAILED (ERROR %d) **\n", error);