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>
35 #include <sys/kernel.h>
36 #include <sys/kerneldump.h>
37 #include <sys/malloc.h>
38 #include <sys/msgbuf.h>
40 #include <sys/watchdog.h>
43 #include <vm/vm_param.h>
44 #include <vm/vm_page.h>
45 #include <vm/vm_phys.h>
46 #include <vm/vm_dumpset.h>
49 #include <machine/dump.h>
50 #include <machine/elf.h>
51 #include <machine/md_var.h>
52 #include <machine/pcb.h>
54 CTASSERT(sizeof(struct kerneldumpheader) == 512);
56 #define MD_ALIGN(x) roundup2((off_t)(x), PAGE_SIZE)
58 /* Handle buffered writes. */
61 struct dump_pa dump_map[DUMPSYS_MD_PA_NPAIRS];
63 #if !defined(__powerpc__)
65 dumpsys_gen_pa_init(void)
69 bzero(dump_map, sizeof(dump_map));
70 for (n = 0; n < nitems(dump_map); n++) {
72 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
74 dump_map[n].pa_start = dump_avail[idx];
75 dump_map[n].pa_size = dump_avail[idx + 1] - dump_avail[idx];
81 dumpsys_gen_pa_next(struct dump_pa *mdp)
85 return (&dump_map[0]);
88 if (mdp->pa_size == 0)
94 dumpsys_gen_wbinv_all(void)
100 dumpsys_gen_unmap_chunk(vm_paddr_t pa __unused, size_t chunk __unused,
107 dumpsys_gen_write_aux_headers(struct dumperinfo *di)
114 dumpsys_buf_seek(struct dumperinfo *di, size_t sz)
116 static uint8_t buf[DEV_BSIZE];
120 bzero(buf, sizeof(buf));
123 nbytes = MIN(sz, sizeof(buf));
125 error = dump_append(di, buf, nbytes);
135 dumpsys_buf_write(struct dumperinfo *di, char *ptr, size_t sz)
141 len = di->blocksize - fragsz;
144 memcpy((char *)di->blockbuf + fragsz, ptr, len);
148 if (fragsz == di->blocksize) {
149 error = dump_append(di, di->blockbuf, di->blocksize);
159 dumpsys_buf_flush(struct dumperinfo *di)
166 error = dump_append(di, di->blockbuf, di->blocksize);
171 CTASSERT(PAGE_SHIFT < 20);
172 #define PG2MB(pgs) ((pgs + (1 << (20 - PAGE_SHIFT)) - 1) >> (20 - PAGE_SHIFT))
175 dumpsys_cb_dumpdata(struct dump_pa *mdp, int seqnr, void *arg)
177 struct dumperinfo *di = (struct dumperinfo*)arg;
181 size_t counter, sz, chunk;
185 error = 0; /* catch case in which chunk size is 0 */
186 counter = 0; /* Update twiddle every 16MB */
188 pgs = mdp->pa_size / PAGE_SIZE;
190 maxdumppgs = min(di->maxiosize / PAGE_SIZE, MAXDUMPPGS);
191 if (maxdumppgs == 0) /* seatbelt */
194 printf(" chunk %d: %juMB (%ju pages)", seqnr, (uintmax_t)PG2MB(pgs),
200 if (chunk > maxdumppgs)
202 sz = chunk << PAGE_SHIFT;
205 printf(" %ju", (uintmax_t)PG2MB(pgs));
206 counter &= (1 << 24) - 1;
209 dumpsys_map_chunk(pa, chunk, &va);
210 wdog_kern_pat(WD_LASTVAL);
212 error = dump_append(di, va, sz);
213 dumpsys_unmap_chunk(pa, chunk, va);
219 /* Check for user abort. */
224 printf(" (CTRL-C to abort) ");
226 printf(" ... %s\n", (error) ? "fail" : "ok");
231 dumpsys_foreach_chunk(dumpsys_callback_t cb, void *arg)
237 mdp = dumpsys_pa_next(NULL);
238 while (mdp != NULL) {
239 error = (*cb)(mdp, seqnr++, arg);
242 mdp = dumpsys_pa_next(mdp);
247 static off_t fileofs;
250 cb_dumphdr(struct dump_pa *mdp, int seqnr, void *arg)
252 struct dumperinfo *di = (struct dumperinfo*)arg;
258 bzero(&phdr, sizeof(phdr));
259 phdr.p_type = PT_LOAD;
260 phdr.p_flags = PF_R; /* XXX */
261 phdr.p_offset = fileofs;
263 phdr.p_vaddr = (do_minidump? mdp->pa_start : ~0L);
264 phdr.p_paddr = (do_minidump? ~0L : mdp->pa_start);
266 phdr.p_vaddr = mdp->pa_start;
267 phdr.p_paddr = mdp->pa_start;
269 phdr.p_filesz = size;
271 phdr.p_align = PAGE_SIZE;
273 error = dumpsys_buf_write(di, (char*)&phdr, sizeof(phdr));
274 fileofs += phdr.p_filesz;
279 cb_size(struct dump_pa *mdp, int seqnr, void *arg)
283 sz = (uint64_t *)arg;
284 *sz += (uint64_t)mdp->pa_size;
289 dumpsys_generic(struct dumperinfo *di)
291 static struct kerneldumpheader kdh;
298 #if MINIDUMP_PAGE_TRACKING == 1
300 return (minidumpsys(di, false));
303 bzero(&ehdr, sizeof(ehdr));
304 ehdr.e_ident[EI_MAG0] = ELFMAG0;
305 ehdr.e_ident[EI_MAG1] = ELFMAG1;
306 ehdr.e_ident[EI_MAG2] = ELFMAG2;
307 ehdr.e_ident[EI_MAG3] = ELFMAG3;
308 ehdr.e_ident[EI_CLASS] = ELF_CLASS;
309 #if BYTE_ORDER == LITTLE_ENDIAN
310 ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
312 ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
314 ehdr.e_ident[EI_VERSION] = EV_CURRENT;
315 ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE; /* XXX big picture? */
316 ehdr.e_type = ET_CORE;
317 ehdr.e_machine = EM_VALUE;
318 ehdr.e_phoff = sizeof(ehdr);
320 ehdr.e_ehsize = sizeof(ehdr);
321 ehdr.e_phentsize = sizeof(Elf_Phdr);
322 ehdr.e_shentsize = sizeof(Elf_Shdr);
326 /* Calculate dump size. */
328 ehdr.e_phnum = dumpsys_foreach_chunk(cb_size, &dumpsize) +
329 DUMPSYS_NUM_AUX_HDRS;
330 hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
331 fileofs = MD_ALIGN(hdrsz);
333 hdrgap = fileofs - roundup2((off_t)hdrsz, di->blocksize);
335 dump_init_header(di, &kdh, KERNELDUMPMAGIC, KERNELDUMP_ARCH_VERSION,
338 error = dump_start(di, &kdh);
342 printf("Dumping %ju MB (%d chunks)\n", (uintmax_t)dumpsize >> 20,
343 ehdr.e_phnum - DUMPSYS_NUM_AUX_HDRS);
345 /* Dump ELF header */
346 error = dumpsys_buf_write(di, (char*)&ehdr, sizeof(ehdr));
350 /* Dump program headers */
351 error = dumpsys_foreach_chunk(cb_dumphdr, di);
354 error = dumpsys_write_aux_headers(di);
357 dumpsys_buf_flush(di);
360 * All headers are written using blocked I/O, so we know the
361 * current offset is (still) block aligned. Skip the alignement
362 * in the file to have the segment contents aligned at page
365 error = dumpsys_buf_seek(di, (size_t)hdrgap);
369 /* Dump memory chunks. */
370 error = dumpsys_foreach_chunk(dumpsys_cb_dumpdata, di);
374 error = dump_finish(di, &kdh);
378 printf("\nDump complete\n");
385 if (error == ECANCELED)
386 printf("\nDump aborted\n");
387 else if (error == E2BIG || error == ENOSPC)
388 printf("\nDump failed. Partition too small.\n");
390 printf("\n** DUMP FAILED (ERROR %d) **\n", error);
394 #if MINIDUMP_PAGE_TRACKING == 1
396 /* Minidump progress bar */
401 } progress_track[10] = {
414 static uint64_t dumpsys_pb_size;
415 static uint64_t dumpsys_pb_remaining;
416 static uint64_t dumpsys_pb_check;
418 /* Reset the progress bar for a dump of dumpsize. */
420 dumpsys_pb_init(uint64_t dumpsize)
424 dumpsys_pb_size = dumpsys_pb_remaining = dumpsize;
425 dumpsys_pb_check = 0;
427 for (i = 0; i < nitems(progress_track); i++)
428 progress_track[i].visited = false;
432 * Update the progress according to the delta bytes that were written out.
433 * Check and print the progress percentage.
436 dumpsys_pb_progress(size_t delta)
440 dumpsys_pb_remaining -= delta;
441 dumpsys_pb_check += delta;
444 * To save time while dumping, only loop through progress_track
447 if ((dumpsys_pb_check >> DUMPSYS_PB_CHECK_BITS) == 0)
450 dumpsys_pb_check &= (1 << DUMPSYS_PB_CHECK_BITS) - 1;
452 sofar = 100 - ((dumpsys_pb_remaining * 100) / dumpsys_pb_size);
453 for (i = 0; i < nitems(progress_track); i++) {
454 if (sofar < progress_track[i].min_per ||
455 sofar > progress_track[i].max_per)
457 if (!progress_track[i].visited) {
458 progress_track[i].visited = true;
459 printf("..%d%%", sofar);
466 minidumpsys(struct dumperinfo *di, bool livedump)
468 struct minidumpstate state;
469 struct msgbuf mb_copy;
475 KASSERT(!dumping, ("live dump invoked from incorrect context"));
478 * Before invoking cpu_minidumpsys() on the live system, we
479 * must snapshot some required global state: the message
480 * buffer, and the page dump bitset. They may be modified at
481 * any moment, so for the sake of the live dump it is best to
482 * have an unchanging snapshot to work with. Both are included
483 * as part of the dump and consumed by userspace tools.
485 * Other global state important to the minidump code is the
486 * dump_avail array and the kernel's page tables, but snapshots
487 * are not taken of these. For one, dump_avail[] is expected
488 * not to change after boot. Snapshotting the kernel page
489 * tables would involve an additional walk, so this is avoided
492 * This means live dumps are best effort, and the result may or
493 * may not be usable; there are no guarantees about the
494 * consistency of the dump's contents. Any of the following
495 * (and likely more) may affect the live dump:
497 * - Data may be modified, freed, or remapped during the
498 * course of the dump, such that the contents written out
499 * are partially or entirely unrecognizable. This means
500 * valid references may point to destroyed/mangled objects,
503 * - The dumped context of any threads that ran during the
504 * dump process may be unreliable.
506 * - The set of kernel page tables included in the dump likely
507 * won't correspond exactly to the copy of the dump bitset.
508 * This means some pages will be dumped without any way to
509 * locate them, and some pages may not have been dumped
510 * despite appearing as if they should.
512 msg_ptr = malloc(msgbufsize, M_TEMP, M_WAITOK);
513 msgbuf_duplicate(msgbufp, &mb_copy, msg_ptr);
514 state.msgbufp = &mb_copy;
516 sz = BITSET_SIZE(vm_page_dump_pages);
517 state.dump_bitset = malloc(sz, M_TEMP, M_WAITOK);
518 BIT_COPY_STORE_REL(sz, vm_page_dump, state.dump_bitset);
520 KASSERT(dumping, ("minidump invoked outside of doadump()"));
522 /* Use the globals. */
523 state.msgbufp = msgbufp;
524 state.dump_bitset = vm_page_dump;
527 error = cpu_minidumpsys(di, &state);
529 free(msg_ptr, M_TEMP);
530 free(state.dump_bitset, M_TEMP);
535 #endif /* MINIDUMP_PAGE_TRACKING == 1 */