[linux-block.git] / include / linux / io_uring.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef _LINUX_IO_URING_H
#define _LINUX_IO_URING_H

#include <linux/sched.h>
#include <linux/xarray.h>
#include <uapi/linux/io_uring.h>

enum io_uring_cmd_flags {
	IO_URING_F_COMPLETE_DEFER	= 1,
	IO_URING_F_UNLOCKED		= 2,
	/* the request is executed from poll, it should not be freed */
	IO_URING_F_MULTISHOT		= 4,
	/* executed by io-wq */
	IO_URING_F_IOWQ			= 8,
	/* int's last bit, sign checks are usually faster than a bit test */
	IO_URING_F_NONBLOCK		= INT_MIN,

	/* ctx state flags, for URING_CMD */
	IO_URING_F_SQE128		= (1 << 8),
	IO_URING_F_CQE32		= (1 << 9),
	IO_URING_F_IOPOLL		= (1 << 10),
};

struct io_uring_cmd {
	struct file	*file;
	const void	*cmd;
	union {
		/* callback to defer completions to task context */
		void (*task_work_cb)(struct io_uring_cmd *cmd, unsigned);
		/* used for polled completion */
		void *cookie;
	};
	u32		cmd_op;
	u32		flags;
	u8		pdu[32]; /* available inline for free use */
};

#if defined(CONFIG_IO_URING)
int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
			      struct iov_iter *iter, void *ioucmd);
void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret, ssize_t res2,
			unsigned issue_flags);
void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
			void (*task_work_cb)(struct io_uring_cmd *, unsigned));
struct sock *io_uring_get_socket(struct file *file);
void __io_uring_cancel(bool cancel_all);
void __io_uring_free(struct task_struct *tsk);
void io_uring_unreg_ringfd(void);
const char *io_uring_get_opcode(u8 opcode);

static inline void io_uring_files_cancel(void)
{
	if (current->io_uring) {
		io_uring_unreg_ringfd();
		__io_uring_cancel(false);
	}
}
static inline void io_uring_task_cancel(void)
{
	if (current->io_uring)
		__io_uring_cancel(true);
}
static inline void io_uring_free(struct task_struct *tsk)
{
	if (tsk->io_uring)
		__io_uring_free(tsk);
}
#else
static inline int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
			      struct iov_iter *iter, void *ioucmd)
{
	return -EOPNOTSUPP;
}
static inline void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret,
		ssize_t ret2, unsigned issue_flags)
{
}
static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
			void (*task_work_cb)(struct io_uring_cmd *, unsigned))
{
}
static inline struct sock *io_uring_get_socket(struct file *file)
{
	return NULL;
}
static inline void io_uring_task_cancel(void)
{
}
static inline void io_uring_files_cancel(void)
{
}
static inline void io_uring_free(struct task_struct *tsk)
{
}
static inline const char *io_uring_get_opcode(u8 opcode)
{
	return "";
}
#endif

#endif
Commit	Line	Data
0f212204 JA	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
	2	#ifndef _LINUX_IO_URING_H
	3	#define _LINUX_IO_URING_H
	4
	5	#include <linux/sched.h>
	6	#include <linux/xarray.h>
a9216fac	7	#include <uapi/linux/io_uring.h>
98447d65	8
ee692a21 JA	9	enum io_uring_cmd_flags {
	10	IO_URING_F_COMPLETE_DEFER = 1,
	11	IO_URING_F_UNLOCKED = 2,
7500194a PB	12	/* the request is executed from poll, it should not be freed */
7500194a PB	13	IO_URING_F_MULTISHOT = 4,
e6aeb272 PB	14	/* executed by io-wq */
e6aeb272 PB	15	IO_URING_F_IOWQ = 8,
ee692a21 JA	16	/* int's last bit, sign checks are usually faster than a bit test */
	17	IO_URING_F_NONBLOCK = INT_MIN,
	18
	19	/* ctx state flags, for URING_CMD */
7500194a PB	20	IO_URING_F_SQE128 = (1 << 8),
	21	IO_URING_F_CQE32 = (1 << 9),
	22	IO_URING_F_IOPOLL = (1 << 10),
ee692a21 JA	23	};
	24
	25	struct io_uring_cmd {
	26	struct file *file;
	27	const void *cmd;
5756a3a7 KJ	28	union {
5756a3a7 KJ	29	/* callback to defer completions to task context */
9d2789ac	30	void (task_work_cb)(struct io_uring_cmd cmd, unsigned);
5756a3a7 KJ	31	/* used for polled completion */
	32	void *cookie;
	33	};
ee692a21	34	u32 cmd_op;
9cda70f6	35	u32 flags;
ee692a21 JA	36	u8 pdu[32]; /* available inline for free use */
	37	};
	38
0f212204	39	#if defined(CONFIG_IO_URING)
a9216fac AG	40	int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
a9216fac AG	41	struct iov_iter iter, void ioucmd);
9d2789ac JA	42	void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret, ssize_t res2,
9d2789ac JA	43	unsigned issue_flags);
ee692a21	44	void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
9d2789ac	45	void (task_work_cb)(struct io_uring_cmd , unsigned));
a3ec6005	46	struct sock io_uring_get_socket(struct file file);
f552a27a	47	void __io_uring_cancel(bool cancel_all);
0f212204	48	void __io_uring_free(struct task_struct *tsk);
e7a6c00d	49	void io_uring_unreg_ringfd(void);
33337d03	50	const char *io_uring_get_opcode(u8 opcode);
0f212204	51
f552a27a	52	static inline void io_uring_files_cancel(void)
0f212204	53	{
e7a6c00d JA	54	if (current->io_uring) {
e7a6c00d JA	55	io_uring_unreg_ringfd();
f552a27a	56	__io_uring_cancel(false);
e7a6c00d	57	}
0f212204	58	}
3f48cf18	59	static inline void io_uring_task_cancel(void)
0f212204	60	{
a4aadd11	61	if (current->io_uring)
f552a27a	62	__io_uring_cancel(true);
0f212204 JA	63	}
	64	static inline void io_uring_free(struct task_struct *tsk)
	65	{
	66	if (tsk->io_uring)
	67	__io_uring_free(tsk);
	68	}
	69	#else
0e0abad2	70	static inline int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
a9216fac AG	71	struct iov_iter iter, void ioucmd)
	72	{
	73	return -EOPNOTSUPP;
	74	}
ee692a21	75	static inline void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret,
9d2789ac	76	ssize_t ret2, unsigned issue_flags)
ee692a21 JA	77	{
	78	}
	79	static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
9d2789ac	80	void (task_work_cb)(struct io_uring_cmd , unsigned))
ee692a21 JA	81	{
ee692a21 JA	82	}
a3ec6005 JA	83	static inline struct sock io_uring_get_socket(struct file file)
	84	{
	85	return NULL;
	86	}
0f212204 JA	87	static inline void io_uring_task_cancel(void)
	88	{
	89	}
f552a27a	90	static inline void io_uring_files_cancel(void)
0f212204 JA	91	{
	92	}
	93	static inline void io_uring_free(struct task_struct *tsk)
	94	{
	95	}
33337d03 DY	96	static inline const char *io_uring_get_opcode(u8 opcode)
	97	{
	98	return "";
	99	}
0f212204 JA	100	#endif
	101
	102	#endif