From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Z7DcEKIZ" Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 65ABD191 for ; Wed, 22 Nov 2023 18:40:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1700707247; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=1Y8rmWHSI3TczOvAqk49LhQZmLf1+AuGXydbAakvgVI=; b=Z7DcEKIZrFuJtUZ9nK3h7RkuNSdC2y0F1L8N/Ocs0bwXWYWHZiNX1IcxDw/subap4KWD+i +7s2bZ9gm7AGHwyPJ8NMgSdvh7gZN+kobWDZgteOJoVw4hb+lM2gNImdyjqW8VnRZpYGP5 88NRo0YTe6+XE+ZH7HTSgQwYd1C7CSw= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-487-Vv7_0xPONU2Bd98dvAbNow-1; Wed, 22 Nov 2023 21:40:44 -0500 X-MC-Unique: Vv7_0xPONU2Bd98dvAbNow-1 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id DA0FF185A78A; Thu, 23 Nov 2023 02:40:43 +0000 (UTC) Received: from fedora (unknown [10.72.120.3]) by smtp.corp.redhat.com (Postfix) with ESMTPS id AD185492BFC; Thu, 23 Nov 2023 02:40:39 +0000 (UTC) Date: Thu, 23 Nov 2023 10:40:35 +0800 From: Ming Lei To: Pavel Begunkov Cc: io-uring@vger.kernel.org, Jens Axboe , linux-block@vger.kernel.org, joshi.k@samsung.com, ming.lei@redhat.com Subject: Re: [PATCH 1/3] io_uring: split out cmd api into a separate header Message-ID: References: <547e56560b97cd66f00bfc5b53db24f2fa1a8852.1700668641.git.asml.silence@gmail.com> Precedence: bulk X-Mailing-List: io-uring@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <547e56560b97cd66f00bfc5b53db24f2fa1a8852.1700668641.git.asml.silence@gmail.com> X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.10 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 > --- > 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 > #include > #include > -#include > +#include > #include > #include > #include > 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 /* for force_successful_syscall_return */ > #include > -#include > +#include > #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 > #include > > -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 > +#include > + > +/* 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 > #include > > +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