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