[linux-2.6-block.git] / io_uring / uring_cmd.c

// SPDX-License-Identifier: GPL-2.0
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/file.h>
#include <linux/io_uring/cmd.h>
#include <linux/security.h>
#include <linux/nospec.h>
#include <net/sock.h>

#include <uapi/linux/io_uring.h>
#include <asm/ioctls.h>

#include "io_uring.h"
#include "rsrc.h"
#include "uring_cmd.h"

static void io_uring_cmd_del_cancelable(struct io_uring_cmd *cmd,
		unsigned int issue_flags)
{
	struct io_kiocb *req = cmd_to_io_kiocb(cmd);
	struct io_ring_ctx *ctx = req->ctx;

	if (!(cmd->flags & IORING_URING_CMD_CANCELABLE))
		return;

	cmd->flags &= ~IORING_URING_CMD_CANCELABLE;
	io_ring_submit_lock(ctx, issue_flags);
	hlist_del(&req->hash_node);
	io_ring_submit_unlock(ctx, issue_flags);
}

/*
 * Mark this command as concelable, then io_uring_try_cancel_uring_cmd()
 * will try to cancel this issued command by sending ->uring_cmd() with
 * issue_flags of IO_URING_F_CANCEL.
 *
 * The command is guaranteed to not be done when calling ->uring_cmd()
 * with IO_URING_F_CANCEL, but it is driver's responsibility to deal
 * with race between io_uring canceling and normal completion.
 */
void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd,
		unsigned int issue_flags)
{
	struct io_kiocb *req = cmd_to_io_kiocb(cmd);
	struct io_ring_ctx *ctx = req->ctx;

	if (!(cmd->flags & IORING_URING_CMD_CANCELABLE)) {
		cmd->flags |= IORING_URING_CMD_CANCELABLE;
		io_ring_submit_lock(ctx, issue_flags);
		hlist_add_head(&req->hash_node, &ctx->cancelable_uring_cmd);
		io_ring_submit_unlock(ctx, issue_flags);
	}
}
EXPORT_SYMBOL_GPL(io_uring_cmd_mark_cancelable);

static void io_uring_cmd_work(struct io_kiocb *req, struct io_tw_state *ts)
{
	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
	unsigned issue_flags = ts->locked ? 0 : IO_URING_F_UNLOCKED;

	ioucmd->task_work_cb(ioucmd, issue_flags);
}

void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd,
			void (*task_work_cb)(struct io_uring_cmd *, unsigned),
			unsigned flags)
{
	struct io_kiocb *req = cmd_to_io_kiocb(ioucmd);

	ioucmd->task_work_cb = task_work_cb;
	req->io_task_work.func = io_uring_cmd_work;
	__io_req_task_work_add(req, flags);
}
EXPORT_SYMBOL_GPL(__io_uring_cmd_do_in_task);

static inline void io_req_set_cqe32_extra(struct io_kiocb *req,
					  u64 extra1, u64 extra2)
{
	req->big_cqe.extra1 = extra1;
	req->big_cqe.extra2 = extra2;
}

/*
 * Called by consumers of io_uring_cmd, if they originally returned
 * -EIOCBQUEUED upon receiving the command.
 */
void io_uring_cmd_done(struct io_uring_cmd *ioucmd, ssize_t ret, ssize_t res2,
		       unsigned issue_flags)
{
	struct io_kiocb *req = cmd_to_io_kiocb(ioucmd);

	io_uring_cmd_del_cancelable(ioucmd, issue_flags);

	if (ret < 0)
		req_set_fail(req);

	io_req_set_res(req, ret, 0);
	if (req->ctx->flags & IORING_SETUP_CQE32)
		io_req_set_cqe32_extra(req, res2, 0);
	if (req->ctx->flags & IORING_SETUP_IOPOLL) {
		/* order with io_iopoll_req_issued() checking ->iopoll_complete */
		smp_store_release(&req->iopoll_completed, 1);
	} else {
		struct io_tw_state ts = {
			.locked = !(issue_flags & IO_URING_F_UNLOCKED),
		};
		io_req_task_complete(req, &ts);
	}
}
EXPORT_SYMBOL_GPL(io_uring_cmd_done);

