Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8cd889cb authored by Paul E. McKenney's avatar Paul E. McKenney
Browse files

rcu: Update documentation for additional RCU lockdep functions 



Add documentation for rcu_dereference_bh_check(),
rcu_dereference_sched_check(), srcu_dereference_check(), and
rcu_dereference_index_check().

Signed-off-by: default avatarPaul E. McKenney <paulmck@linux.vnet.ibm.com>
parent e5177ec7

Documentation/RCU/lockdep.txt

+21 −3
Original line number Original line Diff line number Diff line
@@ -32,9 +32,27 @@ checking of rcu_dereference() primitives: 
	srcu_dereference(p, sp):

	srcu_dereference(p, sp):

		Check for SRCU read-side critical section.

		Check for SRCU read-side critical section.

	rcu_dereference_check(p, c):

	rcu_dereference_check(p, c):

		Use explicit check expression "c".  This is useful in

		Use explicit check expression "c" along with

		code that is invoked by both readers and updaters.

		rcu_read_lock_held().  This is useful in code that is

	rcu_dereference_raw(p)

		invoked by both RCU readers and updaters.

	rcu_dereference_bh_check(p, c):

		Use explicit check expression "c" along with

		rcu_read_lock_bh_held().  This is useful in code that

		is invoked by both RCU-bh readers and updaters.

	rcu_dereference_sched_check(p, c):

		Use explicit check expression "c" along with

		rcu_read_lock_sched_held().  This is useful in code that

		is invoked by both RCU-sched readers and updaters.

	srcu_dereference_check(p, c):

		Use explicit check expression "c" along with

		srcu_read_lock_held()().  This is useful in code that

		is invoked by both SRCU readers and updaters.

	rcu_dereference_index_check(p, c):

		Use explicit check expression "c", but the caller

		must supply one of the rcu_read_lock_held() functions.

		This is useful in code that uses RCU-protected arrays

		that is invoked by both RCU readers and updaters.

	rcu_dereference_raw(p):

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

		Don't check.  (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