Merge branch 'mlxsw-Preparations-for-VxLAN-support'
[sfrench/cifs-2.6.git] / fs / ioctl.c
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  */
39 long 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 }
52 EXPORT_SYMBOL(vfs_ioctl);
53
54 static 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)
89 int 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 }
126 EXPORT_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  */
142 int 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 }
153 EXPORT_SYMBOL(fiemap_check_flags);
154
155 static 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
177 static 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(VERIFY_WRITE, 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
222 static 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         int ret;
227
228         if (!src_file.file)
229                 return -EBADF;
230         ret = -EXDEV;
231         if (src_file.file->f_path.mnt != dst_file->f_path.mnt)
232                 goto fdput;
233         ret = vfs_clone_file_range(src_file.file, off, dst_file, destoff, olen);
234 fdput:
235         fdput(src_file);
236         return ret;
237 }
238
239 static long ioctl_file_clone_range(struct file *file, void __user *argp)
240 {
241         struct file_clone_range args;
242
243         if (copy_from_user(&args, argp, sizeof(args)))
244                 return -EFAULT;
245         return ioctl_file_clone(file, args.src_fd, args.src_offset,
246                                 args.src_length, args.dest_offset);
247 }
248
249 #ifdef CONFIG_BLOCK
250
251 static inline sector_t logical_to_blk(struct inode *inode, loff_t offset)
252 {
253         return (offset >> inode->i_blkbits);
254 }
255
256 static inline loff_t blk_to_logical(struct inode *inode, sector_t blk)
257 {
258         return (blk << inode->i_blkbits);
259 }
260
261 /**
262  * __generic_block_fiemap - FIEMAP for block based inodes (no locking)
263  * @inode: the inode to map
264  * @fieinfo: the fiemap info struct that will be passed back to userspace
265  * @start: where to start mapping in the inode
266  * @len: how much space to map
267  * @get_block: the fs's get_block function
268  *
269  * This does FIEMAP for block based inodes.  Basically it will just loop
270  * through get_block until we hit the number of extents we want to map, or we
271  * go past the end of the file and hit a hole.
272  *
273  * If it is possible to have data blocks beyond a hole past @inode->i_size, then
274  * please do not use this function, it will stop at the first unmapped block
275  * beyond i_size.
276  *
277  * If you use this function directly, you need to do your own locking. Use
278  * generic_block_fiemap if you want the locking done for you.
279  */
280
281 int __generic_block_fiemap(struct inode *inode,
282                            struct fiemap_extent_info *fieinfo, loff_t start,
283                            loff_t len, get_block_t *get_block)
284 {
285         struct buffer_head map_bh;
286         sector_t start_blk, last_blk;
287         loff_t isize = i_size_read(inode);
288         u64 logical = 0, phys = 0, size = 0;
289         u32 flags = FIEMAP_EXTENT_MERGED;
290         bool past_eof = false, whole_file = false;
291         int ret = 0;
292
293         ret = fiemap_check_flags(fieinfo, FIEMAP_FLAG_SYNC);
294         if (ret)
295                 return ret;
296
297         /*
298          * Either the i_mutex or other appropriate locking needs to be held
299          * since we expect isize to not change at all through the duration of
300          * this call.
301          */
302         if (len >= isize) {
303                 whole_file = true;
304                 len = isize;
305         }
306
307         /*
308          * Some filesystems can't deal with being asked to map less than
309          * blocksize, so make sure our len is at least block length.
310          */
311         if (logical_to_blk(inode, len) == 0)
312                 len = blk_to_logical(inode, 1);
313
314         start_blk = logical_to_blk(inode, start);
315         last_blk = logical_to_blk(inode, start + len - 1);
316
317         do {
318                 /*
319                  * we set b_size to the total size we want so it will map as
320                  * many contiguous blocks as possible at once
321                  */
322                 memset(&map_bh, 0, sizeof(struct buffer_head));
323                 map_bh.b_size = len;
324
325                 ret = get_block(inode, start_blk, &map_bh, 0);
326                 if (ret)
327                         break;
328
329                 /* HOLE */
330                 if (!buffer_mapped(&map_bh)) {
331                         start_blk++;
332
333                         /*
334                          * We want to handle the case where there is an
335                          * allocated block at the front of the file, and then
336                          * nothing but holes up to the end of the file properly,
337                          * to make sure that extent at the front gets properly
338                          * marked with FIEMAP_EXTENT_LAST
339                          */
340                         if (!past_eof &&
341                             blk_to_logical(inode, start_blk) >= isize)
342                                 past_eof = 1;
343
344                         /*
345                          * First hole after going past the EOF, this is our
346                          * last extent
347                          */
348                         if (past_eof && size) {
349                                 flags = FIEMAP_EXTENT_MERGED|FIEMAP_EXTENT_LAST;
350                                 ret = fiemap_fill_next_extent(fieinfo, logical,
351                                                               phys, size,
352                                                               flags);
353                         } else if (size) {
354                                 ret = fiemap_fill_next_extent(fieinfo, logical,
355                                                               phys, size, flags);
356                                 size = 0;
357                         }
358
359                         /* if we have holes up to/past EOF then we're done */
360                         if (start_blk > last_blk || past_eof || ret)
361                                 break;
362                 } else {
363                         /*
364                          * We have gone over the length of what we wanted to
365                          * map, and it wasn't the entire file, so add the extent
366                          * we got last time and exit.
367                          *
368                          * This is for the case where say we want to map all the
369                          * way up to the second to the last block in a file, but
370                          * the last block is a hole, making the second to last
371                          * block FIEMAP_EXTENT_LAST.  In this case we want to
372                          * see if there is a hole after the second to last block
373                          * so we can mark it properly.  If we found data after
374                          * we exceeded the length we were requesting, then we
375                          * are good to go, just add the extent to the fieinfo
376                          * and break
377                          */
378                         if (start_blk > last_blk && !whole_file) {
379                                 ret = fiemap_fill_next_extent(fieinfo, logical,
380                                                               phys, size,
381                                                               flags);
382                                 break;
383                         }
384
385                         /*
386                          * if size != 0 then we know we already have an extent
387                          * to add, so add it.
388                          */
389                         if (size) {
390                                 ret = fiemap_fill_next_extent(fieinfo, logical,
391                                                               phys, size,
392                                                               flags);
393                                 if (ret)
394                                         break;
395                         }
396
397                         logical = blk_to_logical(inode, start_blk);
398                         phys = blk_to_logical(inode, map_bh.b_blocknr);
399                         size = map_bh.b_size;
400                         flags = FIEMAP_EXTENT_MERGED;
401
402                         start_blk += logical_to_blk(inode, size);
403
404                         /*
405                          * If we are past the EOF, then we need to make sure as
406                          * soon as we find a hole that the last extent we found
407                          * is marked with FIEMAP_EXTENT_LAST
408                          */
409                         if (!past_eof && logical + size >= isize)
410                                 past_eof = true;
411                 }
412                 cond_resched();
413                 if (fatal_signal_pending(current)) {
414                         ret = -EINTR;
415                         break;
416                 }
417
418         } while (1);
419
420         /* If ret is 1 then we just hit the end of the extent array */
421         if (ret == 1)
422                 ret = 0;
423
424         return ret;
425 }
426 EXPORT_SYMBOL(__generic_block_fiemap);
427
428 /**
429  * generic_block_fiemap - FIEMAP for block based inodes
430  * @inode: The inode to map
431  * @fieinfo: The mapping information
432  * @start: The initial block to map
433  * @len: The length of the extect to attempt to map
434  * @get_block: The block mapping function for the fs
435  *
436  * Calls __generic_block_fiemap to map the inode, after taking
437  * the inode's mutex lock.
438  */
439
440 int generic_block_fiemap(struct inode *inode,
441                          struct fiemap_extent_info *fieinfo, u64 start,
442                          u64 len, get_block_t *get_block)
443 {
444         int ret;
445         inode_lock(inode);
446         ret = __generic_block_fiemap(inode, fieinfo, start, len, get_block);
447         inode_unlock(inode);
448         return ret;
449 }
450 EXPORT_SYMBOL(generic_block_fiemap);
451
452 #endif  /*  CONFIG_BLOCK  */
453
454 /*
455  * This provides compatibility with legacy XFS pre-allocation ioctls
456  * which predate the fallocate syscall.
457  *
458  * Only the l_start, l_len and l_whence fields of the 'struct space_resv'
459  * are used here, rest are ignored.
460  */
461 int ioctl_preallocate(struct file *filp, void __user *argp)
462 {
463         struct inode *inode = file_inode(filp);
464         struct space_resv sr;
465
466         if (copy_from_user(&sr, argp, sizeof(sr)))
467                 return -EFAULT;
468
469         switch (sr.l_whence) {
470         case SEEK_SET:
471                 break;
472         case SEEK_CUR:
473                 sr.l_start += filp->f_pos;
474                 break;
475         case SEEK_END:
476                 sr.l_start += i_size_read(inode);
477                 break;
478         default:
479                 return -EINVAL;
480         }
481
482         return vfs_fallocate(filp, FALLOC_FL_KEEP_SIZE, sr.l_start, sr.l_len);
483 }
484
485 static int file_ioctl(struct file *filp, unsigned int cmd,
486                 unsigned long arg)
487 {
488         struct inode *inode = file_inode(filp);
489         int __user *p = (int __user *)arg;
490
491         switch (cmd) {
492         case FIBMAP:
493                 return ioctl_fibmap(filp, p);
494         case FIONREAD:
495                 return put_user(i_size_read(inode) - filp->f_pos, p);
496         case FS_IOC_RESVSP:
497         case FS_IOC_RESVSP64:
498                 return ioctl_preallocate(filp, p);
499         }
500
501         return vfs_ioctl(filp, cmd, arg);
502 }
503
504 static int ioctl_fionbio(struct file *filp, int __user *argp)
505 {
506         unsigned int flag;
507         int on, error;
508
509         error = get_user(on, argp);
510         if (error)
511                 return error;
512         flag = O_NONBLOCK;
513 #ifdef __sparc__
514         /* SunOS compatibility item. */
515         if (O_NONBLOCK != O_NDELAY)
516                 flag |= O_NDELAY;
517 #endif
518         spin_lock(&filp->f_lock);
519         if (on)
520                 filp->f_flags |= flag;
521         else
522                 filp->f_flags &= ~flag;
523         spin_unlock(&filp->f_lock);
524         return error;
525 }
526
527 static int ioctl_fioasync(unsigned int fd, struct file *filp,
528                           int __user *argp)
529 {
530         unsigned int flag;
531         int on, error;
532
533         error = get_user(on, argp);
534         if (error)
535                 return error;
536         flag = on ? FASYNC : 0;
537
538         /* Did FASYNC state change ? */
539         if ((flag ^ filp->f_flags) & FASYNC) {
540                 if (filp->f_op->fasync)
541                         /* fasync() adjusts filp->f_flags */
542                         error = filp->f_op->fasync(fd, filp, on);
543                 else
544                         error = -ENOTTY;
545         }
546         return error < 0 ? error : 0;
547 }
548
549 static int ioctl_fsfreeze(struct file *filp)
550 {
551         struct super_block *sb = file_inode(filp)->i_sb;
552
553         if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN))
554                 return -EPERM;
555
556         /* If filesystem doesn't support freeze feature, return. */
557         if (sb->s_op->freeze_fs == NULL && sb->s_op->freeze_super == NULL)
558                 return -EOPNOTSUPP;
559
560         /* Freeze */
561         if (sb->s_op->freeze_super)
562                 return sb->s_op->freeze_super(sb);
563         return freeze_super(sb);
564 }
565
566 static int ioctl_fsthaw(struct file *filp)
567 {
568         struct super_block *sb = file_inode(filp)->i_sb;
569
570         if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN))
571                 return -EPERM;
572
573         /* Thaw */
574         if (sb->s_op->thaw_super)
575                 return sb->s_op->thaw_super(sb);
576         return thaw_super(sb);
577 }
578
579 static int ioctl_file_dedupe_range(struct file *file, void __user *arg)
580 {
581         struct file_dedupe_range __user *argp = arg;
582         struct file_dedupe_range *same = NULL;
583         int ret;
584         unsigned long size;
585         u16 count;
586
587         if (get_user(count, &argp->dest_count)) {
588                 ret = -EFAULT;
589                 goto out;
590         }
591
592         size = offsetof(struct file_dedupe_range __user, info[count]);
593         if (size > PAGE_SIZE) {
594                 ret = -ENOMEM;
595                 goto out;
596         }
597
598         same = memdup_user(argp, size);
599         if (IS_ERR(same)) {
600                 ret = PTR_ERR(same);
601                 same = NULL;
602                 goto out;
603         }
604
605         same->dest_count = count;
606         ret = vfs_dedupe_file_range(file, same);
607         if (ret)
608                 goto out;
609
610         ret = copy_to_user(argp, same, size);
611         if (ret)
612                 ret = -EFAULT;
613
614 out:
615         kfree(same);
616         return ret;
617 }
618
619 /*
620  * When you add any new common ioctls to the switches above and below
621  * please update compat_sys_ioctl() too.
622  *
623  * do_vfs_ioctl() is not for drivers and not intended to be EXPORT_SYMBOL()'d.
624  * It's just a simple helper for sys_ioctl and compat_sys_ioctl.
625  */
626 int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
627              unsigned long arg)
628 {
629         int error = 0;
630         int __user *argp = (int __user *)arg;
631         struct inode *inode = file_inode(filp);
632
633         switch (cmd) {
634         case FIOCLEX:
635                 set_close_on_exec(fd, 1);
636                 break;
637
638         case FIONCLEX:
639                 set_close_on_exec(fd, 0);
640                 break;
641
642         case FIONBIO:
643                 error = ioctl_fionbio(filp, argp);
644                 break;
645
646         case FIOASYNC:
647                 error = ioctl_fioasync(fd, filp, argp);
648                 break;
649
650         case FIOQSIZE:
651                 if (S_ISDIR(inode->i_mode) || S_ISREG(inode->i_mode) ||
652                     S_ISLNK(inode->i_mode)) {
653                         loff_t res = inode_get_bytes(inode);
654                         error = copy_to_user(argp, &res, sizeof(res)) ?
655                                         -EFAULT : 0;
656                 } else
657                         error = -ENOTTY;
658                 break;
659
660         case FIFREEZE:
661                 error = ioctl_fsfreeze(filp);
662                 break;
663
664         case FITHAW:
665                 error = ioctl_fsthaw(filp);
666                 break;
667
668         case FS_IOC_FIEMAP:
669                 return ioctl_fiemap(filp, arg);
670
671         case FIGETBSZ:
672                 return put_user(inode->i_sb->s_blocksize, argp);
673
674         case FICLONE:
675                 return ioctl_file_clone(filp, arg, 0, 0, 0);
676
677         case FICLONERANGE:
678                 return ioctl_file_clone_range(filp, argp);
679
680         case FIDEDUPERANGE:
681                 return ioctl_file_dedupe_range(filp, argp);
682
683         default:
684                 if (S_ISREG(inode->i_mode))
685                         error = file_ioctl(filp, cmd, arg);
686                 else
687                         error = vfs_ioctl(filp, cmd, arg);
688                 break;
689         }
690         return error;
691 }
692
693 int ksys_ioctl(unsigned int fd, unsigned int cmd, unsigned long arg)
694 {
695         int error;
696         struct fd f = fdget(fd);
697
698         if (!f.file)
699                 return -EBADF;
700         error = security_file_ioctl(f.file, cmd, arg);
701         if (!error)
702                 error = do_vfs_ioctl(f.file, fd, cmd, arg);
703         fdput(f);
704         return error;
705 }
706
707 SYSCALL_DEFINE3(ioctl, unsigned int, fd, unsigned int, cmd, unsigned long, arg)
708 {
709         return ksys_ioctl(fd, cmd, arg);
710 }