sys/platform/pc32/i386/dump_machdep.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  * $FreeBSD: src/sys/i386/i386/dump_machdep.c,v 1.20 2009/12/10 03:09:35 kmacy Exp $
  27  */
  28
  29 #include <sys/param.h>
  30 #include <sys/systm.h>
  31 #include <sys/conf.h>
  32 #include <sys/cons.h>
  33 #include <sys/sysctl.h>
  34 #include <sys/device.h>
  35 #include <sys/kernel.h>
  36 #include <sys/kerneldump.h>
  37 #include <vm/vm.h>
  38 #include <vm/pmap.h>
  39 #include <machine/elf.h>
  40 #include <machine/md_var.h>
  41 #include <machine/thread.h>
  42 #include <sys/thread2.h>
  43
  44 CTASSERT(sizeof(struct kerneldumpheader) == 512);
  45
  46 int do_minidump = 1;
  47 TUNABLE_INT("debug.minidump", &do_minidump);
  48 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &do_minidump, 0,
  49     "Enable mini crash dumps");
  50
  51
  52 /*
  53  * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
  54  * is to protect us from metadata and to protect metadata from us.
  55  */
  56 #define SIZEOF_METADATA         (64*1024)
  57
  58 #define MD_ALIGN(x)     (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
  59 #define DEV_ALIGN(x)    (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
  60
  61 struct md_pa {
  62         vm_paddr_t md_start;
  63         vm_paddr_t md_size;
  64 };
  65
  66 typedef int callback_t(struct md_pa *, int, void *);
  67
  68 static struct kerneldumpheader kdh;
  69 static off_t dumplo, fileofs;
  70
  71 /* Handle buffered writes. */
  72 static char buffer[DEV_BSIZE];
  73 static size_t fragsz;
  74
  75 /* 20 phys_avail entry pairs correspond to 10 md_pa's */
  76 static struct md_pa dump_map[10];
  77
  78 static void
  79 md_pa_init(void)
  80 {
  81         int n, idx;
  82
  83         bzero(dump_map, sizeof(dump_map));
  84         for (n = 0; n < sizeof(dump_map) / sizeof(dump_map[0]); n++) {
  85                 idx = n * 2;
  86                 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
  87                         break;
  88                 dump_map[n].md_start = dump_avail[idx];
  89                 dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
  90         }
  91 }
  92
  93 static struct md_pa *
  94 md_pa_first(void)
  95 {
  96
  97         return (&dump_map[0]);
  98 }
  99
 100 static struct md_pa *
 101 md_pa_next(struct md_pa *mdp)
 102 {
 103
 104         mdp++;
 105         if (mdp->md_size == 0)
 106                 mdp = NULL;
 107         return (mdp);
 108 }
 109
 110 static int
 111 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
 112 {
 113         size_t len;
 114         int error;
 115
 116         while (sz) {
 117                 len = DEV_BSIZE - fragsz;
 118                 if (len > sz)
 119                         len = sz;
 120                 bcopy(ptr, buffer + fragsz, len);
 121                 fragsz += len;
 122                 ptr += len;
 123                 sz -= len;
 124                 if (fragsz == DEV_BSIZE) {
 125                         error = dev_ddump(di->priv, buffer, 0, dumplo,
 126                             DEV_BSIZE);
 127                         if (error)
 128                                 return error;
 129                         dumplo += DEV_BSIZE;
 130                         fragsz = 0;
 131                 }
 132         }
 133
 134         return (0);
 135 }
 136
 137 static int
 138 buf_flush(struct dumperinfo *di)
 139 {
 140         int error;
 141
 142         if (fragsz == 0)
 143                 return (0);
 144
 145         error = dev_ddump(di->priv, buffer, 0, dumplo, DEV_BSIZE);
 146         dumplo += DEV_BSIZE;
 147         fragsz = 0;
 148         return (error);
 149 }
 150
 151 #define PG2MB(pgs) ((pgs + (1 << 8) - 1) >> 8)
 152
 153 static int
 154 cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
 155 {
 156         struct dumperinfo *di = (struct dumperinfo*)arg;
 157         vm_paddr_t a, pa;
 158         void *va;
 159         uint64_t pgs;
 160         size_t counter, sz, chunk;
 161         int i, c, error;
 162
 163         error = 0;      /* catch case in which chunk size is 0 */
 164         counter = 0;    /* Update twiddle every 16MB */
 165         va = 0;
 166         pgs = mdp->md_size / PAGE_SIZE;
 167         pa = mdp->md_start;
 168
 169         kprintf("  chunk %d: %lldMB (%lld pages)", seqnr, PG2MB(pgs), pgs);
 170
 171         while (pgs) {
 172                 chunk = pgs;
 173                 if (chunk > MAXDUMPPGS)
 174                         chunk = MAXDUMPPGS;
 175                 sz = chunk << PAGE_SHIFT;
 176                 counter += sz;
 177                 if (counter >> 24) {
 178                         kprintf(" %lld", PG2MB(pgs));
 179                         counter &= (1<<24) - 1;
 180                 }
 181                 for (i = 0; i < chunk; i++) {
 182                         a = pa + i * PAGE_SIZE;
 183                         va = pmap_kenter_temporary(trunc_page(a), i);
 184                 }
 185                 error = dev_ddump(di->priv, va, 0, dumplo, sz);
 186                 if (error)
 187                         break;
 188                 dumplo += sz;
 189                 pgs -= chunk;
 190                 pa += sz;
 191
 192                 /* Check for user abort. */
 193                 c = cncheckc();
 194                 if (c == 0x03)
 195                         return (ECANCELED);
 196                 if (c != -1)
 197                         kprintf(" (CTRL-C to abort) ");
 198         }
 199         kprintf(" ... %s\n", (error) ? "fail" : "ok");
 200         return (error);
 201 }
 202
 203 static int
 204 cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
 205 {
 206         struct dumperinfo *di = (struct dumperinfo*)arg;
 207         Elf_Phdr phdr;
 208         uint64_t size;
 209         int error;
 210
 211         size = mdp->md_size;
 212         bzero(&phdr, sizeof(phdr));
 213         phdr.p_type = PT_LOAD;
 214         phdr.p_flags = PF_R;                    /* XXX */
 215         phdr.p_offset = fileofs;
 216         phdr.p_vaddr = mdp->md_start;
 217         phdr.p_paddr = mdp->md_start;
 218         phdr.p_filesz = size;
 219         phdr.p_memsz = size;
 220         phdr.p_align = PAGE_SIZE;
 221
 222         error = buf_write(di, (char*)&phdr, sizeof(phdr));
 223         fileofs += phdr.p_filesz;
 224         return (error);
 225 }
 226
 227 static int
 228 cb_size(struct md_pa *mdp, int seqnr, void *arg)
 229 {
 230         uint64_t *sz = (uint64_t*)arg;
 231
 232         *sz += (uint64_t)mdp->md_size;
 233         return (0);
 234 }
 235
 236 static int
 237 foreach_chunk(callback_t cb, void *arg)
 238 {
 239         struct md_pa *mdp;
 240         int error, seqnr;
 241
 242         seqnr = 0;
 243         mdp = md_pa_first();
 244         while (mdp != NULL) {
 245                 error = (*cb)(mdp, seqnr++, arg);
 246                 if (error)
 247                         return (-error);
 248                 mdp = md_pa_next(mdp);
 249         }
 250         return (seqnr);
 251 }
 252
 253 void
 254 md_dumpsys(struct dumperinfo *di)
 255 {
 256         Elf_Ehdr ehdr;
 257         uint64_t dumpsize;
 258         off_t hdrgap;
 259         size_t hdrsz;
 260         int error;
 261
 262         savectx(&dumppcb);
 263         dumpthread = curthread;
 264
 265         if (do_minidump) {
 266                 minidumpsys(di);
 267                 return;
 268         }
 269
 270         bzero(&ehdr, sizeof(ehdr));
 271         ehdr.e_ident[EI_MAG0] = ELFMAG0;
 272         ehdr.e_ident[EI_MAG1] = ELFMAG1;
 273         ehdr.e_ident[EI_MAG2] = ELFMAG2;
 274         ehdr.e_ident[EI_MAG3] = ELFMAG3;
 275         ehdr.e_ident[EI_CLASS] = ELF_CLASS;
 276 #if BYTE_ORDER == LITTLE_ENDIAN
 277         ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
 278 #else
 279         ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
 280 #endif
 281         ehdr.e_ident[EI_VERSION] = EV_CURRENT;
 282         ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;   /* XXX big picture? */
 283         ehdr.e_type = ET_CORE;
 284         ehdr.e_machine = EM_386;
 285         ehdr.e_phoff = sizeof(ehdr);
 286         ehdr.e_flags = 0;
 287         ehdr.e_ehsize = sizeof(ehdr);
 288         ehdr.e_phentsize = sizeof(Elf_Phdr);
 289         ehdr.e_shentsize = sizeof(Elf_Shdr);
 290
 291         md_pa_init();
 292
 293         /* Calculate dump size. */
 294         dumpsize = 0L;
 295         ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
 296         hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
 297         fileofs = MD_ALIGN(hdrsz);
 298         dumpsize += fileofs;
 299         hdrgap = fileofs - DEV_ALIGN(hdrsz);
 300
 301         /* Determine dump offset on device. */
 302         if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
 303                 error = ENOSPC;
 304                 goto fail;
 305         }
 306         dumplo = di->mediaoffset + di->mediasize - dumpsize;
 307         dumplo -= sizeof(kdh) * 2;
 308
 309         mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_I386_VERSION,
 310             dumpsize, di->blocksize);
 311
 312         kprintf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
 313             ehdr.e_phnum);
 314
 315         /* Dump leader */
 316         error = dev_ddump(di->priv, &kdh, 0, dumplo, sizeof(kdh));
 317         if (error)
 318                 goto fail;
 319         dumplo += sizeof(kdh);
 320
 321         /* Dump ELF header */
 322         error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
 323         if (error)
 324                 goto fail;
 325
 326         /* Dump program headers */
 327         error = foreach_chunk(cb_dumphdr, di);
 328         if (error < 0)
 329                 goto fail;
 330         buf_flush(di);
 331
 332         /*
 333          * All headers are written using blocked I/O, so we know the
 334          * current offset is (still) block aligned. Skip the alignement
 335          * in the file to have the segment contents aligned at page
 336          * boundary. We cannot use MD_ALIGN on dumplo, because we don't
 337          * care and may very well be unaligned within the dump device.
 338          */
 339         dumplo += hdrgap;
 340
 341         /* Dump memory chunks (updates dumplo) */
 342         error = foreach_chunk(cb_dumpdata, di);
 343         if (error < 0)
 344                 goto fail;
 345
 346         /* Dump trailer */
 347         error = dev_ddump(di->priv, &kdh, 0, dumplo, sizeof(kdh));
 348         if (error)
 349                 goto fail;
 350
 351         /* Signal completion, signoff and exit stage left. */
 352         dev_ddump(di->priv, NULL, 0, 0, 0);
 353         kprintf("\nDump complete\n");
 354         return;
 355
 356  fail:
 357         if (error < 0)
 358                 error = -error;
 359
 360         if (error == ECANCELED)
 361                 kprintf("\nDump aborted\n");
 362         else if (error == ENOSPC)
 363                 kprintf("\nDump failed. Partition too small.\n");
 364         else
 365                 kprintf("\n** DUMP FAILED (ERROR %d) **\n", error);
 366 }