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