srcu: Document that srcu_funnel_gp_start() implies srcu_funnel_exp_start()
authorPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Wed, 25 Apr 2018 19:03:36 +0000 (12:03 -0700)
committerPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Mon, 25 Jun 2018 18:26:24 +0000 (11:26 -0700)
This commit updates the header comment of srcu_funnel_gp_start() to
document the fact that srcu_funnel_gp_start() does the work of
srcu_funnel_exp_start(), in some cases by invoking it directly.

Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
kernel/rcu/srcutree.c

index 615e414..37bef2f 100644 (file)
@@ -641,6 +641,9 @@ static void srcu_funnel_exp_start(struct srcu_struct *sp, struct srcu_node *snp,
  * period s.  Losers must either ensure that their desired grace-period
  * number is recorded on at least their leaf srcu_node structure, or they
  * must take steps to invoke their own callbacks.
+ *
+ * Note that this function also does the work of srcu_funnel_exp_start(),
+ * in some cases by directly invoking it.
  */
 static void srcu_funnel_gp_start(struct srcu_struct *sp, struct srcu_data *sdp,
                                 unsigned long s, bool do_norm)