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