diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 09:23:05 -0400 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-14 15:57:59 -0400 |
| commit | 5da98b8230fb998b0731b2ba3893461ff238a297 (patch) | |
| tree | 3ed2748067826eecde3bec1e167f63277919132f | |
| parent | 5426a2cc70be499ea3bc67985c0608c7ac62fe6c (diff) | |
pi-futex.txt: standardize document format
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.
This document requires just minor adjustments to match
the standard documentation style:
- promote document name;
- remove extra collons on some chapter titles;
- use "-" for a bulleted list.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/pi-futex.txt | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/Documentation/pi-futex.txt b/Documentation/pi-futex.txt index 9a5bc8651c29..aafddbee7377 100644 --- a/Documentation/pi-futex.txt +++ b/Documentation/pi-futex.txt | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | ====================== | ||
| 1 | Lightweight PI-futexes | 2 | Lightweight PI-futexes |
| 2 | ---------------------- | 3 | ====================== |
| 3 | 4 | ||
| 4 | We are calling them lightweight for 3 reasons: | 5 | We are calling them lightweight for 3 reasons: |
| 5 | 6 | ||
| @@ -25,8 +26,8 @@ determinism and well-bound latencies. Even in the worst-case, PI will | |||
| 25 | improve the statistical distribution of locking related application | 26 | improve the statistical distribution of locking related application |
| 26 | delays. | 27 | delays. |
| 27 | 28 | ||
| 28 | The longer reply: | 29 | The longer reply |
| 29 | ----------------- | 30 | ---------------- |
| 30 | 31 | ||
| 31 | Firstly, sharing locks between multiple tasks is a common programming | 32 | Firstly, sharing locks between multiple tasks is a common programming |
| 32 | technique that often cannot be replaced with lockless algorithms. As we | 33 | technique that often cannot be replaced with lockless algorithms. As we |
| @@ -71,8 +72,8 @@ deterministic execution of the high-prio task: any medium-priority task | |||
| 71 | could preempt the low-prio task while it holds the shared lock and | 72 | could preempt the low-prio task while it holds the shared lock and |
| 72 | executes the critical section, and could delay it indefinitely. | 73 | executes the critical section, and could delay it indefinitely. |
| 73 | 74 | ||
| 74 | Implementation: | 75 | Implementation |
| 75 | --------------- | 76 | -------------- |
| 76 | 77 | ||
| 77 | As mentioned before, the userspace fastpath of PI-enabled pthread | 78 | As mentioned before, the userspace fastpath of PI-enabled pthread |
| 78 | mutexes involves no kernel work at all - they behave quite similarly to | 79 | mutexes involves no kernel work at all - they behave quite similarly to |
| @@ -83,8 +84,8 @@ entering the kernel. | |||
| 83 | 84 | ||
| 84 | To handle the slowpath, we have added two new futex ops: | 85 | To handle the slowpath, we have added two new futex ops: |
| 85 | 86 | ||
| 86 | FUTEX_LOCK_PI | 87 | - FUTEX_LOCK_PI |
| 87 | FUTEX_UNLOCK_PI | 88 | - FUTEX_UNLOCK_PI |
| 88 | 89 | ||
| 89 | If the lock-acquire fastpath fails, [i.e. an atomic transition from 0 to | 90 | If the lock-acquire fastpath fails, [i.e. an atomic transition from 0 to |
| 90 | TID fails], then FUTEX_LOCK_PI is called. The kernel does all the | 91 | TID fails], then FUTEX_LOCK_PI is called. The kernel does all the |