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.
26 * $FreeBSD: src/sys/i386/i386/dump_machdep.c,v 1.20 2009/12/10 03:09:35 kmacy Exp $
29 #include <sys/param.h>
30 #include <sys/systm.h>
33 #include <sys/sysctl.h>
34 #include <sys/device.h>
35 #include <sys/kernel.h>
36 #include <sys/kerneldump.h>
39 #include <machine/elf.h>
40 #include <machine/md_var.h>
41 #include <machine/thread.h>
42 #include <sys/thread2.h>
44 CTASSERT(sizeof(struct kerneldumpheader) == 512);
47 TUNABLE_INT("debug.minidump", &do_minidump);
48 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &do_minidump, 0,
49 "Enable mini crash dumps");
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.
56 #define SIZEOF_METADATA (64*1024)
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))
66 typedef int callback_t(struct md_pa *, int, void *);
68 static struct kerneldumpheader kdh;
69 static off_t dumplo, fileofs;
71 /* Handle buffered writes. */
72 static char buffer[DEV_BSIZE];
75 /* 20 phys_avail entry pairs correspond to 10 md_pa's */
76 static struct md_pa dump_map[10];
83 bzero(dump_map, sizeof(dump_map));
84 for (n = 0; n < NELEM(dump_map); n++) {
86 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
88 dump_map[n].md_start = dump_avail[idx];
89 dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
97 return (&dump_map[0]);
100 static struct md_pa *
101 md_pa_next(struct md_pa *mdp)
105 if (mdp->md_size == 0)
111 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
117 len = DEV_BSIZE - fragsz;
120 bcopy(ptr, buffer + fragsz, len);
124 if (fragsz == DEV_BSIZE) {
125 error = dev_ddump(di->priv, buffer, 0, dumplo,
138 buf_flush(struct dumperinfo *di)
145 error = dev_ddump(di->priv, buffer, 0, dumplo, DEV_BSIZE);
151 #define PG2MB(pgs) ((pgs + (1 << 8) - 1) >> 8)
154 cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
156 struct dumperinfo *di = (struct dumperinfo*)arg;
160 size_t counter, sz, chunk;
163 error = 0; /* catch case in which chunk size is 0 */
164 counter = 0; /* Update twiddle every 16MB */
166 pgs = mdp->md_size / PAGE_SIZE;
169 kprintf(" chunk %d: %lldMB (%lld pages)", seqnr, PG2MB(pgs), pgs);
173 if (chunk > MAXDUMPPGS)
175 sz = chunk << PAGE_SHIFT;
178 kprintf(" %lld", PG2MB(pgs));
179 counter &= (1<<24) - 1;
181 for (i = 0; i < chunk; i++) {
182 a = pa + i * PAGE_SIZE;
183 va = pmap_kenter_temporary(trunc_page(a), i);
186 error = dev_ddump(di->priv, va, 0, dumplo, sz);
193 /* Check for user abort. */
198 kprintf(" (CTRL-C to abort) ");
200 kprintf(" ... %s\n", (error) ? "fail" : "ok");
205 cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
207 struct dumperinfo *di = (struct dumperinfo*)arg;
213 bzero(&phdr, sizeof(phdr));
214 phdr.p_type = PT_LOAD;
215 phdr.p_flags = PF_R; /* XXX */
216 phdr.p_offset = fileofs;
217 phdr.p_vaddr = mdp->md_start;
218 phdr.p_paddr = mdp->md_start;
219 phdr.p_filesz = size;
221 phdr.p_align = PAGE_SIZE;
223 error = buf_write(di, (char*)&phdr, sizeof(phdr));
224 fileofs += phdr.p_filesz;
229 cb_size(struct md_pa *mdp, int seqnr, void *arg)
231 uint64_t *sz = (uint64_t*)arg;
233 *sz += (uint64_t)mdp->md_size;
238 foreach_chunk(callback_t cb, void *arg)
245 while (mdp != NULL) {
246 error = (*cb)(mdp, seqnr++, arg);
249 mdp = md_pa_next(mdp);
255 md_dumpsys(struct dumperinfo *di)
264 dumpthread = curthread;
271 bzero(&ehdr, sizeof(ehdr));
272 ehdr.e_ident[EI_MAG0] = ELFMAG0;
273 ehdr.e_ident[EI_MAG1] = ELFMAG1;
274 ehdr.e_ident[EI_MAG2] = ELFMAG2;
275 ehdr.e_ident[EI_MAG3] = ELFMAG3;
276 ehdr.e_ident[EI_CLASS] = ELF_CLASS;
277 #if BYTE_ORDER == LITTLE_ENDIAN
278 ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
280 ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
282 ehdr.e_ident[EI_VERSION] = EV_CURRENT;
283 ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE; /* XXX big picture? */
284 ehdr.e_type = ET_CORE;
285 ehdr.e_machine = EM_386;
286 ehdr.e_phoff = sizeof(ehdr);
288 ehdr.e_ehsize = sizeof(ehdr);
289 ehdr.e_phentsize = sizeof(Elf_Phdr);
290 ehdr.e_shentsize = sizeof(Elf_Shdr);
294 /* Calculate dump size. */
296 ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
297 hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
298 fileofs = MD_ALIGN(hdrsz);
300 hdrgap = fileofs - DEV_ALIGN(hdrsz);
302 /* Determine dump offset on device. */
303 if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
307 dumplo = di->mediaoffset + di->mediasize - dumpsize;
308 dumplo -= sizeof(kdh) * 2;
310 mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_I386_VERSION,
311 dumpsize, di->blocksize);
313 kprintf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
317 error = dev_ddump(di->priv, &kdh, 0, dumplo, sizeof(kdh));
320 dumplo += sizeof(kdh);
322 /* Dump ELF header */
323 error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
327 /* Dump program headers */
328 error = foreach_chunk(cb_dumphdr, di);
334 * All headers are written using blocked I/O, so we know the
335 * current offset is (still) block aligned. Skip the alignement
336 * in the file to have the segment contents aligned at page
337 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
338 * care and may very well be unaligned within the dump device.
342 /* Dump memory chunks (updates dumplo) */
343 error = foreach_chunk(cb_dumpdata, di);
348 error = dev_ddump(di->priv, &kdh, 0, dumplo, sizeof(kdh));
352 /* Signal completion, signoff and exit stage left. */
353 dev_ddump(di->priv, NULL, 0, 0, 0);
354 kprintf("\nDump complete\n");
361 if (error == ECANCELED)
362 kprintf("\nDump aborted\n");
363 else if (error == ENOSPC)
364 kprintf("\nDump failed. Partition too small.\n");
366 kprintf("\n** DUMP FAILED (ERROR %d) **\n", error);