Commit 6716f4d3 authored by Paul E. McKenney's avatar Paul E. McKenney
Browse files

rcu: Update synchronize_rcu_mult() comment for call_rcu_hurry() 



Those who have worked with RCU for some time will naturally think in
terms of the long-standing call_rcu() API rather than the much newer
call_rcu_hurry() API.  But it is call_rcu_hurry() that you should normally
pass to synchronize_rcu_mult().  This commit therefore updates the header
comment to point this out.

Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
Reviewed-by: default avatarJoel Fernandes (Google) <joel@joelfernandes.org>
parent 06c2afb8

include/linux/rcupdate_wait.h

+5 −0
Original line number Diff line number Diff line
@@ -42,6 +42,11 @@ do { \ 
 * call_srcu() function, with this wrapper supplying the pointer to the

 * corresponding srcu_struct.

 *

 * Note that call_rcu_hurry() should be used instead of call_rcu()

 * because in kernels built with CONFIG_RCU_LAZY=y the delay between the

 * invocation of call_rcu() and that of the corresponding RCU callback

 * can be multiple seconds.

 *

 * The first argument tells Tiny RCU's _wait_rcu_gp() not to

 * bother waiting for RCU.  The reason for this is because anywhere

 * synchronize_rcu_mult() can be called is automatically already a full