vfs: vfs-level fiemap interface

Basic vfs-level fiemap infrastructure, which sets up a new ->fiemap
inode operation.

Userspace can get extent information on a file via fiemap ioctl. As input,
the fiemap ioctl takes a struct fiemap which includes an array of struct
fiemap_extent (fm_extents). Size of the extent array is passed as
fm_extent_count and number of extents returned will be written into
fm_mapped_extents. Offset and length fields on the fiemap structure
(fm_start, fm_length) describe a logical range which will be searched for
extents. All extents returned will at least partially contain this range.
The actual extent offsets and ranges returned will be unmodified from their
offset and range on-disk.

The fiemap ioctl returns '0' on success. On error, -1 is returned and errno
is set. If errno is equal to EBADR, then fm_flags will contain those flags
which were passed in which the kernel did not understand. On all other
errors, the contents of fm_extents is undefined.

As fiemap evolved, there have been many authors of the vfs patch. As far as
I can tell, the list includes:
Kalpak Shah <kalpak.shah@sun.com>
Andreas Dilger <adilger@sun.com>
Eric Sandeen <sandeen@redhat.com>
Mark Fasheh <mfasheh@suse.com>

Signed-off-by: Mark Fasheh <mfasheh@suse.com>
Signed-off-by: "Theodore Ts'o" <tytso@mit.edu>
Cc: Michael Kerrisk <mtk.manpages@googlemail.com>
Cc: linux-api@vger.kernel.org
Cc: linux-fsdevel@vger.kernel.org

1 files changed, 155 insertions, 0 deletions

diff --git a/fs/ioctl.c b/fs/ioctl.c
index 7db32b3382d3..045d9601fbbd 100644
--- a/fs/ioctl.c
+++ b/fs/ioctl.c
@@ -16,6 +16,9 @@
 
 #include <asm/ioctls.h>
 
