2 * Copyright (c) 2006 Peter Wemm
3 * Copyright (c) 2015 The FreeBSD Foundation
6 * This software was developed by Andrew Turner under
7 * sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include "opt_watchdog.h"
37 #include "opt_watchdog.h"
39 #include <sys/param.h>
40 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/kerneldump.h>
45 #include <sys/msgbuf.h>
46 #include <sys/watchdog.h>
47 #include <sys/vmmeter.h>
50 #include <vm/vm_param.h>
51 #include <vm/vm_page.h>
52 #include <vm/vm_phys.h>
55 #include <machine/md_var.h>
56 #include <machine/pte.h>
57 #include <machine/minidump.h>
59 CTASSERT(sizeof(struct kerneldumpheader) == 512);
61 uint64_t *vm_page_dump;
62 int vm_page_dump_size;
64 static struct kerneldumpheader kdh;
66 /* Handle chunked writes. */
69 static size_t counter, progress, dumpsize;
71 static uint64_t tmpbuffer[PAGE_SIZE / sizeof(uint64_t)];
73 CTASSERT(sizeof(*vm_page_dump) == 8);
76 is_dumpable(vm_paddr_t pa)
81 if ((m = vm_phys_paddr_to_vm_page(pa)) != NULL)
82 return ((m->flags & PG_NODUMP) == 0);
83 for (i = 0; dump_avail[i] != 0 || dump_avail[i + 1] != 0; i += 2) {
84 if (pa >= dump_avail[i] && pa < dump_avail[i + 1])
91 blk_flush(struct dumperinfo *di)
98 error = dump_append(di, dump_va, 0, fragsz);
107 } progress_track[10] = {
121 report_progress(size_t progress, size_t dumpsize)
125 sofar = 100 - ((progress * 100) / dumpsize);
126 for (i = 0; i < nitems(progress_track); i++) {
127 if (sofar < progress_track[i].min_per ||
128 sofar > progress_track[i].max_per)
130 if (progress_track[i].visited)
132 progress_track[i].visited = 1;
133 printf("..%d%%", sofar);
139 blk_write(struct dumperinfo *di, char *ptr, vm_paddr_t pa, size_t sz)
145 maxdumpsz = min(di->maxiosize, MAXDUMPPGS * PAGE_SIZE);
146 if (maxdumpsz == 0) /* seatbelt */
147 maxdumpsz = PAGE_SIZE;
149 if ((sz % PAGE_SIZE) != 0) {
150 printf("size not page aligned\n");
153 if (ptr != NULL && pa != 0) {
154 printf("cant have both va and pa!\n");
157 if ((((uintptr_t)pa) % PAGE_SIZE) != 0) {
158 printf("address not page aligned %p\n", ptr);
163 * If we're doing a virtual dump, flush any
164 * pre-existing pa pages.
166 error = blk_flush(di);
171 len = maxdumpsz - fragsz;
177 report_progress(progress, dumpsize);
178 counter &= (1 << 22) - 1;
181 wdog_kern_pat(WD_LASTVAL);
184 error = dump_append(di, ptr, 0, len);
190 dump_va = (void *)PHYS_TO_DMAP(pa);
194 error = blk_flush(di);
199 /* Check for user abort. */
204 printf(" (CTRL-C to abort) ");
211 minidumpsys(struct dumperinfo *di)
213 pd_entry_t *l0, *l1, *l2;
222 struct minidumphdr mdhdr;
229 for (va = VM_MIN_KERNEL_ADDRESS; va < kernel_vm_end; va += L2_SIZE) {
230 pmapsize += PAGE_SIZE;
231 if (!pmap_get_tables(pmap_kernel(), va, &l0, &l1, &l2, &l3))
234 /* We should always be using the l2 table for kvm */
238 if ((*l2 & ATTR_DESCR_MASK) == L2_BLOCK) {
239 pa = *l2 & ~ATTR_MASK;
240 for (i = 0; i < Ln_ENTRIES; i++, pa += PAGE_SIZE) {
244 } else if ((*l2 & ATTR_DESCR_MASK) == L2_TABLE) {
245 for (i = 0; i < Ln_ENTRIES; i++) {
246 if ((l3[i] & ATTR_DESCR_MASK) != L3_PAGE)
248 pa = l3[i] & ~ATTR_MASK;
255 /* Calculate dump size. */
257 dumpsize += round_page(msgbufp->msg_size);
258 dumpsize += round_page(vm_page_dump_size);
259 for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
260 bits = vm_page_dump[i];
262 bit = ffsl(bits) - 1;
263 pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) +
265 /* Clear out undumpable pages now if needed */
267 dumpsize += PAGE_SIZE;
270 bits &= ~(1ul << bit);
273 dumpsize += PAGE_SIZE;
277 /* Initialize mdhdr */
278 bzero(&mdhdr, sizeof(mdhdr));
279 strcpy(mdhdr.magic, MINIDUMP_MAGIC);
280 mdhdr.version = MINIDUMP_VERSION;
281 mdhdr.msgbufsize = msgbufp->msg_size;
282 mdhdr.bitmapsize = vm_page_dump_size;
283 mdhdr.pmapsize = pmapsize;
284 mdhdr.kernbase = VM_MIN_KERNEL_ADDRESS;
285 mdhdr.dmapphys = DMAP_MIN_PHYSADDR;
286 mdhdr.dmapbase = DMAP_MIN_ADDRESS;
287 mdhdr.dmapend = DMAP_MAX_ADDRESS;
289 dump_init_header(di, &kdh, KERNELDUMPMAGIC, KERNELDUMP_AARCH64_VERSION,
292 error = dump_start(di, &kdh);
296 printf("Dumping %llu out of %ju MB:", (long long)dumpsize >> 20,
297 ptoa((uintmax_t)physmem) / 1048576);
300 bzero(&tmpbuffer, sizeof(tmpbuffer));
301 bcopy(&mdhdr, &tmpbuffer, sizeof(mdhdr));
302 error = blk_write(di, (char *)&tmpbuffer, 0, PAGE_SIZE);
306 /* Dump msgbuf up front */
307 error = blk_write(di, (char *)msgbufp->msg_ptr, 0,
308 round_page(msgbufp->msg_size));
313 error = blk_write(di, (char *)vm_page_dump, 0,
314 round_page(vm_page_dump_size));
318 /* Dump kernel page directory pages */
319 bzero(&tmpbuffer, sizeof(tmpbuffer));
320 for (va = VM_MIN_KERNEL_ADDRESS; va < kernel_vm_end; va += L2_SIZE) {
321 if (!pmap_get_tables(pmap_kernel(), va, &l0, &l1, &l2, &l3)) {
322 /* We always write a page, even if it is zero */
323 error = blk_write(di, (char *)&tmpbuffer, 0, PAGE_SIZE);
326 /* flush, in case we reuse tmpbuffer in the same block*/
327 error = blk_flush(di);
330 } else if (l2 == NULL) {
331 pa = (*l1 & ~ATTR_MASK) | (va & L1_OFFSET);
333 /* Generate fake l3 entries based upon the l1 entry */
334 for (i = 0; i < Ln_ENTRIES; i++) {
335 tmpbuffer[i] = pa + (i * PAGE_SIZE) |
336 ATTR_DEFAULT | L3_PAGE;
338 /* We always write a page, even if it is zero */
339 error = blk_write(di, (char *)&tmpbuffer, 0, PAGE_SIZE);
342 /* flush, in case we reuse tmpbuffer in the same block*/
343 error = blk_flush(di);
346 bzero(&tmpbuffer, sizeof(tmpbuffer));
347 } else if ((*l2 & ATTR_DESCR_MASK) == L2_BLOCK) {
348 /* TODO: Handle an invalid L2 entry */
349 pa = (*l2 & ~ATTR_MASK) | (va & L2_OFFSET);
351 /* Generate fake l3 entries based upon the l1 entry */
352 for (i = 0; i < Ln_ENTRIES; i++) {
353 tmpbuffer[i] = pa + (i * PAGE_SIZE) |
354 ATTR_DEFAULT | L3_PAGE;
356 /* We always write a page, even if it is zero */
357 error = blk_write(di, (char *)&tmpbuffer, 0, PAGE_SIZE);
360 /* flush, in case we reuse fakepd in the same block */
361 error = blk_flush(di);
364 bzero(&tmpbuffer, sizeof(tmpbuffer));
367 pa = *l2 & ~ATTR_MASK;
369 /* We always write a page, even if it is zero */
370 error = blk_write(di, NULL, pa, PAGE_SIZE);
376 /* Dump memory chunks */
377 /* XXX cluster it up and use blk_dump() */
378 for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
379 bits = vm_page_dump[i];
381 bit = ffsl(bits) - 1;
382 pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) +
384 error = blk_write(di, 0, pa, PAGE_SIZE);
387 bits &= ~(1ul << bit);
391 error = blk_flush(di);
395 error = dump_finish(di, &kdh);
399 printf("\nDump complete\n");
407 if (error == ENOSPC) {
408 printf("Dump map grown while dumping. ");
409 if (retry_count < 5) {
410 printf("Retrying...\n");
413 printf("Dump failed.\n");
415 else if (error == ECANCELED)
416 printf("Dump aborted\n");
417 else if (error == E2BIG)
418 printf("Dump failed. Partition too small.\n");
420 printf("** DUMP FAILED (ERROR %d) **\n", error);
425 dump_add_page(vm_paddr_t pa)
430 idx = pa >> 6; /* 2^6 = 64 */
432 atomic_set_long(&vm_page_dump[idx], 1ul << bit);
436 dump_drop_page(vm_paddr_t pa)
441 idx = pa >> 6; /* 2^6 = 64 */
443 atomic_clear_long(&vm_page_dump[idx], 1ul << bit);