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 <sys/param.h>
31 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/kerneldump.h>
36 #include <sys/sysctl.h>
39 #include <machine/elf.h>
40 #include <machine/md_var.h>
42 CTASSERT(sizeof(struct kerneldumpheader) == 512);
45 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
46 * is to protect us from metadata and to protect metadata from us.
48 #define SIZEOF_METADATA (64*1024)
50 #define MD_ALIGN(x) (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
51 #define DEV_ALIGN(x) (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
53 typedef int callback_t(struct pmap_md *, int, void *);
55 static struct kerneldumpheader kdh;
56 static off_t dumplo, fileofs;
58 /* Handle buffered writes. */
59 static char buffer[DEV_BSIZE];
62 int dumpsys_minidump = 1;
63 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RD, &dumpsys_minidump, 0,
64 "Kernel makes compressed crash dumps");
67 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
73 len = DEV_BSIZE - fragsz;
76 bcopy(ptr, buffer + fragsz, len);
80 if (fragsz == DEV_BSIZE) {
81 error = di->dumper(di->priv, buffer, 0, dumplo,
94 buf_flush(struct dumperinfo *di)
101 error = di->dumper(di->priv, buffer, 0, dumplo, DEV_BSIZE);
108 cb_dumpdata(struct pmap_md *md, int seqnr, void *arg)
110 struct dumperinfo *di = (struct dumperinfo*)arg;
112 size_t counter, ofs, resid, sz;
113 int c, error, twiddle;
116 counter = 0; /* Update twiddle every 16MB */
119 ofs = 0; /* Logical offset within the chunk */
122 printf(" chunk %d: %lu bytes ", seqnr, (u_long)resid);
125 sz = (resid > DFLTPHYS) ? DFLTPHYS : resid;
126 va = pmap_dumpsys_map(md, ofs, &sz);
129 printf("%c\b", "|/-\\"[twiddle++ & 3]);
130 counter &= (1<<24) - 1;
132 error = di->dumper(di->priv, (void*)va, 0, dumplo, sz);
133 pmap_dumpsys_unmap(md, ofs, va);
140 /* Check for user abort. */
145 printf("(CTRL-C to abort) ");
147 printf("... %s\n", (error) ? "fail" : "ok");
152 cb_dumphdr(struct pmap_md *md, int seqnr, void *arg)
154 struct dumperinfo *di = (struct dumperinfo*)arg;
158 bzero(&phdr, sizeof(phdr));
159 phdr.p_type = PT_LOAD;
160 phdr.p_flags = PF_R; /* XXX */
161 phdr.p_offset = fileofs;
162 phdr.p_vaddr = md->md_vaddr;
163 phdr.p_paddr = md->md_paddr;
164 phdr.p_filesz = md->md_size;
165 phdr.p_memsz = md->md_size;
166 phdr.p_align = PAGE_SIZE;
168 error = buf_write(di, (char*)&phdr, sizeof(phdr));
169 fileofs += phdr.p_filesz;
174 cb_size(struct pmap_md *md, int seqnr, void *arg)
176 uint32_t *sz = (uint32_t*)arg;
183 foreach_chunk(callback_t cb, void *arg)
189 md = pmap_scan_md(NULL);
191 error = (*cb)(md, seqnr++, arg);
194 md = pmap_scan_md(md);
200 dumpsys(struct dumperinfo *di)
208 bzero(&ehdr, sizeof(ehdr));
209 ehdr.e_ident[EI_MAG0] = ELFMAG0;
210 ehdr.e_ident[EI_MAG1] = ELFMAG1;
211 ehdr.e_ident[EI_MAG2] = ELFMAG2;
212 ehdr.e_ident[EI_MAG3] = ELFMAG3;
213 ehdr.e_ident[EI_CLASS] = ELFCLASS32;
214 #if BYTE_ORDER == LITTLE_ENDIAN
215 ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
217 ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
219 ehdr.e_ident[EI_VERSION] = EV_CURRENT;
220 ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE; /* XXX big picture? */
221 ehdr.e_type = ET_CORE;
222 ehdr.e_machine = EM_PPC;
223 ehdr.e_phoff = sizeof(ehdr);
224 ehdr.e_ehsize = sizeof(ehdr);
225 ehdr.e_phentsize = sizeof(Elf32_Phdr);
226 ehdr.e_shentsize = sizeof(Elf32_Shdr);
228 /* Calculate dump size. */
230 ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
231 hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
232 fileofs = MD_ALIGN(hdrsz);
234 hdrgap = fileofs - DEV_ALIGN(hdrsz);
236 /* For block devices, determine the dump offset on the device. */
237 if (di->mediasize > 0) {
239 SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
243 dumplo = di->mediaoffset + di->mediasize - dumpsize;
244 dumplo -= sizeof(kdh) * 2;
248 mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_POWERPC_VERSION, dumpsize,
251 printf("Dumping %u MB (%d chunks)\n", dumpsize >> 20,
255 error = di->dumper(di->priv, &kdh, 0, dumplo, sizeof(kdh));
258 dumplo += sizeof(kdh);
260 /* Dump ELF header */
261 error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
265 /* Dump program headers */
266 error = foreach_chunk(cb_dumphdr, di);
272 * All headers are written using blocked I/O, so we know the
273 * current offset is (still) block aligned. Skip the alignement
274 * in the file to have the segment contents aligned at page
275 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
276 * care and may very well be unaligned within the dump device.
280 /* Dump memory chunks (updates dumplo) */
281 error = foreach_chunk(cb_dumpdata, di);
286 error = di->dumper(di->priv, &kdh, 0, dumplo, sizeof(kdh));
290 /* Signal completion, signoff and exit stage left. */
291 di->dumper(di->priv, NULL, 0, 0, 0);
292 printf("\nDump complete\n");
299 if (error == ECANCELED)
300 printf("\nDump aborted\n");
302 printf("\n** DUMP FAILED (ERROR %d) **\n", error);