2 * Copyright (c) 2002 Marcel Moolenaar
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include "opt_watchdog.h"
32 #include <sys/param.h>
33 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/kerneldump.h>
40 #include <sys/watchdog.h>
44 #include <machine/bootinfo.h>
45 #include <machine/elf.h>
46 #include <machine/md_var.h>
48 CTASSERT(sizeof(struct kerneldumpheader) == 512);
51 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
52 * is to protect us from metadata and to protect metadata from us.
54 #define SIZEOF_METADATA (64*1024)
56 #define MD_ALIGN(x) (((off_t)(x) + EFI_PAGE_MASK) & ~EFI_PAGE_MASK)
57 #define DEV_ALIGN(x) (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
59 static int minidump = 0;
60 TUNABLE_INT("debug.minidump", &minidump);
61 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &minidump, 0,
62 "Enable mini crash dumps");
64 static struct kerneldumpheader kdh;
65 static off_t dumplo, fileofs;
67 /* Handle buffered writes. */
68 static char buffer[DEV_BSIZE];
72 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
78 len = DEV_BSIZE - fragsz;
81 bcopy(ptr, buffer + fragsz, len);
85 if (fragsz == DEV_BSIZE) {
86 error = dump_write(di, buffer, 0, dumplo,
99 buf_flush(struct dumperinfo *di)
106 error = dump_write(di, buffer, 0, dumplo, DEV_BSIZE);
113 * Physical dump support
116 typedef int phys_callback_t(struct efi_md*, int, void*);
119 phys_cb_dumpdata(struct efi_md *mdp, int seqnr, void *arg)
121 struct dumperinfo *di = (struct dumperinfo*)arg;
125 int c, error, twiddle;
127 error = 0; /* catch case in which mdp->md_pages is 0 */
128 counter = 0; /* Update twiddle every 16MB */
131 pa = IA64_PHYS_TO_RR7(mdp->md_phys);
133 printf(" chunk %d: %ld pages ", seqnr, (long)pgs);
136 sz = (pgs > (DFLTPHYS >> EFI_PAGE_SHIFT))
137 ? DFLTPHYS : pgs << EFI_PAGE_SHIFT;
140 printf("%c\b", "|/-\\"[twiddle++ & 3]);
141 counter &= (1<<24) - 1;
144 wdog_kern_pat(WD_LASTVAL);
146 error = dump_write(di, (void*)pa, 0, dumplo, sz);
150 pgs -= sz >> EFI_PAGE_SHIFT;
153 /* Check for user abort. */
158 printf("(CTRL-C to abort) ");
160 printf("... %s\n", (error) ? "fail" : "ok");
165 phys_cb_dumphdr(struct efi_md *mdp, int seqnr, void *arg)
167 struct dumperinfo *di = (struct dumperinfo*)arg;
171 bzero(&phdr, sizeof(phdr));
172 phdr.p_type = PT_LOAD;
173 phdr.p_flags = PF_R; /* XXX */
174 phdr.p_offset = fileofs;
175 phdr.p_vaddr = (uintptr_t)mdp->md_virt; /* XXX probably bogus. */
176 phdr.p_paddr = mdp->md_phys;
177 phdr.p_filesz = mdp->md_pages << EFI_PAGE_SHIFT;
178 phdr.p_memsz = mdp->md_pages << EFI_PAGE_SHIFT;
179 phdr.p_align = EFI_PAGE_SIZE;
181 error = buf_write(di, (char*)&phdr, sizeof(phdr));
182 fileofs += phdr.p_filesz;
187 phys_cb_size(struct efi_md *mdp, int seqnr, void *arg)
189 uint64_t *sz = (uint64_t*)arg;
191 *sz += (uint64_t)mdp->md_pages << EFI_PAGE_SHIFT;
196 phys_foreach(phys_callback_t cb, void *arg)
202 mdp = efi_md_first();
203 while (mdp != NULL) {
204 if (mdp->md_type == EFI_MD_TYPE_FREE ||
205 mdp->md_type == EFI_MD_TYPE_DATA ||
206 mdp->md_type == EFI_MD_TYPE_CODE ||
207 mdp->md_type == EFI_MD_TYPE_BS_DATA ||
208 mdp->md_type == EFI_MD_TYPE_BS_CODE) {
209 error = (*cb)(mdp, seqnr++, arg);
213 mdp = efi_md_next(mdp);
219 * Virtual dump (aka minidump) support
222 typedef int virt_callback_t(vm_offset_t, vm_size_t, int, void*);
225 virt_cb_size(vm_offset_t va, vm_size_t sz, int seqnr, void *arg)
227 uint64_t *dumpsize = (uint64_t *)arg;
234 virt_cb_dumphdr(vm_offset_t va, vm_size_t sz, int seqnr, void *arg)
236 struct dumperinfo *di = (struct dumperinfo *)arg;
240 bzero(&phdr, sizeof(phdr));
241 phdr.p_type = PT_LOAD;
242 phdr.p_flags = PF_R; /* XXX */
243 phdr.p_offset = fileofs;
248 phdr.p_align = PAGE_SIZE;
250 error = buf_write(di, (char*)&phdr, sizeof(phdr));
251 fileofs += phdr.p_filesz;
256 virt_cb_dumpdata(vm_offset_t va, vm_size_t sz, int seqnr, void *arg)
258 struct dumperinfo *di = (struct dumperinfo *)arg;
259 size_t counter, iosz;
260 int c, error, twiddle;
262 error = 0; /* catch case in which pgs is 0 */
263 counter = 0; /* Update twiddle every 16MB */
266 printf(" chunk %d: %ld pages ", seqnr, atop(sz));
269 iosz = (sz > DFLTPHYS) ? DFLTPHYS : sz;
272 printf("%c\b", "|/-\\"[twiddle++ & 3]);
273 counter &= (1<<24) - 1;
276 wdog_kern_pat(WD_LASTVAL);
278 error = dump_write(di, (void*)va, 0, dumplo, iosz);
285 /* Check for user abort. */
290 printf("(CTRL-C to abort) ");
292 printf("... %s\n", (error) ? "fail" : "ok");
297 virt_foreach(virt_callback_t cb, void *arg)
308 sz = round_page(bootinfo->bi_kernend) - va;
315 if (va == 0 && sz == 0)
317 error = (*cb)(va, sz, seqnr, arg);
330 dumpsys(struct dumperinfo *di)
338 bzero(&ehdr, sizeof(ehdr));
339 ehdr.e_ident[EI_MAG0] = ELFMAG0;
340 ehdr.e_ident[EI_MAG1] = ELFMAG1;
341 ehdr.e_ident[EI_MAG2] = ELFMAG2;
342 ehdr.e_ident[EI_MAG3] = ELFMAG3;
343 ehdr.e_ident[EI_CLASS] = ELFCLASS64;
344 #if BYTE_ORDER == LITTLE_ENDIAN
345 ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
347 ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
349 ehdr.e_ident[EI_VERSION] = EV_CURRENT;
350 ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE; /* XXX big picture? */
351 ehdr.e_type = ET_CORE;
352 ehdr.e_machine = EM_IA_64;
353 ehdr.e_entry = (minidump) ? (uintptr_t)bootinfo :
354 ia64_tpa((uintptr_t)bootinfo);
355 ehdr.e_phoff = sizeof(ehdr);
356 ehdr.e_flags = (minidump) ? 0 : EF_IA_64_ABSOLUTE; /* XXX misuse? */
357 ehdr.e_ehsize = sizeof(ehdr);
358 ehdr.e_phentsize = sizeof(Elf64_Phdr);
359 ehdr.e_shentsize = sizeof(Elf64_Shdr);
361 /* Calculate dump size. */
363 status = (minidump) ? virt_foreach(virt_cb_size, &dumpsize) :
364 phys_foreach(phys_cb_size, &dumpsize);
369 ehdr.e_phnum = status;
370 hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
371 fileofs = (minidump) ? round_page(hdrsz) : MD_ALIGN(hdrsz);
373 hdrgap = fileofs - DEV_ALIGN(hdrsz);
375 /* Determine dump offset on device. */
376 if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
380 dumplo = di->mediaoffset + di->mediasize - dumpsize;
381 dumplo -= sizeof(kdh) * 2;
383 mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_IA64_VERSION, dumpsize, di->blocksize);
385 printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
389 error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
392 dumplo += sizeof(kdh);
394 /* Dump ELF header */
395 error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
399 /* Dump program headers */
400 status = (minidump) ? virt_foreach(virt_cb_dumphdr, di) :
401 phys_foreach(phys_cb_dumphdr, di);
409 * All headers are written using blocked I/O, so we know the
410 * current offset is (still) block aligned. Skip the alignment
411 * in the file to have the segment contents aligned at page
412 * boundary. For physical dumps, it's the EFI page size (= 4K).
413 * For minidumps it's the kernel's page size (= 8K).
417 /* Dump memory chunks (updates dumplo) */
418 status = (minidump) ? virt_foreach(virt_cb_dumpdata, di) :
419 phys_foreach(phys_cb_dumpdata, di);
426 error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
430 /* Signal completion, signoff and exit stage left. */
431 dump_write(di, NULL, 0, 0, 0);
432 printf("\nDump complete\n");
436 if (error == ECANCELED)
437 printf("\nDump aborted\n");
439 printf("\n** DUMP FAILED (ERROR %d) **\n", error);