History

io_uring: add support for pre-mapped user IO buffers

If we have fixed user buffers, we can map them into the kernel when we setup the io_uring. That avoids the need to do get_user_pages() for each and every IO. To utilize this feature, the application must call io_uring_register() after having setup an io_uring instance, passing in IORING_REGISTER_BUFFERS as the opcode. The argument must be a pointer to an iovec array, and the nr_args should contain how many iovecs the application wishes to map. If successful, these buffers are now mapped into the kernel, eligible for IO. To use these fixed buffers, the application must use the IORING_OP_READ_FIXED and IORING_OP_WRITE_FIXED opcodes, and then set sqe->index to the desired buffer index. sqe->addr..sqe->addr+seq->len must point to somewhere inside the indexed buffer. The application may register buffers throughout the lifetime of the io_uring instance. It can call io_uring_register() with IORING_UNREGISTER_BUFFERS as the opcode to unregister the current set of buffers, and then register a new set. The application need not unregister buffers explicitly before shutting down the io_uring instance. It's perfectly valid to setup a larger buffer, and then sometimes only use parts of it for an IO. As long as the range is within the originally mapped region, it will work just fine. For now, buffers must not be file backed. If file backed buffers are passed in, the registration will fail with -1/EOPNOTSUPP. This restriction may be relaxed in the future. RLIMIT_MEMLOCK is used to check how much memory we can pin. A somewhat arbitrary 1G per buffer size is also imposed.

Jens Axboe committed 7 years ago

Commit edafcce1 parent 6d0c48a7 files · +381 −15Browse files

Showing the changes to include/uapi/linux (1 of 7 files). Show all

Unified · Split

include/uapi/linux/io_uring.h+12−1
@@ -27,7 +27,10 @@ struct io_uring_sqe { · 26 unmodified lines
2727 __u32 fsync_flags;
2828 };
2929 __u64 user_data; /* data to be passed back at completion time */
30− __u64 __pad2[3];
30+ union {
31+ __u16 buf_index; /* index into fixed buffers, if used */
32+ __u64 __pad2[3];
33+ };
3134 };
3235
3336 /*
@@ -39,6 +42,8 @@ struct io_uring_sqe { · 5 unmodified lines
3942 #define IORING_OP_READV 1
4043 #define IORING_OP_WRITEV 2
4144 #define IORING_OP_FSYNC 3
45+#define IORING_OP_READ_FIXED 4
46+#define IORING_OP_WRITE_FIXED 5
4247
4348 /*
4449 * sqe->fsync_flags
@@ -103,4 +108,10 @@ struct io_uring_params { · 58 unmodified lines
103108 struct io_cqring_offsets cq_off;
104109 };
105110
111+/*
112+ * io_uring_register(2) opcodes and arguments
113+ */
114+#define IORING_REGISTER_BUFFERS 0
115+#define IORING_UNREGISTER_BUFFERS 1
116+
106117 #endif