2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1986, 1988, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)kern_shutdown.c 8.3 (Berkeley) 1/21/94
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
45 #include "opt_panic.h"
46 #include "opt_printf.h"
47 #include "opt_sched.h"
48 #include "opt_watchdog.h"
50 #include <sys/param.h>
51 #include <sys/systm.h>
55 #include <sys/compressor.h>
58 #include <sys/eventhandler.h>
59 #include <sys/filedesc.h>
62 #include <sys/kernel.h>
63 #include <sys/kerneldump.h>
64 #include <sys/kthread.h>
66 #include <sys/malloc.h>
68 #include <sys/mount.h>
71 #include <sys/reboot.h>
72 #include <sys/resourcevar.h>
73 #include <sys/rwlock.h>
75 #include <sys/sched.h>
77 #include <sys/sysctl.h>
78 #include <sys/sysproto.h>
79 #include <sys/taskqueue.h>
80 #include <sys/vnode.h>
81 #include <sys/watchdog.h>
83 #include <crypto/chacha20/chacha.h>
84 #include <crypto/rijndael/rijndael-api-fst.h>
85 #include <crypto/sha2/sha256.h>
89 #include <machine/cpu.h>
90 #include <machine/dump.h>
91 #include <machine/pcb.h>
92 #include <machine/smp.h>
94 #include <security/mac/mac_framework.h>
97 #include <vm/vm_object.h>
98 #include <vm/vm_page.h>
99 #include <vm/vm_pager.h>
100 #include <vm/swap_pager.h>
102 #include <sys/signalvar.h>
104 static MALLOC_DEFINE(M_DUMPER, "dumper", "dumper block buffer");
106 #ifndef PANIC_REBOOT_WAIT_TIME
107 #define PANIC_REBOOT_WAIT_TIME 15 /* default to 15 seconds */
109 static int panic_reboot_wait_time = PANIC_REBOOT_WAIT_TIME;
110 SYSCTL_INT(_kern, OID_AUTO, panic_reboot_wait_time, CTLFLAG_RWTUN,
111 &panic_reboot_wait_time, 0,
112 "Seconds to wait before rebooting after a panic");
115 * Note that stdarg.h and the ANSI style va_start macro is used for both
116 * ANSI and traditional C compilers.
118 #include <machine/stdarg.h>
121 #ifdef KDB_UNATTENDED
122 int debugger_on_panic = 0;
124 int debugger_on_panic = 1;
126 SYSCTL_INT(_debug, OID_AUTO, debugger_on_panic,
127 CTLFLAG_RWTUN | CTLFLAG_SECURE,
128 &debugger_on_panic, 0, "Run debugger on kernel panic");
130 int debugger_on_trap = 0;
131 SYSCTL_INT(_debug, OID_AUTO, debugger_on_trap,
132 CTLFLAG_RWTUN | CTLFLAG_SECURE,
133 &debugger_on_trap, 0, "Run debugger on kernel trap before panic");
136 static int trace_on_panic = 1;
137 static bool trace_all_panics = true;
139 static int trace_on_panic = 0;
140 static bool trace_all_panics = false;
142 SYSCTL_INT(_debug, OID_AUTO, trace_on_panic,
143 CTLFLAG_RWTUN | CTLFLAG_SECURE,
144 &trace_on_panic, 0, "Print stack trace on kernel panic");
145 SYSCTL_BOOL(_debug, OID_AUTO, trace_all_panics, CTLFLAG_RWTUN,
146 &trace_all_panics, 0, "Print stack traces on secondary kernel panics");
149 static int sync_on_panic = 0;
150 SYSCTL_INT(_kern, OID_AUTO, sync_on_panic, CTLFLAG_RWTUN,
151 &sync_on_panic, 0, "Do a sync before rebooting from a panic");
153 static bool poweroff_on_panic = 0;
154 SYSCTL_BOOL(_kern, OID_AUTO, poweroff_on_panic, CTLFLAG_RWTUN,
155 &poweroff_on_panic, 0, "Do a power off instead of a reboot on a panic");
157 static bool powercycle_on_panic = 0;
158 SYSCTL_BOOL(_kern, OID_AUTO, powercycle_on_panic, CTLFLAG_RWTUN,
159 &powercycle_on_panic, 0, "Do a power cycle instead of a reboot on a panic");
161 static SYSCTL_NODE(_kern, OID_AUTO, shutdown, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
162 "Shutdown environment");
165 static int show_busybufs;
167 static int show_busybufs = 1;
169 SYSCTL_INT(_kern_shutdown, OID_AUTO, show_busybufs, CTLFLAG_RW,
171 "Show busy buffers during shutdown");
173 int suspend_blocked = 0;
174 SYSCTL_INT(_kern, OID_AUTO, suspend_blocked, CTLFLAG_RW,
175 &suspend_blocked, 0, "Block suspend due to a pending shutdown");
178 FEATURE(ekcd, "Encrypted kernel crash dumps support");
180 MALLOC_DEFINE(M_EKCD, "ekcd", "Encrypted kernel crash dumps data");
182 struct kerneldumpcrypto {
183 uint8_t kdc_encryption;
184 uint8_t kdc_iv[KERNELDUMP_IV_MAX_SIZE];
188 cipherInstance aes_ci;
190 struct chacha_ctx u_chacha;
192 #define kdc_ki u.u_aes.aes_ki
193 #define kdc_ci u.u_aes.aes_ci
194 #define kdc_chacha u.u_chacha
195 uint32_t kdc_dumpkeysize;
196 struct kerneldumpkey kdc_dumpkey[];
200 struct kerneldumpcomp {
202 struct compressor *kdc_stream;
207 static struct kerneldumpcomp *kerneldumpcomp_create(struct dumperinfo *di,
208 uint8_t compression);
209 static void kerneldumpcomp_destroy(struct dumperinfo *di);
210 static int kerneldumpcomp_write_cb(void *base, size_t len, off_t off, void *arg);
212 static int kerneldump_gzlevel = 6;
213 SYSCTL_INT(_kern, OID_AUTO, kerneldump_gzlevel, CTLFLAG_RWTUN,
214 &kerneldump_gzlevel, 0,
215 "Kernel crash dump compression level");
218 * Variable panicstr contains argument to first call to panic; used as flag
219 * to indicate that the kernel has already called panic.
221 const char *panicstr;
222 bool __read_frequently panicked;
224 int __read_mostly dumping; /* system is dumping */
225 int rebooting; /* system is rebooting */
227 * Used to serialize between sysctl kern.shutdown.dumpdevname and list
228 * modifications via ioctl.
230 static struct mtx dumpconf_list_lk;
231 MTX_SYSINIT(dumper_configs, &dumpconf_list_lk, "dumper config list", MTX_DEF);
233 /* Our selected dumper(s). */
234 static TAILQ_HEAD(dumpconflist, dumperinfo) dumper_configs =
235 TAILQ_HEAD_INITIALIZER(dumper_configs);
237 /* Context information for dump-debuggers. */
238 static struct pcb dumppcb; /* Registers. */
239 lwpid_t dumptid; /* Thread ID. */
241 static struct cdevsw reroot_cdevsw = {
242 .d_version = D_VERSION,
246 static void poweroff_wait(void *, int);
247 static void shutdown_halt(void *junk, int howto);
248 static void shutdown_panic(void *junk, int howto);
249 static void shutdown_reset(void *junk, int howto);
250 static int kern_reroot(void);
252 /* register various local shutdown events */
254 shutdown_conf(void *unused)
257 EVENTHANDLER_REGISTER(shutdown_final, poweroff_wait, NULL,
259 EVENTHANDLER_REGISTER(shutdown_final, shutdown_halt, NULL,
260 SHUTDOWN_PRI_LAST + 100);
261 EVENTHANDLER_REGISTER(shutdown_final, shutdown_panic, NULL,
262 SHUTDOWN_PRI_LAST + 100);
263 EVENTHANDLER_REGISTER(shutdown_final, shutdown_reset, NULL,
264 SHUTDOWN_PRI_LAST + 200);
267 SYSINIT(shutdown_conf, SI_SUB_INTRINSIC, SI_ORDER_ANY, shutdown_conf, NULL);
270 * The only reason this exists is to create the /dev/reroot/ directory,
271 * used by reroot code in init(8) as a mountpoint for tmpfs.
274 reroot_conf(void *unused)
279 error = make_dev_p(MAKEDEV_CHECKNAME | MAKEDEV_WAITOK, &cdev,
280 &reroot_cdevsw, NULL, UID_ROOT, GID_WHEEL, 0600, "reroot/reroot");
282 printf("%s: failed to create device node, error %d",
287 SYSINIT(reroot_conf, SI_SUB_DEVFS, SI_ORDER_ANY, reroot_conf, NULL);
290 * The system call that results in a reboot.
294 sys_reboot(struct thread *td, struct reboot_args *uap)
300 error = mac_system_check_reboot(td->td_ucred, uap->opt);
303 error = priv_check(td, PRIV_REBOOT);
305 if (uap->opt & RB_REROOT)
306 error = kern_reroot();
308 kern_reboot(uap->opt);
314 shutdown_nice_task_fn(void *arg, int pending __unused)
318 howto = (uintptr_t)arg;
319 /* Send a signal to init(8) and have it shutdown the world. */
321 if (howto & RB_POWEROFF)
322 kern_psignal(initproc, SIGUSR2);
323 else if (howto & RB_POWERCYCLE)
324 kern_psignal(initproc, SIGWINCH);
325 else if (howto & RB_HALT)
326 kern_psignal(initproc, SIGUSR1);
328 kern_psignal(initproc, SIGINT);
329 PROC_UNLOCK(initproc);
332 static struct task shutdown_nice_task = TASK_INITIALIZER(0,
333 &shutdown_nice_task_fn, NULL);
336 * Called by events that want to shut down.. e.g <CTL><ALT><DEL> on a PC
339 shutdown_nice(int howto)
342 if (initproc != NULL && !SCHEDULER_STOPPED()) {
343 shutdown_nice_task.ta_context = (void *)(uintptr_t)howto;
344 taskqueue_enqueue(taskqueue_fast, &shutdown_nice_task);
347 * No init(8) running, or scheduler would not allow it
348 * to run, so simply reboot.
350 kern_reboot(howto | RB_NOSYNC);
363 if (ts.tv_sec >= 86400) {
364 printf("%ldd", (long)ts.tv_sec / 86400);
368 if (f || ts.tv_sec >= 3600) {
369 printf("%ldh", (long)ts.tv_sec / 3600);
373 if (f || ts.tv_sec >= 60) {
374 printf("%ldm", (long)ts.tv_sec / 60);
378 printf("%lds\n", (long)ts.tv_sec);
382 doadump(boolean_t textdump)
390 if (TAILQ_EMPTY(&dumper_configs))
394 dumptid = curthread->td_tid;
399 if (textdump && textdump_pending) {
401 textdump_dumpsys(TAILQ_FIRST(&dumper_configs));
405 struct dumperinfo *di;
407 TAILQ_FOREACH(di, &dumper_configs, di_next) {
419 * Shutdown the system cleanly to prepare for reboot, halt, or power off.
422 kern_reboot(int howto)
427 * Normal paths here don't hold Giant, but we can wind up here
428 * unexpectedly with it held. Drop it now so we don't have to
429 * drop and pick it up elsewhere. The paths it is locking will
430 * never be returned to, and it is preferable to preclude
431 * deadlock than to lock against code that won't ever
434 while (mtx_owned(&Giant))
439 * Bind us to the first CPU so that all shutdown code runs there. Some
440 * systems don't shutdown properly (i.e., ACPI power off) if we
441 * run on another processor.
443 if (!SCHEDULER_STOPPED()) {
444 thread_lock(curthread);
445 sched_bind(curthread, CPU_FIRST());
446 thread_unlock(curthread);
447 KASSERT(PCPU_GET(cpuid) == CPU_FIRST(),
448 ("boot: not running on cpu 0"));
451 /* We're in the process of rebooting. */
454 /* We are out of the debugger now. */
458 * Do any callouts that should be done BEFORE syncing the filesystems.
460 EVENTHANDLER_INVOKE(shutdown_pre_sync, howto);
463 * Now sync filesystems
465 if (!cold && (howto & RB_NOSYNC) == 0 && once == 0) {
467 bufshutdown(show_busybufs);
475 * Ok, now do things that assume all filesystem activity has
478 EVENTHANDLER_INVOKE(shutdown_post_sync, howto);
480 if ((howto & (RB_HALT|RB_DUMP)) == RB_DUMP && !cold && !dumping)
483 /* Now that we're going to really halt the system... */
484 EVENTHANDLER_INVOKE(shutdown_final, howto);
486 for(;;) ; /* safety against shutdown_reset not working */
491 * The system call that results in changing the rootfs.
496 struct vnode *oldrootvnode, *vp;
497 struct mount *mp, *devmp;
500 if (curproc != initproc)
504 * Mark the filesystem containing currently-running executable
505 * (the temporary copy of init(8)) busy.
507 vp = curproc->p_textvp;
508 error = vn_lock(vp, LK_SHARED);
512 error = vfs_busy(mp, MBF_NOWAIT);
516 error = vfs_busy(mp, 0);
517 vn_lock(vp, LK_SHARED | LK_RETRY);
523 if (VN_IS_DOOMED(vp)) {
532 * Remove the filesystem containing currently-running executable
533 * from the mount list, to prevent it from being unmounted
534 * by vfs_unmountall(), and to avoid confusing vfs_mountroot().
536 * Also preserve /dev - forcibly unmounting it could cause driver
544 mtx_lock(&mountlist_mtx);
545 TAILQ_REMOVE(&mountlist, mp, mnt_list);
546 TAILQ_REMOVE(&mountlist, devmp, mnt_list);
547 mtx_unlock(&mountlist_mtx);
549 oldrootvnode = rootvnode;
552 * Unmount everything except for the two filesystems preserved above.
557 * Add /dev back; vfs_mountroot() will move it into its new place.
559 mtx_lock(&mountlist_mtx);
560 TAILQ_INSERT_HEAD(&mountlist, devmp, mnt_list);
561 mtx_unlock(&mountlist_mtx);
566 * Mount the new rootfs.
571 * Update all references to the old rootvnode.
573 mountcheckdirs(oldrootvnode, rootvnode);
576 * Add the temporary filesystem back and unbusy it.
578 mtx_lock(&mountlist_mtx);
579 TAILQ_INSERT_TAIL(&mountlist, mp, mnt_list);
580 mtx_unlock(&mountlist_mtx);
587 * If the shutdown was a clean halt, behave accordingly.
590 shutdown_halt(void *junk, int howto)
593 if (howto & RB_HALT) {
595 printf("The operating system has halted.\n");
596 printf("Please press any key to reboot.\n\n");
598 wdog_kern_pat(WD_TO_NEVER);
601 case -1: /* No console, just die */
611 * Check to see if the system paniced, pause and then reboot
612 * according to the specified delay.
615 shutdown_panic(void *junk, int howto)
619 if (howto & RB_DUMP) {
620 if (panic_reboot_wait_time != 0) {
621 if (panic_reboot_wait_time != -1) {
622 printf("Automatic reboot in %d seconds - "
623 "press a key on the console to abort\n",
624 panic_reboot_wait_time);
625 for (loop = panic_reboot_wait_time * 10;
627 DELAY(1000 * 100); /* 1/10th second */
628 /* Did user type a key? */
629 if (cncheckc() != -1)
635 } else { /* zero time specified - reboot NOW */
638 printf("--> Press a key on the console to reboot,\n");
639 printf("--> or switch off the system now.\n");
645 * Everything done, now reset
648 shutdown_reset(void *junk, int howto)
651 printf("Rebooting...\n");
652 DELAY(1000000); /* wait 1 sec for printf's to complete and be read */
655 * Acquiring smp_ipi_mtx here has a double effect:
656 * - it disables interrupts avoiding CPU0 preemption
657 * by fast handlers (thus deadlocking against other CPUs)
658 * - it avoids deadlocks against smp_rendezvous() or, more
659 * generally, threads busy-waiting, with this spinlock held,
660 * and waiting for responses by threads on other CPUs
661 * (ie. smp_tlb_shootdown()).
663 * For the !SMP case it just needs to handle the former problem.
666 mtx_lock_spin(&smp_ipi_mtx);
671 /* cpu_boot(howto); */ /* doesn't do anything at the moment */
673 /* NOTREACHED */ /* assuming reset worked */
676 #if defined(WITNESS) || defined(INVARIANT_SUPPORT)
677 static int kassert_warn_only = 0;
679 static int kassert_do_kdb = 0;
682 static int kassert_do_ktr = 0;
684 static int kassert_do_log = 1;
685 static int kassert_log_pps_limit = 4;
686 static int kassert_log_mute_at = 0;
687 static int kassert_log_panic_at = 0;
688 static int kassert_suppress_in_panic = 0;
689 static int kassert_warnings = 0;
691 SYSCTL_NODE(_debug, OID_AUTO, kassert, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
694 #ifdef KASSERT_PANIC_OPTIONAL
695 #define KASSERT_RWTUN CTLFLAG_RWTUN
697 #define KASSERT_RWTUN CTLFLAG_RDTUN
700 SYSCTL_INT(_debug_kassert, OID_AUTO, warn_only, KASSERT_RWTUN,
701 &kassert_warn_only, 0,
702 "KASSERT triggers a panic (0) or just a warning (1)");
705 SYSCTL_INT(_debug_kassert, OID_AUTO, do_kdb, KASSERT_RWTUN,
706 &kassert_do_kdb, 0, "KASSERT will enter the debugger");
710 SYSCTL_UINT(_debug_kassert, OID_AUTO, do_ktr, KASSERT_RWTUN,
712 "KASSERT does a KTR, set this to the KTRMASK you want");
715 SYSCTL_INT(_debug_kassert, OID_AUTO, do_log, KASSERT_RWTUN,
717 "If warn_only is enabled, log (1) or do not log (0) assertion violations");
719 SYSCTL_INT(_debug_kassert, OID_AUTO, warnings, CTLFLAG_RD | CTLFLAG_STATS,
720 &kassert_warnings, 0, "number of KASSERTs that have been triggered");
722 SYSCTL_INT(_debug_kassert, OID_AUTO, log_panic_at, KASSERT_RWTUN,
723 &kassert_log_panic_at, 0, "max number of KASSERTS before we will panic");
725 SYSCTL_INT(_debug_kassert, OID_AUTO, log_pps_limit, KASSERT_RWTUN,
726 &kassert_log_pps_limit, 0, "limit number of log messages per second");
728 SYSCTL_INT(_debug_kassert, OID_AUTO, log_mute_at, KASSERT_RWTUN,
729 &kassert_log_mute_at, 0, "max number of KASSERTS to log");
731 SYSCTL_INT(_debug_kassert, OID_AUTO, suppress_in_panic, KASSERT_RWTUN,
732 &kassert_suppress_in_panic, 0,
733 "KASSERTs will be suppressed while handling a panic");
736 static int kassert_sysctl_kassert(SYSCTL_HANDLER_ARGS);
738 SYSCTL_PROC(_debug_kassert, OID_AUTO, kassert,
739 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_NEEDGIANT, NULL, 0,
740 kassert_sysctl_kassert, "I",
741 "set to trigger a test kassert");
744 kassert_sysctl_kassert(SYSCTL_HANDLER_ARGS)
748 error = sysctl_wire_old_buffer(req, sizeof(int));
751 error = sysctl_handle_int(oidp, &i, 0, req);
753 if (error != 0 || req->newptr == NULL)
755 KASSERT(0, ("kassert_sysctl_kassert triggered kassert %d", i));
759 #ifdef KASSERT_PANIC_OPTIONAL
761 * Called by KASSERT, this decides if we will panic
762 * or if we will log via printf and/or ktr.
765 kassert_panic(const char *fmt, ...)
767 static char buf[256];
771 (void)vsnprintf(buf, sizeof(buf), fmt, ap);
775 * If we are suppressing secondary panics, log the warning but do not
776 * re-enter panic/kdb.
778 if (panicstr != NULL && kassert_suppress_in_panic) {
779 if (kassert_do_log) {
780 printf("KASSERT failed: %s\n", buf);
782 if (trace_all_panics && trace_on_panic)
790 * panic if we're not just warning, or if we've exceeded
791 * kassert_log_panic_at warnings.
793 if (!kassert_warn_only ||
794 (kassert_log_panic_at > 0 &&
795 kassert_warnings >= kassert_log_panic_at)) {
805 * log if we've not yet met the mute limit.
807 if (kassert_do_log &&
808 (kassert_log_mute_at == 0 ||
809 kassert_warnings < kassert_log_mute_at)) {
810 static struct timeval lasterr;
813 if (ppsratecheck(&lasterr, &curerr, kassert_log_pps_limit)) {
814 printf("KASSERT failed: %s\n", buf);
819 if (kassert_do_kdb) {
820 kdb_enter(KDB_WHY_KASSERT, buf);
823 atomic_add_int(&kassert_warnings, 1);
825 #endif /* KASSERT_PANIC_OPTIONAL */
829 * Panic is called on unresolvable fatal errors. It prints "panic: mesg",
830 * and then reboots. If we are called twice, then we avoid trying to sync
831 * the disks as this often leads to recursive panics.
834 panic(const char *fmt, ...)
843 vpanic(const char *fmt, va_list ap)
848 struct thread *td = curthread;
849 int bootopt, newpanic;
850 static char buf[256];
856 * stop_cpus_hard(other_cpus) should prevent multiple CPUs from
857 * concurrently entering panic. Only the winner will proceed
860 if (panicstr == NULL && !kdb_active) {
861 other_cpus = all_cpus;
862 CPU_CLR(PCPU_GET(cpuid), &other_cpus);
863 stop_cpus_hard(other_cpus);
868 * Ensure that the scheduler is stopped while panicking, even if panic
869 * has been entered from kdb.
871 td->td_stopsched = 1;
873 bootopt = RB_AUTOBOOT;
876 bootopt |= RB_NOSYNC;
885 (void)vsnprintf(buf, sizeof(buf), fmt, ap);
888 printf("panic: %s\n", buf);
895 printf("cpuid = %d\n", PCPU_GET(cpuid));
897 printf("time = %jd\n", (intmax_t )time_second);
899 if ((newpanic || trace_all_panics) && trace_on_panic)
901 if (debugger_on_panic)
902 kdb_enter(KDB_WHY_PANIC, "panic");
904 /*thread_lock(td); */
905 td->td_flags |= TDF_INPANIC;
906 /* thread_unlock(td); */
908 bootopt |= RB_NOSYNC;
909 if (poweroff_on_panic)
910 bootopt |= RB_POWEROFF;
911 if (powercycle_on_panic)
912 bootopt |= RB_POWERCYCLE;
913 kern_reboot(bootopt);
917 * Support for poweroff delay.
919 * Please note that setting this delay too short might power off your machine
920 * before the write cache on your hard disk has been flushed, leading to
921 * soft-updates inconsistencies.
923 #ifndef POWEROFF_DELAY
924 # define POWEROFF_DELAY 5000
926 static int poweroff_delay = POWEROFF_DELAY;
928 SYSCTL_INT(_kern_shutdown, OID_AUTO, poweroff_delay, CTLFLAG_RW,
929 &poweroff_delay, 0, "Delay before poweroff to write disk caches (msec)");
932 poweroff_wait(void *junk, int howto)
935 if ((howto & (RB_POWEROFF | RB_POWERCYCLE)) == 0 || poweroff_delay <= 0)
937 DELAY(poweroff_delay * 1000);
941 * Some system processes (e.g. syncer) need to be stopped at appropriate
942 * points in their main loops prior to a system shutdown, so that they
943 * won't interfere with the shutdown process (e.g. by holding a disk buf
944 * to cause sync to fail). For each of these system processes, register
945 * shutdown_kproc() as a handler for one of shutdown events.
947 static int kproc_shutdown_wait = 60;
948 SYSCTL_INT(_kern_shutdown, OID_AUTO, kproc_shutdown_wait, CTLFLAG_RW,
949 &kproc_shutdown_wait, 0, "Max wait time (sec) to stop for each process");
952 kproc_shutdown(void *arg, int howto)
960 p = (struct proc *)arg;
961 printf("Waiting (max %d seconds) for system process `%s' to stop... ",
962 kproc_shutdown_wait, p->p_comm);
963 error = kproc_suspend(p, kproc_shutdown_wait * hz);
965 if (error == EWOULDBLOCK)
966 printf("timed out\n");
972 kthread_shutdown(void *arg, int howto)
980 td = (struct thread *)arg;
981 printf("Waiting (max %d seconds) for system thread `%s' to stop... ",
982 kproc_shutdown_wait, td->td_name);
983 error = kthread_suspend(td, kproc_shutdown_wait * hz);
985 if (error == EWOULDBLOCK)
986 printf("timed out\n");
992 dumpdevname_sysctl_handler(SYSCTL_HANDLER_ARGS)
995 struct dumperinfo *di;
999 error = sysctl_wire_old_buffer(req, 0);
1003 sbuf_new_for_sysctl(&sb, buf, sizeof(buf), req);
1005 mtx_lock(&dumpconf_list_lk);
1006 TAILQ_FOREACH(di, &dumper_configs, di_next) {
1007 if (di != TAILQ_FIRST(&dumper_configs))
1008 sbuf_putc(&sb, ',');
1009 sbuf_cat(&sb, di->di_devname);
1011 mtx_unlock(&dumpconf_list_lk);
1013 error = sbuf_finish(&sb);
1017 SYSCTL_PROC(_kern_shutdown, OID_AUTO, dumpdevname,
1018 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT, &dumper_configs, 0,
1019 dumpdevname_sysctl_handler, "A",
1020 "Device(s) for kernel dumps");
1022 static int _dump_append(struct dumperinfo *di, void *virtual,
1023 vm_offset_t physical, size_t length);
1026 static struct kerneldumpcrypto *
1027 kerneldumpcrypto_create(size_t blocksize, uint8_t encryption,
1028 const uint8_t *key, uint32_t encryptedkeysize, const uint8_t *encryptedkey)
1030 struct kerneldumpcrypto *kdc;
1031 struct kerneldumpkey *kdk;
1032 uint32_t dumpkeysize;
1034 dumpkeysize = roundup2(sizeof(*kdk) + encryptedkeysize, blocksize);
1035 kdc = malloc(sizeof(*kdc) + dumpkeysize, M_EKCD, M_WAITOK | M_ZERO);
1037 arc4rand(kdc->kdc_iv, sizeof(kdc->kdc_iv), 0);
1039 kdc->kdc_encryption = encryption;
1040 switch (kdc->kdc_encryption) {
1041 case KERNELDUMP_ENC_AES_256_CBC:
1042 if (rijndael_makeKey(&kdc->kdc_ki, DIR_ENCRYPT, 256, key) <= 0)
1045 case KERNELDUMP_ENC_CHACHA20:
1046 chacha_keysetup(&kdc->kdc_chacha, key, 256);
1052 kdc->kdc_dumpkeysize = dumpkeysize;
1053 kdk = kdc->kdc_dumpkey;
1054 kdk->kdk_encryption = kdc->kdc_encryption;
1055 memcpy(kdk->kdk_iv, kdc->kdc_iv, sizeof(kdk->kdk_iv));
1056 kdk->kdk_encryptedkeysize = htod32(encryptedkeysize);
1057 memcpy(kdk->kdk_encryptedkey, encryptedkey, encryptedkeysize);
1066 kerneldumpcrypto_init(struct kerneldumpcrypto *kdc)
1068 uint8_t hash[SHA256_DIGEST_LENGTH];
1070 struct kerneldumpkey *kdk;
1079 * When a user enters ddb it can write a crash dump multiple times.
1080 * Each time it should be encrypted using a different IV.
1083 SHA256_Update(&ctx, kdc->kdc_iv, sizeof(kdc->kdc_iv));
1084 SHA256_Final(hash, &ctx);
1085 bcopy(hash, kdc->kdc_iv, sizeof(kdc->kdc_iv));
1087 switch (kdc->kdc_encryption) {
1088 case KERNELDUMP_ENC_AES_256_CBC:
1089 if (rijndael_cipherInit(&kdc->kdc_ci, MODE_CBC,
1090 kdc->kdc_iv) <= 0) {
1095 case KERNELDUMP_ENC_CHACHA20:
1096 chacha_ivsetup(&kdc->kdc_chacha, kdc->kdc_iv, NULL);
1103 kdk = kdc->kdc_dumpkey;
1104 memcpy(kdk->kdk_iv, kdc->kdc_iv, sizeof(kdk->kdk_iv));
1106 explicit_bzero(hash, sizeof(hash));
1111 kerneldumpcrypto_dumpkeysize(const struct kerneldumpcrypto *kdc)
1116 return (kdc->kdc_dumpkeysize);
1120 static struct kerneldumpcomp *
1121 kerneldumpcomp_create(struct dumperinfo *di, uint8_t compression)
1123 struct kerneldumpcomp *kdcomp;
1126 switch (compression) {
1127 case KERNELDUMP_COMP_GZIP:
1128 format = COMPRESS_GZIP;
1130 case KERNELDUMP_COMP_ZSTD:
1131 format = COMPRESS_ZSTD;
1137 kdcomp = malloc(sizeof(*kdcomp), M_DUMPER, M_WAITOK | M_ZERO);
1138 kdcomp->kdc_format = compression;
1139 kdcomp->kdc_stream = compressor_init(kerneldumpcomp_write_cb,
1140 format, di->maxiosize, kerneldump_gzlevel, di);
1141 if (kdcomp->kdc_stream == NULL) {
1142 free(kdcomp, M_DUMPER);
1145 kdcomp->kdc_buf = malloc(di->maxiosize, M_DUMPER, M_WAITOK | M_NODUMP);
1150 kerneldumpcomp_destroy(struct dumperinfo *di)
1152 struct kerneldumpcomp *kdcomp;
1154 kdcomp = di->kdcomp;
1157 compressor_fini(kdcomp->kdc_stream);
1158 zfree(kdcomp->kdc_buf, M_DUMPER);
1159 free(kdcomp, M_DUMPER);
1163 * Must not be present on global list.
1166 free_single_dumper(struct dumperinfo *di)
1172 zfree(di->blockbuf, M_DUMPER);
1174 kerneldumpcomp_destroy(di);
1177 zfree(di->kdcrypto, M_EKCD);
1179 zfree(di, M_DUMPER);
1182 /* Registration of dumpers */
1184 dumper_insert(const struct dumperinfo *di_template, const char *devname,
1185 const struct diocskerneldump_arg *kda)
1187 struct dumperinfo *newdi, *listdi;
1192 index = kda->kda_index;
1193 MPASS(index != KDA_REMOVE && index != KDA_REMOVE_DEV &&
1194 index != KDA_REMOVE_ALL);
1196 error = priv_check(curthread, PRIV_SETDUMPER);
1200 newdi = malloc(sizeof(*newdi) + strlen(devname) + 1, M_DUMPER, M_WAITOK
1202 memcpy(newdi, di_template, sizeof(*newdi));
1203 newdi->blockbuf = NULL;
1204 newdi->kdcrypto = NULL;
1205 newdi->kdcomp = NULL;
1206 strcpy(newdi->di_devname, devname);
1208 if (kda->kda_encryption != KERNELDUMP_ENC_NONE) {
1210 newdi->kdcrypto = kerneldumpcrypto_create(di_template->blocksize,
1211 kda->kda_encryption, kda->kda_key,
1212 kda->kda_encryptedkeysize, kda->kda_encryptedkey);
1213 if (newdi->kdcrypto == NULL) {
1222 if (kda->kda_compression != KERNELDUMP_COMP_NONE) {
1225 * We can't support simultaneous unpadded block cipher
1226 * encryption and compression because there is no guarantee the
1227 * length of the compressed result is exactly a multiple of the
1228 * cipher block size.
1230 if (kda->kda_encryption == KERNELDUMP_ENC_AES_256_CBC) {
1235 newdi->kdcomp = kerneldumpcomp_create(newdi,
1236 kda->kda_compression);
1237 if (newdi->kdcomp == NULL) {
1243 newdi->blockbuf = malloc(newdi->blocksize, M_DUMPER, M_WAITOK | M_ZERO);
1245 /* Add the new configuration to the queue */
1246 mtx_lock(&dumpconf_list_lk);
1248 TAILQ_FOREACH(listdi, &dumper_configs, di_next) {
1250 TAILQ_INSERT_BEFORE(listdi, newdi, di_next);
1257 TAILQ_INSERT_TAIL(&dumper_configs, newdi, di_next);
1258 mtx_unlock(&dumpconf_list_lk);
1263 free_single_dumper(newdi);
1269 dumper_ddb_insert(struct dumperinfo *newdi)
1271 TAILQ_INSERT_HEAD(&dumper_configs, newdi, di_next);
1275 dumper_ddb_remove(struct dumperinfo *di)
1277 TAILQ_REMOVE(&dumper_configs, di, di_next);
1282 dumper_config_match(const struct dumperinfo *di, const char *devname,
1283 const struct diocskerneldump_arg *kda)
1285 if (kda->kda_index == KDA_REMOVE_ALL)
1288 if (strcmp(di->di_devname, devname) != 0)
1292 * Allow wildcard removal of configs matching a device on g_dev_orphan.
1294 if (kda->kda_index == KDA_REMOVE_DEV)
1297 if (di->kdcomp != NULL) {
1298 if (di->kdcomp->kdc_format != kda->kda_compression)
1300 } else if (kda->kda_compression != KERNELDUMP_COMP_NONE)
1303 if (di->kdcrypto != NULL) {
1304 if (di->kdcrypto->kdc_encryption != kda->kda_encryption)
1307 * Do we care to verify keys match to delete? It seems weird
1308 * to expect multiple fallback dump configurations on the same
1309 * device that only differ in crypto key.
1313 if (kda->kda_encryption != KERNELDUMP_ENC_NONE)
1320 dumper_remove(const char *devname, const struct diocskerneldump_arg *kda)
1322 struct dumperinfo *di, *sdi;
1326 error = priv_check(curthread, PRIV_SETDUMPER);
1331 * Try to find a matching configuration, and kill it.
1333 * NULL 'kda' indicates remove any configuration matching 'devname',
1334 * which may remove multiple configurations in atypical configurations.
1337 mtx_lock(&dumpconf_list_lk);
1338 TAILQ_FOREACH_SAFE(di, &dumper_configs, di_next, sdi) {
1339 if (dumper_config_match(di, devname, kda)) {
1341 TAILQ_REMOVE(&dumper_configs, di, di_next);
1342 free_single_dumper(di);
1345 mtx_unlock(&dumpconf_list_lk);
1347 /* Only produce ENOENT if a more targeted match didn't match. */
1348 if (!found && kda->kda_index == KDA_REMOVE)
1354 dump_check_bounds(struct dumperinfo *di, off_t offset, size_t length)
1357 if (di->mediasize > 0 && length != 0 && (offset < di->mediaoffset ||
1358 offset - di->mediaoffset + length > di->mediasize)) {
1359 if (di->kdcomp != NULL && offset >= di->mediaoffset) {
1361 "Compressed dump failed to fit in device boundaries.\n");
1365 printf("Attempt to write outside dump device boundaries.\n"
1366 "offset(%jd), mediaoffset(%jd), length(%ju), mediasize(%jd).\n",
1367 (intmax_t)offset, (intmax_t)di->mediaoffset,
1368 (uintmax_t)length, (intmax_t)di->mediasize);
1371 if (length % di->blocksize != 0) {
1372 printf("Attempt to write partial block of length %ju.\n",
1376 if (offset % di->blocksize != 0) {
1377 printf("Attempt to write at unaligned offset %jd.\n",
1387 dump_encrypt(struct kerneldumpcrypto *kdc, uint8_t *buf, size_t size)
1390 switch (kdc->kdc_encryption) {
1391 case KERNELDUMP_ENC_AES_256_CBC:
1392 if (rijndael_blockEncrypt(&kdc->kdc_ci, &kdc->kdc_ki, buf,
1393 8 * size, buf) <= 0) {
1396 if (rijndael_cipherInit(&kdc->kdc_ci, MODE_CBC,
1397 buf + size - 16 /* IV size for AES-256-CBC */) <= 0) {
1401 case KERNELDUMP_ENC_CHACHA20:
1402 chacha_encrypt_bytes(&kdc->kdc_chacha, buf, buf, size);
1411 /* Encrypt data and call dumper. */
1413 dump_encrypted_write(struct dumperinfo *di, void *virtual,
1414 vm_offset_t physical, off_t offset, size_t length)
1416 static uint8_t buf[KERNELDUMP_BUFFER_SIZE];
1417 struct kerneldumpcrypto *kdc;
1423 while (length > 0) {
1424 nbytes = MIN(length, sizeof(buf));
1425 bcopy(virtual, buf, nbytes);
1427 if (dump_encrypt(kdc, buf, nbytes) != 0)
1430 error = dump_write(di, buf, physical, offset, nbytes);
1435 virtual = (void *)((uint8_t *)virtual + nbytes);
1444 kerneldumpcomp_write_cb(void *base, size_t length, off_t offset, void *arg)
1446 struct dumperinfo *di;
1447 size_t resid, rlength;
1452 if (length % di->blocksize != 0) {
1454 * This must be the final write after flushing the compression
1455 * stream. Write as many full blocks as possible and stash the
1456 * residual data in the dumper's block buffer. It will be
1457 * padded and written in dump_finish().
1459 rlength = rounddown(length, di->blocksize);
1461 error = _dump_append(di, base, 0, rlength);
1465 resid = length - rlength;
1466 memmove(di->blockbuf, (uint8_t *)base + rlength, resid);
1467 di->kdcomp->kdc_resid = resid;
1470 return (_dump_append(di, base, 0, length));
1474 * Write kernel dump headers at the beginning and end of the dump extent.
1475 * Write the kernel dump encryption key after the leading header if we were
1476 * configured to do so.
1479 dump_write_headers(struct dumperinfo *di, struct kerneldumpheader *kdh)
1482 struct kerneldumpcrypto *kdc;
1490 hdrsz = sizeof(*kdh);
1491 if (hdrsz > di->blocksize)
1496 key = kdc->kdc_dumpkey;
1497 keysize = kerneldumpcrypto_dumpkeysize(kdc);
1504 * If the dump device has special handling for headers, let it take care
1505 * of writing them out.
1507 if (di->dumper_hdr != NULL)
1508 return (di->dumper_hdr(di, kdh, key, keysize));
1510 if (hdrsz == di->blocksize)
1514 memset(buf, 0, di->blocksize);
1515 memcpy(buf, kdh, hdrsz);
1518 extent = dtoh64(kdh->dumpextent);
1521 error = dump_write(di, kdc->kdc_dumpkey, 0,
1522 di->mediaoffset + di->mediasize - di->blocksize - extent -
1529 error = dump_write(di, buf, 0,
1530 di->mediaoffset + di->mediasize - 2 * di->blocksize - extent -
1531 keysize, di->blocksize);
1533 error = dump_write(di, buf, 0, di->mediaoffset + di->mediasize -
1534 di->blocksize, di->blocksize);
1539 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This is to
1540 * protect us from metadata and metadata from us.
1542 #define SIZEOF_METADATA (64 * 1024)
1545 * Do some preliminary setup for a kernel dump: initialize state for encryption,
1546 * if requested, and make sure that we have enough space on the dump device.
1548 * We set things up so that the dump ends before the last sector of the dump
1549 * device, at which the trailing header is written.
1551 * +-----------+------+-----+----------------------------+------+
1552 * | | lhdr | key | ... kernel dump ... | thdr |
1553 * +-----------+------+-----+----------------------------+------+
1554 * 1 blk opt <------- dump extent --------> 1 blk
1556 * Dumps written using dump_append() start at the beginning of the extent.
1557 * Uncompressed dumps will use the entire extent, but compressed dumps typically
1558 * will not. The true length of the dump is recorded in the leading and trailing
1559 * headers once the dump has been completed.
1561 * The dump device may provide a callback, in which case it will initialize
1562 * dumpoff and take care of laying out the headers.
1565 dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh)
1567 uint64_t dumpextent, span;
1572 error = kerneldumpcrypto_init(di->kdcrypto);
1575 keysize = kerneldumpcrypto_dumpkeysize(di->kdcrypto);
1581 if (di->dumper_start != NULL) {
1582 error = di->dumper_start(di);
1584 dumpextent = dtoh64(kdh->dumpextent);
1585 span = SIZEOF_METADATA + dumpextent + 2 * di->blocksize +
1587 if (di->mediasize < span) {
1588 if (di->kdcomp == NULL)
1592 * We don't yet know how much space the compressed dump
1593 * will occupy, so try to use the whole swap partition
1594 * (minus the first 64KB) in the hope that the
1595 * compressed dump will fit. If that doesn't turn out to
1596 * be enough, the bounds checking in dump_write()
1597 * will catch us and cause the dump to fail.
1599 dumpextent = di->mediasize - span + dumpextent;
1600 kdh->dumpextent = htod64(dumpextent);
1604 * The offset at which to begin writing the dump.
1606 di->dumpoff = di->mediaoffset + di->mediasize - di->blocksize -
1609 di->origdumpoff = di->dumpoff;
1614 _dump_append(struct dumperinfo *di, void *virtual, vm_offset_t physical,
1620 if (di->kdcrypto != NULL)
1621 error = dump_encrypted_write(di, virtual, physical, di->dumpoff,
1625 error = dump_write(di, virtual, physical, di->dumpoff, length);
1627 di->dumpoff += length;
1632 * Write to the dump device starting at dumpoff. When compression is enabled,
1633 * writes to the device will be performed using a callback that gets invoked
1634 * when the compression stream's output buffer is full.
1637 dump_append(struct dumperinfo *di, void *virtual, vm_offset_t physical,
1642 if (di->kdcomp != NULL) {
1643 /* Bounce through a buffer to avoid CRC errors. */
1644 if (length > di->maxiosize)
1646 buf = di->kdcomp->kdc_buf;
1647 memmove(buf, virtual, length);
1648 return (compressor_write(di->kdcomp->kdc_stream, buf, length));
1650 return (_dump_append(di, virtual, physical, length));
1654 * Write to the dump device at the specified offset.
1657 dump_write(struct dumperinfo *di, void *virtual, vm_offset_t physical,
1658 off_t offset, size_t length)
1662 error = dump_check_bounds(di, offset, length);
1665 return (di->dumper(di->priv, virtual, physical, offset, length));
1669 * Perform kernel dump finalization: flush the compression stream, if necessary,
1670 * write the leading and trailing kernel dump headers now that we know the true
1671 * length of the dump, and optionally write the encryption key following the
1675 dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh)
1679 if (di->kdcomp != NULL) {
1680 error = compressor_flush(di->kdcomp->kdc_stream);
1681 if (error == EAGAIN) {
1682 /* We have residual data in di->blockbuf. */
1683 error = dump_write(di, di->blockbuf, 0, di->dumpoff,
1685 di->dumpoff += di->kdcomp->kdc_resid;
1686 di->kdcomp->kdc_resid = 0;
1692 * We now know the size of the compressed dump, so update the
1693 * header accordingly and recompute parity.
1695 kdh->dumplength = htod64(di->dumpoff - di->origdumpoff);
1697 kdh->parity = kerneldump_parity(kdh);
1699 compressor_reset(di->kdcomp->kdc_stream);
1702 error = dump_write_headers(di, kdh);
1706 (void)dump_write(di, NULL, 0, 0, 0);
1711 dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh,
1712 const char *magic, uint32_t archver, uint64_t dumplen)
1716 bzero(kdh, sizeof(*kdh));
1717 strlcpy(kdh->magic, magic, sizeof(kdh->magic));
1718 strlcpy(kdh->architecture, MACHINE_ARCH, sizeof(kdh->architecture));
1719 kdh->version = htod32(KERNELDUMPVERSION);
1720 kdh->architectureversion = htod32(archver);
1721 kdh->dumplength = htod64(dumplen);
1722 kdh->dumpextent = kdh->dumplength;
1723 kdh->dumptime = htod64(time_second);
1725 kdh->dumpkeysize = htod32(kerneldumpcrypto_dumpkeysize(di->kdcrypto));
1727 kdh->dumpkeysize = 0;
1729 kdh->blocksize = htod32(di->blocksize);
1730 strlcpy(kdh->hostname, prison0.pr_hostname, sizeof(kdh->hostname));
1731 dstsize = sizeof(kdh->versionstring);
1732 if (strlcpy(kdh->versionstring, version, dstsize) >= dstsize)
1733 kdh->versionstring[dstsize - 2] = '\n';
1734 if (panicstr != NULL)
1735 strlcpy(kdh->panicstring, panicstr, sizeof(kdh->panicstring));
1736 if (di->kdcomp != NULL)
1737 kdh->compression = di->kdcomp->kdc_format;
1738 kdh->parity = kerneldump_parity(kdh);
1742 DB_SHOW_COMMAND(panic, db_show_panic)
1745 if (panicstr == NULL)
1746 db_printf("panicstr not set\n");
1748 db_printf("panic: %s\n", panicstr);