| Message ID | 547e56560b97cd66f00bfc5b53db24f2fa1a8852.1700668641.git.asml.silence@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | clean up io_uring cmd header structure | expand |
On Wed, Nov 22, 2023 at 04:01:09PM +0000, Pavel Begunkov wrote: > linux/io_uring.h is slowly becoming a rubbish bin where we put > anything exposed to other subsystems. For instance, the task exit > hooks and io_uring cmd infra are completely orthogonal and don't need > each other's definitions. Start cleaning it up by splitting out all > command bits into a new header file. > > Signed-off-by: Pavel Begunkov <asml.silence@gmail.com> > --- > drivers/block/ublk_drv.c | 2 +- > drivers/nvme/host/ioctl.c | 2 +- > include/linux/io_uring.h | 89 +--------------------------------- > include/linux/io_uring/cmd.h | 81 +++++++++++++++++++++++++++++++ > include/linux/io_uring_types.h | 20 ++++++++ > io_uring/io_uring.c | 1 + > io_uring/rw.c | 2 +- > io_uring/uring_cmd.c | 2 +- > 8 files changed, 107 insertions(+), 92 deletions(-) > create mode 100644 include/linux/io_uring/cmd.h > > diff --git a/drivers/block/ublk_drv.c b/drivers/block/ublk_drv.c > index 83600b45e12a..909377068a87 100644 > --- a/drivers/block/ublk_drv.c > +++ b/drivers/block/ublk_drv.c > @@ -36,7 +36,7 @@ > #include <linux/sched/mm.h> > #include <linux/uaccess.h> > #include <linux/cdev.h> > -#include <linux/io_uring.h> > +#include <linux/io_uring/cmd.h> > #include <linux/blk-mq.h> > #include <linux/delay.h> > #include <linux/mm.h> > diff --git a/drivers/nvme/host/ioctl.c b/drivers/nvme/host/ioctl.c > index 529b9954d2b8..6864a6eeee93 100644 > --- a/drivers/nvme/host/ioctl.c > +++ b/drivers/nvme/host/ioctl.c > @@ -5,7 +5,7 @@ > */ > #include <linux/ptrace.h> /* for force_successful_syscall_return */ > #include <linux/nvme_ioctl.h> > -#include <linux/io_uring.h> > +#include <linux/io_uring/cmd.h> > #include "nvme.h" > > enum { > diff --git a/include/linux/io_uring.h b/include/linux/io_uring.h > index aefb73eeeebf..d8fc93492dc5 100644 > --- a/include/linux/io_uring.h > +++ b/include/linux/io_uring.h > @@ -6,71 +6,13 @@ > #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), > - > - /* set when uring wants to cancel a previously issued command */ > - IO_URING_F_CANCEL = (1 << 11), > - IO_URING_F_COMPAT = (1 << 12), > -}; > - > -/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ > -#define IORING_URING_CMD_CANCELABLE (1U << 30) > -#define IORING_URING_CMD_POLLED (1U << 31) > - > -struct io_uring_cmd { > - struct file *file; > - const struct io_uring_sqe *sqe; > - 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 */ > -}; > - > -static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) > -{ > - return sqe->cmd; > -} > - > #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); > 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); > -void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd, > - void (*task_work_cb)(struct io_uring_cmd *, unsigned), > - unsigned flags); > -/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ > -void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, > - void (*task_work_cb)(struct io_uring_cmd *, unsigned)); > - > -static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, > - void (*task_work_cb)(struct io_uring_cmd *, unsigned)) > -{ > - __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); > -} > +int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); > > static inline void io_uring_files_cancel(void) > { > @@ -89,28 +31,7 @@ static inline void io_uring_free(struct task_struct *tsk) > if (tsk->io_uring) > __io_uring_free(tsk); > } > -int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); > -void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > - unsigned int issue_flags); > -struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); > #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 void io_uring_cmd_do_in_task_lazy(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; > @@ -133,14 +54,6 @@ static inline int io_uring_cmd_sock(struct io_uring_cmd *cmd, > { > return -EOPNOTSUPP; > } > -static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > - unsigned int issue_flags) > -{ > -} > -static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) > -{ > - return NULL; > -} > #endif > > #endif > diff --git a/include/linux/io_uring/cmd.h b/include/linux/io_uring/cmd.h > new file mode 100644 > index 000000000000..62fcfaf6fcc9 > --- /dev/null > +++ b/include/linux/io_uring/cmd.h > @@ -0,0 +1,81 @@ > +/* SPDX-License-Identifier: GPL-2.0-or-later */ > +#ifndef _LINUX_IO_URING_CMD_H > +#define _LINUX_IO_URING_CMD_H > + > +#include <uapi/linux/io_uring.h> > +#include <linux/io_uring_types.h> > + > +/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ > +#define IORING_URING_CMD_CANCELABLE (1U << 30) > +#define IORING_URING_CMD_POLLED (1U << 31) > + > +struct io_uring_cmd { > + struct file *file; > + const struct io_uring_sqe *sqe; > + 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 */ > +}; > + > +static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) > +{ > + return sqe->cmd; > +} > + > +#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_do_in_task(struct io_uring_cmd *ioucmd, > + void (*task_work_cb)(struct io_uring_cmd *, unsigned), > + unsigned flags); > +/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ > +void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, > + void (*task_work_cb)(struct io_uring_cmd *, unsigned)); > + > +static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, > + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) > +{ > + __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); > +} > + > +void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > + unsigned int issue_flags); > +struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); > + > +#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 void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, > + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) > +{ > +} > +static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > + unsigned int issue_flags) > +{ > +} > +static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) > +{ > + return NULL; > +} > +#endif > + > +#endif /* _LINUX_IO_URING_CMD_H */ > diff --git a/include/linux/io_uring_types.h b/include/linux/io_uring_types.h > index d3009d56af0b..0bcecb734af3 100644 > --- a/include/linux/io_uring_types.h > +++ b/include/linux/io_uring_types.h > @@ -7,6 +7,26 @@ > #include <linux/llist.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), > + > + /* set when uring wants to cancel a previously issued command */ > + IO_URING_F_CANCEL = (1 << 11), > + IO_URING_F_COMPAT = (1 << 12), > +}; I am wondering why you don't move io_uring_cmd_flags into io_uring/cmd.h? And many above flags are used by driver now. But most definitions in io_uring_types.h are actually io_uring internal stuff. Thanks, Ming
On 11/23/23 02:40, Ming Lei wrote: > On Wed, Nov 22, 2023 at 04:01:09PM +0000, Pavel Begunkov wrote: >> linux/io_uring.h is slowly becoming a rubbish bin where we put >> anything exposed to other subsystems. For instance, the task exit >> hooks and io_uring cmd infra are completely orthogonal and don't need >> each other's definitions. Start cleaning it up by splitting out all >> command bits into a new header file. >> >> Signed-off-by: Pavel Begunkov <asml.silence@gmail.com> >> --- >> drivers/block/ublk_drv.c | 2 +- >> drivers/nvme/host/ioctl.c | 2 +- >> include/linux/io_uring.h | 89 +--------------------------------- >> include/linux/io_uring/cmd.h | 81 +++++++++++++++++++++++++++++++ >> include/linux/io_uring_types.h | 20 ++++++++ >> io_uring/io_uring.c | 1 + >> io_uring/rw.c | 2 +- >> io_uring/uring_cmd.c | 2 +- >> 8 files changed, 107 insertions(+), 92 deletions(-) >> create mode 100644 include/linux/io_uring/cmd.h >> >> diff --git a/drivers/block/ublk_drv.c b/drivers/block/ublk_drv.c >> index 83600b45e12a..909377068a87 100644 >> --- a/drivers/block/ublk_drv.c >> +++ b/drivers/block/ublk_drv.c >> @@ -36,7 +36,7 @@ >> #include <linux/sched/mm.h> >> #include <linux/uaccess.h> >> #include <linux/cdev.h> >> -#include <linux/io_uring.h> >> +#include <linux/io_uring/cmd.h> >> #include <linux/blk-mq.h> >> #include <linux/delay.h> >> #include <linux/mm.h> >> diff --git a/drivers/nvme/host/ioctl.c b/drivers/nvme/host/ioctl.c >> index 529b9954d2b8..6864a6eeee93 100644 >> --- a/drivers/nvme/host/ioctl.c >> +++ b/drivers/nvme/host/ioctl.c >> @@ -5,7 +5,7 @@ >> */ >> #include <linux/ptrace.h> /* for force_successful_syscall_return */ >> #include <linux/nvme_ioctl.h> >> -#include <linux/io_uring.h> >> +#include <linux/io_uring/cmd.h> >> #include "nvme.h" >> >> enum { >> diff --git a/include/linux/io_uring.h b/include/linux/io_uring.h >> index aefb73eeeebf..d8fc93492dc5 100644 >> --- a/include/linux/io_uring.h >> +++ b/include/linux/io_uring.h >> @@ -6,71 +6,13 @@ >> #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), >> - >> - /* set when uring wants to cancel a previously issued command */ >> - IO_URING_F_CANCEL = (1 << 11), >> - IO_URING_F_COMPAT = (1 << 12), >> -}; >> - >> -/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ >> -#define IORING_URING_CMD_CANCELABLE (1U << 30) >> -#define IORING_URING_CMD_POLLED (1U << 31) >> - >> -struct io_uring_cmd { >> - struct file *file; >> - const struct io_uring_sqe *sqe; >> - 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 */ >> -}; >> - >> -static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) >> -{ >> - return sqe->cmd; >> -} >> - >> #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); >> 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); >> -void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd, >> - void (*task_work_cb)(struct io_uring_cmd *, unsigned), >> - unsigned flags); >> -/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ >> -void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, >> - void (*task_work_cb)(struct io_uring_cmd *, unsigned)); >> - >> -static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, >> - void (*task_work_cb)(struct io_uring_cmd *, unsigned)) >> -{ >> - __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); >> -} >> +int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); >> >> static inline void io_uring_files_cancel(void) >> { >> @@ -89,28 +31,7 @@ static inline void io_uring_free(struct task_struct *tsk) >> if (tsk->io_uring) >> __io_uring_free(tsk); >> } >> -int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); >> -void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, >> - unsigned int issue_flags); >> -struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); >> #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 void io_uring_cmd_do_in_task_lazy(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; >> @@ -133,14 +54,6 @@ static inline int io_uring_cmd_sock(struct io_uring_cmd *cmd, >> { >> return -EOPNOTSUPP; >> } >> -static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, >> - unsigned int issue_flags) >> -{ >> -} >> -static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) >> -{ >> - return NULL; >> -} >> #endif >> >> #endif >> diff --git a/include/linux/io_uring/cmd.h b/include/linux/io_uring/cmd.h >> new file mode 100644 >> index 000000000000..62fcfaf6fcc9 >> --- /dev/null >> +++ b/include/linux/io_uring/cmd.h >> @@ -0,0 +1,81 @@ >> +/* SPDX-License-Identifier: GPL-2.0-or-later */ >> +#ifndef _LINUX_IO_URING_CMD_H >> +#define _LINUX_IO_URING_CMD_H >> + >> +#include <uapi/linux/io_uring.h> >> +#include <linux/io_uring_types.h> >> + >> +/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ >> +#define IORING_URING_CMD_CANCELABLE (1U << 30) >> +#define IORING_URING_CMD_POLLED (1U << 31) >> + >> +struct io_uring_cmd { >> + struct file *file; >> + const struct io_uring_sqe *sqe; >> + 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 */ >> +}; >> + >> +static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) >> +{ >> + return sqe->cmd; >> +} >> + >> +#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_do_in_task(struct io_uring_cmd *ioucmd, >> + void (*task_work_cb)(struct io_uring_cmd *, unsigned), >> + unsigned flags); >> +/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ >> +void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, >> + void (*task_work_cb)(struct io_uring_cmd *, unsigned)); >> + >> +static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, >> + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) >> +{ >> + __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); >> +} >> + >> +void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, >> + unsigned int issue_flags); >> +struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); >> + >> +#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 void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, >> + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) >> +{ >> +} >> +static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, >> + unsigned int issue_flags) >> +{ >> +} >> +static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) >> +{ >> + return NULL; >> +} >> +#endif >> + >> +#endif /* _LINUX_IO_URING_CMD_H */ >> diff --git a/include/linux/io_uring_types.h b/include/linux/io_uring_types.h >> index d3009d56af0b..0bcecb734af3 100644 >> --- a/include/linux/io_uring_types.h >> +++ b/include/linux/io_uring_types.h >> @@ -7,6 +7,26 @@ >> #include <linux/llist.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), >> + >> + /* set when uring wants to cancel a previously issued command */ >> + IO_URING_F_CANCEL = (1 << 11), >> + IO_URING_F_COMPAT = (1 << 12), >> +}; > > I am wondering why you don't move io_uring_cmd_flags into > io_uring/cmd.h? And many above flags are used by driver now. > > But most definitions in io_uring_types.h are actually io_uring > internal stuff. That's because these are io_uring internal execution state flags, on top of which someone started to pile up cmd flags, not the other way around. No clue why it was named io_uring_cmd_flags. iow, the first 5 flags are widely used internally, moving them would force us to add cmd.h includes into all io_uring internals. We could split the enum in half, but that would be more ugly as there are still packed into a single unsigned. And we can also get rid of IO_URING_F_SQE128 and others by checking ctx flags directly (with a helper), it'd be way better than having a cmd copy of specific flags.
On Thu, Nov 23, 2023 at 11:16:33AM +0000, Pavel Begunkov wrote: > On 11/23/23 02:40, Ming Lei wrote: > > On Wed, Nov 22, 2023 at 04:01:09PM +0000, Pavel Begunkov wrote: > > > linux/io_uring.h is slowly becoming a rubbish bin where we put > > > anything exposed to other subsystems. For instance, the task exit > > > hooks and io_uring cmd infra are completely orthogonal and don't need > > > each other's definitions. Start cleaning it up by splitting out all > > > command bits into a new header file. > > > > > > Signed-off-by: Pavel Begunkov <asml.silence@gmail.com> > > > --- > > > drivers/block/ublk_drv.c | 2 +- > > > drivers/nvme/host/ioctl.c | 2 +- > > > include/linux/io_uring.h | 89 +--------------------------------- > > > include/linux/io_uring/cmd.h | 81 +++++++++++++++++++++++++++++++ > > > include/linux/io_uring_types.h | 20 ++++++++ > > > io_uring/io_uring.c | 1 + > > > io_uring/rw.c | 2 +- > > > io_uring/uring_cmd.c | 2 +- > > > 8 files changed, 107 insertions(+), 92 deletions(-) > > > create mode 100644 include/linux/io_uring/cmd.h > > > > > > diff --git a/drivers/block/ublk_drv.c b/drivers/block/ublk_drv.c > > > index 83600b45e12a..909377068a87 100644 > > > --- a/drivers/block/ublk_drv.c > > > +++ b/drivers/block/ublk_drv.c > > > @@ -36,7 +36,7 @@ > > > #include <linux/sched/mm.h> > > > #include <linux/uaccess.h> > > > #include <linux/cdev.h> > > > -#include <linux/io_uring.h> > > > +#include <linux/io_uring/cmd.h> > > > #include <linux/blk-mq.h> > > > #include <linux/delay.h> > > > #include <linux/mm.h> > > > diff --git a/drivers/nvme/host/ioctl.c b/drivers/nvme/host/ioctl.c > > > index 529b9954d2b8..6864a6eeee93 100644 > > > --- a/drivers/nvme/host/ioctl.c > > > +++ b/drivers/nvme/host/ioctl.c > > > @@ -5,7 +5,7 @@ > > > */ > > > #include <linux/ptrace.h> /* for force_successful_syscall_return */ > > > #include <linux/nvme_ioctl.h> > > > -#include <linux/io_uring.h> > > > +#include <linux/io_uring/cmd.h> > > > #include "nvme.h" > > > enum { > > > diff --git a/include/linux/io_uring.h b/include/linux/io_uring.h > > > index aefb73eeeebf..d8fc93492dc5 100644 > > > --- a/include/linux/io_uring.h > > > +++ b/include/linux/io_uring.h > > > @@ -6,71 +6,13 @@ > > > #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), > > > - > > > - /* set when uring wants to cancel a previously issued command */ > > > - IO_URING_F_CANCEL = (1 << 11), > > > - IO_URING_F_COMPAT = (1 << 12), > > > -}; > > > - > > > -/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ > > > -#define IORING_URING_CMD_CANCELABLE (1U << 30) > > > -#define IORING_URING_CMD_POLLED (1U << 31) > > > - > > > -struct io_uring_cmd { > > > - struct file *file; > > > - const struct io_uring_sqe *sqe; > > > - 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 */ > > > -}; > > > - > > > -static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) > > > -{ > > > - return sqe->cmd; > > > -} > > > - > > > #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); > > > 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); > > > -void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd, > > > - void (*task_work_cb)(struct io_uring_cmd *, unsigned), > > > - unsigned flags); > > > -/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ > > > -void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, > > > - void (*task_work_cb)(struct io_uring_cmd *, unsigned)); > > > - > > > -static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, > > > - void (*task_work_cb)(struct io_uring_cmd *, unsigned)) > > > -{ > > > - __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); > > > -} > > > +int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); > > > static inline void io_uring_files_cancel(void) > > > { > > > @@ -89,28 +31,7 @@ static inline void io_uring_free(struct task_struct *tsk) > > > if (tsk->io_uring) > > > __io_uring_free(tsk); > > > } > > > -int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); > > > -void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > > > - unsigned int issue_flags); > > > -struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); > > > #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 void io_uring_cmd_do_in_task_lazy(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; > > > @@ -133,14 +54,6 @@ static inline int io_uring_cmd_sock(struct io_uring_cmd *cmd, > > > { > > > return -EOPNOTSUPP; > > > } > > > -static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > > > - unsigned int issue_flags) > > > -{ > > > -} > > > -static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) > > > -{ > > > - return NULL; > > > -} > > > #endif > > > #endif > > > diff --git a/include/linux/io_uring/cmd.h b/include/linux/io_uring/cmd.h > > > new file mode 100644 > > > index 000000000000..62fcfaf6fcc9 > > > --- /dev/null > > > +++ b/include/linux/io_uring/cmd.h > > > @@ -0,0 +1,81 @@ > > > +/* SPDX-License-Identifier: GPL-2.0-or-later */ > > > +#ifndef _LINUX_IO_URING_CMD_H > > > +#define _LINUX_IO_URING_CMD_H > > > + > > > +#include <uapi/linux/io_uring.h> > > > +#include <linux/io_uring_types.h> > > > + > > > +/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ > > > +#define IORING_URING_CMD_CANCELABLE (1U << 30) > > > +#define IORING_URING_CMD_POLLED (1U << 31) > > > + > > > +struct io_uring_cmd { > > > + struct file *file; > > > + const struct io_uring_sqe *sqe; > > > + 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 */ > > > +}; > > > + > > > +static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) > > > +{ > > > + return sqe->cmd; > > > +} > > > + > > > +#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_do_in_task(struct io_uring_cmd *ioucmd, > > > + void (*task_work_cb)(struct io_uring_cmd *, unsigned), > > > + unsigned flags); > > > +/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ > > > +void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, > > > + void (*task_work_cb)(struct io_uring_cmd *, unsigned)); > > > + > > > +static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, > > > + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) > > > +{ > > > + __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); > > > +} > > > + > > > +void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > > > + unsigned int issue_flags); > > > +struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); > > > + > > > +#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 void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, > > > + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) > > > +{ > > > +} > > > +static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, > > > + unsigned int issue_flags) > > > +{ > > > +} > > > +static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) > > > +{ > > > + return NULL; > > > +} > > > +#endif > > > + > > > +#endif /* _LINUX_IO_URING_CMD_H */ > > > diff --git a/include/linux/io_uring_types.h b/include/linux/io_uring_types.h > > > index d3009d56af0b..0bcecb734af3 100644 > > > --- a/include/linux/io_uring_types.h > > > +++ b/include/linux/io_uring_types.h > > > @@ -7,6 +7,26 @@ > > > #include <linux/llist.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), > > > + > > > + /* set when uring wants to cancel a previously issued command */ > > > + IO_URING_F_CANCEL = (1 << 11), > > > + IO_URING_F_COMPAT = (1 << 12), > > > +}; > > > > I am wondering why you don't move io_uring_cmd_flags into > > io_uring/cmd.h? And many above flags are used by driver now. > > > > But most definitions in io_uring_types.h are actually io_uring > > internal stuff. > > That's because these are io_uring internal execution state flags, > on top of which someone started to pile up cmd flags, not the > other way around. No clue why it was named io_uring_cmd_flags. > iow, the first 5 flags are widely used internally, moving them > would force us to add cmd.h includes into all io_uring internals. > > We could split the enum in half, but that would be more ugly > as there are still packed into a single unsigned. And we can > also get rid of IO_URING_F_SQE128 and others by checking > ctx flags directly (with a helper), it'd be way better than > having a cmd copy of specific flags. OK, thanks for the explanation. My only concern is about io_uring_types.h, which is used by io_uring internal except for trace. If you think it is OK to expose it to driver via io_uring/cmd.h now, this patch looks fine for me. thanks, Ming
Hi Pavel,
kernel test robot noticed the following build errors:
[auto build test ERROR on axboe-block/for-next]
[also build test ERROR on linus/master v6.7-rc2 next-20231124]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Pavel-Begunkov/io_uring-split-out-cmd-api-into-a-separate-header/20231123-001742
base: https://git.kernel.org/pub/scm/linux/kernel/git/axboe/linux-block.git for-next
patch link: https://lore.kernel.org/r/547e56560b97cd66f00bfc5b53db24f2fa1a8852.1700668641.git.asml.silence%40gmail.com
patch subject: [PATCH 1/3] io_uring: split out cmd api into a separate header
config: i386-defconfig (https://download.01.org/0day-ci/archive/20231124/202311241554.6yqiHqSd-lkp@intel.com/config)
compiler: gcc-7 (Ubuntu 7.5.0-6ubuntu2) 7.5.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231124/202311241554.6yqiHqSd-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311241554.6yqiHqSd-lkp@intel.com/
All errors (new ones prefixed by >>):
security/selinux/hooks.c: In function 'selinux_uring_cmd':
>> security/selinux/hooks.c:6940:28: error: dereferencing pointer to incomplete type 'struct io_uring_cmd'
struct file *file = ioucmd->file;
^~
vim +6940 security/selinux/hooks.c
f4d653dcaa4e40 Paul Moore 2022-08-10 6929
f4d653dcaa4e40 Paul Moore 2022-08-10 6930 /**
f4d653dcaa4e40 Paul Moore 2022-08-10 6931 * selinux_uring_cmd - check if IORING_OP_URING_CMD is allowed
f4d653dcaa4e40 Paul Moore 2022-08-10 6932 * @ioucmd: the io_uring command structure
f4d653dcaa4e40 Paul Moore 2022-08-10 6933 *
f4d653dcaa4e40 Paul Moore 2022-08-10 6934 * Check to see if the current domain is allowed to execute an
f4d653dcaa4e40 Paul Moore 2022-08-10 6935 * IORING_OP_URING_CMD against the device/file specified in @ioucmd.
f4d653dcaa4e40 Paul Moore 2022-08-10 6936 *
f4d653dcaa4e40 Paul Moore 2022-08-10 6937 */
f4d653dcaa4e40 Paul Moore 2022-08-10 6938 static int selinux_uring_cmd(struct io_uring_cmd *ioucmd)
f4d653dcaa4e40 Paul Moore 2022-08-10 6939 {
f4d653dcaa4e40 Paul Moore 2022-08-10 @6940 struct file *file = ioucmd->file;
f4d653dcaa4e40 Paul Moore 2022-08-10 6941 struct inode *inode = file_inode(file);
f4d653dcaa4e40 Paul Moore 2022-08-10 6942 struct inode_security_struct *isec = selinux_inode(inode);
f4d653dcaa4e40 Paul Moore 2022-08-10 6943 struct common_audit_data ad;
f4d653dcaa4e40 Paul Moore 2022-08-10 6944
f4d653dcaa4e40 Paul Moore 2022-08-10 6945 ad.type = LSM_AUDIT_DATA_FILE;
f4d653dcaa4e40 Paul Moore 2022-08-10 6946 ad.u.file = file;
f4d653dcaa4e40 Paul Moore 2022-08-10 6947
e67b79850fcc4e Stephen Smalley 2023-03-09 6948 return avc_has_perm(current_sid(), isec->sid,
f4d653dcaa4e40 Paul Moore 2022-08-10 6949 SECCLASS_IO_URING, IO_URING__CMD, &ad);
f4d653dcaa4e40 Paul Moore 2022-08-10 6950 }
740b03414b20e7 Paul Moore 2021-02-23 6951 #endif /* CONFIG_IO_URING */
740b03414b20e7 Paul Moore 2021-02-23 6952
Hi Pavel,
kernel test robot noticed the following build errors:
[auto build test ERROR on axboe-block/for-next]
[also build test ERROR on linus/master v6.7-rc2 next-20231124]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Pavel-Begunkov/io_uring-split-out-cmd-api-into-a-separate-header/20231123-001742
base: https://git.kernel.org/pub/scm/linux/kernel/git/axboe/linux-block.git for-next
patch link: https://lore.kernel.org/r/547e56560b97cd66f00bfc5b53db24f2fa1a8852.1700668641.git.asml.silence%40gmail.com
patch subject: [PATCH 1/3] io_uring: split out cmd api into a separate header
config: x86_64-rhel-8.3-rust (https://download.01.org/0day-ci/archive/20231124/202311241614.Z6qymw0W-lkp@intel.com/config)
compiler: clang version 16.0.4 (https://github.com/llvm/llvm-project.git ae42196bc493ffe877a7e3dff8be32035dea4d07)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231124/202311241614.Z6qymw0W-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311241614.Z6qymw0W-lkp@intel.com/
All errors (new ones prefixed by >>):
>> security/selinux/hooks.c:6940:28: error: incomplete definition of type 'struct io_uring_cmd'
struct file *file = ioucmd->file;
~~~~~~^
include/linux/fs.h:1913:8: note: forward declaration of 'struct io_uring_cmd'
struct io_uring_cmd;
^
1 error generated.
vim +6940 security/selinux/hooks.c
f4d653dcaa4e40 Paul Moore 2022-08-10 6929
f4d653dcaa4e40 Paul Moore 2022-08-10 6930 /**
f4d653dcaa4e40 Paul Moore 2022-08-10 6931 * selinux_uring_cmd - check if IORING_OP_URING_CMD is allowed
f4d653dcaa4e40 Paul Moore 2022-08-10 6932 * @ioucmd: the io_uring command structure
f4d653dcaa4e40 Paul Moore 2022-08-10 6933 *
f4d653dcaa4e40 Paul Moore 2022-08-10 6934 * Check to see if the current domain is allowed to execute an
f4d653dcaa4e40 Paul Moore 2022-08-10 6935 * IORING_OP_URING_CMD against the device/file specified in @ioucmd.
f4d653dcaa4e40 Paul Moore 2022-08-10 6936 *
f4d653dcaa4e40 Paul Moore 2022-08-10 6937 */
f4d653dcaa4e40 Paul Moore 2022-08-10 6938 static int selinux_uring_cmd(struct io_uring_cmd *ioucmd)
f4d653dcaa4e40 Paul Moore 2022-08-10 6939 {
f4d653dcaa4e40 Paul Moore 2022-08-10 @6940 struct file *file = ioucmd->file;
f4d653dcaa4e40 Paul Moore 2022-08-10 6941 struct inode *inode = file_inode(file);
f4d653dcaa4e40 Paul Moore 2022-08-10 6942 struct inode_security_struct *isec = selinux_inode(inode);
f4d653dcaa4e40 Paul Moore 2022-08-10 6943 struct common_audit_data ad;
f4d653dcaa4e40 Paul Moore 2022-08-10 6944
f4d653dcaa4e40 Paul Moore 2022-08-10 6945 ad.type = LSM_AUDIT_DATA_FILE;
f4d653dcaa4e40 Paul Moore 2022-08-10 6946 ad.u.file = file;
f4d653dcaa4e40 Paul Moore 2022-08-10 6947
e67b79850fcc4e Stephen Smalley 2023-03-09 6948 return avc_has_perm(current_sid(), isec->sid,
f4d653dcaa4e40 Paul Moore 2022-08-10 6949 SECCLASS_IO_URING, IO_URING__CMD, &ad);
f4d653dcaa4e40 Paul Moore 2022-08-10 6950 }
740b03414b20e7 Paul Moore 2021-02-23 6951 #endif /* CONFIG_IO_URING */
740b03414b20e7 Paul Moore 2021-02-23 6952
diff --git a/drivers/block/ublk_drv.c b/drivers/block/ublk_drv.c index 83600b45e12a..909377068a87 100644 --- a/drivers/block/ublk_drv.c +++ b/drivers/block/ublk_drv.c @@ -36,7 +36,7 @@ #include <linux/sched/mm.h> #include <linux/uaccess.h> #include <linux/cdev.h> -#include <linux/io_uring.h> +#include <linux/io_uring/cmd.h> #include <linux/blk-mq.h> #include <linux/delay.h> #include <linux/mm.h> diff --git a/drivers/nvme/host/ioctl.c b/drivers/nvme/host/ioctl.c index 529b9954d2b8..6864a6eeee93 100644 --- a/drivers/nvme/host/ioctl.c +++ b/drivers/nvme/host/ioctl.c @@ -5,7 +5,7 @@ */ #include <linux/ptrace.h> /* for force_successful_syscall_return */ #include <linux/nvme_ioctl.h> -#include <linux/io_uring.h> +#include <linux/io_uring/cmd.h> #include "nvme.h" enum { diff --git a/include/linux/io_uring.h b/include/linux/io_uring.h index aefb73eeeebf..d8fc93492dc5 100644 --- a/include/linux/io_uring.h +++ b/include/linux/io_uring.h @@ -6,71 +6,13 @@ #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), - - /* set when uring wants to cancel a previously issued command */ - IO_URING_F_CANCEL = (1 << 11), - IO_URING_F_COMPAT = (1 << 12), -}; - -/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ -#define IORING_URING_CMD_CANCELABLE (1U << 30) -#define IORING_URING_CMD_POLLED (1U << 31) - -struct io_uring_cmd { - struct file *file; - const struct io_uring_sqe *sqe; - 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 */ -}; - -static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) -{ - return sqe->cmd; -} - #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); 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); -void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd, - void (*task_work_cb)(struct io_uring_cmd *, unsigned), - unsigned flags); -/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ -void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, - void (*task_work_cb)(struct io_uring_cmd *, unsigned)); - -static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, - void (*task_work_cb)(struct io_uring_cmd *, unsigned)) -{ - __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); -} +int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); static inline void io_uring_files_cancel(void) { @@ -89,28 +31,7 @@ static inline void io_uring_free(struct task_struct *tsk) if (tsk->io_uring) __io_uring_free(tsk); } -int io_uring_cmd_sock(struct io_uring_cmd *cmd, unsigned int issue_flags); -void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, - unsigned int issue_flags); -struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); #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 void io_uring_cmd_do_in_task_lazy(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; @@ -133,14 +54,6 @@ static inline int io_uring_cmd_sock(struct io_uring_cmd *cmd, { return -EOPNOTSUPP; } -static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, - unsigned int issue_flags) -{ -} -static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) -{ - return NULL; -} #endif #endif diff --git a/include/linux/io_uring/cmd.h b/include/linux/io_uring/cmd.h new file mode 100644 index 000000000000..62fcfaf6fcc9 --- /dev/null +++ b/include/linux/io_uring/cmd.h @@ -0,0 +1,81 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +#ifndef _LINUX_IO_URING_CMD_H +#define _LINUX_IO_URING_CMD_H + +#include <uapi/linux/io_uring.h> +#include <linux/io_uring_types.h> + +/* only top 8 bits of sqe->uring_cmd_flags for kernel internal use */ +#define IORING_URING_CMD_CANCELABLE (1U << 30) +#define IORING_URING_CMD_POLLED (1U << 31) + +struct io_uring_cmd { + struct file *file; + const struct io_uring_sqe *sqe; + 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 */ +}; + +static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) +{ + return sqe->cmd; +} + +#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_do_in_task(struct io_uring_cmd *ioucmd, + void (*task_work_cb)(struct io_uring_cmd *, unsigned), + unsigned flags); +/* users should follow semantics of IOU_F_TWQ_LAZY_WAKE */ +void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, + void (*task_work_cb)(struct io_uring_cmd *, unsigned)); + +static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd, + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) +{ + __io_uring_cmd_do_in_task(ioucmd, task_work_cb, 0); +} + +void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, + unsigned int issue_flags); +struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd); + +#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 void io_uring_cmd_do_in_task_lazy(struct io_uring_cmd *ioucmd, + void (*task_work_cb)(struct io_uring_cmd *, unsigned)) +{ +} +static inline void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd, + unsigned int issue_flags) +{ +} +static inline struct task_struct *io_uring_cmd_get_task(struct io_uring_cmd *cmd) +{ + return NULL; +} +#endif + +#endif /* _LINUX_IO_URING_CMD_H */ diff --git a/include/linux/io_uring_types.h b/include/linux/io_uring_types.h index d3009d56af0b..0bcecb734af3 100644 --- a/include/linux/io_uring_types.h +++ b/include/linux/io_uring_types.h @@ -7,6 +7,26 @@ #include <linux/llist.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), + + /* set when uring wants to cancel a previously issued command */ + IO_URING_F_CANCEL = (1 << 11), + IO_URING_F_COMPAT = (1 << 12), +}; + struct io_wq_work_node { struct io_wq_work_node *next; }; diff --git a/io_uring/io_uring.c b/io_uring/io_uring.c index ed254076c723..6ffd7216393b 100644 --- a/io_uring/io_uring.c +++ b/io_uring/io_uring.c @@ -70,6 +70,7 @@ #include <linux/fadvise.h> #include <linux/task_work.h> #include <linux/io_uring.h> +#include <linux/io_uring/cmd.h> #include <linux/audit.h> #include <linux/security.h> #include <asm/shmparam.h> diff --git a/io_uring/rw.c b/io_uring/rw.c index 64390d4e20c1..4943d683508b 100644 --- a/io_uring/rw.c +++ b/io_uring/rw.c @@ -10,7 +10,7 @@ #include <linux/poll.h> #include <linux/nospec.h> #include <linux/compat.h> -#include <linux/io_uring.h> +#include <linux/io_uring/cmd.h> #include <uapi/linux/io_uring.h> diff --git a/io_uring/uring_cmd.c b/io_uring/uring_cmd.c index acbc2924ecd2..4ed0c66e3aae 100644 --- a/io_uring/uring_cmd.c +++ b/io_uring/uring_cmd.c @@ -2,7 +2,7 @@ #include <linux/kernel.h> #include <linux/errno.h> #include <linux/file.h> -#include <linux/io_uring.h> +#include <linux/io_uring/cmd.h> #include <linux/security.h> #include <linux/nospec.h>
linux/io_uring.h is slowly becoming a rubbish bin where we put anything exposed to other subsystems. For instance, the task exit hooks and io_uring cmd infra are completely orthogonal and don't need each other's definitions. Start cleaning it up by splitting out all command bits into a new header file. Signed-off-by: Pavel Begunkov <asml.silence@gmail.com> --- drivers/block/ublk_drv.c | 2 +- drivers/nvme/host/ioctl.c | 2 +- include/linux/io_uring.h | 89 +--------------------------------- include/linux/io_uring/cmd.h | 81 +++++++++++++++++++++++++++++++ include/linux/io_uring_types.h | 20 ++++++++ io_uring/io_uring.c | 1 + io_uring/rw.c | 2 +- io_uring/uring_cmd.c | 2 +- 8 files changed, 107 insertions(+), 92 deletions(-) create mode 100644 include/linux/io_uring/cmd.h