Skip to content

Commit

Permalink
robust-futexes.txt: standardize document format
Browse files Browse the repository at this point in the history
Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- add a title for the document;
- mark literal blocks;

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Jul 14, 2017
1 parent ce3a966 commit 773810d
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions Documentation/robust-futexes.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
Started by: Ingo Molnar <[email protected]>
========================================
A description of what robust futexes are
========================================

:Started by: Ingo Molnar <[email protected]>

Background
----------
Expand Down Expand Up @@ -163,7 +167,7 @@ Implementation details
----------------------

The patch adds two new syscalls: one to register the userspace list, and
one to query the registered list pointer:
one to query the registered list pointer::

asmlinkage long
sys_set_robust_list(struct robust_list_head __user *head,
Expand All @@ -185,15 +189,15 @@ straightforward. The kernel doesn't have any internal distinction between
robust and normal futexes.

If a futex is found to be held at exit time, the kernel sets the
following bit of the futex word:
following bit of the futex word::

#define FUTEX_OWNER_DIED 0x40000000

and wakes up the next futex waiter (if any). User-space does the rest of
the cleanup.

Otherwise, robust futexes are acquired by glibc by putting the TID into
the futex field atomically. Waiters set the FUTEX_WAITERS bit:
the futex field atomically. Waiters set the FUTEX_WAITERS bit::

#define FUTEX_WAITERS 0x80000000

Expand Down

0 comments on commit 773810d

Please sign in to comment.