io_uring: introduce io_uring querying

There are many parameters users might want to query about io_uring like
available request types or the ring sizes. This patch introduces an
interface for such slow path queries.

It was written with several requirements in mind:
- Can be used with or without an io_uring instance. Asking for supported
  setup flags before creating an instance as well as qeurying info about
  an already created ring are valid use cases.
- Should be moderately fast. For example, users might use it to
  periodically retrieve ring attributes at runtime. As a consequence,
  it should be able to query multiple attributes in a single syscall.
- Backward and forward compatible.
- Should be reasobably easy to use.
- Reduce the kernel code size for introducing new query types.

It's implemented as a new registration opcode IORING_REGISTER_QUERY.
The user passes one or more query strutctures linked together, each
represented by struct io_uring_query_hdr. The header stores common
control fields needed for processing and points to query type specific
information.

The header contains
- The query type
- The result field, which on return contains the error code for the query
- Pointer to the query type specific information
- The size of the query structure. The kernel will only populate up to
  the size, which helps with backward compatibility. The kernel can also
  reduce the size, so if the current kernel is older than the inteface
  the user tries to use, it'll get only the supported bits.
- next_entry field is used to chain multiple queries.

Apart from common registeration syscall failures, it can only immediately
return an error code in case when the headers are incorrect or any
other addresses and invalid. That usually mean that the userspace
doesn't use the API right and should be corrected. All query type
specific errors are returned in the header's result field.

As an example, the patch adds a single query type for now, i.e.
IO_URING_QUERY_OPCODES, which tells what register / request / etc.
opcodes are supported, but there are particular plans to extend it.

Note: there is a request probing interface via IORING_REGISTER_PROBE,
but it's a mess. It requires the user to create a ring first, it only
works for requests, and requires dynamic allocations.

Reviewed-by: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: Pavel Begunkov <asml.silence@gmail.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>

