Commit 07d106d0 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

vfs: fix up ENOIOCTLCMD error handling 



We're doing some odd things there, which already messes up various users
(see the net/socket.c code that this removes), and it was going to add
yet more crud to the block layer because of the incorrect error code
translation.

ENOIOCTLCMD is not an error return that should be returned to user mode
from the "ioctl()" system call, but it should *not* be translated as
EINVAL ("Invalid argument").  It should be translated as ENOTTY
("Inappropriate ioctl for device").

That EINVAL confusion has apparently so permeated some code that the
block layer actually checks for it, which is sad.  We continue to do so
for now, but add a big comment about how wrong that is, and we should
remove it entirely eventually.  In the meantime, this tries to keep the
changes localized to just the EINVAL -> ENOTTY fix, and removing code
that makes it harder to do the right thing.

Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 805a6af8

block/ioctl.c

+22 −4
Original line number Diff line number Diff line
@@ -179,6 +179,26 @@ int __blkdev_driver_ioctl(struct block_device *bdev, fmode_t mode, 
 */

EXPORT_SYMBOL_GPL(__blkdev_driver_ioctl);



/*

 * Is it an unrecognized ioctl? The correct returns are either

 * ENOTTY (final) or ENOIOCTLCMD ("I don't know this one, try a

 * fallback"). ENOIOCTLCMD gets turned into ENOTTY by the ioctl

 * code before returning.

 *

 * Confused drivers sometimes return EINVAL, which is wrong. It

 * means "I understood the ioctl command, but the parameters to

 * it were wrong".

 *

 * We should aim to just fix the broken drivers, the EINVAL case

 * should go away.

 */

static inline int is_unrecognized_ioctl(int ret)

{

	return	ret == -EINVAL ||

		ret == -ENOTTY ||

		ret == -ENOIOCTLCMD;

}



/*

 * always keep this in sync with compat_blkdev_ioctl()

 */
@@ -196,8 +216,7 @@ int blkdev_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd, 
			return -EACCES;



		ret = __blkdev_driver_ioctl(bdev, mode, cmd, arg);

		/* -EINVAL to handle old uncorrected drivers */

		if (ret != -EINVAL && ret != -ENOTTY)

		if (!is_unrecognized_ioctl(ret))

			return ret;



		fsync_bdev(bdev);
@@ -206,8 +225,7 @@ int blkdev_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd, 


	case BLKROSET:

		ret = __blkdev_driver_ioctl(bdev, mode, cmd, arg);

		/* -EINVAL to handle old uncorrected drivers */

		if (ret != -EINVAL && ret != -ENOTTY)

		if (!is_unrecognized_ioctl(ret))

			return ret;

		if (!capable(CAP_SYS_ADMIN))

			return -EACCES;

fs/compat_ioctl.c

+2 −36
Original line number Diff line number Diff line
@@ -1506,35 +1506,6 @@ static long do_ioctl_trans(int fd, unsigned int cmd, 
	return -ENOIOCTLCMD;

}



static void compat_ioctl_error(struct file *filp, unsigned int fd,

		unsigned int cmd, unsigned long arg)

{

	char buf[10];

	char *fn = "?";

	char *path;



	/* find the name of the device. */

	path = (char *)__get_free_page(GFP_KERNEL);

	if (path) {

		fn = d_path(&filp->f_path, path, PAGE_SIZE);

		if (IS_ERR(fn))

			fn = "?";

	}



	 sprintf(buf,"'%c'", (cmd>>_IOC_TYPESHIFT) & _IOC_TYPEMASK);

	if (!isprint(buf[1]))

		sprintf(buf, "%02x", buf[1]);

	compat_printk("ioctl32(%s:%d): Unknown cmd fd(%d) "

			"cmd(%08x){t:%s;sz:%u} arg(%08x) on %s\n",

			current->comm, current->pid,

			(int)fd, (unsigned int)cmd, buf,

			(cmd >> _IOC_SIZESHIFT) & _IOC_SIZEMASK,

			(unsigned int)arg, fn);



	if (path)

		free_page((unsigned long)path);

}



static int compat_ioctl_check_table(unsigned int xcmd)

{

	int i;
@@ -1621,13 +1592,8 @@ asmlinkage long compat_sys_ioctl(unsigned int fd, unsigned int cmd, 
		goto found_handler;



	error = do_ioctl_trans(fd, cmd, arg, filp);

	if (error == -ENOIOCTLCMD) {

		static int count;



		if (++count <= 50)

			compat_ioctl_error(filp, fd, cmd, arg);

		error = -EINVAL;

	}

	if (error == -ENOIOCTLCMD)

		error = -ENOTTY;



	goto out_fput;

fs/ioctl.c

+1 −1
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ static long vfs_ioctl(struct file *filp, unsigned int cmd, 


	error = filp->f_op->unlocked_ioctl(filp, cmd, arg);

	if (error == -ENOIOCTLCMD)

		error = -EINVAL;

		error = -ENOTTY;

 out:

	return error;

}

net/socket.c

+1 −15
Original line number Diff line number Diff line
@@ -2883,7 +2883,7 @@ static int bond_ioctl(struct net *net, unsigned int cmd, 


		return dev_ioctl(net, cmd, uifr);

	default:

		return -EINVAL;

		return -ENOIOCTLCMD;

	}

}
@@ -3210,20 +3210,6 @@ static int compat_sock_ioctl_trans(struct file *file, struct socket *sock, 
		return sock_do_ioctl(net, sock, cmd, arg);

	}



	/* Prevent warning from compat_sys_ioctl, these always

	 * result in -EINVAL in the native case anyway. */

	switch (cmd) {

	case SIOCRTMSG:

	case SIOCGIFCOUNT:

	case SIOCSRARP:

	case SIOCGRARP:

	case SIOCDRARP:

	case SIOCSIFLINK:

	case SIOCGIFSLAVE:

	case SIOCSIFSLAVE:

		return -EINVAL;

	}



	return -ENOIOCTLCMD;

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE