kernel/power/hibernate.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
   4  *
   5  * Copyright (c) 2003 Patrick Mochel
   6  * Copyright (c) 2003 Open Source Development Lab
   7  * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
   8  * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
   9  * Copyright (C) 2012 Bojan Smojver <bojan@rexursive.com>
  10  */
  11
  12 #define pr_fmt(fmt) "PM: hibernation: " fmt
  13
  14 #include <linux/export.h>
  15 #include <linux/suspend.h>
  16 #include <linux/reboot.h>
  17 #include <linux/string.h>
  18 #include <linux/device.h>
  19 #include <linux/async.h>
  20 #include <linux/delay.h>
  21 #include <linux/fs.h>
  22 #include <linux/mount.h>
  23 #include <linux/pm.h>
  24 #include <linux/nmi.h>
  25 #include <linux/console.h>
  26 #include <linux/cpu.h>
  27 #include <linux/freezer.h>
  28 #include <linux/gfp.h>
  29 #include <linux/syscore_ops.h>
  30 #include <linux/ctype.h>
  31 #include <linux/genhd.h>
  32 #include <linux/ktime.h>
  33 #include <linux/security.h>
  34 #include <trace/events/power.h>
  35
  36 #include "power.h"
  37
  38
  39 static int nocompress;
  40 static int noresume;
  41 static int nohibernate;
  42 static int resume_wait;
  43 static unsigned int resume_delay;
  44 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
  45 dev_t swsusp_resume_device;
  46 sector_t swsusp_resume_block;
  47 __visible int in_suspend __nosavedata;
  48
  49 enum {
  50         HIBERNATION_INVALID,
  51         HIBERNATION_PLATFORM,
  52         HIBERNATION_SHUTDOWN,
  53         HIBERNATION_REBOOT,
  54 #ifdef CONFIG_SUSPEND
  55         HIBERNATION_SUSPEND,
  56 #endif
  57         HIBERNATION_TEST_RESUME,
  58         /* keep last */
  59         __HIBERNATION_AFTER_LAST
  60 };
  61 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
  62 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
  63
  64 static int hibernation_mode = HIBERNATION_SHUTDOWN;
  65
  66 bool freezer_test_done;
  67
  68 static const struct platform_hibernation_ops *hibernation_ops;
  69
  70 static atomic_t hibernate_atomic = ATOMIC_INIT(1);
  71
  72 bool hibernate_acquire(void)
  73 {
  74         return atomic_add_unless(&hibernate_atomic, -1, 0);
  75 }
  76
  77 void hibernate_release(void)
  78 {
  79         atomic_inc(&hibernate_atomic);
  80 }
  81
  82 bool hibernation_available(void)
  83 {
  84         return nohibernate == 0 && !security_locked_down(LOCKDOWN_HIBERNATION);
  85 }
  86
  87 /**
  88  * hibernation_set_ops - Set the global hibernate operations.
  89  * @ops: Hibernation operations to use in subsequent hibernation transitions.
  90  */
  91 void hibernation_set_ops(const struct platform_hibernation_ops *ops)
  92 {
  93         if (ops && !(ops->begin && ops->end &&  ops->pre_snapshot
  94             && ops->prepare && ops->finish && ops->enter && ops->pre_restore
  95             && ops->restore_cleanup && ops->leave)) {
  96                 WARN_ON(1);
  97                 return;
  98         }
  99         lock_system_sleep();
 100         hibernation_ops = ops;
 101         if (ops)
 102                 hibernation_mode = HIBERNATION_PLATFORM;
 103         else if (hibernation_mode == HIBERNATION_PLATFORM)
 104                 hibernation_mode = HIBERNATION_SHUTDOWN;
 105
 106         unlock_system_sleep();
 107 }
 108 EXPORT_SYMBOL_GPL(hibernation_set_ops);
 109
 110 static bool entering_platform_hibernation;
 111
 112 bool system_entering_hibernation(void)
 113 {
 114         return entering_platform_hibernation;
 115 }
 116 EXPORT_SYMBOL(system_entering_hibernation);
 117
 118 #ifdef CONFIG_PM_DEBUG
 119 static void hibernation_debug_sleep(void)
 120 {
 121         pr_info("debug: Waiting for 5 seconds.\n");
 122         mdelay(5000);
 123 }
 124
 125 static int hibernation_test(int level)
 126 {
 127         if (pm_test_level == level) {
 128                 hibernation_debug_sleep();
 129                 return 1;
 130         }
 131         return 0;
 132 }
 133 #else /* !CONFIG_PM_DEBUG */
 134 static int hibernation_test(int level) { return 0; }
 135 #endif /* !CONFIG_PM_DEBUG */
 136
 137 /**
 138  * platform_begin - Call platform to start hibernation.
 139  * @platform_mode: Whether or not to use the platform driver.
 140  */
 141 static int platform_begin(int platform_mode)
 142 {
 143         return (platform_mode && hibernation_ops) ?
 144                 hibernation_ops->begin(PMSG_FREEZE) : 0;
 145 }
 146
 147 /**
 148  * platform_end - Call platform to finish transition to the working state.
 149  * @platform_mode: Whether or not to use the platform driver.
 150  */
 151 static void platform_end(int platform_mode)
 152 {
 153         if (platform_mode && hibernation_ops)
 154                 hibernation_ops->end();
 155 }
 156
 157 /**
 158  * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
 159  * @platform_mode: Whether or not to use the platform driver.
 160  *
 161  * Use the platform driver to prepare the system for creating a hibernate image,
 162  * if so configured, and return an error code if that fails.
 163  */
 164
 165 static int platform_pre_snapshot(int platform_mode)
 166 {
 167         return (platform_mode && hibernation_ops) ?
 168                 hibernation_ops->pre_snapshot() : 0;
 169 }
 170
 171 /**
 172  * platform_leave - Call platform to prepare a transition to the working state.
 173  * @platform_mode: Whether or not to use the platform driver.
 174  *
 175  * Use the platform driver prepare to prepare the machine for switching to the
 176  * normal mode of operation.
 177  *
 178  * This routine is called on one CPU with interrupts disabled.
 179  */
 180 static void platform_leave(int platform_mode)
 181 {
 182         if (platform_mode && hibernation_ops)
 183                 hibernation_ops->leave();
 184 }
 185
 186 /**
 187  * platform_finish - Call platform to switch the system to the working state.
 188  * @platform_mode: Whether or not to use the platform driver.
 189  *
 190  * Use the platform driver to switch the machine to the normal mode of
 191  * operation.
 192  *
 193  * This routine must be called after platform_prepare().
 194  */
 195 static void platform_finish(int platform_mode)
 196 {
 197         if (platform_mode && hibernation_ops)
 198                 hibernation_ops->finish();
 199 }
 200
 201 /**
 202  * platform_pre_restore - Prepare for hibernate image restoration.
 203  * @platform_mode: Whether or not to use the platform driver.
 204  *
 205  * Use the platform driver to prepare the system for resume from a hibernation
 206  * image.
 207  *
 208  * If the restore fails after this function has been called,
 209  * platform_restore_cleanup() must be called.
 210  */
 211 static int platform_pre_restore(int platform_mode)
 212 {
 213         return (platform_mode && hibernation_ops) ?
 214                 hibernation_ops->pre_restore() : 0;
 215 }
 216
 217 /**
 218  * platform_restore_cleanup - Switch to the working state after failing restore.
 219  * @platform_mode: Whether or not to use the platform driver.
 220  *
 221  * Use the platform driver to switch the system to the normal mode of operation
 222  * after a failing restore.
 223  *
 224  * If platform_pre_restore() has been called before the failing restore, this
 225  * function must be called too, regardless of the result of
 226  * platform_pre_restore().
 227  */
 228 static void platform_restore_cleanup(int platform_mode)
 229 {
 230         if (platform_mode && hibernation_ops)
 231                 hibernation_ops->restore_cleanup();
 232 }
 233
 234 /**
 235  * platform_recover - Recover from a failure to suspend devices.
 236  * @platform_mode: Whether or not to use the platform driver.
 237  */
 238 static void platform_recover(int platform_mode)
 239 {
 240         if (platform_mode && hibernation_ops && hibernation_ops->recover)
 241                 hibernation_ops->recover();
 242 }
 243
 244 /**
 245  * swsusp_show_speed - Print time elapsed between two events during hibernation.
 246  * @start: Starting event.
 247  * @stop: Final event.
 248  * @nr_pages: Number of memory pages processed between @start and @stop.
 249  * @msg: Additional diagnostic message to print.
 250  */
 251 void swsusp_show_speed(ktime_t start, ktime_t stop,
 252                       unsigned nr_pages, char *msg)
 253 {
 254         ktime_t diff;
 255         u64 elapsed_centisecs64;
 256         unsigned int centisecs;
 257         unsigned int k;
 258         unsigned int kps;
 259
 260         diff = ktime_sub(stop, start);
 261         elapsed_centisecs64 = ktime_divns(diff, 10*NSEC_PER_MSEC);
 262         centisecs = elapsed_centisecs64;
 263         if (centisecs == 0)
 264                 centisecs = 1;  /* avoid div-by-zero */
 265         k = nr_pages * (PAGE_SIZE / 1024);
 266         kps = (k * 100) / centisecs;
 267         pr_info("%s %u kbytes in %u.%02u seconds (%u.%02u MB/s)\n",
 268                 msg, k, centisecs / 100, centisecs % 100, kps / 1000,
 269                 (kps % 1000) / 10);
 270 }
 271
 272 __weak int arch_resume_nosmt(void)
 273 {
 274         return 0;
 275 }
 276
 277 /**
 278  * create_image - Create a hibernation image.
 279  * @platform_mode: Whether or not to use the platform driver.
 280  *
 281  * Execute device drivers' "late" and "noirq" freeze callbacks, create a
 282  * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
 283  *
 284  * Control reappears in this routine after the subsequent restore.
 285  */
 286 static int create_image(int platform_mode)
 287 {
 288         int error;
 289
 290         error = dpm_suspend_end(PMSG_FREEZE);
 291         if (error) {
 292                 pr_err("Some devices failed to power down, aborting\n");
 293                 return error;
 294         }
 295
 296         error = platform_pre_snapshot(platform_mode);
 297         if (error || hibernation_test(TEST_PLATFORM))
 298                 goto Platform_finish;
 299
 300         error = suspend_disable_secondary_cpus();
 301         if (error || hibernation_test(TEST_CPUS))
 302                 goto Enable_cpus;
 303
 304         local_irq_disable();
 305
 306         system_state = SYSTEM_SUSPEND;
 307
 308         error = syscore_suspend();
 309         if (error) {
 310                 pr_err("Some system devices failed to power down, aborting\n");
 311                 goto Enable_irqs;
 312         }
 313
 314         if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
 315                 goto Power_up;
 316
 317         in_suspend = 1;
 318         save_processor_state();
 319         trace_suspend_resume(TPS("machine_suspend"), PM_EVENT_HIBERNATE, true);
 320         error = swsusp_arch_suspend();
 321         /* Restore control flow magically appears here */
 322         restore_processor_state();
 323         trace_suspend_resume(TPS("machine_suspend"), PM_EVENT_HIBERNATE, false);
 324         if (error)
 325                 pr_err("Error %d creating image\n", error);
 326
 327         if (!in_suspend) {
 328                 events_check_enabled = false;
 329                 clear_or_poison_free_pages();
 330         }
 331
 332         platform_leave(platform_mode);
 333
 334  Power_up:
 335         syscore_resume();
 336
 337  Enable_irqs:
 338         system_state = SYSTEM_RUNNING;
 339         local_irq_enable();
 340
 341  Enable_cpus:
 342         suspend_enable_secondary_cpus();
 343
 344         /* Allow architectures to do nosmt-specific post-resume dances */
 345         if (!in_suspend)
 346                 error = arch_resume_nosmt();
 347
 348  Platform_finish:
 349         platform_finish(platform_mode);
 350
 351         dpm_resume_start(in_suspend ?
 352                 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
 353
 354         return error;
 355 }
 356
 357 /**
 358  * hibernation_snapshot - Quiesce devices and create a hibernation image.
 359  * @platform_mode: If set, use platform driver to prepare for the transition.
 360  *
 361  * This routine must be called with system_transition_mutex held.
 362  */
 363 int hibernation_snapshot(int platform_mode)
 364 {
 365         pm_message_t msg;
 366         int error;
 367
 368         pm_suspend_clear_flags();
 369         error = platform_begin(platform_mode);
 370         if (error)
 371                 goto Close;
 372
 373         /* Preallocate image memory before shutting down devices. */
 374         error = hibernate_preallocate_memory();
 375         if (error)
 376                 goto Close;
 377
 378         error = freeze_kernel_threads();
 379         if (error)
 380                 goto Cleanup;
 381
 382         if (hibernation_test(TEST_FREEZER)) {
 383
 384                 /*
 385                  * Indicate to the caller that we are returning due to a
 386                  * successful freezer test.
 387                  */
 388                 freezer_test_done = true;
 389                 goto Thaw;
 390         }
 391
 392         error = dpm_prepare(PMSG_FREEZE);
 393         if (error) {
 394                 dpm_complete(PMSG_RECOVER);
 395                 goto Thaw;
 396         }
 397
 398         suspend_console();
 399         pm_restrict_gfp_mask();
 400
 401         error = dpm_suspend(PMSG_FREEZE);
 402
 403         if (error || hibernation_test(TEST_DEVICES))
 404                 platform_recover(platform_mode);
 405         else
 406                 error = create_image(platform_mode);
 407
 408         /*
 409          * In the case that we call create_image() above, the control
 410          * returns here (1) after the image has been created or the
 411          * image creation has failed and (2) after a successful restore.
 412          */
 413
 414         /* We may need to release the preallocated image pages here. */
 415         if (error || !in_suspend)
 416                 swsusp_free();
 417
 418         msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
 419         dpm_resume(msg);
 420
 421         if (error || !in_suspend)
 422                 pm_restore_gfp_mask();
 423
 424         resume_console();
 425         dpm_complete(msg);
 426
 427  Close:
 428         platform_end(platform_mode);
 429         return error;
 430
 431  Thaw:
 432         thaw_kernel_threads();
 433  Cleanup:
 434         swsusp_free();
 435         goto Close;
 436 }
 437
 438 int __weak hibernate_resume_nonboot_cpu_disable(void)
 439 {
 440         return suspend_disable_secondary_cpus();
 441 }
 442
 443 /**
 444  * resume_target_kernel - Restore system state from a hibernation image.
 445  * @platform_mode: Whether or not to use the platform driver.
 446  *
 447  * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
 448  * contents of highmem that have not been restored yet from the image and run
 449  * the low-level code that will restore the remaining contents of memory and
 450  * switch to the just restored target kernel.
 451  */
 452 static int resume_target_kernel(bool platform_mode)
 453 {
 454         int error;
 455
 456         error = dpm_suspend_end(PMSG_QUIESCE);
 457         if (error) {
 458                 pr_err("Some devices failed to power down, aborting resume\n");
 459                 return error;
 460         }
 461
 462         error = platform_pre_restore(platform_mode);
 463         if (error)
 464                 goto Cleanup;
 465
 466         error = hibernate_resume_nonboot_cpu_disable();
 467         if (error)
 468                 goto Enable_cpus;
 469
 470         local_irq_disable();
 471         system_state = SYSTEM_SUSPEND;
 472
 473         error = syscore_suspend();
 474         if (error)
 475                 goto Enable_irqs;
 476
 477         save_processor_state();
 478         error = restore_highmem();
 479         if (!error) {
 480                 error = swsusp_arch_resume();
 481                 /*
 482                  * The code below is only ever reached in case of a failure.
 483                  * Otherwise, execution continues at the place where
 484                  * swsusp_arch_suspend() was called.
 485                  */
 486                 BUG_ON(!error);
 487                 /*
 488                  * This call to restore_highmem() reverts the changes made by
 489                  * the previous one.
 490                  */
 491                 restore_highmem();
 492         }
 493         /*
 494          * The only reason why swsusp_arch_resume() can fail is memory being
 495          * very tight, so we have to free it as soon as we can to avoid
 496          * subsequent failures.
 497          */
 498         swsusp_free();
 499         restore_processor_state();
 500         touch_softlockup_watchdog();
 501
 502         syscore_resume();
 503
 504  Enable_irqs:
 505         system_state = SYSTEM_RUNNING;
 506         local_irq_enable();
 507
 508  Enable_cpus:
 509         suspend_enable_secondary_cpus();
 510
 511  Cleanup:
 512         platform_restore_cleanup(platform_mode);
 513
 514         dpm_resume_start(PMSG_RECOVER);
 515
 516         return error;
 517 }
 518
 519 /**
 520  * hibernation_restore - Quiesce devices and restore from a hibernation image.
 521  * @platform_mode: If set, use platform driver to prepare for the transition.
 522  *
 523  * This routine must be called with system_transition_mutex held.  If it is
 524  * successful, control reappears in the restored target kernel in
 525  * hibernation_snapshot().
 526  */
 527 int hibernation_restore(int platform_mode)
 528 {
 529         int error;
 530
 531         pm_prepare_console();
 532         suspend_console();
 533         pm_restrict_gfp_mask();
 534         error = dpm_suspend_start(PMSG_QUIESCE);
 535         if (!error) {
 536                 error = resume_target_kernel(platform_mode);
 537                 /*
 538                  * The above should either succeed and jump to the new kernel,
 539                  * or return with an error. Otherwise things are just
 540                  * undefined, so let's be paranoid.
 541                  */
 542                 BUG_ON(!error);
 543         }
 544         dpm_resume_end(PMSG_RECOVER);
 545         pm_restore_gfp_mask();
 546         resume_console();
 547         pm_restore_console();
 548         return error;
 549 }
 550
 551 /**
 552  * hibernation_platform_enter - Power off the system using the platform driver.
 553  */
 554 int hibernation_platform_enter(void)
 555 {
 556         int error;
 557
 558         if (!hibernation_ops)
 559                 return -ENOSYS;
 560
 561         /*
 562          * We have cancelled the power transition by running
 563          * hibernation_ops->finish() before saving the image, so we should let
 564          * the firmware know that we're going to enter the sleep state after all
 565          */
 566         error = hibernation_ops->begin(PMSG_HIBERNATE);
 567         if (error)
 568                 goto Close;
 569
 570         entering_platform_hibernation = true;
 571         suspend_console();
 572         error = dpm_suspend_start(PMSG_HIBERNATE);
 573         if (error) {
 574                 if (hibernation_ops->recover)
 575                         hibernation_ops->recover();
 576                 goto Resume_devices;
 577         }
 578
 579         error = dpm_suspend_end(PMSG_HIBERNATE);
 580         if (error)
 581                 goto Resume_devices;
 582
 583         error = hibernation_ops->prepare();
 584         if (error)
 585                 goto Platform_finish;
 586
 587         error = suspend_disable_secondary_cpus();
 588         if (error)
 589                 goto Enable_cpus;
 590
 591         local_irq_disable();
 592         system_state = SYSTEM_SUSPEND;
 593         syscore_suspend();
 594         if (pm_wakeup_pending()) {
 595                 error = -EAGAIN;
 596                 goto Power_up;
 597         }
 598
 599         hibernation_ops->enter();
 600         /* We should never get here */
 601         while (1);
 602
 603  Power_up:
 604         syscore_resume();
 605         system_state = SYSTEM_RUNNING;
 606         local_irq_enable();
 607
 608  Enable_cpus:
 609         suspend_enable_secondary_cpus();
 610
 611  Platform_finish:
 612         hibernation_ops->finish();
 613
 614         dpm_resume_start(PMSG_RESTORE);
 615
 616  Resume_devices:
 617         entering_platform_hibernation = false;
 618         dpm_resume_end(PMSG_RESTORE);
 619         resume_console();
 620
 621  Close:
 622         hibernation_ops->end();
 623
 624         return error;
 625 }
 626
 627 /**
 628  * power_down - Shut the machine down for hibernation.
 629  *
 630  * Use the platform driver, if configured, to put the system into the sleep
 631  * state corresponding to hibernation, or try to power it off or reboot,
 632  * depending on the value of hibernation_mode.
 633  */
 634 static void power_down(void)
 635 {
 636 #ifdef CONFIG_SUSPEND
 637         int error;
 638
 639         if (hibernation_mode == HIBERNATION_SUSPEND) {
 640                 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
 641                 if (error) {
 642                         hibernation_mode = hibernation_ops ?
 643                                                 HIBERNATION_PLATFORM :
 644                                                 HIBERNATION_SHUTDOWN;
 645                 } else {
 646                         /* Restore swap signature. */
 647                         error = swsusp_unmark();
 648                         if (error)
 649                                 pr_err("Swap will be unusable! Try swapon -a.\n");
 650
 651                         return;
 652                 }
 653         }
 654 #endif
 655
 656         switch (hibernation_mode) {
 657         case HIBERNATION_REBOOT:
 658                 kernel_restart(NULL);
 659                 break;
 660         case HIBERNATION_PLATFORM:
 661                 hibernation_platform_enter();
 662                 fallthrough;
 663         case HIBERNATION_SHUTDOWN:
 664                 if (pm_power_off)
 665                         kernel_power_off();
 666                 break;
 667         }
 668         kernel_halt();
 669         /*
 670          * Valid image is on the disk, if we continue we risk serious data
 671          * corruption after resume.
 672          */
 673         pr_crit("Power down manually\n");
 674         while (1)
 675                 cpu_relax();
 676 }
 677
 678 static int load_image_and_restore(void)
 679 {
 680         int error;
 681         unsigned int flags;
 682
 683         pm_pr_dbg("Loading hibernation image.\n");
 684
 685         lock_device_hotplug();
 686         error = create_basic_memory_bitmaps();
 687         if (error)
 688                 goto Unlock;
 689
 690         error = swsusp_read(&flags);
 691         swsusp_close(FMODE_READ);
 692         if (!error)
 693                 error = hibernation_restore(flags & SF_PLATFORM_MODE);
 694
 695         pr_err("Failed to load image, recovering.\n");
 696         swsusp_free();
 697         free_basic_memory_bitmaps();
 698  Unlock:
 699         unlock_device_hotplug();
 700
 701         return error;
 702 }
 703
 704 /**
 705  * hibernate - Carry out system hibernation, including saving the image.
 706  */
 707 int hibernate(void)
 708 {
 709         bool snapshot_test = false;
 710         int error;
 711
 712         if (!hibernation_available()) {
 713                 pm_pr_dbg("Hibernation not available.\n");
 714                 return -EPERM;
 715         }
 716
 717         lock_system_sleep();
 718         /* The snapshot device should not be opened while we're running */
 719         if (!hibernate_acquire()) {
 720                 error = -EBUSY;
 721                 goto Unlock;
 722         }
 723
 724         pr_info("hibernation entry\n");
 725         pm_prepare_console();
 726         error = pm_notifier_call_chain_robust(PM_HIBERNATION_PREPARE, PM_POST_HIBERNATION);
 727         if (error)
 728                 goto Restore;
 729
 730         ksys_sync_helper();
 731
 732         error = freeze_processes();
 733         if (error)
 734                 goto Exit;
 735
 736         lock_device_hotplug();
 737         /* Allocate memory management structures */
 738         error = create_basic_memory_bitmaps();
 739         if (error)
 740                 goto Thaw;
 741
 742         error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
 743         if (error || freezer_test_done)
 744                 goto Free_bitmaps;
 745
 746         if (in_suspend) {
 747                 unsigned int flags = 0;
 748
 749                 if (hibernation_mode == HIBERNATION_PLATFORM)
 750                         flags |= SF_PLATFORM_MODE;
 751                 if (nocompress)
 752                         flags |= SF_NOCOMPRESS_MODE;
 753                 else
 754                         flags |= SF_CRC32_MODE;
 755
 756                 pm_pr_dbg("Writing hibernation image.\n");
 757                 error = swsusp_write(flags);
 758                 swsusp_free();
 759                 if (!error) {
 760                         if (hibernation_mode == HIBERNATION_TEST_RESUME)
 761                                 snapshot_test = true;
 762                         else
 763                                 power_down();
 764                 }
 765                 in_suspend = 0;
 766                 pm_restore_gfp_mask();
 767         } else {
 768                 pm_pr_dbg("Hibernation image restored successfully.\n");
 769         }
 770
 771  Free_bitmaps:
 772         free_basic_memory_bitmaps();
 773  Thaw:
 774         unlock_device_hotplug();
 775         if (snapshot_test) {
 776                 pm_pr_dbg("Checking hibernation image\n");
 777                 error = swsusp_check();
 778                 if (!error)
 779                         error = load_image_and_restore();
 780         }
 781         thaw_processes();
 782
 783         /* Don't bother checking whether freezer_test_done is true */
 784         freezer_test_done = false;
 785  Exit:
 786         pm_notifier_call_chain(PM_POST_HIBERNATION);
 787  Restore:
 788         pm_restore_console();
 789         hibernate_release();
 790  Unlock:
 791         unlock_system_sleep();
 792         pr_info("hibernation exit\n");
 793
 794         return error;
 795 }
 796
 797 /**
 798  * hibernate_quiet_exec - Execute a function with all devices frozen.
 799  * @func: Function to execute.
 800  * @data: Data pointer to pass to @func.
 801  *
 802  * Return the @func return value or an error code if it cannot be executed.
 803  */
 804 int hibernate_quiet_exec(int (*func)(void *data), void *data)
 805 {
 806         int error;
 807
 808         lock_system_sleep();
 809
 810         if (!hibernate_acquire()) {
 811                 error = -EBUSY;
 812                 goto unlock;
 813         }
 814
 815         pm_prepare_console();
 816
 817         error = pm_notifier_call_chain_robust(PM_HIBERNATION_PREPARE, PM_POST_HIBERNATION);
 818         if (error)
 819                 goto restore;
 820
 821         error = freeze_processes();
 822         if (error)
 823                 goto exit;
 824
 825         lock_device_hotplug();
 826
 827         pm_suspend_clear_flags();
 828
 829         error = platform_begin(true);
 830         if (error)
 831                 goto thaw;
 832
 833         error = freeze_kernel_threads();
 834         if (error)
 835                 goto thaw;
 836
 837         error = dpm_prepare(PMSG_FREEZE);
 838         if (error)
 839                 goto dpm_complete;
 840
 841         suspend_console();
 842
 843         error = dpm_suspend(PMSG_FREEZE);
 844         if (error)
 845                 goto dpm_resume;
 846
 847         error = dpm_suspend_end(PMSG_FREEZE);
 848         if (error)
 849                 goto dpm_resume;
 850
 851         error = platform_pre_snapshot(true);
 852         if (error)
 853                 goto skip;
 854
 855         error = func(data);
 856
 857 skip:
 858         platform_finish(true);
 859
 860         dpm_resume_start(PMSG_THAW);
 861
 862 dpm_resume:
 863         dpm_resume(PMSG_THAW);
 864
 865         resume_console();
 866
 867 dpm_complete:
 868         dpm_complete(PMSG_THAW);
 869
 870         thaw_kernel_threads();
 871
 872 thaw:
 873         platform_end(true);
 874
 875         unlock_device_hotplug();
 876
 877         thaw_processes();
 878
 879 exit:
 880         pm_notifier_call_chain(PM_POST_HIBERNATION);
 881
 882 restore:
 883         pm_restore_console();
 884
 885         hibernate_release();
 886
 887 unlock:
 888         unlock_system_sleep();
 889
 890         return error;
 891 }
 892 EXPORT_SYMBOL_GPL(hibernate_quiet_exec);
 893
 894 /**
 895  * software_resume - Resume from a saved hibernation image.
 896  *
 897  * This routine is called as a late initcall, when all devices have been
 898  * discovered and initialized already.
 899  *
 900  * The image reading code is called to see if there is a hibernation image
 901  * available for reading.  If that is the case, devices are quiesced and the
 902  * contents of memory is restored from the saved image.
 903  *
 904  * If this is successful, control reappears in the restored target kernel in
 905  * hibernation_snapshot() which returns to hibernate().  Otherwise, the routine
 906  * attempts to recover gracefully and make the kernel return to the normal mode
 907  * of operation.
 908  */
 909 static int software_resume(void)
 910 {
 911         int error;
 912
 913         /*
 914          * If the user said "noresume".. bail out early.
 915          */
 916         if (noresume || !hibernation_available())
 917                 return 0;
 918
 919         /*
 920          * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
 921          * is configured into the kernel. Since the regular hibernate
 922          * trigger path is via sysfs which takes a buffer mutex before
 923          * calling hibernate functions (which take system_transition_mutex)
 924          * this can cause lockdep to complain about a possible ABBA deadlock
 925          * which cannot happen since we're in the boot code here and
 926          * sysfs can't be invoked yet. Therefore, we use a subclass
 927          * here to avoid lockdep complaining.
 928          */
 929         mutex_lock_nested(&system_transition_mutex, SINGLE_DEPTH_NESTING);
 930
 931         if (swsusp_resume_device)
 932                 goto Check_image;
 933
 934         if (!strlen(resume_file)) {
 935                 error = -ENOENT;
 936                 goto Unlock;
 937         }
 938
 939         pm_pr_dbg("Checking hibernation image partition %s\n", resume_file);
 940
 941         if (resume_delay) {
 942                 pr_info("Waiting %dsec before reading resume device ...\n",
 943                         resume_delay);
 944                 ssleep(resume_delay);
 945         }
 946
 947         /* Check if the device is there */
 948         swsusp_resume_device = name_to_dev_t(resume_file);
 949         if (!swsusp_resume_device) {
 950                 /*
 951                  * Some device discovery might still be in progress; we need
 952                  * to wait for this to finish.
 953                  */
 954                 wait_for_device_probe();
 955
 956                 if (resume_wait) {
 957                         while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
 958                                 msleep(10);
 959                         async_synchronize_full();
 960                 }
 961
 962                 swsusp_resume_device = name_to_dev_t(resume_file);
 963                 if (!swsusp_resume_device) {
 964                         error = -ENODEV;
 965                         goto Unlock;
 966                 }
 967         }
 968
 969  Check_image:
 970         pm_pr_dbg("Hibernation image partition %d:%d present\n",
 971                 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
 972
 973         pm_pr_dbg("Looking for hibernation image.\n");
 974         error = swsusp_check();
 975         if (error)
 976                 goto Unlock;
 977
 978         /* The snapshot device should not be opened while we're running */
 979         if (!hibernate_acquire()) {
 980                 error = -EBUSY;
 981                 swsusp_close(FMODE_READ);
 982                 goto Unlock;
 983         }
 984
 985         pr_info("resume from hibernation\n");
 986         pm_prepare_console();
 987         error = pm_notifier_call_chain_robust(PM_RESTORE_PREPARE, PM_POST_RESTORE);
 988         if (error)
 989                 goto Restore;
 990
 991         pm_pr_dbg("Preparing processes for hibernation restore.\n");
 992         error = freeze_processes();
 993         if (error)
 994                 goto Close_Finish;
 995
 996         error = freeze_kernel_threads();
 997         if (error) {
 998                 thaw_processes();
 999                 goto Close_Finish;
1000         }
1001
1002         error = load_image_and_restore();
1003         thaw_processes();
1004  Finish:
1005         pm_notifier_call_chain(PM_POST_RESTORE);
1006  Restore:
1007         pm_restore_console();
1008         pr_info("resume failed (%d)\n", error);
1009         hibernate_release();
1010         /* For success case, the suspend path will release the lock */
1011  Unlock:
1012         mutex_unlock(&system_transition_mutex);
1013         pm_pr_dbg("Hibernation image not present or could not be loaded.\n");
1014         return error;
1015  Close_Finish:
1016         swsusp_close(FMODE_READ);
1017         goto Finish;
1018 }
1019
1020 late_initcall_sync(software_resume);
1021
1022
1023 static const char * const hibernation_modes[] = {
1024         [HIBERNATION_PLATFORM]  = "platform",
1025         [HIBERNATION_SHUTDOWN]  = "shutdown",
1026         [HIBERNATION_REBOOT]    = "reboot",
1027 #ifdef CONFIG_SUSPEND
1028         [HIBERNATION_SUSPEND]   = "suspend",
1029 #endif
1030         [HIBERNATION_TEST_RESUME]       = "test_resume",
1031 };
1032
1033 /*
1034  * /sys/power/disk - Control hibernation mode.
1035  *
1036  * Hibernation can be handled in several ways.  There are a few different ways
1037  * to put the system into the sleep state: using the platform driver (e.g. ACPI
1038  * or other hibernation_ops), powering it off or rebooting it (for testing
1039  * mostly).
1040  *
1041  * The sysfs file /sys/power/disk provides an interface for selecting the
1042  * hibernation mode to use.  Reading from this file causes the available modes
1043  * to be printed.  There are 3 modes that can be supported:
1044  *
1045  *      'platform'
1046  *      'shutdown'
1047  *      'reboot'
1048  *
1049  * If a platform hibernation driver is in use, 'platform' will be supported
1050  * and will be used by default.  Otherwise, 'shutdown' will be used by default.
1051  * The selected option (i.e. the one corresponding to the current value of
1052  * hibernation_mode) is enclosed by a square bracket.
1053  *
1054  * To select a given hibernation mode it is necessary to write the mode's
1055  * string representation (as returned by reading from /sys/power/disk) back
1056  * into /sys/power/disk.
1057  */
1058
1059 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
1060                          char *buf)
1061 {
1062         int i;
1063         char *start = buf;
1064
1065         if (!hibernation_available())
1066                 return sprintf(buf, "[disabled]\n");
1067
1068         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
1069                 if (!hibernation_modes[i])
1070                         continue;
1071                 switch (i) {
1072                 case HIBERNATION_SHUTDOWN:
1073                 case HIBERNATION_REBOOT:
1074 #ifdef CONFIG_SUSPEND
1075                 case HIBERNATION_SUSPEND:
1076 #endif
1077                 case HIBERNATION_TEST_RESUME:
1078                         break;
1079                 case HIBERNATION_PLATFORM:
1080                         if (hibernation_ops)
1081                                 break;
1082                         /* not a valid mode, continue with loop */
1083                         continue;
1084                 }
1085                 if (i == hibernation_mode)
1086                         buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
1087                 else
1088                         buf += sprintf(buf, "%s ", hibernation_modes[i]);
1089         }
1090         buf += sprintf(buf, "\n");
1091         return buf-start;
1092 }
1093
1094 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
1095                           const char *buf, size_t n)
1096 {
1097         int error = 0;
1098         int i;
1099         int len;
1100         char *p;
1101         int mode = HIBERNATION_INVALID;
1102
1103         if (!hibernation_available())
1104                 return -EPERM;
1105
1106         p = memchr(buf, '\n', n);
1107         len = p ? p - buf : n;
1108
1109         lock_system_sleep();
1110         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
1111                 if (len == strlen(hibernation_modes[i])
1112                     && !strncmp(buf, hibernation_modes[i], len)) {
1113                         mode = i;
1114                         break;
1115                 }
1116         }
1117         if (mode != HIBERNATION_INVALID) {
1118                 switch (mode) {
1119                 case HIBERNATION_SHUTDOWN:
1120                 case HIBERNATION_REBOOT:
1121 #ifdef CONFIG_SUSPEND
1122                 case HIBERNATION_SUSPEND:
1123 #endif
1124                 case HIBERNATION_TEST_RESUME:
1125                         hibernation_mode = mode;
1126                         break;
1127                 case HIBERNATION_PLATFORM:
1128                         if (hibernation_ops)
1129                                 hibernation_mode = mode;
1130                         else
1131                                 error = -EINVAL;
1132                 }
1133         } else
1134                 error = -EINVAL;
1135
1136         if (!error)
1137                 pm_pr_dbg("Hibernation mode set to '%s'\n",
1138                                hibernation_modes[mode]);
1139         unlock_system_sleep();
1140         return error ? error : n;
1141 }
1142
1143 power_attr(disk);
1144
1145 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
1146                            char *buf)
1147 {
1148         return sprintf(buf, "%d:%d\n", MAJOR(swsusp_resume_device),
1149                        MINOR(swsusp_resume_device));
1150 }
1151
1152 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
1153                             const char *buf, size_t n)
1154 {
1155         dev_t res;
1156         int len = n;
1157         char *name;
1158
1159         if (len && buf[len-1] == '\n')
1160                 len--;
1161         name = kstrndup(buf, len, GFP_KERNEL);
1162         if (!name)
1163                 return -ENOMEM;
1164
1165         res = name_to_dev_t(name);
1166         kfree(name);
1167         if (!res)
1168                 return -EINVAL;
1169
1170         lock_system_sleep();
1171         swsusp_resume_device = res;
1172         unlock_system_sleep();
1173         pm_pr_dbg("Configured hibernation resume from disk to %u\n",
1174                   swsusp_resume_device);
1175         noresume = 0;
1176         software_resume();
1177         return n;
1178 }
1179
1180 power_attr(resume);
1181
1182 static ssize_t resume_offset_show(struct kobject *kobj,
1183                                   struct kobj_attribute *attr, char *buf)
1184 {
1185         return sprintf(buf, "%llu\n", (unsigned long long)swsusp_resume_block);
1186 }
1187
1188 static ssize_t resume_offset_store(struct kobject *kobj,
1189                                    struct kobj_attribute *attr, const char *buf,
1190                                    size_t n)
1191 {
1192         unsigned long long offset;
1193         int rc;
1194
1195         rc = kstrtoull(buf, 0, &offset);
1196         if (rc)
1197                 return rc;
1198         swsusp_resume_block = offset;
1199
1200         return n;
1201 }
1202
1203 power_attr(resume_offset);
1204
1205 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1206                                char *buf)
1207 {
1208         return sprintf(buf, "%lu\n", image_size);
1209 }
1210
1211 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1212                                 const char *buf, size_t n)
1213 {
1214         unsigned long size;
1215
1216         if (sscanf(buf, "%lu", &size) == 1) {
1217                 image_size = size;
1218                 return n;
1219         }
1220
1221         return -EINVAL;
1222 }
1223
1224 power_attr(image_size);
1225
1226 static ssize_t reserved_size_show(struct kobject *kobj,
1227                                   struct kobj_attribute *attr, char *buf)
1228 {
1229         return sprintf(buf, "%lu\n", reserved_size);
1230 }
1231
1232 static ssize_t reserved_size_store(struct kobject *kobj,
1233                                    struct kobj_attribute *attr,
1234                                    const char *buf, size_t n)
1235 {
1236         unsigned long size;
1237
1238         if (sscanf(buf, "%lu", &size) == 1) {
1239                 reserved_size = size;
1240                 return n;
1241         }
1242
1243         return -EINVAL;
1244 }
1245
1246 power_attr(reserved_size);
1247
1248 static struct attribute *g[] = {
1249         &disk_attr.attr,
1250         &resume_offset_attr.attr,
1251         &resume_attr.attr,
1252         &image_size_attr.attr,
1253         &reserved_size_attr.attr,
1254         NULL,
1255 };
1256
1257
1258 static const struct attribute_group attr_group = {
1259         .attrs = g,
1260 };
1261
1262
1263 static int __init pm_disk_init(void)
1264 {
1265         return sysfs_create_group(power_kobj, &attr_group);
1266 }
1267
1268 core_initcall(pm_disk_init);
1269
1270
1271 static int __init resume_setup(char *str)
1272 {
1273         if (noresume)
1274                 return 1;
1275
1276         strncpy(resume_file, str, 255);
1277         return 1;
1278 }
1279
1280 static int __init resume_offset_setup(char *str)
1281 {
1282         unsigned long long offset;
1283
1284         if (noresume)
1285                 return 1;
1286
1287         if (sscanf(str, "%llu", &offset) == 1)
1288                 swsusp_resume_block = offset;
1289
1290         return 1;
1291 }
1292
1293 static int __init hibernate_setup(char *str)
1294 {
1295         if (!strncmp(str, "noresume", 8)) {
1296                 noresume = 1;
1297         } else if (!strncmp(str, "nocompress", 10)) {
1298                 nocompress = 1;
1299         } else if (!strncmp(str, "no", 2)) {
1300                 noresume = 1;
1301                 nohibernate = 1;
1302         } else if (IS_ENABLED(CONFIG_STRICT_KERNEL_RWX)
1303                    && !strncmp(str, "protect_image", 13)) {
1304                 enable_restore_image_protection();
1305         }
1306         return 1;
1307 }
1308
1309 static int __init noresume_setup(char *str)
1310 {
1311         noresume = 1;
1312         return 1;
1313 }
1314
1315 static int __init resumewait_setup(char *str)
1316 {
1317         resume_wait = 1;
1318         return 1;
1319 }
1320
1321 static int __init resumedelay_setup(char *str)
1322 {
1323         int rc = kstrtouint(str, 0, &resume_delay);
1324
1325         if (rc)
1326                 return rc;
1327         return 1;
1328 }
1329
1330 static int __init nohibernate_setup(char *str)
1331 {
1332         noresume = 1;
1333         nohibernate = 1;
1334         return 1;
1335 }
1336
1337 __setup("noresume", noresume_setup);
1338 __setup("resume_offset=", resume_offset_setup);
1339 __setup("resume=", resume_setup);
1340 __setup("hibernate=", hibernate_setup);
1341 __setup("resumewait", resumewait_setup);
1342 __setup("resumedelay=", resumedelay_setup);
1343 __setup("nohibernate", nohibernate_setup);