doc: Fix list: rcu_access_pointer() is not lockdep-checked
authorPaul E. McKenney <paulmck@kernel.org>
Wed, 3 Aug 2022 17:23:42 +0000 (10:23 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Wed, 31 Aug 2022 11:58:15 +0000 (04:58 -0700)
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>
Documentation/RCU/whatisRCU.rst

index 77ea260efd1207e797d84bf895c6c7d26063467a..6940e0fe8599bef9f30f72df38af635813378902 100644 (file)
@@ -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.