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