xref: /linux-6.15/kernel/rcu/srcutree.c (revision 3b46679c)
1e7ee1501SPaul E. McKenney // SPDX-License-Identifier: GPL-2.0+
2dad81a20SPaul E. McKenney /*
3dad81a20SPaul E. McKenney  * Sleepable Read-Copy Update mechanism for mutual exclusion.
4dad81a20SPaul E. McKenney  *
5dad81a20SPaul E. McKenney  * Copyright (C) IBM Corporation, 2006
6dad81a20SPaul E. McKenney  * Copyright (C) Fujitsu, 2012
7dad81a20SPaul E. McKenney  *
865bb0dc4SSeongJae Park  * Authors: Paul McKenney <[email protected]>
9dad81a20SPaul E. McKenney  *	   Lai Jiangshan <[email protected]>
10dad81a20SPaul E. McKenney  *
11dad81a20SPaul E. McKenney  * For detailed explanation of Read-Copy Update mechanism see -
12dad81a20SPaul E. McKenney  *		Documentation/RCU/ *.txt
13dad81a20SPaul E. McKenney  *
14dad81a20SPaul E. McKenney  */
15dad81a20SPaul E. McKenney 
16a7538352SJoe Perches #define pr_fmt(fmt) "rcu: " fmt
17a7538352SJoe Perches 
18dad81a20SPaul E. McKenney #include <linux/export.h>
19dad81a20SPaul E. McKenney #include <linux/mutex.h>
20dad81a20SPaul E. McKenney #include <linux/percpu.h>
21dad81a20SPaul E. McKenney #include <linux/preempt.h>
22dad81a20SPaul E. McKenney #include <linux/rcupdate_wait.h>
23dad81a20SPaul E. McKenney #include <linux/sched.h>
24dad81a20SPaul E. McKenney #include <linux/smp.h>
25dad81a20SPaul E. McKenney #include <linux/delay.h>
2622607d66SPaul E. McKenney #include <linux/module.h>
272ec30311SPaul E. McKenney #include <linux/slab.h>
28dad81a20SPaul E. McKenney #include <linux/srcu.h>
29dad81a20SPaul E. McKenney 
30dad81a20SPaul E. McKenney #include "rcu.h"
3145753c5fSIngo Molnar #include "rcu_segcblist.h"
32dad81a20SPaul E. McKenney 
330c8e0e3cSPaul E. McKenney /* Holdoff in nanoseconds for auto-expediting. */
340c8e0e3cSPaul E. McKenney #define DEFAULT_SRCU_EXP_HOLDOFF (25 * 1000)
350c8e0e3cSPaul E. McKenney static ulong exp_holdoff = DEFAULT_SRCU_EXP_HOLDOFF;
3622607d66SPaul E. McKenney module_param(exp_holdoff, ulong, 0444);
3722607d66SPaul E. McKenney 
38c350c008SPaul E. McKenney /* Overflow-check frequency.  N bits roughly says every 2**N grace periods. */
39c350c008SPaul E. McKenney static ulong counter_wrap_check = (ULONG_MAX >> 2);
40c350c008SPaul E. McKenney module_param(counter_wrap_check, ulong, 0444);
41c350c008SPaul E. McKenney 
42c69a00a1SPaul E. McKenney /*
43c69a00a1SPaul E. McKenney  * Control conversion to SRCU_SIZE_BIG:
44a57ffb3cSPaul E. McKenney  *    0: Don't convert at all.
45c69a00a1SPaul E. McKenney  *    1: Convert at init_srcu_struct() time.
46c69a00a1SPaul E. McKenney  *    2: Convert when rcutorture invokes srcu_torture_stats_print().
47a57ffb3cSPaul E. McKenney  *    3: Decide at boot time based on system shape (default).
489f2e91d9SPaul E. McKenney  * 0x1x: Convert when excessive contention encountered.
49c69a00a1SPaul E. McKenney  */
509f2e91d9SPaul E. McKenney #define SRCU_SIZING_NONE	0
519f2e91d9SPaul E. McKenney #define SRCU_SIZING_INIT	1
529f2e91d9SPaul E. McKenney #define SRCU_SIZING_TORTURE	2
539f2e91d9SPaul E. McKenney #define SRCU_SIZING_AUTO	3
549f2e91d9SPaul E. McKenney #define SRCU_SIZING_CONTEND	0x10
559f2e91d9SPaul E. McKenney #define SRCU_SIZING_IS(x) ((convert_to_big & ~SRCU_SIZING_CONTEND) == x)
569f2e91d9SPaul E. McKenney #define SRCU_SIZING_IS_NONE() (SRCU_SIZING_IS(SRCU_SIZING_NONE))
579f2e91d9SPaul E. McKenney #define SRCU_SIZING_IS_INIT() (SRCU_SIZING_IS(SRCU_SIZING_INIT))
589f2e91d9SPaul E. McKenney #define SRCU_SIZING_IS_TORTURE() (SRCU_SIZING_IS(SRCU_SIZING_TORTURE))
599f2e91d9SPaul E. McKenney #define SRCU_SIZING_IS_CONTEND() (convert_to_big & SRCU_SIZING_CONTEND)
60a57ffb3cSPaul E. McKenney static int convert_to_big = SRCU_SIZING_AUTO;
61c69a00a1SPaul E. McKenney module_param(convert_to_big, int, 0444);
62c69a00a1SPaul E. McKenney 
63a57ffb3cSPaul E. McKenney /* Number of CPUs to trigger init_srcu_struct()-time transition to big. */
64a57ffb3cSPaul E. McKenney static int big_cpu_lim __read_mostly = 128;
65a57ffb3cSPaul E. McKenney module_param(big_cpu_lim, int, 0444);
66a57ffb3cSPaul E. McKenney 
679f2e91d9SPaul E. McKenney /* Contention events per jiffy to initiate transition to big. */
689f2e91d9SPaul E. McKenney static int small_contention_lim __read_mostly = 100;
699f2e91d9SPaul E. McKenney module_param(small_contention_lim, int, 0444);
709f2e91d9SPaul E. McKenney 
71e0fcba9aSPaul E. McKenney /* Early-boot callback-management, so early that no lock is required! */
72e0fcba9aSPaul E. McKenney static LIST_HEAD(srcu_boot_list);
73e0fcba9aSPaul E. McKenney static bool __read_mostly srcu_init_done;
74e0fcba9aSPaul E. McKenney 
75da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work);
76aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay);
770d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work);
78e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t);
79da915ad5SPaul E. McKenney 
80d6331980SPaul E. McKenney /* Wrappers for lock acquisition and release, see raw_spin_lock_rcu_node(). */
81d6331980SPaul E. McKenney #define spin_lock_rcu_node(p)							\
82d6331980SPaul E. McKenney do {										\
83d6331980SPaul E. McKenney 	spin_lock(&ACCESS_PRIVATE(p, lock));					\
84d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();						\
85d6331980SPaul E. McKenney } while (0)
86d6331980SPaul E. McKenney 
87d6331980SPaul E. McKenney #define spin_unlock_rcu_node(p) spin_unlock(&ACCESS_PRIVATE(p, lock))
88d6331980SPaul E. McKenney 
89d6331980SPaul E. McKenney #define spin_lock_irq_rcu_node(p)						\
90d6331980SPaul E. McKenney do {										\
91d6331980SPaul E. McKenney 	spin_lock_irq(&ACCESS_PRIVATE(p, lock));				\
92d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();						\
93d6331980SPaul E. McKenney } while (0)
94d6331980SPaul E. McKenney 
95d6331980SPaul E. McKenney #define spin_unlock_irq_rcu_node(p)						\
96d6331980SPaul E. McKenney 	spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
97d6331980SPaul E. McKenney 
98d6331980SPaul E. McKenney #define spin_lock_irqsave_rcu_node(p, flags)					\
99d6331980SPaul E. McKenney do {										\
100d6331980SPaul E. McKenney 	spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags);			\
101d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();						\
102d6331980SPaul E. McKenney } while (0)
103d6331980SPaul E. McKenney 
1049f2e91d9SPaul E. McKenney #define spin_trylock_irqsave_rcu_node(p, flags)					\
1059f2e91d9SPaul E. McKenney ({										\
1069f2e91d9SPaul E. McKenney 	bool ___locked = spin_trylock_irqsave(&ACCESS_PRIVATE(p, lock), flags); \
1079f2e91d9SPaul E. McKenney 										\
1089f2e91d9SPaul E. McKenney 	if (___locked)								\
1099f2e91d9SPaul E. McKenney 		smp_mb__after_unlock_lock();					\
1109f2e91d9SPaul E. McKenney 	___locked;								\
1119f2e91d9SPaul E. McKenney })
1129f2e91d9SPaul E. McKenney 
113d6331980SPaul E. McKenney #define spin_unlock_irqrestore_rcu_node(p, flags)				\
114d6331980SPaul E. McKenney 	spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags)			\
115d6331980SPaul E. McKenney 
116da915ad5SPaul E. McKenney /*
1172ec30311SPaul E. McKenney  * Initialize SRCU per-CPU data.  Note that statically allocated
118da915ad5SPaul E. McKenney  * srcu_struct structures might already have srcu_read_lock() and
119da915ad5SPaul E. McKenney  * srcu_read_unlock() running against them.  So if the is_static parameter
120da915ad5SPaul E. McKenney  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
121da915ad5SPaul E. McKenney  */
1222ec30311SPaul E. McKenney static void init_srcu_struct_data(struct srcu_struct *ssp)
1232ec30311SPaul E. McKenney {
1242ec30311SPaul E. McKenney 	int cpu;
1252ec30311SPaul E. McKenney 	struct srcu_data *sdp;
1262ec30311SPaul E. McKenney 
1272ec30311SPaul E. McKenney 	/*
1282ec30311SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
1292ec30311SPaul E. McKenney 	 * leaves of the srcu_node tree.
1302ec30311SPaul E. McKenney 	 */
1312ec30311SPaul E. McKenney 	WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
1322ec30311SPaul E. McKenney 		     ARRAY_SIZE(sdp->srcu_unlock_count));
1332ec30311SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1342ec30311SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
1352ec30311SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
1362ec30311SPaul E. McKenney 		rcu_segcblist_init(&sdp->srcu_cblist);
1372ec30311SPaul E. McKenney 		sdp->srcu_cblist_invoking = false;
13803200b5cSPaul E. McKenney 		sdp->srcu_gp_seq_needed = ssp->srcu_sup->srcu_gp_seq;
13903200b5cSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = ssp->srcu_sup->srcu_gp_seq;
1402ec30311SPaul E. McKenney 		sdp->mynode = NULL;
1412ec30311SPaul E. McKenney 		sdp->cpu = cpu;
1422ec30311SPaul E. McKenney 		INIT_WORK(&sdp->work, srcu_invoke_callbacks);
1432ec30311SPaul E. McKenney 		timer_setup(&sdp->delay_work, srcu_delay_timer, 0);
1442ec30311SPaul E. McKenney 		sdp->ssp = ssp;
1452ec30311SPaul E. McKenney 	}
1462ec30311SPaul E. McKenney }
1472ec30311SPaul E. McKenney 
148cbdc98e9SPaul E. McKenney /* Invalid seq state, used during snp node initialization */
149cbdc98e9SPaul E. McKenney #define SRCU_SNP_INIT_SEQ		0x2
150cbdc98e9SPaul E. McKenney 
151cbdc98e9SPaul E. McKenney /*
152cbdc98e9SPaul E. McKenney  * Check whether sequence number corresponding to snp node,
153cbdc98e9SPaul E. McKenney  * is invalid.
154cbdc98e9SPaul E. McKenney  */
155cbdc98e9SPaul E. McKenney static inline bool srcu_invl_snp_seq(unsigned long s)
156cbdc98e9SPaul E. McKenney {
15750be0c04SPingfan Liu 	return s == SRCU_SNP_INIT_SEQ;
158cbdc98e9SPaul E. McKenney }
159cbdc98e9SPaul E. McKenney 
1602ec30311SPaul E. McKenney /*
1612ec30311SPaul E. McKenney  * Allocated and initialize SRCU combining tree.  Returns @true if
1622ec30311SPaul E. McKenney  * allocation succeeded and @false otherwise.
1632ec30311SPaul E. McKenney  */
164c69a00a1SPaul E. McKenney static bool init_srcu_struct_nodes(struct srcu_struct *ssp, gfp_t gfp_flags)
165dad81a20SPaul E. McKenney {
166da915ad5SPaul E. McKenney 	int cpu;
167da915ad5SPaul E. McKenney 	int i;
168da915ad5SPaul E. McKenney 	int level = 0;
169da915ad5SPaul E. McKenney 	int levelspread[RCU_NUM_LVLS];
170da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
171da915ad5SPaul E. McKenney 	struct srcu_node *snp;
172da915ad5SPaul E. McKenney 	struct srcu_node *snp_first;
173da915ad5SPaul E. McKenney 
174b5befe84SFrederic Weisbecker 	/* Initialize geometry if it has not already been initialized. */
175b5befe84SFrederic Weisbecker 	rcu_init_geometry();
17695433f72SPaul E. McKenney 	ssp->srcu_sup->node = kcalloc(rcu_num_nodes, sizeof(*ssp->srcu_sup->node), gfp_flags);
17795433f72SPaul E. McKenney 	if (!ssp->srcu_sup->node)
1782ec30311SPaul E. McKenney 		return false;
179b5befe84SFrederic Weisbecker 
180da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
181208f41b1SPaul E. McKenney 	ssp->srcu_sup->level[0] = &ssp->srcu_sup->node[0];
182da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
183208f41b1SPaul E. McKenney 		ssp->srcu_sup->level[i] = ssp->srcu_sup->level[i - 1] + num_rcu_lvl[i - 1];
184da915ad5SPaul E. McKenney 	rcu_init_levelspread(levelspread, num_rcu_lvl);
185da915ad5SPaul E. McKenney 
186da915ad5SPaul E. McKenney 	/* Each pass through this loop initializes one srcu_node structure. */
187aacb5d91SPaul E. McKenney 	srcu_for_each_node_breadth_first(ssp, snp) {
188d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(snp, lock));
189c7e88067SPaul E. McKenney 		WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
190c7e88067SPaul E. McKenney 			     ARRAY_SIZE(snp->srcu_data_have_cbs));
191c7e88067SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
192cbdc98e9SPaul E. McKenney 			snp->srcu_have_cbs[i] = SRCU_SNP_INIT_SEQ;
193c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[i] = 0;
194c7e88067SPaul E. McKenney 		}
195cbdc98e9SPaul E. McKenney 		snp->srcu_gp_seq_needed_exp = SRCU_SNP_INIT_SEQ;
196da915ad5SPaul E. McKenney 		snp->grplo = -1;
197da915ad5SPaul E. McKenney 		snp->grphi = -1;
19895433f72SPaul E. McKenney 		if (snp == &ssp->srcu_sup->node[0]) {
199da915ad5SPaul E. McKenney 			/* Root node, special case. */
200da915ad5SPaul E. McKenney 			snp->srcu_parent = NULL;
201da915ad5SPaul E. McKenney 			continue;
202da915ad5SPaul E. McKenney 		}
203da915ad5SPaul E. McKenney 
204da915ad5SPaul E. McKenney 		/* Non-root node. */
205208f41b1SPaul E. McKenney 		if (snp == ssp->srcu_sup->level[level + 1])
206da915ad5SPaul E. McKenney 			level++;
207208f41b1SPaul E. McKenney 		snp->srcu_parent = ssp->srcu_sup->level[level - 1] +
208208f41b1SPaul E. McKenney 				   (snp - ssp->srcu_sup->level[level]) /
209da915ad5SPaul E. McKenney 				   levelspread[level - 1];
210da915ad5SPaul E. McKenney 	}
211da915ad5SPaul E. McKenney 
212da915ad5SPaul E. McKenney 	/*
213da915ad5SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
214da915ad5SPaul E. McKenney 	 * leaves of the srcu_node tree.
215da915ad5SPaul E. McKenney 	 */
216da915ad5SPaul E. McKenney 	level = rcu_num_lvls - 1;
217208f41b1SPaul E. McKenney 	snp_first = ssp->srcu_sup->level[level];
218da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
219aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
220da915ad5SPaul E. McKenney 		sdp->mynode = &snp_first[cpu / levelspread[level]];
221da915ad5SPaul E. McKenney 		for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
222da915ad5SPaul E. McKenney 			if (snp->grplo < 0)
223da915ad5SPaul E. McKenney 				snp->grplo = cpu;
224da915ad5SPaul E. McKenney 			snp->grphi = cpu;
225da915ad5SPaul E. McKenney 		}
226c7e88067SPaul E. McKenney 		sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
227da915ad5SPaul E. McKenney 	}
228a0d8cbd3SPaul E. McKenney 	smp_store_release(&ssp->srcu_sup->srcu_size_state, SRCU_SIZE_WAIT_BARRIER);
2292ec30311SPaul E. McKenney 	return true;
230da915ad5SPaul E. McKenney }
231da915ad5SPaul E. McKenney 
232da915ad5SPaul E. McKenney /*
233da915ad5SPaul E. McKenney  * Initialize non-compile-time initialized fields, including the
234994f7068SPaul E. McKenney  * associated srcu_node and srcu_data structures.  The is_static parameter
235994f7068SPaul E. McKenney  * tells us that ->sda has already been wired up to srcu_data.
236da915ad5SPaul E. McKenney  */
237aacb5d91SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *ssp, bool is_static)
238da915ad5SPaul E. McKenney {
23995433f72SPaul E. McKenney 	if (!is_static)
24095433f72SPaul E. McKenney 		ssp->srcu_sup = kzalloc(sizeof(*ssp->srcu_sup), GFP_KERNEL);
24195433f72SPaul E. McKenney 	if (!ssp->srcu_sup)
24295433f72SPaul E. McKenney 		return -ENOMEM;
2430839ade9SPaul E. McKenney 	if (!is_static)
244b3fb11f7SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(ssp->srcu_sup, lock));
245a0d8cbd3SPaul E. McKenney 	ssp->srcu_sup->srcu_size_state = SRCU_SIZE_SMALL;
24695433f72SPaul E. McKenney 	ssp->srcu_sup->node = NULL;
247574dc1a7SPaul E. McKenney 	mutex_init(&ssp->srcu_sup->srcu_cb_mutex);
248e3a6ab25SPaul E. McKenney 	mutex_init(&ssp->srcu_sup->srcu_gp_mutex);
249aacb5d91SPaul E. McKenney 	ssp->srcu_idx = 0;
25003200b5cSPaul E. McKenney 	ssp->srcu_sup->srcu_gp_seq = 0;
251aacb5d91SPaul E. McKenney 	ssp->srcu_barrier_seq = 0;
252aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_barrier_mutex);
253aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 0);
254aacb5d91SPaul E. McKenney 	INIT_DELAYED_WORK(&ssp->work, process_srcu);
25546470cf8SPaul E. McKenney 	ssp->sda_is_static = is_static;
256da915ad5SPaul E. McKenney 	if (!is_static)
257aacb5d91SPaul E. McKenney 		ssp->sda = alloc_percpu(struct srcu_data);
25895433f72SPaul E. McKenney 	if (!ssp->sda) {
25995433f72SPaul E. McKenney 		if (!is_static)
26095433f72SPaul E. McKenney 			kfree(ssp->srcu_sup);
26150edb988SPaul E. McKenney 		return -ENOMEM;
26295433f72SPaul E. McKenney 	}
2632ec30311SPaul E. McKenney 	init_srcu_struct_data(ssp);
26403200b5cSPaul E. McKenney 	ssp->srcu_sup->srcu_gp_seq_needed_exp = 0;
26503200b5cSPaul E. McKenney 	ssp->srcu_sup->srcu_last_gp_end = ktime_get_mono_fast_ns();
266a0d8cbd3SPaul E. McKenney 	if (READ_ONCE(ssp->srcu_sup->srcu_size_state) == SRCU_SIZE_SMALL && SRCU_SIZING_IS_INIT()) {
267c69a00a1SPaul E. McKenney 		if (!init_srcu_struct_nodes(ssp, GFP_ATOMIC)) {
26846470cf8SPaul E. McKenney 			if (!ssp->sda_is_static) {
2692ec30311SPaul E. McKenney 				free_percpu(ssp->sda);
2702ec30311SPaul E. McKenney 				ssp->sda = NULL;
27195433f72SPaul E. McKenney 				kfree(ssp->srcu_sup);
2722ec30311SPaul E. McKenney 				return -ENOMEM;
2732ec30311SPaul E. McKenney 			}
2742ec30311SPaul E. McKenney 		} else {
275a0d8cbd3SPaul E. McKenney 			WRITE_ONCE(ssp->srcu_sup->srcu_size_state, SRCU_SIZE_BIG);
2762ec30311SPaul E. McKenney 		}
277c69a00a1SPaul E. McKenney 	}
27803200b5cSPaul E. McKenney 	smp_store_release(&ssp->srcu_sup->srcu_gp_seq_needed, 0); /* Init done. */
27950edb988SPaul E. McKenney 	return 0;
280dad81a20SPaul E. McKenney }
281dad81a20SPaul E. McKenney 
282dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
283dad81a20SPaul E. McKenney 
284aacb5d91SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *ssp, const char *name,
285dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
286dad81a20SPaul E. McKenney {
287dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
288aacb5d91SPaul E. McKenney 	debug_check_no_locks_freed((void *)ssp, sizeof(*ssp));
289aacb5d91SPaul E. McKenney 	lockdep_init_map(&ssp->dep_map, name, key, 0);
290aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
291dad81a20SPaul E. McKenney }
292dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
293dad81a20SPaul E. McKenney 
294dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
295dad81a20SPaul E. McKenney 
296dad81a20SPaul E. McKenney /**
297dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
298aacb5d91SPaul E. McKenney  * @ssp: structure to initialize.
299dad81a20SPaul E. McKenney  *
300dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
301dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
302dad81a20SPaul E. McKenney  * of SRCU protection.
303dad81a20SPaul E. McKenney  */
304aacb5d91SPaul E. McKenney int init_srcu_struct(struct srcu_struct *ssp)
305dad81a20SPaul E. McKenney {
306aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
307dad81a20SPaul E. McKenney }
308dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
309dad81a20SPaul E. McKenney 
310dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
311dad81a20SPaul E. McKenney 
312dad81a20SPaul E. McKenney /*
3139f2e91d9SPaul E. McKenney  * Initiate a transition to SRCU_SIZE_BIG with lock held.
3149f2e91d9SPaul E. McKenney  */
3159f2e91d9SPaul E. McKenney static void __srcu_transition_to_big(struct srcu_struct *ssp)
3169f2e91d9SPaul E. McKenney {
317b3fb11f7SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp->srcu_sup, lock));
318a0d8cbd3SPaul E. McKenney 	smp_store_release(&ssp->srcu_sup->srcu_size_state, SRCU_SIZE_ALLOC);
3199f2e91d9SPaul E. McKenney }
3209f2e91d9SPaul E. McKenney 
3219f2e91d9SPaul E. McKenney /*
32299659f64SPaul E. McKenney  * Initiate an idempotent transition to SRCU_SIZE_BIG.
32399659f64SPaul E. McKenney  */
32499659f64SPaul E. McKenney static void srcu_transition_to_big(struct srcu_struct *ssp)
32599659f64SPaul E. McKenney {
32699659f64SPaul E. McKenney 	unsigned long flags;
32799659f64SPaul E. McKenney 
32899659f64SPaul E. McKenney 	/* Double-checked locking on ->srcu_size-state. */
329a0d8cbd3SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_sup->srcu_size_state) != SRCU_SIZE_SMALL)
33099659f64SPaul E. McKenney 		return;
331b3fb11f7SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp->srcu_sup, flags);
332a0d8cbd3SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_sup->srcu_size_state) != SRCU_SIZE_SMALL) {
333b3fb11f7SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, flags);
33499659f64SPaul E. McKenney 		return;
33599659f64SPaul E. McKenney 	}
3369f2e91d9SPaul E. McKenney 	__srcu_transition_to_big(ssp);
337b3fb11f7SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, flags);
33899659f64SPaul E. McKenney }
33999659f64SPaul E. McKenney 
34099659f64SPaul E. McKenney /*
341c2445d38SPaul E. McKenney  * Check to see if the just-encountered contention event justifies
342c2445d38SPaul E. McKenney  * a transition to SRCU_SIZE_BIG.
3439f2e91d9SPaul E. McKenney  */
344c2445d38SPaul E. McKenney static void spin_lock_irqsave_check_contention(struct srcu_struct *ssp)
3459f2e91d9SPaul E. McKenney {
3469f2e91d9SPaul E. McKenney 	unsigned long j;
3479f2e91d9SPaul E. McKenney 
348a0d8cbd3SPaul E. McKenney 	if (!SRCU_SIZING_IS_CONTEND() || ssp->srcu_sup->srcu_size_state)
3499f2e91d9SPaul E. McKenney 		return;
3509f2e91d9SPaul E. McKenney 	j = jiffies;
351*3b46679cSPaul E. McKenney 	if (ssp->srcu_sup->srcu_size_jiffies != j) {
352*3b46679cSPaul E. McKenney 		ssp->srcu_sup->srcu_size_jiffies = j;
353*3b46679cSPaul E. McKenney 		ssp->srcu_sup->srcu_n_lock_retries = 0;
3549f2e91d9SPaul E. McKenney 	}
355*3b46679cSPaul E. McKenney 	if (++ssp->srcu_sup->srcu_n_lock_retries <= small_contention_lim)
3569f2e91d9SPaul E. McKenney 		return;
3579f2e91d9SPaul E. McKenney 	__srcu_transition_to_big(ssp);
3589f2e91d9SPaul E. McKenney }
3599f2e91d9SPaul E. McKenney 
3609f2e91d9SPaul E. McKenney /*
361c2445d38SPaul E. McKenney  * Acquire the specified srcu_data structure's ->lock, but check for
362c2445d38SPaul E. McKenney  * excessive contention, which results in initiation of a transition
363c2445d38SPaul E. McKenney  * to SRCU_SIZE_BIG.  But only if the srcutree.convert_to_big module
364c2445d38SPaul E. McKenney  * parameter permits this.
365c2445d38SPaul E. McKenney  */
366c2445d38SPaul E. McKenney static void spin_lock_irqsave_sdp_contention(struct srcu_data *sdp, unsigned long *flags)
367c2445d38SPaul E. McKenney {
368c2445d38SPaul E. McKenney 	struct srcu_struct *ssp = sdp->ssp;
369c2445d38SPaul E. McKenney 
370c2445d38SPaul E. McKenney 	if (spin_trylock_irqsave_rcu_node(sdp, *flags))
371c2445d38SPaul E. McKenney 		return;
372b3fb11f7SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp->srcu_sup, *flags);
373c2445d38SPaul E. McKenney 	spin_lock_irqsave_check_contention(ssp);
374b3fb11f7SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, *flags);
375c2445d38SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sdp, *flags);
376c2445d38SPaul E. McKenney }
377c2445d38SPaul E. McKenney 
378c2445d38SPaul E. McKenney /*
379c2445d38SPaul E. McKenney  * Acquire the specified srcu_struct structure's ->lock, but check for
380c2445d38SPaul E. McKenney  * excessive contention, which results in initiation of a transition
381c2445d38SPaul E. McKenney  * to SRCU_SIZE_BIG.  But only if the srcutree.convert_to_big module
382c2445d38SPaul E. McKenney  * parameter permits this.
383c2445d38SPaul E. McKenney  */
384c2445d38SPaul E. McKenney static void spin_lock_irqsave_ssp_contention(struct srcu_struct *ssp, unsigned long *flags)
385c2445d38SPaul E. McKenney {
386b3fb11f7SPaul E. McKenney 	if (spin_trylock_irqsave_rcu_node(ssp->srcu_sup, *flags))
387c2445d38SPaul E. McKenney 		return;
388b3fb11f7SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp->srcu_sup, *flags);
389c2445d38SPaul E. McKenney 	spin_lock_irqsave_check_contention(ssp);
390c2445d38SPaul E. McKenney }
391c2445d38SPaul E. McKenney 
392c2445d38SPaul E. McKenney /*
393da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
394da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
395da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
396aacb5d91SPaul E. McKenney  * to each update-side SRCU primitive.  Use ssp->lock, which -is-
397da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
398da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
399da915ad5SPaul E. McKenney  */
400aacb5d91SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *ssp)
401da915ad5SPaul E. McKenney {
402da915ad5SPaul E. McKenney 	unsigned long flags;
403da915ad5SPaul E. McKenney 
404da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
40503200b5cSPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&ssp->srcu_sup->srcu_gp_seq_needed))) /*^^^*/
406da915ad5SPaul E. McKenney 		return; /* Already initialized. */
407b3fb11f7SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp->srcu_sup, flags);
40803200b5cSPaul E. McKenney 	if (!rcu_seq_state(ssp->srcu_sup->srcu_gp_seq_needed)) {
409b3fb11f7SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, flags);
410da915ad5SPaul E. McKenney 		return;
411da915ad5SPaul E. McKenney 	}
412aacb5d91SPaul E. McKenney 	init_srcu_struct_fields(ssp, true);
413b3fb11f7SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, flags);
414da915ad5SPaul E. McKenney }
415da915ad5SPaul E. McKenney 
416da915ad5SPaul E. McKenney /*
417da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
418da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
419dad81a20SPaul E. McKenney  */
420aacb5d91SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *ssp, int idx)
421dad81a20SPaul E. McKenney {
422dad81a20SPaul E. McKenney 	int cpu;
423dad81a20SPaul E. McKenney 	unsigned long sum = 0;
424dad81a20SPaul E. McKenney 
425dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
426aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
427dad81a20SPaul E. McKenney 
4285d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_lock_count[idx]);
429dad81a20SPaul E. McKenney 	}
430dad81a20SPaul E. McKenney 	return sum;
431dad81a20SPaul E. McKenney }
432dad81a20SPaul E. McKenney 
433dad81a20SPaul E. McKenney /*
434da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
435da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
436dad81a20SPaul E. McKenney  */
437aacb5d91SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *ssp, int idx)
438dad81a20SPaul E. McKenney {
439dad81a20SPaul E. McKenney 	int cpu;
44036f65f1dSPaul E. McKenney 	unsigned long mask = 0;
441dad81a20SPaul E. McKenney 	unsigned long sum = 0;
442dad81a20SPaul E. McKenney 
443dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
444aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
445dad81a20SPaul E. McKenney 
4465d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_unlock_count[idx]);
44736f65f1dSPaul E. McKenney 		if (IS_ENABLED(CONFIG_PROVE_RCU))
44836f65f1dSPaul E. McKenney 			mask = mask | READ_ONCE(cpuc->srcu_nmi_safety);
449dad81a20SPaul E. McKenney 	}
45036f65f1dSPaul E. McKenney 	WARN_ONCE(IS_ENABLED(CONFIG_PROVE_RCU) && (mask & (mask >> 1)),
45136f65f1dSPaul E. McKenney 		  "Mixed NMI-safe readers for srcu_struct at %ps.\n", ssp);
452dad81a20SPaul E. McKenney 	return sum;
453dad81a20SPaul E. McKenney }
454dad81a20SPaul E. McKenney 
455dad81a20SPaul E. McKenney /*
456dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
457dad81a20SPaul E. McKenney  * be zero.
458dad81a20SPaul E. McKenney  */
459aacb5d91SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *ssp, int idx)
460dad81a20SPaul E. McKenney {
461dad81a20SPaul E. McKenney 	unsigned long unlocks;
462dad81a20SPaul E. McKenney 
463aacb5d91SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(ssp, idx);
464dad81a20SPaul E. McKenney 
465dad81a20SPaul E. McKenney 	/*
466dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
467dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
468dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
469dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
470dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
471dad81a20SPaul E. McKenney 	 *
472dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
473dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
474dad81a20SPaul E. McKenney 	 * grace period ends.
475dad81a20SPaul E. McKenney 	 */
476dad81a20SPaul E. McKenney 	smp_mb(); /* A */
477dad81a20SPaul E. McKenney 
478dad81a20SPaul E. McKenney 	/*
479dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
4800cd4b50bSPaul E. McKenney 	 * been no readers on this index at some point in this function.
4810cd4b50bSPaul E. McKenney 	 * But there might be more readers, as a task might have read
4820cd4b50bSPaul E. McKenney 	 * the current ->srcu_idx but not yet have incremented its CPU's
4830cd4b50bSPaul E. McKenney 	 * ->srcu_lock_count[idx] counter.  In fact, it is possible
4840cd4b50bSPaul E. McKenney 	 * that most of the tasks have been preempted between fetching
4850cd4b50bSPaul E. McKenney 	 * ->srcu_idx and incrementing ->srcu_lock_count[idx].  And there
4860cd4b50bSPaul E. McKenney 	 * could be almost (ULONG_MAX / sizeof(struct task_struct)) tasks
4870cd4b50bSPaul E. McKenney 	 * in a system whose address space was fully populated with memory.
4880cd4b50bSPaul E. McKenney 	 * Call this quantity Nt.
489dad81a20SPaul E. McKenney 	 *
4900cd4b50bSPaul E. McKenney 	 * So suppose that the updater is preempted at this point in the
4910cd4b50bSPaul E. McKenney 	 * code for a long time.  That now-preempted updater has already
4920cd4b50bSPaul E. McKenney 	 * flipped ->srcu_idx (possibly during the preceding grace period),
4930cd4b50bSPaul E. McKenney 	 * done an smp_mb() (again, possibly during the preceding grace
4940cd4b50bSPaul E. McKenney 	 * period), and summed up the ->srcu_unlock_count[idx] counters.
4950cd4b50bSPaul E. McKenney 	 * How many times can a given one of the aforementioned Nt tasks
4960cd4b50bSPaul E. McKenney 	 * increment the old ->srcu_idx value's ->srcu_lock_count[idx]
4970cd4b50bSPaul E. McKenney 	 * counter, in the absence of nesting?
498881ec9d2SPaul E. McKenney 	 *
4990cd4b50bSPaul E. McKenney 	 * It can clearly do so once, given that it has already fetched
5000cd4b50bSPaul E. McKenney 	 * the old value of ->srcu_idx and is just about to use that value
5010cd4b50bSPaul E. McKenney 	 * to index its increment of ->srcu_lock_count[idx].  But as soon as
5020cd4b50bSPaul E. McKenney 	 * it leaves that SRCU read-side critical section, it will increment
5030cd4b50bSPaul E. McKenney 	 * ->srcu_unlock_count[idx], which must follow the updater's above
5040cd4b50bSPaul E. McKenney 	 * read from that same value.  Thus, as soon the reading task does
5050cd4b50bSPaul E. McKenney 	 * an smp_mb() and a later fetch from ->srcu_idx, that task will be
5060cd4b50bSPaul E. McKenney 	 * guaranteed to get the new index.  Except that the increment of
5070cd4b50bSPaul E. McKenney 	 * ->srcu_unlock_count[idx] in __srcu_read_unlock() is after the
5080cd4b50bSPaul E. McKenney 	 * smp_mb(), and the fetch from ->srcu_idx in __srcu_read_lock()
5090cd4b50bSPaul E. McKenney 	 * is before the smp_mb().  Thus, that task might not see the new
5100cd4b50bSPaul E. McKenney 	 * value of ->srcu_idx until the -second- __srcu_read_lock(),
5110cd4b50bSPaul E. McKenney 	 * which in turn means that this task might well increment
5120cd4b50bSPaul E. McKenney 	 * ->srcu_lock_count[idx] for the old value of ->srcu_idx twice,
5130cd4b50bSPaul E. McKenney 	 * not just once.
5140cd4b50bSPaul E. McKenney 	 *
5150cd4b50bSPaul E. McKenney 	 * However, it is important to note that a given smp_mb() takes
5160cd4b50bSPaul E. McKenney 	 * effect not just for the task executing it, but also for any
5170cd4b50bSPaul E. McKenney 	 * later task running on that same CPU.
5180cd4b50bSPaul E. McKenney 	 *
5190cd4b50bSPaul E. McKenney 	 * That is, there can be almost Nt + Nc further increments of
5200cd4b50bSPaul E. McKenney 	 * ->srcu_lock_count[idx] for the old index, where Nc is the number
5210cd4b50bSPaul E. McKenney 	 * of CPUs.  But this is OK because the size of the task_struct
5220cd4b50bSPaul E. McKenney 	 * structure limits the value of Nt and current systems limit Nc
5230cd4b50bSPaul E. McKenney 	 * to a few thousand.
5240cd4b50bSPaul E. McKenney 	 *
5250cd4b50bSPaul E. McKenney 	 * OK, but what about nesting?  This does impose a limit on
5260cd4b50bSPaul E. McKenney 	 * nesting of half of the size of the task_struct structure
5270cd4b50bSPaul E. McKenney 	 * (measured in bytes), which should be sufficient.  A late 2022
5280cd4b50bSPaul E. McKenney 	 * TREE01 rcutorture run reported this size to be no less than
5290cd4b50bSPaul E. McKenney 	 * 9408 bytes, allowing up to 4704 levels of nesting, which is
5300cd4b50bSPaul E. McKenney 	 * comfortably beyond excessive.  Especially on 64-bit systems,
5310cd4b50bSPaul E. McKenney 	 * which are unlikely to be configured with an address space fully
5320cd4b50bSPaul E. McKenney 	 * populated with memory, at least not anytime soon.
533dad81a20SPaul E. McKenney 	 */
534aacb5d91SPaul E. McKenney 	return srcu_readers_lock_idx(ssp, idx) == unlocks;
535dad81a20SPaul E. McKenney }
536dad81a20SPaul E. McKenney 
537dad81a20SPaul E. McKenney /**
538dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
539dad81a20SPaul E. McKenney  *                       otherwise
540aacb5d91SPaul E. McKenney  * @ssp: which srcu_struct to count active readers (holding srcu_read_lock).
541dad81a20SPaul E. McKenney  *
542dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
543dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
544dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
545dad81a20SPaul E. McKenney  */
546aacb5d91SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *ssp)
547dad81a20SPaul E. McKenney {
548dad81a20SPaul E. McKenney 	int cpu;
549dad81a20SPaul E. McKenney 	unsigned long sum = 0;
550dad81a20SPaul E. McKenney 
551dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
552aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
553dad81a20SPaul E. McKenney 
5545d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_lock_count[0]);
5555d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_lock_count[1]);
5565d0f5953SPaul E. McKenney 		sum -= atomic_long_read(&cpuc->srcu_unlock_count[0]);
5575d0f5953SPaul E. McKenney 		sum -= atomic_long_read(&cpuc->srcu_unlock_count[1]);
558dad81a20SPaul E. McKenney 	}
559dad81a20SPaul E. McKenney 	return sum;
560dad81a20SPaul E. McKenney }
561dad81a20SPaul E. McKenney 
5624f2bfd94SNeeraj Upadhyay /*
5634f2bfd94SNeeraj Upadhyay  * We use an adaptive strategy for synchronize_srcu() and especially for
5644f2bfd94SNeeraj Upadhyay  * synchronize_srcu_expedited().  We spin for a fixed time period
5654f2bfd94SNeeraj Upadhyay  * (defined below, boot time configurable) to allow SRCU readers to exit
5664f2bfd94SNeeraj Upadhyay  * their read-side critical sections.  If there are still some readers
5674f2bfd94SNeeraj Upadhyay  * after one jiffy, we repeatedly block for one jiffy time periods.
5684f2bfd94SNeeraj Upadhyay  * The blocking time is increased as the grace-period age increases,
5694f2bfd94SNeeraj Upadhyay  * with max blocking time capped at 10 jiffies.
5704f2bfd94SNeeraj Upadhyay  */
5714f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_RETRY_CHECK_DELAY		5
5724f2bfd94SNeeraj Upadhyay 
5734f2bfd94SNeeraj Upadhyay static ulong srcu_retry_check_delay = SRCU_DEFAULT_RETRY_CHECK_DELAY;
5744f2bfd94SNeeraj Upadhyay module_param(srcu_retry_check_delay, ulong, 0444);
5754f2bfd94SNeeraj Upadhyay 
576282d8998SPaul E. McKenney #define SRCU_INTERVAL		1		// Base delay if no expedited GPs pending.
577282d8998SPaul E. McKenney #define SRCU_MAX_INTERVAL	10		// Maximum incremental delay from slow readers.
5784f2bfd94SNeeraj Upadhyay 
5794f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE_LO	3UL	// Lowmark on default per-GP-phase
5804f2bfd94SNeeraj Upadhyay 							// no-delay instances.
5814f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE_HI	1000UL	// Highmark on default per-GP-phase
5824f2bfd94SNeeraj Upadhyay 							// no-delay instances.
5834f2bfd94SNeeraj Upadhyay 
5844f2bfd94SNeeraj Upadhyay #define SRCU_UL_CLAMP_LO(val, low)	((val) > (low) ? (val) : (low))
5854f2bfd94SNeeraj Upadhyay #define SRCU_UL_CLAMP_HI(val, high)	((val) < (high) ? (val) : (high))
5864f2bfd94SNeeraj Upadhyay #define SRCU_UL_CLAMP(val, low, high)	SRCU_UL_CLAMP_HI(SRCU_UL_CLAMP_LO((val), (low)), (high))
5874f2bfd94SNeeraj Upadhyay // per-GP-phase no-delay instances adjusted to allow non-sleeping poll upto
5884f2bfd94SNeeraj Upadhyay // one jiffies time duration. Mult by 2 is done to factor in the srcu_get_delay()
5894f2bfd94SNeeraj Upadhyay // called from process_srcu().
5904f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE_ADJUSTED	\
5914f2bfd94SNeeraj Upadhyay 	(2UL * USEC_PER_SEC / HZ / SRCU_DEFAULT_RETRY_CHECK_DELAY)
5924f2bfd94SNeeraj Upadhyay 
5934f2bfd94SNeeraj Upadhyay // Maximum per-GP-phase consecutive no-delay instances.
5944f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE	\
5954f2bfd94SNeeraj Upadhyay 	SRCU_UL_CLAMP(SRCU_DEFAULT_MAX_NODELAY_PHASE_ADJUSTED,	\
5964f2bfd94SNeeraj Upadhyay 		      SRCU_DEFAULT_MAX_NODELAY_PHASE_LO,	\
5974f2bfd94SNeeraj Upadhyay 		      SRCU_DEFAULT_MAX_NODELAY_PHASE_HI)
5984f2bfd94SNeeraj Upadhyay 
5994f2bfd94SNeeraj Upadhyay static ulong srcu_max_nodelay_phase = SRCU_DEFAULT_MAX_NODELAY_PHASE;
6004f2bfd94SNeeraj Upadhyay module_param(srcu_max_nodelay_phase, ulong, 0444);
6014f2bfd94SNeeraj Upadhyay 
6024f2bfd94SNeeraj Upadhyay // Maximum consecutive no-delay instances.
6034f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY	(SRCU_DEFAULT_MAX_NODELAY_PHASE > 100 ?	\
6044f2bfd94SNeeraj Upadhyay 					 SRCU_DEFAULT_MAX_NODELAY_PHASE : 100)
6054f2bfd94SNeeraj Upadhyay 
6064f2bfd94SNeeraj Upadhyay static ulong srcu_max_nodelay = SRCU_DEFAULT_MAX_NODELAY;
6074f2bfd94SNeeraj Upadhyay module_param(srcu_max_nodelay, ulong, 0444);
608dad81a20SPaul E. McKenney 
6091e9a038bSPaul E. McKenney /*
6101e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
6111e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
6121e9a038bSPaul E. McKenney  */
613aacb5d91SPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *ssp)
6141e9a038bSPaul E. McKenney {
6158f870e6eSPaul E. McKenney 	unsigned long gpstart;
6168f870e6eSPaul E. McKenney 	unsigned long j;
617282d8998SPaul E. McKenney 	unsigned long jbase = SRCU_INTERVAL;
618282d8998SPaul E. McKenney 
61903200b5cSPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_sup->srcu_gp_seq), READ_ONCE(ssp->srcu_sup->srcu_gp_seq_needed_exp)))
620282d8998SPaul E. McKenney 		jbase = 0;
62103200b5cSPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_sup->srcu_gp_seq))) {
6228f870e6eSPaul E. McKenney 		j = jiffies - 1;
62303200b5cSPaul E. McKenney 		gpstart = READ_ONCE(ssp->srcu_sup->srcu_gp_start);
6248f870e6eSPaul E. McKenney 		if (time_after(j, gpstart))
6258f870e6eSPaul E. McKenney 			jbase += j - gpstart;
626282d8998SPaul E. McKenney 		if (!jbase) {
627*3b46679cSPaul E. McKenney 			WRITE_ONCE(ssp->srcu_sup->srcu_n_exp_nodelay, READ_ONCE(ssp->srcu_sup->srcu_n_exp_nodelay) + 1);
628*3b46679cSPaul E. McKenney 			if (READ_ONCE(ssp->srcu_sup->srcu_n_exp_nodelay) > srcu_max_nodelay_phase)
629282d8998SPaul E. McKenney 				jbase = 1;
630282d8998SPaul E. McKenney 		}
6318f870e6eSPaul E. McKenney 	}
632282d8998SPaul E. McKenney 	return jbase > SRCU_MAX_INTERVAL ? SRCU_MAX_INTERVAL : jbase;
6331e9a038bSPaul E. McKenney }
6341e9a038bSPaul E. McKenney 
635f5ad3991SPaul E. McKenney /**
636f5ad3991SPaul E. McKenney  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
637f5ad3991SPaul E. McKenney  * @ssp: structure to clean up.
638f5ad3991SPaul E. McKenney  *
639f5ad3991SPaul E. McKenney  * Must invoke this after you are finished using a given srcu_struct that
640f5ad3991SPaul E. McKenney  * was initialized via init_srcu_struct(), else you leak memory.
641f5ad3991SPaul E. McKenney  */
642f5ad3991SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *ssp)
643dad81a20SPaul E. McKenney {
644da915ad5SPaul E. McKenney 	int cpu;
645da915ad5SPaul E. McKenney 
646aacb5d91SPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(ssp)))
647f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
648aacb5d91SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(ssp)))
649f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
650aacb5d91SPaul E. McKenney 	flush_delayed_work(&ssp->work);
651e81baf4cSSebastian Andrzej Siewior 	for_each_possible_cpu(cpu) {
652e81baf4cSSebastian Andrzej Siewior 		struct srcu_data *sdp = per_cpu_ptr(ssp->sda, cpu);
653e81baf4cSSebastian Andrzej Siewior 
654e81baf4cSSebastian Andrzej Siewior 		del_timer_sync(&sdp->delay_work);
655e81baf4cSSebastian Andrzej Siewior 		flush_work(&sdp->work);
6565cdfd174SPaul E. McKenney 		if (WARN_ON(rcu_segcblist_n_cbs(&sdp->srcu_cblist)))
6575cdfd174SPaul E. McKenney 			return; /* Forgot srcu_barrier(), so just leak it! */
658f7194ac3SPaul E. McKenney 	}
65903200b5cSPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(ssp->srcu_sup->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
66003200b5cSPaul E. McKenney 	    WARN_ON(rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq) != ssp->srcu_sup->srcu_gp_seq_needed) ||
661aacb5d91SPaul E. McKenney 	    WARN_ON(srcu_readers_active(ssp))) {
6628ed00760SPaul E. McKenney 		pr_info("%s: Active srcu_struct %p read state: %d gp state: %lu/%lu\n",
66303200b5cSPaul E. McKenney 			__func__, ssp, rcu_seq_state(READ_ONCE(ssp->srcu_sup->srcu_gp_seq)),
66403200b5cSPaul E. McKenney 			rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq), ssp->srcu_sup->srcu_gp_seq_needed);
665dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
666dad81a20SPaul E. McKenney 	}
66795433f72SPaul E. McKenney 	kfree(ssp->srcu_sup->node);
66895433f72SPaul E. McKenney 	ssp->srcu_sup->node = NULL;
669a0d8cbd3SPaul E. McKenney 	ssp->srcu_sup->srcu_size_state = SRCU_SIZE_SMALL;
67046470cf8SPaul E. McKenney 	if (!ssp->sda_is_static) {
671aacb5d91SPaul E. McKenney 		free_percpu(ssp->sda);
672aacb5d91SPaul E. McKenney 		ssp->sda = NULL;
67395433f72SPaul E. McKenney 		kfree(ssp->srcu_sup);
67495433f72SPaul E. McKenney 		ssp->srcu_sup = NULL;
67546470cf8SPaul E. McKenney 	}
676dad81a20SPaul E. McKenney }
677f5ad3991SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
678dad81a20SPaul E. McKenney 
679e29a4915SFrederic Weisbecker #ifdef CONFIG_PROVE_RCU
680dad81a20SPaul E. McKenney /*
68127120e7dSPaul E. McKenney  * Check for consistent NMI safety.
68227120e7dSPaul E. McKenney  */
683e29a4915SFrederic Weisbecker void srcu_check_nmi_safety(struct srcu_struct *ssp, bool nmi_safe)
68427120e7dSPaul E. McKenney {
68527120e7dSPaul E. McKenney 	int nmi_safe_mask = 1 << nmi_safe;
68627120e7dSPaul E. McKenney 	int old_nmi_safe_mask;
68727120e7dSPaul E. McKenney 	struct srcu_data *sdp;
68827120e7dSPaul E. McKenney 
6896b77bb9bSFrederic Weisbecker 	/* NMI-unsafe use in NMI is a bad sign */
6906b77bb9bSFrederic Weisbecker 	WARN_ON_ONCE(!nmi_safe && in_nmi());
69127120e7dSPaul E. McKenney 	sdp = raw_cpu_ptr(ssp->sda);
69227120e7dSPaul E. McKenney 	old_nmi_safe_mask = READ_ONCE(sdp->srcu_nmi_safety);
69327120e7dSPaul E. McKenney 	if (!old_nmi_safe_mask) {
69427120e7dSPaul E. McKenney 		WRITE_ONCE(sdp->srcu_nmi_safety, nmi_safe_mask);
69527120e7dSPaul E. McKenney 		return;
69627120e7dSPaul E. McKenney 	}
69727120e7dSPaul E. McKenney 	WARN_ONCE(old_nmi_safe_mask != nmi_safe_mask, "CPU %d old state %d new state %d\n", sdp->cpu, old_nmi_safe_mask, nmi_safe_mask);
69827120e7dSPaul E. McKenney }
699e29a4915SFrederic Weisbecker EXPORT_SYMBOL_GPL(srcu_check_nmi_safety);
700e29a4915SFrederic Weisbecker #endif /* CONFIG_PROVE_RCU */
70127120e7dSPaul E. McKenney 
70227120e7dSPaul E. McKenney /*
703dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
704cdf7abc4SPaolo Bonzini  * srcu_struct.
705dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
706dad81a20SPaul E. McKenney  */
707aacb5d91SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *ssp)
708dad81a20SPaul E. McKenney {
709dad81a20SPaul E. McKenney 	int idx;
710dad81a20SPaul E. McKenney 
711aacb5d91SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
7125d0f5953SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_lock_count[idx].counter);
713dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
714dad81a20SPaul E. McKenney 	return idx;
715dad81a20SPaul E. McKenney }
716dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
717dad81a20SPaul E. McKenney 
718dad81a20SPaul E. McKenney /*
719dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
720dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
721dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
722dad81a20SPaul E. McKenney  */
723aacb5d91SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *ssp, int idx)
724dad81a20SPaul E. McKenney {
725dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
7265d0f5953SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_unlock_count[idx].counter);
727dad81a20SPaul E. McKenney }
728dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
729dad81a20SPaul E. McKenney 
7302e83b879SPaul E. McKenney #ifdef CONFIG_NEED_SRCU_NMI_SAFE
7312e83b879SPaul E. McKenney 
7322e83b879SPaul E. McKenney /*
7332e83b879SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
7342e83b879SPaul E. McKenney  * srcu_struct, but in an NMI-safe manner using RMW atomics.
7352e83b879SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
7362e83b879SPaul E. McKenney  */
737e29a4915SFrederic Weisbecker int __srcu_read_lock_nmisafe(struct srcu_struct *ssp)
7382e83b879SPaul E. McKenney {
7392e83b879SPaul E. McKenney 	int idx;
7402e83b879SPaul E. McKenney 	struct srcu_data *sdp = raw_cpu_ptr(ssp->sda);
7412e83b879SPaul E. McKenney 
7422e83b879SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
7432e83b879SPaul E. McKenney 	atomic_long_inc(&sdp->srcu_lock_count[idx]);
7442e83b879SPaul E. McKenney 	smp_mb__after_atomic(); /* B */  /* Avoid leaking the critical section. */
7452e83b879SPaul E. McKenney 	return idx;
7462e83b879SPaul E. McKenney }
7472e83b879SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock_nmisafe);
7482e83b879SPaul E. McKenney 
7492e83b879SPaul E. McKenney /*
7502e83b879SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
7512e83b879SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
7522e83b879SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
7532e83b879SPaul E. McKenney  */
754e29a4915SFrederic Weisbecker void __srcu_read_unlock_nmisafe(struct srcu_struct *ssp, int idx)
7552e83b879SPaul E. McKenney {
7562e83b879SPaul E. McKenney 	struct srcu_data *sdp = raw_cpu_ptr(ssp->sda);
7572e83b879SPaul E. McKenney 
7582e83b879SPaul E. McKenney 	smp_mb__before_atomic(); /* C */  /* Avoid leaking the critical section. */
7592e83b879SPaul E. McKenney 	atomic_long_inc(&sdp->srcu_unlock_count[idx]);
7602e83b879SPaul E. McKenney }
7612e83b879SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock_nmisafe);
7622e83b879SPaul E. McKenney 
7632e83b879SPaul E. McKenney #endif // CONFIG_NEED_SRCU_NMI_SAFE
7642e83b879SPaul E. McKenney 
765dad81a20SPaul E. McKenney /*
766dad81a20SPaul E. McKenney  * Start an SRCU grace period.
767dad81a20SPaul E. McKenney  */
768aacb5d91SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *ssp)
769dad81a20SPaul E. McKenney {
770586e31d5SLukas Bulwahn 	struct srcu_data *sdp;
771dad81a20SPaul E. McKenney 	int state;
772dad81a20SPaul E. McKenney 
773a0d8cbd3SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_sup->srcu_size_state) < SRCU_SIZE_WAIT_BARRIER)
7747f24626dSPingfan Liu 		sdp = per_cpu_ptr(ssp->sda, get_boot_cpu_id());
775994f7068SPaul E. McKenney 	else
776994f7068SPaul E. McKenney 		sdp = this_cpu_ptr(ssp->sda);
777b3fb11f7SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp->srcu_sup, lock));
77803200b5cSPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_sup->srcu_gp_seq, ssp->srcu_sup->srcu_gp_seq_needed));
779eb4c2382SDennis Krein 	spin_lock_rcu_node(sdp);  /* Interrupts already disabled. */
780da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
78103200b5cSPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq));
782da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
78303200b5cSPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_sup->srcu_gp_seq));
784eb4c2382SDennis Krein 	spin_unlock_rcu_node(sdp);  /* Interrupts remain disabled. */
78503200b5cSPaul E. McKenney 	WRITE_ONCE(ssp->srcu_sup->srcu_gp_start, jiffies);
786*3b46679cSPaul E. McKenney 	WRITE_ONCE(ssp->srcu_sup->srcu_n_exp_nodelay, 0);
7872da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
78803200b5cSPaul E. McKenney 	rcu_seq_start(&ssp->srcu_sup->srcu_gp_seq);
78903200b5cSPaul E. McKenney 	state = rcu_seq_state(ssp->srcu_sup->srcu_gp_seq);
790dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
791dad81a20SPaul E. McKenney }
792dad81a20SPaul E. McKenney 
793da915ad5SPaul E. McKenney 
794e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t)
795da915ad5SPaul E. McKenney {
796e81baf4cSSebastian Andrzej Siewior 	struct srcu_data *sdp = container_of(t, struct srcu_data, delay_work);
797e81baf4cSSebastian Andrzej Siewior 
798e81baf4cSSebastian Andrzej Siewior 	queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
799da915ad5SPaul E. McKenney }
800da915ad5SPaul E. McKenney 
801e81baf4cSSebastian Andrzej Siewior static void srcu_queue_delayed_work_on(struct srcu_data *sdp,
802da915ad5SPaul E. McKenney 				       unsigned long delay)
803da915ad5SPaul E. McKenney {
804e81baf4cSSebastian Andrzej Siewior 	if (!delay) {
805e81baf4cSSebastian Andrzej Siewior 		queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
806e81baf4cSSebastian Andrzej Siewior 		return;
807e81baf4cSSebastian Andrzej Siewior 	}
808da915ad5SPaul E. McKenney 
809e81baf4cSSebastian Andrzej Siewior 	timer_reduce(&sdp->delay_work, jiffies + delay);
810da915ad5SPaul E. McKenney }
811da915ad5SPaul E. McKenney 
812da915ad5SPaul E. McKenney /*
813da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
814da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
815da915ad5SPaul E. McKenney  */
816da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
817da915ad5SPaul E. McKenney {
818e81baf4cSSebastian Andrzej Siewior 	srcu_queue_delayed_work_on(sdp, delay);
819da915ad5SPaul E. McKenney }
820da915ad5SPaul E. McKenney 
821da915ad5SPaul E. McKenney /*
822da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
823c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
824c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
825c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
826da915ad5SPaul E. McKenney  */
827aacb5d91SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *ssp, struct srcu_node *snp,
8281e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
829da915ad5SPaul E. McKenney {
830da915ad5SPaul E. McKenney 	int cpu;
831da915ad5SPaul E. McKenney 
832c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
833c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
834c7e88067SPaul E. McKenney 			continue;
835aacb5d91SPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, cpu), delay);
836da915ad5SPaul E. McKenney 	}
837c7e88067SPaul E. McKenney }
838da915ad5SPaul E. McKenney 
839da915ad5SPaul E. McKenney /*
840da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
841da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
842da915ad5SPaul E. McKenney  *
843da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
844da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
845da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
846da915ad5SPaul E. McKenney  * array to have a finite number of elements.
847da915ad5SPaul E. McKenney  */
848aacb5d91SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *ssp)
849da915ad5SPaul E. McKenney {
8504f2bfd94SNeeraj Upadhyay 	unsigned long cbdelay = 1;
851da915ad5SPaul E. McKenney 	bool cbs;
8528ddbd883SIldar Ismagilov 	bool last_lvl;
853c350c008SPaul E. McKenney 	int cpu;
854c350c008SPaul E. McKenney 	unsigned long flags;
855da915ad5SPaul E. McKenney 	unsigned long gpseq;
856da915ad5SPaul E. McKenney 	int idx;
857c7e88067SPaul E. McKenney 	unsigned long mask;
858c350c008SPaul E. McKenney 	struct srcu_data *sdp;
859cbdc98e9SPaul E. McKenney 	unsigned long sgsne;
860da915ad5SPaul E. McKenney 	struct srcu_node *snp;
861e2f63836SPaul E. McKenney 	int ss_state;
862da915ad5SPaul E. McKenney 
863da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
864574dc1a7SPaul E. McKenney 	mutex_lock(&ssp->srcu_sup->srcu_cb_mutex);
865da915ad5SPaul E. McKenney 
866da915ad5SPaul E. McKenney 	/* End the current grace period. */
867b3fb11f7SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp->srcu_sup);
86803200b5cSPaul E. McKenney 	idx = rcu_seq_state(ssp->srcu_sup->srcu_gp_seq);
869da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
87003200b5cSPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_sup->srcu_gp_seq), READ_ONCE(ssp->srcu_sup->srcu_gp_seq_needed_exp)))
8714f2bfd94SNeeraj Upadhyay 		cbdelay = 0;
8724f2bfd94SNeeraj Upadhyay 
87303200b5cSPaul E. McKenney 	WRITE_ONCE(ssp->srcu_sup->srcu_last_gp_end, ktime_get_mono_fast_ns());
87403200b5cSPaul E. McKenney 	rcu_seq_end(&ssp->srcu_sup->srcu_gp_seq);
87503200b5cSPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq);
87603200b5cSPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_sup->srcu_gp_seq_needed_exp, gpseq))
87703200b5cSPaul E. McKenney 		WRITE_ONCE(ssp->srcu_sup->srcu_gp_seq_needed_exp, gpseq);
878b3fb11f7SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp->srcu_sup);
879e3a6ab25SPaul E. McKenney 	mutex_unlock(&ssp->srcu_sup->srcu_gp_mutex);
880da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
881da915ad5SPaul E. McKenney 
882da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
883a0d8cbd3SPaul E. McKenney 	ss_state = smp_load_acquire(&ssp->srcu_sup->srcu_size_state);
884c69a00a1SPaul E. McKenney 	if (ss_state < SRCU_SIZE_WAIT_BARRIER) {
8857f24626dSPingfan Liu 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, get_boot_cpu_id()),
8867f24626dSPingfan Liu 					cbdelay);
887994f7068SPaul E. McKenney 	} else {
888da915ad5SPaul E. McKenney 		idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
889aacb5d91SPaul E. McKenney 		srcu_for_each_node_breadth_first(ssp, snp) {
890d6331980SPaul E. McKenney 			spin_lock_irq_rcu_node(snp);
891da915ad5SPaul E. McKenney 			cbs = false;
892208f41b1SPaul E. McKenney 			last_lvl = snp >= ssp->srcu_sup->level[rcu_num_lvls - 1];
8938ddbd883SIldar Ismagilov 			if (last_lvl)
894c69a00a1SPaul E. McKenney 				cbs = ss_state < SRCU_SIZE_BIG || snp->srcu_have_cbs[idx] == gpseq;
895da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[idx] = gpseq;
896da915ad5SPaul E. McKenney 			rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
897cbdc98e9SPaul E. McKenney 			sgsne = snp->srcu_gp_seq_needed_exp;
898cbdc98e9SPaul E. McKenney 			if (srcu_invl_snp_seq(sgsne) || ULONG_CMP_LT(sgsne, gpseq))
8997ff8b450SPaul E. McKenney 				WRITE_ONCE(snp->srcu_gp_seq_needed_exp, gpseq);
900c69a00a1SPaul E. McKenney 			if (ss_state < SRCU_SIZE_BIG)
901c69a00a1SPaul E. McKenney 				mask = ~0;
902c69a00a1SPaul E. McKenney 			else
903c7e88067SPaul E. McKenney 				mask = snp->srcu_data_have_cbs[idx];
904c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] = 0;
905d6331980SPaul E. McKenney 			spin_unlock_irq_rcu_node(snp);
906a3883df3SPaul E. McKenney 			if (cbs)
907aacb5d91SPaul E. McKenney 				srcu_schedule_cbs_snp(ssp, snp, mask, cbdelay);
908994f7068SPaul E. McKenney 		}
909994f7068SPaul E. McKenney 	}
910c350c008SPaul E. McKenney 
911c350c008SPaul E. McKenney 	/* Occasionally prevent srcu_data counter wrap. */
912994f7068SPaul E. McKenney 	if (!(gpseq & counter_wrap_check))
913994f7068SPaul E. McKenney 		for_each_possible_cpu(cpu) {
914aacb5d91SPaul E. McKenney 			sdp = per_cpu_ptr(ssp->sda, cpu);
915d6331980SPaul E. McKenney 			spin_lock_irqsave_rcu_node(sdp, flags);
916994f7068SPaul E. McKenney 			if (ULONG_CMP_GE(gpseq, sdp->srcu_gp_seq_needed + 100))
917c350c008SPaul E. McKenney 				sdp->srcu_gp_seq_needed = gpseq;
918994f7068SPaul E. McKenney 			if (ULONG_CMP_GE(gpseq, sdp->srcu_gp_seq_needed_exp + 100))
919a35d13ecSIldar Ismagilov 				sdp->srcu_gp_seq_needed_exp = gpseq;
920d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(sdp, flags);
921c350c008SPaul E. McKenney 		}
922da915ad5SPaul E. McKenney 
923da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
924574dc1a7SPaul E. McKenney 	mutex_unlock(&ssp->srcu_sup->srcu_cb_mutex);
925da915ad5SPaul E. McKenney 
926da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
927b3fb11f7SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp->srcu_sup);
92803200b5cSPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq);
929da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
93003200b5cSPaul E. McKenney 	    ULONG_CMP_LT(gpseq, ssp->srcu_sup->srcu_gp_seq_needed)) {
931aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
932b3fb11f7SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp->srcu_sup);
933aacb5d91SPaul E. McKenney 		srcu_reschedule(ssp, 0);
934da915ad5SPaul E. McKenney 	} else {
935b3fb11f7SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp->srcu_sup);
936da915ad5SPaul E. McKenney 	}
937e2f63836SPaul E. McKenney 
938e2f63836SPaul E. McKenney 	/* Transition to big if needed. */
939e2f63836SPaul E. McKenney 	if (ss_state != SRCU_SIZE_SMALL && ss_state != SRCU_SIZE_BIG) {
940e2f63836SPaul E. McKenney 		if (ss_state == SRCU_SIZE_ALLOC)
941c69a00a1SPaul E. McKenney 			init_srcu_struct_nodes(ssp, GFP_KERNEL);
942e2f63836SPaul E. McKenney 		else
943a0d8cbd3SPaul E. McKenney 			smp_store_release(&ssp->srcu_sup->srcu_size_state, ss_state + 1);
944e2f63836SPaul E. McKenney 	}
945da915ad5SPaul E. McKenney }
946da915ad5SPaul E. McKenney 
947da915ad5SPaul E. McKenney /*
9481e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
9491e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
9501e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
9511e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
9521e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
9531e9a038bSPaul E. McKenney  */
954aacb5d91SPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *ssp, struct srcu_node *snp,
9551e9a038bSPaul E. McKenney 				  unsigned long s)
9561e9a038bSPaul E. McKenney {
9571e9a038bSPaul E. McKenney 	unsigned long flags;
958cbdc98e9SPaul E. McKenney 	unsigned long sgsne;
9591e9a038bSPaul E. McKenney 
960994f7068SPaul E. McKenney 	if (snp)
9611e9a038bSPaul E. McKenney 		for (; snp != NULL; snp = snp->srcu_parent) {
962cbdc98e9SPaul E. McKenney 			sgsne = READ_ONCE(snp->srcu_gp_seq_needed_exp);
96303200b5cSPaul E. McKenney 			if (WARN_ON_ONCE(rcu_seq_done(&ssp->srcu_sup->srcu_gp_seq, s)) ||
964cbdc98e9SPaul E. McKenney 			    (!srcu_invl_snp_seq(sgsne) && ULONG_CMP_GE(sgsne, s)))
9651e9a038bSPaul E. McKenney 				return;
966d6331980SPaul E. McKenney 			spin_lock_irqsave_rcu_node(snp, flags);
967cbdc98e9SPaul E. McKenney 			sgsne = snp->srcu_gp_seq_needed_exp;
968cbdc98e9SPaul E. McKenney 			if (!srcu_invl_snp_seq(sgsne) && ULONG_CMP_GE(sgsne, s)) {
969d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(snp, flags);
9701e9a038bSPaul E. McKenney 				return;
9711e9a038bSPaul E. McKenney 			}
9721e9a038bSPaul E. McKenney 			WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
973d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
9741e9a038bSPaul E. McKenney 		}
9759f2e91d9SPaul E. McKenney 	spin_lock_irqsave_ssp_contention(ssp, &flags);
97603200b5cSPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_sup->srcu_gp_seq_needed_exp, s))
97703200b5cSPaul E. McKenney 		WRITE_ONCE(ssp->srcu_sup->srcu_gp_seq_needed_exp, s);
978b3fb11f7SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, flags);
9791e9a038bSPaul E. McKenney }
9801e9a038bSPaul E. McKenney 
9811e9a038bSPaul E. McKenney /*
982da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
983da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
984da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
985da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
986da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
98717294ce6SPaul E. McKenney  *
98817294ce6SPaul E. McKenney  * Note that this function also does the work of srcu_funnel_exp_start(),
98917294ce6SPaul E. McKenney  * in some cases by directly invoking it.
9901bafbfb3SPingfan Liu  *
9911bafbfb3SPingfan Liu  * The srcu read lock should be hold around this function. And s is a seq snap
9921bafbfb3SPingfan Liu  * after holding that lock.
993da915ad5SPaul E. McKenney  */
994aacb5d91SPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *ssp, struct srcu_data *sdp,
9951e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
996da915ad5SPaul E. McKenney {
997da915ad5SPaul E. McKenney 	unsigned long flags;
998da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
999cbdc98e9SPaul E. McKenney 	unsigned long sgsne;
10007b9e9b58SPaul E. McKenney 	struct srcu_node *snp;
10010b56f953SNeeraj Upadhyay 	struct srcu_node *snp_leaf;
1002da915ad5SPaul E. McKenney 	unsigned long snp_seq;
1003da915ad5SPaul E. McKenney 
10040b56f953SNeeraj Upadhyay 	/* Ensure that snp node tree is fully initialized before traversing it */
1005a0d8cbd3SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_sup->srcu_size_state) < SRCU_SIZE_WAIT_BARRIER)
10060b56f953SNeeraj Upadhyay 		snp_leaf = NULL;
10070b56f953SNeeraj Upadhyay 	else
10080b56f953SNeeraj Upadhyay 		snp_leaf = sdp->mynode;
10090b56f953SNeeraj Upadhyay 
1010994f7068SPaul E. McKenney 	if (snp_leaf)
1011da915ad5SPaul E. McKenney 		/* Each pass through the loop does one level of the srcu_node tree. */
10127b9e9b58SPaul E. McKenney 		for (snp = snp_leaf; snp != NULL; snp = snp->srcu_parent) {
101303200b5cSPaul E. McKenney 			if (WARN_ON_ONCE(rcu_seq_done(&ssp->srcu_sup->srcu_gp_seq, s)) && snp != snp_leaf)
1014da915ad5SPaul E. McKenney 				return; /* GP already done and CBs recorded. */
1015d6331980SPaul E. McKenney 			spin_lock_irqsave_rcu_node(snp, flags);
1016da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
1017cbdc98e9SPaul E. McKenney 			if (!srcu_invl_snp_seq(snp_seq) && ULONG_CMP_GE(snp_seq, s)) {
10187b9e9b58SPaul E. McKenney 				if (snp == snp_leaf && snp_seq == s)
1019c7e88067SPaul E. McKenney 					snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
1020d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(snp, flags);
10217b9e9b58SPaul E. McKenney 				if (snp == snp_leaf && snp_seq != s) {
1022aeb9b39bSPaul E. McKenney 					srcu_schedule_cbs_sdp(sdp, do_norm ? SRCU_INTERVAL : 0);
10231e9a038bSPaul E. McKenney 					return;
1024da915ad5SPaul E. McKenney 				}
10251e9a038bSPaul E. McKenney 				if (!do_norm)
1026aacb5d91SPaul E. McKenney 					srcu_funnel_exp_start(ssp, snp, s);
1027da915ad5SPaul E. McKenney 				return;
1028da915ad5SPaul E. McKenney 			}
1029da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[idx] = s;
10307b9e9b58SPaul E. McKenney 			if (snp == snp_leaf)
1031c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
1032cbdc98e9SPaul E. McKenney 			sgsne = snp->srcu_gp_seq_needed_exp;
1033cbdc98e9SPaul E. McKenney 			if (!do_norm && (srcu_invl_snp_seq(sgsne) || ULONG_CMP_LT(sgsne, s)))
10347ff8b450SPaul E. McKenney 				WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
1035d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
1036da915ad5SPaul E. McKenney 		}
1037da915ad5SPaul E. McKenney 
1038da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
10399f2e91d9SPaul E. McKenney 	spin_lock_irqsave_ssp_contention(ssp, &flags);
104003200b5cSPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_sup->srcu_gp_seq_needed, s)) {
1041da915ad5SPaul E. McKenney 		/*
1042da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
1043da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
1044da915ad5SPaul E. McKenney 		 */
104503200b5cSPaul E. McKenney 		smp_store_release(&ssp->srcu_sup->srcu_gp_seq_needed, s); /*^^^*/
1046da915ad5SPaul E. McKenney 	}
104703200b5cSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(ssp->srcu_sup->srcu_gp_seq_needed_exp, s))
104803200b5cSPaul E. McKenney 		WRITE_ONCE(ssp->srcu_sup->srcu_gp_seq_needed_exp, s);
1049da915ad5SPaul E. McKenney 
10501bafbfb3SPingfan Liu 	/* If grace period not already in progress, start it. */
105103200b5cSPaul E. McKenney 	if (!WARN_ON_ONCE(rcu_seq_done(&ssp->srcu_sup->srcu_gp_seq, s)) &&
105203200b5cSPaul E. McKenney 	    rcu_seq_state(ssp->srcu_sup->srcu_gp_seq) == SRCU_STATE_IDLE) {
105303200b5cSPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_sup->srcu_gp_seq, ssp->srcu_sup->srcu_gp_seq_needed));
1054aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
1055ee5e2448SPaul E. McKenney 
1056ee5e2448SPaul E. McKenney 		// And how can that list_add() in the "else" clause
1057ee5e2448SPaul E. McKenney 		// possibly be safe for concurrent execution?  Well,
1058ee5e2448SPaul E. McKenney 		// it isn't.  And it does not have to be.  After all, it
1059ee5e2448SPaul E. McKenney 		// can only be executed during early boot when there is only
1060ee5e2448SPaul E. McKenney 		// the one boot CPU running with interrupts still disabled.
1061e0fcba9aSPaul E. McKenney 		if (likely(srcu_init_done))
1062aacb5d91SPaul E. McKenney 			queue_delayed_work(rcu_gp_wq, &ssp->work,
1063282d8998SPaul E. McKenney 					   !!srcu_get_delay(ssp));
1064aacb5d91SPaul E. McKenney 		else if (list_empty(&ssp->work.work.entry))
1065aacb5d91SPaul E. McKenney 			list_add(&ssp->work.work.entry, &srcu_boot_list);
1066da915ad5SPaul E. McKenney 	}
1067b3fb11f7SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp->srcu_sup, flags);
1068da915ad5SPaul E. McKenney }
1069da915ad5SPaul E. McKenney 
1070da915ad5SPaul E. McKenney /*
1071dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
1072dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
1073da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
1074dad81a20SPaul E. McKenney  */
1075aacb5d91SPaul E. McKenney static bool try_check_zero(struct srcu_struct *ssp, int idx, int trycount)
1076dad81a20SPaul E. McKenney {
10774f2bfd94SNeeraj Upadhyay 	unsigned long curdelay;
10784f2bfd94SNeeraj Upadhyay 
10794f2bfd94SNeeraj Upadhyay 	curdelay = !srcu_get_delay(ssp);
10804f2bfd94SNeeraj Upadhyay 
1081dad81a20SPaul E. McKenney 	for (;;) {
1082aacb5d91SPaul E. McKenney 		if (srcu_readers_active_idx_check(ssp, idx))
1083dad81a20SPaul E. McKenney 			return true;
10844f2bfd94SNeeraj Upadhyay 		if ((--trycount + curdelay) <= 0)
1085dad81a20SPaul E. McKenney 			return false;
10864f2bfd94SNeeraj Upadhyay 		udelay(srcu_retry_check_delay);
1087dad81a20SPaul E. McKenney 	}
1088dad81a20SPaul E. McKenney }
1089dad81a20SPaul E. McKenney 
1090dad81a20SPaul E. McKenney /*
1091da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
1092da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
1093dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
1094dad81a20SPaul E. McKenney  */
1095aacb5d91SPaul E. McKenney static void srcu_flip(struct srcu_struct *ssp)
1096dad81a20SPaul E. McKenney {
1097881ec9d2SPaul E. McKenney 	/*
1098881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
1099881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
1100881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
1101881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
1102881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
1103881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
1104881ec9d2SPaul E. McKenney 	 */
1105881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
1106881ec9d2SPaul E. McKenney 
1107aacb5d91SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_idx, ssp->srcu_idx + 1);
1108dad81a20SPaul E. McKenney 
1109dad81a20SPaul E. McKenney 	/*
1110dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
1111dafc4d16SPaul E. McKenney 	 * increment, that task's __srcu_read_lock() following its next
1112dafc4d16SPaul E. McKenney 	 * __srcu_read_lock() or __srcu_read_unlock() will see the above
1113dafc4d16SPaul E. McKenney 	 * counter update.  Note that both this memory barrier and the
1114dafc4d16SPaul E. McKenney 	 * one in srcu_readers_active_idx_check() provide the guarantee
1115dafc4d16SPaul E. McKenney 	 * for __srcu_read_lock().
1116dad81a20SPaul E. McKenney 	 */
1117dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
1118dad81a20SPaul E. McKenney }
1119dad81a20SPaul E. McKenney 
1120dad81a20SPaul E. McKenney /*
11212da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
11222da4b2a7SPaul E. McKenney  *
11232da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
11242da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
11252da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
11262da4b2a7SPaul E. McKenney  *
11272da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
11282da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
11292da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
11302da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
11312da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
11322da4b2a7SPaul E. McKenney  * but to accept this type of error.
11332da4b2a7SPaul E. McKenney  *
11342da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
11352da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
11362da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
11372da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
11387fef6cffSEthon Paul  * negligible when amortized over that time period, and the extra latency
11392da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
11402da4b2a7SPaul E. McKenney  */
1141aacb5d91SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *ssp)
11422da4b2a7SPaul E. McKenney {
114322607d66SPaul E. McKenney 	unsigned long curseq;
11442da4b2a7SPaul E. McKenney 	unsigned long flags;
11452da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
114622607d66SPaul E. McKenney 	unsigned long t;
1147844a378dSPaul E. McKenney 	unsigned long tlast;
11482da4b2a7SPaul E. McKenney 
1149bde50d8fSSebastian Andrzej Siewior 	check_init_srcu_struct(ssp);
11502da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
1151bde50d8fSSebastian Andrzej Siewior 	sdp = raw_cpu_ptr(ssp->sda);
1152bde50d8fSSebastian Andrzej Siewior 	spin_lock_irqsave_rcu_node(sdp, flags);
11532da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
1154bde50d8fSSebastian Andrzej Siewior 		spin_unlock_irqrestore_rcu_node(sdp, flags);
11552da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
11562da4b2a7SPaul E. McKenney 	}
1157bde50d8fSSebastian Andrzej Siewior 	spin_unlock_irqrestore_rcu_node(sdp, flags);
11582da4b2a7SPaul E. McKenney 
11592da4b2a7SPaul E. McKenney 	/*
1160a616aec9SIngo Molnar 	 * No local callbacks, so probabilistically probe global state.
11612da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
1162a616aec9SIngo Molnar 	 * kill scalability, hence the probabilistic nature of the probe.
11632da4b2a7SPaul E. McKenney 	 */
116422607d66SPaul E. McKenney 
116522607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
116622607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
116703200b5cSPaul E. McKenney 	tlast = READ_ONCE(ssp->srcu_sup->srcu_last_gp_end);
116822607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
1169844a378dSPaul E. McKenney 	    time_in_range_open(t, tlast, tlast + exp_holdoff))
117022607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
117122607d66SPaul E. McKenney 
117222607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
117303200b5cSPaul E. McKenney 	curseq = rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq);
11742da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
117503200b5cSPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(ssp->srcu_sup->srcu_gp_seq_needed)))
11762da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
11772da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
117803200b5cSPaul E. McKenney 	if (curseq != rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq))
11792da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
11802da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
11812da4b2a7SPaul E. McKenney }
11822da4b2a7SPaul E. McKenney 
11832da4b2a7SPaul E. McKenney /*
1184a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
1185a602538eSPaul E. McKenney  */
1186a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
1187a602538eSPaul E. McKenney {
1188a602538eSPaul E. McKenney }
1189a602538eSPaul E. McKenney 
1190a602538eSPaul E. McKenney /*
119129d2bb94SPaul E. McKenney  * Start an SRCU grace period, and also queue the callback if non-NULL.
119229d2bb94SPaul E. McKenney  */
11935358c9faSPaul E. McKenney static unsigned long srcu_gp_start_if_needed(struct srcu_struct *ssp,
11945358c9faSPaul E. McKenney 					     struct rcu_head *rhp, bool do_norm)
119529d2bb94SPaul E. McKenney {
119629d2bb94SPaul E. McKenney 	unsigned long flags;
119729d2bb94SPaul E. McKenney 	int idx;
119829d2bb94SPaul E. McKenney 	bool needexp = false;
119929d2bb94SPaul E. McKenney 	bool needgp = false;
120029d2bb94SPaul E. McKenney 	unsigned long s;
120129d2bb94SPaul E. McKenney 	struct srcu_data *sdp;
12020b56f953SNeeraj Upadhyay 	struct srcu_node *sdp_mynode;
12030b56f953SNeeraj Upadhyay 	int ss_state;
120429d2bb94SPaul E. McKenney 
12055358c9faSPaul E. McKenney 	check_init_srcu_struct(ssp);
1206ae3c0706SFrederic Weisbecker 	/*
1207ae3c0706SFrederic Weisbecker 	 * While starting a new grace period, make sure we are in an
1208ae3c0706SFrederic Weisbecker 	 * SRCU read-side critical section so that the grace-period
1209ae3c0706SFrederic Weisbecker 	 * sequence number cannot wrap around in the meantime.
1210ae3c0706SFrederic Weisbecker 	 */
1211e29a4915SFrederic Weisbecker 	idx = __srcu_read_lock_nmisafe(ssp);
1212a0d8cbd3SPaul E. McKenney 	ss_state = smp_load_acquire(&ssp->srcu_sup->srcu_size_state);
12130b56f953SNeeraj Upadhyay 	if (ss_state < SRCU_SIZE_WAIT_CALL)
12147f24626dSPingfan Liu 		sdp = per_cpu_ptr(ssp->sda, get_boot_cpu_id());
1215994f7068SPaul E. McKenney 	else
121629d2bb94SPaul E. McKenney 		sdp = raw_cpu_ptr(ssp->sda);
1217c2445d38SPaul E. McKenney 	spin_lock_irqsave_sdp_contention(sdp, &flags);
12185358c9faSPaul E. McKenney 	if (rhp)
121929d2bb94SPaul E. McKenney 		rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp);
122029d2bb94SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
122103200b5cSPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq));
122203200b5cSPaul E. McKenney 	s = rcu_seq_snap(&ssp->srcu_sup->srcu_gp_seq);
122329d2bb94SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
122429d2bb94SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
122529d2bb94SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
122629d2bb94SPaul E. McKenney 		needgp = true;
122729d2bb94SPaul E. McKenney 	}
122829d2bb94SPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
122929d2bb94SPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
123029d2bb94SPaul E. McKenney 		needexp = true;
123129d2bb94SPaul E. McKenney 	}
123229d2bb94SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
12330b56f953SNeeraj Upadhyay 
12340b56f953SNeeraj Upadhyay 	/* Ensure that snp node tree is fully initialized before traversing it */
12350b56f953SNeeraj Upadhyay 	if (ss_state < SRCU_SIZE_WAIT_BARRIER)
12360b56f953SNeeraj Upadhyay 		sdp_mynode = NULL;
12370b56f953SNeeraj Upadhyay 	else
12380b56f953SNeeraj Upadhyay 		sdp_mynode = sdp->mynode;
12390b56f953SNeeraj Upadhyay 
124029d2bb94SPaul E. McKenney 	if (needgp)
124129d2bb94SPaul E. McKenney 		srcu_funnel_gp_start(ssp, sdp, s, do_norm);
124229d2bb94SPaul E. McKenney 	else if (needexp)
12430b56f953SNeeraj Upadhyay 		srcu_funnel_exp_start(ssp, sdp_mynode, s);
1244e29a4915SFrederic Weisbecker 	__srcu_read_unlock_nmisafe(ssp, idx);
12455358c9faSPaul E. McKenney 	return s;
124629d2bb94SPaul E. McKenney }
124729d2bb94SPaul E. McKenney 
124829d2bb94SPaul E. McKenney /*
1249da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
1250da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
1251da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
1252dad81a20SPaul E. McKenney  *
1253dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
1254dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
1255dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
1256dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
1257dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
12585ef98a63SPaul E. McKenney  * preceded the call to call_srcu().  It also means that each CPU executing
1259dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
12605ef98a63SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_srcu()
1261dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
1262dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
1263dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
1264dad81a20SPaul E. McKenney  *
12655ef98a63SPaul E. McKenney  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
1266dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
1267dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
12685ef98a63SPaul E. McKenney  * interval between the call to call_srcu() and the invocation of "func()".
1269dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
1270dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
1271dad81a20SPaul E. McKenney  *
1272dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
1273dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
1274dad81a20SPaul E. McKenney  * srcu_struct structure.
1275dad81a20SPaul E. McKenney  */
127611b00045SJiang Biao static void __call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
12771e9a038bSPaul E. McKenney 			rcu_callback_t func, bool do_norm)
1278dad81a20SPaul E. McKenney {
1279a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
1280a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
1281a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
1282a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
1283a602538eSPaul E. McKenney 		return;
1284a602538eSPaul E. McKenney 	}
1285da915ad5SPaul E. McKenney 	rhp->func = func;
12865358c9faSPaul E. McKenney 	(void)srcu_gp_start_if_needed(ssp, rhp, do_norm);
12871e9a038bSPaul E. McKenney }
12881e9a038bSPaul E. McKenney 
12895a0465e1SPaul E. McKenney /**
12905a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
1291aacb5d91SPaul E. McKenney  * @ssp: srcu_struct in queue the callback
129227fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
12935a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
12945a0465e1SPaul E. McKenney  *
12955a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
12965a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
12975a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
12985a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
12995a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
13005a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
13015a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
13025a0465e1SPaul E. McKenney  *
13035a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
13045a0465e1SPaul E. McKenney  * be fast and must not block.
13055a0465e1SPaul E. McKenney  */
1306aacb5d91SPaul E. McKenney void call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
13071e9a038bSPaul E. McKenney 	       rcu_callback_t func)
13081e9a038bSPaul E. McKenney {
1309aacb5d91SPaul E. McKenney 	__call_srcu(ssp, rhp, func, true);
1310dad81a20SPaul E. McKenney }
1311dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
1312dad81a20SPaul E. McKenney 
1313dad81a20SPaul E. McKenney /*
1314dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
1315dad81a20SPaul E. McKenney  */
1316aacb5d91SPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *ssp, bool do_norm)
1317dad81a20SPaul E. McKenney {
1318dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
1319dad81a20SPaul E. McKenney 
1320f505d434SJakub Kicinski 	RCU_LOCKDEP_WARN(lockdep_is_held(ssp) ||
1321dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
1322dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
1323dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
1324dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
1325dad81a20SPaul E. McKenney 
1326dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
1327dad81a20SPaul E. McKenney 		return;
1328dad81a20SPaul E. McKenney 	might_sleep();
1329aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1330dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
1331da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
1332aacb5d91SPaul E. McKenney 	__call_srcu(ssp, &rcu.head, wakeme_after_rcu, do_norm);
1333dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
1334da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
133535732cf9SPaul E. McKenney 
133635732cf9SPaul E. McKenney 	/*
133735732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
1338d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
133935732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
134035732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
134135732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
134235732cf9SPaul E. McKenney 	 */
134335732cf9SPaul E. McKenney 	smp_mb();
1344dad81a20SPaul E. McKenney }
1345dad81a20SPaul E. McKenney 
1346dad81a20SPaul E. McKenney /**
1347dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
1348aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
1349dad81a20SPaul E. McKenney  *
1350dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
1351dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
1352dad81a20SPaul E. McKenney  *
1353dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
1354dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
1355dad81a20SPaul E. McKenney  */
1356aacb5d91SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *ssp)
1357dad81a20SPaul E. McKenney {
1358aacb5d91SPaul E. McKenney 	__synchronize_srcu(ssp, rcu_gp_is_normal());
1359dad81a20SPaul E. McKenney }
1360dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
1361dad81a20SPaul E. McKenney 
1362dad81a20SPaul E. McKenney /**
1363dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
1364aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
1365dad81a20SPaul E. McKenney  *
1366dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
1367dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
1368da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
1369da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
1370dad81a20SPaul E. McKenney  *
1371dad81a20SPaul E. McKenney  * Can block; must be called from process context.
1372dad81a20SPaul E. McKenney  *
1373dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
1374dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
1375dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
1376dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
1377dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
1378dad81a20SPaul E. McKenney  *
1379dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
1380dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
1381dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
13826eb95cc4SPaul E. McKenney  * the end of its last corresponding SRCU read-side critical section
1383dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
1384dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
1385dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
1386dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
1387dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
1388dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
1389dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
1390dad81a20SPaul E. McKenney  *
1391dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
1392dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
1393dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
1394dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
1395dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
1396dad81a20SPaul E. McKenney  *
1397dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
1398dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
1399dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
14002da4b2a7SPaul E. McKenney  *
14013d3a0d1bSPaul E. McKenney  * Implementation of these memory-ordering guarantees is similar to
14023d3a0d1bSPaul E. McKenney  * that of synchronize_rcu().
14033d3a0d1bSPaul E. McKenney  *
14042da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
14052da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
14062da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
14072da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
1408dad81a20SPaul E. McKenney  */
1409aacb5d91SPaul E. McKenney void synchronize_srcu(struct srcu_struct *ssp)
1410dad81a20SPaul E. McKenney {
1411aacb5d91SPaul E. McKenney 	if (srcu_might_be_idle(ssp) || rcu_gp_is_expedited())
1412aacb5d91SPaul E. McKenney 		synchronize_srcu_expedited(ssp);
1413dad81a20SPaul E. McKenney 	else
1414aacb5d91SPaul E. McKenney 		__synchronize_srcu(ssp, true);
1415dad81a20SPaul E. McKenney }
1416dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1417dad81a20SPaul E. McKenney 
14185358c9faSPaul E. McKenney /**
14195358c9faSPaul E. McKenney  * get_state_synchronize_srcu - Provide an end-of-grace-period cookie
14205358c9faSPaul E. McKenney  * @ssp: srcu_struct to provide cookie for.
14215358c9faSPaul E. McKenney  *
14225358c9faSPaul E. McKenney  * This function returns a cookie that can be passed to
14235358c9faSPaul E. McKenney  * poll_state_synchronize_srcu(), which will return true if a full grace
14245358c9faSPaul E. McKenney  * period has elapsed in the meantime.  It is the caller's responsibility
14255358c9faSPaul E. McKenney  * to make sure that grace period happens, for example, by invoking
14265358c9faSPaul E. McKenney  * call_srcu() after return from get_state_synchronize_srcu().
14275358c9faSPaul E. McKenney  */
14285358c9faSPaul E. McKenney unsigned long get_state_synchronize_srcu(struct srcu_struct *ssp)
14295358c9faSPaul E. McKenney {
14305358c9faSPaul E. McKenney 	// Any prior manipulation of SRCU-protected data must happen
14315358c9faSPaul E. McKenney 	// before the load from ->srcu_gp_seq.
14325358c9faSPaul E. McKenney 	smp_mb();
143303200b5cSPaul E. McKenney 	return rcu_seq_snap(&ssp->srcu_sup->srcu_gp_seq);
14345358c9faSPaul E. McKenney }
14355358c9faSPaul E. McKenney EXPORT_SYMBOL_GPL(get_state_synchronize_srcu);
14365358c9faSPaul E. McKenney 
14375358c9faSPaul E. McKenney /**
14385358c9faSPaul E. McKenney  * start_poll_synchronize_srcu - Provide cookie and start grace period
14395358c9faSPaul E. McKenney  * @ssp: srcu_struct to provide cookie for.
14405358c9faSPaul E. McKenney  *
14415358c9faSPaul E. McKenney  * This function returns a cookie that can be passed to
14425358c9faSPaul E. McKenney  * poll_state_synchronize_srcu(), which will return true if a full grace
14435358c9faSPaul E. McKenney  * period has elapsed in the meantime.  Unlike get_state_synchronize_srcu(),
14445358c9faSPaul E. McKenney  * this function also ensures that any needed SRCU grace period will be
14455358c9faSPaul E. McKenney  * started.  This convenience does come at a cost in terms of CPU overhead.
14465358c9faSPaul E. McKenney  */
14475358c9faSPaul E. McKenney unsigned long start_poll_synchronize_srcu(struct srcu_struct *ssp)
14485358c9faSPaul E. McKenney {
14495358c9faSPaul E. McKenney 	return srcu_gp_start_if_needed(ssp, NULL, true);
14505358c9faSPaul E. McKenney }
14515358c9faSPaul E. McKenney EXPORT_SYMBOL_GPL(start_poll_synchronize_srcu);
14525358c9faSPaul E. McKenney 
14535358c9faSPaul E. McKenney /**
14545358c9faSPaul E. McKenney  * poll_state_synchronize_srcu - Has cookie's grace period ended?
14555358c9faSPaul E. McKenney  * @ssp: srcu_struct to provide cookie for.
14565358c9faSPaul E. McKenney  * @cookie: Return value from get_state_synchronize_srcu() or start_poll_synchronize_srcu().
14575358c9faSPaul E. McKenney  *
14585358c9faSPaul E. McKenney  * This function takes the cookie that was returned from either
14595358c9faSPaul E. McKenney  * get_state_synchronize_srcu() or start_poll_synchronize_srcu(), and
14605358c9faSPaul E. McKenney  * returns @true if an SRCU grace period elapsed since the time that the
14615358c9faSPaul E. McKenney  * cookie was created.
14624e7ccfaeSPaul E. McKenney  *
14634e7ccfaeSPaul E. McKenney  * Because cookies are finite in size, wrapping/overflow is possible.
14644e7ccfaeSPaul E. McKenney  * This is more pronounced on 32-bit systems where cookies are 32 bits,
14654e7ccfaeSPaul E. McKenney  * where in theory wrapping could happen in about 14 hours assuming
14664e7ccfaeSPaul E. McKenney  * 25-microsecond expedited SRCU grace periods.  However, a more likely
14674e7ccfaeSPaul E. McKenney  * overflow lower bound is on the order of 24 days in the case of
14684e7ccfaeSPaul E. McKenney  * one-millisecond SRCU grace periods.  Of course, wrapping in a 64-bit
14694e7ccfaeSPaul E. McKenney  * system requires geologic timespans, as in more than seven million years
14704e7ccfaeSPaul E. McKenney  * even for expedited SRCU grace periods.
14714e7ccfaeSPaul E. McKenney  *
14724e7ccfaeSPaul E. McKenney  * Wrapping/overflow is much more of an issue for CONFIG_SMP=n systems
14734e7ccfaeSPaul E. McKenney  * that also have CONFIG_PREEMPTION=n, which selects Tiny SRCU.  This uses
14744e7ccfaeSPaul E. McKenney  * a 16-bit cookie, which rcutorture routinely wraps in a matter of a
14754e7ccfaeSPaul E. McKenney  * few minutes.  If this proves to be a problem, this counter will be
14764e7ccfaeSPaul E. McKenney  * expanded to the same size as for Tree SRCU.
14775358c9faSPaul E. McKenney  */
14785358c9faSPaul E. McKenney bool poll_state_synchronize_srcu(struct srcu_struct *ssp, unsigned long cookie)
14795358c9faSPaul E. McKenney {
148003200b5cSPaul E. McKenney 	if (!rcu_seq_done(&ssp->srcu_sup->srcu_gp_seq, cookie))
14815358c9faSPaul E. McKenney 		return false;
14825358c9faSPaul E. McKenney 	// Ensure that the end of the SRCU grace period happens before
14835358c9faSPaul E. McKenney 	// any subsequent code that the caller might execute.
14845358c9faSPaul E. McKenney 	smp_mb(); // ^^^
14855358c9faSPaul E. McKenney 	return true;
14865358c9faSPaul E. McKenney }
14875358c9faSPaul E. McKenney EXPORT_SYMBOL_GPL(poll_state_synchronize_srcu);
14885358c9faSPaul E. McKenney 
1489da915ad5SPaul E. McKenney /*
1490da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1491da915ad5SPaul E. McKenney  */
1492da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1493da915ad5SPaul E. McKenney {
1494da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1495aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1496da915ad5SPaul E. McKenney 
1497da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1498aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1499aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1500aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1501da915ad5SPaul E. McKenney }
1502da915ad5SPaul E. McKenney 
1503994f7068SPaul E. McKenney /*
1504994f7068SPaul E. McKenney  * Enqueue an srcu_barrier() callback on the specified srcu_data
1505994f7068SPaul E. McKenney  * structure's ->cblist.  but only if that ->cblist already has at least one
1506994f7068SPaul E. McKenney  * callback enqueued.  Note that if a CPU already has callbacks enqueue,
1507994f7068SPaul E. McKenney  * it must have already registered the need for a future grace period,
1508994f7068SPaul E. McKenney  * so all we need do is enqueue a callback that will use the same grace
1509994f7068SPaul E. McKenney  * period as the last callback already in the queue.
1510994f7068SPaul E. McKenney  */
1511994f7068SPaul E. McKenney static void srcu_barrier_one_cpu(struct srcu_struct *ssp, struct srcu_data *sdp)
1512994f7068SPaul E. McKenney {
1513994f7068SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1514994f7068SPaul E. McKenney 	atomic_inc(&ssp->srcu_barrier_cpu_cnt);
1515994f7068SPaul E. McKenney 	sdp->srcu_barrier_head.func = srcu_barrier_cb;
1516994f7068SPaul E. McKenney 	debug_rcu_head_queue(&sdp->srcu_barrier_head);
1517994f7068SPaul E. McKenney 	if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1518994f7068SPaul E. McKenney 				   &sdp->srcu_barrier_head)) {
1519994f7068SPaul E. McKenney 		debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1520994f7068SPaul E. McKenney 		atomic_dec(&ssp->srcu_barrier_cpu_cnt);
1521994f7068SPaul E. McKenney 	}
1522994f7068SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1523994f7068SPaul E. McKenney }
1524994f7068SPaul E. McKenney 
1525dad81a20SPaul E. McKenney /**
1526dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1527aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to wait for in-flight callbacks.
1528dad81a20SPaul E. McKenney  */
1529aacb5d91SPaul E. McKenney void srcu_barrier(struct srcu_struct *ssp)
1530dad81a20SPaul E. McKenney {
1531da915ad5SPaul E. McKenney 	int cpu;
1532e2f63836SPaul E. McKenney 	int idx;
1533aacb5d91SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&ssp->srcu_barrier_seq);
1534da915ad5SPaul E. McKenney 
1535aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1536aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_barrier_mutex);
1537aacb5d91SPaul E. McKenney 	if (rcu_seq_done(&ssp->srcu_barrier_seq, s)) {
1538da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1539aacb5d91SPaul E. McKenney 		mutex_unlock(&ssp->srcu_barrier_mutex);
1540da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1541da915ad5SPaul E. McKenney 	}
1542aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_barrier_seq);
1543aacb5d91SPaul E. McKenney 	init_completion(&ssp->srcu_barrier_completion);
1544da915ad5SPaul E. McKenney 
1545da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1546aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 1);
1547da915ad5SPaul E. McKenney 
1548e29a4915SFrederic Weisbecker 	idx = __srcu_read_lock_nmisafe(ssp);
1549a0d8cbd3SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_sup->srcu_size_state) < SRCU_SIZE_WAIT_BARRIER)
15507f24626dSPingfan Liu 		srcu_barrier_one_cpu(ssp, per_cpu_ptr(ssp->sda,	get_boot_cpu_id()));
1551994f7068SPaul E. McKenney 	else
1552994f7068SPaul E. McKenney 		for_each_possible_cpu(cpu)
1553994f7068SPaul E. McKenney 			srcu_barrier_one_cpu(ssp, per_cpu_ptr(ssp->sda, cpu));
1554e29a4915SFrederic Weisbecker 	__srcu_read_unlock_nmisafe(ssp, idx);
1555da915ad5SPaul E. McKenney 
1556da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1557aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1558aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1559aacb5d91SPaul E. McKenney 	wait_for_completion(&ssp->srcu_barrier_completion);
1560da915ad5SPaul E. McKenney 
1561aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_barrier_seq);
1562aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_barrier_mutex);
1563dad81a20SPaul E. McKenney }
1564dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1565dad81a20SPaul E. McKenney 
1566dad81a20SPaul E. McKenney /**
1567dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1568aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to report batch completion.
1569dad81a20SPaul E. McKenney  *
1570dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1571dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1572dad81a20SPaul E. McKenney  */
1573aacb5d91SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *ssp)
1574dad81a20SPaul E. McKenney {
157539f91504SPaul E. McKenney 	return READ_ONCE(ssp->srcu_idx);
1576dad81a20SPaul E. McKenney }
1577dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1578dad81a20SPaul E. McKenney 
1579dad81a20SPaul E. McKenney /*
1580da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1581da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1582da915ad5SPaul E. McKenney  * completed in that state.
1583dad81a20SPaul E. McKenney  */
1584aacb5d91SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *ssp)
1585dad81a20SPaul E. McKenney {
1586dad81a20SPaul E. McKenney 	int idx;
1587dad81a20SPaul E. McKenney 
1588e3a6ab25SPaul E. McKenney 	mutex_lock(&ssp->srcu_sup->srcu_gp_mutex);
1589da915ad5SPaul E. McKenney 
1590dad81a20SPaul E. McKenney 	/*
1591dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1592da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1593dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1594dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1595dad81a20SPaul E. McKenney 	 * invoking a callback.
1596dad81a20SPaul E. McKenney 	 *
1597dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1598dad81a20SPaul E. McKenney 	 * by the prior grace period.
1599dad81a20SPaul E. McKenney 	 */
160003200b5cSPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&ssp->srcu_sup->srcu_gp_seq)); /* ^^^ */
1601dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1602b3fb11f7SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp->srcu_sup);
160303200b5cSPaul E. McKenney 		if (ULONG_CMP_GE(ssp->srcu_sup->srcu_gp_seq, ssp->srcu_sup->srcu_gp_seq_needed)) {
160403200b5cSPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(ssp->srcu_sup->srcu_gp_seq));
1605b3fb11f7SPaul E. McKenney 			spin_unlock_irq_rcu_node(ssp->srcu_sup);
1606e3a6ab25SPaul E. McKenney 			mutex_unlock(&ssp->srcu_sup->srcu_gp_mutex);
1607dad81a20SPaul E. McKenney 			return;
1608dad81a20SPaul E. McKenney 		}
160903200b5cSPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(ssp->srcu_sup->srcu_gp_seq));
1610dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1611aacb5d91SPaul E. McKenney 			srcu_gp_start(ssp);
1612b3fb11f7SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp->srcu_sup);
1613da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1614e3a6ab25SPaul E. McKenney 			mutex_unlock(&ssp->srcu_sup->srcu_gp_mutex);
1615dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1616dad81a20SPaul E. McKenney 		}
1617da915ad5SPaul E. McKenney 	}
1618dad81a20SPaul E. McKenney 
161903200b5cSPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_sup->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1620aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1621aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 1)) {
1622e3a6ab25SPaul E. McKenney 			mutex_unlock(&ssp->srcu_sup->srcu_gp_mutex);
1623dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1624da915ad5SPaul E. McKenney 		}
1625aacb5d91SPaul E. McKenney 		srcu_flip(ssp);
1626b3fb11f7SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp->srcu_sup);
162703200b5cSPaul E. McKenney 		rcu_seq_set_state(&ssp->srcu_sup->srcu_gp_seq, SRCU_STATE_SCAN2);
1628*3b46679cSPaul E. McKenney 		ssp->srcu_sup->srcu_n_exp_nodelay = 0;
1629b3fb11f7SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp->srcu_sup);
1630dad81a20SPaul E. McKenney 	}
1631dad81a20SPaul E. McKenney 
163203200b5cSPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_sup->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1633dad81a20SPaul E. McKenney 
1634dad81a20SPaul E. McKenney 		/*
1635dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1636dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1637dad81a20SPaul E. McKenney 		 */
1638aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1639aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 2)) {
1640e3a6ab25SPaul E. McKenney 			mutex_unlock(&ssp->srcu_sup->srcu_gp_mutex);
1641da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1642da915ad5SPaul E. McKenney 		}
1643*3b46679cSPaul E. McKenney 		ssp->srcu_sup->srcu_n_exp_nodelay = 0;
1644aacb5d91SPaul E. McKenney 		srcu_gp_end(ssp);  /* Releases ->srcu_gp_mutex. */
1645dad81a20SPaul E. McKenney 	}
1646dad81a20SPaul E. McKenney }
1647dad81a20SPaul E. McKenney 
1648dad81a20SPaul E. McKenney /*
1649dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1650dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1651dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1652dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1653dad81a20SPaul E. McKenney  */
1654da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1655dad81a20SPaul E. McKenney {
1656ae5c2341SJoel Fernandes (Google) 	long len;
1657da915ad5SPaul E. McKenney 	bool more;
1658dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1659dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1660da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1661aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1662dad81a20SPaul E. McKenney 
1663e81baf4cSSebastian Andrzej Siewior 	sdp = container_of(work, struct srcu_data, work);
1664e81baf4cSSebastian Andrzej Siewior 
1665aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1666dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1667d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1668da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
166903200b5cSPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq));
1670da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1671da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1672d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1673da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1674da915ad5SPaul E. McKenney 	}
1675da915ad5SPaul E. McKenney 
1676da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1677da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1678da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1679ae5c2341SJoel Fernandes (Google) 	len = ready_cbs.len;
1680d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1681dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1682dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1683a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1684dad81a20SPaul E. McKenney 		local_bh_disable();
1685dad81a20SPaul E. McKenney 		rhp->func(rhp);
1686dad81a20SPaul E. McKenney 		local_bh_enable();
1687dad81a20SPaul E. McKenney 	}
1688ae5c2341SJoel Fernandes (Google) 	WARN_ON_ONCE(ready_cbs.len);
1689da915ad5SPaul E. McKenney 
1690da915ad5SPaul E. McKenney 	/*
1691da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1692da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1693da915ad5SPaul E. McKenney 	 */
1694d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1695ae5c2341SJoel Fernandes (Google) 	rcu_segcblist_add_len(&sdp->srcu_cblist, -len);
1696da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
169703200b5cSPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_sup->srcu_gp_seq));
1698da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1699da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1700d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1701da915ad5SPaul E. McKenney 	if (more)
1702da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1703dad81a20SPaul E. McKenney }
1704dad81a20SPaul E. McKenney 
1705dad81a20SPaul E. McKenney /*
1706dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1707dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1708dad81a20SPaul E. McKenney  */
1709aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay)
1710dad81a20SPaul E. McKenney {
1711da915ad5SPaul E. McKenney 	bool pushgp = true;
1712dad81a20SPaul E. McKenney 
1713b3fb11f7SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp->srcu_sup);
171403200b5cSPaul E. McKenney 	if (ULONG_CMP_GE(ssp->srcu_sup->srcu_gp_seq, ssp->srcu_sup->srcu_gp_seq_needed)) {
171503200b5cSPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(ssp->srcu_sup->srcu_gp_seq))) {
1716da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1717da915ad5SPaul E. McKenney 			pushgp = false;
1718dad81a20SPaul E. McKenney 		}
171903200b5cSPaul E. McKenney 	} else if (!rcu_seq_state(ssp->srcu_sup->srcu_gp_seq)) {
1720da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1721aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
1722da915ad5SPaul E. McKenney 	}
1723b3fb11f7SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp->srcu_sup);
1724dad81a20SPaul E. McKenney 
1725da915ad5SPaul E. McKenney 	if (pushgp)
1726aacb5d91SPaul E. McKenney 		queue_delayed_work(rcu_gp_wq, &ssp->work, delay);
1727dad81a20SPaul E. McKenney }
1728dad81a20SPaul E. McKenney 
1729dad81a20SPaul E. McKenney /*
1730dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1731dad81a20SPaul E. McKenney  */
17320d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1733dad81a20SPaul E. McKenney {
1734282d8998SPaul E. McKenney 	unsigned long curdelay;
1735282d8998SPaul E. McKenney 	unsigned long j;
1736aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1737dad81a20SPaul E. McKenney 
1738aacb5d91SPaul E. McKenney 	ssp = container_of(work, struct srcu_struct, work.work);
1739dad81a20SPaul E. McKenney 
1740aacb5d91SPaul E. McKenney 	srcu_advance_state(ssp);
1741282d8998SPaul E. McKenney 	curdelay = srcu_get_delay(ssp);
1742282d8998SPaul E. McKenney 	if (curdelay) {
1743282d8998SPaul E. McKenney 		WRITE_ONCE(ssp->reschedule_count, 0);
1744282d8998SPaul E. McKenney 	} else {
1745282d8998SPaul E. McKenney 		j = jiffies;
1746282d8998SPaul E. McKenney 		if (READ_ONCE(ssp->reschedule_jiffies) == j) {
1747282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->reschedule_count, READ_ONCE(ssp->reschedule_count) + 1);
17484f2bfd94SNeeraj Upadhyay 			if (READ_ONCE(ssp->reschedule_count) > srcu_max_nodelay)
1749282d8998SPaul E. McKenney 				curdelay = 1;
1750282d8998SPaul E. McKenney 		} else {
1751282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->reschedule_count, 1);
1752282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->reschedule_jiffies, j);
1753282d8998SPaul E. McKenney 		}
1754282d8998SPaul E. McKenney 	}
1755282d8998SPaul E. McKenney 	srcu_reschedule(ssp, curdelay);
1756dad81a20SPaul E. McKenney }
17577f6733c3SPaul E. McKenney 
17587f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
1759aacb5d91SPaul E. McKenney 			     struct srcu_struct *ssp, int *flags,
1760aebc8264SPaul E. McKenney 			     unsigned long *gp_seq)
17617f6733c3SPaul E. McKenney {
17627f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
17637f6733c3SPaul E. McKenney 		return;
17647f6733c3SPaul E. McKenney 	*flags = 0;
176503200b5cSPaul E. McKenney 	*gp_seq = rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq);
17667f6733c3SPaul E. McKenney }
17677f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
17681f4f6da1SPaul E. McKenney 
17693bedebcfSPaul E. McKenney static const char * const srcu_size_state_name[] = {
17703bedebcfSPaul E. McKenney 	"SRCU_SIZE_SMALL",
17713bedebcfSPaul E. McKenney 	"SRCU_SIZE_ALLOC",
17723bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_BARRIER",
17733bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CALL",
17743bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS1",
17753bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS2",
17763bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS3",
17773bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS4",
17783bedebcfSPaul E. McKenney 	"SRCU_SIZE_BIG",
17793bedebcfSPaul E. McKenney 	"SRCU_SIZE_???",
17803bedebcfSPaul E. McKenney };
17813bedebcfSPaul E. McKenney 
1782aacb5d91SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *ssp, char *tt, char *tf)
1783115a1a52SPaul E. McKenney {
1784115a1a52SPaul E. McKenney 	int cpu;
1785115a1a52SPaul E. McKenney 	int idx;
1786ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1787a0d8cbd3SPaul E. McKenney 	int ss_state = READ_ONCE(ssp->srcu_sup->srcu_size_state);
17883bedebcfSPaul E. McKenney 	int ss_state_idx = ss_state;
1789115a1a52SPaul E. McKenney 
1790aacb5d91SPaul E. McKenney 	idx = ssp->srcu_idx & 0x1;
17913bedebcfSPaul E. McKenney 	if (ss_state < 0 || ss_state >= ARRAY_SIZE(srcu_size_state_name))
17923bedebcfSPaul E. McKenney 		ss_state_idx = ARRAY_SIZE(srcu_size_state_name) - 1;
17934a230f80SPaul E. McKenney 	pr_alert("%s%s Tree SRCU g%ld state %d (%s)",
179403200b5cSPaul E. McKenney 		 tt, tf, rcu_seq_current(&ssp->srcu_sup->srcu_gp_seq), ss_state,
17954a230f80SPaul E. McKenney 		 srcu_size_state_name[ss_state_idx]);
17964a230f80SPaul E. McKenney 	if (!ssp->sda) {
17974a230f80SPaul E. McKenney 		// Called after cleanup_srcu_struct(), perhaps.
17984a230f80SPaul E. McKenney 		pr_cont(" No per-CPU srcu_data structures (->sda == NULL).\n");
17994a230f80SPaul E. McKenney 	} else {
18004a230f80SPaul E. McKenney 		pr_cont(" per-CPU(idx=%d):", idx);
1801115a1a52SPaul E. McKenney 		for_each_possible_cpu(cpu) {
1802115a1a52SPaul E. McKenney 			unsigned long l0, l1;
1803115a1a52SPaul E. McKenney 			unsigned long u0, u1;
1804115a1a52SPaul E. McKenney 			long c0, c1;
18055ab07a8dSPaul E. McKenney 			struct srcu_data *sdp;
1806115a1a52SPaul E. McKenney 
1807aacb5d91SPaul E. McKenney 			sdp = per_cpu_ptr(ssp->sda, cpu);
18085d0f5953SPaul E. McKenney 			u0 = data_race(atomic_long_read(&sdp->srcu_unlock_count[!idx]));
18095d0f5953SPaul E. McKenney 			u1 = data_race(atomic_long_read(&sdp->srcu_unlock_count[idx]));
1810115a1a52SPaul E. McKenney 
1811115a1a52SPaul E. McKenney 			/*
1812115a1a52SPaul E. McKenney 			 * Make sure that a lock is always counted if the corresponding
1813115a1a52SPaul E. McKenney 			 * unlock is counted.
1814115a1a52SPaul E. McKenney 			 */
1815115a1a52SPaul E. McKenney 			smp_rmb();
1816115a1a52SPaul E. McKenney 
18175d0f5953SPaul E. McKenney 			l0 = data_race(atomic_long_read(&sdp->srcu_lock_count[!idx]));
18185d0f5953SPaul E. McKenney 			l1 = data_race(atomic_long_read(&sdp->srcu_lock_count[idx]));
1819115a1a52SPaul E. McKenney 
1820115a1a52SPaul E. McKenney 			c0 = l0 - u0;
1821115a1a52SPaul E. McKenney 			c1 = l1 - u1;
18227e210a65SPaul E. McKenney 			pr_cont(" %d(%ld,%ld %c)",
18237e210a65SPaul E. McKenney 				cpu, c0, c1,
18247e210a65SPaul E. McKenney 				"C."[rcu_segcblist_empty(&sdp->srcu_cblist)]);
1825ac3748c6SPaul E. McKenney 			s0 += c0;
1826ac3748c6SPaul E. McKenney 			s1 += c1;
1827115a1a52SPaul E. McKenney 		}
1828ac3748c6SPaul E. McKenney 		pr_cont(" T(%ld,%ld)\n", s0, s1);
18294a230f80SPaul E. McKenney 	}
18309f2e91d9SPaul E. McKenney 	if (SRCU_SIZING_IS_TORTURE())
183199659f64SPaul E. McKenney 		srcu_transition_to_big(ssp);
1832115a1a52SPaul E. McKenney }
1833115a1a52SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1834115a1a52SPaul E. McKenney 
18351f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void)
18361f4f6da1SPaul E. McKenney {
18371f4f6da1SPaul E. McKenney 	pr_info("Hierarchical SRCU implementation.\n");
18380c8e0e3cSPaul E. McKenney 	if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
18390c8e0e3cSPaul E. McKenney 		pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
18404f2bfd94SNeeraj Upadhyay 	if (srcu_retry_check_delay != SRCU_DEFAULT_RETRY_CHECK_DELAY)
18414f2bfd94SNeeraj Upadhyay 		pr_info("\tNon-default retry check delay of %lu us.\n", srcu_retry_check_delay);
18424f2bfd94SNeeraj Upadhyay 	if (srcu_max_nodelay != SRCU_DEFAULT_MAX_NODELAY)
18434f2bfd94SNeeraj Upadhyay 		pr_info("\tNon-default max no-delay of %lu.\n", srcu_max_nodelay);
18444f2bfd94SNeeraj Upadhyay 	pr_info("\tMax phase no-delay instances is %lu.\n", srcu_max_nodelay_phase);
18451f4f6da1SPaul E. McKenney 	return 0;
18461f4f6da1SPaul E. McKenney }
18471f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce);
1848e0fcba9aSPaul E. McKenney 
1849e0fcba9aSPaul E. McKenney void __init srcu_init(void)
1850e0fcba9aSPaul E. McKenney {
1851aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1852e0fcba9aSPaul E. McKenney 
1853a57ffb3cSPaul E. McKenney 	/* Decide on srcu_struct-size strategy. */
1854a57ffb3cSPaul E. McKenney 	if (SRCU_SIZING_IS(SRCU_SIZING_AUTO)) {
1855a57ffb3cSPaul E. McKenney 		if (nr_cpu_ids >= big_cpu_lim) {
1856a57ffb3cSPaul E. McKenney 			convert_to_big = SRCU_SIZING_INIT; // Don't bother waiting for contention.
1857a57ffb3cSPaul E. McKenney 			pr_info("%s: Setting srcu_struct sizes to big.\n", __func__);
1858a57ffb3cSPaul E. McKenney 		} else {
1859a57ffb3cSPaul E. McKenney 			convert_to_big = SRCU_SIZING_NONE | SRCU_SIZING_CONTEND;
1860a57ffb3cSPaul E. McKenney 			pr_info("%s: Setting srcu_struct sizes based on contention.\n", __func__);
1861a57ffb3cSPaul E. McKenney 		}
1862a57ffb3cSPaul E. McKenney 	}
1863a57ffb3cSPaul E. McKenney 
18648e9c01c7SFrederic Weisbecker 	/*
18658e9c01c7SFrederic Weisbecker 	 * Once that is set, call_srcu() can follow the normal path and
18668e9c01c7SFrederic Weisbecker 	 * queue delayed work. This must follow RCU workqueues creation
18678e9c01c7SFrederic Weisbecker 	 * and timers initialization.
18688e9c01c7SFrederic Weisbecker 	 */
1869e0fcba9aSPaul E. McKenney 	srcu_init_done = true;
1870e0fcba9aSPaul E. McKenney 	while (!list_empty(&srcu_boot_list)) {
1871aacb5d91SPaul E. McKenney 		ssp = list_first_entry(&srcu_boot_list, struct srcu_struct,
18724e6ea4efSPaul E. McKenney 				      work.work.entry);
1873aacb5d91SPaul E. McKenney 		list_del_init(&ssp->work.work.entry);
1874a0d8cbd3SPaul E. McKenney 		if (SRCU_SIZING_IS(SRCU_SIZING_INIT) &&
1875a0d8cbd3SPaul E. McKenney 		    ssp->srcu_sup->srcu_size_state == SRCU_SIZE_SMALL)
1876a0d8cbd3SPaul E. McKenney 			ssp->srcu_sup->srcu_size_state = SRCU_SIZE_ALLOC;
1877aacb5d91SPaul E. McKenney 		queue_work(rcu_gp_wq, &ssp->work.work);
1878e0fcba9aSPaul E. McKenney 	}
1879e0fcba9aSPaul E. McKenney }
1880fe15b50cSPaul E. McKenney 
1881fe15b50cSPaul E. McKenney #ifdef CONFIG_MODULES
1882fe15b50cSPaul E. McKenney 
1883fe15b50cSPaul E. McKenney /* Initialize any global-scope srcu_struct structures used by this module. */
1884fe15b50cSPaul E. McKenney static int srcu_module_coming(struct module *mod)
1885fe15b50cSPaul E. McKenney {
1886fe15b50cSPaul E. McKenney 	int i;
1887f4d01a25SPaul E. McKenney 	struct srcu_struct *ssp;
1888fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1889fe15b50cSPaul E. McKenney 
1890fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++) {
1891f4d01a25SPaul E. McKenney 		ssp = *(sspp++);
1892f4d01a25SPaul E. McKenney 		ssp->sda = alloc_percpu(struct srcu_data);
1893f4d01a25SPaul E. McKenney 		if (WARN_ON_ONCE(!ssp->sda))
1894f4d01a25SPaul E. McKenney 			return -ENOMEM;
1895fe15b50cSPaul E. McKenney 	}
1896fe15b50cSPaul E. McKenney 	return 0;
1897fe15b50cSPaul E. McKenney }
1898fe15b50cSPaul E. McKenney 
1899fe15b50cSPaul E. McKenney /* Clean up any global-scope srcu_struct structures used by this module. */
1900fe15b50cSPaul E. McKenney static void srcu_module_going(struct module *mod)
1901fe15b50cSPaul E. McKenney {
1902fe15b50cSPaul E. McKenney 	int i;
1903f4d01a25SPaul E. McKenney 	struct srcu_struct *ssp;
1904fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1905fe15b50cSPaul E. McKenney 
1906f4d01a25SPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++) {
1907f4d01a25SPaul E. McKenney 		ssp = *(sspp++);
190803200b5cSPaul E. McKenney 		if (!rcu_seq_state(smp_load_acquire(&ssp->srcu_sup->srcu_gp_seq_needed)) &&
1909f4d01a25SPaul E. McKenney 		    !WARN_ON_ONCE(!ssp->sda_is_static))
1910f4d01a25SPaul E. McKenney 			cleanup_srcu_struct(ssp);
1911f4d01a25SPaul E. McKenney 		free_percpu(ssp->sda);
1912f4d01a25SPaul E. McKenney 	}
1913fe15b50cSPaul E. McKenney }
1914fe15b50cSPaul E. McKenney 
1915fe15b50cSPaul E. McKenney /* Handle one module, either coming or going. */
1916fe15b50cSPaul E. McKenney static int srcu_module_notify(struct notifier_block *self,
1917fe15b50cSPaul E. McKenney 			      unsigned long val, void *data)
1918fe15b50cSPaul E. McKenney {
1919fe15b50cSPaul E. McKenney 	struct module *mod = data;
1920fe15b50cSPaul E. McKenney 	int ret = 0;
1921fe15b50cSPaul E. McKenney 
1922fe15b50cSPaul E. McKenney 	switch (val) {
1923fe15b50cSPaul E. McKenney 	case MODULE_STATE_COMING:
1924fe15b50cSPaul E. McKenney 		ret = srcu_module_coming(mod);
1925fe15b50cSPaul E. McKenney 		break;
1926fe15b50cSPaul E. McKenney 	case MODULE_STATE_GOING:
1927fe15b50cSPaul E. McKenney 		srcu_module_going(mod);
1928fe15b50cSPaul E. McKenney 		break;
1929fe15b50cSPaul E. McKenney 	default:
1930fe15b50cSPaul E. McKenney 		break;
1931fe15b50cSPaul E. McKenney 	}
1932fe15b50cSPaul E. McKenney 	return ret;
1933fe15b50cSPaul E. McKenney }
1934fe15b50cSPaul E. McKenney 
1935fe15b50cSPaul E. McKenney static struct notifier_block srcu_module_nb = {
1936fe15b50cSPaul E. McKenney 	.notifier_call = srcu_module_notify,
1937fe15b50cSPaul E. McKenney 	.priority = 0,
1938fe15b50cSPaul E. McKenney };
1939fe15b50cSPaul E. McKenney 
1940fe15b50cSPaul E. McKenney static __init int init_srcu_module_notifier(void)
1941fe15b50cSPaul E. McKenney {
1942fe15b50cSPaul E. McKenney 	int ret;
1943fe15b50cSPaul E. McKenney 
1944fe15b50cSPaul E. McKenney 	ret = register_module_notifier(&srcu_module_nb);
1945fe15b50cSPaul E. McKenney 	if (ret)
1946fe15b50cSPaul E. McKenney 		pr_warn("Failed to register srcu module notifier\n");
1947fe15b50cSPaul E. McKenney 	return ret;
1948fe15b50cSPaul E. McKenney }
1949fe15b50cSPaul E. McKenney late_initcall(init_srcu_module_notifier);
1950fe15b50cSPaul E. McKenney 
1951fe15b50cSPaul E. McKenney #endif /* #ifdef CONFIG_MODULES */
1952