]> Pileus Git - ~andy/linux/blob - kernel/power/user.c
Hibernation: Introduce SNAPSHOT_GET_IMAGE_SIZE ioctl
[~andy/linux] / kernel / power / user.c
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>
14 #include <linux/reboot.h>
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>
23 #include <linux/console.h>
24 #include <linux/cpu.h>
25 #include <linux/freezer.h>
26
27 #include <asm/uaccess.h>
28
29 #include "power.h"
30
31 #define SNAPSHOT_MINOR  231
32
33 static struct snapshot_data {
34         struct snapshot_handle handle;
35         int swap;
36         int mode;
37         char frozen;
38         char ready;
39         char platform_suspend;
40 } snapshot_state;
41
42 atomic_t snapshot_device_available = ATOMIC_INIT(1);
43
44 static int snapshot_open(struct inode *inode, struct file *filp)
45 {
46         struct snapshot_data *data;
47
48         if (!atomic_add_unless(&snapshot_device_available, -1, 0))
49                 return -EBUSY;
50
51         if ((filp->f_flags & O_ACCMODE) == O_RDWR) {
52                 atomic_inc(&snapshot_device_available);
53                 return -ENOSYS;
54         }
55         if(create_basic_memory_bitmaps()) {
56                 atomic_inc(&snapshot_device_available);
57                 return -ENOMEM;
58         }
59         nonseekable_open(inode, filp);
60         data = &snapshot_state;
61         filp->private_data = data;
62         memset(&data->handle, 0, sizeof(struct snapshot_handle));
63         if ((filp->f_flags & O_ACCMODE) == O_RDONLY) {
64                 data->swap = swsusp_resume_device ?
65                         swap_type_of(swsusp_resume_device, 0, NULL) : -1;
66                 data->mode = O_RDONLY;
67         } else {
68                 data->swap = -1;
69                 data->mode = O_WRONLY;
70         }
71         data->frozen = 0;
72         data->ready = 0;
73         data->platform_suspend = 0;
74
75         return 0;
76 }
77
78 static int snapshot_release(struct inode *inode, struct file *filp)
79 {
80         struct snapshot_data *data;
81
82         swsusp_free();
83         free_basic_memory_bitmaps();
84         data = filp->private_data;
85         free_all_swap_pages(data->swap);
86         if (data->frozen) {
87                 mutex_lock(&pm_mutex);
88                 thaw_processes();
89                 mutex_unlock(&pm_mutex);
90         }
91         atomic_inc(&snapshot_device_available);
92         return 0;
93 }
94
95 static ssize_t snapshot_read(struct file *filp, char __user *buf,
96                              size_t count, loff_t *offp)
97 {
98         struct snapshot_data *data;
99         ssize_t res;
100
101         data = filp->private_data;
102         if (!data->ready)
103                 return -ENODATA;
104         res = snapshot_read_next(&data->handle, count);
105         if (res > 0) {
106                 if (copy_to_user(buf, data_of(data->handle), res))
107                         res = -EFAULT;
108                 else
109                         *offp = data->handle.offset;
110         }
111         return res;
112 }
113
114 static ssize_t snapshot_write(struct file *filp, const char __user *buf,
115                               size_t count, loff_t *offp)
116 {
117         struct snapshot_data *data;
118         ssize_t res;
119
120         data = filp->private_data;
121         res = snapshot_write_next(&data->handle, count);
122         if (res > 0) {
123                 if (copy_from_user(data_of(data->handle), buf, res))
124                         res = -EFAULT;
125                 else
126                         *offp = data->handle.offset;
127         }
128         return res;
129 }
130
131 static int snapshot_ioctl(struct inode *inode, struct file *filp,
132                           unsigned int cmd, unsigned long arg)
133 {
134         int error = 0;
135         struct snapshot_data *data;
136         loff_t size;
137         sector_t offset;
138
139         if (_IOC_TYPE(cmd) != SNAPSHOT_IOC_MAGIC)
140                 return -ENOTTY;
141         if (_IOC_NR(cmd) > SNAPSHOT_IOC_MAXNR)
142                 return -ENOTTY;
143         if (!capable(CAP_SYS_ADMIN))
144                 return -EPERM;
145
146         data = filp->private_data;
147
148         switch (cmd) {
149
150         case SNAPSHOT_FREEZE:
151                 if (data->frozen)
152                         break;
153                 mutex_lock(&pm_mutex);
154                 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
155                 if (!error) {
156                         printk("Syncing filesystems ... ");
157                         sys_sync();
158                         printk("done.\n");
159
160                         error = freeze_processes();
161                         if (error)
162                                 thaw_processes();
163                 }
164                 if (error)
165                         pm_notifier_call_chain(PM_POST_HIBERNATION);
166                 mutex_unlock(&pm_mutex);
167                 if (!error)
168                         data->frozen = 1;
169                 break;
170
171         case SNAPSHOT_UNFREEZE:
172                 if (!data->frozen || data->ready)
173                         break;
174                 mutex_lock(&pm_mutex);
175                 thaw_processes();
176                 pm_notifier_call_chain(PM_POST_HIBERNATION);
177                 mutex_unlock(&pm_mutex);
178                 data->frozen = 0;
179                 break;
180
181         case SNAPSHOT_ATOMIC_SNAPSHOT:
182                 if (data->mode != O_RDONLY || !data->frozen  || data->ready) {
183                         error = -EPERM;
184                         break;
185                 }
186                 error = hibernation_snapshot(data->platform_suspend);
187                 if (!error)
188                         error = put_user(in_suspend, (unsigned int __user *)arg);
189                 if (!error)
190                         data->ready = 1;
191                 break;
192
193         case SNAPSHOT_ATOMIC_RESTORE:
194                 snapshot_write_finalize(&data->handle);
195                 if (data->mode != O_WRONLY || !data->frozen ||
196                     !snapshot_image_loaded(&data->handle)) {
197                         error = -EPERM;
198                         break;
199                 }
200                 error = hibernation_restore(data->platform_suspend);
201                 break;
202
203         case SNAPSHOT_FREE:
204                 swsusp_free();
205                 memset(&data->handle, 0, sizeof(struct snapshot_handle));
206                 data->ready = 0;
207                 break;
208
209         case SNAPSHOT_SET_IMAGE_SIZE:
210                 image_size = arg;
211                 break;
212
213         case SNAPSHOT_GET_IMAGE_SIZE:
214                 if (!data->ready) {
215                         error = -ENODATA;
216                         break;
217                 }
218                 size = snapshot_get_image_size();
219                 size <<= PAGE_SHIFT;
220                 error = put_user(size, (loff_t __user *)arg);
221                 break;
222
223         case SNAPSHOT_AVAIL_SWAP:
224                 size = count_swap_pages(data->swap, 1);
225                 size <<= PAGE_SHIFT;
226                 error = put_user(size, (loff_t __user *)arg);
227                 break;
228
229         case SNAPSHOT_GET_SWAP_PAGE:
230                 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
231                         error = -ENODEV;
232                         break;
233                 }
234                 offset = alloc_swapdev_block(data->swap);
235                 if (offset) {
236                         offset <<= PAGE_SHIFT;
237                         error = put_user(offset, (sector_t __user *)arg);
238                 } else {
239                         error = -ENOSPC;
240                 }
241                 break;
242
243         case SNAPSHOT_FREE_SWAP_PAGES:
244                 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
245                         error = -ENODEV;
246                         break;
247                 }
248                 free_all_swap_pages(data->swap);
249                 break;
250
251         case SNAPSHOT_SET_SWAP_FILE:
252                 if (!swsusp_swap_in_use()) {
253                         /*
254                          * User space encodes device types as two-byte values,
255                          * so we need to recode them
256                          */
257                         if (old_decode_dev(arg)) {
258                                 data->swap = swap_type_of(old_decode_dev(arg),
259                                                         0, NULL);
260                                 if (data->swap < 0)
261                                         error = -ENODEV;
262                         } else {
263                                 data->swap = -1;
264                                 error = -EINVAL;
265                         }
266                 } else {
267                         error = -EPERM;
268                 }
269                 break;
270
271         case SNAPSHOT_S2RAM:
272                 if (!data->frozen) {
273                         error = -EPERM;
274                         break;
275                 }
276                 if (!mutex_trylock(&pm_mutex)) {
277                         error = -EBUSY;
278                         break;
279                 }
280                 /*
281                  * Tasks are frozen and the notifiers have been called with
282                  * PM_HIBERNATION_PREPARE
283                  */
284                 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
285                 mutex_unlock(&pm_mutex);
286                 break;
287
288         case SNAPSHOT_PMOPS:
289                 error = -EINVAL;
290
291                 switch (arg) {
292
293                 case PMOPS_PREPARE:
294                         data->platform_suspend = 1;
295                         error = 0;
296                         break;
297
298                 case PMOPS_ENTER:
299                         if (data->platform_suspend)
300                                 error = hibernation_platform_enter();
301
302                         break;
303
304                 case PMOPS_FINISH:
305                         if (data->platform_suspend)
306                                 error = 0;
307
308                         break;
309
310                 default:
311                         printk(KERN_ERR "SNAPSHOT_PMOPS: invalid argument %ld\n", arg);
312
313                 }
314                 break;
315
316         case SNAPSHOT_SET_SWAP_AREA:
317                 if (swsusp_swap_in_use()) {
318                         error = -EPERM;
319                 } else {
320                         struct resume_swap_area swap_area;
321                         dev_t swdev;
322
323                         error = copy_from_user(&swap_area, (void __user *)arg,
324                                         sizeof(struct resume_swap_area));
325                         if (error) {
326                                 error = -EFAULT;
327                                 break;
328                         }
329
330                         /*
331                          * User space encodes device types as two-byte values,
332                          * so we need to recode them
333                          */
334                         swdev = old_decode_dev(swap_area.dev);
335                         if (swdev) {
336                                 offset = swap_area.offset;
337                                 data->swap = swap_type_of(swdev, offset, NULL);
338                                 if (data->swap < 0)
339                                         error = -ENODEV;
340                         } else {
341                                 data->swap = -1;
342                                 error = -EINVAL;
343                         }
344                 }
345                 break;
346
347         default:
348                 error = -ENOTTY;
349
350         }
351
352         return error;
353 }
354
355 static const struct file_operations snapshot_fops = {
356         .open = snapshot_open,
357         .release = snapshot_release,
358         .read = snapshot_read,
359         .write = snapshot_write,
360         .llseek = no_llseek,
361         .ioctl = snapshot_ioctl,
362 };
363
364 static struct miscdevice snapshot_device = {
365         .minor = SNAPSHOT_MINOR,
366         .name = "snapshot",
367         .fops = &snapshot_fops,
368 };
369
370 static int __init snapshot_device_init(void)
371 {
372         return misc_register(&snapshot_device);
373 };
374
375 device_initcall(snapshot_device_init);