sys/kern/kern_shutdown.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   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.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  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.
  23  *
  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
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)kern_shutdown.c     8.3 (Berkeley) 1/21/94
  37  */
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include "opt_ddb.h"
  43 #include "opt_ekcd.h"
  44 #include "opt_kdb.h"
  45 #include "opt_panic.h"
  46 #include "opt_printf.h"
  47 #include "opt_sched.h"
  48 #include "opt_watchdog.h"
  49
  50 #include <sys/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/bio.h>
  53 #include <sys/buf.h>
  54 #include <sys/conf.h>
  55 #include <sys/compressor.h>
  56 #include <sys/cons.h>
  57 #include <sys/disk.h>
  58 #include <sys/eventhandler.h>
  59 #include <sys/filedesc.h>
  60 #include <sys/jail.h>
  61 #include <sys/kdb.h>
  62 #include <sys/kernel.h>
  63 #include <sys/kerneldump.h>
  64 #include <sys/kthread.h>
  65 #include <sys/ktr.h>
  66 #include <sys/malloc.h>
  67 #include <sys/mbuf.h>
  68 #include <sys/mount.h>
  69 #include <sys/priv.h>
  70 #include <sys/proc.h>
  71 #include <sys/reboot.h>
  72 #include <sys/resourcevar.h>
  73 #include <sys/rwlock.h>
  74 #include <sys/sbuf.h>
  75 #include <sys/sched.h>
  76 #include <sys/smp.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>
  82
  83 #include <crypto/chacha20/chacha.h>
  84 #include <crypto/rijndael/rijndael-api-fst.h>
  85 #include <crypto/sha2/sha256.h>
  86
  87 #include <ddb/ddb.h>
  88
  89 #include <machine/cpu.h>
  90 #include <machine/dump.h>
  91 #include <machine/pcb.h>
  92 #include <machine/smp.h>
  93
  94 #include <security/mac/mac_framework.h>
  95
  96 #include <vm/vm.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>
 101
 102 #include <sys/signalvar.h>
 103
 104 static MALLOC_DEFINE(M_DUMPER, "dumper", "dumper block buffer");
 105
 106 #ifndef PANIC_REBOOT_WAIT_TIME
 107 #define PANIC_REBOOT_WAIT_TIME 15 /* default to 15 seconds */
 108 #endif
 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");
 113
 114 /*
 115  * Note that stdarg.h and the ANSI style va_start macro is used for both
 116  * ANSI and traditional C compilers.
 117  */
 118 #include <machine/stdarg.h>
 119
 120 #ifdef KDB
 121 #ifdef KDB_UNATTENDED
 122 static int debugger_on_panic = 0;
 123 #else
 124 static int debugger_on_panic = 1;
 125 #endif
 126 SYSCTL_INT(_debug, OID_AUTO, debugger_on_panic,
 127     CTLFLAG_RWTUN | CTLFLAG_SECURE,
 128     &debugger_on_panic, 0, "Run debugger on kernel panic");
 129
 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");
 134
 135 #ifdef KDB_TRACE
 136 static int trace_on_panic = 1;
 137 static bool trace_all_panics = true;
 138 #else
 139 static int trace_on_panic = 0;
 140 static bool trace_all_panics = false;
 141 #endif
 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");
 147 #endif /* KDB */
 148
 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");
 152
 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");
 156
 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");
 160
 161 static SYSCTL_NODE(_kern, OID_AUTO, shutdown, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
 162     "Shutdown environment");
 163
 164 #ifndef DIAGNOSTIC
 165 static int show_busybufs;
 166 #else
 167 static int show_busybufs = 1;
 168 #endif
 169 SYSCTL_INT(_kern_shutdown, OID_AUTO, show_busybufs, CTLFLAG_RW,
 170         &show_busybufs, 0, "");
 171
 172 int suspend_blocked = 0;
 173 SYSCTL_INT(_kern, OID_AUTO, suspend_blocked, CTLFLAG_RW,
 174         &suspend_blocked, 0, "Block suspend due to a pending shutdown");
 175
 176 #ifdef EKCD
 177 FEATURE(ekcd, "Encrypted kernel crash dumps support");
 178
 179 MALLOC_DEFINE(M_EKCD, "ekcd", "Encrypted kernel crash dumps data");
 180
 181 struct kerneldumpcrypto {
 182         uint8_t                 kdc_encryption;
 183         uint8_t                 kdc_iv[KERNELDUMP_IV_MAX_SIZE];
 184         union {
 185                 struct {
 186                         keyInstance     aes_ki;
 187                         cipherInstance  aes_ci;
 188                 } u_aes;
 189                 struct chacha_ctx       u_chacha;
 190         } u;
 191 #define kdc_ki  u.u_aes.aes_ki
 192 #define kdc_ci  u.u_aes.aes_ci
 193 #define kdc_chacha      u.u_chacha
 194         uint32_t                kdc_dumpkeysize;
 195         struct kerneldumpkey    kdc_dumpkey[];
 196 };
 197 #endif
 198
 199 struct kerneldumpcomp {
 200         uint8_t                 kdc_format;
 201         struct compressor       *kdc_stream;
 202         uint8_t                 *kdc_buf;
 203         size_t                  kdc_resid;
 204 };
 205
 206 static struct kerneldumpcomp *kerneldumpcomp_create(struct dumperinfo *di,
 207                     uint8_t compression);
 208 static void     kerneldumpcomp_destroy(struct dumperinfo *di);
 209 static int      kerneldumpcomp_write_cb(void *base, size_t len, off_t off, void *arg);
 210
 211 static int kerneldump_gzlevel = 6;
 212 SYSCTL_INT(_kern, OID_AUTO, kerneldump_gzlevel, CTLFLAG_RWTUN,
 213     &kerneldump_gzlevel, 0,
 214     "Kernel crash dump compression level");
 215
 216 /*
 217  * Variable panicstr contains argument to first call to panic; used as flag
 218  * to indicate that the kernel has already called panic.
 219  */
 220 const char *panicstr;
 221 bool __read_frequently panicked;
 222
 223 int __read_mostly dumping;              /* system is dumping */
 224 int rebooting;                          /* system is rebooting */
 225 /*
 226  * Used to serialize between sysctl kern.shutdown.dumpdevname and list
 227  * modifications via ioctl.
 228  */
 229 static struct mtx dumpconf_list_lk;
 230 MTX_SYSINIT(dumper_configs, &dumpconf_list_lk, "dumper config list", MTX_DEF);
 231
 232 /* Our selected dumper(s). */
 233 static TAILQ_HEAD(dumpconflist, dumperinfo) dumper_configs =
 234     TAILQ_HEAD_INITIALIZER(dumper_configs);
 235
 236 /* Context information for dump-debuggers. */
 237 static struct pcb dumppcb;              /* Registers. */
 238 lwpid_t dumptid;                        /* Thread ID. */
 239
 240 static struct cdevsw reroot_cdevsw = {
 241      .d_version = D_VERSION,
 242      .d_name    = "reroot",
 243 };
 244
 245 static void poweroff_wait(void *, int);
 246 static void shutdown_halt(void *junk, int howto);
 247 static void shutdown_panic(void *junk, int howto);
 248 static void shutdown_reset(void *junk, int howto);
 249 static int kern_reroot(void);
 250
 251 /* register various local shutdown events */
 252 static void
 253 shutdown_conf(void *unused)
 254 {
 255
 256         EVENTHANDLER_REGISTER(shutdown_final, poweroff_wait, NULL,
 257             SHUTDOWN_PRI_FIRST);
 258         EVENTHANDLER_REGISTER(shutdown_final, shutdown_halt, NULL,
 259             SHUTDOWN_PRI_LAST + 100);
 260         EVENTHANDLER_REGISTER(shutdown_final, shutdown_panic, NULL,
 261             SHUTDOWN_PRI_LAST + 100);
 262         EVENTHANDLER_REGISTER(shutdown_final, shutdown_reset, NULL,
 263             SHUTDOWN_PRI_LAST + 200);
 264 }
 265
 266 SYSINIT(shutdown_conf, SI_SUB_INTRINSIC, SI_ORDER_ANY, shutdown_conf, NULL);
 267
 268 /*
 269  * The only reason this exists is to create the /dev/reroot/ directory,
 270  * used by reroot code in init(8) as a mountpoint for tmpfs.
 271  */
 272 static void
 273 reroot_conf(void *unused)
 274 {
 275         int error;
 276         struct cdev *cdev;
 277
 278         error = make_dev_p(MAKEDEV_CHECKNAME | MAKEDEV_WAITOK, &cdev,
 279             &reroot_cdevsw, NULL, UID_ROOT, GID_WHEEL, 0600, "reroot/reroot");
 280         if (error != 0) {
 281                 printf("%s: failed to create device node, error %d",
 282                     __func__, error);
 283         }
 284 }
 285
 286 SYSINIT(reroot_conf, SI_SUB_DEVFS, SI_ORDER_ANY, reroot_conf, NULL);
 287
 288 /*
 289  * The system call that results in a reboot.
 290  */
 291 /* ARGSUSED */
 292 int
 293 sys_reboot(struct thread *td, struct reboot_args *uap)
 294 {
 295         int error;
 296
 297         error = 0;
 298 #ifdef MAC
 299         error = mac_system_check_reboot(td->td_ucred, uap->opt);
 300 #endif
 301         if (error == 0)
 302                 error = priv_check(td, PRIV_REBOOT);
 303         if (error == 0) {
 304                 if (uap->opt & RB_REROOT)
 305                         error = kern_reroot();
 306                 else
 307                         kern_reboot(uap->opt);
 308         }
 309         return (error);
 310 }
 311
 312 static void
 313 shutdown_nice_task_fn(void *arg, int pending __unused)
 314 {
 315         int howto;
 316
 317         howto = (uintptr_t)arg;
 318         /* Send a signal to init(8) and have it shutdown the world. */
 319         PROC_LOCK(initproc);
 320         if (howto & RB_POWEROFF)
 321                 kern_psignal(initproc, SIGUSR2);
 322         else if (howto & RB_POWERCYCLE)
 323                 kern_psignal(initproc, SIGWINCH);
 324         else if (howto & RB_HALT)
 325                 kern_psignal(initproc, SIGUSR1);
 326         else
 327                 kern_psignal(initproc, SIGINT);
 328         PROC_UNLOCK(initproc);
 329 }
 330
 331 static struct task shutdown_nice_task = TASK_INITIALIZER(0,
 332     &shutdown_nice_task_fn, NULL);
 333
 334 /*
 335  * Called by events that want to shut down.. e.g  <CTL><ALT><DEL> on a PC
 336  */
 337 void
 338 shutdown_nice(int howto)
 339 {
 340
 341         if (initproc != NULL && !SCHEDULER_STOPPED()) {
 342                 shutdown_nice_task.ta_context = (void *)(uintptr_t)howto;
 343                 taskqueue_enqueue(taskqueue_fast, &shutdown_nice_task);
 344         } else {
 345                 /*
 346                  * No init(8) running, or scheduler would not allow it
 347                  * to run, so simply reboot.
 348                  */
 349                 kern_reboot(howto | RB_NOSYNC);
 350         }
 351 }
 352
 353 static void
 354 print_uptime(void)
 355 {
 356         int f;
 357         struct timespec ts;
 358
 359         getnanouptime(&ts);
 360         printf("Uptime: ");
 361         f = 0;
 362         if (ts.tv_sec >= 86400) {
 363                 printf("%ldd", (long)ts.tv_sec / 86400);
 364                 ts.tv_sec %= 86400;
 365                 f = 1;
 366         }
 367         if (f || ts.tv_sec >= 3600) {
 368                 printf("%ldh", (long)ts.tv_sec / 3600);
 369                 ts.tv_sec %= 3600;
 370                 f = 1;
 371         }
 372         if (f || ts.tv_sec >= 60) {
 373                 printf("%ldm", (long)ts.tv_sec / 60);
 374                 ts.tv_sec %= 60;
 375                 f = 1;
 376         }
 377         printf("%lds\n", (long)ts.tv_sec);
 378 }
 379
 380 int
 381 doadump(boolean_t textdump)
 382 {
 383         boolean_t coredump;
 384         int error;
 385
 386         error = 0;
 387         if (dumping)
 388                 return (EBUSY);
 389         if (TAILQ_EMPTY(&dumper_configs))
 390                 return (ENXIO);
 391
 392         savectx(&dumppcb);
 393         dumptid = curthread->td_tid;
 394         dumping++;
 395
 396         coredump = TRUE;
 397 #ifdef DDB
 398         if (textdump && textdump_pending) {
 399                 coredump = FALSE;
 400                 textdump_dumpsys(TAILQ_FIRST(&dumper_configs));
 401         }
 402 #endif
 403         if (coredump) {
 404                 struct dumperinfo *di;
 405
 406                 TAILQ_FOREACH(di, &dumper_configs, di_next) {
 407                         error = dumpsys(di);
 408                         if (error == 0)
 409                                 break;
 410                 }
 411         }
 412
 413         dumping--;
 414         return (error);
 415 }
 416
 417 /*
 418  * Shutdown the system cleanly to prepare for reboot, halt, or power off.
 419  */
 420 void
 421 kern_reboot(int howto)
 422 {
 423         static int once = 0;
 424
 425         /*
 426          * Normal paths here don't hold Giant, but we can wind up here
 427          * unexpectedly with it held.  Drop it now so we don't have to
 428          * drop and pick it up elsewhere. The paths it is locking will
 429          * never be returned to, and it is preferable to preclude
 430          * deadlock than to lock against code that won't ever
 431          * continue.
 432          */
 433         while (mtx_owned(&Giant))
 434                 mtx_unlock(&Giant);
 435
 436 #if defined(SMP)
 437         /*
 438          * Bind us to the first CPU so that all shutdown code runs there.  Some
 439          * systems don't shutdown properly (i.e., ACPI power off) if we
 440          * run on another processor.
 441          */
 442         if (!SCHEDULER_STOPPED()) {
 443                 thread_lock(curthread);
 444                 sched_bind(curthread, CPU_FIRST());
 445                 thread_unlock(curthread);
 446                 KASSERT(PCPU_GET(cpuid) == CPU_FIRST(),
 447                     ("boot: not running on cpu 0"));
 448         }
 449 #endif
 450         /* We're in the process of rebooting. */
 451         rebooting = 1;
 452
 453         /* We are out of the debugger now. */
 454         kdb_active = 0;
 455
 456         /*
 457          * Do any callouts that should be done BEFORE syncing the filesystems.
 458          */
 459         EVENTHANDLER_INVOKE(shutdown_pre_sync, howto);
 460
 461         /*
 462          * Now sync filesystems
 463          */
 464         if (!cold && (howto & RB_NOSYNC) == 0 && once == 0) {
 465                 once = 1;
 466                 bufshutdown(show_busybufs);
 467         }
 468
 469         print_uptime();
 470
 471         cngrab();
 472
 473         /*
 474          * Ok, now do things that assume all filesystem activity has
 475          * been completed.
 476          */
 477         EVENTHANDLER_INVOKE(shutdown_post_sync, howto);
 478
 479         if ((howto & (RB_HALT|RB_DUMP)) == RB_DUMP && !cold && !dumping)
 480                 doadump(TRUE);
 481
 482         /* Now that we're going to really halt the system... */
 483         EVENTHANDLER_INVOKE(shutdown_final, howto);
 484
 485         for(;;) ;       /* safety against shutdown_reset not working */
 486         /* NOTREACHED */
 487 }
 488
 489 /*
 490  * The system call that results in changing the rootfs.
 491  */
 492 static int
 493 kern_reroot(void)
 494 {
 495         struct vnode *oldrootvnode, *vp;
 496         struct mount *mp, *devmp;
 497         int error;
 498
 499         if (curproc != initproc)
 500                 return (EPERM);
 501
 502         /*
 503          * Mark the filesystem containing currently-running executable
 504          * (the temporary copy of init(8)) busy.
 505          */
 506         vp = curproc->p_textvp;
 507         error = vn_lock(vp, LK_SHARED);
 508         if (error != 0)
 509                 return (error);
 510         mp = vp->v_mount;
 511         error = vfs_busy(mp, MBF_NOWAIT);
 512         if (error != 0) {
 513                 vfs_ref(mp);
 514                 VOP_UNLOCK(vp);
 515                 error = vfs_busy(mp, 0);
 516                 vn_lock(vp, LK_SHARED | LK_RETRY);
 517                 vfs_rel(mp);
 518                 if (error != 0) {
 519                         VOP_UNLOCK(vp);
 520                         return (ENOENT);
 521                 }
 522                 if (VN_IS_DOOMED(vp)) {
 523                         VOP_UNLOCK(vp);
 524                         vfs_unbusy(mp);
 525                         return (ENOENT);
 526                 }
 527         }
 528         VOP_UNLOCK(vp);
 529
 530         /*
 531          * Remove the filesystem containing currently-running executable
 532          * from the mount list, to prevent it from being unmounted
 533          * by vfs_unmountall(), and to avoid confusing vfs_mountroot().
 534          *
 535          * Also preserve /dev - forcibly unmounting it could cause driver
 536          * reinitialization.
 537          */
 538
 539         vfs_ref(rootdevmp);
 540         devmp = rootdevmp;
 541         rootdevmp = NULL;
 542
 543         mtx_lock(&mountlist_mtx);
 544         TAILQ_REMOVE(&mountlist, mp, mnt_list);
 545         TAILQ_REMOVE(&mountlist, devmp, mnt_list);
 546         mtx_unlock(&mountlist_mtx);
 547
 548         oldrootvnode = rootvnode;
 549
 550         /*
 551          * Unmount everything except for the two filesystems preserved above.
 552          */
 553         vfs_unmountall();
 554
 555         /*
 556          * Add /dev back; vfs_mountroot() will move it into its new place.
 557          */
 558         mtx_lock(&mountlist_mtx);
 559         TAILQ_INSERT_HEAD(&mountlist, devmp, mnt_list);
 560         mtx_unlock(&mountlist_mtx);
 561         rootdevmp = devmp;
 562         vfs_rel(rootdevmp);
 563
 564         /*
 565          * Mount the new rootfs.
 566          */
 567         vfs_mountroot();
 568
 569         /*
 570          * Update all references to the old rootvnode.
 571          */
 572         mountcheckdirs(oldrootvnode, rootvnode);
 573
 574         /*
 575          * Add the temporary filesystem back and unbusy it.
 576          */
 577         mtx_lock(&mountlist_mtx);
 578         TAILQ_INSERT_TAIL(&mountlist, mp, mnt_list);
 579         mtx_unlock(&mountlist_mtx);
 580         vfs_unbusy(mp);
 581
 582         return (0);
 583 }
 584
 585 /*
 586  * If the shutdown was a clean halt, behave accordingly.
 587  */
 588 static void
 589 shutdown_halt(void *junk, int howto)
 590 {
 591
 592         if (howto & RB_HALT) {
 593                 printf("\n");
 594                 printf("The operating system has halted.\n");
 595                 printf("Please press any key to reboot.\n\n");
 596
 597                 wdog_kern_pat(WD_TO_NEVER);
 598
 599                 switch (cngetc()) {
 600                 case -1:                /* No console, just die */
 601                         cpu_halt();
 602                         /* NOTREACHED */
 603                 default:
 604                         break;
 605                 }
 606         }
 607 }
 608
 609 /*
 610  * Check to see if the system paniced, pause and then reboot
 611  * according to the specified delay.
 612  */
 613 static void
 614 shutdown_panic(void *junk, int howto)
 615 {
 616         int loop;
 617
 618         if (howto & RB_DUMP) {
 619                 if (panic_reboot_wait_time != 0) {
 620                         if (panic_reboot_wait_time != -1) {
 621                                 printf("Automatic reboot in %d seconds - "
 622                                        "press a key on the console to abort\n",
 623                                         panic_reboot_wait_time);
 624                                 for (loop = panic_reboot_wait_time * 10;
 625                                      loop > 0; --loop) {
 626                                         DELAY(1000 * 100); /* 1/10th second */
 627                                         /* Did user type a key? */
 628                                         if (cncheckc() != -1)
 629                                                 break;
 630                                 }
 631                                 if (!loop)
 632                                         return;
 633                         }
 634                 } else { /* zero time specified - reboot NOW */
 635                         return;
 636                 }
 637                 printf("--> Press a key on the console to reboot,\n");
 638                 printf("--> or switch off the system now.\n");
 639                 cngetc();
 640         }
 641 }
 642
 643 /*
 644  * Everything done, now reset
 645  */
 646 static void
 647 shutdown_reset(void *junk, int howto)
 648 {
 649
 650         printf("Rebooting...\n");
 651         DELAY(1000000); /* wait 1 sec for printf's to complete and be read */
 652
 653         /*
 654          * Acquiring smp_ipi_mtx here has a double effect:
 655          * - it disables interrupts avoiding CPU0 preemption
 656          *   by fast handlers (thus deadlocking  against other CPUs)
 657          * - it avoids deadlocks against smp_rendezvous() or, more
 658          *   generally, threads busy-waiting, with this spinlock held,
 659          *   and waiting for responses by threads on other CPUs
 660          *   (ie. smp_tlb_shootdown()).
 661          *
 662          * For the !SMP case it just needs to handle the former problem.
 663          */
 664 #ifdef SMP
 665         mtx_lock_spin(&smp_ipi_mtx);
 666 #else
 667         spinlock_enter();
 668 #endif
 669
 670         /* cpu_boot(howto); */ /* doesn't do anything at the moment */
 671         cpu_reset();
 672         /* NOTREACHED */ /* assuming reset worked */
 673 }
 674
 675 #if defined(WITNESS) || defined(INVARIANT_SUPPORT)
 676 static int kassert_warn_only = 0;
 677 #ifdef KDB
 678 static int kassert_do_kdb = 0;
 679 #endif
 680 #ifdef KTR
 681 static int kassert_do_ktr = 0;
 682 #endif
 683 static int kassert_do_log = 1;
 684 static int kassert_log_pps_limit = 4;
 685 static int kassert_log_mute_at = 0;
 686 static int kassert_log_panic_at = 0;
 687 static int kassert_suppress_in_panic = 0;
 688 static int kassert_warnings = 0;
 689
 690 SYSCTL_NODE(_debug, OID_AUTO, kassert, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
 691     "kassert options");
 692
 693 #ifdef KASSERT_PANIC_OPTIONAL
 694 #define KASSERT_RWTUN   CTLFLAG_RWTUN
 695 #else
 696 #define KASSERT_RWTUN   CTLFLAG_RDTUN
 697 #endif
 698
 699 SYSCTL_INT(_debug_kassert, OID_AUTO, warn_only, KASSERT_RWTUN,
 700     &kassert_warn_only, 0,
 701     "KASSERT triggers a panic (0) or just a warning (1)");
 702
 703 #ifdef KDB
 704 SYSCTL_INT(_debug_kassert, OID_AUTO, do_kdb, KASSERT_RWTUN,
 705     &kassert_do_kdb, 0, "KASSERT will enter the debugger");
 706 #endif
 707
 708 #ifdef KTR
 709 SYSCTL_UINT(_debug_kassert, OID_AUTO, do_ktr, KASSERT_RWTUN,
 710     &kassert_do_ktr, 0,
 711     "KASSERT does a KTR, set this to the KTRMASK you want");
 712 #endif
 713
 714 SYSCTL_INT(_debug_kassert, OID_AUTO, do_log, KASSERT_RWTUN,
 715     &kassert_do_log, 0,
 716     "If warn_only is enabled, log (1) or do not log (0) assertion violations");
 717
 718 SYSCTL_INT(_debug_kassert, OID_AUTO, warnings, CTLFLAG_RD | CTLFLAG_STATS,
 719     &kassert_warnings, 0, "number of KASSERTs that have been triggered");
 720
 721 SYSCTL_INT(_debug_kassert, OID_AUTO, log_panic_at, KASSERT_RWTUN,
 722     &kassert_log_panic_at, 0, "max number of KASSERTS before we will panic");
 723
 724 SYSCTL_INT(_debug_kassert, OID_AUTO, log_pps_limit, KASSERT_RWTUN,
 725     &kassert_log_pps_limit, 0, "limit number of log messages per second");
 726
 727 SYSCTL_INT(_debug_kassert, OID_AUTO, log_mute_at, KASSERT_RWTUN,
 728     &kassert_log_mute_at, 0, "max number of KASSERTS to log");
 729
 730 SYSCTL_INT(_debug_kassert, OID_AUTO, suppress_in_panic, KASSERT_RWTUN,
 731     &kassert_suppress_in_panic, 0,
 732     "KASSERTs will be suppressed while handling a panic");
 733 #undef KASSERT_RWTUN
 734
 735 static int kassert_sysctl_kassert(SYSCTL_HANDLER_ARGS);
 736
 737 SYSCTL_PROC(_debug_kassert, OID_AUTO, kassert,
 738     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_NEEDGIANT, NULL, 0,
 739     kassert_sysctl_kassert, "I",
 740     "set to trigger a test kassert");
 741
 742 static int
 743 kassert_sysctl_kassert(SYSCTL_HANDLER_ARGS)
 744 {
 745         int error, i;
 746
 747         error = sysctl_wire_old_buffer(req, sizeof(int));
 748         if (error == 0) {
 749                 i = 0;
 750                 error = sysctl_handle_int(oidp, &i, 0, req);
 751         }
 752         if (error != 0 || req->newptr == NULL)
 753                 return (error);
 754         KASSERT(0, ("kassert_sysctl_kassert triggered kassert %d", i));
 755         return (0);
 756 }
 757
 758 #ifdef KASSERT_PANIC_OPTIONAL
 759 /*
 760  * Called by KASSERT, this decides if we will panic
 761  * or if we will log via printf and/or ktr.
 762  */
 763 void
 764 kassert_panic(const char *fmt, ...)
 765 {
 766         static char buf[256];
 767         va_list ap;
 768
 769         va_start(ap, fmt);
 770         (void)vsnprintf(buf, sizeof(buf), fmt, ap);
 771         va_end(ap);
 772
 773         /*
 774          * If we are suppressing secondary panics, log the warning but do not
 775          * re-enter panic/kdb.
 776          */
 777         if (panicstr != NULL && kassert_suppress_in_panic) {
 778                 if (kassert_do_log) {
 779                         printf("KASSERT failed: %s\n", buf);
 780 #ifdef KDB
 781                         if (trace_all_panics && trace_on_panic)
 782                                 kdb_backtrace();
 783 #endif
 784                 }
 785                 return;
 786         }
 787
 788         /*
 789          * panic if we're not just warning, or if we've exceeded
 790          * kassert_log_panic_at warnings.
 791          */
 792         if (!kassert_warn_only ||
 793             (kassert_log_panic_at > 0 &&
 794              kassert_warnings >= kassert_log_panic_at)) {
 795                 va_start(ap, fmt);
 796                 vpanic(fmt, ap);
 797                 /* NORETURN */
 798         }
 799 #ifdef KTR
 800         if (kassert_do_ktr)
 801                 CTR0(ktr_mask, buf);
 802 #endif /* KTR */
 803         /*
 804          * log if we've not yet met the mute limit.
 805          */
 806         if (kassert_do_log &&
 807             (kassert_log_mute_at == 0 ||
 808              kassert_warnings < kassert_log_mute_at)) {
 809                 static  struct timeval lasterr;
 810                 static  int curerr;
 811
 812                 if (ppsratecheck(&lasterr, &curerr, kassert_log_pps_limit)) {
 813                         printf("KASSERT failed: %s\n", buf);
 814                         kdb_backtrace();
 815                 }
 816         }
 817 #ifdef KDB
 818         if (kassert_do_kdb) {
 819                 kdb_enter(KDB_WHY_KASSERT, buf);
 820         }
 821 #endif
 822         atomic_add_int(&kassert_warnings, 1);
 823 }
 824 #endif /* KASSERT_PANIC_OPTIONAL */
 825 #endif
 826
 827 /*
 828  * Panic is called on unresolvable fatal errors.  It prints "panic: mesg",
 829  * and then reboots.  If we are called twice, then we avoid trying to sync
 830  * the disks as this often leads to recursive panics.
 831  */
 832 void
 833 panic(const char *fmt, ...)
 834 {
 835         va_list ap;
 836
 837         va_start(ap, fmt);
 838         vpanic(fmt, ap);
 839 }
 840
 841 void
 842 vpanic(const char *fmt, va_list ap)
 843 {
 844 #ifdef SMP
 845         cpuset_t other_cpus;
 846 #endif
 847         struct thread *td = curthread;
 848         int bootopt, newpanic;
 849         static char buf[256];
 850
 851         spinlock_enter();
 852
 853 #ifdef SMP
 854         /*
 855          * stop_cpus_hard(other_cpus) should prevent multiple CPUs from
 856          * concurrently entering panic.  Only the winner will proceed
 857          * further.
 858          */
 859         if (panicstr == NULL && !kdb_active) {
 860                 other_cpus = all_cpus;
 861                 CPU_CLR(PCPU_GET(cpuid), &other_cpus);
 862                 stop_cpus_hard(other_cpus);
 863         }
 864 #endif
 865
 866         /*
 867          * Ensure that the scheduler is stopped while panicking, even if panic
 868          * has been entered from kdb.
 869          */
 870         td->td_stopsched = 1;
 871
 872         bootopt = RB_AUTOBOOT;
 873         newpanic = 0;
 874         if (panicstr)
 875                 bootopt |= RB_NOSYNC;
 876         else {
 877                 bootopt |= RB_DUMP;
 878                 panicstr = fmt;
 879                 panicked = true;
 880                 newpanic = 1;
 881         }
 882
 883         if (newpanic) {
 884                 (void)vsnprintf(buf, sizeof(buf), fmt, ap);
 885                 panicstr = buf;
 886                 cngrab();
 887                 printf("panic: %s\n", buf);
 888         } else {
 889                 printf("panic: ");
 890                 vprintf(fmt, ap);
 891                 printf("\n");
 892         }
 893 #ifdef SMP
 894         printf("cpuid = %d\n", PCPU_GET(cpuid));
 895 #endif
 896         printf("time = %jd\n", (intmax_t )time_second);
 897 #ifdef KDB
 898         if ((newpanic || trace_all_panics) && trace_on_panic)
 899                 kdb_backtrace();
 900         if (debugger_on_panic)
 901                 kdb_enter(KDB_WHY_PANIC, "panic");
 902 #endif
 903         /*thread_lock(td); */
 904         td->td_flags |= TDF_INPANIC;
 905         /* thread_unlock(td); */
 906         if (!sync_on_panic)
 907                 bootopt |= RB_NOSYNC;
 908         if (poweroff_on_panic)
 909                 bootopt |= RB_POWEROFF;
 910         if (powercycle_on_panic)
 911                 bootopt |= RB_POWERCYCLE;
 912         kern_reboot(bootopt);
 913 }
 914
 915 /*
 916  * Support for poweroff delay.
 917  *
 918  * Please note that setting this delay too short might power off your machine
 919  * before the write cache on your hard disk has been flushed, leading to
 920  * soft-updates inconsistencies.
 921  */
 922 #ifndef POWEROFF_DELAY
 923 # define POWEROFF_DELAY 5000
 924 #endif
 925 static int poweroff_delay = POWEROFF_DELAY;
 926
 927 SYSCTL_INT(_kern_shutdown, OID_AUTO, poweroff_delay, CTLFLAG_RW,
 928     &poweroff_delay, 0, "Delay before poweroff to write disk caches (msec)");
 929
 930 static void
 931 poweroff_wait(void *junk, int howto)
 932 {
 933
 934         if ((howto & (RB_POWEROFF | RB_POWERCYCLE)) == 0 || poweroff_delay <= 0)
 935                 return;
 936         DELAY(poweroff_delay * 1000);
 937 }
 938
 939 /*
 940  * Some system processes (e.g. syncer) need to be stopped at appropriate
 941  * points in their main loops prior to a system shutdown, so that they
 942  * won't interfere with the shutdown process (e.g. by holding a disk buf
 943  * to cause sync to fail).  For each of these system processes, register
 944  * shutdown_kproc() as a handler for one of shutdown events.
 945  */
 946 static int kproc_shutdown_wait = 60;
 947 SYSCTL_INT(_kern_shutdown, OID_AUTO, kproc_shutdown_wait, CTLFLAG_RW,
 948     &kproc_shutdown_wait, 0, "Max wait time (sec) to stop for each process");
 949
 950 void
 951 kproc_shutdown(void *arg, int howto)
 952 {
 953         struct proc *p;
 954         int error;
 955
 956         if (panicstr)
 957                 return;
 958
 959         p = (struct proc *)arg;
 960         printf("Waiting (max %d seconds) for system process `%s' to stop... ",
 961             kproc_shutdown_wait, p->p_comm);
 962         error = kproc_suspend(p, kproc_shutdown_wait * hz);
 963
 964         if (error == EWOULDBLOCK)
 965                 printf("timed out\n");
 966         else
 967                 printf("done\n");
 968 }
 969
 970 void
 971 kthread_shutdown(void *arg, int howto)
 972 {
 973         struct thread *td;
 974         int error;
 975
 976         if (panicstr)
 977                 return;
 978
 979         td = (struct thread *)arg;
 980         printf("Waiting (max %d seconds) for system thread `%s' to stop... ",
 981             kproc_shutdown_wait, td->td_name);
 982         error = kthread_suspend(td, kproc_shutdown_wait * hz);
 983
 984         if (error == EWOULDBLOCK)
 985                 printf("timed out\n");
 986         else
 987                 printf("done\n");
 988 }
 989
 990 static int
 991 dumpdevname_sysctl_handler(SYSCTL_HANDLER_ARGS)
 992 {
 993         char buf[256];
 994         struct dumperinfo *di;
 995         struct sbuf sb;
 996         int error;
 997
 998         error = sysctl_wire_old_buffer(req, 0);
 999         if (error != 0)
1000                 return (error);
1001
1002         sbuf_new_for_sysctl(&sb, buf, sizeof(buf), req);
1003
1004         mtx_lock(&dumpconf_list_lk);
1005         TAILQ_FOREACH(di, &dumper_configs, di_next) {
1006                 if (di != TAILQ_FIRST(&dumper_configs))
1007                         sbuf_putc(&sb, ',');
1008                 sbuf_cat(&sb, di->di_devname);
1009         }
1010         mtx_unlock(&dumpconf_list_lk);
1011
1012         error = sbuf_finish(&sb);
1013         sbuf_delete(&sb);
1014         return (error);
1015 }
1016 SYSCTL_PROC(_kern_shutdown, OID_AUTO, dumpdevname,
1017     CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT, &dumper_configs, 0,
1018     dumpdevname_sysctl_handler, "A",
1019     "Device(s) for kernel dumps");
1020
1021 static int      _dump_append(struct dumperinfo *di, void *virtual,
1022                     vm_offset_t physical, size_t length);
1023
1024 #ifdef EKCD
1025 static struct kerneldumpcrypto *
1026 kerneldumpcrypto_create(size_t blocksize, uint8_t encryption,
1027     const uint8_t *key, uint32_t encryptedkeysize, const uint8_t *encryptedkey)
1028 {
1029         struct kerneldumpcrypto *kdc;
1030         struct kerneldumpkey *kdk;
1031         uint32_t dumpkeysize;
1032
1033         dumpkeysize = roundup2(sizeof(*kdk) + encryptedkeysize, blocksize);
1034         kdc = malloc(sizeof(*kdc) + dumpkeysize, M_EKCD, M_WAITOK | M_ZERO);
1035
1036         arc4rand(kdc->kdc_iv, sizeof(kdc->kdc_iv), 0);
1037
1038         kdc->kdc_encryption = encryption;
1039         switch (kdc->kdc_encryption) {
1040         case KERNELDUMP_ENC_AES_256_CBC:
1041                 if (rijndael_makeKey(&kdc->kdc_ki, DIR_ENCRYPT, 256, key) <= 0)
1042                         goto failed;
1043                 break;
1044         case KERNELDUMP_ENC_CHACHA20:
1045                 chacha_keysetup(&kdc->kdc_chacha, key, 256);
1046                 break;
1047         default:
1048                 goto failed;
1049         }
1050
1051         kdc->kdc_dumpkeysize = dumpkeysize;
1052         kdk = kdc->kdc_dumpkey;
1053         kdk->kdk_encryption = kdc->kdc_encryption;
1054         memcpy(kdk->kdk_iv, kdc->kdc_iv, sizeof(kdk->kdk_iv));
1055         kdk->kdk_encryptedkeysize = htod32(encryptedkeysize);
1056         memcpy(kdk->kdk_encryptedkey, encryptedkey, encryptedkeysize);
1057
1058         return (kdc);
1059 failed:
1060         explicit_bzero(kdc, sizeof(*kdc) + dumpkeysize);
1061         free(kdc, M_EKCD);
1062         return (NULL);
1063 }
1064
1065 static int
1066 kerneldumpcrypto_init(struct kerneldumpcrypto *kdc)
1067 {
1068         uint8_t hash[SHA256_DIGEST_LENGTH];
1069         SHA256_CTX ctx;
1070         struct kerneldumpkey *kdk;
1071         int error;
1072
1073         error = 0;
1074
1075         if (kdc == NULL)
1076                 return (0);
1077
1078         /*
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.
1081          */
1082         SHA256_Init(&ctx);
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));
1086
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) {
1091                         error = EINVAL;
1092                         goto out;
1093                 }
1094                 break;
1095         case KERNELDUMP_ENC_CHACHA20:
1096                 chacha_ivsetup(&kdc->kdc_chacha, kdc->kdc_iv, NULL);
1097                 break;
1098         default:
1099                 error = EINVAL;
1100                 goto out;
1101         }
1102
1103         kdk = kdc->kdc_dumpkey;
1104         memcpy(kdk->kdk_iv, kdc->kdc_iv, sizeof(kdk->kdk_iv));
1105 out:
1106         explicit_bzero(hash, sizeof(hash));
1107         return (error);
1108 }
1109
1110 static uint32_t
1111 kerneldumpcrypto_dumpkeysize(const struct kerneldumpcrypto *kdc)
1112 {
1113
1114         if (kdc == NULL)
1115                 return (0);
1116         return (kdc->kdc_dumpkeysize);
1117 }
1118 #endif /* EKCD */
1119
1120 static struct kerneldumpcomp *
1121 kerneldumpcomp_create(struct dumperinfo *di, uint8_t compression)
1122 {
1123         struct kerneldumpcomp *kdcomp;
1124         int format;
1125
1126         switch (compression) {
1127         case KERNELDUMP_COMP_GZIP:
1128                 format = COMPRESS_GZIP;
1129                 break;
1130         case KERNELDUMP_COMP_ZSTD:
1131                 format = COMPRESS_ZSTD;
1132                 break;
1133         default:
1134                 return (NULL);
1135         }
1136
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);
1143                 return (NULL);
1144         }
1145         kdcomp->kdc_buf = malloc(di->maxiosize, M_DUMPER, M_WAITOK | M_NODUMP);
1146         return (kdcomp);
1147 }
1148
1149 static void
1150 kerneldumpcomp_destroy(struct dumperinfo *di)
1151 {
1152         struct kerneldumpcomp *kdcomp;
1153
1154         kdcomp = di->kdcomp;
1155         if (kdcomp == NULL)
1156                 return;
1157         compressor_fini(kdcomp->kdc_stream);
1158         explicit_bzero(kdcomp->kdc_buf, di->maxiosize);
1159         free(kdcomp->kdc_buf, M_DUMPER);
1160         free(kdcomp, M_DUMPER);
1161 }
1162
1163 /*
1164  * Must not be present on global list.
1165  */
1166 static void
1167 free_single_dumper(struct dumperinfo *di)
1168 {
1169
1170         if (di == NULL)
1171                 return;
1172
1173         if (di->blockbuf != NULL) {
1174                 explicit_bzero(di->blockbuf, di->blocksize);
1175                 free(di->blockbuf, M_DUMPER);
1176         }
1177
1178         kerneldumpcomp_destroy(di);
1179
1180 #ifdef EKCD
1181         if (di->kdcrypto != NULL) {
1182                 explicit_bzero(di->kdcrypto, sizeof(*di->kdcrypto) +
1183                     di->kdcrypto->kdc_dumpkeysize);
1184                 free(di->kdcrypto, M_EKCD);
1185         }
1186 #endif
1187
1188         explicit_bzero(di, sizeof(*di));
1189         free(di, M_DUMPER);
1190 }
1191
1192 /* Registration of dumpers */
1193 int
1194 dumper_insert(const struct dumperinfo *di_template, const char *devname,
1195     const struct diocskerneldump_arg *kda)
1196 {
1197         struct dumperinfo *newdi, *listdi;
1198         bool inserted;
1199         uint8_t index;
1200         int error;
1201
1202         index = kda->kda_index;
1203         MPASS(index != KDA_REMOVE && index != KDA_REMOVE_DEV &&
1204             index != KDA_REMOVE_ALL);
1205
1206         error = priv_check(curthread, PRIV_SETDUMPER);
1207         if (error != 0)
1208                 return (error);
1209
1210         newdi = malloc(sizeof(*newdi) + strlen(devname) + 1, M_DUMPER, M_WAITOK
1211             | M_ZERO);
1212         memcpy(newdi, di_template, sizeof(*newdi));
1213         newdi->blockbuf = NULL;
1214         newdi->kdcrypto = NULL;
1215         newdi->kdcomp = NULL;
1216         strcpy(newdi->di_devname, devname);
1217
1218         if (kda->kda_encryption != KERNELDUMP_ENC_NONE) {
1219 #ifdef EKCD
1220                 newdi->kdcrypto = kerneldumpcrypto_create(di_template->blocksize,
1221                     kda->kda_encryption, kda->kda_key,
1222                     kda->kda_encryptedkeysize, kda->kda_encryptedkey);
1223                 if (newdi->kdcrypto == NULL) {
1224                         error = EINVAL;
1225                         goto cleanup;
1226                 }
1227 #else
1228                 error = EOPNOTSUPP;
1229                 goto cleanup;
1230 #endif
1231         }
1232         if (kda->kda_compression != KERNELDUMP_COMP_NONE) {
1233                 /*
1234                  * We can't support simultaneous unpadded block cipher
1235                  * encryption and compression because there is no guarantee the
1236                  * length of the compressed result is exactly a multiple of the
1237                  * cipher block size.
1238                  */
1239                 if (kda->kda_encryption == KERNELDUMP_ENC_AES_256_CBC) {
1240                         error = EOPNOTSUPP;
1241                         goto cleanup;
1242                 }
1243                 newdi->kdcomp = kerneldumpcomp_create(newdi,
1244                     kda->kda_compression);
1245                 if (newdi->kdcomp == NULL) {
1246                         error = EINVAL;
1247                         goto cleanup;
1248                 }
1249         }
1250
1251         newdi->blockbuf = malloc(newdi->blocksize, M_DUMPER, M_WAITOK | M_ZERO);
1252
1253         /* Add the new configuration to the queue */
1254         mtx_lock(&dumpconf_list_lk);
1255         inserted = false;
1256         TAILQ_FOREACH(listdi, &dumper_configs, di_next) {
1257                 if (index == 0) {
1258                         TAILQ_INSERT_BEFORE(listdi, newdi, di_next);
1259                         inserted = true;
1260                         break;
1261                 }
1262                 index--;
1263         }
1264         if (!inserted)
1265                 TAILQ_INSERT_TAIL(&dumper_configs, newdi, di_next);
1266         mtx_unlock(&dumpconf_list_lk);
1267
1268         return (0);
1269
1270 cleanup:
1271         free_single_dumper(newdi);
1272         return (error);
1273 }
1274
1275 #ifdef DDB
1276 void
1277 dumper_ddb_insert(struct dumperinfo *newdi)
1278 {
1279         TAILQ_INSERT_HEAD(&dumper_configs, newdi, di_next);
1280 }
1281
1282 void
1283 dumper_ddb_remove(struct dumperinfo *di)
1284 {
1285         TAILQ_REMOVE(&dumper_configs, di, di_next);
1286 }
1287 #endif
1288
1289 static bool
1290 dumper_config_match(const struct dumperinfo *di, const char *devname,
1291     const struct diocskerneldump_arg *kda)
1292 {
1293         if (kda->kda_index == KDA_REMOVE_ALL)
1294                 return (true);
1295
1296         if (strcmp(di->di_devname, devname) != 0)
1297                 return (false);
1298
1299         /*
1300          * Allow wildcard removal of configs matching a device on g_dev_orphan.
1301          */
1302         if (kda->kda_index == KDA_REMOVE_DEV)
1303                 return (true);
1304
1305         if (di->kdcomp != NULL) {
1306                 if (di->kdcomp->kdc_format != kda->kda_compression)
1307                         return (false);
1308         } else if (kda->kda_compression != KERNELDUMP_COMP_NONE)
1309                 return (false);
1310 #ifdef EKCD
1311         if (di->kdcrypto != NULL) {
1312                 if (di->kdcrypto->kdc_encryption != kda->kda_encryption)
1313                         return (false);
1314                 /*
1315                  * Do we care to verify keys match to delete?  It seems weird
1316                  * to expect multiple fallback dump configurations on the same
1317                  * device that only differ in crypto key.
1318                  */
1319         } else
1320 #endif
1321                 if (kda->kda_encryption != KERNELDUMP_ENC_NONE)
1322                         return (false);
1323
1324         return (true);
1325 }
1326
1327 int
1328 dumper_remove(const char *devname, const struct diocskerneldump_arg *kda)
1329 {
1330         struct dumperinfo *di, *sdi;
1331         bool found;
1332         int error;
1333
1334         error = priv_check(curthread, PRIV_SETDUMPER);
1335         if (error != 0)
1336                 return (error);
1337
1338         /*
1339          * Try to find a matching configuration, and kill it.
1340          *
1341          * NULL 'kda' indicates remove any configuration matching 'devname',
1342          * which may remove multiple configurations in atypical configurations.
1343          */
1344         found = false;
1345         mtx_lock(&dumpconf_list_lk);
1346         TAILQ_FOREACH_SAFE(di, &dumper_configs, di_next, sdi) {
1347                 if (dumper_config_match(di, devname, kda)) {
1348                         found = true;
1349                         TAILQ_REMOVE(&dumper_configs, di, di_next);
1350                         free_single_dumper(di);
1351                 }
1352         }
1353         mtx_unlock(&dumpconf_list_lk);
1354
1355         /* Only produce ENOENT if a more targeted match didn't match. */
1356         if (!found && kda->kda_index == KDA_REMOVE)
1357                 return (ENOENT);
1358         return (0);
1359 }
1360
1361 static int
1362 dump_check_bounds(struct dumperinfo *di, off_t offset, size_t length)
1363 {
1364
1365         if (di->mediasize > 0 && length != 0 && (offset < di->mediaoffset ||
1366             offset - di->mediaoffset + length > di->mediasize)) {
1367                 if (di->kdcomp != NULL && offset >= di->mediaoffset) {
1368                         printf(
1369                     "Compressed dump failed to fit in device boundaries.\n");
1370                         return (E2BIG);
1371                 }
1372
1373                 printf("Attempt to write outside dump device boundaries.\n"
1374             "offset(%jd), mediaoffset(%jd), length(%ju), mediasize(%jd).\n",
1375                     (intmax_t)offset, (intmax_t)di->mediaoffset,
1376                     (uintmax_t)length, (intmax_t)di->mediasize);
1377                 return (ENOSPC);
1378         }
1379         if (length % di->blocksize != 0) {
1380                 printf("Attempt to write partial block of length %ju.\n",
1381                     (uintmax_t)length);
1382                 return (EINVAL);
1383         }
1384         if (offset % di->blocksize != 0) {
1385                 printf("Attempt to write at unaligned offset %jd.\n",
1386                     (intmax_t)offset);
1387                 return (EINVAL);
1388         }
1389
1390         return (0);
1391 }
1392
1393 #ifdef EKCD
1394 static int
1395 dump_encrypt(struct kerneldumpcrypto *kdc, uint8_t *buf, size_t size)
1396 {
1397
1398         switch (kdc->kdc_encryption) {
1399         case KERNELDUMP_ENC_AES_256_CBC:
1400                 if (rijndael_blockEncrypt(&kdc->kdc_ci, &kdc->kdc_ki, buf,
1401                     8 * size, buf) <= 0) {
1402                         return (EIO);
1403                 }
1404                 if (rijndael_cipherInit(&kdc->kdc_ci, MODE_CBC,
1405                     buf + size - 16 /* IV size for AES-256-CBC */) <= 0) {
1406                         return (EIO);
1407                 }
1408                 break;
1409         case KERNELDUMP_ENC_CHACHA20:
1410                 chacha_encrypt_bytes(&kdc->kdc_chacha, buf, buf, size);
1411                 break;
1412         default:
1413                 return (EINVAL);
1414         }
1415
1416         return (0);
1417 }
1418
1419 /* Encrypt data and call dumper. */
1420 static int
1421 dump_encrypted_write(struct dumperinfo *di, void *virtual,
1422     vm_offset_t physical, off_t offset, size_t length)
1423 {
1424         static uint8_t buf[KERNELDUMP_BUFFER_SIZE];
1425         struct kerneldumpcrypto *kdc;
1426         int error;
1427         size_t nbytes;
1428
1429         kdc = di->kdcrypto;
1430
1431         while (length > 0) {
1432                 nbytes = MIN(length, sizeof(buf));
1433                 bcopy(virtual, buf, nbytes);
1434
1435                 if (dump_encrypt(kdc, buf, nbytes) != 0)
1436                         return (EIO);
1437
1438                 error = dump_write(di, buf, physical, offset, nbytes);
1439                 if (error != 0)
1440                         return (error);
1441
1442                 offset += nbytes;
1443                 virtual = (void *)((uint8_t *)virtual + nbytes);
1444                 length -= nbytes;
1445         }
1446
1447         return (0);
1448 }
1449 #endif /* EKCD */
1450
1451 static int
1452 kerneldumpcomp_write_cb(void *base, size_t length, off_t offset, void *arg)
1453 {
1454         struct dumperinfo *di;
1455         size_t resid, rlength;
1456         int error;
1457
1458         di = arg;
1459
1460         if (length % di->blocksize != 0) {
1461                 /*
1462                  * This must be the final write after flushing the compression
1463                  * stream. Write as many full blocks as possible and stash the
1464                  * residual data in the dumper's block buffer. It will be
1465                  * padded and written in dump_finish().
1466                  */
1467                 rlength = rounddown(length, di->blocksize);
1468                 if (rlength != 0) {
1469                         error = _dump_append(di, base, 0, rlength);
1470                         if (error != 0)
1471                                 return (error);
1472                 }
1473                 resid = length - rlength;
1474                 memmove(di->blockbuf, (uint8_t *)base + rlength, resid);
1475                 di->kdcomp->kdc_resid = resid;
1476                 return (EAGAIN);
1477         }
1478         return (_dump_append(di, base, 0, length));
1479 }
1480
1481 /*
1482  * Write kernel dump headers at the beginning and end of the dump extent.
1483  * Write the kernel dump encryption key after the leading header if we were
1484  * configured to do so.
1485  */
1486 static int
1487 dump_write_headers(struct dumperinfo *di, struct kerneldumpheader *kdh)
1488 {
1489 #ifdef EKCD
1490         struct kerneldumpcrypto *kdc;
1491 #endif
1492         void *buf, *key;
1493         size_t hdrsz;
1494         uint64_t extent;
1495         uint32_t keysize;
1496         int error;
1497
1498         hdrsz = sizeof(*kdh);
1499         if (hdrsz > di->blocksize)
1500                 return (ENOMEM);
1501
1502 #ifdef EKCD
1503         kdc = di->kdcrypto;
1504         key = kdc->kdc_dumpkey;
1505         keysize = kerneldumpcrypto_dumpkeysize(kdc);
1506 #else
1507         key = NULL;
1508         keysize = 0;
1509 #endif
1510
1511         /*
1512          * If the dump device has special handling for headers, let it take care
1513          * of writing them out.
1514          */
1515         if (di->dumper_hdr != NULL)
1516                 return (di->dumper_hdr(di, kdh, key, keysize));
1517
1518         if (hdrsz == di->blocksize)
1519                 buf = kdh;
1520         else {
1521                 buf = di->blockbuf;
1522                 memset(buf, 0, di->blocksize);
1523                 memcpy(buf, kdh, hdrsz);
1524         }
1525
1526         extent = dtoh64(kdh->dumpextent);
1527 #ifdef EKCD
1528         if (kdc != NULL) {
1529                 error = dump_write(di, kdc->kdc_dumpkey, 0,
1530                     di->mediaoffset + di->mediasize - di->blocksize - extent -
1531                     keysize, keysize);
1532                 if (error != 0)
1533                         return (error);
1534         }
1535 #endif
1536
1537         error = dump_write(di, buf, 0,
1538             di->mediaoffset + di->mediasize - 2 * di->blocksize - extent -
1539             keysize, di->blocksize);
1540         if (error == 0)
1541                 error = dump_write(di, buf, 0, di->mediaoffset + di->mediasize -
1542                     di->blocksize, di->blocksize);
1543         return (error);
1544 }
1545
1546 /*
1547  * Don't touch the first SIZEOF_METADATA bytes on the dump device.  This is to
1548  * protect us from metadata and metadata from us.
1549  */
1550 #define SIZEOF_METADATA         (64 * 1024)
1551
1552 /*
1553  * Do some preliminary setup for a kernel dump: initialize state for encryption,
1554  * if requested, and make sure that we have enough space on the dump device.
1555  *
1556  * We set things up so that the dump ends before the last sector of the dump
1557  * device, at which the trailing header is written.
1558  *
1559  *     +-----------+------+-----+----------------------------+------+
1560  *     |           | lhdr | key |    ... kernel dump ...     | thdr |
1561  *     +-----------+------+-----+----------------------------+------+
1562  *                   1 blk  opt <------- dump extent --------> 1 blk
1563  *
1564  * Dumps written using dump_append() start at the beginning of the extent.
1565  * Uncompressed dumps will use the entire extent, but compressed dumps typically
1566  * will not. The true length of the dump is recorded in the leading and trailing
1567  * headers once the dump has been completed.
1568  *
1569  * The dump device may provide a callback, in which case it will initialize
1570  * dumpoff and take care of laying out the headers.
1571  */
1572 int
1573 dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh)
1574 {
1575         uint64_t dumpextent, span;
1576         uint32_t keysize;
1577         int error;
1578
1579 #ifdef EKCD
1580         error = kerneldumpcrypto_init(di->kdcrypto);
1581         if (error != 0)
1582                 return (error);
1583         keysize = kerneldumpcrypto_dumpkeysize(di->kdcrypto);
1584 #else
1585         error = 0;
1586         keysize = 0;
1587 #endif
1588
1589         if (di->dumper_start != NULL) {
1590                 error = di->dumper_start(di);
1591         } else {
1592                 dumpextent = dtoh64(kdh->dumpextent);
1593                 span = SIZEOF_METADATA + dumpextent + 2 * di->blocksize +
1594                     keysize;
1595                 if (di->mediasize < span) {
1596                         if (di->kdcomp == NULL)
1597                                 return (E2BIG);
1598
1599                         /*
1600                          * We don't yet know how much space the compressed dump
1601                          * will occupy, so try to use the whole swap partition
1602                          * (minus the first 64KB) in the hope that the
1603                          * compressed dump will fit. If that doesn't turn out to
1604                          * be enough, the bounds checking in dump_write()
1605                          * will catch us and cause the dump to fail.
1606                          */
1607                         dumpextent = di->mediasize - span + dumpextent;
1608                         kdh->dumpextent = htod64(dumpextent);
1609                 }
1610
1611                 /*
1612                  * The offset at which to begin writing the dump.
1613                  */
1614                 di->dumpoff = di->mediaoffset + di->mediasize - di->blocksize -
1615                     dumpextent;
1616         }
1617         di->origdumpoff = di->dumpoff;
1618         return (error);
1619 }
1620
1621 static int
1622 _dump_append(struct dumperinfo *di, void *virtual, vm_offset_t physical,
1623     size_t length)
1624 {
1625         int error;
1626
1627 #ifdef EKCD
1628         if (di->kdcrypto != NULL)
1629                 error = dump_encrypted_write(di, virtual, physical, di->dumpoff,
1630                     length);
1631         else
1632 #endif
1633                 error = dump_write(di, virtual, physical, di->dumpoff, length);
1634         if (error == 0)
1635                 di->dumpoff += length;
1636         return (error);
1637 }
1638
1639 /*
1640  * Write to the dump device starting at dumpoff. When compression is enabled,
1641  * writes to the device will be performed using a callback that gets invoked
1642  * when the compression stream's output buffer is full.
1643  */
1644 int
1645 dump_append(struct dumperinfo *di, void *virtual, vm_offset_t physical,
1646     size_t length)
1647 {
1648         void *buf;
1649
1650         if (di->kdcomp != NULL) {
1651                 /* Bounce through a buffer to avoid CRC errors. */
1652                 if (length > di->maxiosize)
1653                         return (EINVAL);
1654                 buf = di->kdcomp->kdc_buf;
1655                 memmove(buf, virtual, length);
1656                 return (compressor_write(di->kdcomp->kdc_stream, buf, length));
1657         }
1658         return (_dump_append(di, virtual, physical, length));
1659 }
1660
1661 /*
1662  * Write to the dump device at the specified offset.
1663  */
1664 int
1665 dump_write(struct dumperinfo *di, void *virtual, vm_offset_t physical,
1666     off_t offset, size_t length)
1667 {
1668         int error;
1669
1670         error = dump_check_bounds(di, offset, length);
1671         if (error != 0)
1672                 return (error);
1673         return (di->dumper(di->priv, virtual, physical, offset, length));
1674 }
1675
1676 /*
1677  * Perform kernel dump finalization: flush the compression stream, if necessary,
1678  * write the leading and trailing kernel dump headers now that we know the true
1679  * length of the dump, and optionally write the encryption key following the
1680  * leading header.
1681  */
1682 int
1683 dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh)
1684 {
1685         int error;
1686
1687         if (di->kdcomp != NULL) {
1688                 error = compressor_flush(di->kdcomp->kdc_stream);
1689                 if (error == EAGAIN) {
1690                         /* We have residual data in di->blockbuf. */
1691                         error = dump_write(di, di->blockbuf, 0, di->dumpoff,
1692                             di->blocksize);
1693                         di->dumpoff += di->kdcomp->kdc_resid;
1694                         di->kdcomp->kdc_resid = 0;
1695                 }
1696                 if (error != 0)
1697                         return (error);
1698
1699                 /*
1700                  * We now know the size of the compressed dump, so update the
1701                  * header accordingly and recompute parity.
1702                  */
1703                 kdh->dumplength = htod64(di->dumpoff - di->origdumpoff);
1704                 kdh->parity = 0;
1705                 kdh->parity = kerneldump_parity(kdh);
1706
1707                 compressor_reset(di->kdcomp->kdc_stream);
1708         }
1709
1710         error = dump_write_headers(di, kdh);
1711         if (error != 0)
1712                 return (error);
1713
1714         (void)dump_write(di, NULL, 0, 0, 0);
1715         return (0);
1716 }
1717
1718 void
1719 dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh,
1720     const char *magic, uint32_t archver, uint64_t dumplen)
1721 {
1722         size_t dstsize;
1723
1724         bzero(kdh, sizeof(*kdh));
1725         strlcpy(kdh->magic, magic, sizeof(kdh->magic));
1726         strlcpy(kdh->architecture, MACHINE_ARCH, sizeof(kdh->architecture));
1727         kdh->version = htod32(KERNELDUMPVERSION);
1728         kdh->architectureversion = htod32(archver);
1729         kdh->dumplength = htod64(dumplen);
1730         kdh->dumpextent = kdh->dumplength;
1731         kdh->dumptime = htod64(time_second);
1732 #ifdef EKCD
1733         kdh->dumpkeysize = htod32(kerneldumpcrypto_dumpkeysize(di->kdcrypto));
1734 #else
1735         kdh->dumpkeysize = 0;
1736 #endif
1737         kdh->blocksize = htod32(di->blocksize);
1738         strlcpy(kdh->hostname, prison0.pr_hostname, sizeof(kdh->hostname));
1739         dstsize = sizeof(kdh->versionstring);
1740         if (strlcpy(kdh->versionstring, version, dstsize) >= dstsize)
1741                 kdh->versionstring[dstsize - 2] = '\n';
1742         if (panicstr != NULL)
1743                 strlcpy(kdh->panicstring, panicstr, sizeof(kdh->panicstring));
1744         if (di->kdcomp != NULL)
1745                 kdh->compression = di->kdcomp->kdc_format;
1746         kdh->parity = kerneldump_parity(kdh);
1747 }
1748
1749 #ifdef DDB
1750 DB_SHOW_COMMAND(panic, db_show_panic)
1751 {
1752
1753         if (panicstr == NULL)
1754                 db_printf("panicstr not set\n");
1755         else
1756                 db_printf("panic: %s\n", panicstr);
1757 }
1758 #endif