| Message ID | 20241007221603.1703699-10-dw@davidwei.uk (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | io_uring zero copy rx | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Guessing tree name failed - patch did not apply, async |
On 10/7/24 4:15 PM, David Wei wrote: > From: David Wei <davidhwei@meta.com> > > Add a new object called an interface queue (ifq) that represents a net rx queue > that has been configured for zero copy. Each ifq is registered using a new > registration opcode IORING_REGISTER_ZCRX_IFQ. > > The refill queue is allocated by the kernel and mapped by userspace using a new > offset IORING_OFF_RQ_RING, in a similar fashion to the main SQ/CQ. It is used > by userspace to return buffers that it is done with, which will then be re-used > by the netdev again. > > The main CQ ring is used to notify userspace of received data by using the > upper 16 bytes of a big CQE as a new struct io_uring_zcrx_cqe. Each entry > contains the offset + len to the data. > > For now, each io_uring instance only has a single ifq. Looks pretty straight forward to me, but please wrap your commit messages at ~72 chars or it doesn't read so well in the git log. A few minor comments... > diff --git a/include/uapi/linux/io_uring.h b/include/uapi/linux/io_uring.h > index adc2524fd8e3..567cdb89711e 100644 > --- a/include/uapi/linux/io_uring.h > +++ b/include/uapi/linux/io_uring.h > @@ -595,6 +597,9 @@ enum io_uring_register_op { > IORING_REGISTER_NAPI = 27, > IORING_UNREGISTER_NAPI = 28, > > + /* register a netdev hw rx queue for zerocopy */ > + IORING_REGISTER_ZCRX_IFQ = 29, > + Will need to change as the current tree has moved a bit beyond this. Not a huge deal, just an FYI as it obviously impacts userspace too. > +struct io_uring_zcrx_rqe { > + __u64 off; > + __u32 len; > + __u32 __pad; > +}; > + > +struct io_uring_zcrx_cqe { > + __u64 off; > + __u64 __pad; > +}; Would be nice to avoid padding for this one as it doubles its size. But at the same time, always nice to have padding for future proofing... Always a good idea to add padding, but > diff --git a/io_uring/Makefile b/io_uring/Makefile > index 61923e11c767..1a1184f3946a 100644 > --- a/io_uring/Makefile > +++ b/io_uring/Makefile > @@ -10,6 +10,7 @@ obj-$(CONFIG_IO_URING) += io_uring.o opdef.o kbuf.o rsrc.o notif.o \ > epoll.o statx.o timeout.o fdinfo.o \ > cancel.o waitid.o register.o \ > truncate.o memmap.o > +obj-$(CONFIG_PAGE_POOL) += zcrx.o > obj-$(CONFIG_IO_WQ) += io-wq.o > obj-$(CONFIG_FUTEX) += futex.o > obj-$(CONFIG_NET_RX_BUSY_POLL) += napi.o I wonder if this should be expressed a bit differently. Probably have a CONFIG_IO_URING_ZCRX which depends on CONFIG_INET and CONFIG_PAGE_POOL. And then you can also use that rather than doing: #if defined(CONFIG_PAGE_POOL) && defined(CONFIG_INET) in some spots. Not a big deal, it'll work as-is. And honestly should probably cleanup the existing IO_WQ symbol while at it, so perhaps better left for after the fact. > +static int io_allocate_rbuf_ring(struct io_zcrx_ifq *ifq, > + struct io_uring_zcrx_ifq_reg *reg) > +{ > + size_t off, size; > + void *ptr; > + > + off = sizeof(struct io_uring); > + size = off + sizeof(struct io_uring_zcrx_rqe) * reg->rq_entries; > + > + ptr = io_pages_map(&ifq->rqe_pages, &ifq->n_rqe_pages, size); > + if (IS_ERR(ptr)) > + return PTR_ERR(ptr); > + > + ifq->rq_ring = (struct io_uring *)ptr; > + ifq->rqes = (struct io_uring_zcrx_rqe *)((char *)ptr + off); > + return 0; > +} No need to cast that ptr to char *. Rest looks fine to me.
On 10/9/24 11:50 AM, Jens Axboe wrote: >> +struct io_uring_zcrx_rqe { >> + __u64 off; >> + __u32 len; >> + __u32 __pad; >> +}; >> + >> +struct io_uring_zcrx_cqe { >> + __u64 off; >> + __u64 __pad; >> +}; > > Would be nice to avoid padding for this one as it doubles its size. But > at the same time, always nice to have padding for future proofing... Ah nevermind, I see it mirrors the io_uring_cqe itself. Disregard.
On 10/9/24 18:50, Jens Axboe wrote: > On 10/7/24 4:15 PM, David Wei wrote: >> From: David Wei <davidhwei@meta.com> >> ... >> diff --git a/io_uring/Makefile b/io_uring/Makefile >> index 61923e11c767..1a1184f3946a 100644 >> --- a/io_uring/Makefile >> +++ b/io_uring/Makefile >> @@ -10,6 +10,7 @@ obj-$(CONFIG_IO_URING) += io_uring.o opdef.o kbuf.o rsrc.o notif.o \ >> epoll.o statx.o timeout.o fdinfo.o \ >> cancel.o waitid.o register.o \ >> truncate.o memmap.o >> +obj-$(CONFIG_PAGE_POOL) += zcrx.o >> obj-$(CONFIG_IO_WQ) += io-wq.o >> obj-$(CONFIG_FUTEX) += futex.o >> obj-$(CONFIG_NET_RX_BUSY_POLL) += napi.o > > I wonder if this should be expressed a bit differently. Probably have a > CONFIG_IO_URING_ZCRX which depends on CONFIG_INET and CONFIG_PAGE_POOL. > And then you can also use that rather than doing: > > #if defined(CONFIG_PAGE_POOL) && defined(CONFIG_INET) > > in some spots. Not a big deal, it'll work as-is. And honestly should > probably cleanup the existing IO_WQ symbol while at it, so perhaps > better left for after the fact. I should probably just add not selectable by user CONFIG_IO_URING_ZCRX and make it depend on INET/etc. >> +static int io_allocate_rbuf_ring(struct io_zcrx_ifq *ifq, >> + struct io_uring_zcrx_ifq_reg *reg) >> +{ >> + size_t off, size; >> + void *ptr; >> + >> + off = sizeof(struct io_uring); >> + size = off + sizeof(struct io_uring_zcrx_rqe) * reg->rq_entries; >> + >> + ptr = io_pages_map(&ifq->rqe_pages, &ifq->n_rqe_pages, size); >> + if (IS_ERR(ptr)) >> + return PTR_ERR(ptr); >> + >> + ifq->rq_ring = (struct io_uring *)ptr; >> + ifq->rqes = (struct io_uring_zcrx_rqe *)((char *)ptr + off); >> + return 0; >> +} > > No need to cast that ptr to char *. I'll apply it and other small nits, thanks for the review
On 10/9/24 18:50, Jens Axboe wrote: > On 10/7/24 4:15 PM, David Wei wrote: >> From: David Wei <davidhwei@meta.com> ... >> diff --git a/include/uapi/linux/io_uring.h b/include/uapi/linux/io_uring.h >> index adc2524fd8e3..567cdb89711e 100644 >> --- a/include/uapi/linux/io_uring.h >> +++ b/include/uapi/linux/io_uring.h >> @@ -595,6 +597,9 @@ enum io_uring_register_op { >> IORING_REGISTER_NAPI = 27, >> IORING_UNREGISTER_NAPI = 28, >> >> + /* register a netdev hw rx queue for zerocopy */ >> + IORING_REGISTER_ZCRX_IFQ = 29, >> + > > Will need to change as the current tree has moved a bit beyond this. Not > a huge deal, just an FYI as it obviously impacts userspace too. Forgot to mention, I'll rebase it for completness for next iteration, but I expect it'll need staging a branch with net/ changes shared b/w pulled in both trees and taking io_uring bits after on top or something similar. We can probably deal with all such io_uring conflicts at that time.
On 2024-10-09 10:50, Jens Axboe wrote: > On 10/7/24 4:15 PM, David Wei wrote: >> From: David Wei <davidhwei@meta.com> >> >> Add a new object called an interface queue (ifq) that represents a net rx queue >> that has been configured for zero copy. Each ifq is registered using a new >> registration opcode IORING_REGISTER_ZCRX_IFQ. >> >> The refill queue is allocated by the kernel and mapped by userspace using a new >> offset IORING_OFF_RQ_RING, in a similar fashion to the main SQ/CQ. It is used >> by userspace to return buffers that it is done with, which will then be re-used >> by the netdev again. >> >> The main CQ ring is used to notify userspace of received data by using the >> upper 16 bytes of a big CQE as a new struct io_uring_zcrx_cqe. Each entry >> contains the offset + len to the data. >> >> For now, each io_uring instance only has a single ifq. > > Looks pretty straight forward to me, but please wrap your commit > messages at ~72 chars or it doesn't read so well in the git log. Apologies, I rely on vim's text wrapping feature to format. I'll make sure git commit messages are <72 chars in the future.
diff --git a/include/linux/io_uring_types.h b/include/linux/io_uring_types.h index 3315005df117..ace7ac056d51 100644 --- a/include/linux/io_uring_types.h +++ b/include/linux/io_uring_types.h @@ -39,6 +39,8 @@ enum io_uring_cmd_flags { IO_URING_F_COMPAT = (1 << 12), }; +struct io_zcrx_ifq; + struct io_wq_work_node { struct io_wq_work_node *next; }; @@ -372,6 +374,7 @@ struct io_ring_ctx { struct io_alloc_cache rsrc_node_cache; struct wait_queue_head rsrc_quiesce_wq; unsigned rsrc_quiesce; + struct io_zcrx_ifq *ifq; u32 pers_next; struct xarray personalities; diff --git a/include/uapi/linux/io_uring.h b/include/uapi/linux/io_uring.h index adc2524fd8e3..567cdb89711e 100644 --- a/include/uapi/linux/io_uring.h +++ b/include/uapi/linux/io_uring.h @@ -457,6 +457,8 @@ struct io_uring_cqe { #define IORING_OFF_PBUF_RING 0x80000000ULL #define IORING_OFF_PBUF_SHIFT 16 #define IORING_OFF_MMAP_MASK 0xf8000000ULL +#define IORING_OFF_RQ_RING 0x20000000ULL +#define IORING_OFF_RQ_SHIFT 16 /* * Filled with the offset for mmap(2) @@ -595,6 +597,9 @@ enum io_uring_register_op { IORING_REGISTER_NAPI = 27, IORING_UNREGISTER_NAPI = 28, + /* register a netdev hw rx queue for zerocopy */ + IORING_REGISTER_ZCRX_IFQ = 29, + /* this goes last */ IORING_REGISTER_LAST, @@ -802,6 +807,44 @@ enum io_uring_socket_op { SOCKET_URING_OP_SETSOCKOPT, }; +/* Zero copy receive refill queue entry */ +struct io_uring_zcrx_rqe { + __u64 off; + __u32 len; + __u32 __pad; +}; + +struct io_uring_zcrx_cqe { + __u64 off; + __u64 __pad; +}; + +/* The bit from which area id is encoded into offsets */ +#define IORING_ZCRX_AREA_SHIFT 48 +#define IORING_ZCRX_AREA_MASK (~(((__u64)1 << IORING_ZCRX_AREA_SHIFT) - 1)) + +struct io_uring_zcrx_offsets { + __u32 head; + __u32 tail; + __u32 rqes; + __u32 mmap_sz; + __u64 __resv[2]; +}; + +/* + * Argument for IORING_REGISTER_ZCRX_IFQ + */ +struct io_uring_zcrx_ifq_reg { + __u32 if_idx; + __u32 if_rxq; + __u32 rq_entries; + __u32 flags; + + __u64 area_ptr; /* pointer to struct io_uring_zcrx_area_reg */ + struct io_uring_zcrx_offsets offsets; + __u64 __resv[3]; +}; + #ifdef __cplusplus } #endif diff --git a/io_uring/Makefile b/io_uring/Makefile index 61923e11c767..1a1184f3946a 100644 --- a/io_uring/Makefile +++ b/io_uring/Makefile @@ -10,6 +10,7 @@ obj-$(CONFIG_IO_URING) += io_uring.o opdef.o kbuf.o rsrc.o notif.o \ epoll.o statx.o timeout.o fdinfo.o \ cancel.o waitid.o register.o \ truncate.o memmap.o +obj-$(CONFIG_PAGE_POOL) += zcrx.o obj-$(CONFIG_IO_WQ) += io-wq.o obj-$(CONFIG_FUTEX) += futex.o obj-$(CONFIG_NET_RX_BUSY_POLL) += napi.o diff --git a/io_uring/io_uring.c b/io_uring/io_uring.c index 3942db160f18..02856245af3c 100644 --- a/io_uring/io_uring.c +++ b/io_uring/io_uring.c @@ -97,6 +97,7 @@ #include "uring_cmd.h" #include "msg_ring.h" #include "memmap.h" +#include "zcrx.h" #include "timeout.h" #include "poll.h" @@ -2600,6 +2601,7 @@ static __cold void io_ring_ctx_free(struct io_ring_ctx *ctx) return; mutex_lock(&ctx->uring_lock); + io_unregister_zcrx_ifqs(ctx); if (ctx->buf_data) __io_sqe_buffers_unregister(ctx); if (ctx->file_data) @@ -2772,6 +2774,11 @@ static __cold void io_ring_exit_work(struct work_struct *work) io_cqring_overflow_kill(ctx); mutex_unlock(&ctx->uring_lock); } + if (ctx->ifq) { + mutex_lock(&ctx->uring_lock); + io_shutdown_zcrx_ifqs(ctx); + mutex_unlock(&ctx->uring_lock); + } if (ctx->flags & IORING_SETUP_DEFER_TASKRUN) io_move_task_work_from_local(ctx); diff --git a/io_uring/memmap.c b/io_uring/memmap.c index a0f32a255fd1..4c384e8615f6 100644 --- a/io_uring/memmap.c +++ b/io_uring/memmap.c @@ -12,6 +12,7 @@ #include "memmap.h" #include "kbuf.h" +#include "zcrx.h" static void *io_mem_alloc_compound(struct page **pages, int nr_pages, size_t size, gfp_t gfp) @@ -223,6 +224,10 @@ static void *io_uring_validate_mmap_request(struct file *file, loff_t pgoff, io_put_bl(ctx, bl); return ptr; } + case IORING_OFF_RQ_RING: + if (!ctx->ifq) + return ERR_PTR(-EINVAL); + return ctx->ifq->rq_ring; } return ERR_PTR(-EINVAL); @@ -261,6 +266,9 @@ __cold int io_uring_mmap(struct file *file, struct vm_area_struct *vma) ctx->n_sqe_pages); case IORING_OFF_PBUF_RING: return io_pbuf_mmap(file, vma); + case IORING_OFF_RQ_RING: + return io_uring_mmap_pages(ctx, vma, ctx->ifq->rqe_pages, + ctx->ifq->n_rqe_pages); } return -EINVAL; diff --git a/io_uring/register.c b/io_uring/register.c index e3c20be5a198..3b221427e988 100644 --- a/io_uring/register.c +++ b/io_uring/register.c @@ -28,6 +28,7 @@ #include "kbuf.h" #include "napi.h" #include "eventfd.h" +#include "zcrx.h" #define IORING_MAX_RESTRICTIONS (IORING_RESTRICTION_LAST + \ IORING_REGISTER_LAST + IORING_OP_LAST) @@ -511,6 +512,12 @@ static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode, break; ret = io_unregister_napi(ctx, arg); break; + case IORING_REGISTER_ZCRX_IFQ: + ret = -EINVAL; + if (!arg || nr_args != 1) + break; + ret = io_register_zcrx_ifq(ctx, arg); + break; default: ret = -EINVAL; break; diff --git a/io_uring/zcrx.c b/io_uring/zcrx.c new file mode 100644 index 000000000000..79d79b9b8df8 --- /dev/null +++ b/io_uring/zcrx.c @@ -0,0 +1,147 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/errno.h> +#include <linux/mm.h> +#include <linux/io_uring.h> + +#include <uapi/linux/io_uring.h> + +#include "io_uring.h" +#include "kbuf.h" +#include "memmap.h" +#include "zcrx.h" + +#define IO_RQ_MAX_ENTRIES 32768 + +#if defined(CONFIG_PAGE_POOL) && defined(CONFIG_INET) + +static int io_allocate_rbuf_ring(struct io_zcrx_ifq *ifq, + struct io_uring_zcrx_ifq_reg *reg) +{ + size_t off, size; + void *ptr; + + off = sizeof(struct io_uring); + size = off + sizeof(struct io_uring_zcrx_rqe) * reg->rq_entries; + + ptr = io_pages_map(&ifq->rqe_pages, &ifq->n_rqe_pages, size); + if (IS_ERR(ptr)) + return PTR_ERR(ptr); + + ifq->rq_ring = (struct io_uring *)ptr; + ifq->rqes = (struct io_uring_zcrx_rqe *)((char *)ptr + off); + return 0; +} + +static void io_free_rbuf_ring(struct io_zcrx_ifq *ifq) +{ + io_pages_unmap(ifq->rq_ring, &ifq->rqe_pages, &ifq->n_rqe_pages, true); + ifq->rq_ring = NULL; + ifq->rqes = NULL; +} + +static struct io_zcrx_ifq *io_zcrx_ifq_alloc(struct io_ring_ctx *ctx) +{ + struct io_zcrx_ifq *ifq; + + ifq = kzalloc(sizeof(*ifq), GFP_KERNEL); + if (!ifq) + return NULL; + + ifq->if_rxq = -1; + ifq->ctx = ctx; + return ifq; +} + +static void io_zcrx_ifq_free(struct io_zcrx_ifq *ifq) +{ + io_free_rbuf_ring(ifq); + kfree(ifq); +} + +int io_register_zcrx_ifq(struct io_ring_ctx *ctx, + struct io_uring_zcrx_ifq_reg __user *arg) +{ + struct io_uring_zcrx_ifq_reg reg; + struct io_zcrx_ifq *ifq; + size_t ring_sz, rqes_sz; + int ret; + + /* + * 1. Interface queue allocation. + * 2. It can observe data destined for sockets of other tasks. + */ + if (!capable(CAP_NET_ADMIN)) + return -EPERM; + + /* mandatory io_uring features for zc rx */ + if (!(ctx->flags & IORING_SETUP_DEFER_TASKRUN && + ctx->flags & IORING_SETUP_CQE32)) + return -EINVAL; + if (ctx->ifq) + return -EBUSY; + if (copy_from_user(®, arg, sizeof(reg))) + return -EFAULT; + if (reg.__resv[0] || reg.__resv[1] || reg.__resv[2]) + return -EINVAL; + if (reg.if_rxq == -1 || !reg.rq_entries || reg.flags) + return -EINVAL; + if (reg.rq_entries > IO_RQ_MAX_ENTRIES) { + if (!(ctx->flags & IORING_SETUP_CLAMP)) + return -EINVAL; + reg.rq_entries = IO_RQ_MAX_ENTRIES; + } + reg.rq_entries = roundup_pow_of_two(reg.rq_entries); + + if (!reg.area_ptr) + return -EFAULT; + + ifq = io_zcrx_ifq_alloc(ctx); + if (!ifq) + return -ENOMEM; + + ret = io_allocate_rbuf_ring(ifq, ®); + if (ret) + goto err; + + ifq->rq_entries = reg.rq_entries; + ifq->if_rxq = reg.if_rxq; + + ring_sz = sizeof(struct io_uring); + rqes_sz = sizeof(struct io_uring_zcrx_rqe) * ifq->rq_entries; + reg.offsets.mmap_sz = ring_sz + rqes_sz; + reg.offsets.rqes = ring_sz; + reg.offsets.head = offsetof(struct io_uring, head); + reg.offsets.tail = offsetof(struct io_uring, tail); + + if (copy_to_user(arg, ®, sizeof(reg))) { + ret = -EFAULT; + goto err; + } + + ctx->ifq = ifq; + return 0; +err: + io_zcrx_ifq_free(ifq); + return ret; +} + +void io_unregister_zcrx_ifqs(struct io_ring_ctx *ctx) +{ + struct io_zcrx_ifq *ifq = ctx->ifq; + + lockdep_assert_held(&ctx->uring_lock); + + if (!ifq) + return; + + ctx->ifq = NULL; + io_zcrx_ifq_free(ifq); +} + +void io_shutdown_zcrx_ifqs(struct io_ring_ctx *ctx) +{ + lockdep_assert_held(&ctx->uring_lock); +} + +#endif diff --git a/io_uring/zcrx.h b/io_uring/zcrx.h new file mode 100644 index 000000000000..4ef94e19d36b --- /dev/null +++ b/io_uring/zcrx.h @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: GPL-2.0 +#ifndef IOU_ZC_RX_H +#define IOU_ZC_RX_H + +#include <linux/io_uring_types.h> + +struct io_zcrx_ifq { + struct io_ring_ctx *ctx; + struct net_device *dev; + struct io_uring *rq_ring; + struct io_uring_zcrx_rqe *rqes; + u32 rq_entries; + + unsigned short n_rqe_pages; + struct page **rqe_pages; + + u32 if_rxq; +}; + +#if defined(CONFIG_PAGE_POOL) && defined(CONFIG_INET) +int io_register_zcrx_ifq(struct io_ring_ctx *ctx, + struct io_uring_zcrx_ifq_reg __user *arg); +void io_unregister_zcrx_ifqs(struct io_ring_ctx *ctx); +void io_shutdown_zcrx_ifqs(struct io_ring_ctx *ctx); +#else +static inline int io_register_zcrx_ifq(struct io_ring_ctx *ctx, + struct io_uring_zcrx_ifq_reg __user *arg) +{ + return -EOPNOTSUPP; +} +static inline void io_unregister_zcrx_ifqs(struct io_ring_ctx *ctx) +{ +} +static inline void io_shutdown_zcrx_ifqs(struct io_ring_ctx *ctx) +{ +} +#endif + +#endif