sys/i386/i386/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_watchdog.h"
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/conf.h>
  35 #include <sys/cons.h>
  36 #include <sys/kernel.h>
  37 #include <sys/kerneldump.h>
  38 #include <sys/msgbuf.h>
  39 #include <sys/watchdog.h>
  40 #include <vm/vm.h>
  41 #include <vm/pmap.h>
  42 #include <machine/atomic.h>
  43 #include <machine/elf.h>
  44 #include <machine/md_var.h>
  45 #include <machine/vmparam.h>
  46 #include <machine/minidump.h>
  47
  48 CTASSERT(sizeof(struct kerneldumpheader) == 512);
  49
  50 #define MD_ALIGN(x)     (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
  51 #define DEV_ALIGN(x)    roundup2((off_t)(x), DEV_BSIZE)
  52
  53 uint32_t *vm_page_dump;
  54 int vm_page_dump_size;
  55
  56 static struct kerneldumpheader kdh;
  57 static off_t dumplo;
  58
  59 /* Handle chunked writes. */
  60 static size_t fragsz;
  61 static void *dump_va;
  62 static uint64_t counter, progress;
  63
  64 CTASSERT(sizeof(*vm_page_dump) == 4);
  65
  66
  67 static int
  68 is_dumpable(vm_paddr_t pa)
  69 {
  70         int i;
  71
  72         for (i = 0; dump_avail[i] != 0 || dump_avail[i + 1] != 0; i += 2) {
  73                 if (pa >= dump_avail[i] && pa < dump_avail[i + 1])
  74                         return (1);
  75         }
  76         return (0);
  77 }
  78
  79 #define PG2MB(pgs) (((pgs) + (1 << 8) - 1) >> 8)
  80
  81 static int
  82 blk_flush(struct dumperinfo *di)
  83 {
  84         int error;
  85
  86         if (fragsz == 0)
  87                 return (0);
  88
  89         error = dump_write(di, dump_va, 0, dumplo, fragsz);
  90         dumplo += fragsz;
  91         fragsz = 0;
  92         return (error);
  93 }
  94
  95 static int
  96 blk_write(struct dumperinfo *di, char *ptr, vm_paddr_t pa, size_t sz)
  97 {
  98         size_t len;
  99         int error, i, c;
 100         u_int maxdumpsz;
 101
 102         maxdumpsz = min(di->maxiosize, MAXDUMPPGS * PAGE_SIZE);
 103         if (maxdumpsz == 0)     /* seatbelt */
 104                 maxdumpsz = PAGE_SIZE;
 105         error = 0;
 106         if ((sz % PAGE_SIZE) != 0) {
 107                 printf("size not page aligned\n");
 108                 return (EINVAL);
 109         }
 110         if (ptr != NULL && pa != 0) {
 111                 printf("cant have both va and pa!\n");
 112                 return (EINVAL);
 113         }
 114         if (pa != 0 && (((uintptr_t)ptr) % PAGE_SIZE) != 0) {
 115                 printf("address not page aligned\n");
 116                 return (EINVAL);
 117         }
 118         if (ptr != NULL) {
 119                 /* If we're doing a virtual dump, flush any pre-existing pa pages */
 120                 error = blk_flush(di);
 121                 if (error)
 122                         return (error);
 123         }
 124         while (sz) {
 125                 len = maxdumpsz - fragsz;
 126                 if (len > sz)
 127                         len = sz;
 128                 counter += len;
 129                 progress -= len;
 130                 if (counter >> 24) {
 131                         printf(" %lld", PG2MB(progress >> PAGE_SHIFT));
 132                         counter &= (1<<24) - 1;
 133                 }
 134
 135                 wdog_kern_pat(WD_LASTVAL);
 136
 137                 if (ptr) {
 138                         error = dump_write(di, ptr, 0, dumplo, len);
 139                         if (error)
 140                                 return (error);
 141                         dumplo += len;
 142                         ptr += len;
 143                         sz -= len;
 144                 } else {
 145                         for (i = 0; i < len; i += PAGE_SIZE)
 146                                 dump_va = pmap_kenter_temporary(pa + i, (i + fragsz) >> PAGE_SHIFT);
 147                         fragsz += len;
 148                         pa += len;
 149                         sz -= len;
 150                         if (fragsz == maxdumpsz) {
 151                                 error = blk_flush(di);
 152                                 if (error)
 153                                         return (error);
 154                         }
 155                 }
 156
 157                 /* Check for user abort. */
 158                 c = cncheckc();
 159                 if (c == 0x03)
 160                         return (ECANCELED);
 161                 if (c != -1)
 162                         printf(" (CTRL-C to abort) ");
 163         }
 164
 165         return (0);
 166 }
 167
 168 /* A fake page table page, to avoid having to handle both 4K and 2M pages */
 169 static pt_entry_t fakept[NPTEPG];
 170
 171 int
 172 minidumpsys(struct dumperinfo *di)
 173 {
 174         uint64_t dumpsize;
 175         uint32_t ptesize;
 176         vm_offset_t va;
 177         int error;
 178         uint32_t bits;
 179         uint64_t pa;
 180         pd_entry_t *pd;
 181         pt_entry_t *pt;
 182         int i, j, k, bit;
 183         struct minidumphdr mdhdr;
 184
 185         counter = 0;
 186         /* Walk page table pages, set bits in vm_page_dump */
 187         ptesize = 0;
 188         for (va = KERNBASE; va < kernel_vm_end; va += NBPDR) {
 189                 /*
 190                  * We always write a page, even if it is zero. Each
 191                  * page written corresponds to 2MB of space
 192                  */
 193                 ptesize += PAGE_SIZE;
 194                 pd = (pd_entry_t *)((uintptr_t)IdlePTD + KERNBASE);     /* always mapped! */
 195                 j = va >> PDRSHIFT;
 196                 if ((pd[j] & (PG_PS | PG_V)) == (PG_PS | PG_V))  {
 197                         /* This is an entire 2M page. */
 198                         pa = pd[j] & PG_PS_FRAME;
 199                         for (k = 0; k < NPTEPG; k++) {
 200                                 if (is_dumpable(pa))
 201                                         dump_add_page(pa);
 202                                 pa += PAGE_SIZE;
 203                         }
 204                         continue;
 205                 }
 206                 if ((pd[j] & PG_V) == PG_V) {
 207                         /* set bit for each valid page in this 2MB block */
 208                         pt = pmap_kenter_temporary(pd[j] & PG_FRAME, 0);
 209                         for (k = 0; k < NPTEPG; k++) {
 210                                 if ((pt[k] & PG_V) == PG_V) {
 211                                         pa = pt[k] & PG_FRAME;
 212                                         if (is_dumpable(pa))
 213                                                 dump_add_page(pa);
 214                                 }
 215                         }
 216                 } else {
 217                         /* nothing, we're going to dump a null page */
 218                 }
 219         }
 220
 221         /* Calculate dump size. */
 222         dumpsize = ptesize;
 223         dumpsize += round_page(msgbufp->msg_size);
 224         dumpsize += round_page(vm_page_dump_size);
 225         for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
 226                 bits = vm_page_dump[i];
 227                 while (bits) {
 228                         bit = bsfl(bits);
 229                         pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) + bit) * PAGE_SIZE;
 230                         /* Clear out undumpable pages now if needed */
 231                         if (is_dumpable(pa)) {
 232                                 dumpsize += PAGE_SIZE;
 233                         } else {
 234                                 dump_drop_page(pa);
 235                         }
 236                         bits &= ~(1ul << bit);
 237                 }
 238         }
 239         dumpsize += PAGE_SIZE;
 240
 241         progress = dumpsize;
 242
 243         /* Initialize mdhdr */
 244         bzero(&mdhdr, sizeof(mdhdr));
 245         strcpy(mdhdr.magic, MINIDUMP_MAGIC);
 246         mdhdr.version = MINIDUMP_VERSION;
 247         mdhdr.msgbufsize = msgbufp->msg_size;
 248         mdhdr.bitmapsize = vm_page_dump_size;
 249         mdhdr.ptesize = ptesize;
 250         mdhdr.kernbase = KERNBASE;
 251 #if defined(PAE) || defined(PAE_TABLES)
 252         mdhdr.paemode = 1;
 253 #endif
 254
 255         dump_init_header(di, &kdh, KERNELDUMPMAGIC, KERNELDUMP_I386_VERSION,
 256             dumpsize);
 257
 258         printf("Physical memory: %ju MB\n", ptoa((uintmax_t)physmem) / 1048576);
 259         printf("Dumping %llu MB:", (long long)dumpsize >> 20);
 260
 261         error = dump_start(di, &kdh, &dumplo);
 262         if (error != 0)
 263                 goto fail;
 264
 265         /* Dump my header */
 266         bzero(&fakept, sizeof(fakept));
 267         bcopy(&mdhdr, &fakept, sizeof(mdhdr));
 268         error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
 269         if (error)
 270                 goto fail;
 271
 272         /* Dump msgbuf up front */
 273         error = blk_write(di, (char *)msgbufp->msg_ptr, 0, round_page(msgbufp->msg_size));
 274         if (error)
 275                 goto fail;
 276
 277         /* Dump bitmap */
 278         error = blk_write(di, (char *)vm_page_dump, 0, round_page(vm_page_dump_size));
 279         if (error)
 280                 goto fail;
 281
 282         /* Dump kernel page table pages */
 283         for (va = KERNBASE; va < kernel_vm_end; va += NBPDR) {
 284                 /* We always write a page, even if it is zero */
 285                 pd = (pd_entry_t *)((uintptr_t)IdlePTD + KERNBASE);     /* always mapped! */
 286                 j = va >> PDRSHIFT;
 287                 if ((pd[j] & (PG_PS | PG_V)) == (PG_PS | PG_V))  {
 288                         /* This is a single 2M block. Generate a fake PTP */
 289                         pa = pd[j] & PG_PS_FRAME;
 290                         for (k = 0; k < NPTEPG; k++) {
 291                                 fakept[k] = (pa + (k * PAGE_SIZE)) | PG_V | PG_RW | PG_A | PG_M;
 292                         }
 293                         error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
 294                         if (error)
 295                                 goto fail;
 296                         /* flush, in case we reuse fakept in the same block */
 297                         error = blk_flush(di);
 298                         if (error)
 299                                 goto fail;
 300                         continue;
 301                 }
 302                 if ((pd[j] & PG_V) == PG_V) {
 303                         pa = pd[j] & PG_FRAME;
 304                         error = blk_write(di, 0, pa, PAGE_SIZE);
 305                         if (error)
 306                                 goto fail;
 307                 } else {
 308                         bzero(fakept, sizeof(fakept));
 309                         error = blk_write(di, (char *)&fakept, 0, PAGE_SIZE);
 310                         if (error)
 311                                 goto fail;
 312                         /* flush, in case we reuse fakept in the same block */
 313                         error = blk_flush(di);
 314                         if (error)
 315                                 goto fail;
 316                 }
 317         }
 318
 319         /* Dump memory chunks */
 320         /* XXX cluster it up and use blk_dump() */
 321         for (i = 0; i < vm_page_dump_size / sizeof(*vm_page_dump); i++) {
 322                 bits = vm_page_dump[i];
 323                 while (bits) {
 324                         bit = bsfl(bits);
 325                         pa = (((uint64_t)i * sizeof(*vm_page_dump) * NBBY) + bit) * PAGE_SIZE;
 326                         error = blk_write(di, 0, pa, PAGE_SIZE);
 327                         if (error)
 328                                 goto fail;
 329                         bits &= ~(1ul << bit);
 330                 }
 331         }
 332
 333         error = blk_flush(di);
 334         if (error)
 335                 goto fail;
 336
 337         error = dump_finish(di, &kdh, dumplo);
 338         if (error != 0)
 339                 goto fail;
 340
 341         printf("\nDump complete\n");
 342         return (0);
 343
 344  fail:
 345         if (error < 0)
 346                 error = -error;
 347
 348         if (error == ECANCELED)
 349                 printf("\nDump aborted\n");
 350         else if (error == E2BIG || error == ENOSPC)
 351                 printf("\nDump failed. Partition too small.\n");
 352         else
 353                 printf("\n** DUMP FAILED (ERROR %d) **\n", error);
 354         return (error);
 355 }
 356
 357 void
 358 dump_add_page(vm_paddr_t pa)
 359 {
 360         int idx, bit;
 361
 362         pa >>= PAGE_SHIFT;
 363         idx = pa >> 5;          /* 2^5 = 32 */
 364         bit = pa & 31;
 365         atomic_set_int(&vm_page_dump[idx], 1ul << bit);
 366 }
 367
 368 void
 369 dump_drop_page(vm_paddr_t pa)
 370 {
 371         int idx, bit;
 372
 373         pa >>= PAGE_SHIFT;
 374         idx = pa >> 5;          /* 2^5 = 32 */
 375         bit = pa & 31;
 376         atomic_clear_int(&vm_page_dump[idx], 1ul << bit);
 377 }
 378