+/* So that the fiemap access checks can't overflow on 32 bit machines. */
+#define FIEMAP_MAX_EXTENTS      (UINT_MAX / sizeof(struct fiemap_extent))
+
 /**
  * vfs_ioctl - call filesystem specific ioctl methods
  * @filp:       open file to invoke ioctl method on
@@ -71,6 +74,156 @@ static int ioctl_fibmap(struct file *filp, int __user *p)
         return put_user(res, p);
 }
 
+/**
+ * fiemap_fill_next_extent - Fiemap helper function
+ * @fieinfo:    Fiemap context passed into ->fiemap
+ * @logical:    Extent logical start offset, in bytes
+ * @phys:       Extent physical start offset, in bytes
+ * @len:        Extent length, in bytes
+ * @flags:      FIEMAP_EXTENT flags that describe this extent
+ *
+ * Called from file system ->fiemap callback. Will populate extent
+ * info as passed in via arguments and copy to user memory. On
+ * success, extent count on fieinfo is incremented.
+ *
+ * Returns 0 on success, -errno on error, 1 if this was the last
+ * extent that will fit in user array.
+ */
+#define SET_UNKNOWN_FLAGS       (FIEMAP_EXTENT_DELALLOC)
+#define SET_NO_UNMOUNTED_IO_FLAGS       (FIEMAP_EXTENT_DATA_ENCRYPTED)
+#define SET_NOT_ALIGNED_FLAGS   (FIEMAP_EXTENT_DATA_TAIL|FIEMAP_EXTENT_DATA_INLINE)
+int fiemap_fill_next_extent(struct fiemap_extent_info *fieinfo, u64 logical,
+                            u64 phys, u64 len, u32 flags)
+{
+        struct fiemap_extent extent;
+        struct fiemap_extent *dest = fieinfo->fi_extents_start;
+
+        /* only count the extents */
+        if (fieinfo->fi_extents_max == 0) {
+                fieinfo->fi_extents_mapped++;
+                return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
+        }
+
+        if (fieinfo->fi_extents_mapped >= fieinfo->fi_extents_max)
+                return 1;
+
+        if (flags & SET_UNKNOWN_FLAGS)
+                flags |= FIEMAP_EXTENT_UNKNOWN;
+        if (flags & SET_NO_UNMOUNTED_IO_FLAGS)
+                flags |= FIEMAP_EXTENT_ENCODED;
+        if (flags & SET_NOT_ALIGNED_FLAGS)
+                flags |= FIEMAP_EXTENT_NOT_ALIGNED;
+
+        memset(&extent, 0, sizeof(extent));
+        extent.fe_logical = logical;
+        extent.fe_physical = phys;
+        extent.fe_length = len;
+        extent.fe_flags = flags;
+
+        dest += fieinfo->fi_extents_mapped;
+        if (copy_to_user(dest, &extent, sizeof(extent)))
+                return -EFAULT;
+
+        fieinfo->fi_extents_mapped++;
+        if (fieinfo->fi_extents_mapped == fieinfo->fi_extents_max)
+                return 1;
+        return (flags & FIEMAP_EXTENT_LAST) ? 1 : 0;
+}
+EXPORT_SYMBOL(fiemap_fill_next_extent);
+
+/**
+ * fiemap_check_flags - check validity of requested flags for fiemap
+ * @fieinfo:    Fiemap context passed into ->fiemap
+ * @fs_flags:   Set of fiemap flags that the file system understands
+ *
+ * Called from file system ->fiemap callback. This will compute the
+ * intersection of valid fiemap flags and those that the fs supports. That
+ * value is then compared against the user supplied flags. In case of bad user
+ * flags, the invalid values will be written into the fieinfo structure, and
+ * -EBADR is returned, which tells ioctl_fiemap() to return those values to
+ * userspace. For this reason, a return code of -EBADR should be preserved.
+ *
+ * Returns 0 on success, -EBADR on bad flags.
+ */
+int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags)
+{
+        u32 incompat_flags;
+
+        incompat_flags = fieinfo->fi_flags & ~(FIEMAP_FLAGS_COMPAT & fs_flags);
+        if (incompat_flags) {
+                fieinfo->fi_flags = incompat_flags;
+                return -EBADR;
+        }
+        return 0;
+}
+EXPORT_SYMBOL(fiemap_check_flags);
+
+static int fiemap_check_ranges(struct super_block *sb,
+                               u64 start, u64 len, u64 *new_len)
+{
+        *new_len = len;
+
+        if (len == 0)
+                return -EINVAL;
+
+        if (start > sb->s_maxbytes)
+                return -EFBIG;
+
+        /*
+         * Shrink request scope to what the fs can actually handle.
+         */
+        if ((len > sb->s_maxbytes) ||
+            (sb->s_maxbytes - len) < start)
+                *new_len = sb->s_maxbytes - start;
+
+        return 0;
+}
+
+static int ioctl_fiemap(struct file *filp, unsigned long arg)
+{
+        struct fiemap fiemap;
+        struct fiemap_extent_info fieinfo = { 0, };
+        struct inode *inode = filp->f_path.dentry->d_inode;
+        struct super_block *sb = inode->i_sb;
+        u64 len;
+        int error;
+
+        if (!inode->i_op->fiemap)
+                return -EOPNOTSUPP;
+
+        if (copy_from_user(&fiemap, (struct fiemap __user *)arg,
+                           sizeof(struct fiemap)))
+                return -EFAULT;
+
+        if (fiemap.fm_extent_count > FIEMAP_MAX_EXTENTS)
+                return -EINVAL;
+
+        error = fiemap_check_ranges(sb, fiemap.fm_start, fiemap.fm_length,
+                                    &len);
+        if (error)
+                return error;
+
+        fieinfo.fi_flags = fiemap.fm_flags;
+        fieinfo.fi_extents_max = fiemap.fm_extent_count;
+        fieinfo.fi_extents_start = (struct fiemap_extent *)(arg + sizeof(fiemap));
+
+        if (fiemap.fm_extent_count != 0 &&
+            !access_ok(VERIFY_WRITE, fieinfo.fi_extents_start,
+                       fieinfo.fi_extents_max * sizeof(struct fiemap_extent)))
+                return -EFAULT;
+
+        if (fieinfo.fi_flags & FIEMAP_FLAG_SYNC)
+                filemap_write_and_wait(inode->i_mapping);
+
+        error = inode->i_op->fiemap(inode, &fieinfo, fiemap.fm_start, len);
+        fiemap.fm_flags = fieinfo.fi_flags;
+        fiemap.fm_mapped_extents = fieinfo.fi_extents_mapped;
+        if (copy_to_user((char *)arg, &fiemap, sizeof(fiemap)))
+                error = -EFAULT;
+
+        return error;
+}
+
 static int file_ioctl(struct file *filp, unsigned int cmd,
                 unsigned long arg)
 {
@@ -80,6 +233,8 @@ static int file_ioctl(struct file *filp, unsigned int cmd,
         switch (cmd) {
         case FIBMAP:
                 return ioctl_fibmap(filp, p);
+        case FS_IOC_FIEMAP:
+                return ioctl_fiemap(filp, arg);
         case FIGETBSZ:
                 return put_user(inode->i_sb->s_blocksize, p);
         case FIONREAD: