sys/arm/arm/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 "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/sysctl.h>
  37 #include <sys/kernel.h>
  38 #include <sys/proc.h>
  39 #include <sys/kerneldump.h>
  40 #ifdef SW_WATCHDOG
  41 #include <sys/watchdog.h>
  42 #endif
  43 #include <vm/vm.h>
  44 #include <vm/pmap.h>
  45 #include <machine/elf.h>
  46 #include <machine/md_var.h>
  47 #include <machine/pcb.h>
  48 #include <machine/armreg.h>
  49
  50 CTASSERT(sizeof(struct kerneldumpheader) == 512);
  51
  52 int do_minidump = 1;
  53 TUNABLE_INT("debug.minidump", &do_minidump);
  54 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &do_minidump, 0,
  55     "Enable mini crash dumps");
  56
  57 /*
  58  * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
  59  * is to protect us from metadata and to protect metadata from us.
  60  */
  61 #define SIZEOF_METADATA         (64*1024)
  62
  63 #define MD_ALIGN(x)     (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
  64 #define DEV_ALIGN(x)    (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
  65 extern struct pcb dumppcb;
  66
  67 struct md_pa {
  68         vm_paddr_t md_start;
  69         vm_paddr_t md_size;
  70 };
  71
  72 typedef int callback_t(struct md_pa *, int, void *);
  73
  74 static struct kerneldumpheader kdh;
  75 static off_t dumplo, fileofs;
  76
  77 /* Handle buffered writes. */
  78 static char buffer[DEV_BSIZE];
  79 static size_t fragsz;
  80
  81 /* XXX: I suppose 20 should be enough. */
  82 static struct md_pa dump_map[20];
  83
  84 static void
  85 md_pa_init(void)
  86 {
  87         int n, idx;
  88
  89         bzero(dump_map, sizeof(dump_map));
  90         for (n = 0; n < sizeof(dump_map) / sizeof(dump_map[0]); n++) {
  91                 idx = n * 2;
  92                 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
  93                         break;
  94                 dump_map[n].md_start = dump_avail[idx];
  95                 dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
  96         }
  97 }
  98
  99 static struct md_pa *
 100 md_pa_first(void)
 101 {
 102
 103         return (&dump_map[0]);
 104 }
 105
 106 static struct md_pa *
 107 md_pa_next(struct md_pa *mdp)
 108 {
 109
 110         mdp++;
 111         if (mdp->md_size == 0)
 112                 mdp = NULL;
 113         return (mdp);
 114 }
 115
 116 static int
 117 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
 118 {
 119         size_t len;
 120         int error;
 121
 122         while (sz) {
 123                 len = DEV_BSIZE - fragsz;
 124                 if (len > sz)
 125                         len = sz;
 126                 bcopy(ptr, buffer + fragsz, len);
 127                 fragsz += len;
 128                 ptr += len;
 129                 sz -= len;
 130                 if (fragsz == DEV_BSIZE) {
 131                         error = dump_write(di, buffer, 0, dumplo,
 132                             DEV_BSIZE);
 133                         if (error)
 134                                 return error;
 135                         dumplo += DEV_BSIZE;
 136                         fragsz = 0;
 137                 }
 138         }
 139
 140         return (0);
 141 }
 142
 143 static int
 144 buf_flush(struct dumperinfo *di)
 145 {
 146         int error;
 147
 148         if (fragsz == 0)
 149                 return (0);
 150
 151         error = dump_write(di, buffer, 0, dumplo, DEV_BSIZE);
 152         dumplo += DEV_BSIZE;
 153         fragsz = 0;
 154         return (error);
 155 }
 156
 157 extern vm_offset_t kernel_l1kva;
 158 extern char *pouet2;
 159
 160 static int
 161 cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
 162 {
 163         struct dumperinfo *di = (struct dumperinfo*)arg;
 164         vm_paddr_t a, pa;
 165         void *va;
 166         uint32_t pgs;
 167         size_t counter, sz, chunk;
 168         int i, c, error;
 169
 170         va = 0;
 171         error = 0;      /* catch case in which chunk size is 0 */
 172         counter = 0;
 173         pgs = mdp->md_size / PAGE_SIZE;
 174         pa = mdp->md_start;
 175
 176         printf("  chunk %d: %dMB (%d pages)", seqnr, pgs * PAGE_SIZE / (
 177             1024*1024), pgs);
 178
 179         /*
 180          * Make sure we write coherent data.  Note that in the SMP case this
 181          * only operates on the L1 cache of the current CPU, but all other CPUs
 182          * have already been stopped, and their flush/invalidate was done as
 183          * part of stopping.
 184          */
 185         cpu_idcache_wbinv_all();
 186         cpu_l2cache_wbinv_all();
 187 #ifdef __XSCALE__
 188         xscale_cache_clean_minidata();
 189 #endif
 190         while (pgs) {
 191                 chunk = pgs;
 192                 if (chunk > MAXDUMPPGS)
 193                         chunk = MAXDUMPPGS;
 194                 sz = chunk << PAGE_SHIFT;
 195                 counter += sz;
 196                 if (counter >> 24) {
 197                         printf(" %d", pgs * PAGE_SIZE);
 198                         counter &= (1<<24) - 1;
 199                 }
 200                 for (i = 0; i < chunk; i++) {
 201                         a = pa + i * PAGE_SIZE;
 202                         va = pmap_kenter_temporary(trunc_page(a), i);
 203                 }
 204 #ifdef SW_WATCHDOG
 205                 wdog_kern_pat(WD_LASTVAL);
 206 #endif
 207                 error = dump_write(di, va, 0, dumplo, sz);
 208                 if (error)
 209                         break;
 210                 dumplo += sz;
 211                 pgs -= chunk;
 212                 pa += sz;
 213
 214                 /* Check for user abort. */
 215                 c = cncheckc();
 216                 if (c == 0x03)
 217                         return (ECANCELED);
 218                 if (c != -1)
 219                         printf(" (CTRL-C to abort) ");
 220         }
 221         printf(" ... %s\n", (error) ? "fail" : "ok");
 222         return (error);
 223 }
 224
 225 static int
 226 cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
 227 {
 228         struct dumperinfo *di = (struct dumperinfo*)arg;
 229         Elf_Phdr phdr;
 230         uint64_t size;
 231         int error;
 232
 233         size = mdp->md_size;
 234         bzero(&phdr, sizeof(phdr));
 235         phdr.p_type = PT_LOAD;
 236         phdr.p_flags = PF_R;                    /* XXX */
 237         phdr.p_offset = fileofs;
 238         phdr.p_vaddr = mdp->md_start;
 239         phdr.p_paddr = mdp->md_start;
 240         phdr.p_filesz = size;
 241         phdr.p_memsz = size;
 242         phdr.p_align = PAGE_SIZE;
 243
 244         error = buf_write(di, (char*)&phdr, sizeof(phdr));
 245         fileofs += phdr.p_filesz;
 246         return (error);
 247 }
 248
 249 /*
 250  * Add a header to be used by libkvm to get the va to pa delta
 251  */
 252 static int
 253 dump_os_header(struct dumperinfo *di)
 254 {
 255         Elf_Phdr phdr;
 256         int error;
 257
 258         bzero(&phdr, sizeof(phdr));
 259         phdr.p_type = PT_DUMP_DELTA;
 260         phdr.p_flags = PF_R;                    /* XXX */
 261         phdr.p_offset = 0;
 262         phdr.p_vaddr = KERNVIRTADDR;
 263         phdr.p_paddr = pmap_kextract(KERNVIRTADDR);
 264         phdr.p_filesz = 0;
 265         phdr.p_memsz = 0;
 266         phdr.p_align = PAGE_SIZE;
 267
 268         error = buf_write(di, (char*)&phdr, sizeof(phdr));
 269         return (error);
 270 }
 271
 272 static int
 273 cb_size(struct md_pa *mdp, int seqnr, void *arg)
 274 {
 275         uint32_t *sz = (uint32_t*)arg;
 276
 277         *sz += (uint32_t)mdp->md_size;
 278         return (0);
 279 }
 280
 281 static int
 282 foreach_chunk(callback_t cb, void *arg)
 283 {
 284         struct md_pa *mdp;
 285         int error, seqnr;
 286
 287         seqnr = 0;
 288         mdp = md_pa_first();
 289         while (mdp != NULL) {
 290                 error = (*cb)(mdp, seqnr++, arg);
 291                 if (error)
 292                         return (-error);
 293                 mdp = md_pa_next(mdp);
 294         }
 295         return (seqnr);
 296 }
 297
 298 void
 299 dumpsys(struct dumperinfo *di)
 300 {
 301         Elf_Ehdr ehdr;
 302         uint32_t dumpsize;
 303         off_t hdrgap;
 304         size_t hdrsz;
 305         int error;
 306
 307         if (do_minidump) {
 308                 minidumpsys(di);
 309                 return;
 310         }
 311
 312         bzero(&ehdr, sizeof(ehdr));
 313         ehdr.e_ident[EI_MAG0] = ELFMAG0;
 314         ehdr.e_ident[EI_MAG1] = ELFMAG1;
 315         ehdr.e_ident[EI_MAG2] = ELFMAG2;
 316         ehdr.e_ident[EI_MAG3] = ELFMAG3;
 317         ehdr.e_ident[EI_CLASS] = ELF_CLASS;
 318 #if BYTE_ORDER == LITTLE_ENDIAN
 319         ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
 320 #else
 321         ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
 322 #endif
 323         ehdr.e_ident[EI_VERSION] = EV_CURRENT;
 324         ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;   /* XXX big picture? */
 325         ehdr.e_type = ET_CORE;
 326         ehdr.e_machine = EM_ARM;
 327         ehdr.e_phoff = sizeof(ehdr);
 328         ehdr.e_flags = 0;
 329         ehdr.e_ehsize = sizeof(ehdr);
 330         ehdr.e_phentsize = sizeof(Elf_Phdr);
 331         ehdr.e_shentsize = sizeof(Elf_Shdr);
 332
 333         md_pa_init();
 334
 335         /* Calculate dump size. */
 336         dumpsize = 0L;
 337         ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize) + 1;
 338         hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
 339         fileofs = MD_ALIGN(hdrsz);
 340         dumpsize += fileofs;
 341         hdrgap = fileofs - DEV_ALIGN(hdrsz);
 342
 343         /* Determine dump offset on device. */
 344         if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
 345                 error = ENOSPC;
 346                 goto fail;
 347         }
 348         dumplo = di->mediaoffset + di->mediasize - dumpsize;
 349         dumplo -= sizeof(kdh) * 2;
 350
 351         mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_ARM_VERSION, dumpsize, di->blocksize);
 352
 353         printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
 354             ehdr.e_phnum - 1);
 355
 356         /* Dump leader */
 357         error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
 358         if (error)
 359                 goto fail;
 360         dumplo += sizeof(kdh);
 361
 362         /* Dump ELF header */
 363         error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
 364         if (error)
 365                 goto fail;
 366
 367         /* Dump program headers */
 368         error = foreach_chunk(cb_dumphdr, di);
 369         if (error >= 0)
 370                 error = dump_os_header(di);
 371         if (error < 0)
 372                 goto fail;
 373         buf_flush(di);
 374
 375         /*
 376          * All headers are written using blocked I/O, so we know the
 377          * current offset is (still) block aligned. Skip the alignement
 378          * in the file to have the segment contents aligned at page
 379          * boundary. We cannot use MD_ALIGN on dumplo, because we don't
 380          * care and may very well be unaligned within the dump device.
 381          */
 382         dumplo += hdrgap;
 383
 384         /* Dump memory chunks (updates dumplo) */
 385         error = foreach_chunk(cb_dumpdata, di);
 386         if (error < 0)
 387                 goto fail;
 388
 389         /* Dump trailer */
 390         error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
 391         if (error)
 392                 goto fail;
 393
 394         /* Signal completion, signoff and exit stage left. */
 395         dump_write(di, NULL, 0, 0, 0);
 396         printf("\nDump complete\n");
 397         return;
 398
 399  fail:
 400         if (error < 0)
 401                 error = -error;
 402
 403         if (error == ECANCELED)
 404                 printf("\nDump aborted\n");
 405         else if (error == ENOSPC)
 406                 printf("\nDump failed. Partition too small.\n");
 407         else
 408                 printf("\n** DUMP FAILED (ERROR %d) **\n", error);
 409 }