xref: /linux-6.15/kernel/rcu/srcutree.c (revision 2e83b879)
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;
1382ec30311SPaul E. McKenney 		sdp->srcu_gp_seq_needed = ssp->srcu_gp_seq;
1392ec30311SPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = ssp->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 {
157cbdc98e9SPaul E. McKenney 	return rcu_seq_state(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();
176c69a00a1SPaul E. McKenney 	ssp->node = kcalloc(rcu_num_nodes, sizeof(*ssp->node), gfp_flags);
1772ec30311SPaul E. McKenney 	if (!ssp->node)
1782ec30311SPaul E. McKenney 		return false;
179b5befe84SFrederic Weisbecker 
180da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
181aacb5d91SPaul E. McKenney 	ssp->level[0] = &ssp->node[0];
182da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
183aacb5d91SPaul E. McKenney 		ssp->level[i] = ssp->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;
198aacb5d91SPaul E. McKenney 		if (snp == &ssp->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. */
205aacb5d91SPaul E. McKenney 		if (snp == ssp->level[level + 1])
206da915ad5SPaul E. McKenney 			level++;
207aacb5d91SPaul E. McKenney 		snp->srcu_parent = ssp->level[level - 1] +
208aacb5d91SPaul E. McKenney 				   (snp - ssp->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;
217aacb5d91SPaul E. McKenney 	snp_first = ssp->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 	}
228994f7068SPaul E. McKenney 	smp_store_release(&ssp->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 {
239994f7068SPaul E. McKenney 	ssp->srcu_size_state = SRCU_SIZE_SMALL;
2402ec30311SPaul E. McKenney 	ssp->node = NULL;
241aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_cb_mutex);
242aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_gp_mutex);
243aacb5d91SPaul E. McKenney 	ssp->srcu_idx = 0;
244aacb5d91SPaul E. McKenney 	ssp->srcu_gp_seq = 0;
245aacb5d91SPaul E. McKenney 	ssp->srcu_barrier_seq = 0;
246aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_barrier_mutex);
247aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 0);
248aacb5d91SPaul E. McKenney 	INIT_DELAYED_WORK(&ssp->work, process_srcu);
24946470cf8SPaul E. McKenney 	ssp->sda_is_static = is_static;
250da915ad5SPaul E. McKenney 	if (!is_static)
251aacb5d91SPaul E. McKenney 		ssp->sda = alloc_percpu(struct srcu_data);
25250edb988SPaul E. McKenney 	if (!ssp->sda)
25350edb988SPaul E. McKenney 		return -ENOMEM;
2542ec30311SPaul E. McKenney 	init_srcu_struct_data(ssp);
255c69a00a1SPaul E. McKenney 	ssp->srcu_gp_seq_needed_exp = 0;
256c69a00a1SPaul E. McKenney 	ssp->srcu_last_gp_end = ktime_get_mono_fast_ns();
2579f2e91d9SPaul E. McKenney 	if (READ_ONCE(ssp->srcu_size_state) == SRCU_SIZE_SMALL && SRCU_SIZING_IS_INIT()) {
258c69a00a1SPaul E. McKenney 		if (!init_srcu_struct_nodes(ssp, GFP_ATOMIC)) {
25946470cf8SPaul E. McKenney 			if (!ssp->sda_is_static) {
2602ec30311SPaul E. McKenney 				free_percpu(ssp->sda);
2612ec30311SPaul E. McKenney 				ssp->sda = NULL;
2622ec30311SPaul E. McKenney 				return -ENOMEM;
2632ec30311SPaul E. McKenney 			}
2642ec30311SPaul E. McKenney 		} else {
265c69a00a1SPaul E. McKenney 			WRITE_ONCE(ssp->srcu_size_state, SRCU_SIZE_BIG);
2662ec30311SPaul E. McKenney 		}
267c69a00a1SPaul E. McKenney 	}
268aacb5d91SPaul E. McKenney 	smp_store_release(&ssp->srcu_gp_seq_needed, 0); /* Init done. */
26950edb988SPaul E. McKenney 	return 0;
270dad81a20SPaul E. McKenney }
271dad81a20SPaul E. McKenney 
272dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
273dad81a20SPaul E. McKenney 
274aacb5d91SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *ssp, const char *name,
275dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
276dad81a20SPaul E. McKenney {
277dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
278aacb5d91SPaul E. McKenney 	debug_check_no_locks_freed((void *)ssp, sizeof(*ssp));
279aacb5d91SPaul E. McKenney 	lockdep_init_map(&ssp->dep_map, name, key, 0);
280aacb5d91SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
281aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
282dad81a20SPaul E. McKenney }
283dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
284dad81a20SPaul E. McKenney 
285dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
286dad81a20SPaul E. McKenney 
287dad81a20SPaul E. McKenney /**
288dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
289aacb5d91SPaul E. McKenney  * @ssp: structure to initialize.
290dad81a20SPaul E. McKenney  *
291dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
292dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
293dad81a20SPaul E. McKenney  * of SRCU protection.
294dad81a20SPaul E. McKenney  */
295aacb5d91SPaul E. McKenney int init_srcu_struct(struct srcu_struct *ssp)
296dad81a20SPaul E. McKenney {
297aacb5d91SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
298aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
299dad81a20SPaul E. McKenney }
300dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
301dad81a20SPaul E. McKenney 
302dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
303dad81a20SPaul E. McKenney 
304dad81a20SPaul E. McKenney /*
3059f2e91d9SPaul E. McKenney  * Initiate a transition to SRCU_SIZE_BIG with lock held.
3069f2e91d9SPaul E. McKenney  */
3079f2e91d9SPaul E. McKenney static void __srcu_transition_to_big(struct srcu_struct *ssp)
3089f2e91d9SPaul E. McKenney {
3099f2e91d9SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp, lock));
3109f2e91d9SPaul E. McKenney 	smp_store_release(&ssp->srcu_size_state, SRCU_SIZE_ALLOC);
3119f2e91d9SPaul E. McKenney }
3129f2e91d9SPaul E. McKenney 
3139f2e91d9SPaul E. McKenney /*
31499659f64SPaul E. McKenney  * Initiate an idempotent transition to SRCU_SIZE_BIG.
31599659f64SPaul E. McKenney  */
31699659f64SPaul E. McKenney static void srcu_transition_to_big(struct srcu_struct *ssp)
31799659f64SPaul E. McKenney {
31899659f64SPaul E. McKenney 	unsigned long flags;
31999659f64SPaul E. McKenney 
32099659f64SPaul E. McKenney 	/* Double-checked locking on ->srcu_size-state. */
32199659f64SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_size_state) != SRCU_SIZE_SMALL)
32299659f64SPaul E. McKenney 		return;
32399659f64SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
32499659f64SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_size_state) != SRCU_SIZE_SMALL) {
32599659f64SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(ssp, flags);
32699659f64SPaul E. McKenney 		return;
32799659f64SPaul E. McKenney 	}
3289f2e91d9SPaul E. McKenney 	__srcu_transition_to_big(ssp);
32999659f64SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
33099659f64SPaul E. McKenney }
33199659f64SPaul E. McKenney 
33299659f64SPaul E. McKenney /*
333c2445d38SPaul E. McKenney  * Check to see if the just-encountered contention event justifies
334c2445d38SPaul E. McKenney  * a transition to SRCU_SIZE_BIG.
3359f2e91d9SPaul E. McKenney  */
336c2445d38SPaul E. McKenney static void spin_lock_irqsave_check_contention(struct srcu_struct *ssp)
3379f2e91d9SPaul E. McKenney {
3389f2e91d9SPaul E. McKenney 	unsigned long j;
3399f2e91d9SPaul E. McKenney 
3409f2e91d9SPaul E. McKenney 	if (!SRCU_SIZING_IS_CONTEND() || ssp->srcu_size_state)
3419f2e91d9SPaul E. McKenney 		return;
3429f2e91d9SPaul E. McKenney 	j = jiffies;
3439f2e91d9SPaul E. McKenney 	if (ssp->srcu_size_jiffies != j) {
3449f2e91d9SPaul E. McKenney 		ssp->srcu_size_jiffies = j;
3459f2e91d9SPaul E. McKenney 		ssp->srcu_n_lock_retries = 0;
3469f2e91d9SPaul E. McKenney 	}
3479f2e91d9SPaul E. McKenney 	if (++ssp->srcu_n_lock_retries <= small_contention_lim)
3489f2e91d9SPaul E. McKenney 		return;
3499f2e91d9SPaul E. McKenney 	__srcu_transition_to_big(ssp);
3509f2e91d9SPaul E. McKenney }
3519f2e91d9SPaul E. McKenney 
3529f2e91d9SPaul E. McKenney /*
353c2445d38SPaul E. McKenney  * Acquire the specified srcu_data structure's ->lock, but check for
354c2445d38SPaul E. McKenney  * excessive contention, which results in initiation of a transition
355c2445d38SPaul E. McKenney  * to SRCU_SIZE_BIG.  But only if the srcutree.convert_to_big module
356c2445d38SPaul E. McKenney  * parameter permits this.
357c2445d38SPaul E. McKenney  */
358c2445d38SPaul E. McKenney static void spin_lock_irqsave_sdp_contention(struct srcu_data *sdp, unsigned long *flags)
359c2445d38SPaul E. McKenney {
360c2445d38SPaul E. McKenney 	struct srcu_struct *ssp = sdp->ssp;
361c2445d38SPaul E. McKenney 
362c2445d38SPaul E. McKenney 	if (spin_trylock_irqsave_rcu_node(sdp, *flags))
363c2445d38SPaul E. McKenney 		return;
364c2445d38SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, *flags);
365c2445d38SPaul E. McKenney 	spin_lock_irqsave_check_contention(ssp);
366c2445d38SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, *flags);
367c2445d38SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sdp, *flags);
368c2445d38SPaul E. McKenney }
369c2445d38SPaul E. McKenney 
370c2445d38SPaul E. McKenney /*
371c2445d38SPaul E. McKenney  * Acquire the specified srcu_struct structure's ->lock, but check for
372c2445d38SPaul E. McKenney  * excessive contention, which results in initiation of a transition
373c2445d38SPaul E. McKenney  * to SRCU_SIZE_BIG.  But only if the srcutree.convert_to_big module
374c2445d38SPaul E. McKenney  * parameter permits this.
375c2445d38SPaul E. McKenney  */
376c2445d38SPaul E. McKenney static void spin_lock_irqsave_ssp_contention(struct srcu_struct *ssp, unsigned long *flags)
377c2445d38SPaul E. McKenney {
378c2445d38SPaul E. McKenney 	if (spin_trylock_irqsave_rcu_node(ssp, *flags))
379c2445d38SPaul E. McKenney 		return;
380c2445d38SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, *flags);
381c2445d38SPaul E. McKenney 	spin_lock_irqsave_check_contention(ssp);
382c2445d38SPaul E. McKenney }
383c2445d38SPaul E. McKenney 
384c2445d38SPaul E. McKenney /*
385da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
386da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
387da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
388aacb5d91SPaul E. McKenney  * to each update-side SRCU primitive.  Use ssp->lock, which -is-
389da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
390da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
391da915ad5SPaul E. McKenney  */
392aacb5d91SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *ssp)
393da915ad5SPaul E. McKenney {
394da915ad5SPaul E. McKenney 	unsigned long flags;
395da915ad5SPaul E. McKenney 
396da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
397aacb5d91SPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq_needed))) /*^^^*/
398da915ad5SPaul E. McKenney 		return; /* Already initialized. */
399aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
400aacb5d91SPaul E. McKenney 	if (!rcu_seq_state(ssp->srcu_gp_seq_needed)) {
401aacb5d91SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(ssp, flags);
402da915ad5SPaul E. McKenney 		return;
403da915ad5SPaul E. McKenney 	}
404aacb5d91SPaul E. McKenney 	init_srcu_struct_fields(ssp, true);
405aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
406da915ad5SPaul E. McKenney }
407da915ad5SPaul E. McKenney 
408da915ad5SPaul E. McKenney /*
409da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
410da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
411dad81a20SPaul E. McKenney  */
412aacb5d91SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *ssp, int idx)
413dad81a20SPaul E. McKenney {
414dad81a20SPaul E. McKenney 	int cpu;
415dad81a20SPaul E. McKenney 	unsigned long sum = 0;
416dad81a20SPaul E. McKenney 
417dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
418aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
419dad81a20SPaul E. McKenney 
4205d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_lock_count[idx]);
421dad81a20SPaul E. McKenney 	}
422dad81a20SPaul E. McKenney 	return sum;
423dad81a20SPaul E. McKenney }
424dad81a20SPaul E. McKenney 
425dad81a20SPaul E. McKenney /*
426da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
427da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
428dad81a20SPaul E. McKenney  */
429aacb5d91SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *ssp, int idx)
430dad81a20SPaul E. McKenney {
431dad81a20SPaul E. McKenney 	int cpu;
432dad81a20SPaul E. McKenney 	unsigned long sum = 0;
433dad81a20SPaul E. McKenney 
434dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
435aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
436dad81a20SPaul E. McKenney 
4375d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_unlock_count[idx]);
438dad81a20SPaul E. McKenney 	}
439dad81a20SPaul E. McKenney 	return sum;
440dad81a20SPaul E. McKenney }
441dad81a20SPaul E. McKenney 
442dad81a20SPaul E. McKenney /*
443dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
444dad81a20SPaul E. McKenney  * be zero.
445dad81a20SPaul E. McKenney  */
446aacb5d91SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *ssp, int idx)
447dad81a20SPaul E. McKenney {
448dad81a20SPaul E. McKenney 	unsigned long unlocks;
449dad81a20SPaul E. McKenney 
450aacb5d91SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(ssp, idx);
451dad81a20SPaul E. McKenney 
452dad81a20SPaul E. McKenney 	/*
453dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
454dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
455dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
456dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
457dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
458dad81a20SPaul E. McKenney 	 *
459dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
460dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
461dad81a20SPaul E. McKenney 	 * grace period ends.
462dad81a20SPaul E. McKenney 	 */
463dad81a20SPaul E. McKenney 	smp_mb(); /* A */
464dad81a20SPaul E. McKenney 
465dad81a20SPaul E. McKenney 	/*
466dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
467dad81a20SPaul E. McKenney 	 * been no readers on this index at some time in between. This does
468dad81a20SPaul E. McKenney 	 * not mean that there are no more readers, as one could have read
469dad81a20SPaul E. McKenney 	 * the current index but not have incremented the lock counter yet.
470dad81a20SPaul E. McKenney 	 *
471881ec9d2SPaul E. McKenney 	 * So suppose that the updater is preempted here for so long
472881ec9d2SPaul E. McKenney 	 * that more than ULONG_MAX non-nested readers come and go in
473881ec9d2SPaul E. McKenney 	 * the meantime.  It turns out that this cannot result in overflow
474881ec9d2SPaul E. McKenney 	 * because if a reader modifies its unlock count after we read it
475881ec9d2SPaul E. McKenney 	 * above, then that reader's next load of ->srcu_idx is guaranteed
476881ec9d2SPaul E. McKenney 	 * to get the new value, which will cause it to operate on the
477881ec9d2SPaul E. McKenney 	 * other bank of counters, where it cannot contribute to the
478881ec9d2SPaul E. McKenney 	 * overflow of these counters.  This means that there is a maximum
479881ec9d2SPaul E. McKenney 	 * of 2*NR_CPUS increments, which cannot overflow given current
480881ec9d2SPaul E. McKenney 	 * systems, especially not on 64-bit systems.
481881ec9d2SPaul E. McKenney 	 *
482881ec9d2SPaul E. McKenney 	 * OK, how about nesting?  This does impose a limit on nesting
483881ec9d2SPaul E. McKenney 	 * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
484881ec9d2SPaul E. McKenney 	 * especially on 64-bit systems.
485dad81a20SPaul E. McKenney 	 */
486aacb5d91SPaul E. McKenney 	return srcu_readers_lock_idx(ssp, idx) == unlocks;
487dad81a20SPaul E. McKenney }
488dad81a20SPaul E. McKenney 
489dad81a20SPaul E. McKenney /**
490dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
491dad81a20SPaul E. McKenney  *                       otherwise
492aacb5d91SPaul E. McKenney  * @ssp: which srcu_struct to count active readers (holding srcu_read_lock).
493dad81a20SPaul E. McKenney  *
494dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
495dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
496dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
497dad81a20SPaul E. McKenney  */
498aacb5d91SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *ssp)
499dad81a20SPaul E. McKenney {
500dad81a20SPaul E. McKenney 	int cpu;
501dad81a20SPaul E. McKenney 	unsigned long sum = 0;
502dad81a20SPaul E. McKenney 
503dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
504aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
505dad81a20SPaul E. McKenney 
5065d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_lock_count[0]);
5075d0f5953SPaul E. McKenney 		sum += atomic_long_read(&cpuc->srcu_lock_count[1]);
5085d0f5953SPaul E. McKenney 		sum -= atomic_long_read(&cpuc->srcu_unlock_count[0]);
5095d0f5953SPaul E. McKenney 		sum -= atomic_long_read(&cpuc->srcu_unlock_count[1]);
510dad81a20SPaul E. McKenney 	}
511dad81a20SPaul E. McKenney 	return sum;
512dad81a20SPaul E. McKenney }
513dad81a20SPaul E. McKenney 
5144f2bfd94SNeeraj Upadhyay /*
5154f2bfd94SNeeraj Upadhyay  * We use an adaptive strategy for synchronize_srcu() and especially for
5164f2bfd94SNeeraj Upadhyay  * synchronize_srcu_expedited().  We spin for a fixed time period
5174f2bfd94SNeeraj Upadhyay  * (defined below, boot time configurable) to allow SRCU readers to exit
5184f2bfd94SNeeraj Upadhyay  * their read-side critical sections.  If there are still some readers
5194f2bfd94SNeeraj Upadhyay  * after one jiffy, we repeatedly block for one jiffy time periods.
5204f2bfd94SNeeraj Upadhyay  * The blocking time is increased as the grace-period age increases,
5214f2bfd94SNeeraj Upadhyay  * with max blocking time capped at 10 jiffies.
5224f2bfd94SNeeraj Upadhyay  */
5234f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_RETRY_CHECK_DELAY		5
5244f2bfd94SNeeraj Upadhyay 
5254f2bfd94SNeeraj Upadhyay static ulong srcu_retry_check_delay = SRCU_DEFAULT_RETRY_CHECK_DELAY;
5264f2bfd94SNeeraj Upadhyay module_param(srcu_retry_check_delay, ulong, 0444);
5274f2bfd94SNeeraj Upadhyay 
528282d8998SPaul E. McKenney #define SRCU_INTERVAL		1		// Base delay if no expedited GPs pending.
529282d8998SPaul E. McKenney #define SRCU_MAX_INTERVAL	10		// Maximum incremental delay from slow readers.
5304f2bfd94SNeeraj Upadhyay 
5314f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE_LO	3UL	// Lowmark on default per-GP-phase
5324f2bfd94SNeeraj Upadhyay 							// no-delay instances.
5334f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE_HI	1000UL	// Highmark on default per-GP-phase
5344f2bfd94SNeeraj Upadhyay 							// no-delay instances.
5354f2bfd94SNeeraj Upadhyay 
5364f2bfd94SNeeraj Upadhyay #define SRCU_UL_CLAMP_LO(val, low)	((val) > (low) ? (val) : (low))
5374f2bfd94SNeeraj Upadhyay #define SRCU_UL_CLAMP_HI(val, high)	((val) < (high) ? (val) : (high))
5384f2bfd94SNeeraj Upadhyay #define SRCU_UL_CLAMP(val, low, high)	SRCU_UL_CLAMP_HI(SRCU_UL_CLAMP_LO((val), (low)), (high))
5394f2bfd94SNeeraj Upadhyay // per-GP-phase no-delay instances adjusted to allow non-sleeping poll upto
5404f2bfd94SNeeraj Upadhyay // one jiffies time duration. Mult by 2 is done to factor in the srcu_get_delay()
5414f2bfd94SNeeraj Upadhyay // called from process_srcu().
5424f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE_ADJUSTED	\
5434f2bfd94SNeeraj Upadhyay 	(2UL * USEC_PER_SEC / HZ / SRCU_DEFAULT_RETRY_CHECK_DELAY)
5444f2bfd94SNeeraj Upadhyay 
5454f2bfd94SNeeraj Upadhyay // Maximum per-GP-phase consecutive no-delay instances.
5464f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY_PHASE	\
5474f2bfd94SNeeraj Upadhyay 	SRCU_UL_CLAMP(SRCU_DEFAULT_MAX_NODELAY_PHASE_ADJUSTED,	\
5484f2bfd94SNeeraj Upadhyay 		      SRCU_DEFAULT_MAX_NODELAY_PHASE_LO,	\
5494f2bfd94SNeeraj Upadhyay 		      SRCU_DEFAULT_MAX_NODELAY_PHASE_HI)
5504f2bfd94SNeeraj Upadhyay 
5514f2bfd94SNeeraj Upadhyay static ulong srcu_max_nodelay_phase = SRCU_DEFAULT_MAX_NODELAY_PHASE;
5524f2bfd94SNeeraj Upadhyay module_param(srcu_max_nodelay_phase, ulong, 0444);
5534f2bfd94SNeeraj Upadhyay 
5544f2bfd94SNeeraj Upadhyay // Maximum consecutive no-delay instances.
5554f2bfd94SNeeraj Upadhyay #define SRCU_DEFAULT_MAX_NODELAY	(SRCU_DEFAULT_MAX_NODELAY_PHASE > 100 ?	\
5564f2bfd94SNeeraj Upadhyay 					 SRCU_DEFAULT_MAX_NODELAY_PHASE : 100)
5574f2bfd94SNeeraj Upadhyay 
5584f2bfd94SNeeraj Upadhyay static ulong srcu_max_nodelay = SRCU_DEFAULT_MAX_NODELAY;
5594f2bfd94SNeeraj Upadhyay module_param(srcu_max_nodelay, ulong, 0444);
560dad81a20SPaul E. McKenney 
5611e9a038bSPaul E. McKenney /*
5621e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
5631e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
5641e9a038bSPaul E. McKenney  */
565aacb5d91SPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *ssp)
5661e9a038bSPaul E. McKenney {
5678f870e6eSPaul E. McKenney 	unsigned long gpstart;
5688f870e6eSPaul E. McKenney 	unsigned long j;
569282d8998SPaul E. McKenney 	unsigned long jbase = SRCU_INTERVAL;
570282d8998SPaul E. McKenney 
571cbdc98e9SPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_gp_seq), READ_ONCE(ssp->srcu_gp_seq_needed_exp)))
572282d8998SPaul E. McKenney 		jbase = 0;
5738f870e6eSPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq))) {
5748f870e6eSPaul E. McKenney 		j = jiffies - 1;
5758f870e6eSPaul E. McKenney 		gpstart = READ_ONCE(ssp->srcu_gp_start);
5768f870e6eSPaul E. McKenney 		if (time_after(j, gpstart))
5778f870e6eSPaul E. McKenney 			jbase += j - gpstart;
578282d8998SPaul E. McKenney 		if (!jbase) {
579282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->srcu_n_exp_nodelay, READ_ONCE(ssp->srcu_n_exp_nodelay) + 1);
5804f2bfd94SNeeraj Upadhyay 			if (READ_ONCE(ssp->srcu_n_exp_nodelay) > srcu_max_nodelay_phase)
581282d8998SPaul E. McKenney 				jbase = 1;
582282d8998SPaul E. McKenney 		}
5838f870e6eSPaul E. McKenney 	}
584282d8998SPaul E. McKenney 	return jbase > SRCU_MAX_INTERVAL ? SRCU_MAX_INTERVAL : jbase;
5851e9a038bSPaul E. McKenney }
5861e9a038bSPaul E. McKenney 
587f5ad3991SPaul E. McKenney /**
588f5ad3991SPaul E. McKenney  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
589f5ad3991SPaul E. McKenney  * @ssp: structure to clean up.
590f5ad3991SPaul E. McKenney  *
591f5ad3991SPaul E. McKenney  * Must invoke this after you are finished using a given srcu_struct that
592f5ad3991SPaul E. McKenney  * was initialized via init_srcu_struct(), else you leak memory.
593f5ad3991SPaul E. McKenney  */
594f5ad3991SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *ssp)
595dad81a20SPaul E. McKenney {
596da915ad5SPaul E. McKenney 	int cpu;
597da915ad5SPaul E. McKenney 
598aacb5d91SPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(ssp)))
599f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
600aacb5d91SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(ssp)))
601f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
602aacb5d91SPaul E. McKenney 	flush_delayed_work(&ssp->work);
603e81baf4cSSebastian Andrzej Siewior 	for_each_possible_cpu(cpu) {
604e81baf4cSSebastian Andrzej Siewior 		struct srcu_data *sdp = per_cpu_ptr(ssp->sda, cpu);
605e81baf4cSSebastian Andrzej Siewior 
606e81baf4cSSebastian Andrzej Siewior 		del_timer_sync(&sdp->delay_work);
607e81baf4cSSebastian Andrzej Siewior 		flush_work(&sdp->work);
6085cdfd174SPaul E. McKenney 		if (WARN_ON(rcu_segcblist_n_cbs(&sdp->srcu_cblist)))
6095cdfd174SPaul E. McKenney 			return; /* Forgot srcu_barrier(), so just leak it! */
610f7194ac3SPaul E. McKenney 	}
611aacb5d91SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
6128ed00760SPaul E. McKenney 	    WARN_ON(rcu_seq_current(&ssp->srcu_gp_seq) != ssp->srcu_gp_seq_needed) ||
613aacb5d91SPaul E. McKenney 	    WARN_ON(srcu_readers_active(ssp))) {
6148ed00760SPaul E. McKenney 		pr_info("%s: Active srcu_struct %p read state: %d gp state: %lu/%lu\n",
6158ed00760SPaul E. McKenney 			__func__, ssp, rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)),
6168ed00760SPaul E. McKenney 			rcu_seq_current(&ssp->srcu_gp_seq), ssp->srcu_gp_seq_needed);
617dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
618dad81a20SPaul E. McKenney 	}
61946470cf8SPaul E. McKenney 	if (!ssp->sda_is_static) {
620aacb5d91SPaul E. McKenney 		free_percpu(ssp->sda);
621aacb5d91SPaul E. McKenney 		ssp->sda = NULL;
62246470cf8SPaul E. McKenney 	}
6232ec30311SPaul E. McKenney 	kfree(ssp->node);
6242ec30311SPaul E. McKenney 	ssp->node = NULL;
625994f7068SPaul E. McKenney 	ssp->srcu_size_state = SRCU_SIZE_SMALL;
626dad81a20SPaul E. McKenney }
627f5ad3991SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
628dad81a20SPaul E. McKenney 
629dad81a20SPaul E. McKenney /*
630dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
631cdf7abc4SPaolo Bonzini  * srcu_struct.
632dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
633dad81a20SPaul E. McKenney  */
634aacb5d91SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *ssp)
635dad81a20SPaul E. McKenney {
636dad81a20SPaul E. McKenney 	int idx;
637dad81a20SPaul E. McKenney 
638aacb5d91SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
6395d0f5953SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_lock_count[idx].counter);
640dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
641dad81a20SPaul E. McKenney 	return idx;
642dad81a20SPaul E. McKenney }
643dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
644dad81a20SPaul E. McKenney 
645dad81a20SPaul E. McKenney /*
646dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
647dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
648dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
649dad81a20SPaul E. McKenney  */
650aacb5d91SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *ssp, int idx)
651dad81a20SPaul E. McKenney {
652dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
6535d0f5953SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_unlock_count[idx].counter);
654dad81a20SPaul E. McKenney }
655dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
656dad81a20SPaul E. McKenney 
657*2e83b879SPaul E. McKenney #ifdef CONFIG_NEED_SRCU_NMI_SAFE
658*2e83b879SPaul E. McKenney 
659*2e83b879SPaul E. McKenney /*
660*2e83b879SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
661*2e83b879SPaul E. McKenney  * srcu_struct, but in an NMI-safe manner using RMW atomics.
662*2e83b879SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
663*2e83b879SPaul E. McKenney  */
664*2e83b879SPaul E. McKenney int __srcu_read_lock_nmisafe(struct srcu_struct *ssp)
665*2e83b879SPaul E. McKenney {
666*2e83b879SPaul E. McKenney 	int idx;
667*2e83b879SPaul E. McKenney 	struct srcu_data *sdp = raw_cpu_ptr(ssp->sda);
668*2e83b879SPaul E. McKenney 
669*2e83b879SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
670*2e83b879SPaul E. McKenney 	atomic_long_inc(&sdp->srcu_lock_count[idx]);
671*2e83b879SPaul E. McKenney 	smp_mb__after_atomic(); /* B */  /* Avoid leaking the critical section. */
672*2e83b879SPaul E. McKenney 	return idx;
673*2e83b879SPaul E. McKenney }
674*2e83b879SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock_nmisafe);
675*2e83b879SPaul E. McKenney 
676*2e83b879SPaul E. McKenney /*
677*2e83b879SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
678*2e83b879SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
679*2e83b879SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
680*2e83b879SPaul E. McKenney  */
681*2e83b879SPaul E. McKenney void __srcu_read_unlock_nmisafe(struct srcu_struct *ssp, int idx)
682*2e83b879SPaul E. McKenney {
683*2e83b879SPaul E. McKenney 	struct srcu_data *sdp = raw_cpu_ptr(ssp->sda);
684*2e83b879SPaul E. McKenney 
685*2e83b879SPaul E. McKenney 	smp_mb__before_atomic(); /* C */  /* Avoid leaking the critical section. */
686*2e83b879SPaul E. McKenney 	atomic_long_inc(&sdp->srcu_unlock_count[idx]);
687*2e83b879SPaul E. McKenney }
688*2e83b879SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock_nmisafe);
689*2e83b879SPaul E. McKenney 
690*2e83b879SPaul E. McKenney #endif // CONFIG_NEED_SRCU_NMI_SAFE
691*2e83b879SPaul E. McKenney 
692dad81a20SPaul E. McKenney /*
693dad81a20SPaul E. McKenney  * Start an SRCU grace period.
694dad81a20SPaul E. McKenney  */
695aacb5d91SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *ssp)
696dad81a20SPaul E. McKenney {
697586e31d5SLukas Bulwahn 	struct srcu_data *sdp;
698dad81a20SPaul E. McKenney 	int state;
699dad81a20SPaul E. McKenney 
700994f7068SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_size_state) < SRCU_SIZE_WAIT_BARRIER)
701994f7068SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, 0);
702994f7068SPaul E. McKenney 	else
703994f7068SPaul E. McKenney 		sdp = this_cpu_ptr(ssp->sda);
704aacb5d91SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp, lock));
705aacb5d91SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
706eb4c2382SDennis Krein 	spin_lock_rcu_node(sdp);  /* Interrupts already disabled. */
707da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
708aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
709da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
710aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
711eb4c2382SDennis Krein 	spin_unlock_rcu_node(sdp);  /* Interrupts remain disabled. */
712282d8998SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_gp_start, jiffies);
713282d8998SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_n_exp_nodelay, 0);
7142da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
715aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_gp_seq);
71671042606SPaul E. McKenney 	state = rcu_seq_state(ssp->srcu_gp_seq);
717dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
718dad81a20SPaul E. McKenney }
719dad81a20SPaul E. McKenney 
720da915ad5SPaul E. McKenney 
721e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t)
722da915ad5SPaul E. McKenney {
723e81baf4cSSebastian Andrzej Siewior 	struct srcu_data *sdp = container_of(t, struct srcu_data, delay_work);
724e81baf4cSSebastian Andrzej Siewior 
725e81baf4cSSebastian Andrzej Siewior 	queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
726da915ad5SPaul E. McKenney }
727da915ad5SPaul E. McKenney 
728e81baf4cSSebastian Andrzej Siewior static void srcu_queue_delayed_work_on(struct srcu_data *sdp,
729da915ad5SPaul E. McKenney 				       unsigned long delay)
730da915ad5SPaul E. McKenney {
731e81baf4cSSebastian Andrzej Siewior 	if (!delay) {
732e81baf4cSSebastian Andrzej Siewior 		queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
733e81baf4cSSebastian Andrzej Siewior 		return;
734e81baf4cSSebastian Andrzej Siewior 	}
735da915ad5SPaul E. McKenney 
736e81baf4cSSebastian Andrzej Siewior 	timer_reduce(&sdp->delay_work, jiffies + delay);
737da915ad5SPaul E. McKenney }
738da915ad5SPaul E. McKenney 
739da915ad5SPaul E. McKenney /*
740da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
741da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
742da915ad5SPaul E. McKenney  */
743da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
744da915ad5SPaul E. McKenney {
745e81baf4cSSebastian Andrzej Siewior 	srcu_queue_delayed_work_on(sdp, delay);
746da915ad5SPaul E. McKenney }
747da915ad5SPaul E. McKenney 
748da915ad5SPaul E. McKenney /*
749da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
750c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
751c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
752c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
753da915ad5SPaul E. McKenney  */
754aacb5d91SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *ssp, struct srcu_node *snp,
7551e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
756da915ad5SPaul E. McKenney {
757da915ad5SPaul E. McKenney 	int cpu;
758da915ad5SPaul E. McKenney 
759c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
760c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
761c7e88067SPaul E. McKenney 			continue;
762aacb5d91SPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, cpu), delay);
763da915ad5SPaul E. McKenney 	}
764c7e88067SPaul E. McKenney }
765da915ad5SPaul E. McKenney 
766da915ad5SPaul E. McKenney /*
767da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
768da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
769da915ad5SPaul E. McKenney  *
770da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
771da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
772da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
773da915ad5SPaul E. McKenney  * array to have a finite number of elements.
774da915ad5SPaul E. McKenney  */
775aacb5d91SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *ssp)
776da915ad5SPaul E. McKenney {
7774f2bfd94SNeeraj Upadhyay 	unsigned long cbdelay = 1;
778da915ad5SPaul E. McKenney 	bool cbs;
7798ddbd883SIldar Ismagilov 	bool last_lvl;
780c350c008SPaul E. McKenney 	int cpu;
781c350c008SPaul E. McKenney 	unsigned long flags;
782da915ad5SPaul E. McKenney 	unsigned long gpseq;
783da915ad5SPaul E. McKenney 	int idx;
784c7e88067SPaul E. McKenney 	unsigned long mask;
785c350c008SPaul E. McKenney 	struct srcu_data *sdp;
786cbdc98e9SPaul E. McKenney 	unsigned long sgsne;
787da915ad5SPaul E. McKenney 	struct srcu_node *snp;
788e2f63836SPaul E. McKenney 	int ss_state;
789da915ad5SPaul E. McKenney 
790da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
791aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_cb_mutex);
792da915ad5SPaul E. McKenney 
793da915ad5SPaul E. McKenney 	/* End the current grace period. */
794aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
795aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(ssp->srcu_gp_seq);
796da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
7974f2bfd94SNeeraj Upadhyay 	if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_gp_seq), READ_ONCE(ssp->srcu_gp_seq_needed_exp)))
7984f2bfd94SNeeraj Upadhyay 		cbdelay = 0;
7994f2bfd94SNeeraj Upadhyay 
800844a378dSPaul E. McKenney 	WRITE_ONCE(ssp->srcu_last_gp_end, ktime_get_mono_fast_ns());
801aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_gp_seq);
802aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
803aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, gpseq))
8048c9e0cb3SPaul E. McKenney 		WRITE_ONCE(ssp->srcu_gp_seq_needed_exp, gpseq);
805aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
806aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_gp_mutex);
807da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
808da915ad5SPaul E. McKenney 
809da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
810c69a00a1SPaul E. McKenney 	ss_state = smp_load_acquire(&ssp->srcu_size_state);
811c69a00a1SPaul E. McKenney 	if (ss_state < SRCU_SIZE_WAIT_BARRIER) {
812994f7068SPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, 0), cbdelay);
813994f7068SPaul E. McKenney 	} else {
814da915ad5SPaul E. McKenney 		idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
815aacb5d91SPaul E. McKenney 		srcu_for_each_node_breadth_first(ssp, snp) {
816d6331980SPaul E. McKenney 			spin_lock_irq_rcu_node(snp);
817da915ad5SPaul E. McKenney 			cbs = false;
818aacb5d91SPaul E. McKenney 			last_lvl = snp >= ssp->level[rcu_num_lvls - 1];
8198ddbd883SIldar Ismagilov 			if (last_lvl)
820c69a00a1SPaul E. McKenney 				cbs = ss_state < SRCU_SIZE_BIG || snp->srcu_have_cbs[idx] == gpseq;
821da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[idx] = gpseq;
822da915ad5SPaul E. McKenney 			rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
823cbdc98e9SPaul E. McKenney 			sgsne = snp->srcu_gp_seq_needed_exp;
824cbdc98e9SPaul E. McKenney 			if (srcu_invl_snp_seq(sgsne) || ULONG_CMP_LT(sgsne, gpseq))
8257ff8b450SPaul E. McKenney 				WRITE_ONCE(snp->srcu_gp_seq_needed_exp, gpseq);
826c69a00a1SPaul E. McKenney 			if (ss_state < SRCU_SIZE_BIG)
827c69a00a1SPaul E. McKenney 				mask = ~0;
828c69a00a1SPaul E. McKenney 			else
829c7e88067SPaul E. McKenney 				mask = snp->srcu_data_have_cbs[idx];
830c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] = 0;
831d6331980SPaul E. McKenney 			spin_unlock_irq_rcu_node(snp);
832a3883df3SPaul E. McKenney 			if (cbs)
833aacb5d91SPaul E. McKenney 				srcu_schedule_cbs_snp(ssp, snp, mask, cbdelay);
834994f7068SPaul E. McKenney 		}
835994f7068SPaul E. McKenney 	}
836c350c008SPaul E. McKenney 
837c350c008SPaul E. McKenney 	/* Occasionally prevent srcu_data counter wrap. */
838994f7068SPaul E. McKenney 	if (!(gpseq & counter_wrap_check))
839994f7068SPaul E. McKenney 		for_each_possible_cpu(cpu) {
840aacb5d91SPaul E. McKenney 			sdp = per_cpu_ptr(ssp->sda, cpu);
841d6331980SPaul E. McKenney 			spin_lock_irqsave_rcu_node(sdp, flags);
842994f7068SPaul E. McKenney 			if (ULONG_CMP_GE(gpseq, sdp->srcu_gp_seq_needed + 100))
843c350c008SPaul E. McKenney 				sdp->srcu_gp_seq_needed = gpseq;
844994f7068SPaul E. McKenney 			if (ULONG_CMP_GE(gpseq, sdp->srcu_gp_seq_needed_exp + 100))
845a35d13ecSIldar Ismagilov 				sdp->srcu_gp_seq_needed_exp = gpseq;
846d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(sdp, flags);
847c350c008SPaul E. McKenney 		}
848da915ad5SPaul E. McKenney 
849da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
850aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_cb_mutex);
851da915ad5SPaul E. McKenney 
852da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
853aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
854aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
855da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
856aacb5d91SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, ssp->srcu_gp_seq_needed)) {
857aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
858aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
859aacb5d91SPaul E. McKenney 		srcu_reschedule(ssp, 0);
860da915ad5SPaul E. McKenney 	} else {
861aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
862da915ad5SPaul E. McKenney 	}
863e2f63836SPaul E. McKenney 
864e2f63836SPaul E. McKenney 	/* Transition to big if needed. */
865e2f63836SPaul E. McKenney 	if (ss_state != SRCU_SIZE_SMALL && ss_state != SRCU_SIZE_BIG) {
866e2f63836SPaul E. McKenney 		if (ss_state == SRCU_SIZE_ALLOC)
867c69a00a1SPaul E. McKenney 			init_srcu_struct_nodes(ssp, GFP_KERNEL);
868e2f63836SPaul E. McKenney 		else
869e2f63836SPaul E. McKenney 			smp_store_release(&ssp->srcu_size_state, ss_state + 1);
870e2f63836SPaul E. McKenney 	}
871da915ad5SPaul E. McKenney }
872da915ad5SPaul E. McKenney 
873da915ad5SPaul E. McKenney /*
8741e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
8751e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
8761e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
8771e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
8781e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
8791e9a038bSPaul E. McKenney  */
880aacb5d91SPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *ssp, struct srcu_node *snp,
8811e9a038bSPaul E. McKenney 				  unsigned long s)
8821e9a038bSPaul E. McKenney {
8831e9a038bSPaul E. McKenney 	unsigned long flags;
884cbdc98e9SPaul E. McKenney 	unsigned long sgsne;
8851e9a038bSPaul E. McKenney 
886994f7068SPaul E. McKenney 	if (snp)
8871e9a038bSPaul E. McKenney 		for (; snp != NULL; snp = snp->srcu_parent) {
888cbdc98e9SPaul E. McKenney 			sgsne = READ_ONCE(snp->srcu_gp_seq_needed_exp);
889aacb5d91SPaul E. McKenney 			if (rcu_seq_done(&ssp->srcu_gp_seq, s) ||
890cbdc98e9SPaul E. McKenney 			    (!srcu_invl_snp_seq(sgsne) && ULONG_CMP_GE(sgsne, s)))
8911e9a038bSPaul E. McKenney 				return;
892d6331980SPaul E. McKenney 			spin_lock_irqsave_rcu_node(snp, flags);
893cbdc98e9SPaul E. McKenney 			sgsne = snp->srcu_gp_seq_needed_exp;
894cbdc98e9SPaul E. McKenney 			if (!srcu_invl_snp_seq(sgsne) && ULONG_CMP_GE(sgsne, s)) {
895d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(snp, flags);
8961e9a038bSPaul E. McKenney 				return;
8971e9a038bSPaul E. McKenney 			}
8981e9a038bSPaul E. McKenney 			WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
899d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
9001e9a038bSPaul E. McKenney 		}
9019f2e91d9SPaul E. McKenney 	spin_lock_irqsave_ssp_contention(ssp, &flags);
902aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
9038c9e0cb3SPaul E. McKenney 		WRITE_ONCE(ssp->srcu_gp_seq_needed_exp, s);
904aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
9051e9a038bSPaul E. McKenney }
9061e9a038bSPaul E. McKenney 
9071e9a038bSPaul E. McKenney /*
908da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
909da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
910da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
911da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
912da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
91317294ce6SPaul E. McKenney  *
91417294ce6SPaul E. McKenney  * Note that this function also does the work of srcu_funnel_exp_start(),
91517294ce6SPaul E. McKenney  * in some cases by directly invoking it.
916da915ad5SPaul E. McKenney  */
917aacb5d91SPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *ssp, struct srcu_data *sdp,
9181e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
919da915ad5SPaul E. McKenney {
920da915ad5SPaul E. McKenney 	unsigned long flags;
921da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
922cbdc98e9SPaul E. McKenney 	unsigned long sgsne;
9237b9e9b58SPaul E. McKenney 	struct srcu_node *snp;
9240b56f953SNeeraj Upadhyay 	struct srcu_node *snp_leaf;
925da915ad5SPaul E. McKenney 	unsigned long snp_seq;
926da915ad5SPaul E. McKenney 
9270b56f953SNeeraj Upadhyay 	/* Ensure that snp node tree is fully initialized before traversing it */
9280b56f953SNeeraj Upadhyay 	if (smp_load_acquire(&ssp->srcu_size_state) < SRCU_SIZE_WAIT_BARRIER)
9290b56f953SNeeraj Upadhyay 		snp_leaf = NULL;
9300b56f953SNeeraj Upadhyay 	else
9310b56f953SNeeraj Upadhyay 		snp_leaf = sdp->mynode;
9320b56f953SNeeraj Upadhyay 
933994f7068SPaul E. McKenney 	if (snp_leaf)
934da915ad5SPaul E. McKenney 		/* Each pass through the loop does one level of the srcu_node tree. */
9357b9e9b58SPaul E. McKenney 		for (snp = snp_leaf; snp != NULL; snp = snp->srcu_parent) {
9367b9e9b58SPaul E. McKenney 			if (rcu_seq_done(&ssp->srcu_gp_seq, s) && snp != snp_leaf)
937da915ad5SPaul E. McKenney 				return; /* GP already done and CBs recorded. */
938d6331980SPaul E. McKenney 			spin_lock_irqsave_rcu_node(snp, flags);
939da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
940cbdc98e9SPaul E. McKenney 			if (!srcu_invl_snp_seq(snp_seq) && ULONG_CMP_GE(snp_seq, s)) {
9417b9e9b58SPaul E. McKenney 				if (snp == snp_leaf && snp_seq == s)
942c7e88067SPaul E. McKenney 					snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
943d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(snp, flags);
9447b9e9b58SPaul E. McKenney 				if (snp == snp_leaf && snp_seq != s) {
945aeb9b39bSPaul E. McKenney 					srcu_schedule_cbs_sdp(sdp, do_norm ? SRCU_INTERVAL : 0);
9461e9a038bSPaul E. McKenney 					return;
947da915ad5SPaul E. McKenney 				}
9481e9a038bSPaul E. McKenney 				if (!do_norm)
949aacb5d91SPaul E. McKenney 					srcu_funnel_exp_start(ssp, snp, s);
950da915ad5SPaul E. McKenney 				return;
951da915ad5SPaul E. McKenney 			}
952da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[idx] = s;
9537b9e9b58SPaul E. McKenney 			if (snp == snp_leaf)
954c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
955cbdc98e9SPaul E. McKenney 			sgsne = snp->srcu_gp_seq_needed_exp;
956cbdc98e9SPaul E. McKenney 			if (!do_norm && (srcu_invl_snp_seq(sgsne) || ULONG_CMP_LT(sgsne, s)))
9577ff8b450SPaul E. McKenney 				WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
958d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
959da915ad5SPaul E. McKenney 		}
960da915ad5SPaul E. McKenney 
961da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
9629f2e91d9SPaul E. McKenney 	spin_lock_irqsave_ssp_contention(ssp, &flags);
963aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed, s)) {
964da915ad5SPaul E. McKenney 		/*
965da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
966da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
967da915ad5SPaul E. McKenney 		 */
968aacb5d91SPaul E. McKenney 		smp_store_release(&ssp->srcu_gp_seq_needed, s); /*^^^*/
969da915ad5SPaul E. McKenney 	}
970aacb5d91SPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
9718c9e0cb3SPaul E. McKenney 		WRITE_ONCE(ssp->srcu_gp_seq_needed_exp, s);
972da915ad5SPaul E. McKenney 
973da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
974aacb5d91SPaul E. McKenney 	if (!rcu_seq_done(&ssp->srcu_gp_seq, s) &&
975aacb5d91SPaul E. McKenney 	    rcu_seq_state(ssp->srcu_gp_seq) == SRCU_STATE_IDLE) {
976aacb5d91SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
977aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
978ee5e2448SPaul E. McKenney 
979ee5e2448SPaul E. McKenney 		// And how can that list_add() in the "else" clause
980ee5e2448SPaul E. McKenney 		// possibly be safe for concurrent execution?  Well,
981ee5e2448SPaul E. McKenney 		// it isn't.  And it does not have to be.  After all, it
982ee5e2448SPaul E. McKenney 		// can only be executed during early boot when there is only
983ee5e2448SPaul E. McKenney 		// the one boot CPU running with interrupts still disabled.
984e0fcba9aSPaul E. McKenney 		if (likely(srcu_init_done))
985aacb5d91SPaul E. McKenney 			queue_delayed_work(rcu_gp_wq, &ssp->work,
986282d8998SPaul E. McKenney 					   !!srcu_get_delay(ssp));
987aacb5d91SPaul E. McKenney 		else if (list_empty(&ssp->work.work.entry))
988aacb5d91SPaul E. McKenney 			list_add(&ssp->work.work.entry, &srcu_boot_list);
989da915ad5SPaul E. McKenney 	}
990aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
991da915ad5SPaul E. McKenney }
992da915ad5SPaul E. McKenney 
993da915ad5SPaul E. McKenney /*
994dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
995dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
996da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
997dad81a20SPaul E. McKenney  */
998aacb5d91SPaul E. McKenney static bool try_check_zero(struct srcu_struct *ssp, int idx, int trycount)
999dad81a20SPaul E. McKenney {
10004f2bfd94SNeeraj Upadhyay 	unsigned long curdelay;
10014f2bfd94SNeeraj Upadhyay 
10024f2bfd94SNeeraj Upadhyay 	curdelay = !srcu_get_delay(ssp);
10034f2bfd94SNeeraj Upadhyay 
1004dad81a20SPaul E. McKenney 	for (;;) {
1005aacb5d91SPaul E. McKenney 		if (srcu_readers_active_idx_check(ssp, idx))
1006dad81a20SPaul E. McKenney 			return true;
10074f2bfd94SNeeraj Upadhyay 		if ((--trycount + curdelay) <= 0)
1008dad81a20SPaul E. McKenney 			return false;
10094f2bfd94SNeeraj Upadhyay 		udelay(srcu_retry_check_delay);
1010dad81a20SPaul E. McKenney 	}
1011dad81a20SPaul E. McKenney }
1012dad81a20SPaul E. McKenney 
1013dad81a20SPaul E. McKenney /*
1014da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
1015da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
1016dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
1017dad81a20SPaul E. McKenney  */
1018aacb5d91SPaul E. McKenney static void srcu_flip(struct srcu_struct *ssp)
1019dad81a20SPaul E. McKenney {
1020881ec9d2SPaul E. McKenney 	/*
1021881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
1022881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
1023881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
1024881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
1025881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
1026881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
1027881ec9d2SPaul E. McKenney 	 */
1028881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
1029881ec9d2SPaul E. McKenney 
1030aacb5d91SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_idx, ssp->srcu_idx + 1);
1031dad81a20SPaul E. McKenney 
1032dad81a20SPaul E. McKenney 	/*
1033dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
1034dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
1035dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
1036dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
1037dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
1038dad81a20SPaul E. McKenney 	 */
1039dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
1040dad81a20SPaul E. McKenney }
1041dad81a20SPaul E. McKenney 
1042dad81a20SPaul E. McKenney /*
10432da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
10442da4b2a7SPaul E. McKenney  *
10452da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
10462da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
10472da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
10482da4b2a7SPaul E. McKenney  *
10492da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
10502da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
10512da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
10522da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
10532da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
10542da4b2a7SPaul E. McKenney  * but to accept this type of error.
10552da4b2a7SPaul E. McKenney  *
10562da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
10572da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
10582da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
10592da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
10607fef6cffSEthon Paul  * negligible when amortized over that time period, and the extra latency
10612da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
10622da4b2a7SPaul E. McKenney  */
1063aacb5d91SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *ssp)
10642da4b2a7SPaul E. McKenney {
106522607d66SPaul E. McKenney 	unsigned long curseq;
10662da4b2a7SPaul E. McKenney 	unsigned long flags;
10672da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
106822607d66SPaul E. McKenney 	unsigned long t;
1069844a378dSPaul E. McKenney 	unsigned long tlast;
10702da4b2a7SPaul E. McKenney 
1071bde50d8fSSebastian Andrzej Siewior 	check_init_srcu_struct(ssp);
10722da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
1073bde50d8fSSebastian Andrzej Siewior 	sdp = raw_cpu_ptr(ssp->sda);
1074bde50d8fSSebastian Andrzej Siewior 	spin_lock_irqsave_rcu_node(sdp, flags);
10752da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
1076bde50d8fSSebastian Andrzej Siewior 		spin_unlock_irqrestore_rcu_node(sdp, flags);
10772da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
10782da4b2a7SPaul E. McKenney 	}
1079bde50d8fSSebastian Andrzej Siewior 	spin_unlock_irqrestore_rcu_node(sdp, flags);
10802da4b2a7SPaul E. McKenney 
10812da4b2a7SPaul E. McKenney 	/*
1082a616aec9SIngo Molnar 	 * No local callbacks, so probabilistically probe global state.
10832da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
1084a616aec9SIngo Molnar 	 * kill scalability, hence the probabilistic nature of the probe.
10852da4b2a7SPaul E. McKenney 	 */
108622607d66SPaul E. McKenney 
108722607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
108822607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
1089844a378dSPaul E. McKenney 	tlast = READ_ONCE(ssp->srcu_last_gp_end);
109022607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
1091844a378dSPaul E. McKenney 	    time_in_range_open(t, tlast, tlast + exp_holdoff))
109222607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
109322607d66SPaul E. McKenney 
109422607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
1095aacb5d91SPaul E. McKenney 	curseq = rcu_seq_current(&ssp->srcu_gp_seq);
10962da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
1097aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(ssp->srcu_gp_seq_needed)))
10982da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
10992da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
1100aacb5d91SPaul E. McKenney 	if (curseq != rcu_seq_current(&ssp->srcu_gp_seq))
11012da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
11022da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
11032da4b2a7SPaul E. McKenney }
11042da4b2a7SPaul E. McKenney 
11052da4b2a7SPaul E. McKenney /*
1106a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
1107a602538eSPaul E. McKenney  */
1108a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
1109a602538eSPaul E. McKenney {
1110a602538eSPaul E. McKenney }
1111a602538eSPaul E. McKenney 
1112a602538eSPaul E. McKenney /*
111329d2bb94SPaul E. McKenney  * Start an SRCU grace period, and also queue the callback if non-NULL.
111429d2bb94SPaul E. McKenney  */
11155358c9faSPaul E. McKenney static unsigned long srcu_gp_start_if_needed(struct srcu_struct *ssp,
11165358c9faSPaul E. McKenney 					     struct rcu_head *rhp, bool do_norm)
111729d2bb94SPaul E. McKenney {
111829d2bb94SPaul E. McKenney 	unsigned long flags;
111929d2bb94SPaul E. McKenney 	int idx;
112029d2bb94SPaul E. McKenney 	bool needexp = false;
112129d2bb94SPaul E. McKenney 	bool needgp = false;
112229d2bb94SPaul E. McKenney 	unsigned long s;
112329d2bb94SPaul E. McKenney 	struct srcu_data *sdp;
11240b56f953SNeeraj Upadhyay 	struct srcu_node *sdp_mynode;
11250b56f953SNeeraj Upadhyay 	int ss_state;
112629d2bb94SPaul E. McKenney 
11275358c9faSPaul E. McKenney 	check_init_srcu_struct(ssp);
1128*2e83b879SPaul E. McKenney 	idx = __srcu_read_lock_nmisafe(ssp);
11290b56f953SNeeraj Upadhyay 	ss_state = smp_load_acquire(&ssp->srcu_size_state);
11300b56f953SNeeraj Upadhyay 	if (ss_state < SRCU_SIZE_WAIT_CALL)
1131994f7068SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, 0);
1132994f7068SPaul E. McKenney 	else
113329d2bb94SPaul E. McKenney 		sdp = raw_cpu_ptr(ssp->sda);
1134c2445d38SPaul E. McKenney 	spin_lock_irqsave_sdp_contention(sdp, &flags);
11355358c9faSPaul E. McKenney 	if (rhp)
113629d2bb94SPaul E. McKenney 		rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp);
113729d2bb94SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
113829d2bb94SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
113929d2bb94SPaul E. McKenney 	s = rcu_seq_snap(&ssp->srcu_gp_seq);
114029d2bb94SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
114129d2bb94SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
114229d2bb94SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
114329d2bb94SPaul E. McKenney 		needgp = true;
114429d2bb94SPaul E. McKenney 	}
114529d2bb94SPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
114629d2bb94SPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
114729d2bb94SPaul E. McKenney 		needexp = true;
114829d2bb94SPaul E. McKenney 	}
114929d2bb94SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
11500b56f953SNeeraj Upadhyay 
11510b56f953SNeeraj Upadhyay 	/* Ensure that snp node tree is fully initialized before traversing it */
11520b56f953SNeeraj Upadhyay 	if (ss_state < SRCU_SIZE_WAIT_BARRIER)
11530b56f953SNeeraj Upadhyay 		sdp_mynode = NULL;
11540b56f953SNeeraj Upadhyay 	else
11550b56f953SNeeraj Upadhyay 		sdp_mynode = sdp->mynode;
11560b56f953SNeeraj Upadhyay 
115729d2bb94SPaul E. McKenney 	if (needgp)
115829d2bb94SPaul E. McKenney 		srcu_funnel_gp_start(ssp, sdp, s, do_norm);
115929d2bb94SPaul E. McKenney 	else if (needexp)
11600b56f953SNeeraj Upadhyay 		srcu_funnel_exp_start(ssp, sdp_mynode, s);
1161*2e83b879SPaul E. McKenney 	__srcu_read_unlock_nmisafe(ssp, idx);
11625358c9faSPaul E. McKenney 	return s;
116329d2bb94SPaul E. McKenney }
116429d2bb94SPaul E. McKenney 
116529d2bb94SPaul E. McKenney /*
1166da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
1167da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
1168da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
1169dad81a20SPaul E. McKenney  *
1170dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
1171dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
1172dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
1173dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
1174dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
11755ef98a63SPaul E. McKenney  * preceded the call to call_srcu().  It also means that each CPU executing
1176dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
11775ef98a63SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_srcu()
1178dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
1179dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
1180dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
1181dad81a20SPaul E. McKenney  *
11825ef98a63SPaul E. McKenney  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
1183dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
1184dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
11855ef98a63SPaul E. McKenney  * interval between the call to call_srcu() and the invocation of "func()".
1186dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
1187dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
1188dad81a20SPaul E. McKenney  *
1189dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
1190dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
1191dad81a20SPaul E. McKenney  * srcu_struct structure.
1192dad81a20SPaul E. McKenney  */
119311b00045SJiang Biao static void __call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
11941e9a038bSPaul E. McKenney 			rcu_callback_t func, bool do_norm)
1195dad81a20SPaul E. McKenney {
1196a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
1197a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
1198a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
1199a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
1200a602538eSPaul E. McKenney 		return;
1201a602538eSPaul E. McKenney 	}
1202da915ad5SPaul E. McKenney 	rhp->func = func;
12035358c9faSPaul E. McKenney 	(void)srcu_gp_start_if_needed(ssp, rhp, do_norm);
12041e9a038bSPaul E. McKenney }
12051e9a038bSPaul E. McKenney 
12065a0465e1SPaul E. McKenney /**
12075a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
1208aacb5d91SPaul E. McKenney  * @ssp: srcu_struct in queue the callback
120927fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
12105a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
12115a0465e1SPaul E. McKenney  *
12125a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
12135a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
12145a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
12155a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
12165a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
12175a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
12185a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
12195a0465e1SPaul E. McKenney  *
12205a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
12215a0465e1SPaul E. McKenney  * be fast and must not block.
12225a0465e1SPaul E. McKenney  */
1223aacb5d91SPaul E. McKenney void call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
12241e9a038bSPaul E. McKenney 	       rcu_callback_t func)
12251e9a038bSPaul E. McKenney {
1226aacb5d91SPaul E. McKenney 	__call_srcu(ssp, rhp, func, true);
1227dad81a20SPaul E. McKenney }
1228dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
1229dad81a20SPaul E. McKenney 
1230dad81a20SPaul E. McKenney /*
1231dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
1232dad81a20SPaul E. McKenney  */
1233aacb5d91SPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *ssp, bool do_norm)
1234dad81a20SPaul E. McKenney {
1235dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
1236dad81a20SPaul E. McKenney 
1237f505d434SJakub Kicinski 	RCU_LOCKDEP_WARN(lockdep_is_held(ssp) ||
1238dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
1239dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
1240dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
1241dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
1242dad81a20SPaul E. McKenney 
1243dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
1244dad81a20SPaul E. McKenney 		return;
1245dad81a20SPaul E. McKenney 	might_sleep();
1246aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1247dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
1248da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
1249aacb5d91SPaul E. McKenney 	__call_srcu(ssp, &rcu.head, wakeme_after_rcu, do_norm);
1250dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
1251da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
125235732cf9SPaul E. McKenney 
125335732cf9SPaul E. McKenney 	/*
125435732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
1255d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
125635732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
125735732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
125835732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
125935732cf9SPaul E. McKenney 	 */
126035732cf9SPaul E. McKenney 	smp_mb();
1261dad81a20SPaul E. McKenney }
1262dad81a20SPaul E. McKenney 
1263dad81a20SPaul E. McKenney /**
1264dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
1265aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
1266dad81a20SPaul E. McKenney  *
1267dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
1268dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
1269dad81a20SPaul E. McKenney  *
1270dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
1271dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
1272dad81a20SPaul E. McKenney  */
1273aacb5d91SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *ssp)
1274dad81a20SPaul E. McKenney {
1275aacb5d91SPaul E. McKenney 	__synchronize_srcu(ssp, rcu_gp_is_normal());
1276dad81a20SPaul E. McKenney }
1277dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
1278dad81a20SPaul E. McKenney 
1279dad81a20SPaul E. McKenney /**
1280dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
1281aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
1282dad81a20SPaul E. McKenney  *
1283dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
1284dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
1285da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
1286da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
1287dad81a20SPaul E. McKenney  *
1288dad81a20SPaul E. McKenney  * Can block; must be called from process context.
1289dad81a20SPaul E. McKenney  *
1290dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
1291dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
1292dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
1293dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
1294dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
1295dad81a20SPaul E. McKenney  *
1296dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
1297dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
1298dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
12996eb95cc4SPaul E. McKenney  * the end of its last corresponding SRCU read-side critical section
1300dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
1301dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
1302dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
1303dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
1304dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
1305dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
1306dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
1307dad81a20SPaul E. McKenney  *
1308dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
1309dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
1310dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
1311dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
1312dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
1313dad81a20SPaul E. McKenney  *
1314dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
1315dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
1316dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
13172da4b2a7SPaul E. McKenney  *
13183d3a0d1bSPaul E. McKenney  * Implementation of these memory-ordering guarantees is similar to
13193d3a0d1bSPaul E. McKenney  * that of synchronize_rcu().
13203d3a0d1bSPaul E. McKenney  *
13212da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
13222da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
13232da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
13242da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
1325dad81a20SPaul E. McKenney  */
1326aacb5d91SPaul E. McKenney void synchronize_srcu(struct srcu_struct *ssp)
1327dad81a20SPaul E. McKenney {
1328aacb5d91SPaul E. McKenney 	if (srcu_might_be_idle(ssp) || rcu_gp_is_expedited())
1329aacb5d91SPaul E. McKenney 		synchronize_srcu_expedited(ssp);
1330dad81a20SPaul E. McKenney 	else
1331aacb5d91SPaul E. McKenney 		__synchronize_srcu(ssp, true);
1332dad81a20SPaul E. McKenney }
1333dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1334dad81a20SPaul E. McKenney 
13355358c9faSPaul E. McKenney /**
13365358c9faSPaul E. McKenney  * get_state_synchronize_srcu - Provide an end-of-grace-period cookie
13375358c9faSPaul E. McKenney  * @ssp: srcu_struct to provide cookie for.
13385358c9faSPaul E. McKenney  *
13395358c9faSPaul E. McKenney  * This function returns a cookie that can be passed to
13405358c9faSPaul E. McKenney  * poll_state_synchronize_srcu(), which will return true if a full grace
13415358c9faSPaul E. McKenney  * period has elapsed in the meantime.  It is the caller's responsibility
13425358c9faSPaul E. McKenney  * to make sure that grace period happens, for example, by invoking
13435358c9faSPaul E. McKenney  * call_srcu() after return from get_state_synchronize_srcu().
13445358c9faSPaul E. McKenney  */
13455358c9faSPaul E. McKenney unsigned long get_state_synchronize_srcu(struct srcu_struct *ssp)
13465358c9faSPaul E. McKenney {
13475358c9faSPaul E. McKenney 	// Any prior manipulation of SRCU-protected data must happen
13485358c9faSPaul E. McKenney 	// before the load from ->srcu_gp_seq.
13495358c9faSPaul E. McKenney 	smp_mb();
13505358c9faSPaul E. McKenney 	return rcu_seq_snap(&ssp->srcu_gp_seq);
13515358c9faSPaul E. McKenney }
13525358c9faSPaul E. McKenney EXPORT_SYMBOL_GPL(get_state_synchronize_srcu);
13535358c9faSPaul E. McKenney 
13545358c9faSPaul E. McKenney /**
13555358c9faSPaul E. McKenney  * start_poll_synchronize_srcu - Provide cookie and start grace period
13565358c9faSPaul E. McKenney  * @ssp: srcu_struct to provide cookie for.
13575358c9faSPaul E. McKenney  *
13585358c9faSPaul E. McKenney  * This function returns a cookie that can be passed to
13595358c9faSPaul E. McKenney  * poll_state_synchronize_srcu(), which will return true if a full grace
13605358c9faSPaul E. McKenney  * period has elapsed in the meantime.  Unlike get_state_synchronize_srcu(),
13615358c9faSPaul E. McKenney  * this function also ensures that any needed SRCU grace period will be
13625358c9faSPaul E. McKenney  * started.  This convenience does come at a cost in terms of CPU overhead.
13635358c9faSPaul E. McKenney  */
13645358c9faSPaul E. McKenney unsigned long start_poll_synchronize_srcu(struct srcu_struct *ssp)
13655358c9faSPaul E. McKenney {
13665358c9faSPaul E. McKenney 	return srcu_gp_start_if_needed(ssp, NULL, true);
13675358c9faSPaul E. McKenney }
13685358c9faSPaul E. McKenney EXPORT_SYMBOL_GPL(start_poll_synchronize_srcu);
13695358c9faSPaul E. McKenney 
13705358c9faSPaul E. McKenney /**
13715358c9faSPaul E. McKenney  * poll_state_synchronize_srcu - Has cookie's grace period ended?
13725358c9faSPaul E. McKenney  * @ssp: srcu_struct to provide cookie for.
13735358c9faSPaul E. McKenney  * @cookie: Return value from get_state_synchronize_srcu() or start_poll_synchronize_srcu().
13745358c9faSPaul E. McKenney  *
13755358c9faSPaul E. McKenney  * This function takes the cookie that was returned from either
13765358c9faSPaul E. McKenney  * get_state_synchronize_srcu() or start_poll_synchronize_srcu(), and
13775358c9faSPaul E. McKenney  * returns @true if an SRCU grace period elapsed since the time that the
13785358c9faSPaul E. McKenney  * cookie was created.
13794e7ccfaeSPaul E. McKenney  *
13804e7ccfaeSPaul E. McKenney  * Because cookies are finite in size, wrapping/overflow is possible.
13814e7ccfaeSPaul E. McKenney  * This is more pronounced on 32-bit systems where cookies are 32 bits,
13824e7ccfaeSPaul E. McKenney  * where in theory wrapping could happen in about 14 hours assuming
13834e7ccfaeSPaul E. McKenney  * 25-microsecond expedited SRCU grace periods.  However, a more likely
13844e7ccfaeSPaul E. McKenney  * overflow lower bound is on the order of 24 days in the case of
13854e7ccfaeSPaul E. McKenney  * one-millisecond SRCU grace periods.  Of course, wrapping in a 64-bit
13864e7ccfaeSPaul E. McKenney  * system requires geologic timespans, as in more than seven million years
13874e7ccfaeSPaul E. McKenney  * even for expedited SRCU grace periods.
13884e7ccfaeSPaul E. McKenney  *
13894e7ccfaeSPaul E. McKenney  * Wrapping/overflow is much more of an issue for CONFIG_SMP=n systems
13904e7ccfaeSPaul E. McKenney  * that also have CONFIG_PREEMPTION=n, which selects Tiny SRCU.  This uses
13914e7ccfaeSPaul E. McKenney  * a 16-bit cookie, which rcutorture routinely wraps in a matter of a
13924e7ccfaeSPaul E. McKenney  * few minutes.  If this proves to be a problem, this counter will be
13934e7ccfaeSPaul E. McKenney  * expanded to the same size as for Tree SRCU.
13945358c9faSPaul E. McKenney  */
13955358c9faSPaul E. McKenney bool poll_state_synchronize_srcu(struct srcu_struct *ssp, unsigned long cookie)
13965358c9faSPaul E. McKenney {
13975358c9faSPaul E. McKenney 	if (!rcu_seq_done(&ssp->srcu_gp_seq, cookie))
13985358c9faSPaul E. McKenney 		return false;
13995358c9faSPaul E. McKenney 	// Ensure that the end of the SRCU grace period happens before
14005358c9faSPaul E. McKenney 	// any subsequent code that the caller might execute.
14015358c9faSPaul E. McKenney 	smp_mb(); // ^^^
14025358c9faSPaul E. McKenney 	return true;
14035358c9faSPaul E. McKenney }
14045358c9faSPaul E. McKenney EXPORT_SYMBOL_GPL(poll_state_synchronize_srcu);
14055358c9faSPaul E. McKenney 
1406da915ad5SPaul E. McKenney /*
1407da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1408da915ad5SPaul E. McKenney  */
1409da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1410da915ad5SPaul E. McKenney {
1411da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1412aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1413da915ad5SPaul E. McKenney 
1414da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1415aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1416aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1417aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1418da915ad5SPaul E. McKenney }
1419da915ad5SPaul E. McKenney 
1420994f7068SPaul E. McKenney /*
1421994f7068SPaul E. McKenney  * Enqueue an srcu_barrier() callback on the specified srcu_data
1422994f7068SPaul E. McKenney  * structure's ->cblist.  but only if that ->cblist already has at least one
1423994f7068SPaul E. McKenney  * callback enqueued.  Note that if a CPU already has callbacks enqueue,
1424994f7068SPaul E. McKenney  * it must have already registered the need for a future grace period,
1425994f7068SPaul E. McKenney  * so all we need do is enqueue a callback that will use the same grace
1426994f7068SPaul E. McKenney  * period as the last callback already in the queue.
1427994f7068SPaul E. McKenney  */
1428994f7068SPaul E. McKenney static void srcu_barrier_one_cpu(struct srcu_struct *ssp, struct srcu_data *sdp)
1429994f7068SPaul E. McKenney {
1430994f7068SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1431994f7068SPaul E. McKenney 	atomic_inc(&ssp->srcu_barrier_cpu_cnt);
1432994f7068SPaul E. McKenney 	sdp->srcu_barrier_head.func = srcu_barrier_cb;
1433994f7068SPaul E. McKenney 	debug_rcu_head_queue(&sdp->srcu_barrier_head);
1434994f7068SPaul E. McKenney 	if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1435994f7068SPaul E. McKenney 				   &sdp->srcu_barrier_head)) {
1436994f7068SPaul E. McKenney 		debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1437994f7068SPaul E. McKenney 		atomic_dec(&ssp->srcu_barrier_cpu_cnt);
1438994f7068SPaul E. McKenney 	}
1439994f7068SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1440994f7068SPaul E. McKenney }
1441994f7068SPaul E. McKenney 
1442dad81a20SPaul E. McKenney /**
1443dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1444aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to wait for in-flight callbacks.
1445dad81a20SPaul E. McKenney  */
1446aacb5d91SPaul E. McKenney void srcu_barrier(struct srcu_struct *ssp)
1447dad81a20SPaul E. McKenney {
1448da915ad5SPaul E. McKenney 	int cpu;
1449e2f63836SPaul E. McKenney 	int idx;
1450aacb5d91SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&ssp->srcu_barrier_seq);
1451da915ad5SPaul E. McKenney 
1452aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1453aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_barrier_mutex);
1454aacb5d91SPaul E. McKenney 	if (rcu_seq_done(&ssp->srcu_barrier_seq, s)) {
1455da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1456aacb5d91SPaul E. McKenney 		mutex_unlock(&ssp->srcu_barrier_mutex);
1457da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1458da915ad5SPaul E. McKenney 	}
1459aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_barrier_seq);
1460aacb5d91SPaul E. McKenney 	init_completion(&ssp->srcu_barrier_completion);
1461da915ad5SPaul E. McKenney 
1462da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1463aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 1);
1464da915ad5SPaul E. McKenney 
1465*2e83b879SPaul E. McKenney 	idx = __srcu_read_lock_nmisafe(ssp);
1466994f7068SPaul E. McKenney 	if (smp_load_acquire(&ssp->srcu_size_state) < SRCU_SIZE_WAIT_BARRIER)
1467994f7068SPaul E. McKenney 		srcu_barrier_one_cpu(ssp, per_cpu_ptr(ssp->sda, 0));
1468994f7068SPaul E. McKenney 	else
1469994f7068SPaul E. McKenney 		for_each_possible_cpu(cpu)
1470994f7068SPaul E. McKenney 			srcu_barrier_one_cpu(ssp, per_cpu_ptr(ssp->sda, cpu));
1471*2e83b879SPaul E. McKenney 	__srcu_read_unlock_nmisafe(ssp, idx);
1472da915ad5SPaul E. McKenney 
1473da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1474aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1475aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1476aacb5d91SPaul E. McKenney 	wait_for_completion(&ssp->srcu_barrier_completion);
1477da915ad5SPaul E. McKenney 
1478aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_barrier_seq);
1479aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_barrier_mutex);
1480dad81a20SPaul E. McKenney }
1481dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1482dad81a20SPaul E. McKenney 
1483dad81a20SPaul E. McKenney /**
1484dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1485aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to report batch completion.
1486dad81a20SPaul E. McKenney  *
1487dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1488dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1489dad81a20SPaul E. McKenney  */
1490aacb5d91SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *ssp)
1491dad81a20SPaul E. McKenney {
149239f91504SPaul E. McKenney 	return READ_ONCE(ssp->srcu_idx);
1493dad81a20SPaul E. McKenney }
1494dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1495dad81a20SPaul E. McKenney 
1496dad81a20SPaul E. McKenney /*
1497da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1498da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1499da915ad5SPaul E. McKenney  * completed in that state.
1500dad81a20SPaul E. McKenney  */
1501aacb5d91SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *ssp)
1502dad81a20SPaul E. McKenney {
1503dad81a20SPaul E. McKenney 	int idx;
1504dad81a20SPaul E. McKenney 
1505aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_gp_mutex);
1506da915ad5SPaul E. McKenney 
1507dad81a20SPaul E. McKenney 	/*
1508dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1509da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1510dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1511dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1512dad81a20SPaul E. McKenney 	 * invoking a callback.
1513dad81a20SPaul E. McKenney 	 *
1514dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1515dad81a20SPaul E. McKenney 	 * by the prior grace period.
1516dad81a20SPaul E. McKenney 	 */
1517aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq)); /* ^^^ */
1518dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1519aacb5d91SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp);
1520aacb5d91SPaul E. McKenney 		if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1521aacb5d91SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq));
1522aacb5d91SPaul E. McKenney 			spin_unlock_irq_rcu_node(ssp);
1523aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1524dad81a20SPaul E. McKenney 			return;
1525dad81a20SPaul E. McKenney 		}
1526aacb5d91SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
1527dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1528aacb5d91SPaul E. McKenney 			srcu_gp_start(ssp);
1529aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
1530da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1531aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1532dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1533dad81a20SPaul E. McKenney 		}
1534da915ad5SPaul E. McKenney 	}
1535dad81a20SPaul E. McKenney 
1536aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1537aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1538aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 1)) {
1539aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1540dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1541da915ad5SPaul E. McKenney 		}
1542aacb5d91SPaul E. McKenney 		srcu_flip(ssp);
154371042606SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp);
1544aacb5d91SPaul E. McKenney 		rcu_seq_set_state(&ssp->srcu_gp_seq, SRCU_STATE_SCAN2);
1545282d8998SPaul E. McKenney 		ssp->srcu_n_exp_nodelay = 0;
154671042606SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
1547dad81a20SPaul E. McKenney 	}
1548dad81a20SPaul E. McKenney 
1549aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1550dad81a20SPaul E. McKenney 
1551dad81a20SPaul E. McKenney 		/*
1552dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1553dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1554dad81a20SPaul E. McKenney 		 */
1555aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1556aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 2)) {
1557aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1558da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1559da915ad5SPaul E. McKenney 		}
1560282d8998SPaul E. McKenney 		ssp->srcu_n_exp_nodelay = 0;
1561aacb5d91SPaul E. McKenney 		srcu_gp_end(ssp);  /* Releases ->srcu_gp_mutex. */
1562dad81a20SPaul E. McKenney 	}
1563dad81a20SPaul E. McKenney }
1564dad81a20SPaul E. McKenney 
1565dad81a20SPaul E. McKenney /*
1566dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1567dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1568dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1569dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1570dad81a20SPaul E. McKenney  */
1571da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1572dad81a20SPaul E. McKenney {
1573ae5c2341SJoel Fernandes (Google) 	long len;
1574da915ad5SPaul E. McKenney 	bool more;
1575dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1576dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1577da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1578aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1579dad81a20SPaul E. McKenney 
1580e81baf4cSSebastian Andrzej Siewior 	sdp = container_of(work, struct srcu_data, work);
1581e81baf4cSSebastian Andrzej Siewior 
1582aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1583dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1584d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1585da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1586aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
1587da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1588da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1589d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1590da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1591da915ad5SPaul E. McKenney 	}
1592da915ad5SPaul E. McKenney 
1593da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1594da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1595da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1596ae5c2341SJoel Fernandes (Google) 	len = ready_cbs.len;
1597d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1598dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1599dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1600a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1601dad81a20SPaul E. McKenney 		local_bh_disable();
1602dad81a20SPaul E. McKenney 		rhp->func(rhp);
1603dad81a20SPaul E. McKenney 		local_bh_enable();
1604dad81a20SPaul E. McKenney 	}
1605ae5c2341SJoel Fernandes (Google) 	WARN_ON_ONCE(ready_cbs.len);
1606da915ad5SPaul E. McKenney 
1607da915ad5SPaul E. McKenney 	/*
1608da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1609da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1610da915ad5SPaul E. McKenney 	 */
1611d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1612ae5c2341SJoel Fernandes (Google) 	rcu_segcblist_add_len(&sdp->srcu_cblist, -len);
1613da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1614aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
1615da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1616da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1617d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1618da915ad5SPaul E. McKenney 	if (more)
1619da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1620dad81a20SPaul E. McKenney }
1621dad81a20SPaul E. McKenney 
1622dad81a20SPaul E. McKenney /*
1623dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1624dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1625dad81a20SPaul E. McKenney  */
1626aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay)
1627dad81a20SPaul E. McKenney {
1628da915ad5SPaul E. McKenney 	bool pushgp = true;
1629dad81a20SPaul E. McKenney 
1630aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
1631aacb5d91SPaul E. McKenney 	if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1632aacb5d91SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq))) {
1633da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1634da915ad5SPaul E. McKenney 			pushgp = false;
1635dad81a20SPaul E. McKenney 		}
1636aacb5d91SPaul E. McKenney 	} else if (!rcu_seq_state(ssp->srcu_gp_seq)) {
1637da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1638aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
1639da915ad5SPaul E. McKenney 	}
1640aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
1641dad81a20SPaul E. McKenney 
1642da915ad5SPaul E. McKenney 	if (pushgp)
1643aacb5d91SPaul E. McKenney 		queue_delayed_work(rcu_gp_wq, &ssp->work, delay);
1644dad81a20SPaul E. McKenney }
1645dad81a20SPaul E. McKenney 
1646dad81a20SPaul E. McKenney /*
1647dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1648dad81a20SPaul E. McKenney  */
16490d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1650dad81a20SPaul E. McKenney {
1651282d8998SPaul E. McKenney 	unsigned long curdelay;
1652282d8998SPaul E. McKenney 	unsigned long j;
1653aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1654dad81a20SPaul E. McKenney 
1655aacb5d91SPaul E. McKenney 	ssp = container_of(work, struct srcu_struct, work.work);
1656dad81a20SPaul E. McKenney 
1657aacb5d91SPaul E. McKenney 	srcu_advance_state(ssp);
1658282d8998SPaul E. McKenney 	curdelay = srcu_get_delay(ssp);
1659282d8998SPaul E. McKenney 	if (curdelay) {
1660282d8998SPaul E. McKenney 		WRITE_ONCE(ssp->reschedule_count, 0);
1661282d8998SPaul E. McKenney 	} else {
1662282d8998SPaul E. McKenney 		j = jiffies;
1663282d8998SPaul E. McKenney 		if (READ_ONCE(ssp->reschedule_jiffies) == j) {
1664282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->reschedule_count, READ_ONCE(ssp->reschedule_count) + 1);
16654f2bfd94SNeeraj Upadhyay 			if (READ_ONCE(ssp->reschedule_count) > srcu_max_nodelay)
1666282d8998SPaul E. McKenney 				curdelay = 1;
1667282d8998SPaul E. McKenney 		} else {
1668282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->reschedule_count, 1);
1669282d8998SPaul E. McKenney 			WRITE_ONCE(ssp->reschedule_jiffies, j);
1670282d8998SPaul E. McKenney 		}
1671282d8998SPaul E. McKenney 	}
1672282d8998SPaul E. McKenney 	srcu_reschedule(ssp, curdelay);
1673dad81a20SPaul E. McKenney }
16747f6733c3SPaul E. McKenney 
16757f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
1676aacb5d91SPaul E. McKenney 			     struct srcu_struct *ssp, int *flags,
1677aebc8264SPaul E. McKenney 			     unsigned long *gp_seq)
16787f6733c3SPaul E. McKenney {
16797f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
16807f6733c3SPaul E. McKenney 		return;
16817f6733c3SPaul E. McKenney 	*flags = 0;
1682aacb5d91SPaul E. McKenney 	*gp_seq = rcu_seq_current(&ssp->srcu_gp_seq);
16837f6733c3SPaul E. McKenney }
16847f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
16851f4f6da1SPaul E. McKenney 
16863bedebcfSPaul E. McKenney static const char * const srcu_size_state_name[] = {
16873bedebcfSPaul E. McKenney 	"SRCU_SIZE_SMALL",
16883bedebcfSPaul E. McKenney 	"SRCU_SIZE_ALLOC",
16893bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_BARRIER",
16903bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CALL",
16913bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS1",
16923bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS2",
16933bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS3",
16943bedebcfSPaul E. McKenney 	"SRCU_SIZE_WAIT_CBS4",
16953bedebcfSPaul E. McKenney 	"SRCU_SIZE_BIG",
16963bedebcfSPaul E. McKenney 	"SRCU_SIZE_???",
16973bedebcfSPaul E. McKenney };
16983bedebcfSPaul E. McKenney 
1699aacb5d91SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *ssp, char *tt, char *tf)
1700115a1a52SPaul E. McKenney {
1701115a1a52SPaul E. McKenney 	int cpu;
1702115a1a52SPaul E. McKenney 	int idx;
1703ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
17043bedebcfSPaul E. McKenney 	int ss_state = READ_ONCE(ssp->srcu_size_state);
17053bedebcfSPaul E. McKenney 	int ss_state_idx = ss_state;
1706115a1a52SPaul E. McKenney 
1707aacb5d91SPaul E. McKenney 	idx = ssp->srcu_idx & 0x1;
17083bedebcfSPaul E. McKenney 	if (ss_state < 0 || ss_state >= ARRAY_SIZE(srcu_size_state_name))
17093bedebcfSPaul E. McKenney 		ss_state_idx = ARRAY_SIZE(srcu_size_state_name) - 1;
17104a230f80SPaul E. McKenney 	pr_alert("%s%s Tree SRCU g%ld state %d (%s)",
17113bedebcfSPaul E. McKenney 		 tt, tf, rcu_seq_current(&ssp->srcu_gp_seq), ss_state,
17124a230f80SPaul E. McKenney 		 srcu_size_state_name[ss_state_idx]);
17134a230f80SPaul E. McKenney 	if (!ssp->sda) {
17144a230f80SPaul E. McKenney 		// Called after cleanup_srcu_struct(), perhaps.
17154a230f80SPaul E. McKenney 		pr_cont(" No per-CPU srcu_data structures (->sda == NULL).\n");
17164a230f80SPaul E. McKenney 	} else {
17174a230f80SPaul E. McKenney 		pr_cont(" per-CPU(idx=%d):", idx);
1718115a1a52SPaul E. McKenney 		for_each_possible_cpu(cpu) {
1719115a1a52SPaul E. McKenney 			unsigned long l0, l1;
1720115a1a52SPaul E. McKenney 			unsigned long u0, u1;
1721115a1a52SPaul E. McKenney 			long c0, c1;
17225ab07a8dSPaul E. McKenney 			struct srcu_data *sdp;
1723115a1a52SPaul E. McKenney 
1724aacb5d91SPaul E. McKenney 			sdp = per_cpu_ptr(ssp->sda, cpu);
17255d0f5953SPaul E. McKenney 			u0 = data_race(atomic_long_read(&sdp->srcu_unlock_count[!idx]));
17265d0f5953SPaul E. McKenney 			u1 = data_race(atomic_long_read(&sdp->srcu_unlock_count[idx]));
1727115a1a52SPaul E. McKenney 
1728115a1a52SPaul E. McKenney 			/*
1729115a1a52SPaul E. McKenney 			 * Make sure that a lock is always counted if the corresponding
1730115a1a52SPaul E. McKenney 			 * unlock is counted.
1731115a1a52SPaul E. McKenney 			 */
1732115a1a52SPaul E. McKenney 			smp_rmb();
1733115a1a52SPaul E. McKenney 
17345d0f5953SPaul E. McKenney 			l0 = data_race(atomic_long_read(&sdp->srcu_lock_count[!idx]));
17355d0f5953SPaul E. McKenney 			l1 = data_race(atomic_long_read(&sdp->srcu_lock_count[idx]));
1736115a1a52SPaul E. McKenney 
1737115a1a52SPaul E. McKenney 			c0 = l0 - u0;
1738115a1a52SPaul E. McKenney 			c1 = l1 - u1;
17397e210a65SPaul E. McKenney 			pr_cont(" %d(%ld,%ld %c)",
17407e210a65SPaul E. McKenney 				cpu, c0, c1,
17417e210a65SPaul E. McKenney 				"C."[rcu_segcblist_empty(&sdp->srcu_cblist)]);
1742ac3748c6SPaul E. McKenney 			s0 += c0;
1743ac3748c6SPaul E. McKenney 			s1 += c1;
1744115a1a52SPaul E. McKenney 		}
1745ac3748c6SPaul E. McKenney 		pr_cont(" T(%ld,%ld)\n", s0, s1);
17464a230f80SPaul E. McKenney 	}
17479f2e91d9SPaul E. McKenney 	if (SRCU_SIZING_IS_TORTURE())
174899659f64SPaul E. McKenney 		srcu_transition_to_big(ssp);
1749115a1a52SPaul E. McKenney }
1750115a1a52SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1751115a1a52SPaul E. McKenney 
17521f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void)
17531f4f6da1SPaul E. McKenney {
17541f4f6da1SPaul E. McKenney 	pr_info("Hierarchical SRCU implementation.\n");
17550c8e0e3cSPaul E. McKenney 	if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
17560c8e0e3cSPaul E. McKenney 		pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
17574f2bfd94SNeeraj Upadhyay 	if (srcu_retry_check_delay != SRCU_DEFAULT_RETRY_CHECK_DELAY)
17584f2bfd94SNeeraj Upadhyay 		pr_info("\tNon-default retry check delay of %lu us.\n", srcu_retry_check_delay);
17594f2bfd94SNeeraj Upadhyay 	if (srcu_max_nodelay != SRCU_DEFAULT_MAX_NODELAY)
17604f2bfd94SNeeraj Upadhyay 		pr_info("\tNon-default max no-delay of %lu.\n", srcu_max_nodelay);
17614f2bfd94SNeeraj Upadhyay 	pr_info("\tMax phase no-delay instances is %lu.\n", srcu_max_nodelay_phase);
17621f4f6da1SPaul E. McKenney 	return 0;
17631f4f6da1SPaul E. McKenney }
17641f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce);
1765e0fcba9aSPaul E. McKenney 
1766e0fcba9aSPaul E. McKenney void __init srcu_init(void)
1767e0fcba9aSPaul E. McKenney {
1768aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1769e0fcba9aSPaul E. McKenney 
1770a57ffb3cSPaul E. McKenney 	/* Decide on srcu_struct-size strategy. */
1771a57ffb3cSPaul E. McKenney 	if (SRCU_SIZING_IS(SRCU_SIZING_AUTO)) {
1772a57ffb3cSPaul E. McKenney 		if (nr_cpu_ids >= big_cpu_lim) {
1773a57ffb3cSPaul E. McKenney 			convert_to_big = SRCU_SIZING_INIT; // Don't bother waiting for contention.
1774a57ffb3cSPaul E. McKenney 			pr_info("%s: Setting srcu_struct sizes to big.\n", __func__);
1775a57ffb3cSPaul E. McKenney 		} else {
1776a57ffb3cSPaul E. McKenney 			convert_to_big = SRCU_SIZING_NONE | SRCU_SIZING_CONTEND;
1777a57ffb3cSPaul E. McKenney 			pr_info("%s: Setting srcu_struct sizes based on contention.\n", __func__);
1778a57ffb3cSPaul E. McKenney 		}
1779a57ffb3cSPaul E. McKenney 	}
1780a57ffb3cSPaul E. McKenney 
17818e9c01c7SFrederic Weisbecker 	/*
17828e9c01c7SFrederic Weisbecker 	 * Once that is set, call_srcu() can follow the normal path and
17838e9c01c7SFrederic Weisbecker 	 * queue delayed work. This must follow RCU workqueues creation
17848e9c01c7SFrederic Weisbecker 	 * and timers initialization.
17858e9c01c7SFrederic Weisbecker 	 */
1786e0fcba9aSPaul E. McKenney 	srcu_init_done = true;
1787e0fcba9aSPaul E. McKenney 	while (!list_empty(&srcu_boot_list)) {
1788aacb5d91SPaul E. McKenney 		ssp = list_first_entry(&srcu_boot_list, struct srcu_struct,
17894e6ea4efSPaul E. McKenney 				      work.work.entry);
1790aacb5d91SPaul E. McKenney 		list_del_init(&ssp->work.work.entry);
1791a57ffb3cSPaul E. McKenney 		if (SRCU_SIZING_IS(SRCU_SIZING_INIT) && ssp->srcu_size_state == SRCU_SIZE_SMALL)
1792a57ffb3cSPaul E. McKenney 			ssp->srcu_size_state = SRCU_SIZE_ALLOC;
1793aacb5d91SPaul E. McKenney 		queue_work(rcu_gp_wq, &ssp->work.work);
1794e0fcba9aSPaul E. McKenney 	}
1795e0fcba9aSPaul E. McKenney }
1796fe15b50cSPaul E. McKenney 
1797fe15b50cSPaul E. McKenney #ifdef CONFIG_MODULES
1798fe15b50cSPaul E. McKenney 
1799fe15b50cSPaul E. McKenney /* Initialize any global-scope srcu_struct structures used by this module. */
1800fe15b50cSPaul E. McKenney static int srcu_module_coming(struct module *mod)
1801fe15b50cSPaul E. McKenney {
1802fe15b50cSPaul E. McKenney 	int i;
1803fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1804fe15b50cSPaul E. McKenney 	int ret;
1805fe15b50cSPaul E. McKenney 
1806fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++) {
1807fe15b50cSPaul E. McKenney 		ret = init_srcu_struct(*(sspp++));
1808fe15b50cSPaul E. McKenney 		if (WARN_ON_ONCE(ret))
1809fe15b50cSPaul E. McKenney 			return ret;
1810fe15b50cSPaul E. McKenney 	}
1811fe15b50cSPaul E. McKenney 	return 0;
1812fe15b50cSPaul E. McKenney }
1813fe15b50cSPaul E. McKenney 
1814fe15b50cSPaul E. McKenney /* Clean up any global-scope srcu_struct structures used by this module. */
1815fe15b50cSPaul E. McKenney static void srcu_module_going(struct module *mod)
1816fe15b50cSPaul E. McKenney {
1817fe15b50cSPaul E. McKenney 	int i;
1818fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1819fe15b50cSPaul E. McKenney 
1820fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++)
1821fe15b50cSPaul E. McKenney 		cleanup_srcu_struct(*(sspp++));
1822fe15b50cSPaul E. McKenney }
1823fe15b50cSPaul E. McKenney 
1824fe15b50cSPaul E. McKenney /* Handle one module, either coming or going. */
1825fe15b50cSPaul E. McKenney static int srcu_module_notify(struct notifier_block *self,
1826fe15b50cSPaul E. McKenney 			      unsigned long val, void *data)
1827fe15b50cSPaul E. McKenney {
1828fe15b50cSPaul E. McKenney 	struct module *mod = data;
1829fe15b50cSPaul E. McKenney 	int ret = 0;
1830fe15b50cSPaul E. McKenney 
1831fe15b50cSPaul E. McKenney 	switch (val) {
1832fe15b50cSPaul E. McKenney 	case MODULE_STATE_COMING:
1833fe15b50cSPaul E. McKenney 		ret = srcu_module_coming(mod);
1834fe15b50cSPaul E. McKenney 		break;
1835fe15b50cSPaul E. McKenney 	case MODULE_STATE_GOING:
1836fe15b50cSPaul E. McKenney 		srcu_module_going(mod);
1837fe15b50cSPaul E. McKenney 		break;
1838fe15b50cSPaul E. McKenney 	default:
1839fe15b50cSPaul E. McKenney 		break;
1840fe15b50cSPaul E. McKenney 	}
1841fe15b50cSPaul E. McKenney 	return ret;
1842fe15b50cSPaul E. McKenney }
1843fe15b50cSPaul E. McKenney 
1844fe15b50cSPaul E. McKenney static struct notifier_block srcu_module_nb = {
1845fe15b50cSPaul E. McKenney 	.notifier_call = srcu_module_notify,
1846fe15b50cSPaul E. McKenney 	.priority = 0,
1847fe15b50cSPaul E. McKenney };
1848fe15b50cSPaul E. McKenney 
1849fe15b50cSPaul E. McKenney static __init int init_srcu_module_notifier(void)
1850fe15b50cSPaul E. McKenney {
1851fe15b50cSPaul E. McKenney 	int ret;
1852fe15b50cSPaul E. McKenney 
1853fe15b50cSPaul E. McKenney 	ret = register_module_notifier(&srcu_module_nb);
1854fe15b50cSPaul E. McKenney 	if (ret)
1855fe15b50cSPaul E. McKenney 		pr_warn("Failed to register srcu module notifier\n");
1856fe15b50cSPaul E. McKenney 	return ret;
1857fe15b50cSPaul E. McKenney }
1858fe15b50cSPaul E. McKenney late_initcall(init_srcu_module_notifier);
1859fe15b50cSPaul E. McKenney 
1860fe15b50cSPaul E. McKenney #endif /* #ifdef CONFIG_MODULES */
1861