int io_uring_cmd_prep_async(struct io_kiocb *req)
{
	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);

	memcpy(req->async_data, ioucmd->sqe, uring_sqe_size(req->ctx));
	ioucmd->sqe = req->async_data;
	return 0;
}

int io_uring_cmd_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
{
	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);

	if (sqe->__pad1)
		return -EINVAL;

	ioucmd->flags = READ_ONCE(sqe->uring_cmd_flags);
	if (ioucmd->flags & ~IORING_URING_CMD_MASK)
		return -EINVAL;

	if (ioucmd->flags & IORING_URING_CMD_FIXED) {
		struct io_ring_ctx *ctx = req->ctx;
		u16 index;

		req->buf_index = READ_ONCE(sqe->buf_index);
		if (unlikely(req->buf_index >= ctx->nr_user_bufs))
			return -EFAULT;
		index = array_index_nospec(req->buf_index, ctx->nr_user_bufs);
		req->imu = ctx->user_bufs[index];
		io_req_set_rsrc_node(req, ctx, 0);
	}
	ioucmd->sqe = sqe;
	ioucmd->cmd_op = READ_ONCE(sqe->cmd_op);
	return 0;
}

int io_uring_cmd(struct io_kiocb *req, unsigned int issue_flags)
{
	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
	struct io_ring_ctx *ctx = req->ctx;
	struct file *file = req->file;
	int ret;

	if (!file->f_op->uring_cmd)
		return -EOPNOTSUPP;

	ret = security_uring_cmd(ioucmd);
	if (ret)
		return ret;

	if (ctx->flags & IORING_SETUP_SQE128)
		issue_flags |= IO_URING_F_SQE128;
	if (ctx->flags & IORING_SETUP_CQE32)
		issue_flags |= IO_URING_F_CQE32;
	if (ctx->compat)
		issue_flags |= IO_URING_F_COMPAT;
	if (ctx->flags & IORING_SETUP_IOPOLL) {
		if (!file->f_op->uring_cmd_iopoll)
			return -EOPNOTSUPP;
		issue_flags |= IO_URING_F_IOPOLL;
		req->iopoll_completed = 0;
	}

	ret = file->f_op->uring_cmd(ioucmd, issue_flags);
	if (ret == -EAGAIN) {
		if (!req_has_async_data(req)) {
			if (io_alloc_async_data(req))
				return -ENOMEM;
			io_uring_cmd_prep_async(req);
		}
		return -EAGAIN;
	}

	if (ret != -EIOCBQUEUED) {
		if (ret < 0)
			req_set_fail(req);
		io_req_set_res(req, ret, 0);
		return ret;
	}

	return IOU_ISSUE_SKIP_COMPLETE;
}

int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
			      struct iov_iter *iter, void *ioucmd)
{
	struct io_kiocb *req = cmd_to_io_kiocb(ioucmd);

	return io_import_fixed(rw, iter, req->imu, ubuf, len);
}
EXPORT_SYMBOL_GPL(io_uring_cmd_import_fixed);

static inline int io_uring_cmd_getsockopt(struct socket *sock,
					  struct io_uring_cmd *cmd,
					  unsigned int issue_flags)
{
	bool compat = !!(issue_flags & IO_URING_F_COMPAT);
	int optlen, optname, level, err;
	void __user *optval;

	level = READ_ONCE(cmd->sqe->level);
	if (level != SOL_SOCKET)
		return -EOPNOTSUPP;

	optval = u64_to_user_ptr(READ_ONCE(cmd->sqe->optval));
	optname = READ_ONCE(cmd->sqe->optname);
	optlen = READ_ONCE(cmd->sqe->optlen);

	err = do_sock_getsockopt(sock, compat, level, optname,
				 USER_SOCKPTR(optval),
				 KERNEL_SOCKPTR(&optlen));
	if (err)
		return err;

	/* On success, return optlen */
	return optlen;
}

