Commit 2c3cdf5a authored by Paul E. McKenney's avatar Paul E. McKenney
Browse files

doc: Update RCU's lockdep.rst 



This commit adds a couple of new functions to the documentation.

Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
parent 06e6d1d6

Documentation/RCU/lockdep.rst

+4 −0
Original line number Original line Diff line number Diff line
@@ -17,7 +17,9 @@ state:: 
	rcu_read_lock_held() for normal RCU.

	rcu_read_lock_held() for normal RCU.

	rcu_read_lock_bh_held() for RCU-bh.

	rcu_read_lock_bh_held() for RCU-bh.

	rcu_read_lock_sched_held() for RCU-sched.

	rcu_read_lock_sched_held() for RCU-sched.

	rcu_read_lock_any_held() for any of normal RCU, RCU-bh, and RCU-sched.

	srcu_read_lock_held() for SRCU.

	srcu_read_lock_held() for SRCU.

	rcu_read_lock_trace_held() for RCU Tasks Trace.





These functions are conservative, and will therefore return 1 if they

These functions are conservative, and will therefore return 1 if they

aren't certain (for example, if CONFIG_DEBUG_LOCK_ALLOC is not set).

aren't certain (for example, if CONFIG_DEBUG_LOCK_ALLOC is not set).
@@ -53,6 +55,8 @@ checking of rcu_dereference() primitives: 
		is invoked by both SRCU readers and updaters.

		is invoked by both SRCU readers and updaters.

	rcu_dereference_raw(p):

	rcu_dereference_raw(p):

		Don't check.  (Use sparingly, if at all.)

		Don't check.  (Use sparingly, if at all.)

	rcu_dereference_raw_check(p):

		Don't do lockdep at all.  (Use sparingly, if at all.)

	rcu_dereference_protected(p, c):

	rcu_dereference_protected(p, c):

		Use explicit check expression "c", and omit all barriers

		Use explicit check expression "c", and omit all barriers

		and compiler constraints.  This is useful when the data

		and compiler constraints.  This is useful when the data