sys/mips/mips/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
  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/sysctl.h>
  35 #include <sys/kernel.h>
  36 #include <sys/proc.h>
  37 #include <sys/kerneldump.h>
  38 #include <vm/vm.h>
  39 #include <vm/pmap.h>
  40 #include <machine/elf.h>
  41 #include <machine/md_var.h>
  42 #include <machine/pcb.h>
  43 #include <machine/cache.h>
  44
  45 CTASSERT(sizeof(struct kerneldumpheader) == 512);
  46
  47 int do_minidump = 1;
  48 TUNABLE_INT("debug.minidump", &do_minidump);
  49 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &do_minidump, 0,
  50     "Enable mini crash dumps");
  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 extern struct pcb dumppcb;
  61
  62 struct md_pa {
  63         vm_paddr_t md_start;
  64         vm_paddr_t md_size;
  65 };
  66
  67 typedef int callback_t(struct md_pa *, int, void *);
  68
  69 static struct kerneldumpheader kdh;
  70 static off_t dumplo, fileofs;
  71
  72 /* Handle buffered writes. */
  73 static char buffer[DEV_BSIZE];
  74 static size_t fragsz;
  75
  76 /* XXX: I suppose 20 should be enough. */
  77 static struct md_pa dump_map[20];
  78
  79 static void
  80 md_pa_init(void)
  81 {
  82         int n, idx;
  83
  84         bzero(dump_map, sizeof(dump_map));
  85         for (n = 0; n < sizeof(dump_map) / sizeof(dump_map[0]); n++) {
  86                 idx = n * 2;
  87                 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
  88                         break;
  89                 dump_map[n].md_start = dump_avail[idx];
  90                 dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
  91         }
  92 }
  93
  94 static struct md_pa *
  95 md_pa_first(void)
  96 {
  97
  98         return (&dump_map[0]);
  99 }
 100
 101 static struct md_pa *
 102 md_pa_next(struct md_pa *mdp)
 103 {
 104
 105         mdp++;
 106         if (mdp->md_size == 0)
 107                 mdp = NULL;
 108         return (mdp);
 109 }
 110
 111 static int
 112 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
 113 {
 114         size_t len;
 115         int error;
 116
 117         while (sz) {
 118                 len = DEV_BSIZE - fragsz;
 119                 if (len > sz)
 120                         len = sz;
 121                 bcopy(ptr, buffer + fragsz, len);
 122                 fragsz += len;
 123                 ptr += len;
 124                 sz -= len;
 125                 if (fragsz == DEV_BSIZE) {
 126                         error = dump_write(di, buffer, 0, dumplo,
 127                             DEV_BSIZE);
 128                         if (error)
 129                                 return error;
 130                         dumplo += DEV_BSIZE;
 131                         fragsz = 0;
 132                 }
 133         }
 134
 135         return (0);
 136 }
 137
 138 static int
 139 buf_flush(struct dumperinfo *di)
 140 {
 141         int error;
 142
 143         if (fragsz == 0)
 144                 return (0);
 145
 146         error = dump_write(di, buffer, 0, dumplo, DEV_BSIZE);
 147         dumplo += DEV_BSIZE;
 148         fragsz = 0;
 149         return (error);
 150 }
 151
 152 extern vm_offset_t kernel_l1kva;
 153 extern char *pouet2;
 154
 155 static int
 156 cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
 157 {
 158         struct dumperinfo *di = (struct dumperinfo*)arg;
 159         vm_paddr_t pa;
 160         uint32_t pgs;
 161         size_t counter, sz, chunk;
 162         int c, error;
 163
 164         error = 0;      /* catch case in which chunk size is 0 */
 165         counter = 0;
 166         pgs = mdp->md_size / PAGE_SIZE;
 167         pa = mdp->md_start;
 168
 169         printf("  chunk %d: %dMB (%d pages)", seqnr, pgs * PAGE_SIZE / (
 170             1024*1024), pgs);
 171
 172         /* Make sure we write coherent datas. */
 173         mips_dcache_wbinv_all();
 174         while (pgs) {
 175                 chunk = pgs;
 176                 if (chunk > MAXDUMPPGS)
 177                         chunk = MAXDUMPPGS;
 178                 sz = chunk << PAGE_SHIFT;
 179                 counter += sz;
 180                 if (counter >> 24) {
 181                         printf(" %d", pgs * PAGE_SIZE);
 182                         counter &= (1<<24) - 1;
 183                 }
 184
 185                 error = dump_write(di, (void *)(pa),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                         printf(" (CTRL-C to abort) ");
 198         }
 199         printf(" ... %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         uint32_t *sz = (uint32_t*)arg;
 231
 232         *sz += (uint32_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 dumpsys(struct dumperinfo *di)
 255 {
 256         Elf_Ehdr ehdr;
 257         uint32_t dumpsize;
 258         off_t hdrgap;
 259         size_t hdrsz;
 260         int error;
 261
 262         if (do_minidump) {
 263                 minidumpsys(di);
 264                 return;
 265         }
 266
 267         bzero(&ehdr, sizeof(ehdr));
 268         ehdr.e_ident[EI_MAG0] = ELFMAG0;
 269         ehdr.e_ident[EI_MAG1] = ELFMAG1;
 270         ehdr.e_ident[EI_MAG2] = ELFMAG2;
 271         ehdr.e_ident[EI_MAG3] = ELFMAG3;
 272         ehdr.e_ident[EI_CLASS] = ELF_CLASS;
 273 #if BYTE_ORDER == LITTLE_ENDIAN
 274         ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
 275 #else
 276         ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
 277 #endif
 278         ehdr.e_ident[EI_VERSION] = EV_CURRENT;
 279         ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;   /* XXX big picture? */
 280         ehdr.e_type = ET_CORE;
 281         ehdr.e_machine = EM_MIPS;
 282         ehdr.e_phoff = sizeof(ehdr);
 283         ehdr.e_flags = 0;
 284         ehdr.e_ehsize = sizeof(ehdr);
 285         ehdr.e_phentsize = sizeof(Elf_Phdr);
 286         ehdr.e_shentsize = sizeof(Elf_Shdr);
 287
 288         md_pa_init();
 289
 290         /* Calculate dump size. */
 291         dumpsize = 0L;
 292         ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
 293         hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
 294         fileofs = MD_ALIGN(hdrsz);
 295         dumpsize += fileofs;
 296         hdrgap = fileofs - DEV_ALIGN(hdrsz);
 297
 298         /* Determine dump offset on device. */
 299         if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
 300                 error = ENOSPC;
 301                 goto fail;
 302         }
 303         dumplo = di->mediaoffset + di->mediasize - dumpsize;
 304         dumplo -= sizeof(kdh) * 2;
 305
 306         mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_MIPS_VERSION, dumpsize, di->blocksize);
 307
 308         printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
 309             ehdr.e_phnum);
 310
 311         /* Dump leader */
 312         error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
 313         if (error)
 314                 goto fail;
 315         dumplo += sizeof(kdh);
 316
 317         /* Dump ELF header */
 318         error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
 319         if (error)
 320                 goto fail;
 321
 322         /* Dump program headers */
 323         error = foreach_chunk(cb_dumphdr, di);
 324         if (error < 0)
 325                 goto fail;
 326         buf_flush(di);
 327
 328         /*
 329          * All headers are written using blocked I/O, so we know the
 330          * current offset is (still) block aligned. Skip the alignement
 331          * in the file to have the segment contents aligned at page
 332          * boundary. We cannot use MD_ALIGN on dumplo, because we don't
 333          * care and may very well be unaligned within the dump device.
 334          */
 335         dumplo += hdrgap;
 336
 337         /* Dump memory chunks (updates dumplo) */
 338         error = foreach_chunk(cb_dumpdata, di);
 339         if (error < 0)
 340                 goto fail;
 341
 342         /* Dump trailer */
 343         error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
 344         if (error)
 345                 goto fail;
 346
 347         /* Signal completion, signoff and exit stage left. */
 348         dump_write(di, NULL, 0, 0, 0);
 349         printf("\nDump complete\n");
 350         return;
 351
 352  fail:
 353         if (error < 0)
 354                 error = -error;
 355
 356         if (error == ECANCELED)
 357                 printf("\nDump aborted\n");
 358         else if (error == ENOSPC)
 359                 printf("\nDump failed. Partition too small.\n");
 360         else
 361                 printf("\n** DUMP FAILED (ERROR %d) **\n", error);
 362 }