2 * Copyright (c) 2006 Peter Wemm
5 * Redistribution and use in source and binary forms, with or without
6 * 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 ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include "opt_watchdog.h"
33 #include <sys/param.h>
34 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/kerneldump.h>
39 #include <sys/msgbuf.h>
40 #include <sys/sysctl.h>
41 #include <sys/watchdog.h>
43 #include <vm/vm_param.h>
44 #include <vm/vm_page.h>
45 #include <vm/vm_phys.h>
47 #include <machine/atomic.h>
48 #include <machine/elf.h>
49 #include <machine/md_var.h>
50 #include <machine/minidump.h>
52 CTASSERT(sizeof(struct kerneldumpheader) == 512);
55 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
56 * is to protect us from metadata and to protect metadata from us.
58 #define SIZEOF_METADATA (64*1024)
60 uint64_t *vm_page_dump;
61 int vm_page_dump_size;
63 static struct kerneldumpheader kdh;
66 /* Handle chunked writes. */
69 static size_t counter, progress, dumpsize;
71 CTASSERT(sizeof(*vm_page_dump) == 8);
72 static int dump_retry_count = 5;
73 SYSCTL_INT(_machdep, OID_AUTO, dump_retry_count, CTLFLAG_RWTUN,
74 &dump_retry_count, 0, "Number of times dump has to retry before bailing out");
77 is_dumpable(vm_paddr_t pa)
82 if ((m = vm_phys_paddr_to_vm_page(pa)) != NULL)
83 return ((m->flags & PG_NODUMP) == 0);
84 for (i = 0; dump_avail[i] != 0 || dump_avail[i + 1] != 0; i += 2) {
85 if (pa >= dump_avail[i] && pa < dump_avail[i + 1])
91 #define PG2MB(pgs) (((pgs) + (1 << 8) - 1) >> 8)
94 blk_flush(struct dumperinfo *di)
101 error = dump_write(di, dump_va, 0, dumplo, fragsz);
111 } progress_track[10] = {
125 report_progress(size_t progress, size_t dumpsize)
129 sofar = 100 - ((progress * 100) / dumpsize);
130 for (i = 0; i < nitems(progress_track); i++) {
131 if (sofar < progress_track[i].min_per ||
132 sofar > progress_track[i].max_per)
134 if (progress_track[i].visited)
136 progress_track[i].visited = 1;
137 printf("..%d%%", sofar);
143 blk_write(struct dumperinfo *di, char *ptr, vm_paddr_t pa, size_t sz)
149 maxdumpsz = min(di->maxiosize, MAXDUMPPGS * PAGE_SIZE);
150 if (maxdumpsz == 0) /* seatbelt */
151 maxdumpsz = PAGE_SIZE;
153 if ((sz % PAGE_SIZE) != 0) {
154 printf("size not page aligned\n");
157 if (ptr != NULL && pa != 0) {
158 printf("cant have both va and pa!\n");
161 if ((((uintptr_t)pa) % PAGE_SIZE) != 0) {
162 printf("address not page aligned %p\n", ptr);
166 /* If we're doing a virtual dump, flush any pre-existing pa pages */
167 error = blk_flush(di);
172 len = maxdumpsz - fragsz;
178 report_progress(progress, dumpsize);
179 counter &= (1<<24) - 1;
182 wdog_kern_pat(WD_LASTVAL);
185 error = dump_write(di, ptr, 0, dumplo, len);
192 for (i = 0; i < len; i += PAGE_SIZE)
193 dump_va = pmap_kenter_temporary(pa + i, (i + fragsz) >> PAGE_SHIFT);
197 if (fragsz == maxdumpsz) {
198 error = blk_flush(di);
204 /* Check for user abort. */
209 printf(" (CTRL-C to abort) ");
215 /* A fake page table page, to avoid having to handle both 4K and 2M pages */
216 static pd_entry_t fakepd[NPDEPG];
219 minidumpsys(struct dumperinfo *di)
225 uint64_t *pml4, *pdp, *pd, *pt, pa;
226 int i, ii, j, k, n, bit;
228 struct minidumphdr mdhdr;
234 for (i = 0; i < nitems(progress_track); i++)
235 progress_track[i].visited = 0;
236 /* Walk page table pages, set bits in vm_page_dump */
238 for (va = VM_MIN_KERNEL_ADDRESS; va < MAX(KERNBASE + nkpt * NBPDR,
241 * We always write a page, even if it is zero. Each
242 * page written corresponds to 1GB of space
244 pmapsize += PAGE_SIZE;
245 ii = pmap_pml4e_index(va);
246 pml4 = (uint64_t *)PHYS_TO_DMAP(KPML4phys) + ii;
247 pdp = (uint64_t *)PHYS_TO_DMAP(*pml4 & PG_FRAME);
248 i = pmap_pdpe_index(va);
249 if ((pdp[i] & PG_V) == 0) {
255 * 1GB page is represented as 512 2MB pages in a dump.
257 if ((pdp[i] & PG_PS) != 0) {
259 pa = pdp[i] & PG_PS_FRAME;
260 for (n = 0; n < NPDEPG * NPTEPG; n++) {
268 pd = (uint64_t *)PHYS_TO_DMAP(pdp[i] & PG_FRAME);
269 for (n = 0; n < NPDEPG; n++, va += NBPDR) {
270 j = pmap_pde_index(va);
272 if ((pd[j] & PG_V) == 0)
275 if ((pd[j] & PG_PS) != 0) {
276 /* This is an entire 2M page. */
277 pa = pd[j] & PG_PS_FRAME;
278 for (k = 0; k < NPTEPG; k++) {
286 pa = pd[j] & PG_FRAME;
287 /* set bit for this PTE page */
290 /* and for each valid page in this 2MB block */
291 pt = (uint64_t *)PHYS_TO_DMAP(pd[j] & PG_FRAME);
292 for (k = 0; k < NPTEPG; k++) {
293 if ((pt[k] & PG_V) == 0)
295 pa = pt[k] & PG_FRAME;
302 /* Calculate dump size. */
304 dumpsize += round_page(msgbufp->msg_size);
305 dumpsize += round_page(vm_page_dump_size);
306 for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
307 bits = vm_page_dump[i];
310 pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) + bit) * PAGE_SIZE;
311 /* Clear out undumpable pages now if needed */
312 if (is_dumpable(pa)) {
313 dumpsize += PAGE_SIZE;
317 bits &= ~(1ul << bit);
320 dumpsize += PAGE_SIZE;
322 /* Determine dump offset on device. */
323 if (di->mediasize < SIZEOF_METADATA + dumpsize + di->blocksize * 2 +
324 kerneldumpcrypto_dumpkeysize(di->kdc)) {
328 dumplo = di->mediaoffset + di->mediasize - dumpsize;
329 dumplo -= di->blocksize * 2;
330 dumplo -= kerneldumpcrypto_dumpkeysize(di->kdc);
333 /* Initialize kernel dump crypto. */
334 error = kerneldumpcrypto_init(di->kdc);
338 /* Initialize mdhdr */
339 bzero(&mdhdr, sizeof(mdhdr));
340 strcpy(mdhdr.magic, MINIDUMP_MAGIC);
341 mdhdr.version = MINIDUMP_VERSION;
342 mdhdr.msgbufsize = msgbufp->msg_size;
343 mdhdr.bitmapsize = vm_page_dump_size;
344 mdhdr.pmapsize = pmapsize;
345 mdhdr.kernbase = VM_MIN_KERNEL_ADDRESS;
346 mdhdr.dmapbase = DMAP_MIN_ADDRESS;
347 mdhdr.dmapend = DMAP_MAX_ADDRESS;
349 mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_AMD64_VERSION, dumpsize,
350 kerneldumpcrypto_dumpkeysize(di->kdc), di->blocksize);
352 printf("Dumping %llu out of %ju MB:", (long long)dumpsize >> 20,
353 ptoa((uintmax_t)physmem) / 1048576);
356 error = dump_write_header(di, &kdh, 0, dumplo);
359 dumplo += di->blocksize;
362 error = dump_write_key(di, 0, dumplo);
365 dumplo += kerneldumpcrypto_dumpkeysize(di->kdc);
368 bzero(&fakepd, sizeof(fakepd));
369 bcopy(&mdhdr, &fakepd, sizeof(mdhdr));
370 error = blk_write(di, (char *)&fakepd, 0, PAGE_SIZE);
374 /* Dump msgbuf up front */
375 error = blk_write(di, (char *)msgbufp->msg_ptr, 0, round_page(msgbufp->msg_size));
380 error = blk_write(di, (char *)vm_page_dump, 0, round_page(vm_page_dump_size));
384 /* Dump kernel page directory pages */
385 bzero(fakepd, sizeof(fakepd));
386 for (va = VM_MIN_KERNEL_ADDRESS; va < MAX(KERNBASE + nkpt * NBPDR,
387 kernel_vm_end); va += NBPDP) {
388 ii = pmap_pml4e_index(va);
389 pml4 = (uint64_t *)PHYS_TO_DMAP(KPML4phys) + ii;
390 pdp = (uint64_t *)PHYS_TO_DMAP(*pml4 & PG_FRAME);
391 i = pmap_pdpe_index(va);
393 /* We always write a page, even if it is zero */
394 if ((pdp[i] & PG_V) == 0) {
395 error = blk_write(di, (char *)&fakepd, 0, PAGE_SIZE);
398 /* flush, in case we reuse fakepd in the same block */
399 error = blk_flush(di);
405 /* 1GB page is represented as 512 2MB pages in a dump */
406 if ((pdp[i] & PG_PS) != 0) {
407 /* PDPE and PDP have identical layout in this case */
409 for (j = 1; j < NPDEPG; j++)
410 fakepd[j] = fakepd[j - 1] + NBPDR;
411 error = blk_write(di, (char *)&fakepd, 0, PAGE_SIZE);
414 /* flush, in case we reuse fakepd in the same block */
415 error = blk_flush(di);
418 bzero(fakepd, sizeof(fakepd));
422 pd = (uint64_t *)PHYS_TO_DMAP(pdp[i] & PG_FRAME);
423 error = blk_write(di, (char *)pd, 0, PAGE_SIZE);
426 error = blk_flush(di);
431 /* Dump memory chunks */
432 /* XXX cluster it up and use blk_dump() */
433 for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
434 bits = vm_page_dump[i];
437 pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) + bit) * PAGE_SIZE;
438 error = blk_write(di, 0, pa, PAGE_SIZE);
441 bits &= ~(1ul << bit);
445 error = blk_flush(di);
450 error = dump_write_header(di, &kdh, 0, dumplo);
453 dumplo += di->blocksize;
455 /* Signal completion, signoff and exit stage left. */
456 dump_write(di, NULL, 0, 0, 0);
457 printf("\nDump complete\n");
465 if (error == ENOSPC) {
466 printf("Dump map grown while dumping. ");
467 if (retry_count < dump_retry_count) {
468 printf("Retrying...\n");
471 printf("Dump failed.\n");
473 else if (error == ECANCELED)
474 printf("Dump aborted\n");
475 else if (error == E2BIG)
476 printf("Dump failed. Partition too small.\n");
478 printf("** DUMP FAILED (ERROR %d) **\n", error);
483 dump_add_page(vm_paddr_t pa)
488 idx = pa >> 6; /* 2^6 = 64 */
490 atomic_set_long(&vm_page_dump[idx], 1ul << bit);
494 dump_drop_page(vm_paddr_t pa)
499 idx = pa >> 6; /* 2^6 = 64 */
501 atomic_clear_long(&vm_page_dump[idx], 1ul << bit);