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 pa;
 165         uint32_t pgs;
 166         size_t counter, sz, chunk;
 167         int c, error;
 168
 169         error = 0;      /* catch case in which chunk size is 0 */
 170         counter = 0;
 171         pgs = mdp->md_size / PAGE_SIZE;
 172         pa = mdp->md_start;
 173
 174         printf("  chunk %d: %dMB (%d pages)", seqnr, pgs * PAGE_SIZE / (
 175             1024*1024), pgs);
 176
 177         /* Make sure we write coherent datas. */
 178         cpu_idcache_wbinv_all();
 179 #ifdef __XSCALE__
 180         xscale_cache_clean_minidata();
 181 #endif
 182         while (pgs) {
 183                 chunk = pgs;
 184                 if (chunk > MAXDUMPPGS)
 185                         chunk = MAXDUMPPGS;
 186                 sz = chunk << PAGE_SHIFT;
 187                 counter += sz;
 188                 if (counter >> 24) {
 189                         printf(" %d", pgs * PAGE_SIZE);
 190                         counter &= (1<<24) - 1;
 191                 }
 192                 if (pa == (pa & L1_ADDR_BITS)) {
 193                         pmap_kenter_section(0, pa & L1_ADDR_BITS, 0);
 194                         cpu_tlb_flushID_SE(0);
 195                         cpu_cpwait();
 196                 }
 197 #ifdef SW_WATCHDOG
 198                 wdog_kern_pat(WD_LASTVAL);
 199 #endif
 200                 error = dump_write(di,
 201                     (void *)(pa - (pa & L1_ADDR_BITS)),0, dumplo, sz);
 202                 if (error)
 203                         break;
 204                 dumplo += sz;
 205                 pgs -= chunk;
 206                 pa += sz;
 207
 208                 /* Check for user abort. */
 209                 c = cncheckc();
 210                 if (c == 0x03)
 211                         return (ECANCELED);
 212                 if (c != -1)
 213                         printf(" (CTRL-C to abort) ");
 214         }
 215         printf(" ... %s\n", (error) ? "fail" : "ok");
 216         return (error);
 217 }
 218
 219 static int
 220 cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
 221 {
 222         struct dumperinfo *di = (struct dumperinfo*)arg;
 223         Elf_Phdr phdr;
 224         uint64_t size;
 225         int error;
 226
 227         size = mdp->md_size;
 228         bzero(&phdr, sizeof(phdr));
 229         phdr.p_type = PT_LOAD;
 230         phdr.p_flags = PF_R;                    /* XXX */
 231         phdr.p_offset = fileofs;
 232         phdr.p_vaddr = mdp->md_start;
 233         phdr.p_paddr = mdp->md_start;
 234         phdr.p_filesz = size;
 235         phdr.p_memsz = size;
 236         phdr.p_align = PAGE_SIZE;
 237
 238         error = buf_write(di, (char*)&phdr, sizeof(phdr));
 239         fileofs += phdr.p_filesz;
 240         return (error);
 241 }
 242
 243 static int
 244 cb_size(struct md_pa *mdp, int seqnr, void *arg)
 245 {
 246         uint32_t *sz = (uint32_t*)arg;
 247
 248         *sz += (uint32_t)mdp->md_size;
 249         return (0);
 250 }
 251
 252 static int
 253 foreach_chunk(callback_t cb, void *arg)
 254 {
 255         struct md_pa *mdp;
 256         int error, seqnr;
 257
 258         seqnr = 0;
 259         mdp = md_pa_first();
 260         while (mdp != NULL) {
 261                 error = (*cb)(mdp, seqnr++, arg);
 262                 if (error)
 263                         return (-error);
 264                 mdp = md_pa_next(mdp);
 265         }
 266         return (seqnr);
 267 }
 268
 269 void
 270 dumpsys(struct dumperinfo *di)
 271 {
 272         Elf_Ehdr ehdr;
 273         uint32_t dumpsize;
 274         off_t hdrgap;
 275         size_t hdrsz;
 276         int error;
 277
 278         if (do_minidump) {
 279                 minidumpsys(di);
 280                 return;
 281         }
 282
 283         bzero(&ehdr, sizeof(ehdr));
 284         ehdr.e_ident[EI_MAG0] = ELFMAG0;
 285         ehdr.e_ident[EI_MAG1] = ELFMAG1;
 286         ehdr.e_ident[EI_MAG2] = ELFMAG2;
 287         ehdr.e_ident[EI_MAG3] = ELFMAG3;
 288         ehdr.e_ident[EI_CLASS] = ELF_CLASS;
 289 #if BYTE_ORDER == LITTLE_ENDIAN
 290         ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
 291 #else
 292         ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
 293 #endif
 294         ehdr.e_ident[EI_VERSION] = EV_CURRENT;
 295         ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;   /* XXX big picture? */
 296         ehdr.e_type = ET_CORE;
 297         ehdr.e_machine = EM_ARM;
 298         ehdr.e_phoff = sizeof(ehdr);
 299         ehdr.e_flags = 0;
 300         ehdr.e_ehsize = sizeof(ehdr);
 301         ehdr.e_phentsize = sizeof(Elf_Phdr);
 302         ehdr.e_shentsize = sizeof(Elf_Shdr);
 303
 304         md_pa_init();
 305
 306         /* Calculate dump size. */
 307         dumpsize = 0L;
 308         ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
 309         hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
 310         fileofs = MD_ALIGN(hdrsz);
 311         dumpsize += fileofs;
 312         hdrgap = fileofs - DEV_ALIGN(hdrsz);
 313
 314         /* Determine dump offset on device. */
 315         if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
 316                 error = ENOSPC;
 317                 goto fail;
 318         }
 319         dumplo = di->mediaoffset + di->mediasize - dumpsize;
 320         dumplo -= sizeof(kdh) * 2;
 321
 322         mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_ARM_VERSION, dumpsize, di->blocksize);
 323
 324         printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
 325             ehdr.e_phnum);
 326
 327         /* Dump leader */
 328         error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
 329         if (error)
 330                 goto fail;
 331         dumplo += sizeof(kdh);
 332
 333         /* Dump ELF header */
 334         error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
 335         if (error)
 336                 goto fail;
 337
 338         /* Dump program headers */
 339         error = foreach_chunk(cb_dumphdr, di);
 340         if (error < 0)
 341                 goto fail;
 342         buf_flush(di);
 343
 344         /*
 345          * All headers are written using blocked I/O, so we know the
 346          * current offset is (still) block aligned. Skip the alignement
 347          * in the file to have the segment contents aligned at page
 348          * boundary. We cannot use MD_ALIGN on dumplo, because we don't
 349          * care and may very well be unaligned within the dump device.
 350          */
 351         dumplo += hdrgap;
 352
 353         /* Dump memory chunks (updates dumplo) */
 354         error = foreach_chunk(cb_dumpdata, di);
 355         if (error < 0)
 356                 goto fail;
 357
 358         /* Dump trailer */
 359         error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
 360         if (error)
 361                 goto fail;
 362
 363         /* Signal completion, signoff and exit stage left. */
 364         dump_write(di, NULL, 0, 0, 0);
 365         printf("\nDump complete\n");
 366         return;
 367
 368  fail:
 369         if (error < 0)
 370                 error = -error;
 371
 372         if (error == ECANCELED)
 373                 printf("\nDump aborted\n");
 374         else if (error == ENOSPC)
 375                 printf("\nDump failed. Partition too small.\n");
 376         else
 377                 printf("\n** DUMP FAILED (ERROR %d) **\n", error);
 378 }