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>
36 #include <sys/kernel.h>
38 #include <sys/kerneldump.h>
40 #include <sys/watchdog.h>
43 #include <vm/vm_param.h>
45 #include <machine/dump.h>
46 #include <machine/elf.h>
47 #include <machine/md_var.h>
48 #include <machine/pcb.h>
50 CTASSERT(sizeof(struct kerneldumpheader) == 512);
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) roundup2((off_t)(x), PAGE_SIZE)
62 /* Handle buffered writes. */
65 struct dump_pa dump_map[DUMPSYS_MD_PA_NPAIRS];
67 #if !defined(__powerpc__) && !defined(__sparc__)
69 dumpsys_gen_pa_init(void)
73 bzero(dump_map, sizeof(dump_map));
74 for (n = 0; n < nitems(dump_map); n++) {
76 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
78 dump_map[n].pa_start = dump_avail[idx];
79 dump_map[n].pa_size = dump_avail[idx + 1] - dump_avail[idx];
85 dumpsys_gen_pa_next(struct dump_pa *mdp)
89 return (&dump_map[0]);
92 if (mdp->pa_size == 0)
98 dumpsys_gen_wbinv_all(void)
104 dumpsys_gen_unmap_chunk(vm_paddr_t pa __unused, size_t chunk __unused,
110 #if !defined(__sparc__)
112 dumpsys_gen_write_aux_headers(struct dumperinfo *di)
120 dumpsys_buf_seek(struct dumperinfo *di, size_t sz)
122 static uint8_t buf[DEV_BSIZE];
126 bzero(buf, sizeof(buf));
129 nbytes = MIN(sz, sizeof(buf));
131 error = dump_write(di, buf, 0, dumplo, nbytes);
143 dumpsys_buf_write(struct dumperinfo *di, char *ptr, size_t sz)
149 len = di->blocksize - fragsz;
152 memcpy((char *)di->blockbuf + fragsz, ptr, len);
156 if (fragsz == di->blocksize) {
157 error = dump_write(di, di->blockbuf, 0, dumplo,
161 dumplo += di->blocksize;
169 dumpsys_buf_flush(struct dumperinfo *di)
176 error = dump_write(di, di->blockbuf, 0, dumplo, di->blocksize);
177 dumplo += di->blocksize;
182 CTASSERT(PAGE_SHIFT < 20);
183 #define PG2MB(pgs) ((pgs + (1 << (20 - PAGE_SHIFT)) - 1) >> (20 - PAGE_SHIFT))
186 dumpsys_cb_dumpdata(struct dump_pa *mdp, int seqnr, void *arg)
188 struct dumperinfo *di = (struct dumperinfo*)arg;
192 size_t counter, sz, chunk;
196 error = 0; /* catch case in which chunk size is 0 */
197 counter = 0; /* Update twiddle every 16MB */
199 pgs = mdp->pa_size / PAGE_SIZE;
201 maxdumppgs = min(di->maxiosize / PAGE_SIZE, MAXDUMPPGS);
202 if (maxdumppgs == 0) /* seatbelt */
205 printf(" chunk %d: %juMB (%ju pages)", seqnr, (uintmax_t)PG2MB(pgs),
211 if (chunk > maxdumppgs)
213 sz = chunk << PAGE_SHIFT;
216 printf(" %ju", (uintmax_t)PG2MB(pgs));
217 counter &= (1 << 24) - 1;
220 dumpsys_map_chunk(pa, chunk, &va);
222 wdog_kern_pat(WD_LASTVAL);
225 error = dump_write(di, va, 0, dumplo, sz);
226 dumpsys_unmap_chunk(pa, chunk, va);
233 /* Check for user abort. */
238 printf(" (CTRL-C to abort) ");
240 printf(" ... %s\n", (error) ? "fail" : "ok");
245 dumpsys_foreach_chunk(dumpsys_callback_t cb, void *arg)
251 mdp = dumpsys_pa_next(NULL);
252 while (mdp != NULL) {
253 error = (*cb)(mdp, seqnr++, arg);
256 mdp = dumpsys_pa_next(mdp);
261 #if !defined(__sparc__)
262 static off_t fileofs;
265 cb_dumphdr(struct dump_pa *mdp, int seqnr, void *arg)
267 struct dumperinfo *di = (struct dumperinfo*)arg;
273 bzero(&phdr, sizeof(phdr));
274 phdr.p_type = PT_LOAD;
275 phdr.p_flags = PF_R; /* XXX */
276 phdr.p_offset = fileofs;
278 phdr.p_vaddr = (do_minidump? mdp->pa_start : ~0L);
279 phdr.p_paddr = (do_minidump? ~0L : mdp->pa_start);
281 phdr.p_vaddr = mdp->pa_start;
282 phdr.p_paddr = mdp->pa_start;
284 phdr.p_filesz = size;
286 phdr.p_align = PAGE_SIZE;
288 error = dumpsys_buf_write(di, (char*)&phdr, sizeof(phdr));
289 fileofs += phdr.p_filesz;
294 cb_size(struct dump_pa *mdp, int seqnr, void *arg)
298 sz = (uint64_t *)arg;
299 *sz += (uint64_t)mdp->pa_size;
304 dumpsys_generic(struct dumperinfo *di)
306 static struct kerneldumpheader kdh;
315 return (minidumpsys(di));
318 bzero(&ehdr, sizeof(ehdr));
319 ehdr.e_ident[EI_MAG0] = ELFMAG0;
320 ehdr.e_ident[EI_MAG1] = ELFMAG1;
321 ehdr.e_ident[EI_MAG2] = ELFMAG2;
322 ehdr.e_ident[EI_MAG3] = ELFMAG3;
323 ehdr.e_ident[EI_CLASS] = ELF_CLASS;
324 #if BYTE_ORDER == LITTLE_ENDIAN
325 ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
327 ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
329 ehdr.e_ident[EI_VERSION] = EV_CURRENT;
330 ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE; /* XXX big picture? */
331 ehdr.e_type = ET_CORE;
332 ehdr.e_machine = EM_VALUE;
333 ehdr.e_phoff = sizeof(ehdr);
335 ehdr.e_ehsize = sizeof(ehdr);
336 ehdr.e_phentsize = sizeof(Elf_Phdr);
337 ehdr.e_shentsize = sizeof(Elf_Shdr);
341 /* Calculate dump size. */
343 ehdr.e_phnum = dumpsys_foreach_chunk(cb_size, &dumpsize) +
344 DUMPSYS_NUM_AUX_HDRS;
345 hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
346 fileofs = MD_ALIGN(hdrsz);
348 hdrgap = fileofs - roundup2((off_t)hdrsz, di->blocksize);
350 /* Determine dump offset on device. */
351 if (di->mediasize < SIZEOF_METADATA + dumpsize + di->blocksize * 2 +
352 kerneldumpcrypto_dumpkeysize(di->kdc)) {
356 dumplo = di->mediaoffset + di->mediasize - dumpsize;
357 dumplo -= di->blocksize * 2;
358 dumplo -= kerneldumpcrypto_dumpkeysize(di->kdc);
360 /* Initialize kernel dump crypto. */
361 error = kerneldumpcrypto_init(di->kdc);
365 mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_ARCH_VERSION, dumpsize,
366 kerneldumpcrypto_dumpkeysize(di->kdc), di->blocksize);
368 printf("Dumping %ju MB (%d chunks)\n", (uintmax_t)dumpsize >> 20,
369 ehdr.e_phnum - DUMPSYS_NUM_AUX_HDRS);
372 error = dump_write_header(di, &kdh, 0, dumplo);
375 dumplo += di->blocksize;
378 error = dump_write_key(di, 0, dumplo);
381 dumplo += kerneldumpcrypto_dumpkeysize(di->kdc);
383 /* Dump ELF header */
384 error = dumpsys_buf_write(di, (char*)&ehdr, sizeof(ehdr));
388 /* Dump program headers */
389 error = dumpsys_foreach_chunk(cb_dumphdr, di);
392 error = dumpsys_write_aux_headers(di);
395 dumpsys_buf_flush(di);
398 * All headers are written using blocked I/O, so we know the
399 * current offset is (still) block aligned. Skip the alignement
400 * in the file to have the segment contents aligned at page
401 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
402 * care and may very well be unaligned within the dump device.
404 error = dumpsys_buf_seek(di, (size_t)hdrgap);
408 /* Dump memory chunks (updates dumplo) */
409 error = dumpsys_foreach_chunk(dumpsys_cb_dumpdata, di);
414 error = dump_write_header(di, &kdh, 0, dumplo);
417 dumplo += di->blocksize;
419 /* Signal completion, signoff and exit stage left. */
420 dump_write(di, NULL, 0, 0, 0);
421 printf("\nDump complete\n");
428 if (error == ECANCELED)
429 printf("\nDump aborted\n");
430 else if (error == ENOSPC)
431 printf("\nDump failed. Partition too small.\n");
433 printf("\n** DUMP FAILED (ERROR %d) **\n", error);