]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - kernel/power/hibernate.c
PM / Hibernate: Fix s2disk regression related to freezing workqueues
[mirror_ubuntu-bionic-kernel.git] / kernel / power / hibernate.c
CommitLineData
1da177e4 1/*
8b759b84 2 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
1da177e4
LT
3 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
a2531293 6 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
8b759b84 7 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
1da177e4
LT
8 *
9 * This file is released under the GPLv2.
1da177e4
LT
10 */
11
6e5fdeed 12#include <linux/export.h>
1da177e4
LT
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>
6f8d7022 18#include <linux/async.h>
1bfcf130 19#include <linux/kmod.h>
1da177e4
LT
20#include <linux/delay.h>
21#include <linux/fs.h>
d53d9f16 22#include <linux/mount.h>
88d10bba 23#include <linux/pm.h>
97c7801c 24#include <linux/console.h>
e3920fb4 25#include <linux/cpu.h>
7dfb7103 26#include <linux/freezer.h>
5a0e3ad6 27#include <linux/gfp.h>
40dc166c 28#include <linux/syscore_ops.h>
c7510859 29#include <scsi/scsi_scan.h>
d53d9f16 30
1da177e4
LT
31#include "power.h"
32
33
d231ff1a
BS
34static int nocompress;
35static int noresume;
36static int resume_wait;
37static int resume_delay;
47a460d5 38static char resume_file[256] = CONFIG_PM_STD_PARTITION;
1da177e4 39dev_t swsusp_resume_device;
9a154d9d 40sector_t swsusp_resume_block;
d231ff1a 41int in_suspend __nosavedata;
1da177e4 42
a3d25c27
RW
43enum {
44 HIBERNATION_INVALID,
45 HIBERNATION_PLATFORM,
a3d25c27
RW
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
97819a26 56bool freezer_test_done;
aa9a7b11 57
073ef1f6 58static const struct platform_hibernation_ops *hibernation_ops;
a3d25c27
RW
59
60/**
f42a9813
RW
61 * hibernation_set_ops - Set the global hibernate operations.
62 * @ops: Hibernation operations to use in subsequent hibernation transitions.
a3d25c27 63 */
073ef1f6 64void hibernation_set_ops(const struct platform_hibernation_ops *ops)
a3d25c27 65{
caea99ef
RW
66 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
67 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
5729c63a 68 && ops->restore_cleanup && ops->leave)) {
a3d25c27
RW
69 WARN_ON(1);
70 return;
71 }
bcda53fa 72 lock_system_sleep();
a3d25c27
RW
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
bcda53fa 79 unlock_system_sleep();
a3d25c27
RW
80}
81
abfe2d7b
RW
82static bool entering_platform_hibernation;
83
84bool system_entering_hibernation(void)
85{
86 return entering_platform_hibernation;
87}
88EXPORT_SYMBOL(system_entering_hibernation);
89
4cc79776
RW
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
4cc79776
RW
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 */
4cc79776
RW
106static int hibernation_test(int level) { return 0; }
107#endif /* !CONFIG_PM_DEBUG */
108
74f270af 109/**
f42a9813
RW
110 * platform_begin - Call platform to start hibernation.
111 * @platform_mode: Whether or not to use the platform driver.
74f270af 112 */
caea99ef 113static int platform_begin(int platform_mode)
74f270af
RW
114{
115 return (platform_mode && hibernation_ops) ?
caea99ef
RW
116 hibernation_ops->begin() : 0;
117}
118
119/**
f42a9813
RW
120 * platform_end - Call platform to finish transition to the working state.
121 * @platform_mode: Whether or not to use the platform driver.
caea99ef 122 */
caea99ef
RW
123static void platform_end(int platform_mode)
124{
125 if (platform_mode && hibernation_ops)
126 hibernation_ops->end();
74f270af 127}
a3d25c27 128
8a05aac2 129/**
f42a9813
RW
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.
8a05aac2
SS
135 */
136
74f270af 137static int platform_pre_snapshot(int platform_mode)
8a05aac2 138{
7777fab9 139 return (platform_mode && hibernation_ops) ?
74f270af 140 hibernation_ops->pre_snapshot() : 0;
a3d25c27 141}
8a05aac2 142
c7e0831d 143/**
f42a9813
RW
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.
c7e0831d 151 */
c7e0831d
RW
152static void platform_leave(int platform_mode)
153{
154 if (platform_mode && hibernation_ops)
155 hibernation_ops->leave();
156}
157
a3d25c27 158/**
f42a9813
RW
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().
a3d25c27 166 */
7777fab9 167static void platform_finish(int platform_mode)
a3d25c27 168{
7777fab9 169 if (platform_mode && hibernation_ops)
a3d25c27 170 hibernation_ops->finish();
8a05aac2
SS
171}
172
a634cc10 173/**
f42a9813
RW
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.
a634cc10 182 */
a634cc10
RW
183static int platform_pre_restore(int platform_mode)
184{
185 return (platform_mode && hibernation_ops) ?
186 hibernation_ops->pre_restore() : 0;
187}
188
189/**
f42a9813
RW
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().
a634cc10 199 */
a634cc10
RW
200static void platform_restore_cleanup(int platform_mode)
201{
202 if (platform_mode && hibernation_ops)
203 hibernation_ops->restore_cleanup();
204}
205
d8f3de0d 206/**
f42a9813
RW
207 * platform_recover - Recover from a failure to suspend devices.
208 * @platform_mode: Whether or not to use the platform driver.
d8f3de0d 209 */
d8f3de0d
RW
210static void platform_recover(int platform_mode)
211{
212 if (platform_mode && hibernation_ops && hibernation_ops->recover)
213 hibernation_ops->recover();
214}
215
8e60c6a1 216/**
f42a9813
RW
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.
8e60c6a1 222 */
8e60c6a1
NC
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
c7e0831d 244/**
f42a9813
RW
245 * create_image - Create a hibernation image.
246 * @platform_mode: Whether or not to use the platform driver.
247 *
248 * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
249 * and execute the drivers' .thaw_noirq() callbacks.
250 *
251 * Control reappears in this routine after the subsequent restore.
c7e0831d 252 */
47a460d5 253static int create_image(int platform_mode)
c7e0831d
RW
254{
255 int error;
256
d1616302 257 error = dpm_suspend_noirq(PMSG_FREEZE);
c7e0831d 258 if (error) {
23976728
RW
259 printk(KERN_ERR "PM: Some devices failed to power down, "
260 "aborting hibernation\n");
32bdfac5 261 return error;
c7e0831d 262 }
2ed8d2b3 263
4aecd671
RW
264 error = platform_pre_snapshot(platform_mode);
265 if (error || hibernation_test(TEST_PLATFORM))
266 goto Platform_finish;
267
268 error = disable_nonboot_cpus();
48580ab8 269 if (error || hibernation_test(TEST_CPUS))
4aecd671
RW
270 goto Enable_cpus;
271
2ed8d2b3
RW
272 local_irq_disable();
273
2e711c04 274 error = syscore_suspend();
770824bd 275 if (error) {
4484079d 276 printk(KERN_ERR "PM: Some system devices failed to power down, "
770824bd 277 "aborting hibernation\n");
4aecd671 278 goto Enable_irqs;
770824bd 279 }
c7e0831d 280
a2867e08 281 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
4cc79776
RW
282 goto Power_up;
283
284 in_suspend = 1;
c7e0831d
RW
285 save_processor_state();
286 error = swsusp_arch_suspend();
287 if (error)
23976728
RW
288 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
289 error);
c7e0831d
RW
290 /* Restore control flow magically appears here */
291 restore_processor_state();
c125e96f
RW
292 if (!in_suspend) {
293 events_check_enabled = false;
c7e0831d 294 platform_leave(platform_mode);
c125e96f 295 }
4aecd671 296
4cc79776 297 Power_up:
40dc166c 298 syscore_resume();
2ed8d2b3 299
4aecd671 300 Enable_irqs:
2ed8d2b3
RW
301 local_irq_enable();
302
4aecd671
RW
303 Enable_cpus:
304 enable_nonboot_cpus();
305
306 Platform_finish:
307 platform_finish(platform_mode);
308
d1616302 309 dpm_resume_noirq(in_suspend ?
1eede070 310 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
2ed8d2b3 311
c7e0831d
RW
312 return error;
313}
314
7777fab9 315/**
f42a9813
RW
316 * hibernation_snapshot - Quiesce devices and create a hibernation image.
317 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 318 *
f42a9813 319 * This routine must be called with pm_mutex held.
7777fab9 320 */
7777fab9
RW
321int hibernation_snapshot(int platform_mode)
322{
953a2063 323 pm_message_t msg;
cbe2f5a6 324 int error;
7777fab9 325
3fe0313e 326 error = platform_begin(platform_mode);
7777fab9 327 if (error)
d074ee02 328 goto Close;
7777fab9 329
64a473cb
RW
330 /* Preallocate image memory before shutting down devices. */
331 error = hibernate_preallocate_memory();
2aede851
RW
332 if (error)
333 goto Close;
334
335 error = freeze_kernel_threads();
336 if (error)
bb58dd5d 337 goto Cleanup;
2aede851 338
48580ab8 339 if (hibernation_test(TEST_FREEZER)) {
aa9a7b11
SB
340
341 /*
342 * Indicate to the caller that we are returning due to a
343 * successful freezer test.
344 */
345 freezer_test_done = true;
bb58dd5d 346 goto Cleanup;
aa9a7b11
SB
347 }
348
2aede851 349 error = dpm_prepare(PMSG_FREEZE);
bb58dd5d 350 if (error) {
953a2063 351 dpm_complete(PMSG_RECOVER);
bb58dd5d
RW
352 goto Cleanup;
353 }
74f270af 354
7777fab9 355 suspend_console();
c9e664f1 356 pm_restrict_gfp_mask();
953a2063 357
91e7c75b 358 error = dpm_suspend(PMSG_FREEZE);
10a1803d 359
953a2063
SB
360 if (error || hibernation_test(TEST_DEVICES))
361 platform_recover(platform_mode);
362 else
363 error = create_image(platform_mode);
7777fab9 364
c9e664f1 365 /*
953a2063
SB
366 * In the case that we call create_image() above, the control
367 * returns here (1) after the image has been created or the
c9e664f1
RW
368 * image creation has failed and (2) after a successful restore.
369 */
4cc79776 370
64a473cb
RW
371 /* We may need to release the preallocated image pages here. */
372 if (error || !in_suspend)
373 swsusp_free();
374
91e7c75b
RW
375 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
376 dpm_resume(msg);
c9e664f1
RW
377
378 if (error || !in_suspend)
379 pm_restore_gfp_mask();
380
7777fab9 381 resume_console();
91e7c75b
RW
382 dpm_complete(msg);
383
caea99ef
RW
384 Close:
385 platform_end(platform_mode);
7777fab9 386 return error;
d8f3de0d 387
bb58dd5d
RW
388 Cleanup:
389 swsusp_free();
390 goto Close;
7777fab9
RW
391}
392
72df68ca 393/**
f42a9813
RW
394 * resume_target_kernel - Restore system state from a hibernation image.
395 * @platform_mode: Whether or not to use the platform driver.
396 *
397 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
398 * highmem that have not been restored yet from the image and run the low-level
399 * code that will restore the remaining contents of memory and switch to the
400 * just restored target kernel.
72df68ca 401 */
4aecd671 402static int resume_target_kernel(bool platform_mode)
72df68ca
RW
403{
404 int error;
405
d1616302 406 error = dpm_suspend_noirq(PMSG_QUIESCE);
72df68ca 407 if (error) {
23976728 408 printk(KERN_ERR "PM: Some devices failed to power down, "
72df68ca 409 "aborting resume\n");
32bdfac5 410 return error;
72df68ca 411 }
2ed8d2b3 412
4aecd671
RW
413 error = platform_pre_restore(platform_mode);
414 if (error)
415 goto Cleanup;
416
417 error = disable_nonboot_cpus();
418 if (error)
419 goto Enable_cpus;
420
2ed8d2b3
RW
421 local_irq_disable();
422
2e711c04 423 error = syscore_suspend();
4aecd671
RW
424 if (error)
425 goto Enable_irqs;
426
72df68ca
RW
427 save_processor_state();
428 error = restore_highmem();
429 if (!error) {
430 error = swsusp_arch_resume();
431 /*
432 * The code below is only ever reached in case of a failure.
4e2d9491
RW
433 * Otherwise, execution continues at the place where
434 * swsusp_arch_suspend() was called.
72df68ca
RW
435 */
436 BUG_ON(!error);
4e2d9491
RW
437 /*
438 * This call to restore_highmem() reverts the changes made by
439 * the previous one.
440 */
72df68ca
RW
441 restore_highmem();
442 }
443 /*
444 * The only reason why swsusp_arch_resume() can fail is memory being
445 * very tight, so we have to free it as soon as we can to avoid
4e2d9491 446 * subsequent failures.
72df68ca
RW
447 */
448 swsusp_free();
449 restore_processor_state();
450 touch_softlockup_watchdog();
2ed8d2b3 451
40dc166c 452 syscore_resume();
2ed8d2b3 453
4aecd671 454 Enable_irqs:
72df68ca 455 local_irq_enable();
2ed8d2b3 456
4aecd671
RW
457 Enable_cpus:
458 enable_nonboot_cpus();
459
460 Cleanup:
461 platform_restore_cleanup(platform_mode);
462
d1616302 463 dpm_resume_noirq(PMSG_RECOVER);
2ed8d2b3 464
72df68ca
RW
465 return error;
466}
467
7777fab9 468/**
f42a9813
RW
469 * hibernation_restore - Quiesce devices and restore from a hibernation image.
470 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 471 *
f42a9813 472 * This routine must be called with pm_mutex held. If it is successful, control
21e82808 473 * reappears in the restored target kernel in hibernation_snapshot().
7777fab9 474 */
a634cc10 475int hibernation_restore(int platform_mode)
7777fab9 476{
cbe2f5a6 477 int error;
7777fab9
RW
478
479 pm_prepare_console();
480 suspend_console();
c9e664f1 481 pm_restrict_gfp_mask();
d1616302 482 error = dpm_suspend_start(PMSG_QUIESCE);
a634cc10 483 if (!error) {
4aecd671 484 error = resume_target_kernel(platform_mode);
d1616302 485 dpm_resume_end(PMSG_RECOVER);
a634cc10 486 }
c9e664f1 487 pm_restore_gfp_mask();
7777fab9
RW
488 resume_console();
489 pm_restore_console();
490 return error;
491}
492
493/**
f42a9813 494 * hibernation_platform_enter - Power off the system using the platform driver.
7777fab9 495 */
7777fab9
RW
496int hibernation_platform_enter(void)
497{
cbe2f5a6 498 int error;
b1457bcc 499
9cd9a005
RW
500 if (!hibernation_ops)
501 return -ENOSYS;
502
503 /*
504 * We have cancelled the power transition by running
505 * hibernation_ops->finish() before saving the image, so we should let
506 * the firmware know that we're going to enter the sleep state after all
507 */
caea99ef 508 error = hibernation_ops->begin();
9cd9a005 509 if (error)
caea99ef 510 goto Close;
9cd9a005 511
abfe2d7b 512 entering_platform_hibernation = true;
9cd9a005 513 suspend_console();
d1616302 514 error = dpm_suspend_start(PMSG_HIBERNATE);
d8f3de0d
RW
515 if (error) {
516 if (hibernation_ops->recover)
517 hibernation_ops->recover();
518 goto Resume_devices;
519 }
9cd9a005 520
d1616302 521 error = dpm_suspend_noirq(PMSG_HIBERNATE);
4aecd671 522 if (error)
32bdfac5 523 goto Resume_devices;
4aecd671 524
9cd9a005
RW
525 error = hibernation_ops->prepare();
526 if (error)
e681c9dd 527 goto Platform_finish;
9cd9a005
RW
528
529 error = disable_nonboot_cpus();
530 if (error)
e681c9dd 531 goto Platform_finish;
2ed8d2b3 532
4aecd671 533 local_irq_disable();
40dc166c 534 syscore_suspend();
a2867e08 535 if (pm_wakeup_pending()) {
c125e96f
RW
536 error = -EAGAIN;
537 goto Power_up;
538 }
539
4aecd671
RW
540 hibernation_ops->enter();
541 /* We should never get here */
542 while (1);
9cd9a005 543
c125e96f 544 Power_up:
40dc166c 545 syscore_resume();
c125e96f
RW
546 local_irq_enable();
547 enable_nonboot_cpus();
548
e681c9dd 549 Platform_finish:
9cd9a005 550 hibernation_ops->finish();
2ed8d2b3 551
f6f71f18 552 dpm_resume_noirq(PMSG_RESTORE);
4aecd671 553
9cd9a005 554 Resume_devices:
abfe2d7b 555 entering_platform_hibernation = false;
d1616302 556 dpm_resume_end(PMSG_RESTORE);
9cd9a005 557 resume_console();
2ed8d2b3 558
caea99ef
RW
559 Close:
560 hibernation_ops->end();
2ed8d2b3 561
b1457bcc 562 return error;
7777fab9
RW
563}
564
1da177e4 565/**
f42a9813 566 * power_down - Shut the machine down for hibernation.
1da177e4 567 *
f42a9813
RW
568 * Use the platform driver, if configured, to put the system into the sleep
569 * state corresponding to hibernation, or try to power it off or reboot,
570 * depending on the value of hibernation_mode.
1da177e4 571 */
fe0c935a 572static void power_down(void)
1da177e4 573{
a3d25c27 574 switch (hibernation_mode) {
a3d25c27 575 case HIBERNATION_REBOOT:
fdde86ac 576 kernel_restart(NULL);
1da177e4 577 break;
a3d25c27 578 case HIBERNATION_PLATFORM:
7777fab9 579 hibernation_platform_enter();
9cd9a005
RW
580 case HIBERNATION_SHUTDOWN:
581 kernel_power_off();
582 break;
1da177e4 583 }
fdde86ac 584 kernel_halt();
fe0c935a
JB
585 /*
586 * Valid image is on the disk, if we continue we risk serious data
587 * corruption after resume.
588 */
23976728 589 printk(KERN_CRIT "PM: Please power down manually\n");
1da177e4
LT
590 while(1);
591}
592
1da177e4 593/**
f42a9813 594 * hibernate - Carry out system hibernation, including saving the image.
1da177e4 595 */
a3d25c27 596int hibernate(void)
1da177e4
LT
597{
598 int error;
599
bcda53fa 600 lock_system_sleep();
0709db60 601 /* The snapshot device should not be opened while we're running */
b10d9117
RW
602 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
603 error = -EBUSY;
604 goto Unlock;
605 }
606
5a0a2f30 607 pm_prepare_console();
b10d9117
RW
608 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
609 if (error)
610 goto Exit;
0709db60 611
1bfcf130
RW
612 error = usermodehelper_disable();
613 if (error)
614 goto Exit;
615
0709db60
RW
616 /* Allocate memory management structures */
617 error = create_basic_memory_bitmaps();
618 if (error)
619 goto Exit;
620
23976728 621 printk(KERN_INFO "PM: Syncing filesystems ... ");
232b1432
RW
622 sys_sync();
623 printk("done.\n");
624
03afed8b 625 error = freeze_processes();
5a72e04d 626 if (error)
0709db60 627 goto Finish;
1da177e4 628
7777fab9 629 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
64a473cb
RW
630 if (error)
631 goto Thaw;
aa9a7b11
SB
632 if (freezer_test_done) {
633 freezer_test_done = false;
634 goto Thaw;
635 }
64a473cb
RW
636
637 if (in_suspend) {
a634cc10
RW
638 unsigned int flags = 0;
639
640 if (hibernation_mode == HIBERNATION_PLATFORM)
641 flags |= SF_PLATFORM_MODE;
f996fc96
BS
642 if (nocompress)
643 flags |= SF_NOCOMPRESS_MODE;
081a9d04
BS
644 else
645 flags |= SF_CRC32_MODE;
646
1da177e4 647 pr_debug("PM: writing image.\n");
a634cc10 648 error = swsusp_write(flags);
7777fab9 649 swsusp_free();
1da177e4 650 if (!error)
fe0c935a 651 power_down();
5262a475 652 in_suspend = 0;
c9e664f1 653 pm_restore_gfp_mask();
b918f6e6 654 } else {
1da177e4 655 pr_debug("PM: Image restored successfully.\n");
b918f6e6 656 }
64a473cb 657
b918f6e6 658 Thaw:
5a0a2f30 659 thaw_processes();
0709db60
RW
660 Finish:
661 free_basic_memory_bitmaps();
1bfcf130 662 usermodehelper_enable();
0709db60 663 Exit:
b10d9117 664 pm_notifier_call_chain(PM_POST_HIBERNATION);
5a0a2f30 665 pm_restore_console();
0709db60 666 atomic_inc(&snapshot_device_available);
b10d9117 667 Unlock:
bcda53fa 668 unlock_system_sleep();
1da177e4
LT
669 return error;
670}
671
672
673/**
f42a9813
RW
674 * software_resume - Resume from a saved hibernation image.
675 *
676 * This routine is called as a late initcall, when all devices have been
677 * discovered and initialized already.
1da177e4 678 *
f42a9813
RW
679 * The image reading code is called to see if there is a hibernation image
680 * available for reading. If that is the case, devices are quiesced and the
681 * contents of memory is restored from the saved image.
1da177e4 682 *
f42a9813
RW
683 * If this is successful, control reappears in the restored target kernel in
684 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
685 * attempts to recover gracefully and make the kernel return to the normal mode
686 * of operation.
1da177e4 687 */
1da177e4
LT
688static int software_resume(void)
689{
690 int error;
a634cc10 691 unsigned int flags;
1da177e4 692
eed3ee08
AV
693 /*
694 * If the user said "noresume".. bail out early.
695 */
696 if (noresume)
697 return 0;
698
60a0d233
JB
699 /*
700 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
701 * is configured into the kernel. Since the regular hibernate
702 * trigger path is via sysfs which takes a buffer mutex before
703 * calling hibernate functions (which take pm_mutex) this can
704 * cause lockdep to complain about a possible ABBA deadlock
705 * which cannot happen since we're in the boot code here and
706 * sysfs can't be invoked yet. Therefore, we use a subclass
707 * here to avoid lockdep complaining.
708 */
709 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
0c8454f5
RW
710
711 if (swsusp_resume_device)
712 goto Check_image;
713
714 if (!strlen(resume_file)) {
715 error = -ENOENT;
716 goto Unlock;
717 }
718
d0941ead 719 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
0c8454f5 720
f126f733
BS
721 if (resume_delay) {
722 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
723 resume_delay);
724 ssleep(resume_delay);
725 }
726
0c8454f5
RW
727 /* Check if the device is there */
728 swsusp_resume_device = name_to_dev_t(resume_file);
3efa147a 729 if (!swsusp_resume_device) {
eed3ee08
AV
730 /*
731 * Some device discovery might still be in progress; we need
732 * to wait for this to finish.
733 */
734 wait_for_device_probe();
6f8d7022
BS
735
736 if (resume_wait) {
737 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
738 msleep(10);
739 async_synchronize_full();
740 }
741
0c8454f5
RW
742 /*
743 * We can't depend on SCSI devices being available after loading
744 * one of their modules until scsi_complete_async_scans() is
745 * called and the resume device usually is a SCSI one.
746 */
747 scsi_complete_async_scans();
748
3efa147a 749 swsusp_resume_device = name_to_dev_t(resume_file);
0c8454f5
RW
750 if (!swsusp_resume_device) {
751 error = -ENODEV;
752 goto Unlock;
753 }
3efa147a
PM
754 }
755
0c8454f5 756 Check_image:
d0941ead 757 pr_debug("PM: Hibernation image partition %d:%d present\n",
0c8454f5 758 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
1da177e4 759
d0941ead 760 pr_debug("PM: Looking for hibernation image.\n");
ed746e3b
RW
761 error = swsusp_check();
762 if (error)
74dfd666 763 goto Unlock;
1da177e4 764
0709db60
RW
765 /* The snapshot device should not be opened while we're running */
766 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
767 error = -EBUSY;
76b57e61 768 swsusp_close(FMODE_READ);
0709db60
RW
769 goto Unlock;
770 }
771
5a0a2f30 772 pm_prepare_console();
c3e94d89
AS
773 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
774 if (error)
76b57e61 775 goto close_finish;
c3e94d89 776
1bfcf130
RW
777 error = usermodehelper_disable();
778 if (error)
76b57e61 779 goto close_finish;
1bfcf130 780
74dfd666 781 error = create_basic_memory_bitmaps();
0118521c
SB
782 if (error) {
783 usermodehelper_enable();
76b57e61 784 goto close_finish;
0118521c 785 }
1da177e4 786
74dfd666 787 pr_debug("PM: Preparing processes for restore.\n");
03afed8b 788 error = freeze_processes();
ed746e3b 789 if (error) {
c2dd0dae 790 swsusp_close(FMODE_READ);
5a72e04d 791 goto Done;
1da177e4
LT
792 }
793
d0941ead 794 pr_debug("PM: Loading hibernation image.\n");
1da177e4 795
a634cc10 796 error = swsusp_read(&flags);
76b57e61 797 swsusp_close(FMODE_READ);
ed746e3b 798 if (!error)
a634cc10 799 hibernation_restore(flags & SF_PLATFORM_MODE);
1da177e4 800
d0941ead 801 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
7777fab9 802 swsusp_free();
5a0a2f30 803 thaw_processes();
1da177e4 804 Done:
74dfd666 805 free_basic_memory_bitmaps();
1bfcf130 806 usermodehelper_enable();
0709db60 807 Finish:
c3e94d89 808 pm_notifier_call_chain(PM_POST_RESTORE);
5a0a2f30 809 pm_restore_console();
0709db60 810 atomic_inc(&snapshot_device_available);
dd5d666b 811 /* For success case, the suspend path will release the lock */
74dfd666 812 Unlock:
a6d70980 813 mutex_unlock(&pm_mutex);
d0941ead 814 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
7777fab9 815 return error;
76b57e61
JS
816close_finish:
817 swsusp_close(FMODE_READ);
818 goto Finish;
1da177e4
LT
819}
820
821late_initcall(software_resume);
822
823
a3d25c27
RW
824static const char * const hibernation_modes[] = {
825 [HIBERNATION_PLATFORM] = "platform",
826 [HIBERNATION_SHUTDOWN] = "shutdown",
827 [HIBERNATION_REBOOT] = "reboot",
1da177e4
LT
828};
829
f42a9813
RW
830/*
831 * /sys/power/disk - Control hibernation mode.
1da177e4 832 *
f42a9813
RW
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
48580ab8 836 * mostly).
1da177e4 837 *
f42a9813
RW
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
48580ab8 840 * to be printed. There are 3 modes that can be supported:
1da177e4 841 *
1da177e4
LT
842 * 'platform'
843 * 'shutdown'
844 * 'reboot'
845 *
f42a9813
RW
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.
1da177e4
LT
854 */
855
386f275f
KS
856static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
857 char *buf)
1da177e4 858{
f0ced9b2
JB
859 int i;
860 char *start = buf;
861
a3d25c27
RW
862 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
863 if (!hibernation_modes[i])
f0ced9b2
JB
864 continue;
865 switch (i) {
a3d25c27
RW
866 case HIBERNATION_SHUTDOWN:
867 case HIBERNATION_REBOOT:
f0ced9b2 868 break;
a3d25c27
RW
869 case HIBERNATION_PLATFORM:
870 if (hibernation_ops)
f0ced9b2
JB
871 break;
872 /* not a valid mode, continue with loop */
873 continue;
874 }
a3d25c27
RW
875 if (i == hibernation_mode)
876 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
f0ced9b2 877 else
a3d25c27 878 buf += sprintf(buf, "%s ", hibernation_modes[i]);
f0ced9b2
JB
879 }
880 buf += sprintf(buf, "\n");
881 return buf-start;
1da177e4
LT
882}
883
386f275f
KS
884static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
885 const char *buf, size_t n)
1da177e4
LT
886{
887 int error = 0;
888 int i;
889 int len;
890 char *p;
a3d25c27 891 int mode = HIBERNATION_INVALID;
1da177e4
LT
892
893 p = memchr(buf, '\n', n);
894 len = p ? p - buf : n;
895
bcda53fa 896 lock_system_sleep();
a3d25c27 897 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
8d98a690
RW
898 if (len == strlen(hibernation_modes[i])
899 && !strncmp(buf, hibernation_modes[i], len)) {
1da177e4
LT
900 mode = i;
901 break;
902 }
903 }
a3d25c27 904 if (mode != HIBERNATION_INVALID) {
fe0c935a 905 switch (mode) {
a3d25c27
RW
906 case HIBERNATION_SHUTDOWN:
907 case HIBERNATION_REBOOT:
a3d25c27 908 hibernation_mode = mode;
fe0c935a 909 break;
a3d25c27
RW
910 case HIBERNATION_PLATFORM:
911 if (hibernation_ops)
912 hibernation_mode = mode;
1da177e4
LT
913 else
914 error = -EINVAL;
915 }
a3d25c27 916 } else
1da177e4
LT
917 error = -EINVAL;
918
a3d25c27 919 if (!error)
23976728 920 pr_debug("PM: Hibernation mode set to '%s'\n",
a3d25c27 921 hibernation_modes[mode]);
bcda53fa 922 unlock_system_sleep();
1da177e4
LT
923 return error ? error : n;
924}
925
926power_attr(disk);
927
386f275f
KS
928static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
929 char *buf)
1da177e4
LT
930{
931 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
932 MINOR(swsusp_resume_device));
933}
934
386f275f
KS
935static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
936 const char *buf, size_t n)
1da177e4 937{
1da177e4 938 unsigned int maj, min;
1da177e4 939 dev_t res;
a576219a 940 int ret = -EINVAL;
1da177e4 941
a576219a
AM
942 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
943 goto out;
1da177e4 944
a576219a
AM
945 res = MKDEV(maj,min);
946 if (maj != MAJOR(res) || min != MINOR(res))
947 goto out;
1da177e4 948
bcda53fa 949 lock_system_sleep();
a576219a 950 swsusp_resume_device = res;
bcda53fa 951 unlock_system_sleep();
23976728 952 printk(KERN_INFO "PM: Starting manual resume from disk\n");
a576219a
AM
953 noresume = 0;
954 software_resume();
955 ret = n;
59a49335 956 out:
a576219a 957 return ret;
1da177e4
LT
958}
959
960power_attr(resume);
961
386f275f
KS
962static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
963 char *buf)
ca0aec0f 964{
853609b6 965 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
966}
967
386f275f
KS
968static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
969 const char *buf, size_t n)
ca0aec0f 970{
853609b6 971 unsigned long size;
ca0aec0f 972
853609b6 973 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
974 image_size = size;
975 return n;
976 }
977
978 return -EINVAL;
979}
980
981power_attr(image_size);
982
ddeb6487
RW
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
1da177e4
LT
1005static struct attribute * g[] = {
1006 &disk_attr.attr,
1007 &resume_attr.attr,
ca0aec0f 1008 &image_size_attr.attr,
ddeb6487 1009 &reserved_size_attr.attr,
1da177e4
LT
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{
d76e15fb 1021 return sysfs_create_group(power_kobj, &attr_group);
1da177e4
LT
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
9a154d9d
RW
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
f996fc96
BS
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
1da177e4
LT
1058static int __init noresume_setup(char *str)
1059{
1060 noresume = 1;
1061 return 1;
1062}
1063
6f8d7022
BS
1064static int __init resumewait_setup(char *str)
1065{
1066 resume_wait = 1;
1067 return 1;
1068}
1069
f126f733
BS
1070static int __init resumedelay_setup(char *str)
1071{
1072 resume_delay = simple_strtoul(str, NULL, 0);
1073 return 1;
1074}
1075
1da177e4 1076__setup("noresume", noresume_setup);
9a154d9d 1077__setup("resume_offset=", resume_offset_setup);
1da177e4 1078__setup("resume=", resume_setup);
f996fc96 1079__setup("hibernate=", hibernate_setup);
6f8d7022 1080__setup("resumewait", resumewait_setup);
f126f733 1081__setup("resumedelay=", resumedelay_setup);