SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/ioctl.c

   1 /*
   2  *  linux/fs/ioctl.c
   3  *
   4  *  Copyright (C) 1991, 1992  Linus Torvalds
   5  */
   6
   7 #include <linux/syscalls.h>
   8 #include <linux/mm.h>
   9 #include <linux/smp_lock.h>
  10 #include <linux/capability.h>
  11 #include <linux/file.h>
  12 #include <linux/fs.h>
  13 #include <linux/security.h>
  14 #include <linux/module.h>
  15 #include <linux/uaccess.h>
  16 #include <linux/writeback.h>
  17 #include <linux/buffer_head.h>
  18
  19 #include <asm/ioctls.h>
  20
  21 /* So that the fiemap access checks can't overflow on 32 bit machines. */
  22 #define FIEMAP_MAX_EXTENTS      (UINT_MAX / sizeof(struct fiemap_extent))
  23
  24 /**
  25  * vfs_ioctl - call filesystem specific ioctl methods
  26  * @filp:       open file to invoke ioctl method on
  27  * @cmd:        ioctl command to execute
  28  * @arg:        command-specific argument for ioctl
  29  *
  30  * Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
  31  * invokes filesystem specific ->ioctl method.  If neither method exists,
  32  * returns -ENOTTY.
  33  *
  34  * Returns 0 on success, -errno on error.
  35  */
  36 static long vfs_ioctl(struct file *filp, unsigned int cmd,
  37                       unsigned long arg)
  38 {
  39         int error = -ENOTTY;
  40
  41         if (!filp->f_op)
  42                 goto out;
  43
  44         if (filp->f_op->unlocked_ioctl) {
  45                 error = filp->f_op->unlocked_ioctl(filp, cmd, arg);
  46                 if (error == -ENOIOCTLCMD)
  47                         error = -EINVAL;
  48                 goto out;
  49         } else if (filp->f_op->ioctl) {
  50                 lock_kernel();
  51                 error = filp->f_op->ioctl(filp->f_path.dentry->d_inode,
  52                                           filp, cmd, arg);
  53                 unlock_kernel();
  54         }
  55
  56  out:
  57         return error;
  58 }
  59
  60 static int ioctl_fibmap(struct file *filp, int __user *p)
  61 {
  62         struct address_space *mapping = filp->f_mapping;
  63         int res, block;
  64
  65         /* do we support this mess? */
  66         if (!mapping->a_ops->bmap)
  67                 return -EINVAL;
  68         if (!capable(CAP_SYS_RAWIO))
  69                 return -EPERM;
  70         res = get_user(block, p);
  71         if (res)
  72                 return res;
  73         lock_kernel();
  74         res = mapping->a_ops->bmap(mapping, block);
  75         unlock_kernel();
  76         return put_user(res, p);
  77 }
  78
  79 /**
  80  * fiemap_fill_next_extent - Fiemap helper function
  81  * @fieinfo:    Fiemap context passed into ->fiemap
  82  * @logical:    Extent logical start offset, in bytes
  83  * @phys:       Extent physical start offset, in bytes
  84  * @len:        Extent length, in bytes
  85  * @flags:      FIEMAP_EXTENT flags that describe this extent
  86  *
  87  * Called from file system ->fiemap callback. Will populate extent
  88  * info as passed in via arguments and copy to user memory. On
  89  * success, extent count on fieinfo is incremented.
  90  *
  91  * Returns 0 on success, -errno on error, 1 if this was the last
  92  * extent that will fit in user array.
  93  */
  94 #define SET_UNKNOWN_FLAGS       (FIEMAP_EXTENT_DELALLOC)
  95 #define SET_NO_UNMOUNTED_IO_FLAGS       (FIEMAP_EXTENT_DATA_ENCRYPTED)
  96 #define SET_NOT_ALIGNED_FLAGS   (FIEMAP_EXTENT_DATA_TAIL|FIEMAP_EXTENT_DATA_INLINE)
  97 int fiemap_fill_next_extent(struct fiemap_extent_info *fieinfo, u64 logical,
  98                             u64 phys, u64 len, u32 flags)
  99 {
 100         struct fiemap_extent extent;
 101         struct fiemap_extent *dest = fieinfo->fi_extents_start;
 102
 103         /* only count the extents */
 104         if (fieinfo->fi_extents_max == 0) {
 105                 fieinfo->fi_extents_mapped++;
 106                 return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
 107         }
 108
 109         if (fieinfo->fi_extents_mapped >= fieinfo->fi_extents_max)
 110                 return 1;
 111
 112         if (flags & SET_UNKNOWN_FLAGS)
 113                 flags |= FIEMAP_EXTENT_UNKNOWN;
 114         if (flags & SET_NO_UNMOUNTED_IO_FLAGS)
 115                 flags |= FIEMAP_EXTENT_ENCODED;
 116         if (flags & SET_NOT_ALIGNED_FLAGS)
 117                 flags |= FIEMAP_EXTENT_NOT_ALIGNED;
 118
 119         memset(&extent, 0, sizeof(extent));
 120         extent.fe_logical = logical;
 121         extent.fe_physical = phys;
 122         extent.fe_length = len;
 123         extent.fe_flags = flags;
 124
 125         dest += fieinfo->fi_extents_mapped;
 126         if (copy_to_user(dest, &extent, sizeof(extent)))
 127                 return -EFAULT;
 128
 129         fieinfo->fi_extents_mapped++;
 130         if (fieinfo->fi_extents_mapped == fieinfo->fi_extents_max)
 131                 return 1;
 132         return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
 133 }
 134 EXPORT_SYMBOL(fiemap_fill_next_extent);
 135
 136 /**
 137  * fiemap_check_flags - check validity of requested flags for fiemap
 138  * @fieinfo:    Fiemap context passed into ->fiemap
 139  * @fs_flags:   Set of fiemap flags that the file system understands
 140  *
 141  * Called from file system ->fiemap callback. This will compute the
 142  * intersection of valid fiemap flags and those that the fs supports. That
 143  * value is then compared against the user supplied flags. In case of bad user
 144  * flags, the invalid values will be written into the fieinfo structure, and
 145  * -EBADR is returned, which tells ioctl_fiemap() to return those values to
 146  * userspace. For this reason, a return code of -EBADR should be preserved.
 147  *
 148  * Returns 0 on success, -EBADR on bad flags.
 149  */
 150 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags)
 151 {
 152         u32 incompat_flags;
 153
 154         incompat_flags = fieinfo->fi_flags & ~(FIEMAP_FLAGS_COMPAT & fs_flags);
 155         if (incompat_flags) {
 156                 fieinfo->fi_flags = incompat_flags;
 157                 return -EBADR;
 158         }
 159         return 0;
 160 }
 161 EXPORT_SYMBOL(fiemap_check_flags);
 162
 163 static int fiemap_check_ranges(struct super_block *sb,
 164                                u64 start, u64 len, u64 *new_len)
 165 {
 166         *new_len = len;
 167
 168         if (len == 0)
 169                 return -EINVAL;
 170
 171         if (start > sb->s_maxbytes)
 172                 return -EFBIG;
 173
 174         /*
 175          * Shrink request scope to what the fs can actually handle.
 176          */
 177         if ((len > sb->s_maxbytes) ||
 178             (sb->s_maxbytes - len) < start)
 179                 *new_len = sb->s_maxbytes - start;
 180
 181         return 0;
 182 }
 183
 184 static int ioctl_fiemap(struct file *filp, unsigned long arg)
 185 {
 186         struct fiemap fiemap;
 187         struct fiemap_extent_info fieinfo = { 0, };
 188         struct inode *inode = filp->f_path.dentry->d_inode;
 189         struct super_block *sb = inode->i_sb;
 190         u64 len;
 191         int error;
 192
 193         if (!inode->i_op->fiemap)
 194                 return -EOPNOTSUPP;
 195
 196         if (copy_from_user(&fiemap, (struct fiemap __user *)arg,
 197                            sizeof(struct fiemap)))
 198                 return -EFAULT;
 199
 200         if (fiemap.fm_extent_count > FIEMAP_MAX_EXTENTS)
 201                 return -EINVAL;
 202
 203         error = fiemap_check_ranges(sb, fiemap.fm_start, fiemap.fm_length,
 204                                     &len);
 205         if (error)
 206                 return error;
 207
 208         fieinfo.fi_flags = fiemap.fm_flags;
 209         fieinfo.fi_extents_max = fiemap.fm_extent_count;
 210         fieinfo.fi_extents_start = (struct fiemap_extent *)(arg + sizeof(fiemap));
 211
 212         if (fiemap.fm_extent_count != 0 &&
 213             !access_ok(VERIFY_WRITE, fieinfo.fi_extents_start,
 214                        fieinfo.fi_extents_max * sizeof(struct fiemap_extent)))
 215                 return -EFAULT;
 216
 217         if (fieinfo.fi_flags & FIEMAP_FLAG_SYNC)
 218                 filemap_write_and_wait(inode->i_mapping);
 219
 220         error = inode->i_op->fiemap(inode, &fieinfo, fiemap.fm_start, len);
 221         fiemap.fm_flags = fieinfo.fi_flags;
 222         fiemap.fm_mapped_extents = fieinfo.fi_extents_mapped;
 223         if (copy_to_user((char *)arg, &fiemap, sizeof(fiemap)))
 224                 error = -EFAULT;
 225
 226         return error;
 227 }
 228
 229 #define blk_to_logical(inode, blk) (blk << (inode)->i_blkbits)
 230 #define logical_to_blk(inode, offset) (offset >> (inode)->i_blkbits);
 231
 232 /*
 233  * @inode - the inode to map
 234  * @arg - the pointer to userspace where we copy everything to
 235  * @get_block - the fs's get_block function
 236  *
 237  * This does FIEMAP for block based inodes.  Basically it will just loop
 238  * through get_block until we hit the number of extents we want to map, or we
 239  * go past the end of the file and hit a hole.
 240  *
 241  * If it is possible to have data blocks beyond a hole past @inode->i_size, then
 242  * please do not use this function, it will stop at the first unmapped block
 243  * beyond i_size
 244  */
 245 int generic_block_fiemap(struct inode *inode,
 246                          struct fiemap_extent_info *fieinfo, u64 start,
 247                          u64 len, get_block_t *get_block)
 248 {
 249         struct buffer_head tmp;
 250         unsigned int start_blk;
 251         long long length = 0, map_len = 0;
 252         u64 logical = 0, phys = 0, size = 0;
 253         u32 flags = FIEMAP_EXTENT_MERGED;
 254         int ret = 0;
 255
 256         if ((ret = fiemap_check_flags(fieinfo, FIEMAP_FLAG_SYNC)))
 257                 return ret;
 258
 259         start_blk = logical_to_blk(inode, start);
 260
 261         /* guard against change */
 262         mutex_lock(&inode->i_mutex);
 263
 264         length = (long long)min_t(u64, len, i_size_read(inode));
 265         map_len = length;
 266
 267         do {
 268                 /*
 269                  * we set b_size to the total size we want so it will map as
 270                  * many contiguous blocks as possible at once
 271                  */
 272                 memset(&tmp, 0, sizeof(struct buffer_head));
 273                 tmp.b_size = map_len;
 274
 275                 ret = get_block(inode, start_blk, &tmp, 0);
 276                 if (ret)
 277                         break;
 278
 279                 /* HOLE */
 280                 if (!buffer_mapped(&tmp)) {
 281                         /*
 282                          * first hole after going past the EOF, this is our
 283                          * last extent
 284                          */
 285                         if (length <= 0) {
 286                                 flags = FIEMAP_EXTENT_MERGED|FIEMAP_EXTENT_LAST;
 287                                 ret = fiemap_fill_next_extent(fieinfo, logical,
 288                                                               phys, size,
 289                                                               flags);
 290                                 break;
 291                         }
 292
 293                         length -= blk_to_logical(inode, 1);
 294
 295                         /* if we have holes up to/past EOF then we're done */
 296                         if (length <= 0)
 297                                 break;
 298
 299                         start_blk++;
 300                 } else {
 301                         if (length <= 0 && size) {
 302                                 ret = fiemap_fill_next_extent(fieinfo, logical,
 303                                                               phys, size,
 304                                                               flags);
 305                                 if (ret)
 306                                         break;
 307                         }
 308
 309                         logical = blk_to_logical(inode, start_blk);
 310                         phys = blk_to_logical(inode, tmp.b_blocknr);
 311                         size = tmp.b_size;
 312                         flags = FIEMAP_EXTENT_MERGED;
 313
 314                         length -= tmp.b_size;
 315                         start_blk += logical_to_blk(inode, size);
 316
 317                         /*
 318                          * if we are past the EOF we need to loop again to see
 319                          * if there is a hole so we can mark this extent as the
 320                          * last one, and if not keep mapping things until we
 321                          * find a hole, or we run out of slots in the extent
 322                          * array
 323                          */
 324                         if (length <= 0)
 325                                 continue;
 326
 327                         ret = fiemap_fill_next_extent(fieinfo, logical, phys,
 328                                                       size, flags);
 329                         if (ret)
 330                                 break;
 331                 }
 332                 cond_resched();
 333         } while (1);
 334
 335         mutex_unlock(&inode->i_mutex);
 336
 337         /* if ret is 1 then we just hit the end of the extent array */
 338         if (ret == 1)
 339                 ret = 0;
 340
 341         return ret;
 342 }
 343 EXPORT_SYMBOL(generic_block_fiemap);
 344
 345 static int file_ioctl(struct file *filp, unsigned int cmd,
 346                 unsigned long arg)
 347 {
 348         struct inode *inode = filp->f_path.dentry->d_inode;
 349         int __user *p = (int __user *)arg;
 350
 351         switch (cmd) {
 352         case FIBMAP:
 353                 return ioctl_fibmap(filp, p);
 354         case FS_IOC_FIEMAP:
 355                 return ioctl_fiemap(filp, arg);
 356         case FIGETBSZ:
 357                 return put_user(inode->i_sb->s_blocksize, p);
 358         case FIONREAD:
 359                 return put_user(i_size_read(inode) - filp->f_pos, p);
 360         }
 361
 362         return vfs_ioctl(filp, cmd, arg);
 363 }
 364
 365 static int ioctl_fionbio(struct file *filp, int __user *argp)
 366 {
 367         unsigned int flag;
 368         int on, error;
 369
 370         error = get_user(on, argp);
 371         if (error)
 372                 return error;
 373         flag = O_NONBLOCK;
 374 #ifdef __sparc__
 375         /* SunOS compatibility item. */
 376         if (O_NONBLOCK != O_NDELAY)
 377                 flag |= O_NDELAY;
 378 #endif
 379         if (on)
 380                 filp->f_flags |= flag;
 381         else
 382                 filp->f_flags &= ~flag;
 383         return error;
 384 }
 385
 386 static int ioctl_fioasync(unsigned int fd, struct file *filp,
 387                           int __user *argp)
 388 {
 389         unsigned int flag;
 390         int on, error;
 391
 392         error = get_user(on, argp);
 393         if (error)
 394                 return error;
 395         flag = on ? FASYNC : 0;
 396
 397         /* Did FASYNC state change ? */
 398         if ((flag ^ filp->f_flags) & FASYNC) {
 399                 if (filp->f_op && filp->f_op->fasync) {
 400                         lock_kernel();
 401                         error = filp->f_op->fasync(fd, filp, on);
 402                         unlock_kernel();
 403                 } else
 404                         error = -ENOTTY;
 405         }
 406         if (error)
 407                 return error;
 408
 409         if (on)
 410                 filp->f_flags |= FASYNC;
 411         else
 412                 filp->f_flags &= ~FASYNC;
 413         return error;
 414 }
 415
 416 /*
 417  * When you add any new common ioctls to the switches above and below
 418  * please update compat_sys_ioctl() too.
 419  *
 420  * do_vfs_ioctl() is not for drivers and not intended to be EXPORT_SYMBOL()'d.
 421  * It's just a simple helper for sys_ioctl and compat_sys_ioctl.
 422  */
 423 int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
 424              unsigned long arg)
 425 {
 426         int error = 0;
 427         int __user *argp = (int __user *)arg;
 428
 429         switch (cmd) {
 430         case FIOCLEX:
 431                 set_close_on_exec(fd, 1);
 432                 break;
 433
 434         case FIONCLEX:
 435                 set_close_on_exec(fd, 0);
 436                 break;
 437
 438         case FIONBIO:
 439                 error = ioctl_fionbio(filp, argp);
 440                 break;
 441
 442         case FIOASYNC:
 443                 error = ioctl_fioasync(fd, filp, argp);
 444                 break;
 445
 446         case FIOQSIZE:
 447                 if (S_ISDIR(filp->f_path.dentry->d_inode->i_mode) ||
 448                     S_ISREG(filp->f_path.dentry->d_inode->i_mode) ||
 449                     S_ISLNK(filp->f_path.dentry->d_inode->i_mode)) {
 450                         loff_t res =
 451                                 inode_get_bytes(filp->f_path.dentry->d_inode);
 452                         error = copy_to_user((loff_t __user *)arg, &res,
 453                                              sizeof(res)) ? -EFAULT : 0;
 454                 } else
 455                         error = -ENOTTY;
 456                 break;
 457         default:
 458                 if (S_ISREG(filp->f_path.dentry->d_inode->i_mode))
 459                         error = file_ioctl(filp, cmd, arg);
 460                 else
 461                         error = vfs_ioctl(filp, cmd, arg);
 462                 break;
 463         }
 464         return error;
 465 }
 466
 467 asmlinkage long sys_ioctl(unsigned int fd, unsigned int cmd, unsigned long arg)
 468 {
 469         struct file *filp;
 470         int error = -EBADF;
 471         int fput_needed;
 472
 473         filp = fget_light(fd, &fput_needed);
 474         if (!filp)
 475                 goto out;
 476
 477         error = security_file_ioctl(filp, cmd, arg);
 478         if (error)
 479                 goto out_fput;
 480
 481         error = do_vfs_ioctl(filp, fd, cmd, arg);
 482  out_fput:
 483         fput_light(filp, fput_needed);
 484  out:
 485         return error;
 486 }