Merge tag 'ceph-for-6.8-rc1' of https://github.com/ceph/ceph-client
[linux-block.git] / kernel / power / user.c
CommitLineData
55716d26 1// SPDX-License-Identifier: GPL-2.0-only
6e1819d6
RW
2/*
3 * linux/kernel/power/user.c
4 *
5 * This file provides the user space interface for software suspend/resume.
6 *
7 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
6e1819d6
RW
8 */
9
10#include <linux/suspend.h>
3592695c 11#include <linux/reboot.h>
6e1819d6
RW
12#include <linux/string.h>
13#include <linux/device.h>
14#include <linux/miscdevice.h>
15#include <linux/mm.h>
16#include <linux/swap.h>
17#include <linux/swapops.h>
18#include <linux/pm.h>
19#include <linux/fs.h>
c336078b 20#include <linux/compat.h>
97c7801c 21#include <linux/console.h>
e3920fb4 22#include <linux/cpu.h>
7dfb7103 23#include <linux/freezer.h>
6e1819d6 24
7c0f6ba6 25#include <linux/uaccess.h>
6e1819d6
RW
26
27#include "power.h"
28
8386c414 29static bool need_wait;
eb57c1cf 30
6e1819d6
RW
31static struct snapshot_data {
32 struct snapshot_handle handle;
33 int swap;
6e1819d6 34 int mode;
7bc9b1cf
RW
35 bool frozen;
36 bool ready;
37 bool platform_support;
aab17289 38 bool free_bitmaps;
bb3247a3 39 dev_t dev;
6e1819d6
RW
40} snapshot_state;
41
bb3247a3 42int is_hibernate_resume_dev(dev_t dev)
ad1e4f74 43{
bb3247a3 44 return hibernation_available() && snapshot_state.dev == dev;
ad1e4f74
DA
45}
46
6e1819d6
RW
47static int snapshot_open(struct inode *inode, struct file *filp)
48{
49 struct snapshot_data *data;
5950e5d5 50 unsigned int sleep_flags;
70d93298 51 int error;
6e1819d6 52
a6e15a39
KC
53 if (!hibernation_available())
54 return -EPERM;
55
5950e5d5 56 sleep_flags = lock_system_sleep();
25f2f3da 57
ab7e9b06 58 if (!hibernate_acquire()) {
25f2f3da
RW
59 error = -EBUSY;
60 goto Unlock;
61 }
6e1819d6 62
1525a2ad 63 if ((filp->f_flags & O_ACCMODE) == O_RDWR) {
ab7e9b06 64 hibernate_release();
25f2f3da
RW
65 error = -ENOSYS;
66 goto Unlock;
1525a2ad 67 }
6e1819d6
RW
68 nonseekable_open(inode, filp);
69 data = &snapshot_state;
70 filp->private_data = data;
71 memset(&data->handle, 0, sizeof(struct snapshot_handle));
72 if ((filp->f_flags & O_ACCMODE) == O_RDONLY) {
c7510859 73 /* Hibernating. The image device should be accessible. */
21bd9005 74 data->swap = swap_type_of(swsusp_resume_device, 0);
6e1819d6 75 data->mode = O_RDONLY;
6a0c7cd3 76 data->free_bitmaps = false;
70d93298 77 error = pm_notifier_call_chain_robust(PM_HIBERNATION_PREPARE, PM_POST_HIBERNATION);
6e1819d6 78 } else {
c7510859
RW
79 /*
80 * Resuming. We may need to wait for the image device to
81 * appear.
82 */
8386c414 83 need_wait = true;
c7510859 84
6e1819d6
RW
85 data->swap = -1;
86 data->mode = O_WRONLY;
70d93298 87 error = pm_notifier_call_chain_robust(PM_RESTORE_PREPARE, PM_POST_RESTORE);
aab17289
RW
88 if (!error) {
89 error = create_basic_memory_bitmaps();
90 data->free_bitmaps = !error;
70d93298 91 }
c3e94d89 92 }
8fd37a4c 93 if (error)
ab7e9b06 94 hibernate_release();
8fd37a4c 95
7bc9b1cf
RW
96 data->frozen = false;
97 data->ready = false;
98 data->platform_support = false;
bb3247a3 99 data->dev = 0;
6e1819d6 100
25f2f3da 101 Unlock:
5950e5d5 102 unlock_system_sleep(sleep_flags);
25f2f3da
RW
103
104 return error;
6e1819d6
RW
105}
106
107static int snapshot_release(struct inode *inode, struct file *filp)
108{
109 struct snapshot_data *data;
5950e5d5 110 unsigned int sleep_flags;
6e1819d6 111
5950e5d5 112 sleep_flags = lock_system_sleep();
25f2f3da 113
6e1819d6
RW
114 swsusp_free();
115 data = filp->private_data;
bb3247a3 116 data->dev = 0;
d1d241cc 117 free_all_swap_pages(data->swap);
9744997a
RW
118 if (data->frozen) {
119 pm_restore_gfp_mask();
8fd37a4c 120 free_basic_memory_bitmaps();
6e1819d6 121 thaw_processes();
aab17289
RW
122 } else if (data->free_bitmaps) {
123 free_basic_memory_bitmaps();
9744997a 124 }
1497dd1d 125 pm_notifier_call_chain(data->mode == O_RDONLY ?
c3e94d89 126 PM_POST_HIBERNATION : PM_POST_RESTORE);
ab7e9b06 127 hibernate_release();
25f2f3da 128
5950e5d5 129 unlock_system_sleep(sleep_flags);
25f2f3da 130
6e1819d6
RW
131 return 0;
132}
133
134static ssize_t snapshot_read(struct file *filp, char __user *buf,
135 size_t count, loff_t *offp)
136{
5950e5d5 137 loff_t pg_offp = *offp & ~PAGE_MASK;
6e1819d6 138 struct snapshot_data *data;
5950e5d5 139 unsigned int sleep_flags;
6e1819d6
RW
140 ssize_t res;
141
5950e5d5 142 sleep_flags = 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:
5950e5d5 163 unlock_system_sleep(sleep_flags);
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{
5950e5d5 171 loff_t pg_offp = *offp & ~PAGE_MASK;
6e1819d6 172 struct snapshot_data *data;
5950e5d5 173 unsigned long sleep_flags;
6e1819d6
RW
174 ssize_t res;
175
8386c414
TH
176 if (need_wait) {
177 wait_for_device_probe();
178 need_wait = false;
179 }
180
5950e5d5 181 sleep_flags = lock_system_sleep();
25f2f3da 182
6e1819d6 183 data = filp->private_data;
d3c1b24c
JS
184
185 if (!pg_offp) {
186 res = snapshot_write_next(&data->handle);
187 if (res <= 0)
188 goto unlock;
189 } else {
88a5045f 190 res = PAGE_SIZE;
6e1819d6 191 }
25f2f3da 192
fc14eebf
TH
193 if (!data_of(data->handle)) {
194 res = -EINVAL;
195 goto unlock;
196 }
197
d3c1b24c
JS
198 res = simple_write_to_buffer(data_of(data->handle), res, &pg_offp,
199 buf, count);
200 if (res > 0)
201 *offp += res;
202unlock:
5950e5d5 203 unlock_system_sleep(sleep_flags);
25f2f3da 204
6e1819d6
RW
205 return res;
206}
207
0f5c4c6e
CH
208struct compat_resume_swap_area {
209 compat_loff_t offset;
210 u32 dev;
211} __packed;
212
88a77559
CH
213static int snapshot_set_swap_area(struct snapshot_data *data,
214 void __user *argp)
215{
88a77559
CH
216 sector_t offset;
217 dev_t swdev;
218
219 if (swsusp_swap_in_use())
220 return -EPERM;
0f5c4c6e
CH
221
222 if (in_compat_syscall()) {
223 struct compat_resume_swap_area swap_area;
224
225 if (copy_from_user(&swap_area, argp, sizeof(swap_area)))
226 return -EFAULT;
227 swdev = new_decode_dev(swap_area.dev);
228 offset = swap_area.offset;
229 } else {
230 struct resume_swap_area swap_area;
231
232 if (copy_from_user(&swap_area, argp, sizeof(swap_area)))
233 return -EFAULT;
234 swdev = new_decode_dev(swap_area.dev);
235 offset = swap_area.offset;
236 }
88a77559
CH
237
238 /*
239 * User space encodes device types as two-byte values,
240 * so we need to recode them
241 */
21bd9005 242 data->swap = swap_type_of(swdev, offset);
88a77559 243 if (data->swap < 0)
21bd9005
CH
244 return swdev ? -ENODEV : -EINVAL;
245 data->dev = swdev;
88a77559
CH
246 return 0;
247}
248
52d11025
AC
249static long snapshot_ioctl(struct file *filp, unsigned int cmd,
250 unsigned long arg)
6e1819d6
RW
251{
252 int error = 0;
253 struct snapshot_data *data;
af508b34 254 loff_t size;
3aef83e0 255 sector_t offset;
6e1819d6 256
8386c414
TH
257 if (need_wait) {
258 wait_for_device_probe();
259 need_wait = false;
260 }
261
6e1819d6
RW
262 if (_IOC_TYPE(cmd) != SNAPSHOT_IOC_MAGIC)
263 return -ENOTTY;
264 if (_IOC_NR(cmd) > SNAPSHOT_IOC_MAXNR)
265 return -ENOTTY;
266 if (!capable(CAP_SYS_ADMIN))
267 return -EPERM;
268
55f2503c 269 if (!mutex_trylock(&system_transition_mutex))
25f2f3da 270 return -EBUSY;
6e1819d6 271
942f4015 272 lock_device_hotplug();
25f2f3da 273 data = filp->private_data;
52d11025 274
6e1819d6
RW
275 switch (cmd) {
276
277 case SNAPSHOT_FREEZE:
278 if (data->frozen)
279 break;
1bfcf130 280
b5dee313 281 ksys_sync_helper();
c3e94d89 282
1bfcf130 283 error = freeze_processes();
8fd37a4c
RW
284 if (error)
285 break;
286
287 error = create_basic_memory_bitmaps();
288 if (error)
289 thaw_processes();
290 else
7bc9b1cf 291 data->frozen = true;
8fd37a4c 292
6e1819d6
RW
293 break;
294
295 case SNAPSHOT_UNFREEZE:
2f41dddb 296 if (!data->frozen || data->ready)
6e1819d6 297 break;
c9e664f1 298 pm_restore_gfp_mask();
8fd37a4c 299 free_basic_memory_bitmaps();
aab17289 300 data->free_bitmaps = false;
6e1819d6 301 thaw_processes();
7bc9b1cf 302 data->frozen = false;
6e1819d6
RW
303 break;
304
b694e52e 305 case SNAPSHOT_CREATE_IMAGE:
6e1819d6
RW
306 if (data->mode != O_RDONLY || !data->frozen || data->ready) {
307 error = -EPERM;
308 break;
309 }
c9e664f1 310 pm_restore_gfp_mask();
eb57c1cf 311 error = hibernation_snapshot(data->platform_support);
51d6ff7a 312 if (!error) {
cc5d207c 313 error = put_user(in_suspend, (int __user *)arg);
a556d5b5
SB
314 data->ready = !freezer_test_done && !error;
315 freezer_test_done = false;
97819a26 316 }
6e1819d6
RW
317 break;
318
319 case SNAPSHOT_ATOMIC_RESTORE:
8357376d 320 snapshot_write_finalize(&data->handle);
6e1819d6
RW
321 if (data->mode != O_WRONLY || !data->frozen ||
322 !snapshot_image_loaded(&data->handle)) {
323 error = -EPERM;
324 break;
325 }
eb57c1cf 326 error = hibernation_restore(data->platform_support);
6e1819d6
RW
327 break;
328
329 case SNAPSHOT_FREE:
330 swsusp_free();
331 memset(&data->handle, 0, sizeof(struct snapshot_handle));
7bc9b1cf 332 data->ready = false;
181e9bde
RW
333 /*
334 * It is necessary to thaw kernel threads here, because
335 * SNAPSHOT_CREATE_IMAGE may be invoked directly after
336 * SNAPSHOT_FREE. In that case, if kernel threads were not
337 * thawed, the preallocation of memory carried out by
338 * hibernation_snapshot() might run into problems (i.e. it
339 * might fail or even deadlock).
340 */
341 thaw_kernel_threads();
6e1819d6
RW
342 break;
343
b694e52e 344 case SNAPSHOT_PREF_IMAGE_SIZE:
6e1819d6
RW
345 image_size = arg;
346 break;
347
af508b34
RW
348 case SNAPSHOT_GET_IMAGE_SIZE:
349 if (!data->ready) {
350 error = -ENODATA;
351 break;
352 }
353 size = snapshot_get_image_size();
354 size <<= PAGE_SHIFT;
355 error = put_user(size, (loff_t __user *)arg);
356 break;
357
b694e52e 358 case SNAPSHOT_AVAIL_SWAP_SIZE:
af508b34
RW
359 size = count_swap_pages(data->swap, 1);
360 size <<= PAGE_SHIFT;
361 error = put_user(size, (loff_t __user *)arg);
6e1819d6
RW
362 break;
363
b694e52e 364 case SNAPSHOT_ALLOC_SWAP_PAGE:
6e1819d6
RW
365 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
366 error = -ENODEV;
367 break;
368 }
d1d241cc 369 offset = alloc_swapdev_block(data->swap);
6e1819d6
RW
370 if (offset) {
371 offset <<= PAGE_SHIFT;
cc5d207c 372 error = put_user(offset, (loff_t __user *)arg);
6e1819d6
RW
373 } else {
374 error = -ENOSPC;
375 }
376 break;
377
378 case SNAPSHOT_FREE_SWAP_PAGES:
379 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
380 error = -ENODEV;
381 break;
382 }
d1d241cc 383 free_all_swap_pages(data->swap);
6e1819d6
RW
384 break;
385
9b238205
LT
386 case SNAPSHOT_S2RAM:
387 if (!data->frozen) {
388 error = -EPERM;
389 break;
390 }
6c961dfb
RW
391 /*
392 * Tasks are frozen and the notifiers have been called with
393 * PM_HIBERNATION_PREPARE
394 */
395 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
7bc9b1cf 396 data->ready = false;
9b238205
LT
397 break;
398
eb57c1cf
RW
399 case SNAPSHOT_PLATFORM_SUPPORT:
400 data->platform_support = !!arg;
401 break;
402
403 case SNAPSHOT_POWER_OFF:
404 if (data->platform_support)
405 error = hibernation_platform_enter();
406 break;
407
37b2ba12 408 case SNAPSHOT_SET_SWAP_AREA:
88a77559 409 error = snapshot_set_swap_area(data, (void __user *)arg);
37b2ba12
RW
410 break;
411
6e1819d6
RW
412 default:
413 error = -ENOTTY;
414
415 }
25f2f3da 416
942f4015 417 unlock_device_hotplug();
55f2503c 418 mutex_unlock(&system_transition_mutex);
25f2f3da 419
6e1819d6
RW
420 return error;
421}
422
c336078b 423#ifdef CONFIG_COMPAT
c336078b
BH
424static long
425snapshot_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
426{
427 BUILD_BUG_ON(sizeof(loff_t) != sizeof(compat_loff_t));
428
429 switch (cmd) {
430 case SNAPSHOT_GET_IMAGE_SIZE:
431 case SNAPSHOT_AVAIL_SWAP_SIZE:
fba616a4 432 case SNAPSHOT_ALLOC_SWAP_PAGE:
c336078b 433 case SNAPSHOT_CREATE_IMAGE:
0f5c4c6e 434 case SNAPSHOT_SET_SWAP_AREA:
c336078b
BH
435 return snapshot_ioctl(file, cmd,
436 (unsigned long) compat_ptr(arg));
c336078b
BH
437 default:
438 return snapshot_ioctl(file, cmd, arg);
439 }
440}
c336078b
BH
441#endif /* CONFIG_COMPAT */
442
15ad7cdc 443static const struct file_operations snapshot_fops = {
6e1819d6
RW
444 .open = snapshot_open,
445 .release = snapshot_release,
446 .read = snapshot_read,
447 .write = snapshot_write,
448 .llseek = no_llseek,
52d11025 449 .unlocked_ioctl = snapshot_ioctl,
c336078b
BH
450#ifdef CONFIG_COMPAT
451 .compat_ioctl = snapshot_compat_ioctl,
452#endif
6e1819d6
RW
453};
454
455static struct miscdevice snapshot_device = {
456 .minor = SNAPSHOT_MINOR,
457 .name = "snapshot",
458 .fops = &snapshot_fops,
459};
460
461static int __init snapshot_device_init(void)
462{
463 return misc_register(&snapshot_device);
464};
465
466device_initcall(snapshot_device_init);