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