Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * linux/fs/ioctl.c
4 *
5 * Copyright (C) 1991, 1992 Linus Torvalds
6 */
7
8#include <linux/syscalls.h>
9#include <linux/mm.h>
10#include <linux/capability.h>
11#include <linux/file.h>
12#include <linux/fs.h>
13#include <linux/security.h>
14#include <linux/export.h>
15#include <linux/uaccess.h>
16#include <linux/writeback.h>
17#include <linux/buffer_head.h>
18#include <linux/falloc.h>
19#include <linux/sched/signal.h>
20
21#include "internal.h"
22
23#include <asm/ioctls.h>
24
25/* So that the fiemap access checks can't overflow on 32 bit machines. */
26#define FIEMAP_MAX_EXTENTS (UINT_MAX / sizeof(struct fiemap_extent))
27
28/**
29 * vfs_ioctl - call filesystem specific ioctl methods
30 * @filp: open file to invoke ioctl method on
31 * @cmd: ioctl command to execute
32 * @arg: command-specific argument for ioctl
33 *
34 * Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
35 * returns -ENOTTY.
36 *
37 * Returns 0 on success, -errno on error.
38 */
39long vfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
40{
41 int error = -ENOTTY;
42
43 if (!filp->f_op->unlocked_ioctl)
44 goto out;
45
46 error = filp->f_op->unlocked_ioctl(filp, cmd, arg);
47 if (error == -ENOIOCTLCMD)
48 error = -ENOTTY;
49 out:
50 return error;
51}
52EXPORT_SYMBOL(vfs_ioctl);
53
54static int ioctl_fibmap(struct file *filp, int __user *p)
55{
56 struct address_space *mapping = filp->f_mapping;
57 int res, block;
58
59 /* do we support this mess? */
60 if (!mapping->a_ops->bmap)
61 return -EINVAL;
62 if (!capable(CAP_SYS_RAWIO))
63 return -EPERM;
64 res = get_user(block, p);
65 if (res)
66 return res;
67 res = mapping->a_ops->bmap(mapping, block);
68 return put_user(res, p);
69}
70
71/**
72 * fiemap_fill_next_extent - Fiemap helper function
73 * @fieinfo: Fiemap context passed into ->fiemap
74 * @logical: Extent logical start offset, in bytes
75 * @phys: Extent physical start offset, in bytes
76 * @len: Extent length, in bytes
77 * @flags: FIEMAP_EXTENT flags that describe this extent
78 *
79 * Called from file system ->fiemap callback. Will populate extent
80 * info as passed in via arguments and copy to user memory. On
81 * success, extent count on fieinfo is incremented.
82 *
83 * Returns 0 on success, -errno on error, 1 if this was the last
84 * extent that will fit in user array.
85 */
86#define SET_UNKNOWN_FLAGS (FIEMAP_EXTENT_DELALLOC)
87#define SET_NO_UNMOUNTED_IO_FLAGS (FIEMAP_EXTENT_DATA_ENCRYPTED)
88#define SET_NOT_ALIGNED_FLAGS (FIEMAP_EXTENT_DATA_TAIL|FIEMAP_EXTENT_DATA_INLINE)
89int fiemap_fill_next_extent(struct fiemap_extent_info *fieinfo, u64 logical,
90 u64 phys, u64 len, u32 flags)
91{
92 struct fiemap_extent extent;
93 struct fiemap_extent __user *dest = fieinfo->fi_extents_start;
94
95 /* only count the extents */
96 if (fieinfo->fi_extents_max == 0) {
97 fieinfo->fi_extents_mapped++;
98 return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
99 }
100
101 if (fieinfo->fi_extents_mapped >= fieinfo->fi_extents_max)
102 return 1;
103
104 if (flags & SET_UNKNOWN_FLAGS)
105 flags |= FIEMAP_EXTENT_UNKNOWN;
106 if (flags & SET_NO_UNMOUNTED_IO_FLAGS)
107 flags |= FIEMAP_EXTENT_ENCODED;
108 if (flags & SET_NOT_ALIGNED_FLAGS)
109 flags |= FIEMAP_EXTENT_NOT_ALIGNED;
110
111 memset(&extent, 0, sizeof(extent));
112 extent.fe_logical = logical;
113 extent.fe_physical = phys;
114 extent.fe_length = len;
115 extent.fe_flags = flags;
116
117 dest += fieinfo->fi_extents_mapped;
118 if (copy_to_user(dest, &extent, sizeof(extent)))
119 return -EFAULT;
120
121 fieinfo->fi_extents_mapped++;
122 if (fieinfo->fi_extents_mapped == fieinfo->fi_extents_max)
123 return 1;
124 return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
125}
126EXPORT_SYMBOL(fiemap_fill_next_extent);
127
128/**
129 * fiemap_check_flags - check validity of requested flags for fiemap
130 * @fieinfo: Fiemap context passed into ->fiemap
131 * @fs_flags: Set of fiemap flags that the file system understands
132 *
133 * Called from file system ->fiemap callback. This will compute the
134 * intersection of valid fiemap flags and those that the fs supports. That
135 * value is then compared against the user supplied flags. In case of bad user
136 * flags, the invalid values will be written into the fieinfo structure, and
137 * -EBADR is returned, which tells ioctl_fiemap() to return those values to
138 * userspace. For this reason, a return code of -EBADR should be preserved.
139 *
140 * Returns 0 on success, -EBADR on bad flags.
141 */
142int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags)
143{
144 u32 incompat_flags;
145
146 incompat_flags = fieinfo->fi_flags & ~(FIEMAP_FLAGS_COMPAT & fs_flags);
147 if (incompat_flags) {
148 fieinfo->fi_flags = incompat_flags;
149 return -EBADR;
150 }
151 return 0;
152}
153EXPORT_SYMBOL(fiemap_check_flags);
154
155static int fiemap_check_ranges(struct super_block *sb,
156 u64 start, u64 len, u64 *new_len)
157{
158 u64 maxbytes = (u64) sb->s_maxbytes;
159
160 *new_len = len;
161
162 if (len == 0)
163 return -EINVAL;
164
165 if (start > maxbytes)
166 return -EFBIG;
167
168 /*
169 * Shrink request scope to what the fs can actually handle.
170 */
171 if (len > maxbytes || (maxbytes - len) < start)
172 *new_len = maxbytes - start;
173
174 return 0;
175}
176
177static int ioctl_fiemap(struct file *filp, unsigned long arg)
178{
179 struct fiemap fiemap;
180 struct fiemap __user *ufiemap = (struct fiemap __user *) arg;
181 struct fiemap_extent_info fieinfo = { 0, };
182 struct inode *inode = file_inode(filp);
183 struct super_block *sb = inode->i_sb;
184 u64 len;
185 int error;
186
187 if (!inode->i_op->fiemap)
188 return -EOPNOTSUPP;
189
190 if (copy_from_user(&fiemap, ufiemap, sizeof(fiemap)))
191 return -EFAULT;
192
193 if (fiemap.fm_extent_count > FIEMAP_MAX_EXTENTS)
194 return -EINVAL;
195
196 error = fiemap_check_ranges(sb, fiemap.fm_start, fiemap.fm_length,
197 &len);
198 if (error)
199 return error;
200
201 fieinfo.fi_flags = fiemap.fm_flags;
202 fieinfo.fi_extents_max = fiemap.fm_extent_count;
203 fieinfo.fi_extents_start = ufiemap->fm_extents;
204
205 if (fiemap.fm_extent_count != 0 &&
206 !access_ok(fieinfo.fi_extents_start,
207 fieinfo.fi_extents_max * sizeof(struct fiemap_extent)))
208 return -EFAULT;
209
210 if (fieinfo.fi_flags & FIEMAP_FLAG_SYNC)
211 filemap_write_and_wait(inode->i_mapping);
212
213 error = inode->i_op->fiemap(inode, &fieinfo, fiemap.fm_start, len);
214 fiemap.fm_flags = fieinfo.fi_flags;
215 fiemap.fm_mapped_extents = fieinfo.fi_extents_mapped;
216 if (copy_to_user(ufiemap, &fiemap, sizeof(fiemap)))
217 error = -EFAULT;
218
219 return error;
220}
221
222static long ioctl_file_clone(struct file *dst_file, unsigned long srcfd,
223 u64 off, u64 olen, u64 destoff)
224{
225 struct fd src_file = fdget(srcfd);
226 loff_t cloned;
227 int ret;
228
229 if (!src_file.file)
230 return -EBADF;
231 ret = -EXDEV;
232 if (src_file.file->f_path.mnt != dst_file->f_path.mnt)
233 goto fdput;
234 cloned = vfs_clone_file_range(src_file.file, off, dst_file, destoff,
235 olen, 0);
236 if (cloned < 0)
237 ret = cloned;
238 else if (olen && cloned != olen)
239 ret = -EINVAL;
240 else
241 ret = 0;
242fdput:
243 fdput(src_file);
244 return ret;
245}
246
247static long ioctl_file_clone_range(struct file *file, void __user *argp)
248{
249 struct file_clone_range args;
250
251 if (copy_from_user(&args, argp, sizeof(args)))
252 return -EFAULT;
253 return ioctl_file_clone(file, args.src_fd, args.src_offset,
254 args.src_length, args.dest_offset);
255}
256
257#ifdef CONFIG_BLOCK
258
259static inline sector_t logical_to_blk(struct inode *inode, loff_t offset)
260{
261 return (offset >> inode->i_blkbits);
262}
263
264static inline loff_t blk_to_logical(struct inode *inode, sector_t blk)
265{
266 return (blk << inode->i_blkbits);
267}
268
269/**
270 * __generic_block_fiemap - FIEMAP for block based inodes (no locking)
271 * @inode: the inode to map
272 * @fieinfo: the fiemap info struct that will be passed back to userspace
273 * @start: where to start mapping in the inode
274 * @len: how much space to map
275 * @get_block: the fs's get_block function
276 *
277 * This does FIEMAP for block based inodes. Basically it will just loop
278 * through get_block until we hit the number of extents we want to map, or we
279 * go past the end of the file and hit a hole.
280 *
281 * If it is possible to have data blocks beyond a hole past @inode->i_size, then
282 * please do not use this function, it will stop at the first unmapped block
283 * beyond i_size.
284 *
285 * If you use this function directly, you need to do your own locking. Use
286 * generic_block_fiemap if you want the locking done for you.
287 */
288
289int __generic_block_fiemap(struct inode *inode,
290 struct fiemap_extent_info *fieinfo, loff_t start,
291 loff_t len, get_block_t *get_block)
292{
293 struct buffer_head map_bh;
294 sector_t start_blk, last_blk;
295 loff_t isize = i_size_read(inode);
296 u64 logical = 0, phys = 0, size = 0;
297 u32 flags = FIEMAP_EXTENT_MERGED;
298 bool past_eof = false, whole_file = false;
299 int ret = 0;
300
301 ret = fiemap_check_flags(fieinfo, FIEMAP_FLAG_SYNC);
302 if (ret)
303 return ret;
304
305 /*
306 * Either the i_mutex or other appropriate locking needs to be held
307 * since we expect isize to not change at all through the duration of
308 * this call.
309 */
310 if (len >= isize) {
311 whole_file = true;
312 len = isize;
313 }
314
315 /*
316 * Some filesystems can't deal with being asked to map less than
317 * blocksize, so make sure our len is at least block length.
318 */
319 if (logical_to_blk(inode, len) == 0)
320 len = blk_to_logical(inode, 1);
321
322 start_blk = logical_to_blk(inode, start);
323 last_blk = logical_to_blk(inode, start + len - 1);
324
325 do {
326 /*
327 * we set b_size to the total size we want so it will map as
328 * many contiguous blocks as possible at once
329 */
330 memset(&map_bh, 0, sizeof(struct buffer_head));
331 map_bh.b_size = len;
332
333 ret = get_block(inode, start_blk, &map_bh, 0);
334 if (ret)
335 break;
336
337 /* HOLE */
338 if (!buffer_mapped(&map_bh)) {
339 start_blk++;
340
341 /*
342 * We want to handle the case where there is an
343 * allocated block at the front of the file, and then
344 * nothing but holes up to the end of the file properly,
345 * to make sure that extent at the front gets properly
346 * marked with FIEMAP_EXTENT_LAST
347 */
348 if (!past_eof &&
349 blk_to_logical(inode, start_blk) >= isize)
350 past_eof = 1;
351
352 /*
353 * First hole after going past the EOF, this is our
354 * last extent
355 */
356 if (past_eof && size) {
357 flags = FIEMAP_EXTENT_MERGED|FIEMAP_EXTENT_LAST;
358 ret = fiemap_fill_next_extent(fieinfo, logical,
359 phys, size,
360 flags);
361 } else if (size) {
362 ret = fiemap_fill_next_extent(fieinfo, logical,
363 phys, size, flags);
364 size = 0;
365 }
366
367 /* if we have holes up to/past EOF then we're done */
368 if (start_blk > last_blk || past_eof || ret)
369 break;
370 } else {
371 /*
372 * We have gone over the length of what we wanted to
373 * map, and it wasn't the entire file, so add the extent
374 * we got last time and exit.
375 *
376 * This is for the case where say we want to map all the
377 * way up to the second to the last block in a file, but
378 * the last block is a hole, making the second to last
379 * block FIEMAP_EXTENT_LAST. In this case we want to
380 * see if there is a hole after the second to last block
381 * so we can mark it properly. If we found data after
382 * we exceeded the length we were requesting, then we
383 * are good to go, just add the extent to the fieinfo
384 * and break
385 */
386 if (start_blk > last_blk && !whole_file) {
387 ret = fiemap_fill_next_extent(fieinfo, logical,
388 phys, size,
389 flags);
390 break;
391 }
392
393 /*
394 * if size != 0 then we know we already have an extent
395 * to add, so add it.
396 */
397 if (size) {
398 ret = fiemap_fill_next_extent(fieinfo, logical,
399 phys, size,
400 flags);
401 if (ret)
402 break;
403 }
404
405 logical = blk_to_logical(inode, start_blk);
406 phys = blk_to_logical(inode, map_bh.b_blocknr);
407 size = map_bh.b_size;
408 flags = FIEMAP_EXTENT_MERGED;
409
410 start_blk += logical_to_blk(inode, size);
411
412 /*
413 * If we are past the EOF, then we need to make sure as
414 * soon as we find a hole that the last extent we found
415 * is marked with FIEMAP_EXTENT_LAST
416 */
417 if (!past_eof && logical + size >= isize)
418 past_eof = true;
419 }
420 cond_resched();
421 if (fatal_signal_pending(current)) {
422 ret = -EINTR;
423 break;
424 }
425
426 } while (1);
427
428 /* If ret is 1 then we just hit the end of the extent array */
429 if (ret == 1)
430 ret = 0;
431
432 return ret;
433}
434EXPORT_SYMBOL(__generic_block_fiemap);
435
436/**
437 * generic_block_fiemap - FIEMAP for block based inodes
438 * @inode: The inode to map
439 * @fieinfo: The mapping information
440 * @start: The initial block to map
441 * @len: The length of the extect to attempt to map
442 * @get_block: The block mapping function for the fs
443 *
444 * Calls __generic_block_fiemap to map the inode, after taking
445 * the inode's mutex lock.
446 */
447
448int generic_block_fiemap(struct inode *inode,
449 struct fiemap_extent_info *fieinfo, u64 start,
450 u64 len, get_block_t *get_block)
451{
452 int ret;
453 inode_lock(inode);
454 ret = __generic_block_fiemap(inode, fieinfo, start, len, get_block);
455 inode_unlock(inode);
456 return ret;
457}
458EXPORT_SYMBOL(generic_block_fiemap);
459
460#endif /* CONFIG_BLOCK */
461
462/*
463 * This provides compatibility with legacy XFS pre-allocation ioctls
464 * which predate the fallocate syscall.
465 *
466 * Only the l_start, l_len and l_whence fields of the 'struct space_resv'
467 * are used here, rest are ignored.
468 */
469int ioctl_preallocate(struct file *filp, void __user *argp)
470{
471 struct inode *inode = file_inode(filp);
472 struct space_resv sr;
473
474 if (copy_from_user(&sr, argp, sizeof(sr)))
475 return -EFAULT;
476
477 switch (sr.l_whence) {
478 case SEEK_SET:
479 break;
480 case SEEK_CUR:
481 sr.l_start += filp->f_pos;
482 break;
483 case SEEK_END:
484 sr.l_start += i_size_read(inode);
485 break;
486 default:
487 return -EINVAL;
488 }
489
490 return vfs_fallocate(filp, FALLOC_FL_KEEP_SIZE, sr.l_start, sr.l_len);
491}
492
493static int file_ioctl(struct file *filp, unsigned int cmd,
494 unsigned long arg)
495{
496 struct inode *inode = file_inode(filp);
497 int __user *p = (int __user *)arg;
498
499 switch (cmd) {
500 case FIBMAP:
501 return ioctl_fibmap(filp, p);
502 case FIONREAD:
503 return put_user(i_size_read(inode) - filp->f_pos, p);
504 case FS_IOC_RESVSP:
505 case FS_IOC_RESVSP64:
506 return ioctl_preallocate(filp, p);
507 }
508
509 return vfs_ioctl(filp, cmd, arg);
510}
511
512static int ioctl_fionbio(struct file *filp, int __user *argp)
513{
514 unsigned int flag;
515 int on, error;
516
517 error = get_user(on, argp);
518 if (error)
519 return error;
520 flag = O_NONBLOCK;
521#ifdef __sparc__
522 /* SunOS compatibility item. */
523 if (O_NONBLOCK != O_NDELAY)
524 flag |= O_NDELAY;
525#endif
526 spin_lock(&filp->f_lock);
527 if (on)
528 filp->f_flags |= flag;
529 else
530 filp->f_flags &= ~flag;
531 spin_unlock(&filp->f_lock);
532 return error;
533}
534
535static int ioctl_fioasync(unsigned int fd, struct file *filp,
536 int __user *argp)
537{
538 unsigned int flag;
539 int on, error;
540
541 error = get_user(on, argp);
542 if (error)
543 return error;
544 flag = on ? FASYNC : 0;
545
546 /* Did FASYNC state change ? */
547 if ((flag ^ filp->f_flags) & FASYNC) {
548 if (filp->f_op->fasync)
549 /* fasync() adjusts filp->f_flags */
550 error = filp->f_op->fasync(fd, filp, on);
551 else
552 error = -ENOTTY;
553 }
554 return error < 0 ? error : 0;
555}
556
557static int ioctl_fsfreeze(struct file *filp)
558{
559 struct super_block *sb = file_inode(filp)->i_sb;
560
561 if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN))
562 return -EPERM;
563
564 /* If filesystem doesn't support freeze feature, return. */
565 if (sb->s_op->freeze_fs == NULL && sb->s_op->freeze_super == NULL)
566 return -EOPNOTSUPP;
567
568 /* Freeze */
569 if (sb->s_op->freeze_super)
570 return sb->s_op->freeze_super(sb);
571 return freeze_super(sb);
572}
573
574static int ioctl_fsthaw(struct file *filp)
575{
576 struct super_block *sb = file_inode(filp)->i_sb;
577
578 if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN))
579 return -EPERM;
580
581 /* Thaw */
582 if (sb->s_op->thaw_super)
583 return sb->s_op->thaw_super(sb);
584 return thaw_super(sb);
585}
586
587static int ioctl_file_dedupe_range(struct file *file, void __user *arg)
588{
589 struct file_dedupe_range __user *argp = arg;
590 struct file_dedupe_range *same = NULL;
591 int ret;
592 unsigned long size;
593 u16 count;
594
595 if (get_user(count, &argp->dest_count)) {
596 ret = -EFAULT;
597 goto out;
598 }
599
600 size = offsetof(struct file_dedupe_range __user, info[count]);
601 if (size > PAGE_SIZE) {
602 ret = -ENOMEM;
603 goto out;
604 }
605
606 same = memdup_user(argp, size);
607 if (IS_ERR(same)) {
608 ret = PTR_ERR(same);
609 same = NULL;
610 goto out;
611 }
612
613 same->dest_count = count;
614 ret = vfs_dedupe_file_range(file, same);
615 if (ret)
616 goto out;
617
618 ret = copy_to_user(argp, same, size);
619 if (ret)
620 ret = -EFAULT;
621
622out:
623 kfree(same);
624 return ret;
625}
626
627/*
628 * When you add any new common ioctls to the switches above and below
629 * please update compat_sys_ioctl() too.
630 *
631 * do_vfs_ioctl() is not for drivers and not intended to be EXPORT_SYMBOL()'d.
632 * It's just a simple helper for sys_ioctl and compat_sys_ioctl.
633 */
634int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
635 unsigned long arg)
636{
637 int error = 0;
638 int __user *argp = (int __user *)arg;
639 struct inode *inode = file_inode(filp);
640
641 switch (cmd) {
642 case FIOCLEX:
643 set_close_on_exec(fd, 1);
644 break;
645
646 case FIONCLEX:
647 set_close_on_exec(fd, 0);
648 break;
649
650 case FIONBIO:
651 error = ioctl_fionbio(filp, argp);
652 break;
653
654 case FIOASYNC:
655 error = ioctl_fioasync(fd, filp, argp);
656 break;
657
658 case FIOQSIZE:
659 if (S_ISDIR(inode->i_mode) || S_ISREG(inode->i_mode) ||
660 S_ISLNK(inode->i_mode)) {
661 loff_t res = inode_get_bytes(inode);
662 error = copy_to_user(argp, &res, sizeof(res)) ?
663 -EFAULT : 0;
664 } else
665 error = -ENOTTY;
666 break;
667
668 case FIFREEZE:
669 error = ioctl_fsfreeze(filp);
670 break;
671
672 case FITHAW:
673 error = ioctl_fsthaw(filp);
674 break;
675
676 case FS_IOC_FIEMAP:
677 return ioctl_fiemap(filp, arg);
678
679 case FIGETBSZ:
680 /* anon_bdev filesystems may not have a block size */
681 if (!inode->i_sb->s_blocksize)
682 return -EINVAL;
683 return put_user(inode->i_sb->s_blocksize, argp);
684
685 case FICLONE:
686 return ioctl_file_clone(filp, arg, 0, 0, 0);
687
688 case FICLONERANGE:
689 return ioctl_file_clone_range(filp, argp);
690
691 case FIDEDUPERANGE:
692 return ioctl_file_dedupe_range(filp, argp);
693
694 default:
695 if (S_ISREG(inode->i_mode))
696 error = file_ioctl(filp, cmd, arg);
697 else
698 error = vfs_ioctl(filp, cmd, arg);
699 break;
700 }
701 return error;
702}
703
704int ksys_ioctl(unsigned int fd, unsigned int cmd, unsigned long arg)
705{
706 int error;
707 struct fd f = fdget(fd);
708
709 if (!f.file)
710 return -EBADF;
711 error = security_file_ioctl(f.file, cmd, arg);
712 if (!error)
713 error = do_vfs_ioctl(f.file, fd, cmd, arg);
714 fdput(f);
715 return error;
716}
717
718SYSCALL_DEFINE3(ioctl, unsigned int, fd, unsigned int, cmd, unsigned long, arg)
719{
720 return ksys_ioctl(fd, cmd, arg);
721}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * linux/fs/ioctl.c
4 *
5 * Copyright (C) 1991, 1992 Linus Torvalds
6 */
7
8#include <linux/syscalls.h>
9#include <linux/mm.h>
10#include <linux/capability.h>
11#include <linux/compat.h>
12#include <linux/file.h>
13#include <linux/fs.h>
14#include <linux/security.h>
15#include <linux/export.h>
16#include <linux/uaccess.h>
17#include <linux/writeback.h>
18#include <linux/buffer_head.h>
19#include <linux/falloc.h>
20#include <linux/sched/signal.h>
21#include <linux/fiemap.h>
22#include <linux/mount.h>
23#include <linux/fscrypt.h>
24#include <linux/fileattr.h>
25
26#include "internal.h"
27
28#include <asm/ioctls.h>
29
30/* So that the fiemap access checks can't overflow on 32 bit machines. */
31#define FIEMAP_MAX_EXTENTS (UINT_MAX / sizeof(struct fiemap_extent))
32
33/**
34 * vfs_ioctl - call filesystem specific ioctl methods
35 * @filp: open file to invoke ioctl method on
36 * @cmd: ioctl command to execute
37 * @arg: command-specific argument for ioctl
38 *
39 * Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
40 * returns -ENOTTY.
41 *
42 * Returns 0 on success, -errno on error.
43 */
44long vfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
45{
46 int error = -ENOTTY;
47
48 if (!filp->f_op->unlocked_ioctl)
49 goto out;
50
51 error = filp->f_op->unlocked_ioctl(filp, cmd, arg);
52 if (error == -ENOIOCTLCMD)
53 error = -ENOTTY;
54 out:
55 return error;
56}
57EXPORT_SYMBOL(vfs_ioctl);
58
59static int ioctl_fibmap(struct file *filp, int __user *p)
60{
61 struct inode *inode = file_inode(filp);
62 struct super_block *sb = inode->i_sb;
63 int error, ur_block;
64 sector_t block;
65
66 if (!capable(CAP_SYS_RAWIO))
67 return -EPERM;
68
69 error = get_user(ur_block, p);
70 if (error)
71 return error;
72
73 if (ur_block < 0)
74 return -EINVAL;
75
76 block = ur_block;
77 error = bmap(inode, &block);
78
79 if (block > INT_MAX) {
80 error = -ERANGE;
81 pr_warn_ratelimited("[%s/%d] FS: %s File: %pD4 would truncate fibmap result\n",
82 current->comm, task_pid_nr(current),
83 sb->s_id, filp);
84 }
85
86 if (error)
87 ur_block = 0;
88 else
89 ur_block = block;
90
91 if (put_user(ur_block, p))
92 error = -EFAULT;
93
94 return error;
95}
96
97/**
98 * fiemap_fill_next_extent - Fiemap helper function
99 * @fieinfo: Fiemap context passed into ->fiemap
100 * @logical: Extent logical start offset, in bytes
101 * @phys: Extent physical start offset, in bytes
102 * @len: Extent length, in bytes
103 * @flags: FIEMAP_EXTENT flags that describe this extent
104 *
105 * Called from file system ->fiemap callback. Will populate extent
106 * info as passed in via arguments and copy to user memory. On
107 * success, extent count on fieinfo is incremented.
108 *
109 * Returns 0 on success, -errno on error, 1 if this was the last
110 * extent that will fit in user array.
111 */
112int fiemap_fill_next_extent(struct fiemap_extent_info *fieinfo, u64 logical,
113 u64 phys, u64 len, u32 flags)
114{
115 struct fiemap_extent extent;
116 struct fiemap_extent __user *dest = fieinfo->fi_extents_start;
117
118 /* only count the extents */
119 if (fieinfo->fi_extents_max == 0) {
120 fieinfo->fi_extents_mapped++;
121 return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
122 }
123
124 if (fieinfo->fi_extents_mapped >= fieinfo->fi_extents_max)
125 return 1;
126
127#define SET_UNKNOWN_FLAGS (FIEMAP_EXTENT_DELALLOC)
128#define SET_NO_UNMOUNTED_IO_FLAGS (FIEMAP_EXTENT_DATA_ENCRYPTED)
129#define SET_NOT_ALIGNED_FLAGS (FIEMAP_EXTENT_DATA_TAIL|FIEMAP_EXTENT_DATA_INLINE)
130
131 if (flags & SET_UNKNOWN_FLAGS)
132 flags |= FIEMAP_EXTENT_UNKNOWN;
133 if (flags & SET_NO_UNMOUNTED_IO_FLAGS)
134 flags |= FIEMAP_EXTENT_ENCODED;
135 if (flags & SET_NOT_ALIGNED_FLAGS)
136 flags |= FIEMAP_EXTENT_NOT_ALIGNED;
137
138 memset(&extent, 0, sizeof(extent));
139 extent.fe_logical = logical;
140 extent.fe_physical = phys;
141 extent.fe_length = len;
142 extent.fe_flags = flags;
143
144 dest += fieinfo->fi_extents_mapped;
145 if (copy_to_user(dest, &extent, sizeof(extent)))
146 return -EFAULT;
147
148 fieinfo->fi_extents_mapped++;
149 if (fieinfo->fi_extents_mapped == fieinfo->fi_extents_max)
150 return 1;
151 return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
152}
153EXPORT_SYMBOL(fiemap_fill_next_extent);
154
155/**
156 * fiemap_prep - check validity of requested flags for fiemap
157 * @inode: Inode to operate on
158 * @fieinfo: Fiemap context passed into ->fiemap
159 * @start: Start of the mapped range
160 * @len: Length of the mapped range, can be truncated by this function.
161 * @supported_flags: Set of fiemap flags that the file system understands
162 *
163 * This function must be called from each ->fiemap instance to validate the
164 * fiemap request against the file system parameters.
165 *
166 * Returns 0 on success, or a negative error on failure.
167 */
168int fiemap_prep(struct inode *inode, struct fiemap_extent_info *fieinfo,
169 u64 start, u64 *len, u32 supported_flags)
170{
171 u64 maxbytes = inode->i_sb->s_maxbytes;
172 u32 incompat_flags;
173 int ret = 0;
174
175 if (*len == 0)
176 return -EINVAL;
177 if (start >= maxbytes)
178 return -EFBIG;
179
180 /*
181 * Shrink request scope to what the fs can actually handle.
182 */
183 if (*len > maxbytes || (maxbytes - *len) < start)
184 *len = maxbytes - start;
185
186 supported_flags |= FIEMAP_FLAG_SYNC;
187 supported_flags &= FIEMAP_FLAGS_COMPAT;
188 incompat_flags = fieinfo->fi_flags & ~supported_flags;
189 if (incompat_flags) {
190 fieinfo->fi_flags = incompat_flags;
191 return -EBADR;
192 }
193
194 if (fieinfo->fi_flags & FIEMAP_FLAG_SYNC)
195 ret = filemap_write_and_wait(inode->i_mapping);
196 return ret;
197}
198EXPORT_SYMBOL(fiemap_prep);
199
200static int ioctl_fiemap(struct file *filp, struct fiemap __user *ufiemap)
201{
202 struct fiemap fiemap;
203 struct fiemap_extent_info fieinfo = { 0, };
204 struct inode *inode = file_inode(filp);
205 int error;
206
207 if (!inode->i_op->fiemap)
208 return -EOPNOTSUPP;
209
210 if (copy_from_user(&fiemap, ufiemap, sizeof(fiemap)))
211 return -EFAULT;
212
213 if (fiemap.fm_extent_count > FIEMAP_MAX_EXTENTS)
214 return -EINVAL;
215
216 fieinfo.fi_flags = fiemap.fm_flags;
217 fieinfo.fi_extents_max = fiemap.fm_extent_count;
218 fieinfo.fi_extents_start = ufiemap->fm_extents;
219
220 error = inode->i_op->fiemap(inode, &fieinfo, fiemap.fm_start,
221 fiemap.fm_length);
222
223 fiemap.fm_flags = fieinfo.fi_flags;
224 fiemap.fm_mapped_extents = fieinfo.fi_extents_mapped;
225 if (copy_to_user(ufiemap, &fiemap, sizeof(fiemap)))
226 error = -EFAULT;
227
228 return error;
229}
230
231static long ioctl_file_clone(struct file *dst_file, unsigned long srcfd,
232 u64 off, u64 olen, u64 destoff)
233{
234 struct fd src_file = fdget(srcfd);
235 loff_t cloned;
236 int ret;
237
238 if (!src_file.file)
239 return -EBADF;
240 cloned = vfs_clone_file_range(src_file.file, off, dst_file, destoff,
241 olen, 0);
242 if (cloned < 0)
243 ret = cloned;
244 else if (olen && cloned != olen)
245 ret = -EINVAL;
246 else
247 ret = 0;
248 fdput(src_file);
249 return ret;
250}
251
252static long ioctl_file_clone_range(struct file *file,
253 struct file_clone_range __user *argp)
254{
255 struct file_clone_range args;
256
257 if (copy_from_user(&args, argp, sizeof(args)))
258 return -EFAULT;
259 return ioctl_file_clone(file, args.src_fd, args.src_offset,
260 args.src_length, args.dest_offset);
261}
262
263/*
264 * This provides compatibility with legacy XFS pre-allocation ioctls
265 * which predate the fallocate syscall.
266 *
267 * Only the l_start, l_len and l_whence fields of the 'struct space_resv'
268 * are used here, rest are ignored.
269 */
270static int ioctl_preallocate(struct file *filp, int mode, void __user *argp)
271{
272 struct inode *inode = file_inode(filp);
273 struct space_resv sr;
274
275 if (copy_from_user(&sr, argp, sizeof(sr)))
276 return -EFAULT;
277
278 switch (sr.l_whence) {
279 case SEEK_SET:
280 break;
281 case SEEK_CUR:
282 sr.l_start += filp->f_pos;
283 break;
284 case SEEK_END:
285 sr.l_start += i_size_read(inode);
286 break;
287 default:
288 return -EINVAL;
289 }
290
291 return vfs_fallocate(filp, mode | FALLOC_FL_KEEP_SIZE, sr.l_start,
292 sr.l_len);
293}
294
295/* on ia32 l_start is on a 32-bit boundary */
296#if defined CONFIG_COMPAT && defined(CONFIG_X86_64)
297/* just account for different alignment */
298static int compat_ioctl_preallocate(struct file *file, int mode,
299 struct space_resv_32 __user *argp)
300{
301 struct inode *inode = file_inode(file);
302 struct space_resv_32 sr;
303
304 if (copy_from_user(&sr, argp, sizeof(sr)))
305 return -EFAULT;
306
307 switch (sr.l_whence) {
308 case SEEK_SET:
309 break;
310 case SEEK_CUR:
311 sr.l_start += file->f_pos;
312 break;
313 case SEEK_END:
314 sr.l_start += i_size_read(inode);
315 break;
316 default:
317 return -EINVAL;
318 }
319
320 return vfs_fallocate(file, mode | FALLOC_FL_KEEP_SIZE, sr.l_start, sr.l_len);
321}
322#endif
323
324static int file_ioctl(struct file *filp, unsigned int cmd, int __user *p)
325{
326 switch (cmd) {
327 case FIBMAP:
328 return ioctl_fibmap(filp, p);
329 case FS_IOC_RESVSP:
330 case FS_IOC_RESVSP64:
331 return ioctl_preallocate(filp, 0, p);
332 case FS_IOC_UNRESVSP:
333 case FS_IOC_UNRESVSP64:
334 return ioctl_preallocate(filp, FALLOC_FL_PUNCH_HOLE, p);
335 case FS_IOC_ZERO_RANGE:
336 return ioctl_preallocate(filp, FALLOC_FL_ZERO_RANGE, p);
337 }
338
339 return -ENOIOCTLCMD;
340}
341
342static int ioctl_fionbio(struct file *filp, int __user *argp)
343{
344 unsigned int flag;
345 int on, error;
346
347 error = get_user(on, argp);
348 if (error)
349 return error;
350 flag = O_NONBLOCK;
351#ifdef __sparc__
352 /* SunOS compatibility item. */
353 if (O_NONBLOCK != O_NDELAY)
354 flag |= O_NDELAY;
355#endif
356 spin_lock(&filp->f_lock);
357 if (on)
358 filp->f_flags |= flag;
359 else
360 filp->f_flags &= ~flag;
361 spin_unlock(&filp->f_lock);
362 return error;
363}
364
365static int ioctl_fioasync(unsigned int fd, struct file *filp,
366 int __user *argp)
367{
368 unsigned int flag;
369 int on, error;
370
371 error = get_user(on, argp);
372 if (error)
373 return error;
374 flag = on ? FASYNC : 0;
375
376 /* Did FASYNC state change ? */
377 if ((flag ^ filp->f_flags) & FASYNC) {
378 if (filp->f_op->fasync)
379 /* fasync() adjusts filp->f_flags */
380 error = filp->f_op->fasync(fd, filp, on);
381 else
382 error = -ENOTTY;
383 }
384 return error < 0 ? error : 0;
385}
386
387static int ioctl_fsfreeze(struct file *filp)
388{
389 struct super_block *sb = file_inode(filp)->i_sb;
390
391 if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN))
392 return -EPERM;
393
394 /* If filesystem doesn't support freeze feature, return. */
395 if (sb->s_op->freeze_fs == NULL && sb->s_op->freeze_super == NULL)
396 return -EOPNOTSUPP;
397
398 /* Freeze */
399 if (sb->s_op->freeze_super)
400 return sb->s_op->freeze_super(sb, FREEZE_HOLDER_USERSPACE);
401 return freeze_super(sb, FREEZE_HOLDER_USERSPACE);
402}
403
404static int ioctl_fsthaw(struct file *filp)
405{
406 struct super_block *sb = file_inode(filp)->i_sb;
407
408 if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN))
409 return -EPERM;
410
411 /* Thaw */
412 if (sb->s_op->thaw_super)
413 return sb->s_op->thaw_super(sb, FREEZE_HOLDER_USERSPACE);
414 return thaw_super(sb, FREEZE_HOLDER_USERSPACE);
415}
416
417static int ioctl_file_dedupe_range(struct file *file,
418 struct file_dedupe_range __user *argp)
419{
420 struct file_dedupe_range *same = NULL;
421 int ret;
422 unsigned long size;
423 u16 count;
424
425 if (get_user(count, &argp->dest_count)) {
426 ret = -EFAULT;
427 goto out;
428 }
429
430 size = offsetof(struct file_dedupe_range, info[count]);
431 if (size > PAGE_SIZE) {
432 ret = -ENOMEM;
433 goto out;
434 }
435
436 same = memdup_user(argp, size);
437 if (IS_ERR(same)) {
438 ret = PTR_ERR(same);
439 same = NULL;
440 goto out;
441 }
442
443 same->dest_count = count;
444 ret = vfs_dedupe_file_range(file, same);
445 if (ret)
446 goto out;
447
448 ret = copy_to_user(argp, same, size);
449 if (ret)
450 ret = -EFAULT;
451
452out:
453 kfree(same);
454 return ret;
455}
456
457/**
458 * fileattr_fill_xflags - initialize fileattr with xflags
459 * @fa: fileattr pointer
460 * @xflags: FS_XFLAG_* flags
461 *
462 * Set ->fsx_xflags, ->fsx_valid and ->flags (translated xflags). All
463 * other fields are zeroed.
464 */
465void fileattr_fill_xflags(struct fileattr *fa, u32 xflags)
466{
467 memset(fa, 0, sizeof(*fa));
468 fa->fsx_valid = true;
469 fa->fsx_xflags = xflags;
470 if (fa->fsx_xflags & FS_XFLAG_IMMUTABLE)
471 fa->flags |= FS_IMMUTABLE_FL;
472 if (fa->fsx_xflags & FS_XFLAG_APPEND)
473 fa->flags |= FS_APPEND_FL;
474 if (fa->fsx_xflags & FS_XFLAG_SYNC)
475 fa->flags |= FS_SYNC_FL;
476 if (fa->fsx_xflags & FS_XFLAG_NOATIME)
477 fa->flags |= FS_NOATIME_FL;
478 if (fa->fsx_xflags & FS_XFLAG_NODUMP)
479 fa->flags |= FS_NODUMP_FL;
480 if (fa->fsx_xflags & FS_XFLAG_DAX)
481 fa->flags |= FS_DAX_FL;
482 if (fa->fsx_xflags & FS_XFLAG_PROJINHERIT)
483 fa->flags |= FS_PROJINHERIT_FL;
484}
485EXPORT_SYMBOL(fileattr_fill_xflags);
486
487/**
488 * fileattr_fill_flags - initialize fileattr with flags
489 * @fa: fileattr pointer
490 * @flags: FS_*_FL flags
491 *
492 * Set ->flags, ->flags_valid and ->fsx_xflags (translated flags).
493 * All other fields are zeroed.
494 */
495void fileattr_fill_flags(struct fileattr *fa, u32 flags)
496{
497 memset(fa, 0, sizeof(*fa));
498 fa->flags_valid = true;
499 fa->flags = flags;
500 if (fa->flags & FS_SYNC_FL)
501 fa->fsx_xflags |= FS_XFLAG_SYNC;
502 if (fa->flags & FS_IMMUTABLE_FL)
503 fa->fsx_xflags |= FS_XFLAG_IMMUTABLE;
504 if (fa->flags & FS_APPEND_FL)
505 fa->fsx_xflags |= FS_XFLAG_APPEND;
506 if (fa->flags & FS_NODUMP_FL)
507 fa->fsx_xflags |= FS_XFLAG_NODUMP;
508 if (fa->flags & FS_NOATIME_FL)
509 fa->fsx_xflags |= FS_XFLAG_NOATIME;
510 if (fa->flags & FS_DAX_FL)
511 fa->fsx_xflags |= FS_XFLAG_DAX;
512 if (fa->flags & FS_PROJINHERIT_FL)
513 fa->fsx_xflags |= FS_XFLAG_PROJINHERIT;
514}
515EXPORT_SYMBOL(fileattr_fill_flags);
516
517/**
518 * vfs_fileattr_get - retrieve miscellaneous file attributes
519 * @dentry: the object to retrieve from
520 * @fa: fileattr pointer
521 *
522 * Call i_op->fileattr_get() callback, if exists.
523 *
524 * Return: 0 on success, or a negative error on failure.
525 */
526int vfs_fileattr_get(struct dentry *dentry, struct fileattr *fa)
527{
528 struct inode *inode = d_inode(dentry);
529
530 if (!inode->i_op->fileattr_get)
531 return -ENOIOCTLCMD;
532
533 return inode->i_op->fileattr_get(dentry, fa);
534}
535EXPORT_SYMBOL(vfs_fileattr_get);
536
537/**
538 * copy_fsxattr_to_user - copy fsxattr to userspace.
539 * @fa: fileattr pointer
540 * @ufa: fsxattr user pointer
541 *
542 * Return: 0 on success, or -EFAULT on failure.
543 */
544int copy_fsxattr_to_user(const struct fileattr *fa, struct fsxattr __user *ufa)
545{
546 struct fsxattr xfa;
547
548 memset(&xfa, 0, sizeof(xfa));
549 xfa.fsx_xflags = fa->fsx_xflags;
550 xfa.fsx_extsize = fa->fsx_extsize;
551 xfa.fsx_nextents = fa->fsx_nextents;
552 xfa.fsx_projid = fa->fsx_projid;
553 xfa.fsx_cowextsize = fa->fsx_cowextsize;
554
555 if (copy_to_user(ufa, &xfa, sizeof(xfa)))
556 return -EFAULT;
557
558 return 0;
559}
560EXPORT_SYMBOL(copy_fsxattr_to_user);
561
562static int copy_fsxattr_from_user(struct fileattr *fa,
563 struct fsxattr __user *ufa)
564{
565 struct fsxattr xfa;
566
567 if (copy_from_user(&xfa, ufa, sizeof(xfa)))
568 return -EFAULT;
569
570 fileattr_fill_xflags(fa, xfa.fsx_xflags);
571 fa->fsx_extsize = xfa.fsx_extsize;
572 fa->fsx_nextents = xfa.fsx_nextents;
573 fa->fsx_projid = xfa.fsx_projid;
574 fa->fsx_cowextsize = xfa.fsx_cowextsize;
575
576 return 0;
577}
578
579/*
580 * Generic function to check FS_IOC_FSSETXATTR/FS_IOC_SETFLAGS values and reject
581 * any invalid configurations.
582 *
583 * Note: must be called with inode lock held.
584 */
585static int fileattr_set_prepare(struct inode *inode,
586 const struct fileattr *old_ma,
587 struct fileattr *fa)
588{
589 int err;
590
591 /*
592 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
593 * the relevant capability.
594 */
595 if ((fa->flags ^ old_ma->flags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
596 !capable(CAP_LINUX_IMMUTABLE))
597 return -EPERM;
598
599 err = fscrypt_prepare_setflags(inode, old_ma->flags, fa->flags);
600 if (err)
601 return err;
602
603 /*
604 * Project Quota ID state is only allowed to change from within the init
605 * namespace. Enforce that restriction only if we are trying to change
606 * the quota ID state. Everything else is allowed in user namespaces.
607 */
608 if (current_user_ns() != &init_user_ns) {
609 if (old_ma->fsx_projid != fa->fsx_projid)
610 return -EINVAL;
611 if ((old_ma->fsx_xflags ^ fa->fsx_xflags) &
612 FS_XFLAG_PROJINHERIT)
613 return -EINVAL;
614 } else {
615 /*
616 * Caller is allowed to change the project ID. If it is being
617 * changed, make sure that the new value is valid.
618 */
619 if (old_ma->fsx_projid != fa->fsx_projid &&
620 !projid_valid(make_kprojid(&init_user_ns, fa->fsx_projid)))
621 return -EINVAL;
622 }
623
624 /* Check extent size hints. */
625 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
626 return -EINVAL;
627
628 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
629 !S_ISDIR(inode->i_mode))
630 return -EINVAL;
631
632 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
633 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
634 return -EINVAL;
635
636 /*
637 * It is only valid to set the DAX flag on regular files and
638 * directories on filesystems.
639 */
640 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
641 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
642 return -EINVAL;
643
644 /* Extent size hints of zero turn off the flags. */
645 if (fa->fsx_extsize == 0)
646 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
647 if (fa->fsx_cowextsize == 0)
648 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
649
650 return 0;
651}
652
653/**
654 * vfs_fileattr_set - change miscellaneous file attributes
655 * @idmap: idmap of the mount
656 * @dentry: the object to change
657 * @fa: fileattr pointer
658 *
659 * After verifying permissions, call i_op->fileattr_set() callback, if
660 * exists.
661 *
662 * Verifying attributes involves retrieving current attributes with
663 * i_op->fileattr_get(), this also allows initializing attributes that have
664 * not been set by the caller to current values. Inode lock is held
665 * thoughout to prevent racing with another instance.
666 *
667 * Return: 0 on success, or a negative error on failure.
668 */
669int vfs_fileattr_set(struct mnt_idmap *idmap, struct dentry *dentry,
670 struct fileattr *fa)
671{
672 struct inode *inode = d_inode(dentry);
673 struct fileattr old_ma = {};
674 int err;
675
676 if (!inode->i_op->fileattr_set)
677 return -ENOIOCTLCMD;
678
679 if (!inode_owner_or_capable(idmap, inode))
680 return -EPERM;
681
682 inode_lock(inode);
683 err = vfs_fileattr_get(dentry, &old_ma);
684 if (!err) {
685 /* initialize missing bits from old_ma */
686 if (fa->flags_valid) {
687 fa->fsx_xflags |= old_ma.fsx_xflags & ~FS_XFLAG_COMMON;
688 fa->fsx_extsize = old_ma.fsx_extsize;
689 fa->fsx_nextents = old_ma.fsx_nextents;
690 fa->fsx_projid = old_ma.fsx_projid;
691 fa->fsx_cowextsize = old_ma.fsx_cowextsize;
692 } else {
693 fa->flags |= old_ma.flags & ~FS_COMMON_FL;
694 }
695 err = fileattr_set_prepare(inode, &old_ma, fa);
696 if (!err)
697 err = inode->i_op->fileattr_set(idmap, dentry, fa);
698 }
699 inode_unlock(inode);
700
701 return err;
702}
703EXPORT_SYMBOL(vfs_fileattr_set);
704
705static int ioctl_getflags(struct file *file, unsigned int __user *argp)
706{
707 struct fileattr fa = { .flags_valid = true }; /* hint only */
708 int err;
709
710 err = vfs_fileattr_get(file->f_path.dentry, &fa);
711 if (!err)
712 err = put_user(fa.flags, argp);
713 return err;
714}
715
716static int ioctl_setflags(struct file *file, unsigned int __user *argp)
717{
718 struct mnt_idmap *idmap = file_mnt_idmap(file);
719 struct dentry *dentry = file->f_path.dentry;
720 struct fileattr fa;
721 unsigned int flags;
722 int err;
723
724 err = get_user(flags, argp);
725 if (!err) {
726 err = mnt_want_write_file(file);
727 if (!err) {
728 fileattr_fill_flags(&fa, flags);
729 err = vfs_fileattr_set(idmap, dentry, &fa);
730 mnt_drop_write_file(file);
731 }
732 }
733 return err;
734}
735
736static int ioctl_fsgetxattr(struct file *file, void __user *argp)
737{
738 struct fileattr fa = { .fsx_valid = true }; /* hint only */
739 int err;
740
741 err = vfs_fileattr_get(file->f_path.dentry, &fa);
742 if (!err)
743 err = copy_fsxattr_to_user(&fa, argp);
744
745 return err;
746}
747
748static int ioctl_fssetxattr(struct file *file, void __user *argp)
749{
750 struct mnt_idmap *idmap = file_mnt_idmap(file);
751 struct dentry *dentry = file->f_path.dentry;
752 struct fileattr fa;
753 int err;
754
755 err = copy_fsxattr_from_user(&fa, argp);
756 if (!err) {
757 err = mnt_want_write_file(file);
758 if (!err) {
759 err = vfs_fileattr_set(idmap, dentry, &fa);
760 mnt_drop_write_file(file);
761 }
762 }
763 return err;
764}
765
766static int ioctl_getfsuuid(struct file *file, void __user *argp)
767{
768 struct super_block *sb = file_inode(file)->i_sb;
769 struct fsuuid2 u = { .len = sb->s_uuid_len, };
770
771 if (!sb->s_uuid_len)
772 return -ENOTTY;
773
774 memcpy(&u.uuid[0], &sb->s_uuid, sb->s_uuid_len);
775
776 return copy_to_user(argp, &u, sizeof(u)) ? -EFAULT : 0;
777}
778
779static int ioctl_get_fs_sysfs_path(struct file *file, void __user *argp)
780{
781 struct super_block *sb = file_inode(file)->i_sb;
782
783 if (!strlen(sb->s_sysfs_name))
784 return -ENOTTY;
785
786 struct fs_sysfs_path u = {};
787
788 u.len = scnprintf(u.name, sizeof(u.name), "%s/%s", sb->s_type->name, sb->s_sysfs_name);
789
790 return copy_to_user(argp, &u, sizeof(u)) ? -EFAULT : 0;
791}
792
793/*
794 * do_vfs_ioctl() is not for drivers and not intended to be EXPORT_SYMBOL()'d.
795 * It's just a simple helper for sys_ioctl and compat_sys_ioctl.
796 *
797 * When you add any new common ioctls to the switches above and below,
798 * please ensure they have compatible arguments in compat mode.
799 */
800static int do_vfs_ioctl(struct file *filp, unsigned int fd,
801 unsigned int cmd, unsigned long arg)
802{
803 void __user *argp = (void __user *)arg;
804 struct inode *inode = file_inode(filp);
805
806 switch (cmd) {
807 case FIOCLEX:
808 set_close_on_exec(fd, 1);
809 return 0;
810
811 case FIONCLEX:
812 set_close_on_exec(fd, 0);
813 return 0;
814
815 case FIONBIO:
816 return ioctl_fionbio(filp, argp);
817
818 case FIOASYNC:
819 return ioctl_fioasync(fd, filp, argp);
820
821 case FIOQSIZE:
822 if (S_ISDIR(inode->i_mode) || S_ISREG(inode->i_mode) ||
823 S_ISLNK(inode->i_mode)) {
824 loff_t res = inode_get_bytes(inode);
825 return copy_to_user(argp, &res, sizeof(res)) ?
826 -EFAULT : 0;
827 }
828
829 return -ENOTTY;
830
831 case FIFREEZE:
832 return ioctl_fsfreeze(filp);
833
834 case FITHAW:
835 return ioctl_fsthaw(filp);
836
837 case FS_IOC_FIEMAP:
838 return ioctl_fiemap(filp, argp);
839
840 case FIGETBSZ:
841 /* anon_bdev filesystems may not have a block size */
842 if (!inode->i_sb->s_blocksize)
843 return -EINVAL;
844
845 return put_user(inode->i_sb->s_blocksize, (int __user *)argp);
846
847 case FICLONE:
848 return ioctl_file_clone(filp, arg, 0, 0, 0);
849
850 case FICLONERANGE:
851 return ioctl_file_clone_range(filp, argp);
852
853 case FIDEDUPERANGE:
854 return ioctl_file_dedupe_range(filp, argp);
855
856 case FIONREAD:
857 if (!S_ISREG(inode->i_mode))
858 return vfs_ioctl(filp, cmd, arg);
859
860 return put_user(i_size_read(inode) - filp->f_pos,
861 (int __user *)argp);
862
863 case FS_IOC_GETFLAGS:
864 return ioctl_getflags(filp, argp);
865
866 case FS_IOC_SETFLAGS:
867 return ioctl_setflags(filp, argp);
868
869 case FS_IOC_FSGETXATTR:
870 return ioctl_fsgetxattr(filp, argp);
871
872 case FS_IOC_FSSETXATTR:
873 return ioctl_fssetxattr(filp, argp);
874
875 case FS_IOC_GETFSUUID:
876 return ioctl_getfsuuid(filp, argp);
877
878 case FS_IOC_GETFSSYSFSPATH:
879 return ioctl_get_fs_sysfs_path(filp, argp);
880
881 default:
882 if (S_ISREG(inode->i_mode))
883 return file_ioctl(filp, cmd, argp);
884 break;
885 }
886
887 return -ENOIOCTLCMD;
888}
889
890SYSCALL_DEFINE3(ioctl, unsigned int, fd, unsigned int, cmd, unsigned long, arg)
891{
892 struct fd f = fdget(fd);
893 int error;
894
895 if (!f.file)
896 return -EBADF;
897
898 error = security_file_ioctl(f.file, cmd, arg);
899 if (error)
900 goto out;
901
902 error = do_vfs_ioctl(f.file, fd, cmd, arg);
903 if (error == -ENOIOCTLCMD)
904 error = vfs_ioctl(f.file, cmd, arg);
905
906out:
907 fdput(f);
908 return error;
909}
910
911#ifdef CONFIG_COMPAT
912/**
913 * compat_ptr_ioctl - generic implementation of .compat_ioctl file operation
914 * @file: The file to operate on.
915 * @cmd: The ioctl command number.
916 * @arg: The argument to the ioctl.
917 *
918 * This is not normally called as a function, but instead set in struct
919 * file_operations as
920 *
921 * .compat_ioctl = compat_ptr_ioctl,
922 *
923 * On most architectures, the compat_ptr_ioctl() just passes all arguments
924 * to the corresponding ->ioctl handler. The exception is arch/s390, where
925 * compat_ptr() clears the top bit of a 32-bit pointer value, so user space
926 * pointers to the second 2GB alias the first 2GB, as is the case for
927 * native 32-bit s390 user space.
928 *
929 * The compat_ptr_ioctl() function must therefore be used only with ioctl
930 * functions that either ignore the argument or pass a pointer to a
931 * compatible data type.
932 *
933 * If any ioctl command handled by fops->unlocked_ioctl passes a plain
934 * integer instead of a pointer, or any of the passed data types
935 * is incompatible between 32-bit and 64-bit architectures, a proper
936 * handler is required instead of compat_ptr_ioctl.
937 */
938long compat_ptr_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
939{
940 if (!file->f_op->unlocked_ioctl)
941 return -ENOIOCTLCMD;
942
943 return file->f_op->unlocked_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
944}
945EXPORT_SYMBOL(compat_ptr_ioctl);
946
947COMPAT_SYSCALL_DEFINE3(ioctl, unsigned int, fd, unsigned int, cmd,
948 compat_ulong_t, arg)
949{
950 struct fd f = fdget(fd);
951 int error;
952
953 if (!f.file)
954 return -EBADF;
955
956 error = security_file_ioctl_compat(f.file, cmd, arg);
957 if (error)
958 goto out;
959
960 switch (cmd) {
961 /* FICLONE takes an int argument, so don't use compat_ptr() */
962 case FICLONE:
963 error = ioctl_file_clone(f.file, arg, 0, 0, 0);
964 break;
965
966#if defined(CONFIG_X86_64)
967 /* these get messy on amd64 due to alignment differences */
968 case FS_IOC_RESVSP_32:
969 case FS_IOC_RESVSP64_32:
970 error = compat_ioctl_preallocate(f.file, 0, compat_ptr(arg));
971 break;
972 case FS_IOC_UNRESVSP_32:
973 case FS_IOC_UNRESVSP64_32:
974 error = compat_ioctl_preallocate(f.file, FALLOC_FL_PUNCH_HOLE,
975 compat_ptr(arg));
976 break;
977 case FS_IOC_ZERO_RANGE_32:
978 error = compat_ioctl_preallocate(f.file, FALLOC_FL_ZERO_RANGE,
979 compat_ptr(arg));
980 break;
981#endif
982
983 /*
984 * These access 32-bit values anyway so no further handling is
985 * necessary.
986 */
987 case FS_IOC32_GETFLAGS:
988 case FS_IOC32_SETFLAGS:
989 cmd = (cmd == FS_IOC32_GETFLAGS) ?
990 FS_IOC_GETFLAGS : FS_IOC_SETFLAGS;
991 fallthrough;
992 /*
993 * everything else in do_vfs_ioctl() takes either a compatible
994 * pointer argument or no argument -- call it with a modified
995 * argument.
996 */
997 default:
998 error = do_vfs_ioctl(f.file, fd, cmd,
999 (unsigned long)compat_ptr(arg));
1000 if (error != -ENOIOCTLCMD)
1001 break;
1002
1003 if (f.file->f_op->compat_ioctl)
1004 error = f.file->f_op->compat_ioctl(f.file, cmd, arg);
1005 if (error == -ENOIOCTLCMD)
1006 error = -ENOTTY;
1007 break;
1008 }
1009
1010 out:
1011 fdput(f);
1012
1013 return error;
1014}
1015#endif