static inline int io_uring_cmd_setsockopt(struct socket *sock,
					  struct io_uring_cmd *cmd,
					  unsigned int issue_flags)
{
	bool compat = !!(issue_flags & IO_URING_F_COMPAT);
	int optname, optlen, level;
	void __user *optval;
	sockptr_t optval_s;

	optval = u64_to_user_ptr(READ_ONCE(cmd->sqe->optval));
	optname = READ_ONCE(cmd->sqe->optname);
	optlen = READ_ONCE(cmd->sqe->optlen);
	level = READ_ONCE(cmd->sqe->level);
	optval_s = USER_SOCKPTR(optval);

	return do_sock_setsockopt(sock, compat, level, optname, optval_s,
				  optlen);
}

#if defined(CONFIG_NET)
int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags)
{
	struct socket *sock = cmd->file->private_data;
	struct sock *sk = sock->sk;
	struct proto *prot = READ_ONCE(sk->sk_prot);
	int ret, arg = 0;

	if (!prot || !prot->ioctl)
		return -EOPNOTSUPP;

	switch (cmd->sqe->cmd_op) {
	case SOCKET_URING_OP_SIOCINQ:
		ret = prot->ioctl(sk, SIOCINQ, &arg);
		if (ret)
			return ret;
		return arg;
	case SOCKET_URING_OP_SIOCOUTQ:
		ret = prot->ioctl(sk, SIOCOUTQ, &arg);
		if (ret)
			return ret;
		return arg;
	case SOCKET_URING_OP_GETSOCKOPT:
		return io_uring_cmd_getsockopt(sock, cmd, issue_flags);
	case SOCKET_URING_OP_SETSOCKOPT:
		return io_uring_cmd_setsockopt(sock, cmd, issue_flags);
	default:
		return -EOPNOTSUPP;
	}
}
EXPORT_SYMBOL_GPL(io_uring_cmd_sock);
#endif
Commit	Line	Data
99f15d8d JA	1	// SPDX-License-Identifier: GPL-2.0
	2	#include <linux/kernel.h>
	3	#include <linux/errno.h>
	4	#include <linux/file.h>
b66509b8	5	#include <linux/io_uring/cmd.h>
2a584012	6	#include <linux/security.h>
9cda70f6	7	#include <linux/nospec.h>
3fb1764c	8	#include <net/sock.h>
99f15d8d JA	9
99f15d8d JA	10	#include <uapi/linux/io_uring.h>
1ba0e9d6	11	#include <asm/ioctls.h>
99f15d8d	12
99f15d8d	13	#include "io_uring.h"
a9216fac	14	#include "rsrc.h"
99f15d8d JA	15	#include "uring_cmd.h"
99f15d8d JA	16
93b8cc60 ML	17	static void io_uring_cmd_del_cancelable(struct io_uring_cmd *cmd,
	18	unsigned int issue_flags)
	19	{
	20	struct io_kiocb *req = cmd_to_io_kiocb(cmd);
	21	struct io_ring_ctx *ctx = req->ctx;
	22
	23	if (!(cmd->flags & IORING_URING_CMD_CANCELABLE))
	24	return;
	25
	26	cmd->flags &= ~IORING_URING_CMD_CANCELABLE;
	27	io_ring_submit_lock(ctx, issue_flags);
	28	hlist_del(&req->hash_node);
	29	io_ring_submit_unlock(ctx, issue_flags);
	30	}
	31
	32	/*
	33	* Mark this command as concelable, then io_uring_try_cancel_uring_cmd()
	34	* will try to cancel this issued command by sending ->uring_cmd() with
	35	* issue_flags of IO_URING_F_CANCEL.
	36	*
	37	* The command is guaranteed to not be done when calling ->uring_cmd()
	38	* with IO_URING_F_CANCEL, but it is driver's responsibility to deal
	39	* with race between io_uring canceling and normal completion.
	40	*/
	41	void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd,
	42	unsigned int issue_flags)
	43	{
	44	struct io_kiocb *req = cmd_to_io_kiocb(cmd);
	45	struct io_ring_ctx *ctx = req->ctx;
	46
	47	if (!(cmd->flags & IORING_URING_CMD_CANCELABLE)) {
	48	cmd->flags \|= IORING_URING_CMD_CANCELABLE;
	49	io_ring_submit_lock(ctx, issue_flags);
	50	hlist_add_head(&req->hash_node, &ctx->cancelable_uring_cmd);
	51	io_ring_submit_unlock(ctx, issue_flags);
	52	}
	53	}
	54	EXPORT_SYMBOL_GPL(io_uring_cmd_mark_cancelable);
	55
