Add io_uring futex/futexv support
Jens Axboe
maintainerv3 cover Add io_uring futex/futexv support
Hi,
This patchset adds support for first futex wake and wait, and then futexv.
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/futex.h | 17 +- 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 | 364 +++++++++++++++++++++++++++++++++ io_uring/futex.h | 36 ++++ io_uring/io_uring.c | 5 + io_uring/opdef.c | 35 +++- kernel/futex/futex.h | 64 +++++- kernel/futex/requeue.c | 3 +- kernel/futex/syscalls.c | 42 ++-- kernel/futex/waitwake.c | 53 +++-- 14 files changed, 593 insertions(+), 46 deletions(-)
You can also find the code here:
https://git.kernel.dk/cgit/linux/log/?h=io_uring-futex
V3:
- Rebase on top of Peter's futex flag patches
- Move to using FUTEX2 flags
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerPATCH v3 1/10 futex: Clarify FUTEX2 flags
From: Peter Zijlstra <[email protected]>
sys_futex_waitv() is part of the futex2 series (the first and only so far) of syscalls and has a flags field per futex (as opposed to flags being encoded in the futex op).
This new flags field has a new namespace, which unfortunately isn't super explicit. Notably it currently takes FUTEX_32 and FUTEX_PRIVATE_FLAG.
Introduce the FUTEX2 namespace to clarify this
--- include/uapi/linux/futex.h | 16 +++++++++++++--- kernel/futex/syscalls.c | 7 +++---- 2 files changed, 16 insertions(+), 7 deletions(-)
include/uapi/linux/futex.h +13 -3
@@ -44,10 +44,20 @@ FUTEX_PRIVATE_FLAG)/* -* Flags to specify the bit length of the futex word for futex2 syscalls. -* Currently, only 32 is supported. +* Flags for futex2 syscalls. */ -#define FUTEX_32 2 +/* 0x00 */ +/* 0x01 */ +#define FUTEX2_32 0x02 +/* 0x04 */ +/* 0x08 */ +/* 0x10 */ +/* 0x20 */ +/* 0x40 */ +#define FUTEX2_PRIVATE FUTEX_PRIVATE_FLAG + +/* do not use */ +#define FUTEX_32 FUTEX2_32/* historical accident :-( */ /* * Max numbers of elements in a futex_waitv array
kernel/futex/syscalls.c +3 -4
@@ -183,8 +183,7 @@ SYSCALL_DEFINE6(futex, u32 __user *, uaddr, int, op, u32, val,return do_futex (uaddr, op, val, tp, uaddr2, (unsigned long )utime, val3); } -/* Mask of available flags for each futex in futex_waitv list */ -#define FUTEXV_WAITER_MASK (FUTEX_32 | FUTEX_PRIVATE_FLAG) +#define FUTEX2_MASK (FUTEX2_32 | FUTEX2_PRIVATE)/** * futex_parse_waitv - Parse a waitv array from userspace
@@ -205,10 +204,10 @@ static int futex_parse_waitv(struct futex_vector *futexv,if (copy_from_user (&aux, &uwaitv[i],sizeof (aux)))return -EFAULT ; -if ((aux.flags & ~FUTEXV_WAITER_MASK ) || aux.__reserved) +if ((aux.flags & ~FUTEX2_MASK ) || aux.__reserved)return -EINVAL ; -if (!(aux.flags &FUTEX_32 )) +if (!(aux.flags &FUTEX2_32 ))return -EINVAL ; futexv[i].w.flags = aux.flags;
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH v3 2/10 futex: Extend the FUTEX2 flags
In reply to Jens AxboeFrom: Peter Zijlstra <[email protected]>
Add the definition for the missing but always intended extra sizes, and add a NUMA flag for the planned numa extention.
--- include/uapi/linux/futex.h | 7 ++++--- kernel/futex/syscalls.c | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-)
include/uapi/linux/futex.h +4 -3
@@ -46,10 +46,11 @@/* * Flags for futex2 syscalls. */ -/* 0x00 */ -/* 0x01 */ +#define FUTEX2_8 0x00 +#define FUTEX2_16 0x01#define FUTEX2_32 0x02 -/* 0x04 */ +#define FUTEX2_64 0x03 +#define FUTEX2_NUMA 0x04/* 0x08 */ /* 0x10 */ /* 0x20 */
kernel/futex/syscalls.c +2 -2
@@ -183,7 +183,7 @@ SYSCALL_DEFINE6(futex, u32 __user *, uaddr, int, op, u32, val,return do_futex (uaddr, op, val, tp, uaddr2, (unsigned long )utime, val3); } -#define FUTEX2_MASK (FUTEX2_32 | FUTEX2_PRIVATE) +#define FUTEX2_MASK (FUTEX2_64 | FUTEX2_PRIVATE)/** * futex_parse_waitv - Parse a waitv array from userspace
@@ -207,7 +207,7 @@ static int futex_parse_waitv(struct futex_vector *futexv,if ((aux.flags & ~FUTEX2_MASK ) || aux.__reserved)return -EINVAL ; -if (!(aux.flags &FUTEX2_32 )) +if ((aux.flags &FUTEX2_64 ) !=FUTEX2_32 )return -EINVAL ; futexv[i].w.flags = aux.flags;
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH v3 3/10 futex: Flag conversion
In reply to Jens AxboeFrom: Peter Zijlstra <[email protected]>
Futex has 3 sets of flags:
- legacy futex op bits
- futex2 flags
- internal flags
Add a few helpers to convert from the API flags into the internal flags.
--- kernel/futex/futex.h | 48 ++++++++++++++++++++++++++++++++++++++--- kernel/futex/syscalls.c | 21 +++++++++++------- kernel/futex/waitwake.c | 4 ++-- 3 files changed, 60 insertions(+), 13 deletions(-)
kernel/futex/futex.h +45 -3
@@ -16,8 +16,15 @@* Futex flags used to encode options to functions and preserve them across * restarts. */ +#define FLAGS_SIZE_8 0x00 +#define FLAGS_SIZE_16 0x01 +#define FLAGS_SIZE_32 0x02 +#define FLAGS_SIZE_64 0x03 + +#define FLAGS_SIZE_MASK 0x03 +#ifdef CONFIG_MMU -# define FLAGS_SHARED 0x01 +# define FLAGS_SHARED 0x10#else /* * NOMMU does not have per process address space. Let the compiler optimize
@@ -25,8 +32,43 @@*/ # define FLAGS_SHARED 0x00#endif -#define FLAGS_CLOCKRT 0x02 -#define FLAGS_HAS_TIMEOUT 0x04 +#define FLAGS_CLOCKRT 0x20 +#define FLAGS_HAS_TIMEOUT 0x40 +#define FLAGS_NUMA 0x80 + +/* FUTEX_ to FLAGS_ */ +static inline unsigned int futex_to_flags (unsigned int op) +{ +unsigned int flags =FLAGS_SIZE_32 ; + +if (!(op &FUTEX_PRIVATE_FLAG )) + flags |=FLAGS_SHARED ; + +if (op &FUTEX_CLOCK_REALTIME ) + flags |=FLAGS_CLOCKRT ; + +return flags; +} + +/* FUTEX2_ to FLAGS_ */ +static inline unsigned int futex2_to_flags (unsigned int flags2) +{ +unsigned int flags = flags2 &FUTEX2_64 ; + +if (!(flags2 &FUTEX2_PRIVATE )) + flags |=FLAGS_SHARED ; + +if (flags2 &FUTEX2_NUMA ) + flags |=FLAGS_NUMA ; + +return flags; +} + +static inline unsigned int futex_size (unsigned int flags) +{ +unsigned int size = flags &FLAGS_SIZE_MASK ; +return 1 << size;/* {0,1,2,3} -> {1,2,4,8} */ +}#ifdef CONFIG_FAIL_FUTEX extern bool should_fail_futex (bool fshared);
kernel/futex/syscalls.c +13 -8
@@ -85,15 +85,12 @@ SYSCALL_DEFINE3(get_robust_list, int, pid,long do_futex (u32 __user *uaddr,int op,u32 val,ktime_t *timeout,u32 __user *uaddr2,u32 val2,u32 val3) { +unsigned int flags =futex_to_flags (op);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 && +if (flags &FLAGS_CLOCKRT ) { +if (cmd !=FUTEX_WAIT_BITSET && + cmd !=FUTEX_WAIT_REQUEUE_PI && cmd !=FUTEX_LOCK_PI2 )return -ENOSYS ; }
@@ -201,6 +198,8 @@ static int futex_parse_waitv(struct futex_vector *futexv,unsigned int i;for (i =0 ; i < nr_futexes; i++) { +unsigned int bits, flags; +if (copy_from_user (&aux, &uwaitv[i],sizeof (aux)))return -EFAULT ;
@@ -210,7 +209,13 @@ static int futex_parse_waitv(struct futex_vector *futexv,if ((aux.flags &FUTEX2_64 ) !=FUTEX2_32 )return -EINVAL ; - futexv[i].w.flags = aux.flags; + flags =futex2_to_flags (aux.flags); + bits =8 *futex_size (flags); + +if (bits <64 && aux.val >> bits) +return -EINVAL ; + + futexv[i].w.flags = flags; futexv[i].w.val = aux.val; futexv[i].w.uaddr = aux.uaddr; futexv[i].q = futex_q_init;
kernel/futex/waitwake.c +2 -2
@@ -419,11 +419,11 @@ static int futex_wait_multiple_setup(struct futex_vector *vs, int count, int *wo*/ retry:for (i =0 ; i < count; i++) { -if ((vs[i].w.flags &FUTEX_PRIVATE_FLAG ) && retry) +if (!(vs[i].w.flags &FLAGS_SHARED ) && retry)continue ; ret =get_futex_key (u64_to_user_ptr (vs[i].w.uaddr), - !(vs[i].w.flags &FUTEX_PRIVATE_FLAG ), + vs[i].w.flags &FLAGS_SHARED , &vs[i].q.key,FUTEX_READ );if (unlikely (ret))
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH v3 4/10 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.
Normal sync futex waiting relies on wake_q holding tasks that should be woken up. This is what futex_wake_mark() does, it'll unqueue the futex and add the associated task to the wake queue. For async usage of futex waiting, rather than having tasks sleeping on the futex, we'll need to deal with a futex wake differently. For the planned io_uring case, that means posting a completion event for the task in question. Having a definable wake handler can help support that use case.
--- 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
@@ -111,6 +111,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
@@ -140,6 +143,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 v3 5/10 futex: abstract out a __futex_wake_mark() helper
In reply to Jens AxboeMove the unqueue and lock_ptr clear into a helper that futex_wake_mark() calls. Add it to the public functions as well, in preparation for using it outside the core futex code.
--- kernel/futex/futex.h | 1 + kernel/futex/waitwake.c | 33 ++++++++++++++++++++++----------- 2 files changed, 23 insertions(+), 11 deletions(-)
kernel/futex/futex.h +1 -0
@@ -190,6 +190,7 @@ extern int futex_wait_setup(u32 __user *uaddr, u32 val, unsigned int flags, struct futex_q *q, struct futex_hash_bucket **hb);extern void futex_wait_queue (struct futex_hash_bucket *hb,struct futex_q *q,struct hrtimer_sleeper *timeout); +extern bool __futex_wake_mark (struct futex_q *q);extern void futex_wake_mark (struct wake_q_head *wake_q,struct futex_q *q);extern int fault_in_user_writeable (u32 __user *uaddr);
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.
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH v3 6/10 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 those can always be done directly from the io_uring submission without needing async handling. For FUTEX_WAIT, things are a bit more complicated. If the futex isn't ready, then we rely on a callback via futex_queue->wake() when someone wakes up the futex. From that calback, we queue up task_work with the original task, which will post a CQE and wake it, if necessary.
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 | 220 +++++++++++++++++++++++++++++++++ io_uring/futex.h | 34 +++++ io_uring/io_uring.c | 5 + io_uring/opdef.c | 24 +++- 9 files changed, 300 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 +220 -0
220 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"
@@ -330,6 +331,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);
@@ -349,6 +351,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;
@@ -2869,6 +2872,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)
@@ -3281,6 +3285,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
Peter Zijlstra
reviewerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Review
Quoted 7 lines · Jens Axboe
(quoted diff) +7
-0+struct io_futex { + struct file *file; + u32 __user *uaddr; + unsigned int futex_val; + unsigned int futex_flags; + unsigned int futex_mask; +};
So in the futex patches I just posted I went with 'unsigned long' (syscall) or 'u64' (data structures) for the futex, such that, on 64bit platforms, we might support 64bit futexes in the future (I still need to audit the whole futex internals and convert u32 to unsigned long in order to enable that).
So would something like:
struct io_futex {
struct file *file;
void __user *uaddr;
u64 futex_val;
u64 futex_mask;
u32 futex_flags;
};work to match the futex2 syscalls?
Review
Quoted 11 lines
(quoted diff) +11
-0+int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) +{ + struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex); + + if (unlikely(sqe->fd || sqe->addr2 || sqe->buf_index || sqe->addr3)) + return -EINVAL; + + iof->uaddr = u64_to_user_ptr(READ_ONCE(sqe->addr)); + iof->futex_val = READ_ONCE(sqe->len); + iof->futex_mask = READ_ONCE(sqe->file_index); + iof->futex_flags = READ_ONCE(sqe->futex_flags);
sqe->addr, u64sqe->len, u32sqe->file_index, u32sqe->futex_flags, u32
Review
Quoted 1 line
(quoted diff) +1
-0+ if (iof->futex_flags & FUTEX_CMD_MASK)
FUTEX2_MASK
(which would need lifting from syscall.c to kernel/futex/futex.h I suppose)
Quoted 10 lines
(quoted diff) +4
-0+ return -EINVAL; + + return 0; +}include/uapi/linux/io_uring.h +0
-0
include/uapi/linux/io_uring.h struct io_uring_sqe { · line 71
Quoted 7 lines
include/uapi/linux/io_uring.h +1
-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 */
Perhaps extend it like so?
include/uapi/linux/io_uring.h +3 -0
@@ -35,6 +35,7 @@ struct io_uring_sqe {union {__u64 off;/* offset into file */ __u64 addr2; +__u64 futex_val;struct {__u32 cmd_op;__u32 __pad1;
@@ -65,6 +66,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 */
@@ -87,6 +89,7 @@ struct io_uring_sqe {union {struct {__u64 addr3; +__u64 futex_mask;__u64 __pad2[1 ]; };/*
So that we can write something roughtly like:
iof->uaddr = sqe->addr; iof->val = sqe->futex_val; iof->mask = sqe->futex_mask; iof->flags = sqe->futex_flags; if (iof->flags & ~FUTEX2_MASK) return -EINVAL;
Peter Zijlstra
reviewerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
On Fri, Jul 21, 2023 at 01:30:31PM +0200, Peter Zijlstra wrote:
Sorry, I was too quick..
iof->uaddr = sqe->addr; iof->val = sqe->futex_val; iof->mask = sqe->futex_mask; flags = sqe->futex_flags; if (flags & ~FUTEX2_MASK) return -EINVAL; iof->flags = futex2_to_flags(flags); if (!futex_flags_valid(iof->flags)) return -EINVAL; if (!futex_validate_input(iof->flags, iof->val) || !futex_validate_input(iof->flags, iof->mask)) return -EINVAL
Jens Axboe
maintainerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 4 lines · Peter Zijlstra
On Fri, Jul 21, 2023 at 01:30:31PM +0200, Peter Zijlstra wrote:
Sorry, I was too quick..
Quoted 15 lines
iof->uaddr = sqe->addr; iof->val = sqe->futex_val; iof->mask = sqe->futex_mask; flags = sqe->futex_flags; if (flags & ~FUTEX2_MASK) return -EINVAL; iof->flags = futex2_to_flags(flags); if (!futex_flags_valid(iof->flags)) return -EINVAL; if (!futex_validate_input(iof->flags, iof->val) || !futex_validate_input(iof->flags, iof->mask)) return -EINVAL
Something like that should work, with some variable names fixed up. I just went with 'addr' for the futex address, addr2 for the value, and addr3 for the mask.
Rebased on top of your first 4 updated patches, and added a single patch that moves FUTEX2_MASK, will run some testing to validate it's all still sane.
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 21 lines · Jens Axboe
Quoted 4 lines · Peter Zijlstra
On Fri, Jul 21, 2023 at 01:30:31PM +0200, Peter Zijlstra wrote:
Sorry, I was too quick..
Quoted 15 lines
iof->uaddr = sqe->addr; iof->val = sqe->futex_val; iof->mask = sqe->futex_mask; flags = sqe->futex_flags; if (flags & ~FUTEX2_MASK) return -EINVAL; iof->flags = futex2_to_flags(flags); if (!futex_flags_valid(iof->flags)) return -EINVAL; if (!futex_validate_input(iof->flags, iof->val) || !futex_validate_input(iof->flags, iof->mask)) return -EINVAL
Quoted 7 lines
Something like that should work, with some variable names fixed up. I just went with 'addr' for the futex address, addr2 for the value, and addr3 for the mask.
Rebased on top of your first 4 updated patches, and added a single patch that moves
FUTEX2_MASK, will run some testing to validate it's all still sane.
FWIW, here's the io_uring incremental after that rebase. Update the liburing futex branch as well, updating the prep helpers to take 64 bit values for mask/val and also add the flags argument that was missing as well. Only other addition was adding those 4 new patches instead of the old 3 ones, and adding single patch that just moves FUTEX2_MASK to futex.h.
All checks out fine, tests pass and it works.
io_uring/futex.c +22 -10
@@ -18,11 +18,11 @@ struct io_futex {u32 __user *uaddr;struct futex_waitv __user *uwaitv; }; -unsigned int futex_val; -unsigned int futex_flags; -unsigned int futex_mask; -unsigned int futex_nr; +unsigned long futex_val; +unsigned long futex_mask;unsigned long futexv_owned; +u32 futex_flags; +unsigned int futex_nr; };struct io_futex_data {
@@ -171,15 +171,28 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex); +u32 flags; -if (unlikely (sqe->fd || sqe->buf_index || sqe->addr3)) +if (unlikely (sqe->fd || sqe->buf_index || sqe->file_index))return -EINVAL ; iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); - iof->futex_val =READ_ONCE (sqe->len); - iof->futex_mask =READ_ONCE (sqe->file_index); - iof->futex_flags =READ_ONCE (sqe->futex_flags); -if (iof->futex_flags &FUTEX_CMD_MASK ) + iof->futex_val =READ_ONCE (sqe->addr2); + iof->futex_mask =READ_ONCE (sqe->addr3); + iof->futex_nr =READ_ONCE (sqe->len); +if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) +return -EINVAL ; + + flags =READ_ONCE (sqe->futex_flags); +if (flags & ~FUTEX2_MASK ) +return -EINVAL ; + + iof->futex_flags =futex2_to_flags (flags); +if (!futex_flags_valid (iof->futex_flags)) +return -EINVAL ; + +if (!futex_validate_input (iof->futex_flags, iof->futex_val) || + !futex_validate_input (iof->futex_flags, iof->futex_mask))return -EINVAL ; iof->futexv_owned =0 ;
@@ -211,7 +224,6 @@ int io_futexv_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (ret)return ret; - iof->futex_nr =READ_ONCE (sqe->off);if (!iof->futex_nr || iof->futex_nr >FUTEX_WAITV_MAX )return -EINVAL ;
Signature · 1 line
Jens Axboe
Peter Zijlstra
reviewerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 32 lines · Jens Axboe
FWIW, here's the
io_uringincremental after that rebase. Update the liburing futex branch as well, updating the prep helpers to take 64 bit values for mask/val and also add the flags argument that was missing as well. Only other addition was adding those 4 new patches instead of the old 3 ones, and adding single patch that just movesFUTEX2_MASKtofutex.h.All checks out fine, tests pass and it works.
io_uring/futex.c +5
-0@@ -18,11 +18,11 @@ struct io_futex {u32 __user *uaddr;struct futex_waitv __user *uwaitv; }; +unsigned long futex_val; +unsigned long futex_mask;unsigned long futexv_owned; +u32 futex_flags; +unsigned int futex_nr; };struct io_futex_data {@@ -171,15 +171,28 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex); +u32 flags;
io_uring/futex.c bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task, · line 185
Quoted 10 lines
io_uring/futex.c +7
-0+if (unlikely (sqe->fd || sqe->buf_index || sqe->file_index))return -EINVAL ; iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); + iof->futex_val =READ_ONCE (sqe->addr2); + iof->futex_mask =READ_ONCE (sqe->addr3); + iof->futex_nr =READ_ONCE (sqe->len); +if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) +return -EINVAL ; +
Hmm, would something like:
if (req->opcode == IORING_OP_FUTEX_WAITV) {
if (iof->futex_val && iof->futex_mask)
return -EINVAL;
/* sys_futex_waitv() doesn't take @flags as of yet */
if (iof->futex_flags)
return -EINVAL;
if (!iof->futex_nr)
return -EINVAL;
} else {
/* sys_futex_{wake,wait}() don't take @nr */
if (iof->futex_nr)
return -EINVAL;
/* both take @flags and @mask */
flags = READ_ONCE(sqe->futex_flags);
if (flags & ~FUTEX2_MASK)
return -EINVAL;
iof->futex_flags = futex2_to_flags(flags);
if (!futex_flags_valid(iof->futex_flags))
return -EINVAL;
if (!futex_validate_input(iof->futex_flags, iof->futex_mask))
return -EINVAL;
/* sys_futex_wait() takes @val */
if (req->iocode == IORING_OP_FUTEX_WAIT) {
if (!futex_validate_input(iof->futex_flags, iof->futex_val))
return -EINVAL;
} else {
if (iof->futex_val)
return -EINVAL;
}
}work? The waitv thing is significantly different from the other two.
Jens Axboe
maintainerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 85 lines · Peter Zijlstra
Quoted 32 lines · Jens Axboe
FWIW, here's the
io_uringincremental after that rebase. Update the liburing futex branch as well, updating the prep helpers to take 64 bit values for mask/val and also add the flags argument that was missing as well. Only other addition was adding those 4 new patches instead of the old 3 ones, and adding single patch that just movesFUTEX2_MASKtofutex.h.All checks out fine, tests pass and it works.
io_uring/futex.c +5
-0@@ -18,11 +18,11 @@ struct io_futex {u32 __user *uaddr;struct futex_waitv __user *uwaitv; }; +unsigned long futex_val; +unsigned long futex_mask;unsigned long futexv_owned; +u32 futex_flags; +unsigned int futex_nr; };struct io_futex_data {@@ -171,15 +171,28 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex); +u32 flags;io_uring/futex.c bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task, · line 185
Quoted 10 lines
io_uring/futex.c +7
-0+if (unlikely (sqe->fd || sqe->buf_index || sqe->file_index))return -EINVAL ; iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); + iof->futex_val =READ_ONCE (sqe->addr2); + iof->futex_mask =READ_ONCE (sqe->addr3); + iof->futex_nr =READ_ONCE (sqe->len); +if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) +return -EINVAL ; +Hmm, would something like:
if (req->opcode == IORING_OP_FUTEX_WAITV) { if (iof->futex_val && iof->futex_mask) return -EINVAL; /* sys_futex_waitv() doesn't take @flags as of yet */ if (iof->futex_flags) return -EINVAL; if (!iof->futex_nr) return -EINVAL; } else { /* sys_futex_{wake,wait}() don't take @nr */ if (iof->futex_nr) return -EINVAL; /* both take @flags and @mask */ flags = READ_ONCE(sqe->futex_flags); if (flags & ~FUTEX2_MASK) return -EINVAL; iof->futex_flags = futex2_to_flags(flags); if (!futex_flags_valid(iof->futex_flags)) return -EINVAL; if (!futex_validate_input(iof->futex_flags, iof->futex_mask)) return -EINVAL; /* sys_futex_wait() takes @val */ if (req->iocode == IORING_OP_FUTEX_WAIT) { if (!futex_validate_input(iof->futex_flags, iof->futex_val)) return -EINVAL; } else { if (iof->futex_val) return -EINVAL; } }
Quoted 1 line
work? The waitv thing is significantly different from the other two.
I think I'll just have prep and prepv totally separate. It only makes sense to share parts of them if one is a subset of the other. That'll get rid of the odd conditionals and sectioning of it.
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 86 lines · Jens Axboe
Quoted 85 lines · Peter Zijlstra
Quoted 32 lines · Jens Axboe
FWIW, here's the
io_uringincremental after that rebase. Update the liburing futex branch as well, updating the prep helpers to take 64 bit values for mask/val and also add the flags argument that was missing as well. Only other addition was adding those 4 new patches instead of the old 3 ones, and adding single patch that just movesFUTEX2_MASKtofutex.h.All checks out fine, tests pass and it works.
io_uring/futex.c +5
-0@@ -18,11 +18,11 @@ struct io_futex {u32 __user *uaddr;struct futex_waitv __user *uwaitv; }; +unsigned long futex_val; +unsigned long futex_mask;unsigned long futexv_owned; +u32 futex_flags; +unsigned int futex_nr; };struct io_futex_data {@@ -171,15 +171,28 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex); +u32 flags;io_uring/futex.c bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task, · line 185
Quoted 10 lines
io_uring/futex.c +7
-0+if (unlikely (sqe->fd || sqe->buf_index || sqe->file_index))return -EINVAL ; iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); + iof->futex_val =READ_ONCE (sqe->addr2); + iof->futex_mask =READ_ONCE (sqe->addr3); + iof->futex_nr =READ_ONCE (sqe->len); +if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) +return -EINVAL ; +Hmm, would something like:
if (req->opcode == IORING_OP_FUTEX_WAITV) { if (iof->futex_val && iof->futex_mask) return -EINVAL; /* sys_futex_waitv() doesn't take @flags as of yet */ if (iof->futex_flags) return -EINVAL; if (!iof->futex_nr) return -EINVAL; } else { /* sys_futex_{wake,wait}() don't take @nr */ if (iof->futex_nr) return -EINVAL; /* both take @flags and @mask */ flags = READ_ONCE(sqe->futex_flags); if (flags & ~FUTEX2_MASK) return -EINVAL; iof->futex_flags = futex2_to_flags(flags); if (!futex_flags_valid(iof->futex_flags)) return -EINVAL; if (!futex_validate_input(iof->futex_flags, iof->futex_mask)) return -EINVAL; /* sys_futex_wait() takes @val */ if (req->iocode == IORING_OP_FUTEX_WAIT) { if (!futex_validate_input(iof->futex_flags, iof->futex_val)) return -EINVAL; } else { if (iof->futex_val) return -EINVAL; } }
Quoted 5 lines
Quoted 1 line
work? The waitv thing is significantly different from the other two.
I think I'll just have prep and prepv totally separate. It only makes sense to share parts of them if one is a subset of the other. That'll get rid of the odd conditionals and sectioning of it.
Something like the below - totally untested, but just to show what I mean. Will need to get split and folded into the two separate patches. Will test and fold them later today.
io_uring/futex.c +33 -8
@@ -168,7 +168,7 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,return found; } -int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) +static int __io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex);u32 flags;
@@ -179,9 +179,6 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); iof->futex_val =READ_ONCE (sqe->addr2); iof->futex_mask =READ_ONCE (sqe->addr3); - iof->futex_nr =READ_ONCE (sqe->len); -if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) -return -EINVAL ; flags =READ_ONCE (sqe->futex_flags);if (flags & ~FUTEX2_MASK )
@@ -191,14 +188,36 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (!futex_flags_valid (iof->futex_flags))return -EINVAL ; -if (!futex_validate_input (iof->futex_flags, iof->futex_val) || - !futex_validate_input (iof->futex_flags, iof->futex_mask)) +if (!futex_validate_input (iof->futex_flags, iof->futex_mask))return -EINVAL ; - iof->futexv_owned =0 ;return 0 ; } +int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) +{ + struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex); +int ret; + +if (unlikely (sqe->len)) +return -EINVAL ; + + ret =__io_futex_prep (req, sqe); +if (ret) +return ret; + +/* sys_futex_wait() takes @val */ +if (req->opcode ==IORING_OP_FUTEX_WAIT ) { +if (!futex_validate_input (iof->futex_flags, iof->futex_val)) +return -EINVAL ; + }else { +if (iof->futex_val) +return -EINVAL ; + } + +return 0 ; +} +static void io_futex_wakev_fn (struct wake_q_head *wake_q,struct futex_q *q) {struct io_kiocb *req = q->wake_data;
@@ -220,10 +239,15 @@ int io_futexv_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)struct futex_vector *futexv;int ret; - ret =io_futex_prep (req, sqe); + ret =__io_futex_prep (req, sqe);if (ret)return ret; +/* No flags supported for waitv */ +if (iof->futex_flags) +return -EINVAL ; + + iof->futex_nr =READ_ONCE (sqe->len);if (!iof->futex_nr || iof->futex_nr >FUTEX_WAITV_MAX )return -EINVAL ;
@@ -238,6 +262,7 @@ int io_futexv_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)return ret; } + iof->futexv_owned =0 ; req->flags |=REQ_F_ASYNC_DATA ; req->async_data = futexv;return 0 ;
Signature · 1 line
Jens Axboe
Peter Zijlstra
reviewerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 30 lines · Jens Axboe
Something like the below - totally untested, but just to show what I mean. Will need to get split and folded into the two separate patches. Will test and fold them later today.
io_uring/futex.c +1
-4@@ -168,7 +168,7 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,return found; } -int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) +static int __io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex);u32 flags;@@ -179,9 +179,6 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); iof->futex_val =READ_ONCE (sqe->addr2); iof->futex_mask =READ_ONCE (sqe->addr3); - iof->futex_nr =READ_ONCE (sqe->len); -if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) -return -EINVAL ; flags =READ_ONCE (sqe->futex_flags);if (flags & ~FUTEX2_MASK )@@ -191,14 +188,36 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (!futex_flags_valid (iof->futex_flags))
io_uring/futex.c int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) · line 195
Quoted 10 lines
io_uring/futex.c +1
-3return -EINVAL ; -if (!futex_validate_input (iof->futex_flags, iof->futex_val) || - !futex_validate_input (iof->futex_flags, iof->futex_mask)) +if (!futex_validate_input (iof->futex_flags, iof->futex_mask))return -EINVAL ; - iof->futexv_owned =0 ;return 0 ; }
I think you can/should split more into io_futex_prep(), specifically waitv should also have zero @val and @mask.
But yes, something like this makes sense.
Jens Axboe
maintainerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 39 lines · Peter Zijlstra
Quoted 37 lines · Jens Axboe
Something like the below - totally untested, but just to show what I mean. Will need to get split and folded into the two separate patches. Will test and fold them later today.
io_uring/futex.c +2
-6@@ -168,7 +168,7 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,return found; } -int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) +static int __io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex);u32 flags;@@ -179,9 +179,6 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); iof->futex_val =READ_ONCE (sqe->addr2); iof->futex_mask =READ_ONCE (sqe->addr3); - iof->futex_nr =READ_ONCE (sqe->len); -if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) -return -EINVAL ; flags =READ_ONCE (sqe->futex_flags);if (flags & ~FUTEX2_MASK )@@ -191,14 +188,36 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (!futex_flags_valid (iof->futex_flags))return -EINVAL ; -if (!futex_validate_input (iof->futex_flags, iof->futex_val) || - !futex_validate_input (iof->futex_flags, iof->futex_mask)) +if (!futex_validate_input (iof->futex_flags, iof->futex_mask))return -EINVAL ;
Quoted 6 lines
io_uring/futex.c int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) · line 195
Quoted 3 lines
io_uring/futex.c +0
-1- iof->futexv_owned =0 ;return 0 ; }I think you can/should split more into
io_futex_prep(), specifically waitv should also have zero @val and @mask.
Yep, I'll include that. Updating them now...
Signature · 1 line
Jens Axboe
Jens Axboe
maintainerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
Quoted 40 lines · Jens Axboe
Quoted 39 lines · Peter Zijlstra
Quoted 37 lines · Jens Axboe
Something like the below - totally untested, but just to show what I mean. Will need to get split and folded into the two separate patches. Will test and fold them later today.
io_uring/futex.c +2
-6@@ -168,7 +168,7 @@ bool io_futex_remove_all(struct io_ring_ctx *ctx, struct task_struct *task,return found; } -int io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) +static int __io_futex_prep (struct io_kiocb *req,const struct io_uring_sqe *sqe) { struct io_futex *iof = io_kiocb_to_cmd(req, struct io_futex);u32 flags;@@ -179,9 +179,6 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); iof->futex_val =READ_ONCE (sqe->addr2); iof->futex_mask =READ_ONCE (sqe->addr3); - iof->futex_nr =READ_ONCE (sqe->len); -if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) -return -EINVAL ; flags =READ_ONCE (sqe->futex_flags);if (flags & ~FUTEX2_MASK )@@ -191,14 +188,36 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (!futex_flags_valid (iof->futex_flags))return -EINVAL ; -if (!futex_validate_input (iof->futex_flags, iof->futex_val) || - !futex_validate_input (iof->futex_flags, iof->futex_mask)) +if (!futex_validate_input (iof->futex_flags, iof->futex_mask))return -EINVAL ;
Quoted 8 lines
Quoted 6 lines
io_uring/futex.c int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) · line 195
Quoted 3 lines
io_uring/futex.c +0
-1- iof->futexv_owned =0 ;return 0 ; }I think you can/should split more into
io_futex_prep(), specifically waitv should also have zero @val and @mask.Yep, I'll include that. Updating them now...
It ends up just being this incremental for the very last patch, moving all the waitv related prep to the wait prep and not relying on the non-vectored one at all.
io_uring/futex.c +7 -7
@@ -179,9 +179,6 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); iof->futex_val =READ_ONCE (sqe->addr2); iof->futex_mask =READ_ONCE (sqe->addr3); - iof->futex_nr =READ_ONCE (sqe->len); -if (iof->futex_nr && req->opcode !=IORING_OP_FUTEX_WAITV ) -return -EINVAL ; flags =READ_ONCE (sqe->futex_flags);if (flags & ~FUTEX2_MASK )
@@ -195,7 +192,6 @@ int io_futex_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe) !futex_validate_input(iof->futex_flags, iof->futex_mask)) return -EINVAL; - iof->futexv_owned =0 ;return 0 ; }
@@ -220,10 +216,13 @@ int io_futexv_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)struct futex_vector *futexv;int ret; - ret =io_futex_prep (req, sqe); -if (ret) -return ret; +/* No flags or mask supported for waitv */ +if (unlikely (sqe->fd || sqe->buf_index || sqe->file_index || + sqe->addr2 || sqe->addr3)) +return -EINVAL ; + iof->uaddr =u64_to_user_ptr (READ_ONCE (sqe->addr)); + iof->futex_nr =READ_ONCE (sqe->len);if (!iof->futex_nr || iof->futex_nr >FUTEX_WAITV_MAX )return -EINVAL ;
@@ -238,6 +237,7 @@ int io_futexv_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)return ret; } + iof->futexv_owned =0 ; req->flags |=REQ_F_ASYNC_DATA ; req->async_data = futexv;return 0 ;
Signature · 1 line
Jens Axboe
Peter Zijlstra
reviewerRe: [PATCH 06/10] io_uring: add support for futex wake and wait
In reply to Jens AxboeQuoted 3 lines · Jens Axboe
I think I'll just have prep and prepv totally separate. It only makes sense to share parts of them if one is a subset of the other. That'll get rid of the odd conditionals and sectioning of it.
Ah, yes. Fair enough.
Jens Axboe
maintainerPATCH v3 7/10 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
@@ -144,6 +144,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 v3 8/10 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.
--- kernel/futex/futex.h | 5 +++++ kernel/futex/syscalls.c | 14 ++++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-)
kernel/futex/futex.h +5 -0
@@ -327,6 +327,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
@@ -187,12 +187,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;
@@ -219,6 +222,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 ;
@@ -295,7 +300,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 );
Signature · 1 line
2.40.1
Jens Axboe
maintainerPATCH v3 9/10 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
@@ -332,6 +332,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
@@ -369,7 +369,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 *
@@ -379,7 +379,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;
@@ -407,7 +407,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;
@@ -469,7 +469,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 ;
@@ -554,7 +554,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 v3 10/10 io_uring: add support for vectored futex waits
In reply to Jens AxboeThis adds support for IORING_OP_FUTEX_WAITV, which allows registering a notification for a number of futexes at once. If one of the futexes are woken, then the request will complete with the index of the futex that got woken as the result. This is identical to what the normal vectored futex waitv operation does.
Use like IORING_OP_FUTEX_WAIT, except sqe->addr must now contain the a pointer to a struct futex_waitv array, and sqe->off must now contain the number of elements in that array.
Waiting on N futexes could be done with IORING_OP_FUTEX_WAIT as well, but that punts a lot of the work to the application:
1) Application would need to submit N IORING_OP_FUTEX_WAIT requests, rather than just a single IORING_OP_FUTEX_WAITV.
2) When one futex is woken, application would need to cancel the remaining N-1 requests that didn't trigger.
While this is of course doable, having a single vectored futex wait makes for much simpler application code.
--- include/uapi/linux/io_uring.h | 1 + io_uring/futex.c | 164 +++++++++++++++++++++++++++++++--- io_uring/futex.h | 2 + io_uring/opdef.c | 11 +++ 4 files changed, 168 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 +154 -10
211 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_futexv_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 )
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_futexv_wait, +#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