Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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>
7#include <uapi/linux/io_uring.h>
8
9enum io_uring_cmd_flags {
10 IO_URING_F_COMPLETE_DEFER = 1,
11 IO_URING_F_UNLOCKED = 2,
12 /* the request is executed from poll, it should not be freed */
13 IO_URING_F_MULTISHOT = 4,
14 /* executed by io-wq */
15 IO_URING_F_IOWQ = 8,
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 */
20 IO_URING_F_SQE128 = (1 << 8),
21 IO_URING_F_CQE32 = (1 << 9),
22 IO_URING_F_IOPOLL = (1 << 10),
23};
24
25struct io_uring_cmd {
26 struct file *file;
27 const struct io_uring_sqe *sqe;
28 union {
29 /* callback to defer completions to task context */
30 void (*task_work_cb)(struct io_uring_cmd *cmd, unsigned);
31 /* used for polled completion */
32 void *cookie;
33 };
34 u32 cmd_op;
35 u32 flags;
36 u8 pdu[32]; /* available inline for free use */
37};
38
39static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe)
40{
41 return sqe->cmd;
42}
43
44#if defined(CONFIG_IO_URING)
45int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
46 struct iov_iter *iter, void *ioucmd);
47void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret, ssize_t res2,
48 unsigned issue_flags);
49struct sock *io_uring_get_socket(struct file *file);
50void __io_uring_cancel(bool cancel_all);
51void __io_uring_free(struct task_struct *tsk);
52void io_uring_unreg_ringfd(void);
53const char *io_uring_get_opcode(u8 opcode);
54void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd,
55 void (*task_work_cb)(struct io_uring_cmd *, unsigned),
56 unsigned flags);
57/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */
58void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd,
59 void (*task_work_cb)(struct io_uring_cmd *, unsigned));
60
61static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
62 void (*task_work_cb)(struct io_uring_cmd *, unsigned))
63{
64 __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0);
65}
66
67static inline void io_uring_files_cancel(void)
68{
69 if (current->io_uring) {
70 io_uring_unreg_ringfd();
71 __io_uring_cancel(false);
72 }
73}
74static inline void io_uring_task_cancel(void)
75{
76 if (current->io_uring)
77 __io_uring_cancel(true);
78}
79static inline void io_uring_free(struct task_struct *tsk)
80{
81 if (tsk->io_uring)
82 __io_uring_free(tsk);
83}
84#else
85static inline int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
86 struct iov_iter *iter, void *ioucmd)
87{
88 return -EOPNOTSUPP;
89}
90static inline void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret,
91 ssize_t ret2, unsigned issue_flags)
92{
93}
94static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
95 void (*task_work_cb)(struct io_uring_cmd *, unsigned))
96{
97}
98static inline void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd,
99 void (*task_work_cb)(struct io_uring_cmd *, unsigned))
100{
101}
102static inline struct sock *io_uring_get_socket(struct file *file)
103{
104 return NULL;
105}
106static inline void io_uring_task_cancel(void)
107{
108}
109static inline void io_uring_files_cancel(void)
110{
111}
112static inline void io_uring_free(struct task_struct *tsk)
113{
114}
115static inline const char *io_uring_get_opcode(u8 opcode)
116{
117 return "";
118}
119#endif
120
121#endif