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