diff --git a/include/uapi/linux/io_uring.h b/include/uapi/linux/io_uring.h
index 04ebff33d0e626ab7f7abe3f85ded222242c1b64..1ce17c535944c500208b8294400fc3cf37a910d7 100644 (file)
--- a/include/uapi/linux/io_uring.h
+++ b/include/uapi/linux/io_uring.h
@@ -686,6 +686,9 @@ enum io_uring_register_op {
 
        IORING_REGISTER_MEM_REGION              = 34,
 
+       /* query various aspects of io_uring, see linux/io_uring/query.h */
+       IORING_REGISTER_QUERY                   = 35,
+
        /* this goes last */
        IORING_REGISTER_LAST,
 

diff --git a/include/uapi/linux/io_uring/query.h b/include/uapi/linux/io_uring/query.h
new file mode 100644 (file)
index 0000000..5d75432
--- /dev/null
+++ b/include/uapi/linux/io_uring/query.h
@@ -0,0 +1,41 @@
+/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR MIT */
+/*
+ * Header file for the io_uring query interface.
+ */
+#ifndef LINUX_IO_URING_QUERY_H
+#define LINUX_IO_URING_QUERY_H
+
+#include <linux/types.h>
+
+struct io_uring_query_hdr {
+       __u64 next_entry;
+       __u64 query_data;
+       __u32 query_op;
+       __u32 size;
+       __s32 result;
+       __u32 __resv[3];
+};
+
+enum {
+       IO_URING_QUERY_OPCODES                  = 0,
+
+       __IO_URING_QUERY_MAX,
+};
+
+/* Doesn't require a ring */
+struct io_uring_query_opcode {
+       /* The number of supported IORING_OP_* opcodes */
+       __u32   nr_request_opcodes;
+       /* The number of supported IORING_[UN]REGISTER_* opcodes */
+       __u32   nr_register_opcodes;
+       /* Bitmask of all supported IORING_FEAT_* flags */
+       __u64   feature_flags;
+       /* Bitmask of all supported IORING_SETUP_* flags */
+       __u64   ring_setup_flags;
+       /* Bitmask of all supported IORING_ENTER_** flags */
+       __u64   enter_flags;
+       /* Bitmask of all supported IOSQE_* flags */
+       __u64   sqe_flags;
+};
+
+#endif

diff --git a/io_uring/Makefile b/io_uring/Makefile
index b3f1bd492804b01dee2b1b075a5f9a4653e2d595..bc4e4a3fa0a50a322023de2613c0a3f2253a5fb7 100644 (file)
--- a/io_uring/Makefile
+++ b/io_uring/Makefile
@@ -13,7 +13,7 @@ obj-$(CONFIG_IO_URING)                += io_uring.o opdef.o kbuf.o rsrc.o notif.o \
                                        sync.o msg_ring.o advise.o openclose.o \
                                        statx.o timeout.o cancel.o \
                                        waitid.o register.o truncate.o \
-                                       memmap.o alloc_cache.o
+                                       memmap.o alloc_cache.o query.o
 obj-$(CONFIG_IO_URING_ZCRX)    += zcrx.o
 obj-$(CONFIG_IO_WQ)            += io-wq.o
 obj-$(CONFIG_FUTEX)            += futex.o

diff --git a/io_uring/query.c b/io_uring/query.c
new file mode 100644 (file)
index 0000000..9eed0f3
--- /dev/null
+++ b/io_uring/query.c
@@ -0,0 +1,93 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#include "linux/io_uring/query.h"
+
+#include "query.h"
+#include "io_uring.h"
+
+#define IO_MAX_QUERY_SIZE              (sizeof(struct io_uring_query_opcode))
+
+static ssize_t io_query_ops(void *data)
+{
+       struct io_uring_query_opcode *e = data;
+
+       BUILD_BUG_ON(sizeof(*e) > IO_MAX_QUERY_SIZE);
+
+       e->nr_request_opcodes = IORING_OP_LAST;
+       e->nr_register_opcodes = IORING_REGISTER_LAST;
+       e->feature_flags = IORING_FEAT_FLAGS;
+       e->ring_setup_flags = IORING_SETUP_FLAGS;
+       e->enter_flags = IORING_ENTER_FLAGS;
+       e->sqe_flags = SQE_VALID_FLAGS;
+       return sizeof(*e);
+}
+
+static int io_handle_query_entry(struct io_ring_ctx *ctx,
+                                void *data, void __user *uhdr,
+                                u64 *next_entry)
+{
+       struct io_uring_query_hdr hdr;
+       size_t usize, res_size = 0;
+       ssize_t ret = -EINVAL;
+       void __user *udata;
+
+       if (copy_from_user(&hdr, uhdr, sizeof(hdr)))
+               return -EFAULT;
+       usize = hdr.size;
+       hdr.size = min(hdr.size, IO_MAX_QUERY_SIZE);
+       udata = u64_to_user_ptr(hdr.query_data);
+
+       if (hdr.query_op >= __IO_URING_QUERY_MAX) {
+               ret = -EOPNOTSUPP;
+               goto out;
+       }
+       if (!mem_is_zero(hdr.__resv, sizeof(hdr.__resv)) || hdr.result || !hdr.size)
+               goto out;
+       if (copy_from_user(data, udata, hdr.size))
+               return -EFAULT;
+
+       switch (hdr.query_op) {
+       case IO_URING_QUERY_OPCODES:
+               ret = io_query_ops(data);
+               break;
+       }
+
+       if (ret >= 0) {
+               if (WARN_ON_ONCE(ret > IO_MAX_QUERY_SIZE))
+                       return -EFAULT;
+               res_size = ret;
+               ret = 0;
+       }
+out:
+       hdr.result = ret;
+       hdr.size = min_t(size_t, usize, res_size);
+
+       if (copy_struct_to_user(udata, usize, data, hdr.size, NULL))
+               return -EFAULT;
+       if (copy_to_user(uhdr, &hdr, sizeof(hdr)))
+               return -EFAULT;
+       *next_entry = hdr.next_entry;
+       return 0;
+}
+
+int io_query(struct io_ring_ctx *ctx, void __user *arg, unsigned nr_args)
+{
+       char entry_buffer[IO_MAX_QUERY_SIZE];
+       void __user *uhdr = arg;
+       int ret;
+
+       memset(entry_buffer, 0, sizeof(entry_buffer));
+
+       if (nr_args)
+               return -EINVAL;
+
+       while (uhdr) {
+               u64 next_hdr;
+
+               ret = io_handle_query_entry(ctx, entry_buffer, uhdr, &next_hdr);
+               if (ret)
+                       return ret;
+               uhdr = u64_to_user_ptr(next_hdr);
+       }
+       return 0;
+}

diff --git a/io_uring/query.h b/io_uring/query.h
new file mode 100644 (file)
index 0000000..171d47c
--- /dev/null
+++ b/io_uring/query.h
@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: GPL-2.0
+#ifndef IORING_QUERY_H
+#define IORING_QUERY_H
+
+#include <linux/io_uring_types.h>
+
+int io_query(struct io_ring_ctx *ctx, void __user *arg, unsigned nr_args);
+
+#endif

diff --git a/io_uring/register.c b/io_uring/register.c
index 50ce87928be03837880210dcd18dcceeabaa2d45..9c31a8afb83d2317ff525eadff60a0846c10709d 100644 (file)
--- a/io_uring/register.c
+++ b/io_uring/register.c
@@ -31,6 +31,7 @@
 #include "msg_ring.h"
 #include "memmap.h"
 #include "zcrx.h"
+#include "query.h"
 
 #define IORING_MAX_RESTRICTIONS        (IORING_RESTRICTION_LAST + \
                                 IORING_REGISTER_LAST + IORING_OP_LAST)
@@ -832,6 +833,9 @@ static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode,
                        break;
                ret = io_register_mem_region(ctx, arg);
                break;
+       case IORING_REGISTER_QUERY:
+               ret = io_query(ctx, arg, nr_args);
+               break;
        default:
                ret = -EINVAL;
                break;
@@ -901,6 +905,8 @@ static int io_uring_register_blind(unsigned int opcode, void __user *arg,
        switch (opcode) {
        case IORING_REGISTER_SEND_MSG_RING:
                return io_uring_register_send_msg_ring(arg, nr_args);
+       case IORING_REGISTER_QUERY:
+               return io_query(NULL, arg, nr_args);
        }
        return -EINVAL;
 }