kernel/reboot.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  linux/kernel/reboot.c
   4  *
   5  *  Copyright (C) 2013  Linus Torvalds
   6  */
   7
   8 #define pr_fmt(fmt)     "reboot: " fmt
   9
  10 #include <linux/ctype.h>
  11 #include <linux/export.h>
  12 #include <linux/kexec.h>
  13 #include <linux/kmod.h>
  14 #include <linux/kmsg_dump.h>
  15 #include <linux/reboot.h>
  16 #include <linux/suspend.h>
  17 #include <linux/syscalls.h>
  18 #include <linux/syscore_ops.h>
  19 #include <linux/uaccess.h>
  20
  21 /*
  22  * this indicates whether you can reboot with ctrl-alt-del: the default is yes
  23  */
  24
  25 int C_A_D = 1;
  26 struct pid *cad_pid;
  27 EXPORT_SYMBOL(cad_pid);
  28
  29 #if defined(CONFIG_ARM)
  30 #define DEFAULT_REBOOT_MODE             = REBOOT_HARD
  31 #else
  32 #define DEFAULT_REBOOT_MODE
  33 #endif
  34 enum reboot_mode reboot_mode DEFAULT_REBOOT_MODE;
  35 enum reboot_mode panic_reboot_mode = REBOOT_UNDEFINED;
  36
  37 /*
  38  * This variable is used privately to keep track of whether or not
  39  * reboot_type is still set to its default value (i.e., reboot= hasn't
  40  * been set on the command line).  This is needed so that we can
  41  * suppress DMI scanning for reboot quirks.  Without it, it's
  42  * impossible to override a faulty reboot quirk without recompiling.
  43  */
  44 int reboot_default = 1;
  45 int reboot_cpu;
  46 enum reboot_type reboot_type = BOOT_ACPI;
  47 int reboot_force;
  48
  49 /*
  50  * If set, this is used for preparing the system to power off.
  51  */
  52
  53 void (*pm_power_off_prepare)(void);
  54 EXPORT_SYMBOL_GPL(pm_power_off_prepare);
  55
  56 /**
  57  *      emergency_restart - reboot the system
  58  *
  59  *      Without shutting down any hardware or taking any locks
  60  *      reboot the system.  This is called when we know we are in
  61  *      trouble so this is our best effort to reboot.  This is
  62  *      safe to call in interrupt context.
  63  */
  64 void emergency_restart(void)
  65 {
  66         kmsg_dump(KMSG_DUMP_EMERG);
  67         system_state = SYSTEM_RESTART;
  68         machine_emergency_restart();
  69 }
  70 EXPORT_SYMBOL_GPL(emergency_restart);
  71
  72 void kernel_restart_prepare(char *cmd)
  73 {
  74         blocking_notifier_call_chain(&reboot_notifier_list, SYS_RESTART, cmd);
  75         system_state = SYSTEM_RESTART;
  76         usermodehelper_disable();
  77         device_shutdown();
  78 }
  79
  80 /**
  81  *      register_reboot_notifier - Register function to be called at reboot time
  82  *      @nb: Info about notifier function to be called
  83  *
  84  *      Registers a function with the list of functions
  85  *      to be called at reboot time.
  86  *
  87  *      Currently always returns zero, as blocking_notifier_chain_register()
  88  *      always returns zero.
  89  */
  90 int register_reboot_notifier(struct notifier_block *nb)
  91 {
  92         return blocking_notifier_chain_register(&reboot_notifier_list, nb);
  93 }
  94 EXPORT_SYMBOL(register_reboot_notifier);
  95
  96 /**
  97  *      unregister_reboot_notifier - Unregister previously registered reboot notifier
  98  *      @nb: Hook to be unregistered
  99  *
 100  *      Unregisters a previously registered reboot
 101  *      notifier function.
 102  *
 103  *      Returns zero on success, or %-ENOENT on failure.
 104  */
 105 int unregister_reboot_notifier(struct notifier_block *nb)
 106 {
 107         return blocking_notifier_chain_unregister(&reboot_notifier_list, nb);
 108 }
 109 EXPORT_SYMBOL(unregister_reboot_notifier);
 110
 111 static void devm_unregister_reboot_notifier(struct device *dev, void *res)
 112 {
 113         WARN_ON(unregister_reboot_notifier(*(struct notifier_block **)res));
 114 }
 115
 116 int devm_register_reboot_notifier(struct device *dev, struct notifier_block *nb)
 117 {
 118         struct notifier_block **rcnb;
 119         int ret;
 120
 121         rcnb = devres_alloc(devm_unregister_reboot_notifier,
 122                             sizeof(*rcnb), GFP_KERNEL);
 123         if (!rcnb)
 124                 return -ENOMEM;
 125
 126         ret = register_reboot_notifier(nb);
 127         if (!ret) {
 128                 *rcnb = nb;
 129                 devres_add(dev, rcnb);
 130         } else {
 131                 devres_free(rcnb);
 132         }
 133
 134         return ret;
 135 }
 136 EXPORT_SYMBOL(devm_register_reboot_notifier);
 137
 138 /*
 139  *      Notifier list for kernel code which wants to be called
 140  *      to restart the system.
 141  */
 142 static ATOMIC_NOTIFIER_HEAD(restart_handler_list);
 143
 144 /**
 145  *      register_restart_handler - Register function to be called to reset
 146  *                                 the system
 147  *      @nb: Info about handler function to be called
 148  *      @nb->priority:  Handler priority. Handlers should follow the
 149  *                      following guidelines for setting priorities.
 150  *                      0:      Restart handler of last resort,
 151  *                              with limited restart capabilities
 152  *                      128:    Default restart handler; use if no other
 153  *                              restart handler is expected to be available,
 154  *                              and/or if restart functionality is
 155  *                              sufficient to restart the entire system
 156  *                      255:    Highest priority restart handler, will
 157  *                              preempt all other restart handlers
 158  *
 159  *      Registers a function with code to be called to restart the
 160  *      system.
 161  *
 162  *      Registered functions will be called from machine_restart as last
 163  *      step of the restart sequence (if the architecture specific
 164  *      machine_restart function calls do_kernel_restart - see below
 165  *      for details).
 166  *      Registered functions are expected to restart the system immediately.
 167  *      If more than one function is registered, the restart handler priority
 168  *      selects which function will be called first.
 169  *
 170  *      Restart handlers are expected to be registered from non-architecture
 171  *      code, typically from drivers. A typical use case would be a system
 172  *      where restart functionality is provided through a watchdog. Multiple
 173  *      restart handlers may exist; for example, one restart handler might
 174  *      restart the entire system, while another only restarts the CPU.
 175  *      In such cases, the restart handler which only restarts part of the
 176  *      hardware is expected to register with low priority to ensure that
 177  *      it only runs if no other means to restart the system is available.
 178  *
 179  *      Currently always returns zero, as atomic_notifier_chain_register()
 180  *      always returns zero.
 181  */
 182 int register_restart_handler(struct notifier_block *nb)
 183 {
 184         return atomic_notifier_chain_register(&restart_handler_list, nb);
 185 }
 186 EXPORT_SYMBOL(register_restart_handler);
 187
 188 /**
 189  *      unregister_restart_handler - Unregister previously registered
 190  *                                   restart handler
 191  *      @nb: Hook to be unregistered
 192  *
 193  *      Unregisters a previously registered restart handler function.
 194  *
 195  *      Returns zero on success, or %-ENOENT on failure.
 196  */
 197 int unregister_restart_handler(struct notifier_block *nb)
 198 {
 199         return atomic_notifier_chain_unregister(&restart_handler_list, nb);
 200 }
 201 EXPORT_SYMBOL(unregister_restart_handler);
 202
 203 /**
 204  *      do_kernel_restart - Execute kernel restart handler call chain
 205  *
 206  *      Calls functions registered with register_restart_handler.
 207  *
 208  *      Expected to be called from machine_restart as last step of the restart
 209  *      sequence.
 210  *
 211  *      Restarts the system immediately if a restart handler function has been
 212  *      registered. Otherwise does nothing.
 213  */
 214 void do_kernel_restart(char *cmd)
 215 {
 216         atomic_notifier_call_chain(&restart_handler_list, reboot_mode, cmd);
 217 }
 218
 219 void migrate_to_reboot_cpu(void)
 220 {
 221         /* The boot cpu is always logical cpu 0 */
 222         int cpu = reboot_cpu;
 223
 224         cpu_hotplug_disable();
 225
 226         /* Make certain the cpu I'm about to reboot on is online */
 227         if (!cpu_online(cpu))
 228                 cpu = cpumask_first(cpu_online_mask);
 229
 230         /* Prevent races with other tasks migrating this task */
 231         current->flags |= PF_NO_SETAFFINITY;
 232
 233         /* Make certain I only run on the appropriate processor */
 234         set_cpus_allowed_ptr(current, cpumask_of(cpu));
 235 }
 236
 237 /**
 238  *      kernel_restart - reboot the system
 239  *      @cmd: pointer to buffer containing command to execute for restart
 240  *              or %NULL
 241  *
 242  *      Shutdown everything and perform a clean reboot.
 243  *      This is not safe to call in interrupt context.
 244  */
 245 void kernel_restart(char *cmd)
 246 {
 247         kernel_restart_prepare(cmd);
 248         migrate_to_reboot_cpu();
 249         syscore_shutdown();
 250         if (!cmd)
 251                 pr_emerg("Restarting system\n");
 252         else
 253                 pr_emerg("Restarting system with command '%s'\n", cmd);
 254         kmsg_dump(KMSG_DUMP_SHUTDOWN);
 255         machine_restart(cmd);
 256 }
 257 EXPORT_SYMBOL_GPL(kernel_restart);
 258
 259 static void kernel_shutdown_prepare(enum system_states state)
 260 {
 261         blocking_notifier_call_chain(&reboot_notifier_list,
 262                 (state == SYSTEM_HALT) ? SYS_HALT : SYS_POWER_OFF, NULL);
 263         system_state = state;
 264         usermodehelper_disable();
 265         device_shutdown();
 266 }
 267 /**
 268  *      kernel_halt - halt the system
 269  *
 270  *      Shutdown everything and perform a clean system halt.
 271  */
 272 void kernel_halt(void)
 273 {
 274         kernel_shutdown_prepare(SYSTEM_HALT);
 275         migrate_to_reboot_cpu();
 276         syscore_shutdown();
 277         pr_emerg("System halted\n");
 278         kmsg_dump(KMSG_DUMP_SHUTDOWN);
 279         machine_halt();
 280 }
 281 EXPORT_SYMBOL_GPL(kernel_halt);
 282
 283 /**
 284  *      kernel_power_off - power_off the system
 285  *
 286  *      Shutdown everything and perform a clean system power_off.
 287  */
 288 void kernel_power_off(void)
 289 {
 290         kernel_shutdown_prepare(SYSTEM_POWER_OFF);
 291         if (pm_power_off_prepare)
 292                 pm_power_off_prepare();
 293         migrate_to_reboot_cpu();
 294         syscore_shutdown();
 295         pr_emerg("Power down\n");
 296         kmsg_dump(KMSG_DUMP_SHUTDOWN);
 297         machine_power_off();
 298 }
 299 EXPORT_SYMBOL_GPL(kernel_power_off);
 300
 301 DEFINE_MUTEX(system_transition_mutex);
 302
 303 /*
 304  * Reboot system call: for obvious reasons only root may call it,
 305  * and even root needs to set up some magic numbers in the registers
 306  * so that some mistake won't make this reboot the whole machine.
 307  * You can also set the meaning of the ctrl-alt-del-key here.
 308  *
 309  * reboot doesn't sync: do that yourself before calling this.
 310  */
 311 SYSCALL_DEFINE4(reboot, int, magic1, int, magic2, unsigned int, cmd,
 312                 void __user *, arg)
 313 {
 314         struct pid_namespace *pid_ns = task_active_pid_ns(current);
 315         char buffer[256];
 316         int ret = 0;
 317
 318         /* We only trust the superuser with rebooting the system. */
 319         if (!ns_capable(pid_ns->user_ns, CAP_SYS_BOOT))
 320                 return -EPERM;
 321
 322         /* For safety, we require "magic" arguments. */
 323         if (magic1 != LINUX_REBOOT_MAGIC1 ||
 324                         (magic2 != LINUX_REBOOT_MAGIC2 &&
 325                         magic2 != LINUX_REBOOT_MAGIC2A &&
 326                         magic2 != LINUX_REBOOT_MAGIC2B &&
 327                         magic2 != LINUX_REBOOT_MAGIC2C))
 328                 return -EINVAL;
 329
 330         /*
 331          * If pid namespaces are enabled and the current task is in a child
 332          * pid_namespace, the command is handled by reboot_pid_ns() which will
 333          * call do_exit().
 334          */
 335         ret = reboot_pid_ns(pid_ns, cmd);
 336         if (ret)
 337                 return ret;
 338
 339         /* Instead of trying to make the power_off code look like
 340          * halt when pm_power_off is not set do it the easy way.
 341          */
 342         if ((cmd == LINUX_REBOOT_CMD_POWER_OFF) && !pm_power_off)
 343                 cmd = LINUX_REBOOT_CMD_HALT;
 344
 345         mutex_lock(&system_transition_mutex);
 346         switch (cmd) {
 347         case LINUX_REBOOT_CMD_RESTART:
 348                 kernel_restart(NULL);
 349                 break;
 350
 351         case LINUX_REBOOT_CMD_CAD_ON:
 352                 C_A_D = 1;
 353                 break;
 354
 355         case LINUX_REBOOT_CMD_CAD_OFF:
 356                 C_A_D = 0;
 357                 break;
 358
 359         case LINUX_REBOOT_CMD_HALT:
 360                 kernel_halt();
 361                 do_exit(0);
 362                 panic("cannot halt");
 363
 364         case LINUX_REBOOT_CMD_POWER_OFF:
 365                 kernel_power_off();
 366                 do_exit(0);
 367                 break;
 368
 369         case LINUX_REBOOT_CMD_RESTART2:
 370                 ret = strncpy_from_user(&buffer[0], arg, sizeof(buffer) - 1);
 371                 if (ret < 0) {
 372                         ret = -EFAULT;
 373                         break;
 374                 }
 375                 buffer[sizeof(buffer) - 1] = '\0';
 376
 377                 kernel_restart(buffer);
 378                 break;
 379
 380 #ifdef CONFIG_KEXEC_CORE
 381         case LINUX_REBOOT_CMD_KEXEC:
 382                 ret = kernel_kexec();
 383                 break;
 384 #endif
 385
 386 #ifdef CONFIG_HIBERNATION
 387         case LINUX_REBOOT_CMD_SW_SUSPEND:
 388                 ret = hibernate();
 389                 break;
 390 #endif
 391
 392         default:
 393                 ret = -EINVAL;
 394                 break;
 395         }
 396         mutex_unlock(&system_transition_mutex);
 397         return ret;
 398 }
 399
 400 static void deferred_cad(struct work_struct *dummy)
 401 {
 402         kernel_restart(NULL);
 403 }
 404
 405 /*
 406  * This function gets called by ctrl-alt-del - ie the keyboard interrupt.
 407  * As it's called within an interrupt, it may NOT sync: the only choice
 408  * is whether to reboot at once, or just ignore the ctrl-alt-del.
 409  */
 410 void ctrl_alt_del(void)
 411 {
 412         static DECLARE_WORK(cad_work, deferred_cad);
 413
 414         if (C_A_D)
 415                 schedule_work(&cad_work);
 416         else
 417                 kill_cad_pid(SIGINT, 1);
 418 }
 419
 420 char poweroff_cmd[POWEROFF_CMD_PATH_LEN] = "/sbin/poweroff";
 421 static const char reboot_cmd[] = "/sbin/reboot";
 422
 423 static int run_cmd(const char *cmd)
 424 {
 425         char **argv;
 426         static char *envp[] = {
 427                 "HOME=/",
 428                 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
 429                 NULL
 430         };
 431         int ret;
 432         argv = argv_split(GFP_KERNEL, cmd, NULL);
 433         if (argv) {
 434                 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_EXEC);
 435                 argv_free(argv);
 436         } else {
 437                 ret = -ENOMEM;
 438         }
 439
 440         return ret;
 441 }
 442
 443 static int __orderly_reboot(void)
 444 {
 445         int ret;
 446
 447         ret = run_cmd(reboot_cmd);
 448
 449         if (ret) {
 450                 pr_warn("Failed to start orderly reboot: forcing the issue\n");
 451                 emergency_sync();
 452                 kernel_restart(NULL);
 453         }
 454
 455         return ret;
 456 }
 457
 458 static int __orderly_poweroff(bool force)
 459 {
 460         int ret;
 461
 462         ret = run_cmd(poweroff_cmd);
 463
 464         if (ret && force) {
 465                 pr_warn("Failed to start orderly shutdown: forcing the issue\n");
 466
 467                 /*
 468                  * I guess this should try to kick off some daemon to sync and
 469                  * poweroff asap.  Or not even bother syncing if we're doing an
 470                  * emergency shutdown?
 471                  */
 472                 emergency_sync();
 473                 kernel_power_off();
 474         }
 475
 476         return ret;
 477 }
 478
 479 static bool poweroff_force;
 480
 481 static void poweroff_work_func(struct work_struct *work)
 482 {
 483         __orderly_poweroff(poweroff_force);
 484 }
 485
 486 static DECLARE_WORK(poweroff_work, poweroff_work_func);
 487
 488 /**
 489  * orderly_poweroff - Trigger an orderly system poweroff
 490  * @force: force poweroff if command execution fails
 491  *
 492  * This may be called from any context to trigger a system shutdown.
 493  * If the orderly shutdown fails, it will force an immediate shutdown.
 494  */
 495 void orderly_poweroff(bool force)
 496 {
 497         if (force) /* do not override the pending "true" */
 498                 poweroff_force = true;
 499         schedule_work(&poweroff_work);
 500 }
 501 EXPORT_SYMBOL_GPL(orderly_poweroff);
 502
 503 static void reboot_work_func(struct work_struct *work)
 504 {
 505         __orderly_reboot();
 506 }
 507
 508 static DECLARE_WORK(reboot_work, reboot_work_func);
 509
 510 /**
 511  * orderly_reboot - Trigger an orderly system reboot
 512  *
 513  * This may be called from any context to trigger a system reboot.
 514  * If the orderly reboot fails, it will force an immediate reboot.
 515  */
 516 void orderly_reboot(void)
 517 {
 518         schedule_work(&reboot_work);
 519 }
 520 EXPORT_SYMBOL_GPL(orderly_reboot);
 521
 522 static int __init reboot_setup(char *str)
 523 {
 524         for (;;) {
 525                 enum reboot_mode *mode;
 526
 527                 /*
 528                  * Having anything passed on the command line via
 529                  * reboot= will cause us to disable DMI checking
 530                  * below.
 531                  */
 532                 reboot_default = 0;
 533
 534                 if (!strncmp(str, "panic_", 6)) {
 535                         mode = &panic_reboot_mode;
 536                         str += 6;
 537                 } else {
 538                         mode = &reboot_mode;
 539                 }
 540
 541                 switch (*str) {
 542                 case 'w':
 543                         *mode = REBOOT_WARM;
 544                         break;
 545
 546                 case 'c':
 547                         *mode = REBOOT_COLD;
 548                         break;
 549
 550                 case 'h':
 551                         *mode = REBOOT_HARD;
 552                         break;
 553
 554                 case 's':
 555                         if (isdigit(*(str+1)))
 556                                 reboot_cpu = simple_strtoul(str+1, NULL, 0);
 557                         else if (str[1] == 'm' && str[2] == 'p' &&
 558                                                         isdigit(*(str+3)))
 559                                 reboot_cpu = simple_strtoul(str+3, NULL, 0);
 560                         else
 561                                 *mode = REBOOT_SOFT;
 562                         if (reboot_cpu >= num_possible_cpus()) {
 563                                 pr_err("Ignoring the CPU number in reboot= option. "
 564                                        "CPU %d exceeds possible cpu number %d\n",
 565                                        reboot_cpu, num_possible_cpus());
 566                                 reboot_cpu = 0;
 567                                 break;
 568                         }
 569                         break;
 570
 571                 case 'g':
 572                         *mode = REBOOT_GPIO;
 573                         break;
 574
 575                 case 'b':
 576                 case 'a':
 577                 case 'k':
 578                 case 't':
 579                 case 'e':
 580                 case 'p':
 581                         reboot_type = *str;
 582                         break;
 583
 584                 case 'f':
 585                         reboot_force = 1;
 586                         break;
 587                 }
 588
 589                 str = strchr(str, ',');
 590                 if (str)
 591                         str++;
 592                 else
 593                         break;
 594         }
 595         return 1;
 596 }
 597 __setup("reboot=", reboot_setup);