]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - kernel/power/user.c
Merge tag 'jfs-3.12' of git://github.com/kleikamp/linux-shaggy
[mirror_ubuntu-eoan-kernel.git] / kernel / power / user.c
CommitLineData
6e1819d6
RW
1/*
2 * linux/kernel/power/user.c
3 *
4 * This file provides the user space interface for software suspend/resume.
5 *
6 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
7 *
8 * This file is released under the GPLv2.
9 *
10 */
11
12#include <linux/suspend.h>
13#include <linux/syscalls.h>
3592695c 14#include <linux/reboot.h>
6e1819d6
RW
15#include <linux/string.h>
16#include <linux/device.h>
17#include <linux/miscdevice.h>
18#include <linux/mm.h>
19#include <linux/swap.h>
20#include <linux/swapops.h>
21#include <linux/pm.h>
22#include <linux/fs.h>
c336078b 23#include <linux/compat.h>
97c7801c 24#include <linux/console.h>
e3920fb4 25#include <linux/cpu.h>
7dfb7103 26#include <linux/freezer.h>
6e1819d6
RW
27
28#include <asm/uaccess.h>
29
30#include "power.h"
31
eb57c1cf 32
6e1819d6
RW
33#define SNAPSHOT_MINOR 231
34
35static struct snapshot_data {
36 struct snapshot_handle handle;
37 int swap;
6e1819d6
RW
38 int mode;
39 char frozen;
40 char ready;
eb57c1cf 41 char platform_support;
aab17289 42 bool free_bitmaps;
6e1819d6
RW
43} snapshot_state;
44
0709db60 45atomic_t snapshot_device_available = ATOMIC_INIT(1);
6e1819d6
RW
46
47static int snapshot_open(struct inode *inode, struct file *filp)
48{
49 struct snapshot_data *data;
c3e94d89 50 int error;
6e1819d6 51
bcda53fa 52 lock_system_sleep();
25f2f3da
RW
53
54 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
55 error = -EBUSY;
56 goto Unlock;
57 }
6e1819d6 58
1525a2ad 59 if ((filp->f_flags & O_ACCMODE) == O_RDWR) {
0709db60 60 atomic_inc(&snapshot_device_available);
25f2f3da
RW
61 error = -ENOSYS;
62 goto Unlock;
1525a2ad 63 }
6e1819d6
RW
64 nonseekable_open(inode, filp);
65 data = &snapshot_state;
66 filp->private_data = data;
67 memset(&data->handle, 0, sizeof(struct snapshot_handle));
68 if ((filp->f_flags & O_ACCMODE) == O_RDONLY) {
c7510859 69 /* Hibernating. The image device should be accessible. */
915bae9e 70 data->swap = swsusp_resume_device ?
7bf23687 71 swap_type_of(swsusp_resume_device, 0, NULL) : -1;
6e1819d6 72 data->mode = O_RDONLY;
ebae2604 73 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
c3e94d89 74 if (error)
ebae2604 75 pm_notifier_call_chain(PM_POST_HIBERNATION);
6e1819d6 76 } else {
c7510859
RW
77 /*
78 * Resuming. We may need to wait for the image device to
79 * appear.
80 */
81 wait_for_device_probe();
c7510859 82
6e1819d6
RW
83 data->swap = -1;
84 data->mode = O_WRONLY;
ebae2604 85 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
aab17289
RW
86 if (!error) {
87 error = create_basic_memory_bitmaps();
88 data->free_bitmaps = !error;
89 }
c3e94d89 90 if (error)
ebae2604 91 pm_notifier_call_chain(PM_POST_RESTORE);
c3e94d89 92 }
8fd37a4c 93 if (error)
c3e94d89 94 atomic_inc(&snapshot_device_available);
8fd37a4c 95
6e1819d6
RW
96 data->frozen = 0;
97 data->ready = 0;
eb57c1cf 98 data->platform_support = 0;
6e1819d6 99
25f2f3da 100 Unlock:
bcda53fa 101 unlock_system_sleep();
25f2f3da
RW
102
103 return error;
6e1819d6
RW
104}
105
106static int snapshot_release(struct inode *inode, struct file *filp)
107{
108 struct snapshot_data *data;
109
bcda53fa 110 lock_system_sleep();
25f2f3da 111
6e1819d6
RW
112 swsusp_free();
113 data = filp->private_data;
d1d241cc 114 free_all_swap_pages(data->swap);
9744997a
RW
115 if (data->frozen) {
116 pm_restore_gfp_mask();
8fd37a4c 117 free_basic_memory_bitmaps();
6e1819d6 118 thaw_processes();
aab17289
RW
119 } else if (data->free_bitmaps) {
120 free_basic_memory_bitmaps();
9744997a 121 }
1497dd1d 122 pm_notifier_call_chain(data->mode == O_RDONLY ?
c3e94d89 123 PM_POST_HIBERNATION : PM_POST_RESTORE);
0709db60 124 atomic_inc(&snapshot_device_available);
25f2f3da 125
bcda53fa 126 unlock_system_sleep();
25f2f3da 127
6e1819d6
RW
128 return 0;
129}
130
131static ssize_t snapshot_read(struct file *filp, char __user *buf,
132 size_t count, loff_t *offp)
133{
134 struct snapshot_data *data;
135 ssize_t res;
d3c1b24c 136 loff_t pg_offp = *offp & ~PAGE_MASK;
6e1819d6 137
bcda53fa 138 lock_system_sleep();
25f2f3da 139
6e1819d6 140 data = filp->private_data;
25f2f3da
RW
141 if (!data->ready) {
142 res = -ENODATA;
143 goto Unlock;
144 }
d3c1b24c
JS
145 if (!pg_offp) { /* on page boundary? */
146 res = snapshot_read_next(&data->handle);
147 if (res <= 0)
148 goto Unlock;
149 } else {
150 res = PAGE_SIZE - pg_offp;
6e1819d6 151 }
25f2f3da 152
d3c1b24c
JS
153 res = simple_read_from_buffer(buf, count, &pg_offp,
154 data_of(data->handle), res);
155 if (res > 0)
156 *offp += res;
157
25f2f3da 158 Unlock:
bcda53fa 159 unlock_system_sleep();
25f2f3da 160
6e1819d6
RW
161 return res;
162}
163
164static ssize_t snapshot_write(struct file *filp, const char __user *buf,
165 size_t count, loff_t *offp)
166{
167 struct snapshot_data *data;
168 ssize_t res;
d3c1b24c 169 loff_t pg_offp = *offp & ~PAGE_MASK;
6e1819d6 170
bcda53fa 171 lock_system_sleep();
25f2f3da 172
6e1819d6 173 data = filp->private_data;
d3c1b24c
JS
174
175 if (!pg_offp) {
176 res = snapshot_write_next(&data->handle);
177 if (res <= 0)
178 goto unlock;
179 } else {
180 res = PAGE_SIZE - pg_offp;
6e1819d6 181 }
25f2f3da 182
d3c1b24c
JS
183 res = simple_write_to_buffer(data_of(data->handle), res, &pg_offp,
184 buf, count);
185 if (res > 0)
186 *offp += res;
187unlock:
bcda53fa 188 unlock_system_sleep();
25f2f3da 189
6e1819d6
RW
190 return res;
191}
192
52d11025
AC
193static long snapshot_ioctl(struct file *filp, unsigned int cmd,
194 unsigned long arg)
6e1819d6
RW
195{
196 int error = 0;
197 struct snapshot_data *data;
af508b34 198 loff_t size;
3aef83e0 199 sector_t offset;
6e1819d6
RW
200
201 if (_IOC_TYPE(cmd) != SNAPSHOT_IOC_MAGIC)
202 return -ENOTTY;
203 if (_IOC_NR(cmd) > SNAPSHOT_IOC_MAXNR)
204 return -ENOTTY;
205 if (!capable(CAP_SYS_ADMIN))
206 return -EPERM;
207
25f2f3da
RW
208 if (!mutex_trylock(&pm_mutex))
209 return -EBUSY;
6e1819d6 210
942f4015 211 lock_device_hotplug();
25f2f3da 212 data = filp->private_data;
52d11025 213
6e1819d6
RW
214 switch (cmd) {
215
216 case SNAPSHOT_FREEZE:
217 if (data->frozen)
218 break;
1bfcf130 219
c3e94d89
AS
220 printk("Syncing filesystems ... ");
221 sys_sync();
222 printk("done.\n");
223
1bfcf130 224 error = freeze_processes();
8fd37a4c
RW
225 if (error)
226 break;
227
228 error = create_basic_memory_bitmaps();
229 if (error)
230 thaw_processes();
231 else
6e1819d6 232 data->frozen = 1;
8fd37a4c 233
6e1819d6
RW
234 break;
235
236 case SNAPSHOT_UNFREEZE:
2f41dddb 237 if (!data->frozen || data->ready)
6e1819d6 238 break;
c9e664f1 239 pm_restore_gfp_mask();
8fd37a4c 240 free_basic_memory_bitmaps();
aab17289 241 data->free_bitmaps = false;
6e1819d6 242 thaw_processes();
6e1819d6
RW
243 data->frozen = 0;
244 break;
245
b694e52e 246 case SNAPSHOT_CREATE_IMAGE:
6e1819d6
RW
247 if (data->mode != O_RDONLY || !data->frozen || data->ready) {
248 error = -EPERM;
249 break;
250 }
c9e664f1 251 pm_restore_gfp_mask();
eb57c1cf 252 error = hibernation_snapshot(data->platform_support);
51d6ff7a 253 if (!error) {
cc5d207c 254 error = put_user(in_suspend, (int __user *)arg);
a556d5b5
SB
255 data->ready = !freezer_test_done && !error;
256 freezer_test_done = false;
97819a26 257 }
6e1819d6
RW
258 break;
259
260 case SNAPSHOT_ATOMIC_RESTORE:
8357376d 261 snapshot_write_finalize(&data->handle);
6e1819d6
RW
262 if (data->mode != O_WRONLY || !data->frozen ||
263 !snapshot_image_loaded(&data->handle)) {
264 error = -EPERM;
265 break;
266 }
eb57c1cf 267 error = hibernation_restore(data->platform_support);
6e1819d6
RW
268 break;
269
270 case SNAPSHOT_FREE:
271 swsusp_free();
272 memset(&data->handle, 0, sizeof(struct snapshot_handle));
273 data->ready = 0;
181e9bde
RW
274 /*
275 * It is necessary to thaw kernel threads here, because
276 * SNAPSHOT_CREATE_IMAGE may be invoked directly after
277 * SNAPSHOT_FREE. In that case, if kernel threads were not
278 * thawed, the preallocation of memory carried out by
279 * hibernation_snapshot() might run into problems (i.e. it
280 * might fail or even deadlock).
281 */
282 thaw_kernel_threads();
6e1819d6
RW
283 break;
284
b694e52e 285 case SNAPSHOT_PREF_IMAGE_SIZE:
6e1819d6
RW
286 image_size = arg;
287 break;
288
af508b34
RW
289 case SNAPSHOT_GET_IMAGE_SIZE:
290 if (!data->ready) {
291 error = -ENODATA;
292 break;
293 }
294 size = snapshot_get_image_size();
295 size <<= PAGE_SHIFT;
296 error = put_user(size, (loff_t __user *)arg);
297 break;
298
b694e52e 299 case SNAPSHOT_AVAIL_SWAP_SIZE:
af508b34
RW
300 size = count_swap_pages(data->swap, 1);
301 size <<= PAGE_SHIFT;
302 error = put_user(size, (loff_t __user *)arg);
6e1819d6
RW
303 break;
304
b694e52e 305 case SNAPSHOT_ALLOC_SWAP_PAGE:
6e1819d6
RW
306 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
307 error = -ENODEV;
308 break;
309 }
d1d241cc 310 offset = alloc_swapdev_block(data->swap);
6e1819d6
RW
311 if (offset) {
312 offset <<= PAGE_SHIFT;
cc5d207c 313 error = put_user(offset, (loff_t __user *)arg);
6e1819d6
RW
314 } else {
315 error = -ENOSPC;
316 }
317 break;
318
319 case SNAPSHOT_FREE_SWAP_PAGES:
320 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
321 error = -ENODEV;
322 break;
323 }
d1d241cc 324 free_all_swap_pages(data->swap);
6e1819d6
RW
325 break;
326
9b238205
LT
327 case SNAPSHOT_S2RAM:
328 if (!data->frozen) {
329 error = -EPERM;
330 break;
331 }
6c961dfb
RW
332 /*
333 * Tasks are frozen and the notifiers have been called with
334 * PM_HIBERNATION_PREPARE
335 */
336 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
36cb7035 337 data->ready = 0;
9b238205
LT
338 break;
339
eb57c1cf
RW
340 case SNAPSHOT_PLATFORM_SUPPORT:
341 data->platform_support = !!arg;
342 break;
343
344 case SNAPSHOT_POWER_OFF:
345 if (data->platform_support)
346 error = hibernation_platform_enter();
347 break;
348
37b2ba12 349 case SNAPSHOT_SET_SWAP_AREA:
d1d241cc 350 if (swsusp_swap_in_use()) {
37b2ba12
RW
351 error = -EPERM;
352 } else {
353 struct resume_swap_area swap_area;
354 dev_t swdev;
355
356 error = copy_from_user(&swap_area, (void __user *)arg,
357 sizeof(struct resume_swap_area));
358 if (error) {
359 error = -EFAULT;
360 break;
361 }
362
363 /*
364 * User space encodes device types as two-byte values,
365 * so we need to recode them
366 */
d88d4050 367 swdev = new_decode_dev(swap_area.dev);
37b2ba12
RW
368 if (swdev) {
369 offset = swap_area.offset;
7bf23687 370 data->swap = swap_type_of(swdev, offset, NULL);
37b2ba12
RW
371 if (data->swap < 0)
372 error = -ENODEV;
373 } else {
374 data->swap = -1;
375 error = -EINVAL;
376 }
377 }
378 break;
379
6e1819d6
RW
380 default:
381 error = -ENOTTY;
382
383 }
25f2f3da 384
942f4015 385 unlock_device_hotplug();
25f2f3da
RW
386 mutex_unlock(&pm_mutex);
387
6e1819d6
RW
388 return error;
389}
390
c336078b
BH
391#ifdef CONFIG_COMPAT
392
393struct compat_resume_swap_area {
394 compat_loff_t offset;
395 u32 dev;
396} __packed;
397
398static long
399snapshot_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
400{
401 BUILD_BUG_ON(sizeof(loff_t) != sizeof(compat_loff_t));
402
403 switch (cmd) {
404 case SNAPSHOT_GET_IMAGE_SIZE:
405 case SNAPSHOT_AVAIL_SWAP_SIZE:
406 case SNAPSHOT_ALLOC_SWAP_PAGE: {
407 compat_loff_t __user *uoffset = compat_ptr(arg);
408 loff_t offset;
409 mm_segment_t old_fs;
410 int err;
411
412 old_fs = get_fs();
413 set_fs(KERNEL_DS);
414 err = snapshot_ioctl(file, cmd, (unsigned long) &offset);
415 set_fs(old_fs);
416 if (!err && put_user(offset, uoffset))
417 err = -EFAULT;
418 return err;
419 }
420
421 case SNAPSHOT_CREATE_IMAGE:
422 return snapshot_ioctl(file, cmd,
423 (unsigned long) compat_ptr(arg));
424
425 case SNAPSHOT_SET_SWAP_AREA: {
426 struct compat_resume_swap_area __user *u_swap_area =
427 compat_ptr(arg);
428 struct resume_swap_area swap_area;
429 mm_segment_t old_fs;
430 int err;
431
432 err = get_user(swap_area.offset, &u_swap_area->offset);
433 err |= get_user(swap_area.dev, &u_swap_area->dev);
434 if (err)
435 return -EFAULT;
436 old_fs = get_fs();
437 set_fs(KERNEL_DS);
438 err = snapshot_ioctl(file, SNAPSHOT_SET_SWAP_AREA,
439 (unsigned long) &swap_area);
440 set_fs(old_fs);
441 return err;
442 }
443
444 default:
445 return snapshot_ioctl(file, cmd, arg);
446 }
447}
448
449#endif /* CONFIG_COMPAT */
450
15ad7cdc 451static const struct file_operations snapshot_fops = {
6e1819d6
RW
452 .open = snapshot_open,
453 .release = snapshot_release,
454 .read = snapshot_read,
455 .write = snapshot_write,
456 .llseek = no_llseek,
52d11025 457 .unlocked_ioctl = snapshot_ioctl,
c336078b
BH
458#ifdef CONFIG_COMPAT
459 .compat_ioctl = snapshot_compat_ioctl,
460#endif
6e1819d6
RW
461};
462
463static struct miscdevice snapshot_device = {
464 .minor = SNAPSHOT_MINOR,
465 .name = "snapshot",
466 .fops = &snapshot_fops,
467};
468
469static int __init snapshot_device_init(void)
470{
471 return misc_register(&snapshot_device);
472};
473
474device_initcall(snapshot_device_init);