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