Add io_uring futex/futexv support
Jens Axboe
maintainercover Add io_uring futex/futexv support
Hi,
This patchset adds support for first futex wake and wait, and then futexv. Patches 1..2 are just prep patches, patch 3 adds the wait and wake support for io_uring, and then patches 4..6 are again prep patches to end up with futexv support in patch 7.
For both wait/wake/waitv, we support the bitset variant, as the "normal" variants can be easily implemented on top of that.
PI and requeue are not supported through io_uring, just the above mentioned parts. This may change in the future, but in the spirit of keeping this small (and based on what people have been asking for), this is what we currently have.
When I did these patches, I forgot that Pavel had previously posted a futex variant for io_uring. The major thing that had been holding me back from people asking about futexes and io_uring, is that I wanted to do this what I consider the right way - no usage of io-wq or thread offload, an actually async implementation that is efficient to use and don't rely on a blocking thread for futex wait/waitv. This is what this patchset attempts to do, while being minimally invasive on the futex side. I believe the diffstat reflects that.
As far as I can recall, the first request for futex support with io_uring came from Andres Freund, working on postgres. His aio rework of postgres was one of the early adopters of io_uring, and futex support was a natural extension for that. This is relevant from both a usability point of view, as well as for effiency and performance. In Andres's words, for the former:
"Futex wait support in io_uring makes it a lot easier to avoid deadlocks in concurrent programs that have their own buffer pool: Obviously pages in the application buffer pool have to be locked during IO. If the initiator of IO A needs to wait for a held lock B, the holder of lock B might wait for the IO A to complete. The ability to wait for a lock and IO completions at the same time provides an efficient way to avoid such deadlocks."
and in terms of effiency, even without unlocking the full potential yet, Andres says:
"Futex wake support in io_uring is useful because it allows for more efficient directed wakeups. For some "locks" postgres has queues implemented in userspace, with wakeup logic that cannot easily be implemented with FUTEX_WAKE_BITSET on a single "futex word" (imagine waiting for journal flushes to have completed up to a certain point). Thus a "lock release" sometimes need to wake up many processes in a row. A quick-and-dirty conversion to doing these wakeups via io_uring lead to a 3% throughput increase, with 12% fewer context switches, albeit in a fairly extreme workload."
Some basic io_uring futex support and test cases are available in the liburing 'futex' branch:
https://git.kernel.dk/cgit/liburing/log/?h=futex
testing all of the variants. I originally wrote this code about a month ago and Andres has been using it with postgres, and I'm not aware of any bugs in it. That's not to say it's perfect, obviously, and I welcome some feedback so we can move this forward and hash out any potential issues.
include/linux/io_uring_types.h | 3 + include/uapi/linux/io_uring.h | 4 + io_uring/Makefile | 4 +- io_uring/cancel.c | 5 + io_uring/cancel.h | 4 + io_uring/futex.c | 377 +++++++++++++++++++++++++++++++++ io_uring/futex.h | 36 ++++ io_uring/io_uring.c | 5 + io_uring/opdef.c | 35 ++- kernel/futex/futex.h | 30 +++ kernel/futex/requeue.c | 3 +- kernel/futex/syscalls.c | 25 ++- kernel/futex/waitwake.c | 19 +- 13 files changed, 525 insertions(+), 25 deletions(-)
You can also find the code here:
https://git.kernel.dk/cgit/linux/log/?h=io_uring-futex
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerPATCH 1/7 futex: abstract out futex_op_to_flags() helper
Rather than needing to duplicate this for the io_uring hook of futexes, abstract out a helper.
No functional changes intended in this patch.
--- kernel/futex/futex.h | 15 +++++++++++++++ kernel/futex/syscalls.c | 11 ++--------- 2 files changed, 17 insertions(+), 9 deletions(-)
kernel/futex/futex.h +15 -0
@@ -291,4 +291,19 @@ extern int futex_unlock_pi(u32 __user *uaddr, unsigned int flags);extern int futex_lock_pi (u32 __user *uaddr,unsigned int flags,ktime_t *time,int trylock); +static inline bool futex_op_to_flags (int op,int cmd,unsigned int *flags) +{ +if (!(op &FUTEX_PRIVATE_FLAG )) + *flags |=FLAGS_SHARED ; + +if (op &FUTEX_CLOCK_REALTIME ) { + *flags |=FLAGS_CLOCKRT ; +if (cmd !=FUTEX_WAIT_BITSET && cmd !=FUTEX_WAIT_REQUEUE_PI && + cmd !=FUTEX_LOCK_PI2 ) +return false; + } + +return true; +} +#endif /* _FUTEX_H */
kernel/futex/syscalls.c +2 -9
@@ -88,15 +88,8 @@ long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout,int cmd = op &FUTEX_CMD_MASK ;unsigned int flags =0 ; -if (!(op &FUTEX_PRIVATE_FLAG )) - flags |=FLAGS_SHARED ; - -if (op &FUTEX_CLOCK_REALTIME ) { - flags |=FLAGS_CLOCKRT ; -if (cmd !=FUTEX_WAIT_BITSET && cmd !=FUTEX_WAIT_REQUEUE_PI && - cmd !=FUTEX_LOCK_PI2 ) -return -ENOSYS ; - } +if (!futex_op_to_flags (op, cmd, &flags)) +return -ENOSYS ;switch (cmd) {case FUTEX_WAIT :
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH 2/7 futex: factor out the futex wake handling
In reply to Jens AxboeIn preparation for having another waker that isn't futex_wake_mark(), add a wake handler in futex_q. No extra data is associated with the handler outside of struct futex_q itself. futex_wake_mark() is defined as the standard wakeup helper, now set through futex_q_init like other defaults.
--- kernel/futex/futex.h | 4 ++++ kernel/futex/requeue.c | 3 ++- kernel/futex/waitwake.c | 6 +++--- 3 files changed, 9 insertions(+), 4 deletions(-)
kernel/futex/futex.h +4 -0
@@ -69,6 +69,9 @@ struct futex_pi_state {union futex_key key; } __randomize_layout; +struct futex_q ; +typedef void (futex_wake_fn )(struct wake_q_head *wake_q,struct futex_q *q); +/** * struct futex_q - The hashed futex queue entry, one per waiting task * @list: priority-sorted list of tasks waiting on this futex
@@ -98,6 +101,7 @@ struct futex_q {struct task_struct *task;spinlock_t *lock_ptr; +futex_wake_fn *wake;union futex_key key;struct futex_pi_state *pi_state;struct rt_mutex_waiter *rt_waiter;
kernel/futex/requeue.c +2 -1
@@ -58,6 +58,7 @@ enum {const struct futex_q futex_q_init = {/* list gets initialized in futex_queue()*/ + .wake = futex_wake_mark, .key =FUTEX_KEY_INIT , .bitset =FUTEX_BITSET_MATCH_ANY , .requeue_state =ATOMIC_INIT (Q_REQUEUE_PI_NONE ),
@@ -591,7 +592,7 @@ int futex_requeue(u32 __user *uaddr1, unsigned int flags, u32 __user *uaddr2,/* Plain futexes just wake or requeue and are done */ if (!requeue_pi) {if (++task_count <= nr_wake) -futex_wake_mark (&wake_q, this); + this->wake (&wake_q, this);else requeue_futex (this, hb1, hb2, &key2);continue ;
kernel/futex/waitwake.c +3 -3
@@ -174,7 +174,7 @@ int futex_wake(u32 __user *uaddr, unsigned int flags, int nr_wake, u32 bitset)if (!(this->bitset & bitset))continue ; -futex_wake_mark (&wake_q, this); + this->wake (&wake_q, this);if (++ret >= nr_wake)break ; }
@@ -289,7 +289,7 @@ int futex_wake_op(u32 __user *uaddr1, unsigned int flags, u32 __user *uaddr2, ret = -EINVAL ; goto out_unlock; } -futex_wake_mark (&wake_q, this); + this->wake (&wake_q, this);if (++ret >= nr_wake)break ; }
@@ -303,7 +303,7 @@ int futex_wake_op(u32 __user *uaddr1, unsigned int flags, u32 __user *uaddr2, ret = -EINVAL ; goto out_unlock; } -futex_wake_mark (&wake_q, this); + this->wake (&wake_q, this);if (++op_ret >= nr_wake2)break ; }
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH 3/7 io_uring: add support for futex wake and wait
In reply to Jens AxboeAdd support for FUTEX_WAKE/WAIT primitives.
IORING_OP_FUTEX_WAKE is mix of FUTEX_WAKE and FUTEX_WAKE_BITSET, as it does support passing in a bitset.
Similary, IORING_OP_FUTEX_WAIT is a mix of FUTEX_WAIT and FUTEX_WAIT_BITSET.
FUTEX_WAKE is straight forward, as we can always just do those inline. FUTEX_WAIT will queue the futex with an appropriate callback, and that callback will in turn post a CQE when it has triggered.
Cancelations are supported, both from the application point-of-view, but also to be able to cancel pending waits if the ring exits before all events have occurred.
This is just the barebones wait/wake support. PI or REQUEUE support is not added at this point, unclear if we might look into that later.
Likewise, explicit timeouts are not supported either. It is expected that users that need timeouts would do so via the usual io_uring mechanism to do that using linked timeouts.
--- include/linux/io_uring_types.h | 3 + include/uapi/linux/io_uring.h | 3 + io_uring/Makefile | 4 +- io_uring/cancel.c | 5 + io_uring/cancel.h | 4 + io_uring/futex.c | 232 +++++++++++++++++++++++++++++++++ io_uring/futex.h | 34 +++++ io_uring/io_uring.c | 5 + io_uring/opdef.c | 24 +++- 9 files changed, 312 insertions(+), 2 deletions(-) create mode 100644 io_uring/futex.c create mode 100644 io_uring/futex.h
include/linux/io_uring_types.h +3 -0
@@ -273,6 +273,9 @@ struct io_ring_ctx {struct io_wq_work_list locked_free_list;unsigned int locked_free_nr; +struct hlist_head futex_list; +struct io_alloc_cache futex_cache; +const struct cred *sq_creds;/* cred used for __io_sq_thread() */ struct io_sq_data *sq_data;/* if using sq thread polling */
include/uapi/linux/io_uring.h +3 -0
@@ -65,6 +65,7 @@ struct io_uring_sqe {__u32 xattr_flags;__u32 msg_ring_flags;__u32 uring_cmd_flags; +__u32 futex_flags; };__u64 user_data;/* data to be passed back at completion time */ /* pack this to avoid bogus arm OABI complaints */
@@ -235,6 +236,8 @@ enum io_uring_op {IORING_OP_URING_CMD ,IORING_OP_SEND_ZC ,IORING_OP_SENDMSG_ZC , +IORING_OP_FUTEX_WAIT , +IORING_OP_FUTEX_WAKE ,/* this goes last, obviously */ IORING_OP_LAST,
io_uring/Makefile +3 -1
@@ -7,5 +7,7 @@ obj-$(CONFIG_IO_URING) += io_uring.o xattr.o nop.o fs.o splice.o \ openclose.o uring_cmd.o epoll.o \ statx.o net.o msg_ring.o timeout.o \ sqpoll.o fdinfo.o tctx.o poll.o \ - cancel.o kbuf.o rsrc.o rw.o opdef.o notif.o + cancel.o kbuf.o rsrc.o rw.o opdef.o \ + notif.o obj-$(CONFIG_IO_WQ) += io-wq.o +obj-$(CONFIG_FUTEX) += futex.o
io_uring/cancel.c +5 -0
@@ -15,6 +15,7 @@#include "tctx.h" #include "poll.h" #include "timeout.h" +#include "futex.h" #include "cancel.h" struct io_cancel {
@@ -119,6 +120,10 @@ int io_try_cancel(struct io_uring_task *tctx, struct io_cancel_data *cd,if (ret != -ENOENT )return ret; + ret =io_futex_cancel (ctx, cd, issue_flags); +if (ret != -ENOENT ) +return ret; +spin_lock (&ctx->completion_lock);if (!(cd->flags &IORING_ASYNC_CANCEL_FD )) ret =io_timeout_cancel (ctx, cd);
io_uring/cancel.h +4 -0
@@ -1,4 +1,6 @@// SPDX-License-Identifier: GPL-2.0 +#ifndef IORING_CANCEL_H +#define IORING_CANCEL_H #include <linux/io_uring_types.h>
@@ -22,3 +24,5 @@ void init_hash_table(struct io_hash_table *table, unsigned size);int io_sync_cancel (struct io_ring_ctx *ctx,void __user *arg);bool io_cancel_req_match (struct io_kiocb *req,struct io_cancel_data *cd); + +#endif
io_uring/futex.c new file +232 -0
232 lines not on this page · raw message
io_uring/futex.h new file +34 -0
@@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include "cancel.h" + +int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe); +int io_futex_wait (struct io_kiocb *req,unsigned int issue_flags); +int io_futex_wake (struct io_kiocb *req,unsigned int issue_flags); + +#if defined(CONFIG_FUTEX ) +int io_futex_cancel (struct io_ring_ctx *ctx,struct io_cancel_data *cd, +unsigned int issue_flags); +bool io_futex_remove_all (struct io_ring_ctx *ctx,struct task_struct *task, +bool cancel_all); +void io_futex_cache_init (struct io_ring_ctx *ctx); +void io_futex_cache_free (struct io_ring_ctx *ctx); +#else +static inline int io_futex_cancel (struct io_ring_ctx *ctx, +struct io_cancel_data *cd, +unsigned int issue_flags) +{ +return 0 ; +} +static inline bool io_futex_remove_all (struct io_ring_ctx *ctx, +struct task_struct *task,bool cancel_all) +{ +return false; +} +static inline void io_futex_cache_init (struct io_ring_ctx *ctx) +{ +} +static inline void io_futex_cache_free (struct io_ring_ctx *ctx) +{ +} +#endif
io_uring/io_uring.c +5 -0
@@ -92,6 +92,7 @@#include "cancel.h" #include "net.h" #include "notif.h" +#include "futex.h" #include "timeout.h" #include "poll.h"
@@ -314,6 +315,7 @@ static __cold struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p) sizeof(struct async_poll));io_alloc_cache_init (&ctx->netmsg_cache,IO_ALLOC_CACHE_MAX ,sizeof (struct io_async_msghdr )); +io_futex_cache_init (ctx);init_completion (&ctx->ref_comp);xa_init_flags (&ctx->personalities,XA_FLAGS_ALLOC1 );mutex_init (&ctx->uring_lock);
@@ -333,6 +335,7 @@ static __cold struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p)INIT_LIST_HEAD (&ctx->tctx_list); ctx->submit_state.free_list.next =NULL ;INIT_WQ_LIST (&ctx->locked_free_list); +INIT_HLIST_HEAD (&ctx->futex_list);INIT_DELAYED_WORK (&ctx->fallback_work, io_fallback_req_func);INIT_WQ_LIST (&ctx->submit_state.compl_reqs);return ctx;
@@ -2842,6 +2845,7 @@ static __cold void io_ring_ctx_free(struct io_ring_ctx *ctx)io_eventfd_unregister (ctx);io_alloc_cache_free (&ctx->apoll_cache, io_apoll_cache_free);io_alloc_cache_free (&ctx->netmsg_cache, io_netmsg_cache_free); +io_futex_cache_free (ctx);io_destroy_buffers (ctx);mutex_unlock (&ctx->uring_lock);if (ctx->sq_creds)
@@ -3254,6 +3258,7 @@ static __cold bool io_uring_try_cancel_requests(struct io_ring_ctx *ctx, ret |=io_cancel_defer_files (ctx, task, cancel_all);mutex_lock (&ctx->uring_lock); ret |=io_poll_remove_all (ctx, task, cancel_all); + ret |=io_futex_remove_all (ctx, task, cancel_all);mutex_unlock (&ctx->uring_lock); ret |=io_kill_timeouts (ctx, task, cancel_all);if (task)
io_uring/opdef.c +23 -1
@@ -33,6 +33,7 @@#include "poll.h" #include "cancel.h" #include "rw.h" +#include "futex.h" static int io_no_issue (struct io_kiocb *req,unsigned int issue_flags) {
@@ -426,11 +427,26 @@ const struct io_issue_def io_issue_defs[] = { .issue = io_sendmsg_zc, #else .prep = io_eopnotsupp_prep, +#endif + }, + [IORING_OP_FUTEX_WAIT ] = { +#if defined(CONFIG_FUTEX) + .prep = io_futex_prep, + .issue = io_futex_wait, +#else + .prep = io_eopnotsupp_prep, +#endif + }, + [IORING_OP_FUTEX_WAKE ] = { +#if defined(CONFIG_FUTEX) + .prep = io_futex_prep, + .issue = io_futex_wake, +#else + .prep = io_eopnotsupp_prep, #endif }, }; -const struct io_cold_def io_cold_defs[] = { [IORING_OP_NOP ] = { .name ="NOP" ,
@@ -648,6 +664,12 @@ const struct io_cold_def io_cold_defs[] = { .fail = io_sendrecv_fail, #endif }, + [IORING_OP_FUTEX_WAIT ] = { + .name ="FUTEX_WAIT" , + }, + [IORING_OP_FUTEX_WAKE ] = { + .name ="FUTEX_WAKE" , + }, };const char *io_uring_get_opcode (u8 opcode)
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH 4/7 futex: add wake_data to struct futex_q
In reply to Jens AxboeWith handling multiple futex_q for waitv, we cannot easily go from the futex_q to data related to that request or queue. Add a wake_data argument that belongs to the wake handler assigned.
--- kernel/futex/futex.h | 1 + 1 file changed, 1 insertion(+)
kernel/futex/futex.h +1 -0
@@ -102,6 +102,7 @@ struct futex_q {struct task_struct *task;spinlock_t *lock_ptr;futex_wake_fn *wake; +void *wake_data;union futex_key key;struct futex_pi_state *pi_state;struct rt_mutex_waiter *rt_waiter;
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH 5/7 futex: make futex_parse_waitv() available as a helper
In reply to Jens AxboeTo make it more generically useful, augment it with allowing the caller to pass in the wake handler and wake data. Convert the futex_waitv() syscall, passing in the default handlers.
Since we now provide a way to pass in a wake handler and data, ensure we use __futex_queue() to avoid having futex_queue() overwrite our wait data.
--- kernel/futex/futex.h | 5 +++++ kernel/futex/syscalls.c | 14 ++++++++++---- kernel/futex/waitwake.c | 3 ++- 3 files changed, 17 insertions(+), 5 deletions(-)
kernel/futex/futex.h +5 -0
@@ -284,6 +284,11 @@ struct futex_vector {struct futex_q q; }; +extern int futex_parse_waitv (struct futex_vector *futexv, +struct futex_waitv __user *uwaitv, +unsigned int nr_futexes,futex_wake_fn *wake, +void *wake_data); +extern int futex_wait_multiple (struct futex_vector *vs,unsigned int count,struct hrtimer_sleeper *to);
kernel/futex/syscalls.c +10 -4
@@ -184,12 +184,15 @@ SYSCALL_DEFINE6(futex, u32 __user *, uaddr, int, op, u32, val,* @futexv: Kernel side list of waiters to be filled * @uwaitv: Userspace list to be parsed * @nr_futexes: Length of futexv +* @wake: Wake to call when futex is woken +* @wake_data: Data for the wake handler * * Return: Error code on failure, 0 on success */ -static int futex_parse_waitv (struct futex_vector *futexv, -struct futex_waitv __user *uwaitv, -unsigned int nr_futexes) +int futex_parse_waitv (struct futex_vector *futexv, +struct futex_waitv __user *uwaitv, +unsigned int nr_futexes,futex_wake_fn *wake, +void *wake_data) {struct futex_waitv aux;unsigned int i;
@@ -208,6 +211,8 @@ static int futex_parse_waitv(struct futex_vector *futexv, futexv[i].w.val = aux.val; futexv[i].w.uaddr = aux.uaddr; futexv[i].q = futex_q_init; + futexv[i].q.wake = wake; + futexv[i].q.wake_data = wake_data; }return 0 ;
@@ -284,7 +289,8 @@ SYSCALL_DEFINE5(futex_waitv, struct futex_waitv __user *, waiters, goto destroy_timer; } - ret =futex_parse_waitv (futexv, waiters, nr_futexes); + ret =futex_parse_waitv (futexv, waiters, nr_futexes, futex_wake_mark, +NULL );if (!ret) ret =futex_wait_multiple (futexv, nr_futexes, timeout ? &to :NULL );
kernel/futex/waitwake.c +2 -1
@@ -446,7 +446,8 @@ static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo* next futex. Queue each futex at this moment so hb can * be unlocked. */ -futex_queue (q, hb); +__futex_queue (q, hb); +spin_unlock (&hb->lock);continue ; }
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH 6/7 futex: make the vectored futex operations available
In reply to Jens AxboeRename unqueue_multiple() as futex_unqueue_multiple(), and make both that and futex_wait_multiple_setup() available for external users. This is in preparation for wiring up vectored waits in io_uring.
--- kernel/futex/futex.h | 5 +++++ kernel/futex/waitwake.c | 10 +++++----- 2 files changed, 10 insertions(+), 5 deletions(-)
kernel/futex/futex.h +5 -0
@@ -289,6 +289,11 @@ extern int futex_parse_waitv(struct futex_vector *futexv, unsigned int nr_futexes, futex_wake_fn *wake, void *wake_data); +extern int futex_wait_multiple_setup (struct futex_vector *vs,int count, +int *woken); + +extern int futex_unqueue_multiple (struct futex_vector *v,int count); +extern int futex_wait_multiple (struct futex_vector *vs,unsigned int count,struct hrtimer_sleeper *to);
kernel/futex/waitwake.c +5 -5
@@ -358,7 +358,7 @@ void futex_wait_queue(struct futex_hash_bucket *hb, struct futex_q *q, }/** -* unqueue_multiple - Remove various futexes from their hash bucket +* futex_unqueue_multiple - Remove various futexes from their hash bucket * @v: The list of futexes to unqueue * @count: Number of futexes in the list *
@@ -368,7 +368,7 @@ void futex_wait_queue(struct futex_hash_bucket *hb, struct futex_q *q,* - >=0 - Index of the last futex that was awoken; * - -1 - No futex was awoken */ -static int unqueue_multiple (struct futex_vector *v,int count) +int futex_unqueue_multiple (struct futex_vector *v,int count) {int ret =-1 , i;
@@ -396,7 +396,7 @@ static int unqueue_multiple(struct futex_vector *v, int count)* - 0 - Success * - <0 - -EFAULT, -EWOULDBLOCK or -EINVAL */ -static int futex_wait_multiple_setup (struct futex_vector *vs,int count,int *woken) +int futex_wait_multiple_setup (struct futex_vector *vs,int count,int *woken) {struct futex_hash_bucket *hb;bool retry = false;
@@ -459,7 +459,7 @@ static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo* was woken, we don't return error and return this index to * userspace */ - *woken =unqueue_multiple (vs, i); + *woken =futex_unqueue_multiple (vs, i);if (*woken >=0 )return 1 ;
@@ -544,7 +544,7 @@ int futex_wait_multiple(struct futex_vector *vs, unsigned int count,__set_current_state (TASK_RUNNING ); - ret =unqueue_multiple (vs, count); + ret =futex_unqueue_multiple (vs, count);if (ret >=0 )return ret;
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH 7/7 io_uring: add futex waitv
In reply to Jens AxboeNeeds a bit of splitting and a few hunks should go further back (like the wake handler typedef).
WIP, adds IORING_OP_FUTEX_WAITV - pass in an array of futex addresses, and wait on all of them until one of them triggers.
--- include/uapi/linux/io_uring.h | 1 + io_uring/futex.c | 165 +++++++++++++++++++++++++++++++--- io_uring/futex.h | 2 + io_uring/opdef.c | 11 +++ 4 files changed, 169 insertions(+), 10 deletions(-)
include/uapi/linux/io_uring.h +1 -0
@@ -238,6 +238,7 @@ enum io_uring_op {IORING_OP_SENDMSG_ZC ,IORING_OP_FUTEX_WAIT ,IORING_OP_FUTEX_WAKE , +IORING_OP_FUTEX_WAITV ,/* this goes last, obviously */ IORING_OP_LAST,
io_uring/futex.c +155 -10
213 lines not on this page · raw message
io_uring/futex.h +2 -0
@@ -3,7 +3,9 @@#include "cancel.h" int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe); +int io_futexv_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe);int io_futex_wait (struct io_kiocb *req,unsigned int issue_flags); +int io_futex_waitv (struct io_kiocb *req,unsigned int issue_flags);int io_futex_wake (struct io_kiocb *req,unsigned int issue_flags);#if defined(CONFIG_FUTEX )
io_uring/opdef.c +11 -0
@@ -443,6 +443,14 @@ const struct io_issue_def io_issue_defs[] = { .issue = io_futex_wake, #else .prep = io_eopnotsupp_prep, +#endif + }, + [IORING_OP_FUTEX_WAITV] = { +#if defined(CONFIG_FUTEX ) + .prep = io_futexv_prep, + .issue = io_futex_waitv, +#else + .prep = io_eopnotsupp_prep,#endif }, };
@@ -670,6 +678,9 @@ const struct io_cold_def io_cold_defs[] = { [IORING_OP_FUTEX_WAKE ] = { .name ="FUTEX_WAKE" , }, + [IORING_OP_FUTEX_WAITV ] = { + .name ="FUTEX_WAITV" , + }, };const char *io_uring_get_opcode (u8 opcode)
Signature · 1 line
2.40.1
Peter Zijlstra
reviewerRe: [PATCH 1/7] futex: abstract out futex_op_to_flags() helper
In reply to Jens AxboeQuoted 16 lines · Jens Axboe
Rather than needing to duplicate this for the
io_uringhook of futexes, abstract out a helper.No functional changes intended in this patch.
Signed-off-by Jens Axboe <[email protected]>--- kernel/futex/futex.h | 15 +++++++++++++++ kernel/futex/syscalls.c | 11 ++--------- 2 files changed, 17 insertions(+), 9 deletions(-)kernel/futex/futex.h +0
-0
kernel/futex/futex.h extern int futex_unlock_pi(u32 __user *uaddr, unsigned int flags); · line 295
Quoted 5 lines
kernel/futex/futex.h +2
-0@@ -291,4 +291,19 @@ extern int futex_unlock_pi(u32 __user *uaddr, unsigned int flags);extern int futex_lock_pi (u32 __user *uaddr,unsigned int flags,ktime_t *time,int trylock); +static inline bool futex_op_to_flags (int op,int cmd,unsigned int *flags) +{
*flags = 0;
Quoted 19 lines
kernel/futex/futex.h +12
-0+if (!(op &FUTEX_PRIVATE_FLAG )) + *flags |=FLAGS_SHARED ; + +if (op &FUTEX_CLOCK_REALTIME ) { + *flags |=FLAGS_CLOCKRT ; +if (cmd !=FUTEX_WAIT_BITSET && cmd !=FUTEX_WAIT_REQUEUE_PI && + cmd !=FUTEX_LOCK_PI2 ) +return false; + } + +return true; +}kernel/futex/syscalls.c +0
-0
kernel/futex/syscalls.c long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout, · line 89
Quoted 2 lines
kernel/futex/syscalls.c +0
-0@@ -88,15 +88,8 @@ long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout,int cmd = op &FUTEX_CMD_MASK ;unsigned int flags =0 ;
and skip the initializer here.
kernel/futex/syscalls.c long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout, · line 93
Quoted 13 lines
kernel/futex/syscalls.c +2
-9-if (!(op &FUTEX_PRIVATE_FLAG )) - flags |=FLAGS_SHARED ; - -if (op &FUTEX_CLOCK_REALTIME ) { - flags |=FLAGS_CLOCKRT ; -if (cmd !=FUTEX_WAIT_BITSET && cmd !=FUTEX_WAIT_REQUEUE_PI && - cmd !=FUTEX_LOCK_PI2 ) -return -ENOSYS ; - } +if (!futex_op_to_flags (op, cmd, &flags)) +return -ENOSYS ;
then the helper is more self sufficient and doesn't rely on the caller to initialize the flags word.
Peter Zijlstra
reviewerRe: [PATCH 3/7] io_uring: add support for futex wake and wait
In reply to Jens AxboeQuoted 16 lines · Jens Axboe
Add support for FUTEX_WAKE/WAIT primitives.
IORING_OP_FUTEX_WAKEis mix ofFUTEX_WAKEandFUTEX_WAKE_BITSET, as it does support passing in a bitset.Similary,
IORING_OP_FUTEX_WAITis a mix ofFUTEX_WAITandFUTEX_WAIT_BITSET.
FUTEX_WAKEis straight forward, as we can always just do those inline.FUTEX_WAITwill queue the futex with an appropriate callback, and that callback will in turn post a CQE when it has triggered.Cancelations are supported, both from the application point-of-view, but also to be able to cancel pending waits if the ring exits before all events have occurred.
Quoted 8 lines
This is just the barebones wait/wake support. PI or REQUEUE support is not added at this point, unclear if we might look into that later.
Likewise, explicit timeouts are not supported either. It is expected that users that need timeouts would do so via the usual
io_uringmechanism to do that using linked timeouts.Signed-off-by Jens Axboe <[email protected]>
I'm not sure I'm qualified to review this :/ I really don't know anything about how io-uring works. And the above doesn't really begin to explain things.
Review
Quoted 12 lines
(quoted diff) +12
-0+static void io_futex_wake_fn(struct wake_q_head *wake_q, struct futex_q *q) +{ + struct io_futex_data *ifd = container_of(q, struct io_futex_data, q); + struct io_kiocb *req = ifd->req; + + __futex_unqueue(q); + smp_store_release(&q->lock_ptr, NULL); + + io_req_set_res(req, 0, 0); + req->io_task_work.func = io_futex_complete; + io_req_task_work_add(req); +}
I'm noting the WARN from futex_wake_mark() went walk-about.
Perhaps something like so?
kernel/futex/waitwake.c +22 -11
@@ -106,20 +106,11 @@* double_lock_hb() and double_unlock_hb(), respectively. */ -/* -* The hash bucket lock must be held when this is called. -* Afterwards, the futex_q must not be accessed. Callers -* must ensure to later call wake_up_q() for the actual -* wakeups to occur. -*/ -void futex_wake_mark (struct wake_q_head *wake_q,struct futex_q *q) +bool __futex_wake_mark (struct futex_q *q) { -struct task_struct *p = q->task; -if (WARN (q->pi_state || q->rt_waiter,"refusing to wake PI futex\n" )) -return ; +return false; -get_task_struct (p);__futex_unqueue (q);/* * The waiting task can free the futex_q as soon as q->lock_ptr = NULL
@@ -130,6 +121,26 @@ void futex_wake_mark(struct wake_q_head *wake_q, struct futex_q *q)*/ smp_store_release (&q->lock_ptr,NULL ); +return true; +} + +/* +* The hash bucket lock must be held when this is called. +* Afterwards, the futex_q must not be accessed. Callers +* must ensure to later call wake_up_q() for the actual +* wakeups to occur. +*/ +void futex_wake_mark (struct wake_q_head *wake_q,struct futex_q *q) +{ +struct task_struct *p = q->task; + +get_task_struct (p); + +if (!__futex_wake_mark (q)) { +put_task_struct (p); +return ; + } +/* * Queue the task for later wakeup for after we've released * the hb->lock.
Peter Zijlstra
reviewerRe: [PATCH 2/7] futex: factor out the futex wake handling
In reply to Jens AxboeQuoted 5 lines · Jens Axboe
In preparation for having another waker that isn't
futex_wake_mark(), add a wake handler infutex_q. No extra data is associated with the handler outside of structfutex_qitself.futex_wake_mark()is defined as the standard wakeup helper, now set throughfutex_q_initlike other defaults.
Urgh... so if I understand things right, you're going to replace this with a custom wake function that does *NOT* put the task on the wake_q.
The wake_q will thus be empty and the task does not get woken up. I'm presuming someone gets a notification instead somewhere somehow.
I might've been nice to mention some of this somewhere ...
Quoted 29 lines
Signed-off-by Jens Axboe <[email protected]>--- kernel/futex/futex.h | 4 ++++ kernel/futex/requeue.c | 3 ++- kernel/futex/waitwake.c | 6 +++--- 3 files changed, 9 insertions(+), 4 deletions(-)kernel/futex/futex.h +4
-0@@ -69,6 +69,9 @@ struct futex_pi_state {union futex_key key; } __randomize_layout; +struct futex_q ; +typedef void (futex_wake_fn )(struct wake_q_head *wake_q,struct futex_q *q); +/** * struct futex_q - The hashed futex queue entry, one per waiting task * @list: priority-sorted list of tasks waiting on this futex @@ -98,6 +101,7 @@ struct futex_q {struct task_struct *task;spinlock_t *lock_ptr; +futex_wake_fn *wake;union futex_key key;struct futex_pi_state *pi_state;struct rt_mutex_waiter *rt_waiter;
Peter Zijlstra
reviewerRe: [PATCH 5/7] futex: make futex_parse_waitv() available as a helper
In reply to Jens AxboeQuoted 9 lines · Jens Axboe
Since we now provide a way to pass in a wake handler and data, ensure we use
__futex_queue()to avoid havingfutex_queue()overwrite our wait data.kernel/futex/waitwake.c +0
-0
kernel/futex/waitwake.c static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo · line 452
Quoted 8 lines
kernel/futex/waitwake.c +2
-1@@ -446,7 +446,8 @@ static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo* next futex. Queue each futex at this moment so hb can * be unlocked. */ -futex_queue (q, hb); +__futex_queue (q, hb); +spin_unlock (&hb->lock);continue ; }
I'm not following; I even applied all your patches up to this point, but futex_queue() still reads:
static inline void futex_queue(struct futex_q *q, struct futex_hash_bucket *hb)
__releases(&hb->lock)
{
__futex_queue(q, hb);
spin_unlock(&hb->lock);
}How would it be different and overwrite anything ?!?
Peter Zijlstra
reviewerRe: [PATCH 7/7] io_uring: add futex waitv
In reply to Jens AxboeQuoted 6 lines · Jens Axboe
Needs a bit of splitting and a few hunks should go further back (like the wake handler typedef).
WIP, adds
IORING_OP_FUTEX_WAITV- pass in an array of futex addresses, and wait on all of them until one of them triggers.
So I'm once again not following. FUTEX_WAITV is to wait on multiple futexes and get a notification when any one of them wakes up with an index to indicate which one.
How exactly is that different from multiple FUTEX_WAIT entries in the io_uring thing itself? Admittedly I don't actually know much of anything when it comes to io_uring, but isn't the idea that queue multiple 'syscall' like things and get individual completions back?
So how does WAITV make sense here?
Jens Axboe
maintainerRe: [PATCH 1/7] futex: abstract out futex_op_to_flags() helper
In reply to Peter ZijlstraQuoted 49 lines · Peter Zijlstra
Quoted 16 lines · Jens Axboe
Rather than needing to duplicate this for the
io_uringhook of futexes, abstract out a helper.No functional changes intended in this patch.
Signed-off-by Jens Axboe <[email protected]>--- kernel/futex/futex.h | 15 +++++++++++++++ kernel/futex/syscalls.c | 11 ++--------- 2 files changed, 17 insertions(+), 9 deletions(-)kernel/futex/futex.h +0
-0kernel/futex/futex.h extern int futex_unlock_pi(u32 __user *uaddr, unsigned int flags); · line 295
Quoted 5 lines
kernel/futex/futex.h +2
-0@@ -291,4 +291,19 @@ extern int futex_unlock_pi(u32 __user *uaddr, unsigned int flags);extern int futex_lock_pi (u32 __user *uaddr,unsigned int flags,ktime_t *time,int trylock); +static inline bool futex_op_to_flags (int op,int cmd,unsigned int *flags) +{*flags = 0;Quoted 19 lines
kernel/futex/futex.h +12
-0+if (!(op &FUTEX_PRIVATE_FLAG )) + *flags |=FLAGS_SHARED ; + +if (op &FUTEX_CLOCK_REALTIME ) { + *flags |=FLAGS_CLOCKRT ; +if (cmd !=FUTEX_WAIT_BITSET && cmd !=FUTEX_WAIT_REQUEUE_PI && + cmd !=FUTEX_LOCK_PI2 ) +return false; + } + +return true; +}kernel/futex/syscalls.c +0
-0kernel/futex/syscalls.c long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout, · line 89
Quoted 2 lines
kernel/futex/syscalls.c +0
-0@@ -88,15 +88,8 @@ long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout,int cmd = op &FUTEX_CMD_MASK ;unsigned int flags =0 ;and skip the initializer here.
Quoted 1 line
Quoted 15 lines
kernel/futex/syscalls.c long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout, · line 92
Quoted 12 lines
kernel/futex/syscalls.c +2
-9-if (!(op &FUTEX_PRIVATE_FLAG )) - flags |=FLAGS_SHARED ; - -if (op &FUTEX_CLOCK_REALTIME ) { - flags |=FLAGS_CLOCKRT ; -if (cmd !=FUTEX_WAIT_BITSET && cmd !=FUTEX_WAIT_REQUEUE_PI && - cmd !=FUTEX_LOCK_PI2 ) -return -ENOSYS ; - } +if (!futex_op_to_flags (op, cmd, &flags)) +return -ENOSYS ;then the helper is more self sufficient and doesn't rely on the caller to initialize the flags word.
Good idea - done, thanks.
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 2/7] futex: factor out the futex wake handling
In reply to Peter ZijlstraQuoted 7 lines · Peter Zijlstra
Quoted 5 lines · Jens Axboe
In preparation for having another waker that isn't
futex_wake_mark(), add a wake handler infutex_q. No extra data is associated with the handler outside of structfutex_qitself.futex_wake_mark()is defined as the standard wakeup helper, now set throughfutex_q_initlike other defaults.
Quoted 5 lines
Urgh... so if I understand things right, you're going to replace this with a custom wake function that does *NOT* put the task on the
wake_q.The
wake_qwill thus be empty and the task does not get woken up. I'm presuming someone gets a notification instead somewhere somehow.
Right. The custom wake function is responsible for waking the task, if that is what needs to happen. On the io_uring side, the callback would queue work for the original task to post a completion event, which would then also wake it up obviously.
Quoted 1 line
I might've been nice to mention some of this somewhere ...
I'll expand the commit message a bit, it is a bit light.
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 3/7] io_uring: add support for futex wake and wait
In reply to Peter ZijlstraQuoted 24 lines · Peter Zijlstra
Quoted 23 lines · Jens Axboe
Add support for FUTEX_WAKE/WAIT primitives.
IORING_OP_FUTEX_WAKEis mix ofFUTEX_WAKEandFUTEX_WAKE_BITSET, as it does support passing in a bitset.Similary,
IORING_OP_FUTEX_WAITis a mix ofFUTEX_WAITandFUTEX_WAIT_BITSET.
FUTEX_WAKEis straight forward, as we can always just do those inline.FUTEX_WAITwill queue the futex with an appropriate callback, and that callback will in turn post a CQE when it has triggered.Cancelations are supported, both from the application point-of-view, but also to be able to cancel pending waits if the ring exits before all events have occurred.
This is just the barebones wait/wake support. PI or REQUEUE support is not added at this point, unclear if we might look into that later.
Likewise, explicit timeouts are not supported either. It is expected that users that need timeouts would do so via the usual
io_uringmechanism to do that using linked timeouts.
Quoted 5 lines
Quoted 1 line
Signed-off-by Jens Axboe <[email protected]>I'm not sure I'm qualified to review this :/ I really don't know anything about how io-uring works. And the above doesn't really begin to explain things.
It's definitely catered to someone who knows how that works already, I feel like it'd be a bit beyond the scope of a commit message like that to explain io_uring internals. Then we'd have to do that every time we add a new request type.
But I can certainly expand it a bit and hopefully make it a bit clearer. I'll do that.
Quoted 6 lines
Quoted 6 lines
(quoted diff) +6
-0+static void io_futex_wake_fn(struct wake_q_head *wake_q, struct futex_q *q) +{ + struct io_futex_data *ifd = container_of(q, struct io_futex_data, q); + struct io_kiocb *req = ifd->req; + + __futex_unqueue(q);
Quoted 8 lines
Review
Quoted 6 lines
(quoted diff) +6
-0+ smp_store_release(&q->lock_ptr, NULL); + + io_req_set_res(req, 0, 0); + req->io_task_work.func = io_futex_complete; + io_req_task_work_add(req); +}I'm noting the WARN from
futex_wake_mark()went walk-about.
True.
Quoted 1 line
Perhaps something like so?
I like that, sharing more code is always better. Should be a separate patch though I think, or folded into patch 2. Which would you prefer? I'll do a separate patch for now.
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 5/7] futex: make futex_parse_waitv() available as a helper
In reply to Peter ZijlstraQuoted 23 lines · Peter Zijlstra
Quoted 9 lines · Jens Axboe
Since we now provide a way to pass in a wake handler and data, ensure we use
__futex_queue()to avoid havingfutex_queue()overwrite our wait data.kernel/futex/waitwake.c +0
-0kernel/futex/waitwake.c static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo · line 452
Quoted 8 lines
kernel/futex/waitwake.c +2
-1@@ -446,7 +446,8 @@ static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo* next futex. Queue each futex at this moment so hb can * be unlocked. */ -futex_queue (q, hb); +__futex_queue (q, hb); +spin_unlock (&hb->lock);continue ; }I'm not following; I even applied all your patches up to this point, but
futex_queue()still reads:
Quoted 8 lines
static inline void
futex_queue(struct futex_q *q, struct futex_hash_bucket *hb)__releases(&hb->lock) { __futex_queue(q, hb); spin_unlock(&hb->lock); }How would it be different and overwrite anything ?!?
Good catch, this is a leftover from storing the task/wakeup data separately. But I got rid of that, so it's stale comment at this point and we can certainly use futex_queue() here again and drop this hunk. Will make that edit.
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 7/7] io_uring: add futex waitv
In reply to Peter ZijlstraQuoted 11 lines · Peter Zijlstra
Quoted 6 lines · Jens Axboe
Needs a bit of splitting and a few hunks should go further back (like the wake handler typedef).
WIP, adds
IORING_OP_FUTEX_WAITV- pass in an array of futex addresses, and wait on all of them until one of them triggers.So I'm once again not following.
FUTEX_WAITVis to wait on multiple futexes and get a notification when any one of them wakes up with an index to indicate which one.
Right
Quoted 6 lines
How exactly is that different from multiple
FUTEX_WAITentries in theio_uringthing itself? Admittedly I don't actually know much of anything when it comes toio_uring, but isn't the idea that queue multiple 'syscall' like things and get individual completions back?So how does WAITV make sense here?
You most certainly could just queue N FUTEX_WAIT operations rather than a single FUTEX_WAITV, but it becomes pretty cumbersome to deal with. First of all, you'd now get N completions you have to deal with. That's obviously doable, but you'd probably also need to care about cancelations of the N-1 FUTEX_WAIT that weren't triggered.
For those reasons, I do think having a separate FUTEX_WAITV makes a lot more sense. It's a single request and there's no cleanup or cancelation work to run when just one futex triggers. Tongue in cheek, but you could also argue that why would you need futex waitv support in the kernel, when you could just have N processes wait on N futexes? We can certainly do that a LOT more efficiently with io_uring even without FUTEX_WAITV, but from an efficiency and usability point of view, having FUTEX_WAITV makes this a lot easier than dealing with N requests and cancelations on completion.
Signature · 1 line
Jens Axboe