user.c 9.6 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
/*
 * linux/kernel/power/user.c
 *
 * This file provides the user space interface for software suspend/resume.
 *
 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
 *
 * This file is released under the GPLv2.
 *
 */

#include <linux/suspend.h>
#include <linux/syscalls.h>
14
#include <linux/reboot.h>
15
16
17
18
19
20
21
22
#include <linux/string.h>
#include <linux/device.h>
#include <linux/miscdevice.h>
#include <linux/mm.h>
#include <linux/swap.h>
#include <linux/swapops.h>
#include <linux/pm.h>
#include <linux/fs.h>
23
#include <linux/console.h>
24
#include <linux/cpu.h>
25
#include <linux/freezer.h>
26
#include <linux/smp_lock.h>
27
#include <scsi/scsi_scan.h>
28
29
30
31
32

#include <asm/uaccess.h>

#include "power.h"

33
/*
34
35
36
 * NOTE: The SNAPSHOT_SET_SWAP_FILE and SNAPSHOT_PMOPS ioctls are obsolete and
 * will be removed in the future.  They are only preserved here for
 * compatibility with existing userland utilities.
37
 */
38
#define SNAPSHOT_SET_SWAP_FILE	_IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
39
40
41
42
43
44
#define SNAPSHOT_PMOPS		_IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)

#define PMOPS_PREPARE	1
#define PMOPS_ENTER	2
#define PMOPS_FINISH	3

45
46
47
48
49
50
51
52
53
54
/*
 * NOTE: The following ioctl definitions are wrong and have been replaced with
 * correct ones.  They are only preserved here for compatibility with existing
 * userland utilities and will be removed in the future.
 */
#define SNAPSHOT_ATOMIC_SNAPSHOT	_IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
#define SNAPSHOT_SET_IMAGE_SIZE		_IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
#define SNAPSHOT_AVAIL_SWAP		_IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
#define SNAPSHOT_GET_SWAP_PAGE		_IOR(SNAPSHOT_IOC_MAGIC, 8, void *)

55

56
57
58
59
60
61
62
63
#define SNAPSHOT_MINOR	231

static struct snapshot_data {
	struct snapshot_handle handle;
	int swap;
	int mode;
	char frozen;
	char ready;
64
	char platform_support;
65
66
} snapshot_state;

67
atomic_t snapshot_device_available = ATOMIC_INIT(1);
68
69
70
71

static int snapshot_open(struct inode *inode, struct file *filp)
{
	struct snapshot_data *data;
72
	int error;
73

74
75
76
77
78
79
	mutex_lock(&pm_mutex);

	if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
		error = -EBUSY;
		goto Unlock;
	}
80

81
	if ((filp->f_flags & O_ACCMODE) == O_RDWR) {
82
		atomic_inc(&snapshot_device_available);
83
84
		error = -ENOSYS;
		goto Unlock;
85
86
	}
	if(create_basic_memory_bitmaps()) {
87
		atomic_inc(&snapshot_device_available);
88
89
		error = -ENOMEM;
		goto Unlock;
90
	}
91
92
93
94
95
	nonseekable_open(inode, filp);
	data = &snapshot_state;
	filp->private_data = data;
	memset(&data->handle, 0, sizeof(struct snapshot_handle));
	if ((filp->f_flags & O_ACCMODE) == O_RDONLY) {
96
		/* Hibernating.  The image device should be accessible. */
97
		data->swap = swsusp_resume_device ?
98
			swap_type_of(swsusp_resume_device, 0, NULL) : -1;
99
		data->mode = O_RDONLY;
100
		error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
101
		if (error)
102
			pm_notifier_call_chain(PM_POST_HIBERNATION);
103
	} else {
104
105
106
107
108
109
110
		/*
		 * Resuming.  We may need to wait for the image device to
		 * appear.
		 */
		wait_for_device_probe();
		scsi_complete_async_scans();

111
112
		data->swap = -1;
		data->mode = O_WRONLY;
113
		error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
114
		if (error)
115
			pm_notifier_call_chain(PM_POST_RESTORE);
116
	}
117
	if (error)
118
		atomic_inc(&snapshot_device_available);
119
120
	data->frozen = 0;
	data->ready = 0;
121
	data->platform_support = 0;
122

123
124
125
126
 Unlock:
	mutex_unlock(&pm_mutex);

	return error;
127
128
129
130
131
132
}

static int snapshot_release(struct inode *inode, struct file *filp)
{
	struct snapshot_data *data;

133
134
	mutex_lock(&pm_mutex);

135
	swsusp_free();
136
	free_basic_memory_bitmaps();
137
	data = filp->private_data;
138
	free_all_swap_pages(data->swap);
139
	if (data->frozen)
140
		thaw_processes();
141
142
	pm_notifier_call_chain(data->mode == O_WRONLY ?
			PM_POST_HIBERNATION : PM_POST_RESTORE);
143
	atomic_inc(&snapshot_device_available);
144
145
146

	mutex_unlock(&pm_mutex);

147
148
149
150
151
152
153
154
155
	return 0;
}

