diff options
| author | Jens Axboe <axboe@kernel.dk> | 2023-09-29 12:10:36 -0600 |
|---|---|---|
| committer | Jens Axboe <axboe@kernel.dk> | 2023-10-18 08:53:37 -0600 |
| commit | bfb09c4e85271a4f3f9ddfcc3a687075daee6a17 (patch) | |
| tree | f6f77ba6247c0c694bb0caac3fb647c0abb8fa47 | |
| parent | e58e411434b279a234bc13d46b3f7f5f97add3d8 (diff) | |
| download | liburing-futex.tar.gz | |
futex man: add note on using linked timeoutsfutex
The io_uring wait syscalls do not support passing in a timeout in
the request itself, like the sync futex syscalls do. Instead, it is
encouraged to use linked timeouts to achieve the same thing.
While in there, also fixup some .B$ tags that should've been .BR.
Signed-off-by: Jens Axboe <axboe@kernel.dk>
| -rw-r--r-- | man/io_uring_prep_futex_wait.3 | 9 | ||||
| -rw-r--r-- | man/io_uring_prep_futex_waitv.3 | 9 | ||||
| -rw-r--r-- | man/io_uring_prep_futex_wake.3 | 4 |
3 files changed, 16 insertions, 6 deletions
diff --git a/man/io_uring_prep_futex_wait.3 b/man/io_uring_prep_futex_wait.3 index 4de9164d..22e9a149 100644 --- a/man/io_uring_prep_futex_wait.3 +++ b/man/io_uring_prep_futex_wait.3 @@ -78,10 +78,15 @@ Instead it returns the negated directly in the CQE .I res field. +.SH NOTES +Unlike the sync futex syscalls that wait on a futex, io_uring does not support +passing in a timeout for the request. Instead, applications are encouraged +to use a linked timeout to abort the futex request at a given time, if desired. .SH SEE ALSO .BR io_uring_get_sqe (3), .BR io_uring_submit (3), -.B$ io_uring_prep_futex_waitv (3), -.B$ io_uring_prep_futex_wake (3), +.BR io_uring_prep_futex_waitv (3), +.BR io_uring_prep_futex_wake (3), +.BR io_uring_prep_link_timeout (3), .BR futex (2) .BR futex2 (2) diff --git a/man/io_uring_prep_futex_waitv.3 b/man/io_uring_prep_futex_waitv.3 index 4226e81b..85c3b7f6 100644 --- a/man/io_uring_prep_futex_waitv.3 +++ b/man/io_uring_prep_futex_waitv.3 @@ -62,10 +62,15 @@ Instead it returns the negated directly in the CQE .I res field. +.SH NOTES +Unlike the sync futex syscalls that wait on a futex, io_uring does not support +passing in a timeout for the request. Instead, applications are encouraged +to use a linked timeout to abort the futex request at a given time, if desired. .SH SEE ALSO .BR io_uring_get_sqe (3), .BR io_uring_submit (3), -.B$ io_uring_prep_futex_wait (3), -.B$ io_uring_prep_futex_wake (3), +.BR io_uring_prep_futex_wait (3), +.BR io_uring_prep_futex_wake (3), +.BR io_uring_prep_link_timeout (3), .BR futex (2) .BR futex2 (2) diff --git a/man/io_uring_prep_futex_wake.3 b/man/io_uring_prep_futex_wake.3 index 3920bf5f..4d96e05d 100644 --- a/man/io_uring_prep_futex_wake.3 +++ b/man/io_uring_prep_futex_wake.3 @@ -78,7 +78,7 @@ field. .SH SEE ALSO .BR io_uring_get_sqe (3), .BR io_uring_submit (3), -.B$ io_uring_prep_futex_wait (3), -.B$ io_uring_prep_futex_waitv (3), +.BR io_uring_prep_futex_wait (3), +.BR io_uring_prep_futex_waitv (3), .BR futex (2) .BR futex2 (2) |