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