static ssize_t snapshot_read(struct file *filp, char __user *buf,
                             size_t count, loff_t *offp)
{
	struct snapshot_data *data;
	ssize_t res;

156
157
	mutex_lock(&pm_mutex);

158
	data = filp->private_data;
159
160
161
162
	if (!data->ready) {
		res = -ENODATA;
		goto Unlock;
	}
163
164
165
166
167
168
169
	res = snapshot_read_next(&data->handle, count);
	if (res > 0) {
		if (copy_to_user(buf, data_of(data->handle), res))
			res = -EFAULT;
		else
			*offp = data->handle.offset;
	}
170
171
172
173

 Unlock:
	mutex_unlock(&pm_mutex);

174
175
176
177
178
179
180
181
182
	return res;
}

static ssize_t snapshot_write(struct file *filp, const char __user *buf,
                              size_t count, loff_t *offp)
{
	struct snapshot_data *data;
	ssize_t res;

183
184
	mutex_lock(&pm_mutex);

185
186
187
188
189
190
191
192
	data = filp->private_data;
	res = snapshot_write_next(&data->handle, count);
	if (res > 0) {
		if (copy_from_user(data_of(data->handle), buf, res))
			res = -EFAULT;
		else
			*offp = data->handle.offset;
	}
193
194
195

	mutex_unlock(&pm_mutex);

196
197
198
	return res;
}

199
200
static long snapshot_ioctl(struct file *filp, unsigned int cmd,
							unsigned long arg)
201
202
203
{
	int error = 0;
	struct snapshot_data *data;
204
	loff_t size;
205
	sector_t offset;
206
207
208
209
210
211
212
213

	if (_IOC_TYPE(cmd) != SNAPSHOT_IOC_MAGIC)
		return -ENOTTY;
	if (_IOC_NR(cmd) > SNAPSHOT_IOC_MAXNR)
		return -ENOTTY;
	if (!capable(CAP_SYS_ADMIN))
		return -EPERM;

214
215
	if (!mutex_trylock(&pm_mutex))
		return -EBUSY;
216

217
	data = filp->private_data;
218

219
220
221
222
223
	switch (cmd) {

	case SNAPSHOT_FREEZE:
		if (data->frozen)
			break;
224

225
226
227
228
		printk("Syncing filesystems ... ");
		sys_sync();
		printk("done.\n");

229
		error = usermodehelper_disable();
230
		if (error)
231
232
233
234
			break;

		error = freeze_processes();
		if (error) {
235
			thaw_processes();
236
237
			usermodehelper_enable();
		}
238
239
240
241
242
		if (!error)
			data->frozen = 1;
		break;

	case SNAPSHOT_UNFREEZE:
243
		if (!data->frozen || data->ready)
244
245
			break;
		thaw_processes();
246
		usermodehelper_enable();
247
248
249
		data->frozen = 0;
		break;

250
	case SNAPSHOT_CREATE_IMAGE:
251
252
253
254
255
	case SNAPSHOT_ATOMIC_SNAPSHOT:
		if (data->mode != O_RDONLY || !data->frozen  || data->ready) {
			error = -EPERM;
			break;
		}
256
		error = hibernation_snapshot(data->platform_support);
257
		if (!error)
258
			error = put_user(in_suspend, (int __user *)arg);
259
260
261
262
263
		if (!error)
			data->ready = 1;
		break;

	case SNAPSHOT_ATOMIC_RESTORE:
264
		snapshot_write_finalize(&data->handle);
265
266
267
268
269
		if (data->mode != O_WRONLY || !data->frozen ||
		    !snapshot_image_loaded(&data->handle)) {
			error = -EPERM;
			break;
		}
270
		error = hibernation_restore(data->platform_support);
271
272
273
274
275
276
277
278
		break;

	case SNAPSHOT_FREE:
		swsusp_free();
		memset(&data->handle, 0, sizeof(struct snapshot_handle));
		data->ready = 0;
		break;

279
	case SNAPSHOT_PREF_IMAGE_SIZE:
280
281
282
283
	case SNAPSHOT_SET_IMAGE_SIZE:
		image_size = arg;
		break;

284
285
286
287
288
289
290
291
292
293
	case SNAPSHOT_GET_IMAGE_SIZE:
		if (!data->ready) {
			error = -ENODATA;
			break;
		}
		size = snapshot_get_image_size();
		size <<= PAGE_SHIFT;
		error = put_user(size, (loff_t __user *)arg);
		break;

294
	case SNAPSHOT_AVAIL_SWAP_SIZE:
295
	case SNAPSHOT_AVAIL_SWAP:
296
297
298
		size = count_swap_pages(data->swap, 1);
		size <<= PAGE_SHIFT;
		error = put_user(size, (loff_t __user *)arg);
299
300
		break;

301
	case SNAPSHOT_ALLOC_SWAP_PAGE:
302
303
304
305
306
	case SNAPSHOT_GET_SWAP_PAGE:
		if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
			error = -ENODEV;
			break;
		}
307
		offset = alloc_swapdev_block(data->swap);
308
309
		if (offset) {
			offset <<= PAGE_SHIFT;
310
			error = put_user(offset, (loff_t __user *)arg);
311
312
313
314
315
316
317
318
319
320
		} else {
			error = -ENOSPC;
		}
		break;

	case SNAPSHOT_FREE_SWAP_PAGES:
		if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
			error = -ENODEV;
			break;
		}
