doc: Fix list: rcu_access_pointer() is not lockdep-checked

Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

kernel os linux

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>

Paul E. McKenney 3 years ago ca8a439e 1c1c1d98

+9 -3

1 changed file

expand all

Documentation

RCU

whatisRCU.rst

+9 -3

Documentation/RCU/whatisRCU.rst

··· 1057 1057 init_srcu_struct 1058 1058 cleanup_srcu_struct 1059 1059 1060 - All: lockdep-checked RCU-protected pointer access:: 1060 + All: lockdep-checked RCU utility APIs:: 1061 1061 1062 - rcu_access_pointer 1063 - rcu_dereference_raw 1064 1062 RCU_LOCKDEP_WARN 1065 1063 rcu_sleep_check 1066 1064 RCU_NONIDLE 1065 + 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 1067 1073 1068 1074 See the comment headers in the source code (or the docbook generated 1069 1075 from them) for more information.