Skip to content

Commit ca8a439

Browse files
committed
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 <[email protected]>
1 parent 1c1c1d9 commit ca8a439

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

Documentation/RCU/whatisRCU.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1057,14 +1057,20 @@ SRCU: Initialization/cleanup::
10571057
init_srcu_struct
10581058
cleanup_srcu_struct
10591059

1060-
All: lockdep-checked RCU-protected pointer access::
1060+
All: lockdep-checked RCU utility APIs::
10611061

1062-
rcu_access_pointer
1063-
rcu_dereference_raw
10641062
RCU_LOCKDEP_WARN
10651063
rcu_sleep_check
10661064
RCU_NONIDLE
10671065

1066+
All: Unchecked RCU-protected pointer access::
1067+
1068+
rcu_dereference_raw
1069+
1070+
All: Unchecked RCU-protected pointer access with dereferencing prohibited::
1071+
1072+
rcu_access_pointer
1073+
10681074
See the comment headers in the source code (or the docbook generated
10691075
from them) for more information.
10701076

0 commit comments

Comments
 (0)