2 * Copyright (c) 1986, 1988, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)kern_shutdown.c 8.3 (Berkeley) 1/21/94
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
42 #include "opt_panic.h"
43 #include "opt_show_busybufs.h"
44 #include "opt_sched.h"
46 #include <sys/param.h>
47 #include <sys/systm.h>
52 #include <sys/eventhandler.h>
55 #include <sys/kernel.h>
56 #include <sys/kerneldump.h>
57 #include <sys/kthread.h>
58 #include <sys/malloc.h>
59 #include <sys/mount.h>
62 #include <sys/reboot.h>
63 #include <sys/resourcevar.h>
64 #include <sys/sched.h>
65 #include <sys/smp.h> /* smp_active */
66 #include <sys/sysctl.h>
67 #include <sys/sysproto.h>
71 #include <machine/cpu.h>
72 #include <machine/pcb.h>
73 #include <machine/smp.h>
75 #include <security/mac/mac_framework.h>
78 #include <vm/vm_object.h>
79 #include <vm/vm_page.h>
80 #include <vm/vm_pager.h>
81 #include <vm/swap_pager.h>
83 #include <sys/signalvar.h>
85 #ifndef PANIC_REBOOT_WAIT_TIME
86 #define PANIC_REBOOT_WAIT_TIME 15 /* default to 15 seconds */
90 * Note that stdarg.h and the ANSI style va_start macro is used for both
91 * ANSI and traditional C compilers.
93 #include <machine/stdarg.h>
97 int debugger_on_panic = 0;
99 int debugger_on_panic = 1;
101 SYSCTL_INT(_debug, OID_AUTO, debugger_on_panic, CTLFLAG_RW,
102 &debugger_on_panic, 0, "Run debugger on kernel panic");
105 int trace_on_panic = 1;
107 int trace_on_panic = 0;
109 SYSCTL_INT(_debug, OID_AUTO, trace_on_panic, CTLFLAG_RW,
110 &trace_on_panic, 0, "Print stack trace on kernel panic");
113 int sync_on_panic = 0;
114 SYSCTL_INT(_kern, OID_AUTO, sync_on_panic, CTLFLAG_RW,
115 &sync_on_panic, 0, "Do a sync before rebooting from a panic");
117 SYSCTL_NODE(_kern, OID_AUTO, shutdown, CTLFLAG_RW, 0, "Shutdown environment");
120 * Variable panicstr contains argument to first call to panic; used as flag
121 * to indicate that the kernel has already called panic.
123 const char *panicstr;
125 int dumping; /* system is dumping */
126 int rebooting; /* system is rebooting */
127 static struct dumperinfo dumper; /* our selected dumper */
129 /* Context information for dump-debuggers. */
130 static struct pcb dumppcb; /* Registers. */
131 static lwpid_t dumptid; /* Thread ID. */
133 static void boot(int) __dead2;
134 static void poweroff_wait(void *, int);
135 static void shutdown_halt(void *junk, int howto);
136 static void shutdown_panic(void *junk, int howto);
137 static void shutdown_reset(void *junk, int howto);
139 /* register various local shutdown events */
141 shutdown_conf(void *unused)
144 EVENTHANDLER_REGISTER(shutdown_final, poweroff_wait, NULL,
146 EVENTHANDLER_REGISTER(shutdown_final, shutdown_halt, NULL,
147 SHUTDOWN_PRI_LAST + 100);
148 EVENTHANDLER_REGISTER(shutdown_final, shutdown_panic, NULL,
149 SHUTDOWN_PRI_LAST + 100);
150 EVENTHANDLER_REGISTER(shutdown_final, shutdown_reset, NULL,
151 SHUTDOWN_PRI_LAST + 200);
154 SYSINIT(shutdown_conf, SI_SUB_INTRINSIC, SI_ORDER_ANY, shutdown_conf, NULL);
157 * The system call that results in a reboot.
161 reboot(struct thread *td, struct reboot_args *uap)
167 error = mac_system_check_reboot(td->td_ucred, uap->opt);
170 error = priv_check(td, PRIV_REBOOT);
180 * Called by events that want to shut down.. e.g <CTL><ALT><DEL> on a PC
182 static int shutdown_howto = 0;
185 shutdown_nice(int howto)
188 shutdown_howto = howto;
190 /* Send a signal to init(8) and have it shutdown the world */
191 if (initproc != NULL) {
193 psignal(initproc, SIGINT);
194 PROC_UNLOCK(initproc);
196 /* No init(8) running, so simply reboot */
201 static int waittime = -1;
212 if (ts.tv_sec >= 86400) {
213 printf("%ldd", (long)ts.tv_sec / 86400);
217 if (f || ts.tv_sec >= 3600) {
218 printf("%ldh", (long)ts.tv_sec / 3600);
222 if (f || ts.tv_sec >= 60) {
223 printf("%ldm", (long)ts.tv_sec / 60);
227 printf("%lds\n", (long)ts.tv_sec);
235 * Sometimes people have to call this from the kernel debugger.
236 * (if 'panic' can not dump)
237 * Give them a clue as to why they can't dump.
239 if (dumper.dumper == NULL) {
240 printf("Cannot dump. Device not defined or unavailable.\n");
245 dumptid = curthread->td_tid;
248 if (textdump_pending)
249 textdump_dumpsys(&dumper);
257 isbufbusy(struct buf *bp)
259 if (((bp->b_flags & (B_INVAL | B_PERSISTENT)) == 0 &&
261 ((bp->b_flags & (B_DELWRI | B_INVAL)) == B_DELWRI))
267 * Shutdown the system cleanly to prepare for reboot, halt, or power off.
272 static int first_buf_printf = 1;
276 * Bind us to CPU 0 so that all shutdown code runs there. Some
277 * systems don't shutdown properly (i.e., ACPI power off) if we
278 * run on another processor.
280 thread_lock(curthread);
281 sched_bind(curthread, 0);
282 thread_unlock(curthread);
283 KASSERT(PCPU_GET(cpuid) == 0, ("boot: not running on cpu 0"));
285 /* We're in the process of rebooting. */
288 /* collect extra flags that shutdown_nice might have set */
289 howto |= shutdown_howto;
291 /* We are out of the debugger now. */
295 * Do any callouts that should be done BEFORE syncing the filesystems.
297 EVENTHANDLER_INVOKE(shutdown_pre_sync, howto);
300 * Now sync filesystems
302 if (!cold && (howto & RB_NOSYNC) == 0 && waittime < 0) {
303 register struct buf *bp;
304 int iter, nbusy, pbusy;
311 sync(curthread, NULL);
314 * With soft updates, some buffers that are
315 * written will be remarked as dirty until other
316 * buffers are written.
318 for (iter = pbusy = 0; iter < 20; iter++) {
320 for (bp = &buf[nbuf]; --bp >= buf; )
324 if (first_buf_printf)
325 printf("All buffers synced.");
328 if (first_buf_printf) {
329 printf("Syncing disks, buffers remaining... ");
330 first_buf_printf = 0;
332 printf("%d ", nbusy);
336 sync(curthread, NULL);
340 * Drop Giant and spin for a while to allow
341 * interrupt threads to run.
348 * Drop Giant and context switch several times to
349 * allow interrupt threads to run.
352 for (subiter = 0; subiter < 50 * iter; subiter++) {
353 thread_lock(curthread);
354 mi_switch(SW_VOL, NULL);
355 thread_unlock(curthread);
363 * Count only busy local buffers to prevent forcing
364 * a fsck if we're just a client of a wedged NFS server
367 for (bp = &buf[nbuf]; --bp >= buf; ) {
370 /* XXX: This is bogus. We should probably have a BO_REMOTE flag instead */
371 if (bp->b_dev == NULL) {
372 TAILQ_REMOVE(&mountlist,
373 bp->b_vp->v_mount, mnt_list);
378 #if defined(SHOW_BUSYBUFS) || defined(DIAGNOSTIC)
380 "%d: bufobj:%p, flags:%0x, blkno:%ld, lblkno:%ld\n",
382 bp->b_flags, (long)bp->b_blkno,
389 * Failed to sync all blocks. Indicate this and don't
390 * unmount filesystems (thus forcing an fsck on reboot).
392 printf("Giving up on %d buffers\n", nbusy);
393 DELAY(5000000); /* 5 seconds */
395 if (!first_buf_printf)
396 printf("Final sync complete\n");
398 * Unmount filesystems
404 DELAY(100000); /* wait for console output to finish */
410 * Ok, now do things that assume all filesystem activity has
413 EVENTHANDLER_INVOKE(shutdown_post_sync, howto);
415 if ((howto & (RB_HALT|RB_DUMP)) == RB_DUMP && !cold && !dumping)
418 /* Now that we're going to really halt the system... */
419 EVENTHANDLER_INVOKE(shutdown_final, howto);
421 for(;;) ; /* safety against shutdown_reset not working */
426 * If the shutdown was a clean halt, behave accordingly.
429 shutdown_halt(void *junk, int howto)
432 if (howto & RB_HALT) {
434 printf("The operating system has halted.\n");
435 printf("Please press any key to reboot.\n\n");
437 case -1: /* No console, just die */
448 * Check to see if the system paniced, pause and then reboot
449 * according to the specified delay.
452 shutdown_panic(void *junk, int howto)
456 if (howto & RB_DUMP) {
457 if (PANIC_REBOOT_WAIT_TIME != 0) {
458 if (PANIC_REBOOT_WAIT_TIME != -1) {
459 printf("Automatic reboot in %d seconds - "
460 "press a key on the console to abort\n",
461 PANIC_REBOOT_WAIT_TIME);
462 for (loop = PANIC_REBOOT_WAIT_TIME * 10;
464 DELAY(1000 * 100); /* 1/10th second */
465 /* Did user type a key? */
466 if (cncheckc() != -1)
472 } else { /* zero time specified - reboot NOW */
475 printf("--> Press a key on the console to reboot,\n");
476 printf("--> or switch off the system now.\n");
482 * Everything done, now reset
485 shutdown_reset(void *junk, int howto)
489 * Disable interrupts on CPU0 in order to avoid fast handlers
490 * to preempt the stopping process and to deadlock against other
495 printf("Rebooting...\n");
496 DELAY(1000000); /* wait 1 sec for printf's to complete and be read */
497 /* cpu_boot(howto); */ /* doesn't do anything at the moment */
499 /* NOTREACHED */ /* assuming reset worked */
503 static u_int panic_cpu = NOCPU;
507 * Panic is called on unresolvable fatal errors. It prints "panic: mesg",
508 * and then reboots. If we are called twice, then we avoid trying to sync
509 * the disks as this often leads to recursive panics.
512 panic(const char *fmt, ...)
514 struct thread *td = curthread;
515 int bootopt, newpanic;
517 static char buf[256];
522 * We don't want multiple CPU's to panic at the same time, so we
523 * use panic_cpu as a simple spinlock. We have to keep checking
524 * panic_cpu if we are spinning in case the panic on the first
527 if (panic_cpu != PCPU_GET(cpuid))
528 while (atomic_cmpset_int(&panic_cpu, NOCPU,
529 PCPU_GET(cpuid)) == 0)
530 while (panic_cpu != NOCPU)
534 bootopt = RB_AUTOBOOT | RB_DUMP;
537 bootopt |= RB_NOSYNC;
545 (void)vsnprintf(buf, sizeof(buf), fmt, ap);
547 printf("panic: %s\n", buf);
555 printf("cpuid = %d\n", PCPU_GET(cpuid));
559 if (newpanic && trace_on_panic)
561 if (debugger_on_panic)
562 kdb_enter(KDB_WHY_PANIC, "panic");
563 #ifdef RESTARTABLE_PANICS
564 /* See if the user aborted the panic, in which case we continue. */
565 if (panicstr == NULL) {
567 atomic_store_rel_int(&panic_cpu, NOCPU);
573 /*thread_lock(td); */
574 td->td_flags |= TDF_INPANIC;
575 /* thread_unlock(td); */
577 bootopt |= RB_NOSYNC;
583 * Support for poweroff delay.
585 #ifndef POWEROFF_DELAY
586 # define POWEROFF_DELAY 5000
588 static int poweroff_delay = POWEROFF_DELAY;
590 SYSCTL_INT(_kern_shutdown, OID_AUTO, poweroff_delay, CTLFLAG_RW,
591 &poweroff_delay, 0, "");
594 poweroff_wait(void *junk, int howto)
597 if (!(howto & RB_POWEROFF) || poweroff_delay <= 0)
599 DELAY(poweroff_delay * 1000);
603 * Some system processes (e.g. syncer) need to be stopped at appropriate
604 * points in their main loops prior to a system shutdown, so that they
605 * won't interfere with the shutdown process (e.g. by holding a disk buf
606 * to cause sync to fail). For each of these system processes, register
607 * shutdown_kproc() as a handler for one of shutdown events.
609 static int kproc_shutdown_wait = 60;
610 SYSCTL_INT(_kern_shutdown, OID_AUTO, kproc_shutdown_wait, CTLFLAG_RW,
611 &kproc_shutdown_wait, 0, "");
614 kproc_shutdown(void *arg, int howto)
617 char procname[MAXCOMLEN + 1];
623 p = (struct proc *)arg;
624 strlcpy(procname, p->p_comm, sizeof(procname));
625 printf("Waiting (max %d seconds) for system process `%s' to stop...",
626 kproc_shutdown_wait, procname);
627 error = kproc_suspend(p, kproc_shutdown_wait * hz);
629 if (error == EWOULDBLOCK)
630 printf("timed out\n");
636 kthread_shutdown(void *arg, int howto)
639 char procname[MAXCOMLEN + 1];
645 td = (struct thread *)arg;
646 strlcpy(procname, td->td_name, sizeof(procname));
647 printf("Waiting (max %d seconds) for system thread `%s' to stop...",
648 kproc_shutdown_wait, procname);
649 error = kthread_suspend(td, kproc_shutdown_wait * hz);
651 if (error == EWOULDBLOCK)
652 printf("timed out\n");
657 /* Registration of dumpers */
659 set_dumper(struct dumperinfo *di)
663 bzero(&dumper, sizeof dumper);
666 if (dumper.dumper != NULL)
672 /* Call dumper with bounds checking. */
674 dump_write(struct dumperinfo *di, void *virtual, vm_offset_t physical,
675 off_t offset, size_t length)
678 if (length != 0 && (offset < di->mediaoffset ||
679 offset - di->mediaoffset + length > di->mediasize)) {
680 printf("Attempt to write outside dump device boundaries.\n");
683 return (di->dumper(di->priv, virtual, physical, offset, length));
687 mkdumpheader(struct kerneldumpheader *kdh, char *magic, uint32_t archver,
688 uint64_t dumplen, uint32_t blksz)
691 bzero(kdh, sizeof(*kdh));
692 strncpy(kdh->magic, magic, sizeof(kdh->magic));
693 strncpy(kdh->architecture, MACHINE_ARCH, sizeof(kdh->architecture));
694 kdh->version = htod32(KERNELDUMPVERSION);
695 kdh->architectureversion = htod32(archver);
696 kdh->dumplength = htod64(dumplen);
697 kdh->dumptime = htod64(time_second);
698 kdh->blocksize = htod32(blksz);
699 strncpy(kdh->hostname, prison0.pr_hostname, sizeof(kdh->hostname));
700 strncpy(kdh->versionstring, version, sizeof(kdh->versionstring));
701 if (panicstr != NULL)
702 strncpy(kdh->panicstring, panicstr, sizeof(kdh->panicstring));
703 kdh->parity = kerneldump_parity(kdh);