]> bbs.cooldavid.org Git - net-next-2.6.git/blame - kernel/power/hibernate.c
hibernation: freeze swap at hibernation
[net-next-2.6.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
12#include <linux/suspend.h>
13#include <linux/syscalls.h>
14#include <linux/reboot.h>
15#include <linux/string.h>
16#include <linux/device.h>
1bfcf130 17#include <linux/kmod.h>
1da177e4
LT
18#include <linux/delay.h>
19#include <linux/fs.h>
d53d9f16 20#include <linux/mount.h>
88d10bba 21#include <linux/pm.h>
97c7801c 22#include <linux/console.h>
e3920fb4 23#include <linux/cpu.h>
7dfb7103 24#include <linux/freezer.h>
5a0e3ad6 25#include <linux/gfp.h>
c7510859 26#include <scsi/scsi_scan.h>
a8af7898 27#include <asm/suspend.h>
d53d9f16 28
1da177e4
LT
29#include "power.h"
30
31
1da177e4 32static int noresume = 0;
47a460d5 33static char resume_file[256] = CONFIG_PM_STD_PARTITION;
1da177e4 34dev_t swsusp_resume_device;
9a154d9d 35sector_t swsusp_resume_block;
8e60c6a1 36int in_suspend __nosavedata = 0;
1da177e4 37
a3d25c27
RW
38enum {
39 HIBERNATION_INVALID,
40 HIBERNATION_PLATFORM,
41 HIBERNATION_TEST,
42 HIBERNATION_TESTPROC,
43 HIBERNATION_SHUTDOWN,
44 HIBERNATION_REBOOT,
45 /* keep last */
46 __HIBERNATION_AFTER_LAST
47};
48#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
49#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
50
51static int hibernation_mode = HIBERNATION_SHUTDOWN;
52
b3dac3b3 53static struct platform_hibernation_ops *hibernation_ops;
a3d25c27
RW
54
55/**
56 * hibernation_set_ops - set the global hibernate operations
57 * @ops: the hibernation operations to use in subsequent hibernation transitions
58 */
59
b3dac3b3 60void hibernation_set_ops(struct platform_hibernation_ops *ops)
a3d25c27 61{
caea99ef
RW
62 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
63 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
74f270af 64 && ops->restore_cleanup)) {
a3d25c27
RW
65 WARN_ON(1);
66 return;
67 }
68 mutex_lock(&pm_mutex);
69 hibernation_ops = ops;
70 if (ops)
71 hibernation_mode = HIBERNATION_PLATFORM;
72 else if (hibernation_mode == HIBERNATION_PLATFORM)
73 hibernation_mode = HIBERNATION_SHUTDOWN;
74
75 mutex_unlock(&pm_mutex);
76}
77
abfe2d7b
RW
78static bool entering_platform_hibernation;
79
80bool system_entering_hibernation(void)
81{
82 return entering_platform_hibernation;
83}
84EXPORT_SYMBOL(system_entering_hibernation);
85
4cc79776
RW
86#ifdef CONFIG_PM_DEBUG
87static void hibernation_debug_sleep(void)
88{
89 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
90 mdelay(5000);
91}
92
93static int hibernation_testmode(int mode)
94{
95 if (hibernation_mode == mode) {
96 hibernation_debug_sleep();
97 return 1;
98 }
99 return 0;
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_testmode(int mode) { return 0; }
112static int hibernation_test(int level) { return 0; }
113#endif /* !CONFIG_PM_DEBUG */
114
74f270af 115/**
caea99ef 116 * platform_begin - tell the platform driver that we're starting
74f270af
RW
117 * hibernation
118 */
119
caea99ef 120static int platform_begin(int platform_mode)
74f270af
RW
121{
122 return (platform_mode && hibernation_ops) ?
caea99ef
RW
123 hibernation_ops->begin() : 0;
124}
125
126/**
127 * platform_end - tell the platform driver that we've entered the
128 * working state
129 */
130
131static void platform_end(int platform_mode)
132{
133 if (platform_mode && hibernation_ops)
134 hibernation_ops->end();
74f270af 135}
a3d25c27 136
8a05aac2 137/**
74f270af 138 * platform_pre_snapshot - prepare the machine for hibernation using the
8a05aac2
SS
139 * platform driver if so configured and return an error code if it fails
140 */
141
74f270af 142static int platform_pre_snapshot(int platform_mode)
8a05aac2 143{
7777fab9 144 return (platform_mode && hibernation_ops) ?
74f270af 145 hibernation_ops->pre_snapshot() : 0;
a3d25c27 146}
8a05aac2 147
c7e0831d
RW
148/**
149 * platform_leave - prepare the machine for switching to the normal mode
150 * of operation using the platform driver (called with interrupts disabled)
151 */
152
153static void platform_leave(int platform_mode)
154{
155 if (platform_mode && hibernation_ops)
156 hibernation_ops->leave();
157}
158
a3d25c27
RW
159/**
160 * platform_finish - switch the machine to the normal mode of operation
161 * using the platform driver (must be called after platform_prepare())
162 */
163
7777fab9 164static void platform_finish(int platform_mode)
a3d25c27 165{
7777fab9 166 if (platform_mode && hibernation_ops)
a3d25c27 167 hibernation_ops->finish();
8a05aac2
SS
168}
169
a634cc10
RW
170/**
171 * platform_pre_restore - prepare the platform for the restoration from a
172 * hibernation image. If the restore fails after this function has been
173 * called, platform_restore_cleanup() must be called.
174 */
175
176static int platform_pre_restore(int platform_mode)
177{
178 return (platform_mode && hibernation_ops) ?
179 hibernation_ops->pre_restore() : 0;
180}
181
182/**
183 * platform_restore_cleanup - switch the platform to the normal mode of
184 * operation after a failing restore. If platform_pre_restore() has been
185 * called before the failing restore, this function must be called too,
186 * regardless of the result of platform_pre_restore().
187 */
188
189static void platform_restore_cleanup(int platform_mode)
190{
191 if (platform_mode && hibernation_ops)
192 hibernation_ops->restore_cleanup();
193}
194
d8f3de0d
RW
195/**
196 * platform_recover - recover the platform from a failure to suspend
197 * devices.
198 */
199
200static void platform_recover(int platform_mode)
201{
202 if (platform_mode && hibernation_ops && hibernation_ops->recover)
203 hibernation_ops->recover();
204}
205
8e60c6a1
NC
206/**
207 * swsusp_show_speed - print the time elapsed between two events.
208 * @start: Starting event.
209 * @stop: Final event.
210 * @nr_pages - number of pages processed between @start and @stop
211 * @msg - introductory message to print
212 */
213
214void swsusp_show_speed(struct timeval *start, struct timeval *stop,
215 unsigned nr_pages, char *msg)
216{
217 s64 elapsed_centisecs64;
218 int centisecs;
219 int k;
220 int kps;
221
222 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
223 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
224 centisecs = elapsed_centisecs64;
225 if (centisecs == 0)
226 centisecs = 1; /* avoid div-by-zero */
227 k = nr_pages * (PAGE_SIZE / 1024);
228 kps = (k * 100) / centisecs;
229 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
230 msg, k,
231 centisecs / 100, centisecs % 100,
232 kps / 1000, (kps % 1000) / 10);
233}
234
c7e0831d
RW
235/**
236 * create_image - freeze devices that need to be frozen with interrupts
237 * off, create the hibernation image and thaw those devices. Control
238 * reappears in this routine after a restore.
239 */
240
47a460d5 241static int create_image(int platform_mode)
c7e0831d
RW
242{
243 int error;
244
245 error = arch_prepare_suspend();
246 if (error)
247 return error;
248
d1616302
AS
249 /* At this point, dpm_suspend_start() has been called, but *not*
250 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
c7e0831d
RW
251 * Otherwise, drivers for some devices (e.g. interrupt controllers)
252 * become desynchronized with the actual state of the hardware
253 * at resume time, and evil weirdness ensues.
254 */
d1616302 255 error = dpm_suspend_noirq(PMSG_FREEZE);
c7e0831d 256 if (error) {
23976728
RW
257 printk(KERN_ERR "PM: Some devices failed to power down, "
258 "aborting hibernation\n");
32bdfac5 259 return error;
c7e0831d 260 }
2ed8d2b3 261
4aecd671
RW
262 error = platform_pre_snapshot(platform_mode);
263 if (error || hibernation_test(TEST_PLATFORM))
264 goto Platform_finish;
265
266 error = disable_nonboot_cpus();
267 if (error || hibernation_test(TEST_CPUS)
268 || hibernation_testmode(HIBERNATION_TEST))
269 goto Enable_cpus;
270
2ed8d2b3
RW
271 local_irq_disable();
272
4484079d 273 error = sysdev_suspend(PMSG_FREEZE);
770824bd 274 if (error) {
4484079d 275 printk(KERN_ERR "PM: Some system devices failed to power down, "
770824bd 276 "aborting hibernation\n");
4aecd671 277 goto Enable_irqs;
770824bd 278 }
c7e0831d 279
c125e96f 280 if (hibernation_test(TEST_CORE) || !pm_check_wakeup_events())
4cc79776
RW
281 goto Power_up;
282
283 in_suspend = 1;
c7e0831d
RW
284 save_processor_state();
285 error = swsusp_arch_suspend();
286 if (error)
23976728
RW
287 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
288 error);
c7e0831d
RW
289 /* Restore control flow magically appears here */
290 restore_processor_state();
c125e96f
RW
291 if (!in_suspend) {
292 events_check_enabled = false;
c7e0831d 293 platform_leave(platform_mode);
c125e96f 294 }
4aecd671 295
4cc79776 296 Power_up:
770824bd 297 sysdev_resume();
d1616302 298 /* NOTE: dpm_resume_noirq() is just a resume() for devices
c7e0831d
RW
299 * that suspended with irqs off ... no overall powerup.
300 */
2ed8d2b3 301
4aecd671 302 Enable_irqs:
2ed8d2b3
RW
303 local_irq_enable();
304
4aecd671
RW
305 Enable_cpus:
306 enable_nonboot_cpus();
307
308 Platform_finish:
309 platform_finish(platform_mode);
310
d1616302 311 dpm_resume_noirq(in_suspend ?
1eede070 312 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
2ed8d2b3 313
c7e0831d
RW
314 return error;
315}
316
7777fab9
RW
317/**
318 * hibernation_snapshot - quiesce devices and create the hibernation
319 * snapshot image.
320 * @platform_mode - if set, use the platform driver, if available, to
877d0310 321 * prepare the platform firmware for the power transition.
7777fab9
RW
322 *
323 * Must be called with pm_mutex held
324 */
325
326int hibernation_snapshot(int platform_mode)
327{
cbe2f5a6 328 int error;
452aa699 329 gfp_t saved_mask;
7777fab9 330
3fe0313e 331 error = platform_begin(platform_mode);
7777fab9 332 if (error)
d074ee02 333 goto Close;
7777fab9 334
64a473cb
RW
335 /* Preallocate image memory before shutting down devices. */
336 error = hibernate_preallocate_memory();
74f270af 337 if (error)
caea99ef 338 goto Close;
74f270af 339
7777fab9 340 suspend_console();
d2997b10 341 hibernation_freeze_swap();
452aa699 342 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
d1616302 343 error = dpm_suspend_start(PMSG_FREEZE);
10a1803d 344 if (error)
d8f3de0d 345 goto Recover_platform;
10a1803d 346
4cc79776 347 if (hibernation_test(TEST_DEVICES))
d8f3de0d 348 goto Recover_platform;
7777fab9 349
4aecd671
RW
350 error = create_image(platform_mode);
351 /* Control returns here after successful restore */
4cc79776 352
4cc79776 353 Resume_devices:
64a473cb
RW
354 /* We may need to release the preallocated image pages here. */
355 if (error || !in_suspend)
356 swsusp_free();
357
d1616302 358 dpm_resume_end(in_suspend ?
1eede070 359 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
452aa699 360 set_gfp_allowed_mask(saved_mask);
7777fab9 361 resume_console();
caea99ef
RW
362 Close:
363 platform_end(platform_mode);
7777fab9 364 return error;
d8f3de0d
RW
365
366 Recover_platform:
367 platform_recover(platform_mode);
368 goto Resume_devices;
7777fab9
RW
369}
370
72df68ca
RW
371/**
372 * resume_target_kernel - prepare devices that need to be suspended with
373 * interrupts off, restore the contents of highmem that have not been
374 * restored yet from the image and run the low level code that will restore
375 * the remaining contents of memory and switch to the just restored target
376 * kernel.
377 */
378
4aecd671 379static int resume_target_kernel(bool platform_mode)
72df68ca
RW
380{
381 int error;
382
d1616302 383 error = dpm_suspend_noirq(PMSG_QUIESCE);
72df68ca 384 if (error) {
23976728 385 printk(KERN_ERR "PM: Some devices failed to power down, "
72df68ca 386 "aborting resume\n");
32bdfac5 387 return error;
72df68ca 388 }
2ed8d2b3 389
4aecd671
RW
390 error = platform_pre_restore(platform_mode);
391 if (error)
392 goto Cleanup;
393
394 error = disable_nonboot_cpus();
395 if (error)
396 goto Enable_cpus;
397
2ed8d2b3
RW
398 local_irq_disable();
399
4aecd671
RW
400 error = sysdev_suspend(PMSG_QUIESCE);
401 if (error)
402 goto Enable_irqs;
403
72df68ca
RW
404 /* We'll ignore saved state, but this gets preempt count (etc) right */
405 save_processor_state();
406 error = restore_highmem();
407 if (!error) {
408 error = swsusp_arch_resume();
409 /*
410 * The code below is only ever reached in case of a failure.
411 * Otherwise execution continues at place where
412 * swsusp_arch_suspend() was called
413 */
414 BUG_ON(!error);
415 /* This call to restore_highmem() undos the previous one */
416 restore_highmem();
417 }
418 /*
419 * The only reason why swsusp_arch_resume() can fail is memory being
420 * very tight, so we have to free it as soon as we can to avoid
421 * subsequent failures
422 */
423 swsusp_free();
424 restore_processor_state();
425 touch_softlockup_watchdog();
2ed8d2b3 426
770824bd 427 sysdev_resume();
2ed8d2b3 428
4aecd671 429 Enable_irqs:
72df68ca 430 local_irq_enable();
2ed8d2b3 431
4aecd671
RW
432 Enable_cpus:
433 enable_nonboot_cpus();
434
435 Cleanup:
436 platform_restore_cleanup(platform_mode);
437
d1616302 438 dpm_resume_noirq(PMSG_RECOVER);
2ed8d2b3 439
72df68ca
RW
440 return error;
441}
442
7777fab9
RW
443/**
444 * hibernation_restore - quiesce devices and restore the hibernation
445 * snapshot image. If successful, control returns in hibernation_snaphot()
a634cc10 446 * @platform_mode - if set, use the platform driver, if available, to
877d0310 447 * prepare the platform firmware for the transition.
7777fab9
RW
448 *
449 * Must be called with pm_mutex held
450 */
451
a634cc10 452int hibernation_restore(int platform_mode)
7777fab9 453{
cbe2f5a6 454 int error;
452aa699 455 gfp_t saved_mask;
7777fab9
RW
456
457 pm_prepare_console();
458 suspend_console();
452aa699 459 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
d1616302 460 error = dpm_suspend_start(PMSG_QUIESCE);
a634cc10 461 if (!error) {
4aecd671 462 error = resume_target_kernel(platform_mode);
d1616302 463 dpm_resume_end(PMSG_RECOVER);
a634cc10 464 }
452aa699 465 set_gfp_allowed_mask(saved_mask);
7777fab9
RW
466 resume_console();
467 pm_restore_console();
468 return error;
469}
470
471/**
472 * hibernation_platform_enter - enter the hibernation state using the
473 * platform driver (if available)
474 */
475
476int hibernation_platform_enter(void)
477{
cbe2f5a6 478 int error;
452aa699 479 gfp_t saved_mask;
b1457bcc 480
9cd9a005
RW
481 if (!hibernation_ops)
482 return -ENOSYS;
483
484 /*
485 * We have cancelled the power transition by running
486 * hibernation_ops->finish() before saving the image, so we should let
487 * the firmware know that we're going to enter the sleep state after all
488 */
caea99ef 489 error = hibernation_ops->begin();
9cd9a005 490 if (error)
caea99ef 491 goto Close;
9cd9a005 492
abfe2d7b 493 entering_platform_hibernation = true;
9cd9a005 494 suspend_console();
452aa699 495 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
d1616302 496 error = dpm_suspend_start(PMSG_HIBERNATE);
d8f3de0d
RW
497 if (error) {
498 if (hibernation_ops->recover)
499 hibernation_ops->recover();
500 goto Resume_devices;
501 }
9cd9a005 502
d1616302 503 error = dpm_suspend_noirq(PMSG_HIBERNATE);
4aecd671 504 if (error)
32bdfac5 505 goto Resume_devices;
4aecd671 506
9cd9a005
RW
507 error = hibernation_ops->prepare();
508 if (error)
e681c9dd 509 goto Platform_finish;
9cd9a005
RW
510
511 error = disable_nonboot_cpus();
512 if (error)
e681c9dd 513 goto Platform_finish;
2ed8d2b3 514
4aecd671
RW
515 local_irq_disable();
516 sysdev_suspend(PMSG_HIBERNATE);
c125e96f
RW
517 if (!pm_check_wakeup_events()) {
518 error = -EAGAIN;
519 goto Power_up;
520 }
521
4aecd671
RW
522 hibernation_ops->enter();
523 /* We should never get here */
524 while (1);
9cd9a005 525
c125e96f
RW
526 Power_up:
527 sysdev_resume();
528 local_irq_enable();
529 enable_nonboot_cpus();
530
e681c9dd 531 Platform_finish:
9cd9a005 532 hibernation_ops->finish();
2ed8d2b3 533
f6f71f18 534 dpm_resume_noirq(PMSG_RESTORE);
4aecd671 535
9cd9a005 536 Resume_devices:
abfe2d7b 537 entering_platform_hibernation = false;
d1616302 538 dpm_resume_end(PMSG_RESTORE);
452aa699 539 set_gfp_allowed_mask(saved_mask);
9cd9a005 540 resume_console();
2ed8d2b3 541
caea99ef
RW
542 Close:
543 hibernation_ops->end();
2ed8d2b3 544
b1457bcc 545 return error;
7777fab9
RW
546}
547
1da177e4 548/**
a3d25c27 549 * power_down - Shut the machine down for hibernation.
1da177e4 550 *
fe0c935a
JB
551 * Use the platform driver, if configured so; otherwise try
552 * to power off or reboot.
1da177e4
LT
553 */
554
fe0c935a 555static void power_down(void)
1da177e4 556{
a3d25c27
RW
557 switch (hibernation_mode) {
558 case HIBERNATION_TEST:
559 case HIBERNATION_TESTPROC:
fe0c935a 560 break;
a3d25c27 561 case HIBERNATION_REBOOT:
fdde86ac 562 kernel_restart(NULL);
1da177e4 563 break;
a3d25c27 564 case HIBERNATION_PLATFORM:
7777fab9 565 hibernation_platform_enter();
9cd9a005
RW
566 case HIBERNATION_SHUTDOWN:
567 kernel_power_off();
568 break;
1da177e4 569 }
fdde86ac 570 kernel_halt();
fe0c935a
JB
571 /*
572 * Valid image is on the disk, if we continue we risk serious data
573 * corruption after resume.
574 */
23976728 575 printk(KERN_CRIT "PM: Please power down manually\n");
1da177e4
LT
576 while(1);
577}
578
1da177e4
LT
579static int prepare_processes(void)
580{
b918f6e6 581 int error = 0;
1da177e4 582
1da177e4
LT
583 if (freeze_processes()) {
584 error = -EBUSY;
5a0a2f30 585 thaw_processes();
1da177e4 586 }
5a72e04d 587 return error;
1da177e4
LT
588}
589
1da177e4 590/**
a3d25c27 591 * hibernate - The granpappy of the built-in hibernation management
1da177e4
LT
592 */
593
a3d25c27 594int hibernate(void)
1da177e4
LT
595{
596 int error;
597
b10d9117 598 mutex_lock(&pm_mutex);
0709db60 599 /* The snapshot device should not be opened while we're running */
b10d9117
RW
600 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
601 error = -EBUSY;
602 goto Unlock;
603 }
604
5a0a2f30 605 pm_prepare_console();
b10d9117
RW
606 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
607 if (error)
608 goto Exit;
0709db60 609
1bfcf130
RW
610 error = usermodehelper_disable();
611 if (error)
612 goto Exit;
613
0709db60
RW
614 /* Allocate memory management structures */
615 error = create_basic_memory_bitmaps();
616 if (error)
617 goto Exit;
618
23976728 619 printk(KERN_INFO "PM: Syncing filesystems ... ");
232b1432
RW
620 sys_sync();
621 printk("done.\n");
622
1da177e4 623 error = prepare_processes();
5a72e04d 624 if (error)
0709db60 625 goto Finish;
1da177e4 626
4cc79776 627 if (hibernation_test(TEST_FREEZER))
ed746e3b 628 goto Thaw;
4cc79776
RW
629
630 if (hibernation_testmode(HIBERNATION_TESTPROC))
631 goto Thaw;
632
7777fab9 633 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
64a473cb
RW
634 if (error)
635 goto Thaw;
636
637 if (in_suspend) {
a634cc10
RW
638 unsigned int flags = 0;
639
640 if (hibernation_mode == HIBERNATION_PLATFORM)
641 flags |= SF_PLATFORM_MODE;
1da177e4 642 pr_debug("PM: writing image.\n");
a634cc10 643 error = swsusp_write(flags);
7777fab9 644 swsusp_free();
1da177e4 645 if (!error)
fe0c935a 646 power_down();
b918f6e6 647 } else {
1da177e4 648 pr_debug("PM: Image restored successfully.\n");
b918f6e6 649 }
64a473cb 650
b918f6e6 651 Thaw:
5a0a2f30 652 thaw_processes();
0709db60
RW
653 Finish:
654 free_basic_memory_bitmaps();
1bfcf130 655 usermodehelper_enable();
0709db60 656 Exit:
b10d9117 657 pm_notifier_call_chain(PM_POST_HIBERNATION);
5a0a2f30 658 pm_restore_console();
0709db60 659 atomic_inc(&snapshot_device_available);
b10d9117
RW
660 Unlock:
661 mutex_unlock(&pm_mutex);
1da177e4
LT
662 return error;
663}
664
665
666/**
667 * software_resume - Resume from a saved image.
668 *
669 * Called as a late_initcall (so all devices are discovered and
670 * initialized), we call swsusp to see if we have a saved image or not.
671 * If so, we quiesce devices, the restore the saved image. We will
a3d25c27 672 * return above (in hibernate() ) if everything goes well.
1da177e4
LT
673 * Otherwise, we fail gracefully and return to the normally
674 * scheduled program.
675 *
676 */
677
678static int software_resume(void)
679{
680 int error;
a634cc10 681 unsigned int flags;
1da177e4 682
eed3ee08
AV
683 /*
684 * If the user said "noresume".. bail out early.
685 */
686 if (noresume)
687 return 0;
688
60a0d233
JB
689 /*
690 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
691 * is configured into the kernel. Since the regular hibernate
692 * trigger path is via sysfs which takes a buffer mutex before
693 * calling hibernate functions (which take pm_mutex) this can
694 * cause lockdep to complain about a possible ABBA deadlock
695 * which cannot happen since we're in the boot code here and
696 * sysfs can't be invoked yet. Therefore, we use a subclass
697 * here to avoid lockdep complaining.
698 */
699 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
0c8454f5
RW
700
701 if (swsusp_resume_device)
702 goto Check_image;
703
704 if (!strlen(resume_file)) {
705 error = -ENOENT;
706 goto Unlock;
707 }
708
709 pr_debug("PM: Checking image partition %s\n", resume_file);
710
711 /* Check if the device is there */
712 swsusp_resume_device = name_to_dev_t(resume_file);
3efa147a 713 if (!swsusp_resume_device) {
eed3ee08
AV
714 /*
715 * Some device discovery might still be in progress; we need
716 * to wait for this to finish.
717 */
718 wait_for_device_probe();
0c8454f5
RW
719 /*
720 * We can't depend on SCSI devices being available after loading
721 * one of their modules until scsi_complete_async_scans() is
722 * called and the resume device usually is a SCSI one.
723 */
724 scsi_complete_async_scans();
725
3efa147a 726 swsusp_resume_device = name_to_dev_t(resume_file);
0c8454f5
RW
727 if (!swsusp_resume_device) {
728 error = -ENODEV;
729 goto Unlock;
730 }
3efa147a
PM
731 }
732
0c8454f5
RW
733 Check_image:
734 pr_debug("PM: Resume from partition %d:%d\n",
735 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
1da177e4 736
23976728 737 pr_debug("PM: Checking hibernation image.\n");
ed746e3b
RW
738 error = swsusp_check();
739 if (error)
74dfd666 740 goto Unlock;
1da177e4 741
0709db60
RW
742 /* The snapshot device should not be opened while we're running */
743 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
744 error = -EBUSY;
76b57e61 745 swsusp_close(FMODE_READ);
0709db60
RW
746 goto Unlock;
747 }
748
5a0a2f30 749 pm_prepare_console();
c3e94d89
AS
750 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
751 if (error)
76b57e61 752 goto close_finish;
c3e94d89 753
1bfcf130
RW
754 error = usermodehelper_disable();
755 if (error)
76b57e61 756 goto close_finish;
1bfcf130 757
74dfd666
RW
758 error = create_basic_memory_bitmaps();
759 if (error)
76b57e61 760 goto close_finish;
1da177e4 761
74dfd666 762 pr_debug("PM: Preparing processes for restore.\n");
ed746e3b
RW
763 error = prepare_processes();
764 if (error) {
c2dd0dae 765 swsusp_close(FMODE_READ);
5a72e04d 766 goto Done;
1da177e4
LT
767 }
768
23976728 769 pr_debug("PM: Reading hibernation image.\n");
1da177e4 770
a634cc10 771 error = swsusp_read(&flags);
76b57e61 772 swsusp_close(FMODE_READ);
ed746e3b 773 if (!error)
a634cc10 774 hibernation_restore(flags & SF_PLATFORM_MODE);
1da177e4 775
ed746e3b 776 printk(KERN_ERR "PM: Restore failed, recovering.\n");
7777fab9 777 swsusp_free();
5a0a2f30 778 thaw_processes();
1da177e4 779 Done:
74dfd666 780 free_basic_memory_bitmaps();
1bfcf130 781 usermodehelper_enable();
0709db60 782 Finish:
c3e94d89 783 pm_notifier_call_chain(PM_POST_RESTORE);
5a0a2f30 784 pm_restore_console();
0709db60 785 atomic_inc(&snapshot_device_available);
dd5d666b 786 /* For success case, the suspend path will release the lock */
74dfd666 787 Unlock:
a6d70980 788 mutex_unlock(&pm_mutex);
1da177e4 789 pr_debug("PM: Resume from disk failed.\n");
7777fab9 790 return error;
76b57e61
JS
791close_finish:
792 swsusp_close(FMODE_READ);
793 goto Finish;
1da177e4
LT
794}
795
796late_initcall(software_resume);
797
798
a3d25c27
RW
799static const char * const hibernation_modes[] = {
800 [HIBERNATION_PLATFORM] = "platform",
801 [HIBERNATION_SHUTDOWN] = "shutdown",
802 [HIBERNATION_REBOOT] = "reboot",
803 [HIBERNATION_TEST] = "test",
804 [HIBERNATION_TESTPROC] = "testproc",
1da177e4
LT
805};
806
807/**
a3d25c27 808 * disk - Control hibernation mode
1da177e4 809 *
11d77d0c
JB
810 * Suspend-to-disk can be handled in several ways. We have a few options
811 * for putting the system to sleep - using the platform driver (e.g. ACPI
a3d25c27
RW
812 * or other hibernation_ops), powering off the system or rebooting the
813 * system (for testing) as well as the two test modes.
1da177e4 814 *
11d77d0c 815 * The system can support 'platform', and that is known a priori (and
a3d25c27
RW
816 * encoded by the presence of hibernation_ops). However, the user may
817 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
818 * test modes, 'test' or 'testproc'.
1da177e4
LT
819 *
820 * show() will display what the mode is currently set to.
821 * store() will accept one of
822 *
1da177e4
LT
823 * 'platform'
824 * 'shutdown'
825 * 'reboot'
11d77d0c
JB
826 * 'test'
827 * 'testproc'
1da177e4 828 *
11d77d0c 829 * It will only change to 'platform' if the system
a3d25c27 830 * supports it (as determined by having hibernation_ops).
1da177e4
LT
831 */
832
386f275f
KS
833static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
834 char *buf)
1da177e4 835{
f0ced9b2
JB
836 int i;
837 char *start = buf;
838
a3d25c27
RW
839 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
840 if (!hibernation_modes[i])
f0ced9b2
JB
841 continue;
842 switch (i) {
a3d25c27
RW
843 case HIBERNATION_SHUTDOWN:
844 case HIBERNATION_REBOOT:
845 case HIBERNATION_TEST:
846 case HIBERNATION_TESTPROC:
f0ced9b2 847 break;
a3d25c27
RW
848 case HIBERNATION_PLATFORM:
849 if (hibernation_ops)
f0ced9b2
JB
850 break;
851 /* not a valid mode, continue with loop */
852 continue;
853 }
a3d25c27
RW
854 if (i == hibernation_mode)
855 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
f0ced9b2 856 else
a3d25c27 857 buf += sprintf(buf, "%s ", hibernation_modes[i]);
f0ced9b2
JB
858 }
859 buf += sprintf(buf, "\n");
860 return buf-start;
1da177e4
LT
861}
862
863
386f275f
KS
864static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
865 const char *buf, size_t n)
1da177e4
LT
866{
867 int error = 0;
868 int i;
869 int len;
870 char *p;
a3d25c27 871 int mode = HIBERNATION_INVALID;
1da177e4
LT
872
873 p = memchr(buf, '\n', n);
874 len = p ? p - buf : n;
875
a6d70980 876 mutex_lock(&pm_mutex);
a3d25c27 877 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
8d98a690
RW
878 if (len == strlen(hibernation_modes[i])
879 && !strncmp(buf, hibernation_modes[i], len)) {
1da177e4
LT
880 mode = i;
881 break;
882 }
883 }
a3d25c27 884 if (mode != HIBERNATION_INVALID) {
fe0c935a 885 switch (mode) {
a3d25c27
RW
886 case HIBERNATION_SHUTDOWN:
887 case HIBERNATION_REBOOT:
888 case HIBERNATION_TEST:
889 case HIBERNATION_TESTPROC:
890 hibernation_mode = mode;
fe0c935a 891 break;
a3d25c27
RW
892 case HIBERNATION_PLATFORM:
893 if (hibernation_ops)
894 hibernation_mode = mode;
1da177e4
LT
895 else
896 error = -EINVAL;
897 }
a3d25c27 898 } else
1da177e4
LT
899 error = -EINVAL;
900
a3d25c27 901 if (!error)
23976728 902 pr_debug("PM: Hibernation mode set to '%s'\n",
a3d25c27 903 hibernation_modes[mode]);
a6d70980 904 mutex_unlock(&pm_mutex);
1da177e4
LT
905 return error ? error : n;
906}
907
908power_attr(disk);
909
386f275f
KS
910static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
911 char *buf)
1da177e4
LT
912{
913 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
914 MINOR(swsusp_resume_device));
915}
916
386f275f
KS
917static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
918 const char *buf, size_t n)
1da177e4 919{
1da177e4 920 unsigned int maj, min;
1da177e4 921 dev_t res;
a576219a 922 int ret = -EINVAL;
1da177e4 923
a576219a
AM
924 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
925 goto out;
1da177e4 926
a576219a
AM
927 res = MKDEV(maj,min);
928 if (maj != MAJOR(res) || min != MINOR(res))
929 goto out;
1da177e4 930
a6d70980 931 mutex_lock(&pm_mutex);
a576219a 932 swsusp_resume_device = res;
a6d70980 933 mutex_unlock(&pm_mutex);
23976728 934 printk(KERN_INFO "PM: Starting manual resume from disk\n");
a576219a
AM
935 noresume = 0;
936 software_resume();
937 ret = n;
59a49335 938 out:
a576219a 939 return ret;
1da177e4
LT
940}
941
942power_attr(resume);
943
386f275f
KS
944static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
945 char *buf)
ca0aec0f 946{
853609b6 947 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
948}
949
386f275f
KS
950static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
951 const char *buf, size_t n)
ca0aec0f 952{
853609b6 953 unsigned long size;
ca0aec0f 954
853609b6 955 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
956 image_size = size;
957 return n;
958 }
959
960 return -EINVAL;
961}
962
963power_attr(image_size);
964
1da177e4
LT
965static struct attribute * g[] = {
966 &disk_attr.attr,
967 &resume_attr.attr,
ca0aec0f 968 &image_size_attr.attr,
1da177e4
LT
969 NULL,
970};
971
972
973static struct attribute_group attr_group = {
974 .attrs = g,
975};
976
977
978static int __init pm_disk_init(void)
979{
d76e15fb 980 return sysfs_create_group(power_kobj, &attr_group);
1da177e4
LT
981}
982
983core_initcall(pm_disk_init);
984
985
986static int __init resume_setup(char *str)
987{
988 if (noresume)
989 return 1;
990
991 strncpy( resume_file, str, 255 );
992 return 1;
993}
994
9a154d9d
RW
995static int __init resume_offset_setup(char *str)
996{
997 unsigned long long offset;
998
999 if (noresume)
1000 return 1;
1001
1002 if (sscanf(str, "%llu", &offset) == 1)
1003 swsusp_resume_block = offset;
1004
1005 return 1;
1006}
1007
1da177e4
LT
1008static int __init noresume_setup(char *str)
1009{
1010 noresume = 1;
1011 return 1;
1012}
1013
1014__setup("noresume", noresume_setup);
9a154d9d 1015__setup("resume_offset=", resume_offset_setup);
1da177e4 1016__setup("resume=", resume_setup);