kernel/power/hibernate.c

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