1 // SPDX-License-Identifier: GPL-2.0-only 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> 8 */ 9 10 #include <linux/suspend.h> 11 #include <linux/reboot.h> 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> 20 #include <linux/compat.h> 21 #include <linux/console.h> 22 #include <linux/cpu.h> 23 #include <linux/freezer.h> 24 25 #include <linux/uaccess.h> 26 27 #include "power.h" 28 29 static bool need_wait; 30 31 static struct snapshot_data { 32 struct snapshot_handle handle; 33 int swap; 34 int mode; 35 bool frozen; 36 bool ready; 37 bool platform_support; 38 bool free_bitmaps; 39 dev_t dev; 40 } snapshot_state; 41 42 int is_hibernate_resume_dev(dev_t dev) 43 { 44 return hibernation_available() && snapshot_state.dev == dev; 45 } 46 47 static int snapshot_open(struct inode *inode, struct file *filp) 48 { 49 struct snapshot_data *data; 50 unsigned int sleep_flags; 51 int error; 52 53 if (!hibernation_available()) 54 return -EPERM; 55 56 sleep_flags = lock_system_sleep(); 57 58 if (!hibernate_acquire()) { 59 error = -EBUSY; 60 goto Unlock; 61 } 62 63 if ((filp->f_flags & O_ACCMODE) == O_RDWR) { 64 hibernate_release(); 65 error = -ENOSYS; 66 goto Unlock; 67 } 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) { 73 /* Hibernating. The image device should be accessible. */ 74 data->swap = swap_type_of(swsusp_resume_device, 0); 75 data->mode = O_RDONLY; 76 data->free_bitmaps = false; 77 error = pm_notifier_call_chain_robust(PM_HIBERNATION_PREPARE, PM_POST_HIBERNATION); 78 } else { 79 /* 80 * Resuming. We may need to wait for the image device to 81 * appear. 82 */ 83 need_wait = true; 84 85 data->swap = -1; 86 data->mode = O_WRONLY; 87 error = pm_notifier_call_chain_robust(PM_RESTORE_PREPARE, PM_POST_RESTORE); 88 if (!error) { 89 error = create_basic_memory_bitmaps(); 90 data->free_bitmaps = !error; 91 } 92 } 93 if (error) 94 hibernate_release(); 95 96 data->frozen = false; 97 data->ready = false; 98 data->platform_support = false; 99 data->dev = 0; 100 101 Unlock: 102 unlock_system_sleep(sleep_flags); 103 104 return error; 105 } 106 107 static int snapshot_release(struct inode *inode, struct file *filp) 108 { 109 struct snapshot_data *data; 110 unsigned int sleep_flags; 111 112 sleep_flags = lock_system_sleep(); 113 114 swsusp_free(); 115 data = filp->private_data; 116 data->dev = 0; 117 free_all_swap_pages(data->swap); 118 if (data->frozen) { 119 pm_restore_gfp_mask(); 120 free_basic_memory_bitmaps(); 121 thaw_processes(); 122 } else if (data->free_bitmaps) { 123 free_basic_memory_bitmaps(); 124 } 125 pm_notifier_call_chain(data->mode == O_RDONLY ? 126 PM_POST_HIBERNATION : PM_POST_RESTORE); 127 hibernate_release(); 128 129 unlock_system_sleep(sleep_flags); 130 131 return 0; 132 } 133 134 static ssize_t snapshot_read(struct file *filp, char __user *buf, 135 size_t count, loff_t *offp) 136 { 137 loff_t pg_offp = *offp & ~PAGE_MASK; 138 struct snapshot_data *data; 139 unsigned int sleep_flags; 140 ssize_t res; 141 142 sleep_flags = lock_system_sleep(); 143 144 data = filp->private_data; 145 if (!data->ready) { 146 res = -ENODATA; 147 goto Unlock; 148 } 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; 155 } 156 157 res = simple_read_from_buffer(buf, count, &pg_offp, 158 data_of(data->handle), res); 159 if (res > 0) 160 *offp += res; 161 162 Unlock: 163 unlock_system_sleep(sleep_flags); 164 165 return res; 166 } 167 168 static ssize_t snapshot_write(struct file *filp, const char __user *buf, 169 size_t count, loff_t *offp) 170 { 171 loff_t pg_offp = *offp & ~PAGE_MASK; 172 struct snapshot_data *data; 173 unsigned long sleep_flags; 174 ssize_t res; 175 176 if (need_wait) { 177 wait_for_device_probe(); 178 need_wait = false; 179 } 180 181 sleep_flags = lock_system_sleep(); 182 183 data = filp->private_data; 184 185 if (!pg_offp) { 186 res = snapshot_write_next(&data->handle); 187 if (res <= 0) 188 goto unlock; 189 } else { 190 res = PAGE_SIZE; 191 } 192 193 if (!data_of(data->handle)) { 194 res = -EINVAL; 195 goto unlock; 196 } 197 198 res = simple_write_to_buffer(data_of(data->handle), res, &pg_offp, 199 buf, count); 200 if (res > 0) 201 *offp += res; 202 unlock: 203 unlock_system_sleep(sleep_flags); 204 205 return res; 206 } 207 208 struct compat_resume_swap_area { 209 compat_loff_t offset; 210 u32 dev; 211 } __packed; 212 213 static int snapshot_set_swap_area(struct snapshot_data *data, 214 void __user *argp) 215 { 216 sector_t offset; 217 dev_t swdev; 218 219 if (swsusp_swap_in_use()) 220 return -EPERM; 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 } 237 238 /* 239 * User space encodes device types as two-byte values, 240 * so we need to recode them 241 */ 242 data->swap = swap_type_of(swdev, offset); 243 if (data->swap < 0) 244 return swdev ? -ENODEV : -EINVAL; 245 data->dev = swdev; 246 return 0; 247 } 248 249 static long snapshot_ioctl(struct file *filp, unsigned int cmd, 250 unsigned long arg) 251 { 252 int error = 0; 253 struct snapshot_data *data; 254 loff_t size; 255 sector_t offset; 256 257 if (need_wait) { 258 wait_for_device_probe(); 259 need_wait = false; 260 } 261 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 269 if (!mutex_trylock(&system_transition_mutex)) 270 return -EBUSY; 271 272 lock_device_hotplug(); 273 data = filp->private_data; 274 275 switch (cmd) { 276 277 case SNAPSHOT_FREEZE: 278 if (data->frozen) 279 break; 280 281 error = pm_sleep_fs_sync(); 282 if (error) 283 break; 284 285 error = freeze_processes(); 286 if (error) 287 break; 288 289 error = create_basic_memory_bitmaps(); 290 if (error) 291 thaw_processes(); 292 else 293 data->frozen = true; 294 295 break; 296 297 case SNAPSHOT_UNFREEZE: 298 if (!data->frozen || data->ready) 299 break; 300 pm_restore_gfp_mask(); 301 free_basic_memory_bitmaps(); 302 data->free_bitmaps = false; 303 thaw_processes(); 304 data->frozen = false; 305 break; 306 307 case SNAPSHOT_CREATE_IMAGE: 308 if (data->mode != O_RDONLY || !data->frozen || data->ready) { 309 error = -EPERM; 310 break; 311 } 312 pm_restore_gfp_mask(); 313 error = hibernation_snapshot(data->platform_support); 314 if (!error) { 315 error = put_user(in_suspend, (int __user *)arg); 316 data->ready = !freezer_test_done && !error; 317 freezer_test_done = false; 318 } 319 break; 320 321 case SNAPSHOT_ATOMIC_RESTORE: 322 error = snapshot_write_finalize(&data->handle); 323 if (error) 324 break; 325 if (data->mode != O_WRONLY || !data->frozen) { 326 error = -EPERM; 327 break; 328 } 329 if (!snapshot_image_loaded(&data->handle)) { 330 error = -ENODATA; 331 break; 332 } 333 error = hibernation_restore(data->platform_support); 334 break; 335 336 case SNAPSHOT_FREE: 337 swsusp_free(); 338 memset(&data->handle, 0, sizeof(struct snapshot_handle)); 339 data->ready = false; 340 /* 341 * It is necessary to thaw kernel threads here, because 342 * SNAPSHOT_CREATE_IMAGE may be invoked directly after 343 * SNAPSHOT_FREE. In that case, if kernel threads were not 344 * thawed, the preallocation of memory carried out by 345 * hibernation_snapshot() might run into problems (i.e. it 346 * might fail or even deadlock). 347 */ 348 thaw_kernel_threads(); 349 break; 350 351 case SNAPSHOT_PREF_IMAGE_SIZE: 352 image_size = arg; 353 break; 354 355 case SNAPSHOT_GET_IMAGE_SIZE: 356 if (!data->ready) { 357 error = -ENODATA; 358 break; 359 } 360 size = snapshot_get_image_size(); 361 size <<= PAGE_SHIFT; 362 error = put_user(size, (loff_t __user *)arg); 363 break; 364 365 case SNAPSHOT_AVAIL_SWAP_SIZE: 366 size = count_swap_pages(data->swap, 1); 367 size <<= PAGE_SHIFT; 368 error = put_user(size, (loff_t __user *)arg); 369 break; 370 371 case SNAPSHOT_ALLOC_SWAP_PAGE: 372 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) { 373 error = -ENODEV; 374 break; 375 } 376 offset = alloc_swapdev_block(data->swap); 377 if (offset) { 378 offset <<= PAGE_SHIFT; 379 error = put_user(offset, (loff_t __user *)arg); 380 } else { 381 error = -ENOSPC; 382 } 383 break; 384 385 case SNAPSHOT_FREE_SWAP_PAGES: 386 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) { 387 error = -ENODEV; 388 break; 389 } 390 free_all_swap_pages(data->swap); 391 break; 392 393 case SNAPSHOT_S2RAM: 394 if (!data->frozen) { 395 error = -EPERM; 396 break; 397 } 398 /* 399 * Tasks are frozen and the notifiers have been called with 400 * PM_HIBERNATION_PREPARE 401 */ 402 error = suspend_devices_and_enter(PM_SUSPEND_MEM); 403 data->ready = false; 404 break; 405 406 case SNAPSHOT_PLATFORM_SUPPORT: 407 data->platform_support = !!arg; 408 break; 409 410 case SNAPSHOT_POWER_OFF: 411 if (data->platform_support) 412 error = hibernation_platform_enter(); 413 break; 414 415 case SNAPSHOT_SET_SWAP_AREA: 416 error = snapshot_set_swap_area(data, (void __user *)arg); 417 break; 418 419 default: 420 error = -ENOTTY; 421 422 } 423 424 unlock_device_hotplug(); 425 mutex_unlock(&system_transition_mutex); 426 427 return error; 428 } 429 430 #ifdef CONFIG_COMPAT 431 static long 432 snapshot_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg) 433 { 434 BUILD_BUG_ON(sizeof(loff_t) != sizeof(compat_loff_t)); 435 436 switch (cmd) { 437 case SNAPSHOT_GET_IMAGE_SIZE: 438 case SNAPSHOT_AVAIL_SWAP_SIZE: 439 case SNAPSHOT_ALLOC_SWAP_PAGE: 440 case SNAPSHOT_CREATE_IMAGE: 441 case SNAPSHOT_SET_SWAP_AREA: 442 return snapshot_ioctl(file, cmd, 443 (unsigned long) compat_ptr(arg)); 444 default: 445 return snapshot_ioctl(file, cmd, arg); 446 } 447 } 448 #endif /* CONFIG_COMPAT */ 449 450 static const struct file_operations snapshot_fops = { 451 .open = snapshot_open, 452 .release = snapshot_release, 453 .read = snapshot_read, 454 .write = snapshot_write, 455 .unlocked_ioctl = snapshot_ioctl, 456 #ifdef CONFIG_COMPAT 457 .compat_ioctl = snapshot_compat_ioctl, 458 #endif 459 }; 460 461 static struct miscdevice snapshot_device = { 462 .minor = SNAPSHOT_MINOR, 463 .name = "snapshot", 464 .fops = &snapshot_fops, 465 }; 466 467 static int __init snapshot_device_init(void) 468 { 469 return misc_register(&snapshot_device); 470 }; 471 472 device_initcall(snapshot_device_init); 473