diff options
| author | Paul E. McKenney <paulmck@kernel.org> | 2022-08-03 10:23:42 -0700 |
|---|---|---|
| committer | Paul E. McKenney <paulmck@kernel.org> | 2022-08-31 04:58:15 -0700 |
| commit | ca8a439e4611765b0e4bf5d4fd3fab54bab5ffe2 (patch) | |
| tree | 6eff26dae8e3c047404e93e48fa1f37674d258bd /Documentation/RCU | |
| parent | 1c1c1d983e75f53b3e307804a39d17d24310c5f2 (diff) | |
doc: Fix list: rcu_access_pointer() is not lockdep-checked
The rcu_access_pointer() macro does not consult lockdep by design because
it is intended to be used outside of RCU read-side critical sections.
This commit therefore makes a separate list for it in whatisRCU.rst.
Similarly, RCU_LOCKDEP_WARN(), rcu_sleep_check(), and RCU_NONIDLE()
do not do anything with pointer access. This commit therefore creates
a separate utility-API list for them.
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'Documentation/RCU')
| -rw-r--r-- | Documentation/RCU/whatisRCU.rst | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/Documentation/RCU/whatisRCU.rst b/Documentation/RCU/whatisRCU.rst index 77ea260efd12..6940e0fe8599 100644 --- a/Documentation/RCU/whatisRCU.rst +++ b/Documentation/RCU/whatisRCU.rst @@ -1057,14 +1057,20 @@ SRCU: Initialization/cleanup:: init_srcu_struct cleanup_srcu_struct -All: lockdep-checked RCU-protected pointer access:: +All: lockdep-checked RCU utility APIs:: - rcu_access_pointer - rcu_dereference_raw RCU_LOCKDEP_WARN rcu_sleep_check RCU_NONIDLE +All: Unchecked RCU-protected pointer access:: + + rcu_dereference_raw + +All: Unchecked RCU-protected pointer access with dereferencing prohibited:: + + rcu_access_pointer + See the comment headers in the source code (or the docbook generated from them) for more information. |