321
		free_all_swap_pages(data->swap);
322
323
		break;

324
	case SNAPSHOT_SET_SWAP_FILE: /* This ioctl is deprecated */
325
		if (!swsusp_swap_in_use()) {
326
327
328
329
330
			/*
			 * User space encodes device types as two-byte values,
			 * so we need to recode them
			 */
			if (old_decode_dev(arg)) {
331
332
				data->swap = swap_type_of(old_decode_dev(arg),
							0, NULL);
333
334
335
336
337
338
339
340
341
342
343
				if (data->swap < 0)
					error = -ENODEV;
			} else {
				data->swap = -1;
				error = -EINVAL;
			}
		} else {
			error = -EPERM;
		}
		break;

344
345
346
347
348
	case SNAPSHOT_S2RAM:
		if (!data->frozen) {
			error = -EPERM;
			break;
		}
349
350
351
352
353
		/*
		 * Tasks are frozen and the notifiers have been called with
		 * PM_HIBERNATION_PREPARE
		 */
		error = suspend_devices_and_enter(PM_SUSPEND_MEM);
354
355
		break;

356
357
358
359
360
361
362
363
364
365
	case SNAPSHOT_PLATFORM_SUPPORT:
		data->platform_support = !!arg;
		break;

	case SNAPSHOT_POWER_OFF:
		if (data->platform_support)
			error = hibernation_platform_enter();
		break;

	case SNAPSHOT_PMOPS: /* This ioctl is deprecated */
366
367
		error = -EINVAL;

368
369
370
		switch (arg) {

		case PMOPS_PREPARE:
371
			data->platform_support = 1;
372
			error = 0;
373
374
375
			break;

		case PMOPS_ENTER:
376
			if (data->platform_support)
377
				error = hibernation_platform_enter();
378
379
380
			break;

		case PMOPS_FINISH:
381
			if (data->platform_support)
382
				error = 0;
383
384
385
386
387
388
389
390
			break;

		default:
			printk(KERN_ERR "SNAPSHOT_PMOPS: invalid argument %ld\n", arg);

		}
		break;

391
	case SNAPSHOT_SET_SWAP_AREA:
392
		if (swsusp_swap_in_use()) {
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
			error = -EPERM;
		} else {
			struct resume_swap_area swap_area;
			dev_t swdev;

			error = copy_from_user(&swap_area, (void __user *)arg,
					sizeof(struct resume_swap_area));
			if (error) {
				error = -EFAULT;
				break;
			}

			/*
			 * User space encodes device types as two-byte values,
			 * so we need to recode them
			 */
			swdev = old_decode_dev(swap_area.dev);
			if (swdev) {
				offset = swap_area.offset;
412
				data->swap = swap_type_of(swdev, offset, NULL);
413
414
415
416
417
418
419
420
421
				if (data->swap < 0)
					error = -ENODEV;
			} else {
				data->swap = -1;
				error = -EINVAL;
			}
		}
		break;

422
423
424
425
	default:
		error = -ENOTTY;

	}
426
427
428

	mutex_unlock(&pm_mutex);

429
430
431
	return error;
}

432
static const struct file_operations snapshot_fops = {
433
434
435
436
437
	.open = snapshot_open,
	.release = snapshot_release,
	.read = snapshot_read,
	.write = snapshot_write,
	.llseek = no_llseek,
438
	.unlocked_ioctl = snapshot_ioctl,
439
440
441
442
443
444
445
446
447
448
449
450
451
452
};

static struct miscdevice snapshot_device = {
	.minor = SNAPSHOT_MINOR,
	.name = "snapshot",
	.fops = &snapshot_fops,
};

static int __init snapshot_device_init(void)
{
	return misc_register(&snapshot_device);
};

device_initcall(snapshot_device_init);