mirror of
https://github.com/torvalds/linux.git
synced 2024-12-26 12:52:30 +00:00
404147faaa
The RCU documentation contains old-style cross references which
do not follow the best practices outlined in doc-guide/sphinx.rst.
In addition, some of the cross references use URLs that should be replaced
by pathnames.
Update all of these cross references and adjust the surrounding words.
Summary of changes:
- out-of-date plaintext file names (*.txt) -> *.rst
- references by :ref: tags -> path names of *.rst
* use relative paths to .rst files under the RCU/ subdirectory
* use abs paths of Documentation/xxx for other .rst files
- references by URL under https://www.kernel.org/ -> paths of *.rst
- adjust surrounding words of some of updated references.
Note:
The automarkup.py script interprets references via "*.txt" as if they
were via "*.rst", so the *.txt -> *.rst changes should be regarded as
cleanups rather than bug fixes.
Cc: rcu@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Tested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
92 lines
3.7 KiB
ReStructuredText
92 lines
3.7 KiB
ReStructuredText
.. _rcu_doc:
|
|
|
|
RCU Concepts
|
|
============
|
|
|
|
The basic idea behind RCU (read-copy update) is to split destructive
|
|
operations into two parts, one that prevents anyone from seeing the data
|
|
item being destroyed, and one that actually carries out the destruction.
|
|
A "grace period" must elapse between the two parts, and this grace period
|
|
must be long enough that any readers accessing the item being deleted have
|
|
since dropped their references. For example, an RCU-protected deletion
|
|
from a linked list would first remove the item from the list, wait for
|
|
a grace period to elapse, then free the element. See listRCU.rst for more
|
|
information on using RCU with linked lists.
|
|
|
|
Frequently Asked Questions
|
|
--------------------------
|
|
|
|
- Why would anyone want to use RCU?
|
|
|
|
The advantage of RCU's two-part approach is that RCU readers need
|
|
not acquire any locks, perform any atomic instructions, write to
|
|
shared memory, or (on CPUs other than Alpha) execute any memory
|
|
barriers. The fact that these operations are quite expensive
|
|
on modern CPUs is what gives RCU its performance advantages
|
|
in read-mostly situations. The fact that RCU readers need not
|
|
acquire locks can also greatly simplify deadlock-avoidance code.
|
|
|
|
- How can the updater tell when a grace period has completed
|
|
if the RCU readers give no indication when they are done?
|
|
|
|
Just as with spinlocks, RCU readers are not permitted to
|
|
block, switch to user-mode execution, or enter the idle loop.
|
|
Therefore, as soon as a CPU is seen passing through any of these
|
|
three states, we know that that CPU has exited any previous RCU
|
|
read-side critical sections. So, if we remove an item from a
|
|
linked list, and then wait until all CPUs have switched context,
|
|
executed in user mode, or executed in the idle loop, we can
|
|
safely free up that item.
|
|
|
|
Preemptible variants of RCU (CONFIG_PREEMPT_RCU) get the
|
|
same effect, but require that the readers manipulate CPU-local
|
|
counters. These counters allow limited types of blocking within
|
|
RCU read-side critical sections. SRCU also uses CPU-local
|
|
counters, and permits general blocking within RCU read-side
|
|
critical sections. These variants of RCU detect grace periods
|
|
by sampling these counters.
|
|
|
|
- If I am running on a uniprocessor kernel, which can only do one
|
|
thing at a time, why should I wait for a grace period?
|
|
|
|
See UP.rst for more information.
|
|
|
|
- How can I see where RCU is currently used in the Linux kernel?
|
|
|
|
Search for "rcu_read_lock", "rcu_read_unlock", "call_rcu",
|
|
"rcu_read_lock_bh", "rcu_read_unlock_bh", "srcu_read_lock",
|
|
"srcu_read_unlock", "synchronize_rcu", "synchronize_net",
|
|
"synchronize_srcu", and the other RCU primitives. Or grab one
|
|
of the cscope databases from:
|
|
|
|
(http://www.rdrop.com/users/paulmck/RCU/linuxusage/rculocktab.html).
|
|
|
|
- What guidelines should I follow when writing code that uses RCU?
|
|
|
|
See checklist.rst.
|
|
|
|
- Why the name "RCU"?
|
|
|
|
"RCU" stands for "read-copy update".
|
|
listRCU.rst has more information on where this name came from, search
|
|
for "read-copy update" to find it.
|
|
|
|
- I hear that RCU is patented? What is with that?
|
|
|
|
Yes, it is. There are several known patents related to RCU,
|
|
search for the string "Patent" in Documentation/RCU/RTFP.txt to find them.
|
|
Of these, one was allowed to lapse by the assignee, and the
|
|
others have been contributed to the Linux kernel under GPL.
|
|
There are now also LGPL implementations of user-level RCU
|
|
available (https://liburcu.org/).
|
|
|
|
- I hear that RCU needs work in order to support realtime kernels?
|
|
|
|
Realtime-friendly RCU can be enabled via the CONFIG_PREEMPT_RCU
|
|
kernel configuration parameter.
|
|
|
|
- Where can I find more information on RCU?
|
|
|
|
See the Documentation/RCU/RTFP.txt file.
|
|
Or point your browser at (http://www.rdrop.com/users/paulmck/RCU/).
|