xref: /linux-6.15/include/linux/io_uring/cmd.h (revision 6b04a373)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef _LINUX_IO_URING_CMD_H
3 #define _LINUX_IO_URING_CMD_H
4 
5 #include <uapi/linux/io_uring.h>
6 #include <linux/io_uring_types.h>
7 
8 /* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */
9 #define IORING_URING_CMD_CANCELABLE	(1U << 30)
10 #define IORING_URING_CMD_POLLED		(1U << 31)
11 
12 struct io_uring_cmd {
13 	struct file	*file;
14 	const struct io_uring_sqe *sqe;
15 	union {
16 		/* callback to defer completions to task context */
17 		void (*task_work_cb)(struct io_uring_cmd *cmd, unsigned);
18 		/* used for polled completion */
19 		void *cookie;
20 	};
21 	u32		cmd_op;
22 	u32		flags;
23 	u8		pdu[32]; /* available inline for free use */
24 };
25 
26 static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe)
27 {
28 	return sqe->cmd;
29 }
30 
31 #if defined(CONFIG_IO_URING)
32 int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
33 			      struct iov_iter *iter, void *ioucmd);
34 void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret, ssize_t res2,
35 			unsigned issue_flags);
36 void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd,
37 			    void (*task_work_cb)(struct io_uring_cmd *, unsigned),
38 			    unsigned flags);
39 
40 void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd,
41 		unsigned int issue_flags);
42 struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd);
43 
44 #else
45 static inline int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
46 			      struct iov_iter *iter, void *ioucmd)
47 {
48 	return -EOPNOTSUPP;
49 }
50 static inline void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret,
51 		ssize_t ret2, unsigned issue_flags)
52 {
53 }
54 static inline void __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 {
58 }
59 static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd,
60 		unsigned int issue_flags)
61 {
62 }
63 static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd)
64 {
65 	return NULL;
66 }
67 #endif
68 
69 /* users must follow the IOU_F_TWQ_LAZY_WAKE semantics */
70 static inline void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd,
71 			void (*task_work_cb)(struct io_uring_cmd *, unsigned))
72 {
73 	__io_uring_cmd_do_in_task(ioucmd, task_work_cb, IOU_F_TWQ_LAZY_WAKE);
74 }
75 
76 static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
77 			void (*task_work_cb)(struct io_uring_cmd *, unsigned))
78 {
79 	__io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0);
80 }
81 
82 #endif /* _LINUX_IO_URING_CMD_H */
83