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