Add support for kernel-managed buffer rings, which allow the kernel to allocate and manage the backing buffers for a buffer ring, rather than requiring the application to provide and manage them. Internally, the IOBL_KERNEL_MANAGED flag marks buffer lists as kernel-managed for appropriate handling in the I/O path. At the uapi level, kernel-managed buffer rings are created through the pbuf interface with the IOU_PBUF_RING_KERNEL_MANAGED flag set. The io_uring_buf_reg struct is modified to allow taking in a buf_size instead of a ring_addr. To create a kernel-managed buffer ring, the caller must set the IOU_PBUF_RING_MMAP flag as well to indicate that the kernel will allocate the memory for the ring. When the caller mmaps the ring, they will get back a virtual mapping to the buffer memory. Signed-off-by: Joanne Koong --- include/uapi/linux/io_uring.h | 14 +++++- io_uring/kbuf.c | 95 +++++++++++++++++++++++++++++------ io_uring/kbuf.h | 6 ++- 3 files changed, 97 insertions(+), 18 deletions(-) diff --git a/include/uapi/linux/io_uring.h b/include/uapi/linux/io_uring.h index 6750c383a2ab..278b56a87745 100644 --- a/include/uapi/linux/io_uring.h +++ b/include/uapi/linux/io_uring.h @@ -885,15 +885,27 @@ struct io_uring_buf_ring { * use of it will consume only as much as it needs. This * requires that both the kernel and application keep * track of where the current read/recv index is at. + * IOU_PBUF_RING_KERNEL_MANAGED: If set, kernel allocates the memory for the + * ring and its buffers. The application must set the + * buffer size through reg->buf_size. The buffers are + * recycled by the kernel. IOU_PBUF_RING_MMAP must be set + * as well. When the caller makes a subsequent mmap call, + * the virtual mapping returned is a contiguous mapping of + * the buffers. IOU_PBUF_RING_INC is not yet supported. */ enum io_uring_register_pbuf_ring_flags { IOU_PBUF_RING_MMAP = 1, IOU_PBUF_RING_INC = 2, + IOU_PBUF_RING_KERNEL_MANAGED = 4, }; /* argument for IORING_(UN)REGISTER_PBUF_RING */ struct io_uring_buf_reg { - __u64 ring_addr; + union { + __u64 ring_addr; + /* used if reg->flags & IOU_PBUF_RING_KERNEL_MANAGED */ + __u32 buf_size; + }; __u32 ring_entries; __u16 bgid; __u16 flags; diff --git a/io_uring/kbuf.c b/io_uring/kbuf.c index 67d4fe576473..816200e91b1f 100644 --- a/io_uring/kbuf.c +++ b/io_uring/kbuf.c @@ -427,10 +427,13 @@ static int io_remove_buffers_legacy(struct io_ring_ctx *ctx, static void io_put_bl(struct io_ring_ctx *ctx, struct io_buffer_list *bl) { - if (bl->flags & IOBL_BUF_RING) + if (bl->flags & IOBL_BUF_RING) { io_free_region(ctx->user, &bl->region); - else + if (bl->flags & IOBL_KERNEL_MANAGED) + kfree(bl->buf_ring); + } else { io_remove_buffers_legacy(ctx, bl, -1U); + } kfree(bl); } @@ -596,6 +599,51 @@ int io_manage_buffers_legacy(struct io_kiocb *req, unsigned int issue_flags) return IOU_COMPLETE; } +static int io_setup_kmbuf_ring(struct io_ring_ctx *ctx, + struct io_buffer_list *bl, + const struct io_uring_buf_reg *reg) +{ + struct io_uring_region_desc rd; + struct io_uring_buf_ring *ring; + unsigned long ring_size; + void *buf_region; + unsigned int i; + int ret; + + /* allocate pages for the ring structure */ + ring_size = flex_array_size(ring, bufs, reg->ring_entries); + ring = kzalloc(ring_size, GFP_KERNEL_ACCOUNT); + if (!ring) + return -ENOMEM; + + memset(&rd, 0, sizeof(rd)); + rd.size = (u64)reg->buf_size * reg->ring_entries; + + ret = io_create_region(ctx, &bl->region, &rd, 0); + if (ret) { + kfree(ring); + return ret; + } + + /* initialize ring buf entries to point to the buffers */ + buf_region = io_region_get_ptr(&bl->region); + for (i = 0; i < reg->ring_entries; i++) { + struct io_uring_buf *buf = &ring->bufs[i]; + + buf->addr = (u64)(uintptr_t)buf_region; + buf->len = reg->buf_size; + buf->bid = i; + + buf_region += reg->buf_size; + } + ring->tail = reg->ring_entries; + + bl->buf_ring = ring; + bl->flags |= IOBL_KERNEL_MANAGED; + + return 0; +} + int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg) { struct io_uring_buf_reg reg; @@ -612,7 +660,8 @@ int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg) return -EFAULT; if (!mem_is_zero(reg.resv, sizeof(reg.resv))) return -EINVAL; - if (reg.flags & ~(IOU_PBUF_RING_MMAP | IOU_PBUF_RING_INC)) + if (reg.flags & ~(IOU_PBUF_RING_MMAP | IOU_PBUF_RING_INC | + IOU_PBUF_RING_KERNEL_MANAGED)) return -EINVAL; if (!is_power_of_2(reg.ring_entries)) return -EINVAL; @@ -620,6 +669,15 @@ int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg) if (reg.ring_entries >= 65536) return -EINVAL; + if (reg.flags & IOU_PBUF_RING_KERNEL_MANAGED) { + if (!(reg.flags & IOU_PBUF_RING_MMAP)) + return -EINVAL; + if (reg.flags & IOU_PBUF_RING_INC) + return -EINVAL; + if (!reg.buf_size || !PAGE_ALIGNED(reg.buf_size)) + return -EINVAL; + } + bl = io_buffer_get_list(ctx, reg.bgid); if (bl) { /* if mapped buffer ring OR classic exists, don't allow */ @@ -634,17 +692,26 @@ int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg) mmap_offset = (unsigned long)reg.bgid << IORING_OFF_PBUF_SHIFT; ring_size = flex_array_size(br, bufs, reg.ring_entries); - memset(&rd, 0, sizeof(rd)); - rd.size = PAGE_ALIGN(ring_size); - if (!(reg.flags & IOU_PBUF_RING_MMAP)) { - rd.user_addr = reg.ring_addr; - rd.flags |= IORING_MEM_REGION_TYPE_USER; + + if (reg.flags & IOU_PBUF_RING_KERNEL_MANAGED) { + ret = io_setup_kmbuf_ring(ctx, bl, ®); + if (ret) { + kfree(bl); + return ret; + } + } else { + rd.size = PAGE_ALIGN(ring_size); + if (!(reg.flags & IOU_PBUF_RING_MMAP)) { + rd.user_addr = reg.ring_addr; + rd.flags |= IORING_MEM_REGION_TYPE_USER; + } + ret = io_create_region(ctx, &bl->region, &rd, mmap_offset); + if (ret) + goto fail; + bl->buf_ring = io_region_get_ptr(&bl->region); } - ret = io_create_region(ctx, &bl->region, &rd, mmap_offset); - if (ret) - goto fail; - br = io_region_get_ptr(&bl->region); + br = bl->buf_ring; #ifdef SHM_COLOUR /* @@ -666,15 +733,13 @@ int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg) bl->nr_entries = reg.ring_entries; bl->mask = reg.ring_entries - 1; bl->flags |= IOBL_BUF_RING; - bl->buf_ring = br; if (reg.flags & IOU_PBUF_RING_INC) bl->flags |= IOBL_INC; ret = io_buffer_add_list(ctx, bl, reg.bgid); if (!ret) return 0; fail: - io_free_region(ctx->user, &bl->region); - kfree(bl); + io_put_bl(ctx, bl); return ret; } diff --git a/io_uring/kbuf.h b/io_uring/kbuf.h index bf15e26520d3..38dd5fe6716e 100644 --- a/io_uring/kbuf.h +++ b/io_uring/kbuf.h @@ -7,9 +7,11 @@ enum { /* ring mapped provided buffers */ - IOBL_BUF_RING = 1, + IOBL_BUF_RING = 1, /* buffers are consumed incrementally rather than always fully */ - IOBL_INC = 2, + IOBL_INC = 2, + /* buffers are kernel managed */ + IOBL_KERNEL_MANAGED = 4, }; struct io_buffer_list { -- 2.47.3