sys/kern/kern_shutdown.c

   1 /*-
   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.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)kern_shutdown.c     8.3 (Berkeley) 1/21/94
  39  * $FreeBSD: src/sys/kern/kern_shutdown.c,v 1.72.2.12 2002/02/21 19:15:10 dillon Exp $
  40  * $DragonFly: src/sys/kern/kern_shutdown.c,v 1.2 2003/06/17 04:28:41 dillon Exp $
  41  */
  42
  43 #include "opt_ddb.h"
  44 #include "opt_hw_wdog.h"
  45 #include "opt_panic.h"
  46 #include "opt_show_busybufs.h"
  47
  48 #include <sys/param.h>
  49 #include <sys/systm.h>
  50 #include <sys/eventhandler.h>
  51 #include <sys/buf.h>
  52 #include <sys/disklabel.h>
  53 #include <sys/reboot.h>
  54 #include <sys/proc.h>
  55 #include <sys/vnode.h>
  56 #include <sys/kernel.h>
  57 #include <sys/kthread.h>
  58 #include <sys/malloc.h>
  59 #include <sys/mount.h>
  60 #include <sys/queue.h>
  61 #include <sys/sysctl.h>
  62 #include <sys/conf.h>
  63 #include <sys/sysproto.h>
  64 #include <sys/cons.h>
  65
  66 #include <machine/pcb.h>
  67 #include <machine/clock.h>
  68 #include <machine/md_var.h>
  69 #include <machine/smp.h>                /* smp_active, cpuid */
  70
  71 #include <sys/signalvar.h>
  72
  73 #ifndef PANIC_REBOOT_WAIT_TIME
  74 #define PANIC_REBOOT_WAIT_TIME 15 /* default to 15 seconds */
  75 #endif
  76
  77 /*
  78  * Note that stdarg.h and the ANSI style va_start macro is used for both
  79  * ANSI and traditional C compilers.
  80  */
  81 #include <machine/stdarg.h>
  82
  83 #ifdef DDB
  84 #ifdef DDB_UNATTENDED
  85 int debugger_on_panic = 0;
  86 #else
  87 int debugger_on_panic = 1;
  88 #endif
  89 SYSCTL_INT(_debug, OID_AUTO, debugger_on_panic, CTLFLAG_RW,
  90         &debugger_on_panic, 0, "Run debugger on kernel panic");
  91 #endif
  92
  93 SYSCTL_NODE(_kern, OID_AUTO, shutdown, CTLFLAG_RW, 0, "Shutdown environment");
  94
  95 #ifdef  HW_WDOG
  96 /*
  97  * If there is a hardware watchdog, point this at the function needed to
  98  * hold it off.
  99  * It's needed when the kernel needs to do some lengthy operations.
 100  * e.g. in wd.c when dumping core.. It's most annoying to have
 101  * your precious core-dump only half written because the wdog kicked in.
 102  */
 103 watchdog_tickle_fn wdog_tickler = NULL;
 104 #endif  /* HW_WDOG */
 105
 106 /*
 107  * Variable panicstr contains argument to first call to panic; used as flag
 108  * to indicate that the kernel has already called panic.
 109  */
 110 const char *panicstr;
 111
 112 int dumping;                            /* system is dumping */
 113
 114 static void boot __P((int)) __dead2;
 115 static void dumpsys __P((void));
 116 static int setdumpdev __P((dev_t dev));
 117 static void poweroff_wait __P((void *, int));
 118 static void print_uptime __P((void));
 119 static void shutdown_halt __P((void *junk, int howto));
 120 static void shutdown_panic __P((void *junk, int howto));
 121 static void shutdown_reset __P((void *junk, int howto));
 122
 123 /* register various local shutdown events */
 124 static void
 125 shutdown_conf(void *unused)
 126 {
 127         EVENTHANDLER_REGISTER(shutdown_final, poweroff_wait, NULL, SHUTDOWN_PRI_FIRST);
 128         EVENTHANDLER_REGISTER(shutdown_final, shutdown_halt, NULL, SHUTDOWN_PRI_LAST + 100);
 129         EVENTHANDLER_REGISTER(shutdown_final, shutdown_panic, NULL, SHUTDOWN_PRI_LAST + 100);
 130         EVENTHANDLER_REGISTER(shutdown_final, shutdown_reset, NULL, SHUTDOWN_PRI_LAST + 200);
 131 }
 132
 133 SYSINIT(shutdown_conf, SI_SUB_INTRINSIC, SI_ORDER_ANY, shutdown_conf, NULL)
 134
 135 /* ARGSUSED */
 136
 137 /*
 138  * The system call that results in a reboot
 139  */
 140 int
 141 reboot(p, uap)
 142         struct proc *p;
 143         struct reboot_args *uap;
 144 {
 145         int error;
 146
 147         if ((error = suser(p)))
 148                 return (error);
 149
 150         boot(uap->opt);
 151         return (0);
 152 }
 153
 154 /*
 155  * Called by events that want to shut down.. e.g  <CTL><ALT><DEL> on a PC
 156  */
 157 static int shutdown_howto = 0;
 158
 159 void
 160 shutdown_nice(int howto)
 161 {
 162         shutdown_howto = howto;
 163
 164         /* Send a signal to init(8) and have it shutdown the world */
 165         if (initproc != NULL) {
 166                 psignal(initproc, SIGINT);
 167         } else {
 168                 /* No init(8) running, so simply reboot */
 169                 boot(RB_NOSYNC);
 170         }
 171         return;
 172 }
 173 static int      waittime = -1;
 174 static struct pcb dumppcb;
 175
 176 static void
 177 print_uptime()
 178 {
 179         int f;
 180         struct timespec ts;
 181
 182         getnanouptime(&ts);
 183         printf("Uptime: ");
 184         f = 0;
 185         if (ts.tv_sec >= 86400) {
 186                 printf("%ldd", ts.tv_sec / 86400);
 187                 ts.tv_sec %= 86400;
 188                 f = 1;
 189         }
 190         if (f || ts.tv_sec >= 3600) {
 191                 printf("%ldh", ts.tv_sec / 3600);
 192                 ts.tv_sec %= 3600;
 193                 f = 1;
 194         }
 195         if (f || ts.tv_sec >= 60) {
 196                 printf("%ldm", ts.tv_sec / 60);
 197                 ts.tv_sec %= 60;
 198                 f = 1;
 199         }
 200         printf("%lds\n", ts.tv_sec);
 201 }
 202
 203 /*
 204  *  Go through the rigmarole of shutting down..
 205  * this used to be in machdep.c but I'll be dammned if I could see
 206  * anything machine dependant in it.
 207  */
 208 static void
 209 boot(howto)
 210         int howto;
 211 {
 212
 213         /* collect extra flags that shutdown_nice might have set */
 214         howto |= shutdown_howto;
 215
 216 #ifdef SMP
 217         if (smp_active) {
 218                 printf("boot() called on cpu#%d\n", cpuid);
 219         }
 220 #endif
 221         /*
 222          * Do any callouts that should be done BEFORE syncing the filesystems.
 223          */
 224         EVENTHANDLER_INVOKE(shutdown_pre_sync, howto);
 225
 226         /*
 227          * Now sync filesystems
 228          */
 229         if (!cold && (howto & RB_NOSYNC) == 0 && waittime < 0) {
 230                 register struct buf *bp;
 231                 int iter, nbusy, pbusy;
 232
 233                 waittime = 0;
 234                 printf("\nsyncing disks... ");
 235
 236                 sync(&proc0, NULL);
 237
 238                 /*
 239                  * With soft updates, some buffers that are
 240                  * written will be remarked as dirty until other
 241                  * buffers are written.
 242                  */
 243                 for (iter = pbusy = 0; iter < 20; iter++) {
 244                         nbusy = 0;
 245                         for (bp = &buf[nbuf]; --bp >= buf; ) {
 246                                 if ((bp->b_flags & B_INVAL) == 0 &&
 247                                     BUF_REFCNT(bp) > 0) {
 248                                         nbusy++;
 249                                 } else if ((bp->b_flags & (B_DELWRI | B_INVAL))
 250                                                 == B_DELWRI) {
 251                                         /* bawrite(bp);*/
 252                                         nbusy++;
 253                                 }
 254                         }
 255                         if (nbusy == 0)
 256                                 break;
 257                         printf("%d ", nbusy);
 258                         if (nbusy < pbusy)
 259                                 iter = 0;
 260                         pbusy = nbusy;
 261                         if (iter > 5 && bioops.io_sync)
 262                                 (*bioops.io_sync)(NULL);
 263                         sync(&proc0, NULL);
 264                         DELAY(50000 * iter);
 265                 }
 266                 printf("\n");
 267                 /*
 268                  * Count only busy local buffers to prevent forcing
 269                  * a fsck if we're just a client of a wedged NFS server
 270                  */
 271                 nbusy = 0;
 272                 for (bp = &buf[nbuf]; --bp >= buf; ) {
 273                         if (((bp->b_flags&B_INVAL) == 0 && BUF_REFCNT(bp)) ||
 274                             ((bp->b_flags & (B_DELWRI|B_INVAL)) == B_DELWRI)) {
 275                                 if (bp->b_dev == NODEV) {
 276                                         TAILQ_REMOVE(&mountlist,
 277                                             bp->b_vp->v_mount, mnt_list);
 278                                         continue;
 279                                 }
 280                                 nbusy++;
 281 #if defined(SHOW_BUSYBUFS) || defined(DIAGNOSTIC)
 282                                 printf(
 283                             "%p %d: dev:%s, flags:%08lx, blkno:%ld, lblkno:%ld\n",
 284                                     bp, nbusy, devtoname(bp->b_dev),
 285                                     bp->b_flags, (long)bp->b_blkno,
 286                                     (long)bp->b_lblkno);
 287 #endif
 288                         }
 289                 }
 290                 if (nbusy) {
 291                         /*
 292                          * Failed to sync all blocks. Indicate this and don't
 293                          * unmount filesystems (thus forcing an fsck on reboot).
 294                          */
 295                         printf("giving up on %d buffers\n", nbusy);
 296                         DELAY(5000000); /* 5 seconds */
 297                 } else {
 298                         printf("done\n");
 299                         /*
 300                          * Unmount filesystems
 301                          */
 302                         if (panicstr == 0)
 303                                 vfs_unmountall();
 304                 }
 305                 DELAY(100000);          /* wait for console output to finish */
 306         }
 307
 308         print_uptime();
 309
 310         /*
 311          * Ok, now do things that assume all filesystem activity has
 312          * been completed.
 313          */
 314         EVENTHANDLER_INVOKE(shutdown_post_sync, howto);
 315         splhigh();
 316         if ((howto & (RB_HALT|RB_DUMP)) == RB_DUMP && !cold)
 317                 dumpsys();
 318
 319         /* Now that we're going to really halt the system... */
 320         EVENTHANDLER_INVOKE(shutdown_final, howto);
 321
 322         for(;;) ;       /* safety against shutdown_reset not working */
 323         /* NOTREACHED */
 324 }
 325
 326 /*
 327  * If the shutdown was a clean halt, behave accordingly.
 328  */
 329 static void
 330 shutdown_halt(void *junk, int howto)
 331 {
 332         if (howto & RB_HALT) {
 333                 printf("\n");
 334                 printf("The operating system has halted.\n");
 335                 printf("Please press any key to reboot.\n\n");
 336                 switch (cngetc()) {
 337                 case -1:                /* No console, just die */
 338                         cpu_halt();
 339                         /* NOTREACHED */
 340                 default:
 341                         howto &= ~RB_HALT;
 342                         break;
 343                 }
 344         }
 345 }
 346
 347 /*
 348  * Check to see if the system paniced, pause and then reboot
 349  * according to the specified delay.
 350  */
 351 static void
 352 shutdown_panic(void *junk, int howto)
 353 {
 354         int loop;
 355
 356         if (howto & RB_DUMP) {
 357                 if (PANIC_REBOOT_WAIT_TIME != 0) {
 358                         if (PANIC_REBOOT_WAIT_TIME != -1) {
 359                                 printf("Automatic reboot in %d seconds - "
 360                                        "press a key on the console to abort\n",
 361                                         PANIC_REBOOT_WAIT_TIME);
 362                                 for (loop = PANIC_REBOOT_WAIT_TIME * 10;
 363                                      loop > 0; --loop) {
 364                                         DELAY(1000 * 100); /* 1/10th second */
 365                                         /* Did user type a key? */
 366                                         if (cncheckc() != -1)
 367                                                 break;
 368                                 }
 369                                 if (!loop)
 370                                         return;
 371                         }
 372                 } else { /* zero time specified - reboot NOW */
 373                         return;
 374                 }
 375                 printf("--> Press a key on the console to reboot,\n");
 376                 printf("--> or switch off the system now.\n");
 377                 cngetc();
 378         }
 379 }
 380
 381 /*
 382  * Everything done, now reset
 383  */
 384 static void
 385 shutdown_reset(void *junk, int howto)
 386 {
 387         printf("Rebooting...\n");
 388         DELAY(1000000); /* wait 1 sec for printf's to complete and be read */
 389         /* cpu_boot(howto); */ /* doesn't do anything at the moment */
 390         cpu_reset();
 391         /* NOTREACHED */ /* assuming reset worked */
 392 }
 393
 394 /*
 395  * Magic number for savecore
 396  *
 397  * exported (symorder) and used at least by savecore(8)
 398  *
 399  */
 400 static u_long const     dumpmag = 0x8fca0101UL;
 401
 402 static int      dumpsize = 0;           /* also for savecore */
 403
 404 static int      dodump = 1;
 405
 406 SYSCTL_INT(_machdep, OID_AUTO, do_dump, CTLFLAG_RW, &dodump, 0,
 407     "Try to perform coredump on kernel panic");
 408
 409 static int
 410 setdumpdev(dev)
 411         dev_t dev;
 412 {
 413         int psize;
 414         long newdumplo;
 415
 416         if (dev == NODEV) {
 417                 dumpdev = dev;
 418                 return (0);
 419         }
 420         if (devsw(dev) == NULL)
 421                 return (ENXIO);         /* XXX is this right? */
 422         if (devsw(dev)->d_psize == NULL)
 423                 return (ENXIO);         /* XXX should be ENODEV ? */
 424         psize = devsw(dev)->d_psize(dev);
 425         if (psize == -1)
 426                 return (ENXIO);         /* XXX should be ENODEV ? */
 427         /*
 428          * XXX should clean up checking in dumpsys() to be more like this.
 429          */
 430         newdumplo = psize - Maxmem * (PAGE_SIZE / DEV_BSIZE);
 431         if (newdumplo <= LABELSECTOR)
 432                 return (ENOSPC);
 433         dumpdev = dev;
 434         dumplo = newdumplo;
 435         return (0);
 436 }
 437
 438
 439 /* ARGSUSED */
 440 static void dump_conf __P((void *dummy));
 441 static void
 442 dump_conf(dummy)
 443         void *dummy;
 444 {
 445         char *path;
 446         dev_t dev;
 447
 448         path = malloc(MNAMELEN, M_TEMP, M_WAITOK);
 449         if (TUNABLE_STR_FETCH("dumpdev", path, MNAMELEN) != 0) {
 450                 dev = getdiskbyname(path);
 451                 if (dev != NODEV)
 452                         dumpdev = dev;
 453         }
 454         free(path, M_TEMP);
 455         if (setdumpdev(dumpdev) != 0)
 456                 dumpdev = NODEV;
 457 }
 458
 459 SYSINIT(dump_conf, SI_SUB_DUMP_CONF, SI_ORDER_FIRST, dump_conf, NULL)
 460
 461 static int
 462 sysctl_kern_dumpdev(SYSCTL_HANDLER_ARGS)
 463 {
 464         int error;
 465         udev_t ndumpdev;
 466
 467         ndumpdev = dev2udev(dumpdev);
 468         error = sysctl_handle_opaque(oidp, &ndumpdev, sizeof ndumpdev, req);
 469         if (error == 0 && req->newptr != NULL)
 470                 error = setdumpdev(udev2dev(ndumpdev, 0));
 471         return (error);
 472 }
 473
 474 SYSCTL_PROC(_kern, KERN_DUMPDEV, dumpdev, CTLTYPE_OPAQUE|CTLFLAG_RW,
 475         0, sizeof dumpdev, sysctl_kern_dumpdev, "T,dev_t", "");
 476
 477 /*
 478  * Doadump comes here after turning off memory management and
 479  * getting on the dump stack, either when called above, or by
 480  * the auto-restart code.
 481  */
 482 static void
 483 dumpsys(void)
 484 {
 485         int     error;
 486
 487         savectx(&dumppcb);
 488         if (dumping++) {
 489                 printf("Dump already in progress, bailing...\n");
 490                 return;
 491         }
 492         if (!dodump)
 493                 return;
 494         if (dumpdev == NODEV)
 495                 return;
 496         if (!(devsw(dumpdev)))
 497                 return;
 498         if (!(devsw(dumpdev)->d_dump))
 499                 return;
 500         dumpsize = Maxmem;
 501         printf("\ndumping to dev %s, offset %ld\n", devtoname(dumpdev), dumplo);
 502         printf("dump ");
 503         error = (*devsw(dumpdev)->d_dump)(dumpdev);
 504         if (error == 0) {
 505                 printf("succeeded\n");
 506                 return;
 507         }
 508         printf("failed, reason: ");
 509         switch (error) {
 510         case ENODEV:
 511                 printf("device doesn't support a dump routine\n");
 512                 break;
 513
 514         case ENXIO:
 515                 printf("device bad\n");
 516                 break;
 517
 518         case EFAULT:
 519                 printf("device not ready\n");
 520                 break;
 521
 522         case EINVAL:
 523                 printf("area improper\n");
 524                 break;
 525
 526         case EIO:
 527                 printf("i/o error\n");
 528                 break;
 529
 530         case EINTR:
 531                 printf("aborted from console\n");
 532                 break;
 533
 534         default:
 535                 printf("unknown, error = %d\n", error);
 536                 break;
 537         }
 538 }
 539
 540 int
 541 dumpstatus(vm_offset_t addr, off_t count)
 542 {
 543         int c;
 544
 545         if (addr % (1024 * 1024) == 0) {
 546 #ifdef HW_WDOG
 547                 if (wdog_tickler)
 548                         (*wdog_tickler)();
 549 #endif
 550                 printf("%ld ", (long)(count / (1024 * 1024)));
 551         }
 552
 553         if ((c = cncheckc()) == 0x03)
 554                 return -1;
 555         else if (c != -1)
 556                 printf("[CTRL-C to abort] ");
 557
 558         return 0;
 559 }
 560
 561 /*
 562  * Panic is called on unresolvable fatal errors.  It prints "panic: mesg",
 563  * and then reboots.  If we are called twice, then we avoid trying to sync
 564  * the disks as this often leads to recursive panics.
 565  */
 566 void
 567 panic(const char *fmt, ...)
 568 {
 569         int bootopt;
 570         va_list ap;
 571         static char buf[256];
 572
 573         bootopt = RB_AUTOBOOT | RB_DUMP;
 574         if (panicstr)
 575                 bootopt |= RB_NOSYNC;
 576         else
 577                 panicstr = fmt;
 578
 579         va_start(ap, fmt);
 580         (void)vsnprintf(buf, sizeof(buf), fmt, ap);
 581         if (panicstr == fmt)
 582                 panicstr = buf;
 583         va_end(ap);
 584         printf("panic: %s\n", buf);
 585 #ifdef SMP
 586         /* three seperate prints in case of an unmapped page and trap */
 587         printf("mp_lock = %08x; ", mp_lock);
 588         printf("cpuid = %d; ", cpuid);
 589         printf("lapic.id = %08x\n", lapic.id);
 590 #endif
 591
 592 #if defined(DDB)
 593         if (debugger_on_panic)
 594                 Debugger ("panic");
 595 #endif
 596         boot(bootopt);
 597 }
 598
 599 /*
 600  * Support for poweroff delay.
 601  */
 602 #ifndef POWEROFF_DELAY
 603 # define POWEROFF_DELAY 5000
 604 #endif
 605 static int poweroff_delay = POWEROFF_DELAY;
 606
 607 SYSCTL_INT(_kern_shutdown, OID_AUTO, poweroff_delay, CTLFLAG_RW,
 608         &poweroff_delay, 0, "");
 609
 610 static void
 611 poweroff_wait(void *junk, int howto)
 612 {
 613         if(!(howto & RB_POWEROFF) || poweroff_delay <= 0)
 614                 return;
 615         DELAY(poweroff_delay * 1000);
 616 }
 617
 618 /*
 619  * Some system processes (e.g. syncer) need to be stopped at appropriate
 620  * points in their main loops prior to a system shutdown, so that they
 621  * won't interfere with the shutdown process (e.g. by holding a disk buf
 622  * to cause sync to fail).  For each of these system processes, register
 623  * shutdown_kproc() as a handler for one of shutdown events.
 624  */
 625 static int kproc_shutdown_wait = 60;
 626 SYSCTL_INT(_kern_shutdown, OID_AUTO, kproc_shutdown_wait, CTLFLAG_RW,
 627     &kproc_shutdown_wait, 0, "");
 628
 629 void
 630 shutdown_kproc(void *arg, int howto)
 631 {
 632         struct proc *p;
 633         int error;
 634
 635         if (panicstr)
 636                 return;
 637
 638         p = (struct proc *)arg;
 639         printf("Waiting (max %d seconds) for system process `%s' to stop...",
 640             kproc_shutdown_wait, p->p_comm);
 641         error = suspend_kproc(p, kproc_shutdown_wait * hz);
 642
 643         if (error == EWOULDBLOCK)
 644                 printf("timed out\n");
 645         else
 646                 printf("stopped\n");
 647 }