a282967c	56	static void io_uring_cmd_work(struct io_kiocb req, struct io_tw_state ts)
99f15d8d	57	{
f2ccb5ae	58	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
a282967c	59	unsigned issue_flags = ts->locked ? 0 : IO_URING_F_UNLOCKED;
99f15d8d	60
9d2789ac	61	ioucmd->task_work_cb(ioucmd, issue_flags);
99f15d8d JA	62	}
99f15d8d JA	63
5f3139fc PB	64	void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd,
	65	void (task_work_cb)(struct io_uring_cmd , unsigned),
	66	unsigned flags)
99f15d8d JA	67	{
	68	struct io_kiocb *req = cmd_to_io_kiocb(ioucmd);
	69
	70	ioucmd->task_work_cb = task_work_cb;
	71	req->io_task_work.func = io_uring_cmd_work;
5f3139fc PB	72	__io_req_task_work_add(req, flags);
	73	}
	74	EXPORT_SYMBOL_GPL(__io_uring_cmd_do_in_task);
	75
99f15d8d JA	76	static inline void io_req_set_cqe32_extra(struct io_kiocb *req,
	77	u64 extra1, u64 extra2)
	78	{
b24c5d75 PB	79	req->big_cqe.extra1 = extra1;
b24c5d75 PB	80	req->big_cqe.extra2 = extra2;
99f15d8d JA	81	}
	82
	83	/*
	84	* Called by consumers of io_uring_cmd, if they originally returned
	85	* -EIOCBQUEUED upon receiving the command.
	86	*/
