xfs: kill dead ioctls for 5.17
v2 cover xfs: kill dead ioctls for 5.17
Hi all,
Let's retire some old ioctls that we don't want to support anymore!
v2: target FSSETDM too, and various tweaks to the ALLOCSP log messages
If you're going to start using this mess, you probably ought to just pull from my git trees, which are linked below.
This is an extraordinary way to destroy everything. Enjoy! Comments and questions are, as always, welcome.
--D
kernel git tree:
https://git.kernel.org/cgit/linux/kernel/git/djwong/xfs-linux.git/log/?h=xfs-5.17-kill-ioctls
--- fs/xfs/libxfs/xfs_fs.h | 37 ++++------------- fs/xfs/xfs_bmap_util.c | 7 +-- fs/xfs/xfs_bmap_util.h | 2 - fs/xfs/xfs_file.c | 3 - fs/xfs/xfs_ioctl.c | 102 +++++++----------------------------------------- fs/xfs/xfs_ioctl.h | 6 --- fs/xfs/xfs_ioctl32.c | 27 ------------- fs/xfs/xfs_ioctl32.h | 4 -- 8 files changed, 27 insertions(+), 161 deletions(-)
PATCH v2 1/3 xfs: kill the XFS_IOC_{ALLOC,FREE}SP* ioctls
From: Darrick J. Wong <[email protected]>
According to the glibc compat header for Irix 4, these ioctls originated in April 1991 as a (somewhat clunky) way to preallocate space at the end of a file on an EFS filesystem. XFS, which was released in Irix 5.3 in December 1993, picked up these ioctls to maintain compatibility and they were ported to Linux in the early 2000s.
Recently it was pointed out to me they still lurk in the kernel, even though the Linux fallocate syscall supplanted the functionality a long time ago. fstests doesn't seem to include any real functional or stress tests for these ioctls, which means that the code quality is ... very questionable. Most notably, it was a stale disk block exposure vector for 21 years and nobody noticed or complained. As mature programmers say, "If you're not testing it, it's broken."
Given all that, let's withdraw these ioctls from the XFS userspace API. Normally we'd set a long deprecation process, but I estimate that there aren't any real users, so let's trigger a warning in dmesg and return -ENOTTY.
See: CVE-2021-4155
Augments: 983d8e60f508 ("xfs: map unwritten blocks in XFS_IOC_{ALLOC,FREE}SP just like fallocate")
--- fs/xfs/xfs_bmap_util.c | 7 ++-- fs/xfs/xfs_bmap_util.h | 2 + fs/xfs/xfs_file.c | 3 +- fs/xfs/xfs_ioctl.c | 93 +++--------------------------------------------- fs/xfs/xfs_ioctl.h | 6 --- fs/xfs/xfs_ioctl32.c | 27 -------------- 6 files changed, 10 insertions(+), 128 deletions(-)
fs/xfs/xfs_bmap_util.c +3 -4
@@ -771,8 +771,7 @@ intxfs_alloc_file_space ( struct xfs_inode *ip, xfs_off_t offset, - xfs_off_t len, - int alloc_type) + xfs_off_t len) { xfs_mount_t *mp = ip->i_mount;xfs_off_t count;
@@ -865,8 +864,8 @@ xfs_alloc_file_space( goto error; error =xfs_bmapi_write (tp, ip, startoffset_fsb, - allocatesize_fsb, alloc_type,0 , imapp, - &nimaps); + allocatesize_fsb,XFS_BMAPI_PREALLOC ,0 , imapp, + &nimaps);if (error) goto error;
fs/xfs/xfs_bmap_util.h +1 -1
@@ -54,7 +54,7 @@ int xfs_bmap_last_extent(struct xfs_trans *tp, struct xfs_inode *ip,/* preallocation and hole punch interface */ int xfs_alloc_file_space (struct xfs_inode *ip,xfs_off_t offset, -xfs_off_t len,int alloc_type); +xfs_off_t len);int xfs_free_file_space (struct xfs_inode *ip,xfs_off_t offset,xfs_off_t len); int xfs_collapse_file_space(struct xfs_inode *, xfs_off_t offset,
fs/xfs/xfs_file.c +1 -2
@@ -1052,8 +1052,7 @@ xfs_file_fallocate( }if (!xfs_is_always_cow_inode (ip)) { - error =xfs_alloc_file_space (ip, offset, len, -XFS_BMAPI_PREALLOC ); + error =xfs_alloc_file_space (ip, offset, len);if (error) goto out_unlock; }
fs/xfs/xfs_ioctl.c +5 -88
105 lines not on this page · raw message
fs/xfs/xfs_ioctl.h +0 -6
@@ -10,12 +10,6 @@ struct xfs_bstat;struct xfs_ibulk ;struct xfs_inogrp ; - -extern int -xfs_ioc_space ( -struct file *filp, -xfs_flock64_t *bf); -int xfs_ioc_swapext (xfs_swapext_t *sxp);
fs/xfs/xfs_ioctl32.c +0 -27
@@ -27,22 +27,6 @@ _IOC(_IOC_DIR(cmd), _IOC_TYPE(cmd), _IOC_NR(cmd), sizeof(type))#ifdef BROKEN_X86_ALIGNMENT -STATIC int -xfs_compat_flock64_copyin ( -xfs_flock64_t *bf, -compat_xfs_flock64_t __user *arg32) -{ -if (get_user (bf->l_type, &arg32->l_type) || -get_user (bf->l_whence, &arg32->l_whence) || -get_user (bf->l_start, &arg32->l_start) || -get_user (bf->l_len, &arg32->l_len) || -get_user (bf->l_sysid, &arg32->l_sysid) || -get_user (bf->l_pid, &arg32->l_pid) || -copy_from_user (bf->l_pad, &arg32->l_pad,4 *sizeof (u32))) -return -EFAULT ; -return 0 ; -} - STATIC int xfs_compat_ioc_fsgeometry_v1( struct xfs_mount *mp,
@@ -445,17 +429,6 @@ xfs_file_compat_ioctl(switch (cmd) {#if defined(BROKEN_X86_ALIGNMENT ) -case XFS_IOC_ALLOCSP_32 : -case XFS_IOC_FREESP_32 : -case XFS_IOC_ALLOCSP64_32 : -case XFS_IOC_FREESP64_32 : { -struct xfs_flock64 bf; - -if (xfs_compat_flock64_copyin (&bf, arg)) -return -EFAULT ; - cmd = _NATIVE_IOC(cmd, struct xfs_flock64); -return xfs_ioc_space (filp, &bf); - }case XFS_IOC_FSGEOMETRY_V1_32 :return xfs_compat_ioc_fsgeometry_v1 (ip->i_mount, arg);case XFS_IOC_FSGROWFSDATA_32 : {
Re: [PATCH 1/3] xfs: kill the XFS_IOC_{ALLOC,FREE}SP* ioctls
Quoted 21 lines · Darrick J. Wong
From: Darrick J. Wong <[email protected]>
According to the glibc compat header for Irix 4, these ioctls originated in April 1991 as a (somewhat clunky) way to preallocate space at the end of a file on an EFS filesystem. XFS, which was released in Irix 5.3 in December 1993, picked up these ioctls to maintain compatibility and they were ported to Linux in the early 2000s.
Recently it was pointed out to me they still lurk in the kernel, even though the Linux fallocate syscall supplanted the functionality a long time ago. fstests doesn't seem to include any real functional or stress tests for these ioctls, which means that the code quality is ... very questionable. Most notably, it was a stale disk block exposure vector for 21 years and nobody noticed or complained. As mature programmers say, "If you're not testing it, it's broken."
Given all that, let's withdraw these ioctls from the XFS userspace API. Normally we'd set a long deprecation process, but I estimate that there aren't any real users, so let's trigger a warning in dmesg and return
-ENOTTY.
Quoted 5 lines
See: CVE-2021-4155
Augments:
983d8e60f508("xfs: map unwritten blocks in XFS_IOC_{ALLOC,FREE}SP just like fallocate")Signed-off-by Darrick J. Wong <[email protected]>Reviewed-by Eric Sandeen <[email protected]>
Looks good now.
Signature · 2 lines
Dave Chinner [email protected]
Re: [PATCH 1/3] xfs: kill the XFS_IOC_{ALLOC,FREE}SP* ioctls
I will just mention in passing that we augment the XFS_IOC_ALLOC ioctl to perform explicit near-to-block allocation. I’m not suggesting you shouldn’t withdraw the ioctls, just referencing xkcd 1172.
—
Roger
Quoted 37 lines · Dave Chinner
Quoted 21 lines · Darrick J. Wong
From: Darrick J. Wong <[email protected]>
According to the glibc compat header for Irix 4, these ioctls originated in April 1991 as a (somewhat clunky) way to preallocate space at the end of a file on an EFS filesystem. XFS, which was released in Irix 5.3 in December 1993, picked up these ioctls to maintain compatibility and they were ported to Linux in the early 2000s.
Recently it was pointed out to me they still lurk in the kernel, even though the Linux fallocate syscall supplanted the functionality a long time ago. fstests doesn't seem to include any real functional or stress tests for these ioctls, which means that the code quality is ... very questionable. Most notably, it was a stale disk block exposure vector for 21 years and nobody noticed or complained. As mature programmers say, "If you're not testing it, it's broken."
Given all that, let's withdraw these ioctls from the XFS userspace API. Normally we'd set a long deprecation process, but I estimate that there aren't any real users, so let's trigger a warning in dmesg and return
-ENOTTY.Quoted 5 lines
See: CVE-2021-4155
Augments:
983d8e60f508("xfs: map unwritten blocks in XFS_IOC_{ALLOC,FREE}SP just like fallocate")Signed-off-by Darrick J. Wong <[email protected]>Reviewed-by Eric Sandeen <[email protected]>Looks good now.
Reviewed-by Dave Chinner <[email protected]>Signature · 2 lines
Dave Chinner [email protected]
PATCH v2 2/3 xfs: remove the XFS_IOC_{ALLOC,FREE}SP* definitions
In reply to Darrick J. WongFrom: Darrick J. Wong <[email protected]>
Now that we've made these ioctls defunct, move them from xfs_fs.h to xfs_ioctl.c, which effectively removes them from the publicly supported ioctl interfaces for XFS.
--- fs/xfs/libxfs/xfs_fs.h | 8 ++++---- fs/xfs/xfs_ioctl.c | 9 +++++++++ fs/xfs/xfs_ioctl32.h | 4 ---- 3 files changed, 13 insertions(+), 8 deletions(-)
fs/xfs/libxfs/xfs_fs.h +4 -4
@@ -781,13 +781,13 @@ struct xfs_scrub_metadata {* For 'documentation' purposed more than anything else, * the "cmd #" field reflects the IRIX fcntl number. */ -#define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64) -#define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64) +/* XFS_IOC_ALLOCSP ------- deprecated 10 */ +/* XFS_IOC_FREESP -------- deprecated 11 */ #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)#define XFS_IOC_FSGETXATTR FS_IOC_FSGETXATTR#define XFS_IOC_FSSETXATTR FS_IOC_FSSETXATTR -#define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64) -#define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64) +/* XFS_IOC_ALLOCSP64 ----- deprecated 36 */ +/* XFS_IOC_FREESP64 ------ deprecated 37 */ #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)#define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)#define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
fs/xfs/xfs_ioctl.c +9 -0
@@ -1854,6 +1854,15 @@ xfs_fs_eofblocks_from_user(return 0 ; } +/* +* These long-unused ioctls were removed from the official ioctl API in 5.17, +* but retain these definitions so that we can log warnings about them. +*/ +#define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64) +#define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64) +#define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64) +#define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64) +/* * Note: some of the ioctl's return positive numbers as a * byte count indicating success, such as readlink_by_handle.
fs/xfs/xfs_ioctl32.h +0 -4
@@ -154,10 +154,6 @@ typedef struct compat_xfs_flock64 {__s32 l_pad[4 ];/* reserve area */ } compat_xfs_flock64_t; -#define XFS_IOC_ALLOCSP_32 _IOW('X', 10, struct compat_xfs_flock64) -#define XFS_IOC_FREESP_32 _IOW('X', 11, struct compat_xfs_flock64) -#define XFS_IOC_ALLOCSP64_32 _IOW('X', 36, struct compat_xfs_flock64) -#define XFS_IOC_FREESP64_32 _IOW('X', 37, struct compat_xfs_flock64)#define XFS_IOC_RESVSP_32 _IOW('X', 40, struct compat_xfs_flock64)#define XFS_IOC_UNRESVSP_32 _IOW('X', 41, struct compat_xfs_flock64)#define XFS_IOC_RESVSP64_32 _IOW('X', 42, struct compat_xfs_flock64)
PATCH v2 3/3 xfs: remove the XFS_IOC_FSSETDM definitions
In reply to Darrick J. WongFrom: Darrick J. Wong <[email protected]>
Remove the definitions for these ioctls, since the functionality (and, weirdly, the 32-bit compat ioctl definitions) were removed from the kernel in November 2019.
--- fs/xfs/libxfs/xfs_fs.h | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-)
fs/xfs/libxfs/xfs_fs.h +4 -25
@@ -92,21 +92,6 @@ struct getbmapx {#define XFS_FMR_OWN_COW FMR_OWNER('X', 7)/* cow staging */ #define XFS_FMR_OWN_DEFECTIVE FMR_OWNER('X', 8)/* bad blocks */ -/* -* Structure for XFS_IOC_FSSETDM. -* For use by backup and restore programs to set the XFS on-disk inode -* fields di_dmevmask and di_dmstate. These must be set to exactly and -* only values previously obtained via xfs_bulkstat! (Specifically the -* struct xfs_bstat fields bs_dmevmask and bs_dmstate.) -*/ -#ifndef HAVE_FSDMIDATA -struct fsdmidata { -__u32 fsd_dmevmask;/* corresponds to di_dmevmask */ -__u16 fsd_padding; -__u16 fsd_dmstate;/* corresponds to di_dmstate */ -}; -#endif -/* * File segment locking set data type for 64 bit access. * Also used for all the RESV/FREE interfaces.
@@ -562,16 +547,10 @@ typedef struct xfs_fsop_handlereq {/* * Compound structures for passing args through Handle Request interfaces -* xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle -* - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and -* XFS_IOC_ATTRMULTI_BY_HANDLE +* xfs_attrlist_by_handle, xfs_attrmulti_by_handle +* - ioctls: XFS_IOC_ATTRLIST_BY_HANDLE, and XFS_IOC_ATTRMULTI_BY_HANDLE */ -typedef struct xfs_fsop_setdm_handlereq { -struct xfs_fsop_handlereq hreq;/* handle information */ -struct fsdmidata __user *data;/* DMAPI data */ -}xfs_fsop_setdm_handlereq_t ; -/* * Flags passed in xfs_attr_multiop.am_flags for the attr ioctl interface. *
@@ -789,7 +768,7 @@ struct xfs_scrub_metadata {/* XFS_IOC_ALLOCSP64 ----- deprecated 36 */ /* XFS_IOC_FREESP64 ------ deprecated 37 */ #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap) -#define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata) +/* XFS_IOC_FSSETDM ------- deprecated 39 */ #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)#define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)#define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
@@ -831,7 +810,7 @@ struct xfs_scrub_metadata {#define XFS_IOC_FREEZE _IOWR('X', 119, int)/* aka FIFREEZE */ #define XFS_IOC_THAW _IOWR('X', 120, int)/* aka FITHAW */ -#define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq) +/* XFS_IOC_FSSETDM_BY_HANDLE -- deprecated 121 */ #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)#define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)#define XFS_IOC_FSGEOMETRY_V4 _IOR ('X', 124, struct xfs_fsop_geom_v4)
Re: [PATCH 3/3] xfs: remove the XFS_IOC_FSSETDM definitions
Quoted 10 lines · Darrick J. Wong
From: Darrick J. Wong <[email protected]>
Remove the definitions for these ioctls, since the functionality (and, weirdly, the 32-bit compat ioctl definitions) were removed from the kernel in November 2019.
Signed-off-by Darrick J. Wong <[email protected]>--- fs/xfs/libxfs/xfs_fs.h | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-)
Looks fine to me.
THe only user I know of is xfsdump, and it will only use this functionality if a special CLI option is given to it. Given that this would just be writing zeros as this is what will be in the inodes that are backed up by xfsdump, I don't see it a big problem if this fails now.
Nothing else out there is likely to be using this ioctl - the DMAPI state was specific to a long dead proprietary SGI HSM product and that's the only thing I know of that used this ioctl to set non-zero values in the first place.
Hence I think removing this ioctl has very little risk of userspace regression.
Signature · 2 lines
Dave Chinner [email protected]