sys/amd64/amd64/minidump_machdep.c

   1 /*-
   2  * Copyright (c) 2006 Peter Wemm
   3  * All rights reserved.
   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  *
   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.
  14  *
  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.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_pmap.h"
  31 #include "opt_watchdog.h"
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/conf.h>
  36 #include <sys/cons.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>
  42 #include <vm/vm.h>
  43 #include <vm/vm_param.h>
  44 #include <vm/vm_page.h>
  45 #include <vm/vm_phys.h>
  46 #include <vm/pmap.h>
  47 #include <machine/atomic.h>
  48 #include <machine/elf.h>
  49 #include <machine/md_var.h>
  50 #include <machine/minidump.h>
  51
  52 CTASSERT(sizeof(struct kerneldumpheader) == 512);
  53
  54 /*
  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.
  57  */
  58 #define SIZEOF_METADATA         (64*1024)
  59
  60 uint64_t *vm_page_dump;
  61 int vm_page_dump_size;
  62
  63 static struct kerneldumpheader kdh;
  64 static off_t dumplo;
  65
  66 /* Handle chunked writes. */
  67 static size_t fragsz;
  68 static void *dump_va;
  69 static size_t counter, progress, dumpsize;
  70
  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");
  75
  76 static int
  77 is_dumpable(vm_paddr_t pa)
  78 {
  79         vm_page_t m;
  80         int i;
  81
  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])
  86                         return (1);
  87         }
  88         return (0);
  89 }
  90
  91 #define PG2MB(pgs) (((pgs) + (1 << 8) - 1) >> 8)
  92
  93 static int
  94 blk_flush(struct dumperinfo *di)
  95 {
  96         int error;
  97
  98         if (fragsz == 0)
  99                 return (0);
 100
 101         error = dump_write(di, dump_va, 0, dumplo, fragsz);
 102         dumplo += fragsz;
 103         fragsz = 0;
 104         return (error);
 105 }
 106
 107 static struct {
 108         int min_per;
 109         int max_per;
 110         int visited;
 111 } progress_track[10] = {
 112         {  0,  10, 0},
 113         { 10,  20, 0},
 114         { 20,  30, 0},
 115         { 30,  40, 0},
 116         { 40,  50, 0},
 117         { 50,  60, 0},
 118         { 60,  70, 0},
 119         { 70,  80, 0},
 120         { 80,  90, 0},
 121         { 90, 100, 0}
 122 };
 123
 124 static void
 125 report_progress(size_t progress, size_t dumpsize)
 126 {
 127         int sofar, i;
 128
 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)
 133                         continue;
 134                 if (progress_track[i].visited)
 135                         return;
 136                 progress_track[i].visited = 1;
 137                 printf("..%d%%", sofar);
 138                 return;
 139         }
 140 }
 141
 142 static int
 143 blk_write(struct dumperinfo *di, char *ptr, vm_paddr_t pa, size_t sz)
 144 {
 145         size_t len;
 146         int error, i, c;
 147         u_int maxdumpsz;
 148
 149         maxdumpsz = min(di->maxiosize, MAXDUMPPGS * PAGE_SIZE);
 150         if (maxdumpsz == 0)     /* seatbelt */
 151                 maxdumpsz = PAGE_SIZE;
 152         error = 0;
 153         if ((sz % PAGE_SIZE) != 0) {
 154                 printf("size not page aligned\n");
 155                 return (EINVAL);
 156         }
 157         if (ptr != NULL && pa != 0) {
 158                 printf("cant have both va and pa!\n");
 159                 return (EINVAL);
 160         }
 161         if ((((uintptr_t)pa) % PAGE_SIZE) != 0) {
 162                 printf("address not page aligned %p\n", ptr);
 163                 return (EINVAL);
 164         }
 165         if (ptr != NULL) {
 166                 /* If we're doing a virtual dump, flush any pre-existing pa pages */
 167                 error = blk_flush(di);
 168                 if (error)
 169                         return (error);
 170         }
 171         while (sz) {
 172                 len = maxdumpsz - fragsz;
 173                 if (len > sz)
 174                         len = sz;
 175                 counter += len;
 176                 progress -= len;
 177                 if (counter >> 24) {
 178                         report_progress(progress, dumpsize);
 179                         counter &= (1<<24) - 1;
 180                 }
 181
 182                 wdog_kern_pat(WD_LASTVAL);
 183
 184                 if (ptr) {
 185                         error = dump_write(di, ptr, 0, dumplo, len);
 186                         if (error)
 187                                 return (error);
 188                         dumplo += len;
 189                         ptr += len;
 190                         sz -= len;
 191                 } else {
 192                         for (i = 0; i < len; i += PAGE_SIZE)
 193                                 dump_va = pmap_kenter_temporary(pa + i, (i + fragsz) >> PAGE_SHIFT);
 194                         fragsz += len;
 195                         pa += len;
 196                         sz -= len;
 197                         if (fragsz == maxdumpsz) {
 198                                 error = blk_flush(di);
 199                                 if (error)
 200                                         return (error);
 201                         }
 202                 }
 203
 204                 /* Check for user abort. */
 205                 c = cncheckc();
 206                 if (c == 0x03)
 207                         return (ECANCELED);
 208                 if (c != -1)
 209                         printf(" (CTRL-C to abort) ");
 210         }
 211
 212         return (0);
 213 }
 214
 215 /* A fake page table page, to avoid having to handle both 4K and 2M pages */
 216 static pd_entry_t fakepd[NPDEPG];
 217
 218 int
 219 minidumpsys(struct dumperinfo *di)
 220 {
 221         uint32_t pmapsize;
 222         vm_offset_t va;
 223         int error;
 224         uint64_t bits;
 225         uint64_t *pml4, *pdp, *pd, *pt, pa;
 226         size_t size;
 227         int i, ii, j, k, n, bit;
 228         int retry_count;
 229         struct minidumphdr mdhdr;
 230
 231         retry_count = 0;
 232  retry:
 233         retry_count++;
 234         counter = 0;
 235         for (i = 0; i < nitems(progress_track); i++)
 236                 progress_track[i].visited = 0;
 237         /* Walk page table pages, set bits in vm_page_dump */
 238         pmapsize = 0;
 239         for (va = VM_MIN_KERNEL_ADDRESS; va < MAX(KERNBASE + nkpt * NBPDR,
 240             kernel_vm_end); ) {
 241                 /*
 242                  * We always write a page, even if it is zero. Each
 243                  * page written corresponds to 1GB of space
 244                  */
 245                 pmapsize += PAGE_SIZE;
 246                 ii = pmap_pml4e_index(va);
 247                 pml4 = (uint64_t *)PHYS_TO_DMAP(KPML4phys) + ii;
 248                 pdp = (uint64_t *)PHYS_TO_DMAP(*pml4 & PG_FRAME);
 249                 i = pmap_pdpe_index(va);
 250                 if ((pdp[i] & PG_V) == 0) {
 251                         va += NBPDP;
 252                         continue;
 253                 }
 254
 255                 /*
 256                  * 1GB page is represented as 512 2MB pages in a dump.
 257                  */
 258                 if ((pdp[i] & PG_PS) != 0) {
 259                         va += NBPDP;
 260                         pa = pdp[i] & PG_PS_FRAME;
 261                         for (n = 0; n < NPDEPG * NPTEPG; n++) {
 262                                 if (is_dumpable(pa))
 263                                         dump_add_page(pa);
 264                                 pa += PAGE_SIZE;
 265                         }
 266                         continue;
 267                 }
 268
 269                 pd = (uint64_t *)PHYS_TO_DMAP(pdp[i] & PG_FRAME);
 270                 for (n = 0; n < NPDEPG; n++, va += NBPDR) {
 271                         j = pmap_pde_index(va);
 272
 273                         if ((pd[j] & PG_V) == 0)
 274                                 continue;
 275
 276                         if ((pd[j] & PG_PS) != 0) {
 277                                 /* This is an entire 2M page. */
 278                                 pa = pd[j] & PG_PS_FRAME;
 279                                 for (k = 0; k < NPTEPG; k++) {
 280                                         if (is_dumpable(pa))
 281                                                 dump_add_page(pa);
 282                                         pa += PAGE_SIZE;
 283                                 }
 284                                 continue;
 285                         }
 286
 287                         pa = pd[j] & PG_FRAME;
 288                         /* set bit for this PTE page */
 289                         if (is_dumpable(pa))
 290                                 dump_add_page(pa);
 291                         /* and for each valid page in this 2MB block */
 292                         pt = (uint64_t *)PHYS_TO_DMAP(pd[j] & PG_FRAME);
 293                         for (k = 0; k < NPTEPG; k++) {
 294                                 if ((pt[k] & PG_V) == 0)
 295                                         continue;
 296                                 pa = pt[k] & PG_FRAME;
 297                                 if (is_dumpable(pa))
 298                                         dump_add_page(pa);
 299                         }
 300                 }
 301         }
 302
 303         /* Calculate dump size. */
 304         dumpsize = pmapsize;
 305         dumpsize += round_page(msgbufp->msg_size);
 306         dumpsize += round_page(vm_page_dump_size);
 307         for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
 308                 bits = vm_page_dump[i];
 309                 while (bits) {
 310                         bit = bsfq(bits);
 311                         pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) + bit) * PAGE_SIZE;
 312                         /* Clear out undumpable pages now if needed */
 313                         if (is_dumpable(pa)) {
 314                                 dumpsize += PAGE_SIZE;
 315                         } else {
 316                                 dump_drop_page(pa);
 317                         }
 318                         bits &= ~(1ul << bit);
 319                 }
 320         }
 321         dumpsize += PAGE_SIZE;
 322
 323         /* Determine dump offset on device. */
 324         if (di->mediasize < SIZEOF_METADATA + dumpsize + di->blocksize * 2) {
 325                 error = E2BIG;
 326                 goto fail;
 327         }
 328         dumplo = di->mediaoffset + di->mediasize - dumpsize;
 329         dumplo -= di->blocksize * 2;
 330         progress = dumpsize;
 331
 332         /* Initialize mdhdr */
 333         bzero(&mdhdr, sizeof(mdhdr));
 334         strcpy(mdhdr.magic, MINIDUMP_MAGIC);
 335         mdhdr.version = MINIDUMP_VERSION;
 336         mdhdr.msgbufsize = msgbufp->msg_size;
 337         mdhdr.bitmapsize = vm_page_dump_size;
 338         mdhdr.pmapsize = pmapsize;
 339         mdhdr.kernbase = VM_MIN_KERNEL_ADDRESS;
 340         mdhdr.dmapbase = DMAP_MIN_ADDRESS;
 341         mdhdr.dmapend = DMAP_MAX_ADDRESS;
 342
 343         mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_AMD64_VERSION, dumpsize, di->blocksize);
 344
 345         printf("Dumping %llu out of %ju MB:", (long long)dumpsize >> 20,
 346             ptoa((uintmax_t)physmem) / 1048576);
 347
 348         /* Dump leader */
 349         error = dump_write_pad(di, &kdh, 0, dumplo, sizeof(kdh), &size);
 350         if (error)
 351                 goto fail;
 352         dumplo += size;
 353
 354         /* Dump my header */
 355         bzero(&fakepd, sizeof(fakepd));
 356         bcopy(&mdhdr, &fakepd, sizeof(mdhdr));
 357         error = blk_write(di, (char *)&fakepd, 0, PAGE_SIZE);
 358         if (error)
 359                 goto fail;
 360
 361         /* Dump msgbuf up front */
 362         error = blk_write(di, (char *)msgbufp->msg_ptr, 0, round_page(msgbufp->msg_size));
 363         if (error)
 364                 goto fail;
 365
 366         /* Dump bitmap */
 367         error = blk_write(di, (char *)vm_page_dump, 0, round_page(vm_page_dump_size));
 368         if (error)
 369                 goto fail;
 370
 371         /* Dump kernel page directory pages */
 372         bzero(fakepd, sizeof(fakepd));
 373         for (va = VM_MIN_KERNEL_ADDRESS; va < MAX(KERNBASE + nkpt * NBPDR,
 374             kernel_vm_end); va += NBPDP) {
 375                 ii = pmap_pml4e_index(va);
 376                 pml4 = (uint64_t *)PHYS_TO_DMAP(KPML4phys) + ii;
 377                 pdp = (uint64_t *)PHYS_TO_DMAP(*pml4 & PG_FRAME);
 378                 i = pmap_pdpe_index(va);
 379
 380                 /* We always write a page, even if it is zero */
 381                 if ((pdp[i] & PG_V) == 0) {
 382                         error = blk_write(di, (char *)&fakepd, 0, PAGE_SIZE);
 383                         if (error)
 384                                 goto fail;
 385                         /* flush, in case we reuse fakepd in the same block */
 386                         error = blk_flush(di);
 387                         if (error)
 388                                 goto fail;
 389                         continue;
 390                 }
 391
 392                 /* 1GB page is represented as 512 2MB pages in a dump */
 393                 if ((pdp[i] & PG_PS) != 0) {
 394                         /* PDPE and PDP have identical layout in this case */
 395                         fakepd[0] = pdp[i];
 396                         for (j = 1; j < NPDEPG; j++)
 397                                 fakepd[j] = fakepd[j - 1] + NBPDR;
 398                         error = blk_write(di, (char *)&fakepd, 0, PAGE_SIZE);
 399                         if (error)
 400                                 goto fail;
 401                         /* flush, in case we reuse fakepd in the same block */
 402                         error = blk_flush(di);
 403                         if (error)
 404                                 goto fail;
 405                         bzero(fakepd, sizeof(fakepd));
 406                         continue;
 407                 }
 408
 409                 pd = (uint64_t *)PHYS_TO_DMAP(pdp[i] & PG_FRAME);
 410                 error = blk_write(di, (char *)pd, 0, PAGE_SIZE);
 411                 if (error)
 412                         goto fail;
 413                 error = blk_flush(di);
 414                 if (error)
 415                         goto fail;
 416         }
 417
 418         /* Dump memory chunks */
 419         /* XXX cluster it up and use blk_dump() */
 420         for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
 421                 bits = vm_page_dump[i];
 422                 while (bits) {
 423                         bit = bsfq(bits);
 424                         pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) + bit) * PAGE_SIZE;
 425                         error = blk_write(di, 0, pa, PAGE_SIZE);
 426                         if (error)
 427                                 goto fail;
 428                         bits &= ~(1ul << bit);
 429                 }
 430         }
 431
 432         error = blk_flush(di);
 433         if (error)
 434                 goto fail;
 435
 436         /* Dump trailer */
 437         error = dump_write_pad(di, &kdh, 0, dumplo, sizeof(kdh), &size);
 438         if (error)
 439                 goto fail;
 440         dumplo += size;
 441
 442         /* Signal completion, signoff and exit stage left. */
 443         dump_write(di, NULL, 0, 0, 0);
 444         printf("\nDump complete\n");
 445         return (0);
 446
 447  fail:
 448         if (error < 0)
 449                 error = -error;
 450
 451         printf("\n");
 452         if (error == ENOSPC) {
 453                 printf("Dump map grown while dumping. ");
 454                 if (retry_count < dump_retry_count) {
 455                         printf("Retrying...\n");
 456                         goto retry;
 457                 }
 458                 printf("Dump failed.\n");
 459         }
 460         else if (error == ECANCELED)
 461                 printf("Dump aborted\n");
 462         else if (error == E2BIG)
 463                 printf("Dump failed. Partition too small.\n");
 464         else
 465                 printf("** DUMP FAILED (ERROR %d) **\n", error);
 466         return (error);
 467 }
 468
 469 void
 470 dump_add_page(vm_paddr_t pa)
 471 {
 472         int idx, bit;
 473
 474         pa >>= PAGE_SHIFT;
 475         idx = pa >> 6;          /* 2^6 = 64 */
 476         bit = pa & 63;
 477         atomic_set_long(&vm_page_dump[idx], 1ul << bit);
 478 }
 479
 480 void
 481 dump_drop_page(vm_paddr_t pa)
 482 {
 483         int idx, bit;
 484
 485         pa >>= PAGE_SHIFT;
 486         idx = pa >> 6;          /* 2^6 = 64 */
 487         bit = pa & 63;
 488         atomic_clear_long(&vm_page_dump[idx], 1ul << bit);
 489 }