9d2789ac JA	87	void io_uring_cmd_done(struct io_uring_cmd *ioucmd, ssize_t ret, ssize_t res2,
9d2789ac JA	88	unsigned issue_flags)
99f15d8d JA	89	{
	90	struct io_kiocb *req = cmd_to_io_kiocb(ioucmd);
	91
93b8cc60 ML	92	io_uring_cmd_del_cancelable(ioucmd, issue_flags);
93b8cc60 ML	93
99f15d8d JA	94	if (ret < 0)
	95	req_set_fail(req);
	96
ff2557b7	97	io_req_set_res(req, ret, 0);
99f15d8d JA	98	if (req->ctx->flags & IORING_SETUP_CQE32)
99f15d8d JA	99	io_req_set_cqe32_extra(req, res2, 0);
27a67079	100	if (req->ctx->flags & IORING_SETUP_IOPOLL) {
5756a3a7 KJ	101	/* order with io_iopoll_req_issued() checking ->iopoll_complete */
5756a3a7 KJ	102	smp_store_release(&req->iopoll_completed, 1);
27a67079 JA	103	} else {
	104	struct io_tw_state ts = {
	105	.locked = !(issue_flags & IO_URING_F_UNLOCKED),
	106	};
	107	io_req_task_complete(req, &ts);
	108	}
99f15d8d JA	109	}
	110	EXPORT_SYMBOL_GPL(io_uring_cmd_done);
	111
	112	int io_uring_cmd_prep_async(struct io_kiocb *req)
	113	{
f2ccb5ae	114	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
99f15d8d	115
fd9b8547 BL	116	memcpy(req->async_data, ioucmd->sqe, uring_sqe_size(req->ctx));
fd9b8547 BL	117	ioucmd->sqe = req->async_data;
99f15d8d JA	118	return 0;
	119	}
	120
	121	int io_uring_cmd_prep(struct io_kiocb req, const struct io_uring_sqe sqe)
	122	{
f2ccb5ae	123	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
99f15d8d	124
9cda70f6	125	if (sqe->__pad1)
99f15d8d	126	return -EINVAL;
9cda70f6 AG	127
9cda70f6 AG	128	ioucmd->flags = READ_ONCE(sqe->uring_cmd_flags);
528ce678	129	if (ioucmd->flags & ~IORING_URING_CMD_MASK)
9cda70f6 AG	130	return -EINVAL;
	131
	132	if (ioucmd->flags & IORING_URING_CMD_FIXED) {
	133	struct io_ring_ctx *ctx = req->ctx;
	134	u16 index;
	135
	136	req->buf_index = READ_ONCE(sqe->buf_index);
	137	if (unlikely(req->buf_index >= ctx->nr_user_bufs))
	138	return -EFAULT;
	139	index = array_index_nospec(req->buf_index, ctx->nr_user_bufs);
	140	req->imu = ctx->user_bufs[index];
	141	io_req_set_rsrc_node(req, ctx, 0);
	142	}
fd9b8547	143	ioucmd->sqe = sqe;
99f15d8d JA	144	ioucmd->cmd_op = READ_ONCE(sqe->cmd_op);
	145	return 0;
	146	}
	147
	148	int io_uring_cmd(struct io_kiocb *req, unsigned int issue_flags)
	149	{
f2ccb5ae	150	struct io_uring_cmd *ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
99f15d8d JA	151	struct io_ring_ctx *ctx = req->ctx;
	152	struct file *file = req->file;
	153	int ret;
	154
03b3d6be	155	if (!file->f_op->uring_cmd)
99f15d8d JA	156	return -EOPNOTSUPP;
99f15d8d JA	157
2a584012 LC	158	ret = security_uring_cmd(ioucmd);
	159	if (ret)
	160	return ret;
	161
99f15d8d JA	162	if (ctx->flags & IORING_SETUP_SQE128)
	163	issue_flags \|= IO_URING_F_SQE128;
	164	if (ctx->flags & IORING_SETUP_CQE32)
	165	issue_flags \|= IO_URING_F_CQE32;
5fea44a6 BL	166	if (ctx->compat)
5fea44a6 BL	167	issue_flags \|= IO_URING_F_COMPAT;
5756a3a7	168	if (ctx->flags & IORING_SETUP_IOPOLL) {
03b3d6be JA	169	if (!file->f_op->uring_cmd_iopoll)
03b3d6be JA	170	return -EOPNOTSUPP;
99f15d8d	171	issue_flags \|= IO_URING_F_IOPOLL;
5756a3a7	172	req->iopoll_completed = 0;
5756a3a7	173	}
99f15d8d	174
99f15d8d JA	175	ret = file->f_op->uring_cmd(ioucmd, issue_flags);
	176	if (ret == -EAGAIN) {
	177	if (!req_has_async_data(req)) {
	178	if (io_alloc_async_data(req))
	179	return -ENOMEM;
	180	io_uring_cmd_prep_async(req);
	181	}
	182	return -EAGAIN;
	183	}
	184
	185	if (ret != -EIOCBQUEUED) {
3ed159c9 AG	186	if (ret < 0)
	187	req_set_fail(req);
	188	io_req_set_res(req, ret, 0);
a9c3eda7	189	return ret;
99f15d8d JA	190	}
	191
	192	return IOU_ISSUE_SKIP_COMPLETE;
	193	}
