From: Gabriel Krisman Bertazi <krisman@suse.de>
To: axboe@kernel.dk
Cc: io-uring@vger.kernel.org, Gabriel Krisman Bertazi <krisman@suse.de>
Subject: [RESEND PATCH liburing 1/2] man: Fix FUTEX_WAIT/FUTEX_WAKE explanation
Date: Mon, 31 Aug 2026 12:44:25 -0300 [thread overview]
Message-ID: <20260831154426.115944-2-krisman@suse.de> (raw)
In-Reply-To: <20260831154426.115944-1-krisman@suse.de>
The description of the futex_wait parameters is incorrect when
explaining the futex value. Correct it and rewrite the rest of the
futex operations description to make them clearer.
Closes: https://github.com/axboe/liburing/issues/1625
Signed-off-by: Gabriel Krisman Bertazi <krisman@suse.de>
---
man/io_uring_enter.2 | 39 ++++++++++++++++++++-------------------
1 file changed, 20 insertions(+), 19 deletions(-)
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2
index 7b99335e..b2e93f43 100644
--- a/man/io_uring_enter.2
+++ b/man/io_uring_enter.2
@@ -1538,20 +1538,19 @@ system call.
.I addr
must hold a pointer to the futex,
.I addr2
-must hold the value to which the futex has to be changed so this caller to
-.BR futex_wait (2)
-can be woken by a call to
-.BR futex_wake (2),
+must hold the value of the futex word read by the application when
+submitting the operation. The kernel will only put the task to sleep
+and wait on the futex if, at the time of queueing, the futex word still
+matches this value.
.I addr3
-must hold the bitmask of this
+must hold a bitmask of this
.BR futex_wait (2)
-caller.
-For a caller of
-.BR futex_wake (2)
-to wake a waiter additionally the bitmask of the waiter and waker must have
-at least one set bit in common.
+caller, which will be used as a key by the kernel when
+deciding which callers to wake up.
.I fd
-must contain additional flags passed in.
+may contain additional flags following the
+.B futex2
+interface flags.
Available since 6.7.
@@ -1561,17 +1560,19 @@ Issues the equivalent of the
.BR futex_wake (2)
system call.
.I addr
-must hold a pointer to the futex,
+must hold a pointer to the futex to be awaken,
.I addr2
-must hold the maximum number of waiters waiting on this futex to wake,
+must hold the maximum number of waiters to be awaken by this call,
.I addr3
-must hold the bitmask of this
-.BR futex_wake (2)
-call.
-To wake a waiter additionally the bitmask of the waiter and waker must have
-at least one set bit in common.
+must hold a bitmask identifying which callers to wake.
+A waker will be waken if at least one bit of the bitmask matches,
+subject to the limit of waiters set by
+.IR addr2 .
.I fd
-must contain additional flags passed in.
+may contain additional flags following
+the
+.B futex2
+interface flags.
Available since 6.7.
--
2.55.0
next prev parent reply other threads:[~2026-08-31 15:44 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-31 15:44 [RESEND PATCH liburing 0/2] man page improvements Gabriel Krisman Bertazi
2026-08-31 15:44 ` Gabriel Krisman Bertazi [this message]
2026-08-31 15:44 ` [RESEND PATCH liburing 2/2] man/io_uring_submit*.3: Point to error code documentation Gabriel Krisman Bertazi
2026-08-31 23:00 ` [RESEND PATCH liburing 0/2] man page improvements Jens Axboe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260831154426.115944-2-krisman@suse.de \
--to=krisman@suse.de \
--cc=axboe@kernel.dk \
--cc=io-uring@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.