Commit | Line | Data |
---|---|---|
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> | |
97c7801c | 23 | #include <linux/console.h> |
e3920fb4 | 24 | #include <linux/cpu.h> |
7dfb7103 | 25 | #include <linux/freezer.h> |
c7510859 | 26 | #include <scsi/scsi_scan.h> |
6e1819d6 RW |
27 | |
28 | #include <asm/uaccess.h> | |
29 | ||
30 | #include "power.h" | |
31 | ||
eb57c1cf | 32 | /* |
96f73749 RW |
33 | * NOTE: The SNAPSHOT_SET_SWAP_FILE and SNAPSHOT_PMOPS ioctls are obsolete and |
34 | * will be removed in the future. They are only preserved here for | |
35 | * compatibility with existing userland utilities. | |
eb57c1cf | 36 | */ |
96f73749 | 37 | #define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int) |
eb57c1cf RW |
38 | #define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int) |
39 | ||
40 | #define PMOPS_PREPARE 1 | |
41 | #define PMOPS_ENTER 2 | |
42 | #define PMOPS_FINISH 3 | |
43 | ||
cc5d207c RW |
44 | /* |
45 | * NOTE: The following ioctl definitions are wrong and have been replaced with | |
46 | * correct ones. They are only preserved here for compatibility with existing | |
47 | * userland utilities and will be removed in the future. | |
48 | */ | |
49 | #define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *) | |
50 | #define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long) | |
51 | #define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *) | |
52 | #define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *) | |
53 | ||
eb57c1cf | 54 | |
6e1819d6 RW |
55 | #define SNAPSHOT_MINOR 231 |
56 | ||
57 | static struct snapshot_data { | |
58 | struct snapshot_handle handle; | |
59 | int swap; | |
6e1819d6 RW |
60 | int mode; |
61 | char frozen; | |
62 | char ready; | |
eb57c1cf | 63 | char platform_support; |
6e1819d6 RW |
64 | } snapshot_state; |
65 | ||
0709db60 | 66 | atomic_t snapshot_device_available = ATOMIC_INIT(1); |
6e1819d6 RW |
67 | |
68 | static int snapshot_open(struct inode *inode, struct file *filp) | |
69 | { | |
70 | struct snapshot_data *data; | |
c3e94d89 | 71 | int error; |
6e1819d6 | 72 | |
25f2f3da RW |
73 | mutex_lock(&pm_mutex); |
74 | ||
75 | if (!atomic_add_unless(&snapshot_device_available, -1, 0)) { | |
76 | error = -EBUSY; | |
77 | goto Unlock; | |
78 | } | |
6e1819d6 | 79 | |
1525a2ad | 80 | if ((filp->f_flags & O_ACCMODE) == O_RDWR) { |
0709db60 | 81 | atomic_inc(&snapshot_device_available); |
25f2f3da RW |
82 | error = -ENOSYS; |
83 | goto Unlock; | |
1525a2ad RW |
84 | } |
85 | if(create_basic_memory_bitmaps()) { | |
0709db60 | 86 | atomic_inc(&snapshot_device_available); |
25f2f3da RW |
87 | error = -ENOMEM; |
88 | goto Unlock; | |
1525a2ad | 89 | } |
6e1819d6 RW |
90 | nonseekable_open(inode, filp); |
91 | data = &snapshot_state; | |
92 | filp->private_data = data; | |
93 | memset(&data->handle, 0, sizeof(struct snapshot_handle)); | |
94 | if ((filp->f_flags & O_ACCMODE) == O_RDONLY) { | |
c7510859 | 95 | /* Hibernating. The image device should be accessible. */ |
915bae9e | 96 | data->swap = swsusp_resume_device ? |
7bf23687 | 97 | swap_type_of(swsusp_resume_device, 0, NULL) : -1; |
6e1819d6 | 98 | data->mode = O_RDONLY; |
ebae2604 | 99 | error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE); |
c3e94d89 | 100 | if (error) |
ebae2604 | 101 | pm_notifier_call_chain(PM_POST_HIBERNATION); |
6e1819d6 | 102 | } else { |
c7510859 RW |
103 | /* |
104 | * Resuming. We may need to wait for the image device to | |
105 | * appear. | |
106 | */ | |
107 | wait_for_device_probe(); | |
108 | scsi_complete_async_scans(); | |
109 | ||
6e1819d6 RW |
110 | data->swap = -1; |
111 | data->mode = O_WRONLY; | |
ebae2604 | 112 | error = pm_notifier_call_chain(PM_RESTORE_PREPARE); |
c3e94d89 | 113 | if (error) |
ebae2604 | 114 | pm_notifier_call_chain(PM_POST_RESTORE); |
c3e94d89 | 115 | } |
25f2f3da | 116 | if (error) |
c3e94d89 | 117 | atomic_inc(&snapshot_device_available); |
6e1819d6 RW |
118 | data->frozen = 0; |
119 | data->ready = 0; | |
eb57c1cf | 120 | data->platform_support = 0; |
6e1819d6 | 121 | |
25f2f3da RW |
122 | Unlock: |
123 | mutex_unlock(&pm_mutex); | |
124 | ||
125 | return error; | |
6e1819d6 RW |
126 | } |
127 | ||
128 | static int snapshot_release(struct inode *inode, struct file *filp) | |
129 | { | |
130 | struct snapshot_data *data; | |
131 | ||
25f2f3da RW |
132 | mutex_lock(&pm_mutex); |
133 | ||
6e1819d6 | 134 | swsusp_free(); |
74dfd666 | 135 | free_basic_memory_bitmaps(); |
6e1819d6 | 136 | data = filp->private_data; |
d1d241cc | 137 | free_all_swap_pages(data->swap); |
9744997a RW |
138 | if (data->frozen) { |
139 | pm_restore_gfp_mask(); | |
6e1819d6 | 140 | thaw_processes(); |
9744997a | 141 | } |
1497dd1d | 142 | pm_notifier_call_chain(data->mode == O_RDONLY ? |
c3e94d89 | 143 | PM_POST_HIBERNATION : PM_POST_RESTORE); |
0709db60 | 144 | atomic_inc(&snapshot_device_available); |
25f2f3da RW |
145 | |
146 | mutex_unlock(&pm_mutex); | |
147 | ||
6e1819d6 RW |
148 | return 0; |
149 | } | |
150 | ||
151 | static ssize_t snapshot_read(struct file *filp, char __user *buf, | |
152 | size_t count, loff_t *offp) | |
153 | { | |
154 | struct snapshot_data *data; | |
155 | ssize_t res; | |
d3c1b24c | 156 | loff_t pg_offp = *offp & ~PAGE_MASK; |
6e1819d6 | 157 | |
25f2f3da RW |
158 | mutex_lock(&pm_mutex); |
159 | ||
6e1819d6 | 160 | data = filp->private_data; |
25f2f3da RW |
161 | if (!data->ready) { |
162 | res = -ENODATA; | |
163 | goto Unlock; | |
164 | } | |
d3c1b24c JS |
165 | if (!pg_offp) { /* on page boundary? */ |
166 | res = snapshot_read_next(&data->handle); | |
167 | if (res <= 0) | |
168 | goto Unlock; | |
169 | } else { | |
170 | res = PAGE_SIZE - pg_offp; | |
6e1819d6 | 171 | } |
25f2f3da | 172 | |
d3c1b24c JS |
173 | res = simple_read_from_buffer(buf, count, &pg_offp, |
174 | data_of(data->handle), res); | |
175 | if (res > 0) | |
176 | *offp += res; | |
177 | ||
25f2f3da RW |
178 | Unlock: |
179 | mutex_unlock(&pm_mutex); | |
180 | ||
6e1819d6 RW |
181 | return res; |
182 | } | |
183 | ||
184 | static ssize_t snapshot_write(struct file *filp, const char __user *buf, | |
185 | size_t count, loff_t *offp) | |
186 | { | |
187 | struct snapshot_data *data; | |
188 | ssize_t res; | |
d3c1b24c | 189 | loff_t pg_offp = *offp & ~PAGE_MASK; |
6e1819d6 | 190 | |
25f2f3da RW |
191 | mutex_lock(&pm_mutex); |
192 | ||
6e1819d6 | 193 | data = filp->private_data; |
d3c1b24c JS |
194 | |
195 | if (!pg_offp) { | |
196 | res = snapshot_write_next(&data->handle); | |
197 | if (res <= 0) | |
198 | goto unlock; | |
199 | } else { | |
200 | res = PAGE_SIZE - pg_offp; | |
6e1819d6 | 201 | } |
25f2f3da | 202 | |
d3c1b24c JS |
203 | res = simple_write_to_buffer(data_of(data->handle), res, &pg_offp, |
204 | buf, count); | |
205 | if (res > 0) | |
206 | *offp += res; | |
207 | unlock: | |
25f2f3da RW |
208 | mutex_unlock(&pm_mutex); |
209 | ||
6e1819d6 RW |
210 | return res; |
211 | } | |
212 | ||
b694e52e JS |
213 | static void snapshot_deprecated_ioctl(unsigned int cmd) |
214 | { | |
215 | if (printk_ratelimit()) | |
216 | printk(KERN_NOTICE "%pf: ioctl '%.8x' is deprecated and will " | |
217 | "be removed soon, update your suspend-to-disk " | |
218 | "utilities\n", | |
219 | __builtin_return_address(0), cmd); | |
220 | } | |
221 | ||
52d11025 AC |
222 | static long snapshot_ioctl(struct file *filp, unsigned int cmd, |
223 | unsigned long arg) | |
6e1819d6 RW |
224 | { |
225 | int error = 0; | |
226 | struct snapshot_data *data; | |
af508b34 | 227 | loff_t size; |
3aef83e0 | 228 | sector_t offset; |
6e1819d6 RW |
229 | |
230 | if (_IOC_TYPE(cmd) != SNAPSHOT_IOC_MAGIC) | |
231 | return -ENOTTY; | |
232 | if (_IOC_NR(cmd) > SNAPSHOT_IOC_MAXNR) | |
233 | return -ENOTTY; | |
234 | if (!capable(CAP_SYS_ADMIN)) | |
235 | return -EPERM; | |
236 | ||
25f2f3da RW |
237 | if (!mutex_trylock(&pm_mutex)) |
238 | return -EBUSY; | |
6e1819d6 | 239 | |
25f2f3da | 240 | data = filp->private_data; |
52d11025 | 241 | |
6e1819d6 RW |
242 | switch (cmd) { |
243 | ||
244 | case SNAPSHOT_FREEZE: | |
245 | if (data->frozen) | |
246 | break; | |
1bfcf130 | 247 | |
c3e94d89 AS |
248 | printk("Syncing filesystems ... "); |
249 | sys_sync(); | |
250 | printk("done.\n"); | |
251 | ||
1bfcf130 | 252 | error = usermodehelper_disable(); |
b10d9117 | 253 | if (error) |
1bfcf130 RW |
254 | break; |
255 | ||
256 | error = freeze_processes(); | |
257 | if (error) { | |
c3e94d89 | 258 | thaw_processes(); |
1bfcf130 RW |
259 | usermodehelper_enable(); |
260 | } | |
6e1819d6 RW |
261 | if (!error) |
262 | data->frozen = 1; | |
263 | break; | |
264 | ||
265 | case SNAPSHOT_UNFREEZE: | |
2f41dddb | 266 | if (!data->frozen || data->ready) |
6e1819d6 | 267 | break; |
c9e664f1 | 268 | pm_restore_gfp_mask(); |
6e1819d6 | 269 | thaw_processes(); |
1bfcf130 | 270 | usermodehelper_enable(); |
6e1819d6 RW |
271 | data->frozen = 0; |
272 | break; | |
273 | ||
274 | case SNAPSHOT_ATOMIC_SNAPSHOT: | |
b694e52e JS |
275 | snapshot_deprecated_ioctl(cmd); |
276 | case SNAPSHOT_CREATE_IMAGE: | |
6e1819d6 RW |
277 | if (data->mode != O_RDONLY || !data->frozen || data->ready) { |
278 | error = -EPERM; | |
279 | break; | |
280 | } | |
c9e664f1 | 281 | pm_restore_gfp_mask(); |
eb57c1cf | 282 | error = hibernation_snapshot(data->platform_support); |
6e1819d6 | 283 | if (!error) |
cc5d207c | 284 | error = put_user(in_suspend, (int __user *)arg); |
6e1819d6 RW |
285 | if (!error) |
286 | data->ready = 1; | |
287 | break; | |
288 | ||
289 | case SNAPSHOT_ATOMIC_RESTORE: | |
8357376d | 290 | snapshot_write_finalize(&data->handle); |
6e1819d6 RW |
291 | if (data->mode != O_WRONLY || !data->frozen || |
292 | !snapshot_image_loaded(&data->handle)) { | |
293 | error = -EPERM; | |
294 | break; | |
295 | } | |
eb57c1cf | 296 | error = hibernation_restore(data->platform_support); |
6e1819d6 RW |
297 | break; |
298 | ||
299 | case SNAPSHOT_FREE: | |
300 | swsusp_free(); | |
301 | memset(&data->handle, 0, sizeof(struct snapshot_handle)); | |
302 | data->ready = 0; | |
303 | break; | |
304 | ||
305 | case SNAPSHOT_SET_IMAGE_SIZE: | |
b694e52e JS |
306 | snapshot_deprecated_ioctl(cmd); |
307 | case SNAPSHOT_PREF_IMAGE_SIZE: | |
6e1819d6 RW |
308 | image_size = arg; |
309 | break; | |
310 | ||
af508b34 RW |
311 | case SNAPSHOT_GET_IMAGE_SIZE: |
312 | if (!data->ready) { | |
313 | error = -ENODATA; | |
314 | break; | |
315 | } | |
316 | size = snapshot_get_image_size(); | |
317 | size <<= PAGE_SHIFT; | |
318 | error = put_user(size, (loff_t __user *)arg); | |
319 | break; | |
320 | ||
6e1819d6 | 321 | case SNAPSHOT_AVAIL_SWAP: |
b694e52e JS |
322 | snapshot_deprecated_ioctl(cmd); |
323 | case SNAPSHOT_AVAIL_SWAP_SIZE: | |
af508b34 RW |
324 | size = count_swap_pages(data->swap, 1); |
325 | size <<= PAGE_SHIFT; | |
326 | error = put_user(size, (loff_t __user *)arg); | |
6e1819d6 RW |
327 | break; |
328 | ||
329 | case SNAPSHOT_GET_SWAP_PAGE: | |
b694e52e JS |
330 | snapshot_deprecated_ioctl(cmd); |
331 | case SNAPSHOT_ALLOC_SWAP_PAGE: | |
6e1819d6 RW |
332 | if (data->swap < 0 || data->swap >= MAX_SWAPFILES) { |
333 | error = -ENODEV; | |
334 | break; | |
335 | } | |
d1d241cc | 336 | offset = alloc_swapdev_block(data->swap); |
6e1819d6 RW |
337 | if (offset) { |
338 | offset <<= PAGE_SHIFT; | |
cc5d207c | 339 | error = put_user(offset, (loff_t __user *)arg); |
6e1819d6 RW |
340 | } else { |
341 | error = -ENOSPC; | |
342 | } | |
343 | break; | |
344 | ||
345 | case SNAPSHOT_FREE_SWAP_PAGES: | |
346 | if (data->swap < 0 || data->swap >= MAX_SWAPFILES) { | |
347 | error = -ENODEV; | |
348 | break; | |
349 | } | |
d1d241cc | 350 | free_all_swap_pages(data->swap); |
6e1819d6 RW |
351 | break; |
352 | ||
96f73749 | 353 | case SNAPSHOT_SET_SWAP_FILE: /* This ioctl is deprecated */ |
b694e52e | 354 | snapshot_deprecated_ioctl(cmd); |
d1d241cc | 355 | if (!swsusp_swap_in_use()) { |
6e1819d6 RW |
356 | /* |
357 | * User space encodes device types as two-byte values, | |
358 | * so we need to recode them | |
359 | */ | |
360 | if (old_decode_dev(arg)) { | |
7bf23687 RW |
361 | data->swap = swap_type_of(old_decode_dev(arg), |
362 | 0, NULL); | |
6e1819d6 RW |
363 | if (data->swap < 0) |
364 | error = -ENODEV; | |
365 | } else { | |
366 | data->swap = -1; | |
367 | error = -EINVAL; | |
368 | } | |
369 | } else { | |
370 | error = -EPERM; | |
371 | } | |
372 | break; | |
373 | ||
9b238205 LT |
374 | case SNAPSHOT_S2RAM: |
375 | if (!data->frozen) { | |
376 | error = -EPERM; | |
377 | break; | |
378 | } | |
6c961dfb RW |
379 | /* |
380 | * Tasks are frozen and the notifiers have been called with | |
381 | * PM_HIBERNATION_PREPARE | |
382 | */ | |
383 | error = suspend_devices_and_enter(PM_SUSPEND_MEM); | |
36cb7035 | 384 | data->ready = 0; |
9b238205 LT |
385 | break; |
386 | ||
eb57c1cf RW |
387 | case SNAPSHOT_PLATFORM_SUPPORT: |
388 | data->platform_support = !!arg; | |
389 | break; | |
390 | ||
391 | case SNAPSHOT_POWER_OFF: | |
392 | if (data->platform_support) | |
393 | error = hibernation_platform_enter(); | |
394 | break; | |
395 | ||
396 | case SNAPSHOT_PMOPS: /* This ioctl is deprecated */ | |
b694e52e | 397 | snapshot_deprecated_ioctl(cmd); |
2b5b09b3 RW |
398 | error = -EINVAL; |
399 | ||
3592695c SS |
400 | switch (arg) { |
401 | ||
402 | case PMOPS_PREPARE: | |
eb57c1cf | 403 | data->platform_support = 1; |
7777fab9 | 404 | error = 0; |
3592695c SS |
405 | break; |
406 | ||
407 | case PMOPS_ENTER: | |
eb57c1cf | 408 | if (data->platform_support) |
7777fab9 | 409 | error = hibernation_platform_enter(); |
3592695c SS |
410 | break; |
411 | ||
412 | case PMOPS_FINISH: | |
eb57c1cf | 413 | if (data->platform_support) |
2b5b09b3 | 414 | error = 0; |
3592695c SS |
415 | break; |
416 | ||
417 | default: | |
418 | printk(KERN_ERR "SNAPSHOT_PMOPS: invalid argument %ld\n", arg); | |
3592695c SS |
419 | |
420 | } | |
421 | break; | |
422 | ||
37b2ba12 | 423 | case SNAPSHOT_SET_SWAP_AREA: |
d1d241cc | 424 | if (swsusp_swap_in_use()) { |
37b2ba12 RW |
425 | error = -EPERM; |
426 | } else { | |
427 | struct resume_swap_area swap_area; | |
428 | dev_t swdev; | |
429 | ||
430 | error = copy_from_user(&swap_area, (void __user *)arg, | |
431 | sizeof(struct resume_swap_area)); | |
432 | if (error) { | |
433 | error = -EFAULT; | |
434 | break; | |
435 | } | |
436 | ||
437 | /* | |
438 | * User space encodes device types as two-byte values, | |
439 | * so we need to recode them | |
440 | */ | |
d88d4050 | 441 | swdev = new_decode_dev(swap_area.dev); |
37b2ba12 RW |
442 | if (swdev) { |
443 | offset = swap_area.offset; | |
7bf23687 | 444 | data->swap = swap_type_of(swdev, offset, NULL); |
37b2ba12 RW |
445 | if (data->swap < 0) |
446 | error = -ENODEV; | |
447 | } else { | |
448 | data->swap = -1; | |
449 | error = -EINVAL; | |
450 | } | |
451 | } | |
452 | break; | |
453 | ||
6e1819d6 RW |
454 | default: |
455 | error = -ENOTTY; | |
456 | ||
457 | } | |
25f2f3da RW |
458 | |
459 | mutex_unlock(&pm_mutex); | |
460 | ||
6e1819d6 RW |
461 | return error; |
462 | } | |
463 | ||
15ad7cdc | 464 | static const struct file_operations snapshot_fops = { |
6e1819d6 RW |
465 | .open = snapshot_open, |
466 | .release = snapshot_release, | |
467 | .read = snapshot_read, | |
468 | .write = snapshot_write, | |
469 | .llseek = no_llseek, | |
52d11025 | 470 | .unlocked_ioctl = snapshot_ioctl, |
6e1819d6 RW |
471 | }; |
472 | ||
473 | static struct miscdevice snapshot_device = { | |
474 | .minor = SNAPSHOT_MINOR, | |
475 | .name = "snapshot", | |
476 | .fops = &snapshot_fops, | |
477 | }; | |
478 | ||
479 | static int __init snapshot_device_init(void) | |
480 | { | |
481 | return misc_register(&snapshot_device); | |
482 | }; | |
483 | ||
484 | device_initcall(snapshot_device_init); |