a9216fac AG	194
	195	int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
	196	struct iov_iter iter, void ioucmd)
	197	{
	198	struct io_kiocb *req = cmd_to_io_kiocb(ioucmd);
	199
	200	return io_import_fixed(rw, iter, req->imu, ubuf, len);
	201	}
	202	EXPORT_SYMBOL_GPL(io_uring_cmd_import_fixed);
8e9fad0e	203
a5d2f99a BL	204	static inline int io_uring_cmd_getsockopt(struct socket *sock,
	205	struct io_uring_cmd *cmd,
	206	unsigned int issue_flags)
	207	{
	208	bool compat = !!(issue_flags & IO_URING_F_COMPAT);
	209	int optlen, optname, level, err;
	210	void __user *optval;
	211
	212	level = READ_ONCE(cmd->sqe->level);
	213	if (level != SOL_SOCKET)
	214	return -EOPNOTSUPP;
	215
	216	optval = u64_to_user_ptr(READ_ONCE(cmd->sqe->optval));
	217	optname = READ_ONCE(cmd->sqe->optname);
	218	optlen = READ_ONCE(cmd->sqe->optlen);
	219
	220	err = do_sock_getsockopt(sock, compat, level, optname,
	221	USER_SOCKPTR(optval),
	222	KERNEL_SOCKPTR(&optlen));
	223	if (err)
	224	return err;
	225
	226	/* On success, return optlen */
	227	return optlen;
	228	}
	229
4232c6e3 BL	230	static inline int io_uring_cmd_setsockopt(struct socket *sock,
	231	struct io_uring_cmd *cmd,
	232	unsigned int issue_flags)
	233	{
	234	bool compat = !!(issue_flags & IO_URING_F_COMPAT);
	235	int optname, optlen, level;
	236	void __user *optval;
	237	sockptr_t optval_s;
	238
	239	optval = u64_to_user_ptr(READ_ONCE(cmd->sqe->optval));
	240	optname = READ_ONCE(cmd->sqe->optname);
	241	optlen = READ_ONCE(cmd->sqe->optlen);
	242	level = READ_ONCE(cmd->sqe->level);
	243	optval_s = USER_SOCKPTR(optval);
	244
	245	return do_sock_setsockopt(sock, compat, level, optname, optval_s,
	246	optlen);
	247	}
	248
d2cac3ec	249	#if defined(CONFIG_NET)
8e9fad0e BL	250	int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags)
	251	{
	252	struct socket *sock = cmd->file->private_data;
	253	struct sock *sk = sock->sk;
	254	struct proto *prot = READ_ONCE(sk->sk_prot);
	255	int ret, arg = 0;
	256
	257	if (!prot \|\| !prot->ioctl)
	258	return -EOPNOTSUPP;
	259
	260	switch (cmd->sqe->cmd_op) {
	261	case SOCKET_URING_OP_SIOCINQ:
	262	ret = prot->ioctl(sk, SIOCINQ, &arg);
	263	if (ret)
	264	return ret;
	265	return arg;
	266	case SOCKET_URING_OP_SIOCOUTQ:
	267	ret = prot->ioctl(sk, SIOCOUTQ, &arg);
	268	if (ret)
	269	return ret;
	270	return arg;
a5d2f99a BL	271	case SOCKET_URING_OP_GETSOCKOPT:
a5d2f99a BL	272	return io_uring_cmd_getsockopt(sock, cmd, issue_flags);
4232c6e3 BL	273	case SOCKET_URING_OP_SETSOCKOPT:
4232c6e3 BL	274	return io_uring_cmd_setsockopt(sock, cmd, issue_flags);
8e9fad0e BL	275	default:
	276	return -EOPNOTSUPP;
	277	}
	278	}
	279	EXPORT_SYMBOL_GPL(io_uring_cmd_sock);
d2cac3ec	280	#endif