sys/kern/kern_dump.c

   1 /*-
   2  * Copyright (c) 2002 Marcel Moolenaar
   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 <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/conf.h>
  33 #include <sys/cons.h>
  34 #include <sys/kernel.h>
  35 #include <sys/proc.h>
  36 #include <sys/kerneldump.h>
  37 #include <sys/watchdog.h>
  38 #include <vm/vm.h>
  39 #include <vm/vm_param.h>
  40 #include <vm/vm_page.h>
  41 #include <vm/vm_phys.h>
  42 #include <vm/pmap.h>
  43 #include <machine/dump.h>
  44 #include <machine/elf.h>
  45 #include <machine/md_var.h>
  46 #include <machine/pcb.h>
  47
  48 CTASSERT(sizeof(struct kerneldumpheader) == 512);
  49
  50 #define MD_ALIGN(x)     roundup2((off_t)(x), PAGE_SIZE)
  51
  52 /* Handle buffered writes. */
  53 static size_t fragsz;
  54
  55 struct dump_pa dump_map[DUMPSYS_MD_PA_NPAIRS];
  56
  57 #if !defined(__powerpc__)
  58 void
  59 dumpsys_gen_pa_init(void)
  60 {
  61         int n, idx;
  62
  63         bzero(dump_map, sizeof(dump_map));
  64         for (n = 0; n < nitems(dump_map); n++) {
  65                 idx = n * 2;
  66                 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
  67                         break;
  68                 dump_map[n].pa_start = dump_avail[idx];
  69                 dump_map[n].pa_size = dump_avail[idx + 1] - dump_avail[idx];
  70         }
  71 }
  72 #endif
  73
  74 struct dump_pa *
  75 dumpsys_gen_pa_next(struct dump_pa *mdp)
  76 {
  77
  78         if (mdp == NULL)
  79                 return (&dump_map[0]);
  80
  81         mdp++;
  82         if (mdp->pa_size == 0)
  83                 mdp = NULL;
  84         return (mdp);
  85 }
  86
  87 void
  88 dumpsys_gen_wbinv_all(void)
  89 {
  90
  91 }
  92
  93 void
  94 dumpsys_gen_unmap_chunk(vm_paddr_t pa __unused, size_t chunk __unused,
  95     void *va __unused)
  96 {
  97
  98 }
  99
 100 int
 101 dumpsys_gen_write_aux_headers(struct dumperinfo *di)
 102 {
 103
 104         return (0);
 105 }
 106
 107 int
 108 dumpsys_buf_seek(struct dumperinfo *di, size_t sz)
 109 {
 110         static uint8_t buf[DEV_BSIZE];
 111         size_t nbytes;
 112         int error;
 113
 114         bzero(buf, sizeof(buf));
 115
 116         while (sz > 0) {
 117                 nbytes = MIN(sz, sizeof(buf));
 118
 119                 error = dump_append(di, buf, 0, nbytes);
 120                 if (error)
 121                         return (error);
 122                 sz -= nbytes;
 123         }
 124
 125         return (0);
 126 }
 127
 128 int
 129 dumpsys_buf_write(struct dumperinfo *di, char *ptr, size_t sz)
 130 {
 131         size_t len;
 132         int error;
 133
 134         while (sz) {
 135                 len = di->blocksize - fragsz;
 136                 if (len > sz)
 137                         len = sz;
 138                 memcpy((char *)di->blockbuf + fragsz, ptr, len);
 139                 fragsz += len;
 140                 ptr += len;
 141                 sz -= len;
 142                 if (fragsz == di->blocksize) {
 143                         error = dump_append(di, di->blockbuf, 0, di->blocksize);
 144                         if (error)
 145                                 return (error);
 146                         fragsz = 0;
 147                 }
 148         }
 149         return (0);
 150 }
 151
 152 int
 153 dumpsys_buf_flush(struct dumperinfo *di)
 154 {
 155         int error;
 156
 157         if (fragsz == 0)
 158                 return (0);
 159
 160         error = dump_append(di, di->blockbuf, 0, di->blocksize);
 161         fragsz = 0;
 162         return (error);
 163 }
 164
 165 CTASSERT(PAGE_SHIFT < 20);
 166 #define PG2MB(pgs) ((pgs + (1 << (20 - PAGE_SHIFT)) - 1) >> (20 - PAGE_SHIFT))
 167
 168 int
 169 dumpsys_cb_dumpdata(struct dump_pa *mdp, int seqnr, void *arg)
 170 {
 171         struct dumperinfo *di = (struct dumperinfo*)arg;
 172         vm_paddr_t pa;
 173         void *va;
 174         uint64_t pgs;
 175         size_t counter, sz, chunk;
 176         int c, error;
 177         u_int maxdumppgs;
 178
 179         error = 0;      /* catch case in which chunk size is 0 */
 180         counter = 0;    /* Update twiddle every 16MB */
 181         va = NULL;
 182         pgs = mdp->pa_size / PAGE_SIZE;
 183         pa = mdp->pa_start;
 184         maxdumppgs = min(di->maxiosize / PAGE_SIZE, MAXDUMPPGS);
 185         if (maxdumppgs == 0)    /* seatbelt */
 186                 maxdumppgs = 1;
 187
 188         printf("  chunk %d: %juMB (%ju pages)", seqnr, (uintmax_t)PG2MB(pgs),
 189             (uintmax_t)pgs);
 190
 191         dumpsys_wbinv_all();
 192         while (pgs) {
 193                 chunk = pgs;
 194                 if (chunk > maxdumppgs)
 195                         chunk = maxdumppgs;
 196                 sz = chunk << PAGE_SHIFT;
 197                 counter += sz;
 198                 if (counter >> 24) {
 199                         printf(" %ju", (uintmax_t)PG2MB(pgs));
 200                         counter &= (1 << 24) - 1;
 201                 }
 202
 203                 dumpsys_map_chunk(pa, chunk, &va);
 204                 wdog_kern_pat(WD_LASTVAL);
 205
 206                 error = dump_append(di, va, 0, sz);
 207                 dumpsys_unmap_chunk(pa, chunk, va);
 208                 if (error)
 209                         break;
 210                 pgs -= chunk;
 211                 pa += sz;
 212
 213                 /* Check for user abort. */
 214                 c = cncheckc();
 215                 if (c == 0x03)
 216                         return (ECANCELED);
 217                 if (c != -1)
 218                         printf(" (CTRL-C to abort) ");
 219         }
 220         printf(" ... %s\n", (error) ? "fail" : "ok");
 221         return (error);
 222 }
 223
 224 int
 225 dumpsys_foreach_chunk(dumpsys_callback_t cb, void *arg)
 226 {
 227         struct dump_pa *mdp;
 228         int error, seqnr;
 229
 230         seqnr = 0;
 231         mdp = dumpsys_pa_next(NULL);
 232         while (mdp != NULL) {
 233                 error = (*cb)(mdp, seqnr++, arg);
 234                 if (error)
 235                         return (-error);
 236                 mdp = dumpsys_pa_next(mdp);
 237         }
 238         return (seqnr);
 239 }
 240
 241 static off_t fileofs;
 242
 243 static int
 244 cb_dumphdr(struct dump_pa *mdp, int seqnr, void *arg)
 245 {
 246         struct dumperinfo *di = (struct dumperinfo*)arg;
 247         Elf_Phdr phdr;
 248         uint64_t size;
 249         int error;
 250
 251         size = mdp->pa_size;
 252         bzero(&phdr, sizeof(phdr));
 253         phdr.p_type = PT_LOAD;
 254         phdr.p_flags = PF_R;                    /* XXX */
 255         phdr.p_offset = fileofs;
 256 #ifdef __powerpc__
 257         phdr.p_vaddr = (do_minidump? mdp->pa_start : ~0L);
 258         phdr.p_paddr = (do_minidump? ~0L : mdp->pa_start);
 259 #else
 260         phdr.p_vaddr = mdp->pa_start;
 261         phdr.p_paddr = mdp->pa_start;
 262 #endif
 263         phdr.p_filesz = size;
 264         phdr.p_memsz = size;
 265         phdr.p_align = PAGE_SIZE;
 266
 267         error = dumpsys_buf_write(di, (char*)&phdr, sizeof(phdr));
 268         fileofs += phdr.p_filesz;
 269         return (error);
 270 }
 271
 272 static int
 273 cb_size(struct dump_pa *mdp, int seqnr, void *arg)
 274 {
 275         uint64_t *sz;
 276
 277         sz = (uint64_t *)arg;
 278         *sz += (uint64_t)mdp->pa_size;
 279         return (0);
 280 }
 281
 282 int
 283 dumpsys_generic(struct dumperinfo *di)
 284 {
 285         static struct kerneldumpheader kdh;
 286         Elf_Ehdr ehdr;
 287         uint64_t dumpsize;
 288         off_t hdrgap;
 289         size_t hdrsz;
 290         int error;
 291
 292 #if !defined(__powerpc__) || defined(__powerpc64__)
 293         if (do_minidump)
 294                 return (minidumpsys(di));
 295 #endif
 296
 297         bzero(&ehdr, sizeof(ehdr));
 298         ehdr.e_ident[EI_MAG0] = ELFMAG0;
 299         ehdr.e_ident[EI_MAG1] = ELFMAG1;
 300         ehdr.e_ident[EI_MAG2] = ELFMAG2;
 301         ehdr.e_ident[EI_MAG3] = ELFMAG3;
 302         ehdr.e_ident[EI_CLASS] = ELF_CLASS;
 303 #if BYTE_ORDER == LITTLE_ENDIAN
 304         ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
 305 #else
 306         ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
 307 #endif
 308         ehdr.e_ident[EI_VERSION] = EV_CURRENT;
 309         ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;   /* XXX big picture? */
 310         ehdr.e_type = ET_CORE;
 311         ehdr.e_machine = EM_VALUE;
 312         ehdr.e_phoff = sizeof(ehdr);
 313         ehdr.e_flags = 0;
 314         ehdr.e_ehsize = sizeof(ehdr);
 315         ehdr.e_phentsize = sizeof(Elf_Phdr);
 316         ehdr.e_shentsize = sizeof(Elf_Shdr);
 317
 318         dumpsys_pa_init();
 319
 320         /* Calculate dump size. */
 321         dumpsize = 0L;
 322         ehdr.e_phnum = dumpsys_foreach_chunk(cb_size, &dumpsize) +
 323             DUMPSYS_NUM_AUX_HDRS;
 324         hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
 325         fileofs = MD_ALIGN(hdrsz);
 326         dumpsize += fileofs;
 327         hdrgap = fileofs - roundup2((off_t)hdrsz, di->blocksize);
 328
 329         dump_init_header(di, &kdh, KERNELDUMPMAGIC, KERNELDUMP_ARCH_VERSION,
 330             dumpsize);
 331
 332         error = dump_start(di, &kdh);
 333         if (error != 0)
 334                 goto fail;
 335
 336         printf("Dumping %ju MB (%d chunks)\n", (uintmax_t)dumpsize >> 20,
 337             ehdr.e_phnum - DUMPSYS_NUM_AUX_HDRS);
 338
 339         /* Dump ELF header */
 340         error = dumpsys_buf_write(di, (char*)&ehdr, sizeof(ehdr));
 341         if (error)
 342                 goto fail;
 343
 344         /* Dump program headers */
 345         error = dumpsys_foreach_chunk(cb_dumphdr, di);
 346         if (error < 0)
 347                 goto fail;
 348         error = dumpsys_write_aux_headers(di);
 349         if (error < 0)
 350                 goto fail;
 351         dumpsys_buf_flush(di);
 352
 353         /*
 354          * All headers are written using blocked I/O, so we know the
 355          * current offset is (still) block aligned. Skip the alignement
 356          * in the file to have the segment contents aligned at page
 357          * boundary.
 358          */
 359         error = dumpsys_buf_seek(di, (size_t)hdrgap);
 360         if (error)
 361                 goto fail;
 362
 363         /* Dump memory chunks. */
 364         error = dumpsys_foreach_chunk(dumpsys_cb_dumpdata, di);
 365         if (error < 0)
 366                 goto fail;
 367
 368         error = dump_finish(di, &kdh);
 369         if (error != 0)
 370                 goto fail;
 371
 372         printf("\nDump complete\n");
 373         return (0);
 374
 375  fail:
 376         if (error < 0)
 377                 error = -error;
 378
 379         if (error == ECANCELED)
 380                 printf("\nDump aborted\n");
 381         else if (error == E2BIG || error == ENOSPC)
 382                 printf("\nDump failed. Partition too small.\n");
 383         else
 384                 printf("\n** DUMP FAILED (ERROR %d) **\n", error);
 385         return (error);
 386 }