futex.2: Document FUTEX_WAIT_BITSET

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Thomas Gleixner 2015-01-13 15:34:17 +01:00 committed by Michael Kerrisk
parent 5447735dd2
commit 79c9b4366e
1 changed files with 22 additions and 15 deletions

View File

@ -26,13 +26,6 @@
.\"
.\" See Documentation/pi-futex.txt
.\"
.\" FIXME .
.\" 2.6.25 adds FUTEX_WAKE_BITSET, FUTEX_WAIT_BITSET
.\" commit cd689985cf49f6ff5c8eddc48d98b9d581d9475d
.\" Author: Thomas Gleixner <tglx@linutronix.de>
.\" Date: Fri Feb 1 17:45:14 2008 +0100
.\"
.\" FIXME .
.\" 2.6.31 adds FUTEX_WAIT_REQUEUE_PI, FUTEX_CMP_REQUEUE_PI
.\" commit 52400ba946759af28442dee6265c5c0180ac7122
.\" Author: Darren Hart <dvhltc@us.ibm.com>
@ -236,14 +229,6 @@ the futex and executes the
.B FUTEX_WAKE
operation.
.TP
.BR FUTEX_WAIT_BITSET " (since Linux 2.6.25)"
.\" commit cd689985cf49f6ff5c8eddc48d98b9d581d9475d
.\" FIXME TO complete
.\"
.\" FIXME Employs 'timeout' argument
.\"
[As yet undocumented]
.TP
.BR FUTEX_WAKE " (since Linux 2.6.0)"
.\" Strictly speaking, since Linux 2.5.x
This operation wakes at most
@ -431,6 +416,22 @@ is the sum of the number of waiters woken on the futex
plus the number of waiters woken on the futex
.IR uaddr2 .
.TP
.BR FUTEX_WAIT_BITSET " (since Linux 2.6.25)"
.\" commit cd689985cf49f6ff5c8eddc48d98b9d581d9475d
This operation is the same as
.BR FUTEX_WAIT
except that
.I val3
is used to provide a 32-bit bitset to the kernel.
This bitset is stored in the kernel-internal state of the waiter.
See the description of
.BR FUTEX_WAKE_BITSET
for further details.
The
.I uaddr2
argument is ignored.
.TP
.BR FUTEX_WAKE_BITSET " (since Linux 2.6.25)"
.\" commit cd689985cf49f6ff5c8eddc48d98b9d581d9475d
.\" FIXME TO complete
@ -690,6 +691,12 @@ on
.IR uaddr .
.TP
.B EINVAL
.RB ( FUTEX_WAIT_BITSET )
The bitset supplied in
.IR val3
is zero.
.TP
.B EINVAL
.RB ( FUTEX_REQUEUE )
.\" FIXME tglx suggested adding this, but does this error really
.\" occur for FUTEX_REQUEUE?