From: Alejandro Colomar <alx.manpages@gmail.com>
To: mtk.manpages@gmail.com
Cc: Alejandro Colomar <alx.manpages@gmail.com>,
linux-man@vger.kernel.org, Kurt Kanzenbach <kurt@linutronix.de>
Subject: [PATCH 07/23] futex.2: Minor tweaks to Kurt's patch
Date: Sun, 8 Aug 2021 10:41:17 +0200 [thread overview]
Message-ID: <20210808084133.734274-8-alx.manpages@gmail.com> (raw)
In-Reply-To: <20210808084133.734274-1-alx.manpages@gmail.com>
Cc: Kurt Kanzenbach <kurt@linutronix.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
man2/futex.2 | 78 ++++++++++++++++++++++++++--------------------------
1 file changed, 39 insertions(+), 39 deletions(-)
diff --git a/man2/futex.2 b/man2/futex.2
index 2f340e0e0..facdf60c9 100644
--- a/man2/futex.2
+++ b/man2/futex.2
@@ -222,9 +222,9 @@ This allows the kernel to make some additional performance optimizations.
.\" taking reference counts on file backing store, and so on.
.IP
As a convenience,
-.IR <linux/futex.h>
+.I <linux/futex.h>
defines a set of constants with the suffix
-.BR _PRIVATE
+.B _PRIVATE
that are equivalents of all of the operations listed below,
.\" except the obsolete FUTEX_FD, for which the "private" flag was
.\" meaningless
@@ -245,21 +245,21 @@ This option bit can be employed only with the
.\" commit 337f13046ff03717a9e99675284a817527440a49
.BR FUTEX_WAIT ,
and
-(since Linux v5.14.0)
+(since Linux 5.14)
.\" commit bf22a6976897977b0a3f1aeba6823c959fc4fdae
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
operations.
.IP
If this option is set, the kernel measures the
.I timeout
against the
-.BR CLOCK_REALTIME
+.B CLOCK_REALTIME
clock.
.IP
If this option is not set, the kernel measures the
.I timeout
against the
-.BR CLOCK_MONOTONIC
+.B CLOCK_MONOTONIC
clock.
.PP
The operation specified in
@@ -968,9 +968,8 @@ PI futexes are operated on by specifying one of the values listed below in
Note that the PI futex operations must be used as paired operations
and are subject to some additional requirements:
.IP * 3
-.B FUTEX_LOCK_PI
-,
-.B FUTEX_LOCK_PI2
+.BR FUTEX_LOCK_PI ,
+.BR FUTEX_LOCK_PI2 ,
and
.B FUTEX_TRYLOCK_PI
pair with
@@ -1123,19 +1122,20 @@ The
.IR uaddr2 ,
.IR val ,
and
-.IR val3
+.I val3
arguments are ignored.
.\"
.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.\"
.TP
-.BR FUTEX_LOCK_PI2 " (since Linux 5.14.0)"
+.BR FUTEX_LOCK_PI2 " (since Linux 5.14)"
.\" commit bf22a6976897977b0a3f1aeba6823c959fc4fdae
-This operation works similar like
+This operation works similar to
.BR FUTEX_LOCK_PI .
The only difference is the
-timeout argument.
-.BR FUTEX_LOCK_PI2
+.I timeout
+argument.
+.B FUTEX_LOCK_PI2
has support for selectable clocks.
.IP
If
@@ -1466,7 +1466,7 @@ The value pointed to by
is not equal to the expected value
.IR val3 .
.TP
-.BR EAGAIN
+.B EAGAIN
.RB ( FUTEX_LOCK_PI ,
.BR FUTEX_LOCK_PI2 ,
.BR FUTEX_TRYLOCK_PI ,
@@ -1480,7 +1480,7 @@ is about to exit,
but has not yet handled the internal state cleanup.
Try again.
.TP
-.BR EDEADLK
+.B EDEADLK
.RB ( FUTEX_LOCK_PI ,
.BR FUTEX_LOCK_PI2 ,
.BR FUTEX_TRYLOCK_PI ,
@@ -1522,18 +1522,18 @@ a spurious wakeup; since Linux 2.6.22, this no longer happens.
.TP
.B EINVAL
The operation in
-.IR futex_op
+.I futex_op
is one of those that employs a timeout, but the supplied
.I timeout
argument was invalid
.RI ( tv_sec
was less than zero, or
-.IR tv_nsec
+.I tv_nsec
was not less than 1,000,000,000).
.TP
.B EINVAL
The operation specified in
-.IR futex_op
+.I futex_op
employs one or both of the pointers
.I uaddr
and
@@ -1545,17 +1545,17 @@ the address is not four-byte-aligned.
.RB ( FUTEX_WAIT_BITSET ,
.BR FUTEX_WAKE_BITSET )
The bit mask supplied in
-.IR val3
+.I val3
is zero.
.TP
.B EINVAL
.RB ( FUTEX_CMP_REQUEUE_PI )
.I uaddr
equals
-.IR uaddr2
+.I uaddr2
(i.e., an attempt was made to requeue to the same futex).
.TP
-.BR EINVAL
+.B EINVAL
.RB ( FUTEX_FD )
The signal number supplied in
.I val
@@ -1570,9 +1570,9 @@ is invalid.
The kernel detected an inconsistency between the user-space state at
.I uaddr
and the kernel state\(emthat is, it detected a waiter which waits in
-.BR FUTEX_LOCK_PI
+.B FUTEX_LOCK_PI
or
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
on
.IR uaddr .
.TP
@@ -1588,7 +1588,7 @@ This indicates either state corruption
or that the kernel found a waiter on
.I uaddr
which is waiting via
-.BR FUTEX_WAIT
+.B FUTEX_WAIT
or
.BR FUTEX_WAIT_BITSET .
.TP
@@ -1601,9 +1601,9 @@ and the kernel state;
.\" The kernel sees: I have non PI state for a futex you tried to
.\" tell me was PI
that is, the kernel detected a waiter which waits via
-.BR FUTEX_WAIT
+.B FUTEX_WAIT
or
-.BR FUTEX_WAIT_BITSET
+.B FUTEX_WAIT_BITSET
on
.IR uaddr2 .
.TP
@@ -1613,9 +1613,9 @@ The kernel detected an inconsistency between the user-space state at
.I uaddr
and the kernel state;
that is, the kernel detected a waiter which waits via
-.BR FUTEX_WAIT
+.B FUTEX_WAIT
or
-.BR FUTEX_WAIT_BITSET
+.B FUTEX_WAIT_BITSET
on
.IR uaddr .
.TP
@@ -1627,9 +1627,9 @@ and the kernel state;
that is, the kernel detected a waiter which waits on
.I uaddr
via
-.BR FUTEX_LOCK_PI
+.B FUTEX_LOCK_PI
or
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
(instead of
.BR FUTEX_WAIT_REQUEUE_PI ).
.TP
@@ -1656,7 +1656,7 @@ Invalid argument.
.RB ( FUTEX_FD )
The system-wide limit on the total number of open files has been reached.
.TP
-.BR ENOMEM
+.B ENOMEM
.RB ( FUTEX_LOCK_PI ,
.BR FUTEX_LOCK_PI2 ,
.BR FUTEX_TRYLOCK_PI ,
@@ -1669,7 +1669,7 @@ Invalid operation specified in
.TP
.B ENOSYS
The
-.BR FUTEX_CLOCK_REALTIME
+.B FUTEX_CLOCK_REALTIME
option was specified in
.IR futex_op ,
but the accompanying operation was neither
@@ -1679,7 +1679,7 @@ but the accompanying operation was neither
nor
.BR FUTEX_LOCK_PI2 .
.TP
-.BR ENOSYS
+.B ENOSYS
.RB ( FUTEX_LOCK_PI ,
.BR FUTEX_LOCK_PI2 ,
.BR FUTEX_TRYLOCK_PI ,
@@ -1690,7 +1690,7 @@ A run-time check determined that the operation is not available.
The PI-futex operations are not implemented on all architectures and
are not supported on some CPU variants.
.TP
-.BR EPERM
+.B EPERM
.RB ( FUTEX_LOCK_PI ,
.BR FUTEX_LOCK_PI2 ,
.BR FUTEX_TRYLOCK_PI ,
@@ -1703,11 +1703,11 @@ the futex at
.IR uaddr2 ).
(This may be caused by a state corruption in user space.)
.TP
-.BR EPERM
+.B EPERM
.RB ( FUTEX_UNLOCK_PI )
The caller does not own the lock represented by the futex word.
.TP
-.BR ESRCH
+.B ESRCH
.RB ( FUTEX_LOCK_PI ,
.BR FUTEX_LOCK_PI2 ,
.BR FUTEX_TRYLOCK_PI ,
@@ -1716,7 +1716,7 @@ The thread ID in the futex word at
.I uaddr
does not exist.
.TP
-.BR ESRCH
+.B ESRCH
.RB ( FUTEX_CMP_REQUEUE_PI )
The thread ID in the futex word at
.I uaddr2
@@ -1724,7 +1724,7 @@ does not exist.
.TP
.B ETIMEDOUT
The operation in
-.IR futex_op
+.I futex_op
employed the timeout specified in
.IR timeout ,
and the timeout expired before the operation completed.
--
2.32.0
next prev parent reply other threads:[~2021-08-08 8:41 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-08 8:41 [PATCH 00/23] More patches from others Alejandro Colomar
2021-08-08 8:41 ` [PATCH 01/23] pipe.7: also mention writev(2) in atomicity section Alejandro Colomar
2021-08-08 13:20 ` Alejandro Colomar (man-pages)
2021-08-08 20:06 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 02/23] sigaction.2: Document SA_EXPOSE_TAGBITS and the flag support detection protocol Alejandro Colomar
2021-08-09 0:29 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 03/23] sigaction.2: Apply minor tweaks to Peter's patch Alejandro Colomar
2021-08-09 0:34 ` Michael Kerrisk (man-pages)
2021-08-09 6:36 ` Alejandro Colomar (man-pages)
2021-08-08 8:41 ` [PATCH 04/23] namespaces.7: ffix Alejandro Colomar
2021-08-08 20:08 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 05/23] unix.7: tfix Alejandro Colomar
2021-08-08 20:23 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 06/23] futex.2: Document FUTEX_LOCK_PI2 Alejandro Colomar
2021-08-09 0:06 ` Michael Kerrisk (man-pages)
2021-08-09 8:14 ` Kurt Kanzenbach
2021-08-09 9:01 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` Alejandro Colomar [this message]
2021-08-09 0:05 ` [PATCH 07/23] futex.2: Minor tweaks to Kurt's patch Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 08/23] man2: new page describing memfd_secret() system call Alejandro Colomar
2021-08-09 2:00 ` Michael Kerrisk (man-pages)
2021-08-10 8:53 ` Mike Rapoport
2021-08-08 8:41 ` [PATCH 09/23] termios.3: Document missing baudrate constants Alejandro Colomar
2021-08-08 20:30 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 10/23] getopt.3: Further clarification of optstring Alejandro Colomar
2021-08-08 22:11 ` Michael Kerrisk (man-pages)
2021-08-09 6:40 ` Alejandro Colomar (man-pages)
2021-08-08 8:41 ` [PATCH 11/23] getopt.3: Minor tweak to James's patch Alejandro Colomar
2021-08-08 22:12 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 12/23] termios.3: Use bold style for Bnn and EXTn macro constants Alejandro Colomar
2021-08-08 20:31 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 13/23] ioctl_tty.2: Document ioctls: TCGETS2, TCSETS2, TCSETSW2, TCSETSF2 Alejandro Colomar
2021-08-08 20:37 ` Michael Kerrisk (man-pages)
2021-08-08 20:56 ` Michael Kerrisk (man-pages)
2021-08-08 21:15 ` Pali Rohár
2021-08-08 21:30 ` Michael Kerrisk (man-pages)
2021-08-10 19:11 ` Pali Rohár
2021-08-10 20:40 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 14/23] ioctl_tty.2: Update DTR example Alejandro Colomar
2021-08-08 20:12 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 15/23] termios.3: Add information how to set baud rate to any other value Alejandro Colomar
2021-08-08 20:34 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 16/23] man-pages.7: wfix Alejandro Colomar
2021-08-08 20:09 ` Michael Kerrisk (man-pages)
2021-10-17 19:42 ` Alejandro Colomar (man-pages)
2021-08-08 8:41 ` [PATCH 17/23] termios.3: ffix Alejandro Colomar
2021-08-08 20:35 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 18/23] termios.3: SPARC architecture has 4 different Bnnn constants Alejandro Colomar
2021-08-08 20:36 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 19/23] regex.3: wfix Alejandro Colomar
2021-08-08 20:11 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 20/23] mount_setattr.2: New manual page documenting the mount_setattr() system call Alejandro Colomar
2021-08-10 1:34 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 21/23] mount_setattr.2: Minor tweaks to Chirstian's patch Alejandro Colomar
2021-08-10 1:35 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 22/23] ldd.1: Fix example command Alejandro Colomar
2021-08-08 22:32 ` Michael Kerrisk (man-pages)
2021-08-08 8:41 ` [PATCH 23/23] close_range.2: Glibc added a wrapper recently Alejandro Colomar
2021-08-08 20:58 ` Michael Kerrisk (man-pages)
2021-08-10 1:39 ` [PATCH 00/23] More patches from others Michael Kerrisk (man-pages)
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=20210808084133.734274-8-alx.manpages@gmail.com \
--to=alx.manpages@gmail.com \
--cc=kurt@linutronix.de \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
/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.