xref: /linux-6.15/kernel/rcu/srcutree.c (revision 7ff8b450)
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  *
8e7ee1501SPaul E. McKenney  * Author: 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>
27dad81a20SPaul E. McKenney #include <linux/srcu.h>
28dad81a20SPaul E. McKenney 
29dad81a20SPaul E. McKenney #include "rcu.h"
3045753c5fSIngo Molnar #include "rcu_segcblist.h"
31dad81a20SPaul E. McKenney 
320c8e0e3cSPaul E. McKenney /* Holdoff in nanoseconds for auto-expediting. */
330c8e0e3cSPaul E. McKenney #define DEFAULT_SRCU_EXP_HOLDOFF (25 * 1000)
340c8e0e3cSPaul E. McKenney static ulong exp_holdoff = DEFAULT_SRCU_EXP_HOLDOFF;
3522607d66SPaul E. McKenney module_param(exp_holdoff, ulong, 0444);
3622607d66SPaul E. McKenney 
37c350c008SPaul E. McKenney /* Overflow-check frequency.  N bits roughly says every 2**N grace periods. */
38c350c008SPaul E. McKenney static ulong counter_wrap_check = (ULONG_MAX >> 2);
39c350c008SPaul E. McKenney module_param(counter_wrap_check, ulong, 0444);
40c350c008SPaul E. McKenney 
41e0fcba9aSPaul E. McKenney /* Early-boot callback-management, so early that no lock is required! */
42e0fcba9aSPaul E. McKenney static LIST_HEAD(srcu_boot_list);
43e0fcba9aSPaul E. McKenney static bool __read_mostly srcu_init_done;
44e0fcba9aSPaul E. McKenney 
45da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work);
46aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay);
470d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work);
48e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t);
49da915ad5SPaul E. McKenney 
50d6331980SPaul E. McKenney /* Wrappers for lock acquisition and release, see raw_spin_lock_rcu_node(). */
51d6331980SPaul E. McKenney #define spin_lock_rcu_node(p)					\
52d6331980SPaul E. McKenney do {									\
53d6331980SPaul E. McKenney 	spin_lock(&ACCESS_PRIVATE(p, lock));			\
54d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
55d6331980SPaul E. McKenney } while (0)
56d6331980SPaul E. McKenney 
57d6331980SPaul E. McKenney #define spin_unlock_rcu_node(p) spin_unlock(&ACCESS_PRIVATE(p, lock))
58d6331980SPaul E. McKenney 
59d6331980SPaul E. McKenney #define spin_lock_irq_rcu_node(p)					\
60d6331980SPaul E. McKenney do {									\
61d6331980SPaul E. McKenney 	spin_lock_irq(&ACCESS_PRIVATE(p, lock));			\
62d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
63d6331980SPaul E. McKenney } while (0)
64d6331980SPaul E. McKenney 
65d6331980SPaul E. McKenney #define spin_unlock_irq_rcu_node(p)					\
66d6331980SPaul E. McKenney 	spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
67d6331980SPaul E. McKenney 
68d6331980SPaul E. McKenney #define spin_lock_irqsave_rcu_node(p, flags)			\
69d6331980SPaul E. McKenney do {									\
70d6331980SPaul E. McKenney 	spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags);	\
71d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
72d6331980SPaul E. McKenney } while (0)
73d6331980SPaul E. McKenney 
74d6331980SPaul E. McKenney #define spin_unlock_irqrestore_rcu_node(p, flags)			\
75d6331980SPaul E. McKenney 	spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags)	\
76d6331980SPaul E. McKenney 
77da915ad5SPaul E. McKenney /*
78da915ad5SPaul E. McKenney  * Initialize SRCU combining tree.  Note that statically allocated
79da915ad5SPaul E. McKenney  * srcu_struct structures might already have srcu_read_lock() and
80da915ad5SPaul E. McKenney  * srcu_read_unlock() running against them.  So if the is_static parameter
81da915ad5SPaul E. McKenney  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
82da915ad5SPaul E. McKenney  */
83aacb5d91SPaul E. McKenney static void init_srcu_struct_nodes(struct srcu_struct *ssp, bool is_static)
84dad81a20SPaul E. McKenney {
85da915ad5SPaul E. McKenney 	int cpu;
86da915ad5SPaul E. McKenney 	int i;
87da915ad5SPaul E. McKenney 	int level = 0;
88da915ad5SPaul E. McKenney 	int levelspread[RCU_NUM_LVLS];
89da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
90da915ad5SPaul E. McKenney 	struct srcu_node *snp;
91da915ad5SPaul E. McKenney 	struct srcu_node *snp_first;
92da915ad5SPaul E. McKenney 
93da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
94aacb5d91SPaul E. McKenney 	ssp->level[0] = &ssp->node[0];
95da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
96aacb5d91SPaul E. McKenney 		ssp->level[i] = ssp->level[i - 1] + num_rcu_lvl[i - 1];
97da915ad5SPaul E. McKenney 	rcu_init_levelspread(levelspread, num_rcu_lvl);
98da915ad5SPaul E. McKenney 
99da915ad5SPaul E. McKenney 	/* Each pass through this loop initializes one srcu_node structure. */
100aacb5d91SPaul E. McKenney 	srcu_for_each_node_breadth_first(ssp, snp) {
101d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(snp, lock));
102c7e88067SPaul E. McKenney 		WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
103c7e88067SPaul E. McKenney 			     ARRAY_SIZE(snp->srcu_data_have_cbs));
104c7e88067SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
105da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[i] = 0;
106c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[i] = 0;
107c7e88067SPaul E. McKenney 		}
1081e9a038bSPaul E. McKenney 		snp->srcu_gp_seq_needed_exp = 0;
109da915ad5SPaul E. McKenney 		snp->grplo = -1;
110da915ad5SPaul E. McKenney 		snp->grphi = -1;
111aacb5d91SPaul E. McKenney 		if (snp == &ssp->node[0]) {
112da915ad5SPaul E. McKenney 			/* Root node, special case. */
113da915ad5SPaul E. McKenney 			snp->srcu_parent = NULL;
114da915ad5SPaul E. McKenney 			continue;
115da915ad5SPaul E. McKenney 		}
116da915ad5SPaul E. McKenney 
117da915ad5SPaul E. McKenney 		/* Non-root node. */
118aacb5d91SPaul E. McKenney 		if (snp == ssp->level[level + 1])
119da915ad5SPaul E. McKenney 			level++;
120aacb5d91SPaul E. McKenney 		snp->srcu_parent = ssp->level[level - 1] +
121aacb5d91SPaul E. McKenney 				   (snp - ssp->level[level]) /
122da915ad5SPaul E. McKenney 				   levelspread[level - 1];
123da915ad5SPaul E. McKenney 	}
124da915ad5SPaul E. McKenney 
125da915ad5SPaul E. McKenney 	/*
126da915ad5SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
127da915ad5SPaul E. McKenney 	 * leaves of the srcu_node tree.
128da915ad5SPaul E. McKenney 	 */
129da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
130da915ad5SPaul E. McKenney 		     ARRAY_SIZE(sdp->srcu_unlock_count));
131da915ad5SPaul E. McKenney 	level = rcu_num_lvls - 1;
132aacb5d91SPaul E. McKenney 	snp_first = ssp->level[level];
133da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
134aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
135d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
136da915ad5SPaul E. McKenney 		rcu_segcblist_init(&sdp->srcu_cblist);
137da915ad5SPaul E. McKenney 		sdp->srcu_cblist_invoking = false;
138aacb5d91SPaul E. McKenney 		sdp->srcu_gp_seq_needed = ssp->srcu_gp_seq;
139aacb5d91SPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = ssp->srcu_gp_seq;
140da915ad5SPaul E. McKenney 		sdp->mynode = &snp_first[cpu / levelspread[level]];
141da915ad5SPaul E. McKenney 		for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
142da915ad5SPaul E. McKenney 			if (snp->grplo < 0)
143da915ad5SPaul E. McKenney 				snp->grplo = cpu;
144da915ad5SPaul E. McKenney 			snp->grphi = cpu;
145da915ad5SPaul E. McKenney 		}
146da915ad5SPaul E. McKenney 		sdp->cpu = cpu;
147e81baf4cSSebastian Andrzej Siewior 		INIT_WORK(&sdp->work, srcu_invoke_callbacks);
148e81baf4cSSebastian Andrzej Siewior 		timer_setup(&sdp->delay_work, srcu_delay_timer, 0);
149aacb5d91SPaul E. McKenney 		sdp->ssp = ssp;
150c7e88067SPaul E. McKenney 		sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
151da915ad5SPaul E. McKenney 		if (is_static)
152da915ad5SPaul E. McKenney 			continue;
153da915ad5SPaul E. McKenney 
154da915ad5SPaul E. McKenney 		/* Dynamically allocated, better be no srcu_read_locks()! */
155da915ad5SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) {
156da915ad5SPaul E. McKenney 			sdp->srcu_lock_count[i] = 0;
157da915ad5SPaul E. McKenney 			sdp->srcu_unlock_count[i] = 0;
158da915ad5SPaul E. McKenney 		}
159da915ad5SPaul E. McKenney 	}
160da915ad5SPaul E. McKenney }
161da915ad5SPaul E. McKenney 
162da915ad5SPaul E. McKenney /*
163da915ad5SPaul E. McKenney  * Initialize non-compile-time initialized fields, including the
164da915ad5SPaul E. McKenney  * associated srcu_node and srcu_data structures.  The is_static
165da915ad5SPaul E. McKenney  * parameter is passed through to init_srcu_struct_nodes(), and
166da915ad5SPaul E. McKenney  * also tells us that ->sda has already been wired up to srcu_data.
167da915ad5SPaul E. McKenney  */
168aacb5d91SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *ssp, bool is_static)
169da915ad5SPaul E. McKenney {
170aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_cb_mutex);
171aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_gp_mutex);
172aacb5d91SPaul E. McKenney 	ssp->srcu_idx = 0;
173aacb5d91SPaul E. McKenney 	ssp->srcu_gp_seq = 0;
174aacb5d91SPaul E. McKenney 	ssp->srcu_barrier_seq = 0;
175aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_barrier_mutex);
176aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 0);
177aacb5d91SPaul E. McKenney 	INIT_DELAYED_WORK(&ssp->work, process_srcu);
178da915ad5SPaul E. McKenney 	if (!is_static)
179aacb5d91SPaul E. McKenney 		ssp->sda = alloc_percpu(struct srcu_data);
180aacb5d91SPaul E. McKenney 	init_srcu_struct_nodes(ssp, is_static);
181aacb5d91SPaul E. McKenney 	ssp->srcu_gp_seq_needed_exp = 0;
182aacb5d91SPaul E. McKenney 	ssp->srcu_last_gp_end = ktime_get_mono_fast_ns();
183aacb5d91SPaul E. McKenney 	smp_store_release(&ssp->srcu_gp_seq_needed, 0); /* Init done. */
184aacb5d91SPaul E. McKenney 	return ssp->sda ? 0 : -ENOMEM;
185dad81a20SPaul E. McKenney }
186dad81a20SPaul E. McKenney 
187dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
188dad81a20SPaul E. McKenney 
189aacb5d91SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *ssp, const char *name,
190dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
191dad81a20SPaul E. McKenney {
192dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
193aacb5d91SPaul E. McKenney 	debug_check_no_locks_freed((void *)ssp, sizeof(*ssp));
194aacb5d91SPaul E. McKenney 	lockdep_init_map(&ssp->dep_map, name, key, 0);
195aacb5d91SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
196aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
197dad81a20SPaul E. McKenney }
198dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
199dad81a20SPaul E. McKenney 
200dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
201dad81a20SPaul E. McKenney 
202dad81a20SPaul E. McKenney /**
203dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
204aacb5d91SPaul E. McKenney  * @ssp: structure to initialize.
205dad81a20SPaul E. McKenney  *
206dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
207dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
208dad81a20SPaul E. McKenney  * of SRCU protection.
209dad81a20SPaul E. McKenney  */
210aacb5d91SPaul E. McKenney int init_srcu_struct(struct srcu_struct *ssp)
211dad81a20SPaul E. McKenney {
212aacb5d91SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
213aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
214dad81a20SPaul E. McKenney }
215dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
216dad81a20SPaul E. McKenney 
217dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
218dad81a20SPaul E. McKenney 
219dad81a20SPaul E. McKenney /*
220da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
221da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
222da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
223aacb5d91SPaul E. McKenney  * to each update-side SRCU primitive.  Use ssp->lock, which -is-
224da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
225da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
226da915ad5SPaul E. McKenney  */
227aacb5d91SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *ssp)
228da915ad5SPaul E. McKenney {
229da915ad5SPaul E. McKenney 	unsigned long flags;
230da915ad5SPaul E. McKenney 
231da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
232aacb5d91SPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq_needed))) /*^^^*/
233da915ad5SPaul E. McKenney 		return; /* Already initialized. */
234aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
235aacb5d91SPaul E. McKenney 	if (!rcu_seq_state(ssp->srcu_gp_seq_needed)) {
236aacb5d91SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(ssp, flags);
237da915ad5SPaul E. McKenney 		return;
238da915ad5SPaul E. McKenney 	}
239aacb5d91SPaul E. McKenney 	init_srcu_struct_fields(ssp, true);
240aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
241da915ad5SPaul E. McKenney }
242da915ad5SPaul E. McKenney 
243da915ad5SPaul E. McKenney /*
244da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
245da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
246dad81a20SPaul E. McKenney  */
247aacb5d91SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *ssp, int idx)
248dad81a20SPaul E. McKenney {
249dad81a20SPaul E. McKenney 	int cpu;
250dad81a20SPaul E. McKenney 	unsigned long sum = 0;
251dad81a20SPaul E. McKenney 
252dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
253aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
254dad81a20SPaul E. McKenney 
255da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[idx]);
256dad81a20SPaul E. McKenney 	}
257dad81a20SPaul E. McKenney 	return sum;
258dad81a20SPaul E. McKenney }
259dad81a20SPaul E. McKenney 
260dad81a20SPaul E. McKenney /*
261da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
262da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
263dad81a20SPaul E. McKenney  */
264aacb5d91SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *ssp, int idx)
265dad81a20SPaul E. McKenney {
266dad81a20SPaul E. McKenney 	int cpu;
267dad81a20SPaul E. McKenney 	unsigned long sum = 0;
268dad81a20SPaul E. McKenney 
269dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
270aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
271dad81a20SPaul E. McKenney 
272da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_unlock_count[idx]);
273dad81a20SPaul E. McKenney 	}
274dad81a20SPaul E. McKenney 	return sum;
275dad81a20SPaul E. McKenney }
276dad81a20SPaul E. McKenney 
277dad81a20SPaul E. McKenney /*
278dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
279dad81a20SPaul E. McKenney  * be zero.
280dad81a20SPaul E. McKenney  */
281aacb5d91SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *ssp, int idx)
282dad81a20SPaul E. McKenney {
283dad81a20SPaul E. McKenney 	unsigned long unlocks;
284dad81a20SPaul E. McKenney 
285aacb5d91SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(ssp, idx);
286dad81a20SPaul E. McKenney 
287dad81a20SPaul E. McKenney 	/*
288dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
289dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
290dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
291dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
292dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
293dad81a20SPaul E. McKenney 	 *
294dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
295dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
296dad81a20SPaul E. McKenney 	 * grace period ends.
297dad81a20SPaul E. McKenney 	 */
298dad81a20SPaul E. McKenney 	smp_mb(); /* A */
299dad81a20SPaul E. McKenney 
300dad81a20SPaul E. McKenney 	/*
301dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
302dad81a20SPaul E. McKenney 	 * been no readers on this index at some time in between. This does
303dad81a20SPaul E. McKenney 	 * not mean that there are no more readers, as one could have read
304dad81a20SPaul E. McKenney 	 * the current index but not have incremented the lock counter yet.
305dad81a20SPaul E. McKenney 	 *
306881ec9d2SPaul E. McKenney 	 * So suppose that the updater is preempted here for so long
307881ec9d2SPaul E. McKenney 	 * that more than ULONG_MAX non-nested readers come and go in
308881ec9d2SPaul E. McKenney 	 * the meantime.  It turns out that this cannot result in overflow
309881ec9d2SPaul E. McKenney 	 * because if a reader modifies its unlock count after we read it
310881ec9d2SPaul E. McKenney 	 * above, then that reader's next load of ->srcu_idx is guaranteed
311881ec9d2SPaul E. McKenney 	 * to get the new value, which will cause it to operate on the
312881ec9d2SPaul E. McKenney 	 * other bank of counters, where it cannot contribute to the
313881ec9d2SPaul E. McKenney 	 * overflow of these counters.  This means that there is a maximum
314881ec9d2SPaul E. McKenney 	 * of 2*NR_CPUS increments, which cannot overflow given current
315881ec9d2SPaul E. McKenney 	 * systems, especially not on 64-bit systems.
316881ec9d2SPaul E. McKenney 	 *
317881ec9d2SPaul E. McKenney 	 * OK, how about nesting?  This does impose a limit on nesting
318881ec9d2SPaul E. McKenney 	 * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
319881ec9d2SPaul E. McKenney 	 * especially on 64-bit systems.
320dad81a20SPaul E. McKenney 	 */
321aacb5d91SPaul E. McKenney 	return srcu_readers_lock_idx(ssp, idx) == unlocks;
322dad81a20SPaul E. McKenney }
323dad81a20SPaul E. McKenney 
324dad81a20SPaul E. McKenney /**
325dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
326dad81a20SPaul E. McKenney  *                       otherwise
327aacb5d91SPaul E. McKenney  * @ssp: which srcu_struct to count active readers (holding srcu_read_lock).
328dad81a20SPaul E. McKenney  *
329dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
330dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
331dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
332dad81a20SPaul E. McKenney  */
333aacb5d91SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *ssp)
334dad81a20SPaul E. McKenney {
335dad81a20SPaul E. McKenney 	int cpu;
336dad81a20SPaul E. McKenney 	unsigned long sum = 0;
337dad81a20SPaul E. McKenney 
338dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
339aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
340dad81a20SPaul E. McKenney 
341da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[0]);
342da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[1]);
343da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[0]);
344da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[1]);
345dad81a20SPaul E. McKenney 	}
346dad81a20SPaul E. McKenney 	return sum;
347dad81a20SPaul E. McKenney }
348dad81a20SPaul E. McKenney 
349dad81a20SPaul E. McKenney #define SRCU_INTERVAL		1
350dad81a20SPaul E. McKenney 
3511e9a038bSPaul E. McKenney /*
3521e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
3531e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
3541e9a038bSPaul E. McKenney  */
355aacb5d91SPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *ssp)
3561e9a038bSPaul E. McKenney {
357aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_gp_seq),
358aacb5d91SPaul E. McKenney 			 READ_ONCE(ssp->srcu_gp_seq_needed_exp)))
3591e9a038bSPaul E. McKenney 		return 0;
3601e9a038bSPaul E. McKenney 	return SRCU_INTERVAL;
3611e9a038bSPaul E. McKenney }
3621e9a038bSPaul E. McKenney 
363f5ad3991SPaul E. McKenney /**
364f5ad3991SPaul E. McKenney  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
365f5ad3991SPaul E. McKenney  * @ssp: structure to clean up.
366f5ad3991SPaul E. McKenney  *
367f5ad3991SPaul E. McKenney  * Must invoke this after you are finished using a given srcu_struct that
368f5ad3991SPaul E. McKenney  * was initialized via init_srcu_struct(), else you leak memory.
369f5ad3991SPaul E. McKenney  */
370f5ad3991SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *ssp)
371dad81a20SPaul E. McKenney {
372da915ad5SPaul E. McKenney 	int cpu;
373da915ad5SPaul E. McKenney 
374aacb5d91SPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(ssp)))
375f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
376aacb5d91SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(ssp)))
377f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
378aacb5d91SPaul E. McKenney 	flush_delayed_work(&ssp->work);
379e81baf4cSSebastian Andrzej Siewior 	for_each_possible_cpu(cpu) {
380e81baf4cSSebastian Andrzej Siewior 		struct srcu_data *sdp = per_cpu_ptr(ssp->sda, cpu);
381e81baf4cSSebastian Andrzej Siewior 
382e81baf4cSSebastian Andrzej Siewior 		del_timer_sync(&sdp->delay_work);
383e81baf4cSSebastian Andrzej Siewior 		flush_work(&sdp->work);
3845cdfd174SPaul E. McKenney 		if (WARN_ON(rcu_segcblist_n_cbs(&sdp->srcu_cblist)))
3855cdfd174SPaul E. McKenney 			return; /* Forgot srcu_barrier(), so just leak it! */
386f7194ac3SPaul E. McKenney 	}
387aacb5d91SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
388aacb5d91SPaul E. McKenney 	    WARN_ON(srcu_readers_active(ssp))) {
389a7538352SJoe Perches 		pr_info("%s: Active srcu_struct %p state: %d\n",
390aacb5d91SPaul E. McKenney 			__func__, ssp, rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)));
391dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
392dad81a20SPaul E. McKenney 	}
393aacb5d91SPaul E. McKenney 	free_percpu(ssp->sda);
394aacb5d91SPaul E. McKenney 	ssp->sda = NULL;
395dad81a20SPaul E. McKenney }
396f5ad3991SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
397dad81a20SPaul E. McKenney 
398dad81a20SPaul E. McKenney /*
399dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
400cdf7abc4SPaolo Bonzini  * srcu_struct.
401dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
402dad81a20SPaul E. McKenney  */
403aacb5d91SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *ssp)
404dad81a20SPaul E. McKenney {
405dad81a20SPaul E. McKenney 	int idx;
406dad81a20SPaul E. McKenney 
407aacb5d91SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
408aacb5d91SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_lock_count[idx]);
409dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
410dad81a20SPaul E. McKenney 	return idx;
411dad81a20SPaul E. McKenney }
412dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
413dad81a20SPaul E. McKenney 
414dad81a20SPaul E. McKenney /*
415dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
416dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
417dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
418dad81a20SPaul E. McKenney  */
419aacb5d91SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *ssp, int idx)
420dad81a20SPaul E. McKenney {
421dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
422aacb5d91SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_unlock_count[idx]);
423dad81a20SPaul E. McKenney }
424dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
425dad81a20SPaul E. McKenney 
426dad81a20SPaul E. McKenney /*
427dad81a20SPaul E. McKenney  * We use an adaptive strategy for synchronize_srcu() and especially for
428dad81a20SPaul E. McKenney  * synchronize_srcu_expedited().  We spin for a fixed time period
429dad81a20SPaul E. McKenney  * (defined below) to allow SRCU readers to exit their read-side critical
430dad81a20SPaul E. McKenney  * sections.  If there are still some readers after a few microseconds,
431dad81a20SPaul E. McKenney  * we repeatedly block for 1-millisecond time periods.
432dad81a20SPaul E. McKenney  */
433dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY		5
434dad81a20SPaul E. McKenney 
435dad81a20SPaul E. McKenney /*
436dad81a20SPaul E. McKenney  * Start an SRCU grace period.
437dad81a20SPaul E. McKenney  */
438aacb5d91SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *ssp)
439dad81a20SPaul E. McKenney {
440aacb5d91SPaul E. McKenney 	struct srcu_data *sdp = this_cpu_ptr(ssp->sda);
441dad81a20SPaul E. McKenney 	int state;
442dad81a20SPaul E. McKenney 
443aacb5d91SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp, lock));
444aacb5d91SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
445eb4c2382SDennis Krein 	spin_lock_rcu_node(sdp);  /* Interrupts already disabled. */
446da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
447aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
448da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
449aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
450eb4c2382SDennis Krein 	spin_unlock_rcu_node(sdp);  /* Interrupts remain disabled. */
4512da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
452aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_gp_seq);
453aacb5d91SPaul E. McKenney 	state = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
454dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
455dad81a20SPaul E. McKenney }
456dad81a20SPaul E. McKenney 
457da915ad5SPaul E. McKenney 
458e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t)
459da915ad5SPaul E. McKenney {
460e81baf4cSSebastian Andrzej Siewior 	struct srcu_data *sdp = container_of(t, struct srcu_data, delay_work);
461e81baf4cSSebastian Andrzej Siewior 
462e81baf4cSSebastian Andrzej Siewior 	queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
463da915ad5SPaul E. McKenney }
464da915ad5SPaul E. McKenney 
465e81baf4cSSebastian Andrzej Siewior static void srcu_queue_delayed_work_on(struct srcu_data *sdp,
466da915ad5SPaul E. McKenney 				       unsigned long delay)
467da915ad5SPaul E. McKenney {
468e81baf4cSSebastian Andrzej Siewior 	if (!delay) {
469e81baf4cSSebastian Andrzej Siewior 		queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
470e81baf4cSSebastian Andrzej Siewior 		return;
471e81baf4cSSebastian Andrzej Siewior 	}
472da915ad5SPaul E. McKenney 
473e81baf4cSSebastian Andrzej Siewior 	timer_reduce(&sdp->delay_work, jiffies + delay);
474da915ad5SPaul E. McKenney }
475da915ad5SPaul E. McKenney 
476da915ad5SPaul E. McKenney /*
477da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
478da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
479da915ad5SPaul E. McKenney  */
480da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
481da915ad5SPaul E. McKenney {
482e81baf4cSSebastian Andrzej Siewior 	srcu_queue_delayed_work_on(sdp, delay);
483da915ad5SPaul E. McKenney }
484da915ad5SPaul E. McKenney 
485da915ad5SPaul E. McKenney /*
486da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
487c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
488c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
489c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
490da915ad5SPaul E. McKenney  */
491aacb5d91SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *ssp, struct srcu_node *snp,
4921e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
493da915ad5SPaul E. McKenney {
494da915ad5SPaul E. McKenney 	int cpu;
495da915ad5SPaul E. McKenney 
496c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
497c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
498c7e88067SPaul E. McKenney 			continue;
499aacb5d91SPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, cpu), delay);
500da915ad5SPaul E. McKenney 	}
501c7e88067SPaul E. McKenney }
502da915ad5SPaul E. McKenney 
503da915ad5SPaul E. McKenney /*
504da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
505da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
506da915ad5SPaul E. McKenney  *
507da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
508da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
509da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
510da915ad5SPaul E. McKenney  * array to have a finite number of elements.
511da915ad5SPaul E. McKenney  */
512aacb5d91SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *ssp)
513da915ad5SPaul E. McKenney {
5141e9a038bSPaul E. McKenney 	unsigned long cbdelay;
515da915ad5SPaul E. McKenney 	bool cbs;
5168ddbd883SIldar Ismagilov 	bool last_lvl;
517c350c008SPaul E. McKenney 	int cpu;
518c350c008SPaul E. McKenney 	unsigned long flags;
519da915ad5SPaul E. McKenney 	unsigned long gpseq;
520da915ad5SPaul E. McKenney 	int idx;
521c7e88067SPaul E. McKenney 	unsigned long mask;
522c350c008SPaul E. McKenney 	struct srcu_data *sdp;
523da915ad5SPaul E. McKenney 	struct srcu_node *snp;
524da915ad5SPaul E. McKenney 
525da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
526aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_cb_mutex);
527da915ad5SPaul E. McKenney 
528da915ad5SPaul E. McKenney 	/* End the current grace period. */
529aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
530aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(ssp->srcu_gp_seq);
531da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
532aacb5d91SPaul E. McKenney 	cbdelay = srcu_get_delay(ssp);
533844a378dSPaul E. McKenney 	WRITE_ONCE(ssp->srcu_last_gp_end, ktime_get_mono_fast_ns());
534aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_gp_seq);
535aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
536aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, gpseq))
537aacb5d91SPaul E. McKenney 		ssp->srcu_gp_seq_needed_exp = gpseq;
538aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
539aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_gp_mutex);
540da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
541da915ad5SPaul E. McKenney 
542da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
543da915ad5SPaul E. McKenney 	idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
544aacb5d91SPaul E. McKenney 	srcu_for_each_node_breadth_first(ssp, snp) {
545d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(snp);
546da915ad5SPaul E. McKenney 		cbs = false;
547aacb5d91SPaul E. McKenney 		last_lvl = snp >= ssp->level[rcu_num_lvls - 1];
5488ddbd883SIldar Ismagilov 		if (last_lvl)
549da915ad5SPaul E. McKenney 			cbs = snp->srcu_have_cbs[idx] == gpseq;
550da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = gpseq;
551da915ad5SPaul E. McKenney 		rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
5521e9a038bSPaul E. McKenney 		if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
553*7ff8b450SPaul E. McKenney 			WRITE_ONCE(snp->srcu_gp_seq_needed_exp, gpseq);
554c7e88067SPaul E. McKenney 		mask = snp->srcu_data_have_cbs[idx];
555c7e88067SPaul E. McKenney 		snp->srcu_data_have_cbs[idx] = 0;
556d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(snp);
557a3883df3SPaul E. McKenney 		if (cbs)
558aacb5d91SPaul E. McKenney 			srcu_schedule_cbs_snp(ssp, snp, mask, cbdelay);
559c350c008SPaul E. McKenney 
560c350c008SPaul E. McKenney 		/* Occasionally prevent srcu_data counter wrap. */
5618ddbd883SIldar Ismagilov 		if (!(gpseq & counter_wrap_check) && last_lvl)
562c350c008SPaul E. McKenney 			for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
563aacb5d91SPaul E. McKenney 				sdp = per_cpu_ptr(ssp->sda, cpu);
564d6331980SPaul E. McKenney 				spin_lock_irqsave_rcu_node(sdp, flags);
565c350c008SPaul E. McKenney 				if (ULONG_CMP_GE(gpseq,
566c350c008SPaul E. McKenney 						 sdp->srcu_gp_seq_needed + 100))
567c350c008SPaul E. McKenney 					sdp->srcu_gp_seq_needed = gpseq;
568a35d13ecSIldar Ismagilov 				if (ULONG_CMP_GE(gpseq,
569a35d13ecSIldar Ismagilov 						 sdp->srcu_gp_seq_needed_exp + 100))
570a35d13ecSIldar Ismagilov 					sdp->srcu_gp_seq_needed_exp = gpseq;
571d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(sdp, flags);
572c350c008SPaul E. McKenney 			}
573da915ad5SPaul E. McKenney 	}
574da915ad5SPaul E. McKenney 
575da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
576aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_cb_mutex);
577da915ad5SPaul E. McKenney 
578da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
579aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
580aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
581da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
582aacb5d91SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, ssp->srcu_gp_seq_needed)) {
583aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
584aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
585aacb5d91SPaul E. McKenney 		srcu_reschedule(ssp, 0);
586da915ad5SPaul E. McKenney 	} else {
587aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
588da915ad5SPaul E. McKenney 	}
589da915ad5SPaul E. McKenney }
590da915ad5SPaul E. McKenney 
591da915ad5SPaul E. McKenney /*
5921e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
5931e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
5941e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
5951e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
5961e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
5971e9a038bSPaul E. McKenney  */
598aacb5d91SPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *ssp, struct srcu_node *snp,
5991e9a038bSPaul E. McKenney 				  unsigned long s)
6001e9a038bSPaul E. McKenney {
6011e9a038bSPaul E. McKenney 	unsigned long flags;
6021e9a038bSPaul E. McKenney 
6031e9a038bSPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
604aacb5d91SPaul E. McKenney 		if (rcu_seq_done(&ssp->srcu_gp_seq, s) ||
6051e9a038bSPaul E. McKenney 		    ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
6061e9a038bSPaul E. McKenney 			return;
607d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
6081e9a038bSPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
609d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
6101e9a038bSPaul E. McKenney 			return;
6111e9a038bSPaul E. McKenney 		}
6121e9a038bSPaul E. McKenney 		WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
613d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
6141e9a038bSPaul E. McKenney 	}
615aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
616aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
617aacb5d91SPaul E. McKenney 		ssp->srcu_gp_seq_needed_exp = s;
618aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
6191e9a038bSPaul E. McKenney }
6201e9a038bSPaul E. McKenney 
6211e9a038bSPaul E. McKenney /*
622da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
623da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
624da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
625da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
626da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
62717294ce6SPaul E. McKenney  *
62817294ce6SPaul E. McKenney  * Note that this function also does the work of srcu_funnel_exp_start(),
62917294ce6SPaul E. McKenney  * in some cases by directly invoking it.
630da915ad5SPaul E. McKenney  */
631aacb5d91SPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *ssp, struct srcu_data *sdp,
6321e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
633da915ad5SPaul E. McKenney {
634da915ad5SPaul E. McKenney 	unsigned long flags;
635da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
636da915ad5SPaul E. McKenney 	struct srcu_node *snp = sdp->mynode;
637da915ad5SPaul E. McKenney 	unsigned long snp_seq;
638da915ad5SPaul E. McKenney 
639da915ad5SPaul E. McKenney 	/* Each pass through the loop does one level of the srcu_node tree. */
640da915ad5SPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
641aacb5d91SPaul E. McKenney 		if (rcu_seq_done(&ssp->srcu_gp_seq, s) && snp != sdp->mynode)
642da915ad5SPaul E. McKenney 			return; /* GP already done and CBs recorded. */
643d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
644da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
645da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
646c7e88067SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq == s)
647c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
648d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
649da915ad5SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq != s) {
6501e9a038bSPaul E. McKenney 				srcu_schedule_cbs_sdp(sdp, do_norm
6511e9a038bSPaul E. McKenney 							   ? SRCU_INTERVAL
6521e9a038bSPaul E. McKenney 							   : 0);
6531e9a038bSPaul E. McKenney 				return;
654da915ad5SPaul E. McKenney 			}
6551e9a038bSPaul E. McKenney 			if (!do_norm)
656aacb5d91SPaul E. McKenney 				srcu_funnel_exp_start(ssp, snp, s);
657da915ad5SPaul E. McKenney 			return;
658da915ad5SPaul E. McKenney 		}
659da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = s;
660c7e88067SPaul E. McKenney 		if (snp == sdp->mynode)
661c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
6621e9a038bSPaul E. McKenney 		if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
663*7ff8b450SPaul E. McKenney 			WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
664d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
665da915ad5SPaul E. McKenney 	}
666da915ad5SPaul E. McKenney 
667da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
668aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
669aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed, s)) {
670da915ad5SPaul E. McKenney 		/*
671da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
672da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
673da915ad5SPaul E. McKenney 		 */
674aacb5d91SPaul E. McKenney 		smp_store_release(&ssp->srcu_gp_seq_needed, s); /*^^^*/
675da915ad5SPaul E. McKenney 	}
676aacb5d91SPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
677aacb5d91SPaul E. McKenney 		ssp->srcu_gp_seq_needed_exp = s;
678da915ad5SPaul E. McKenney 
679da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
680aacb5d91SPaul E. McKenney 	if (!rcu_seq_done(&ssp->srcu_gp_seq, s) &&
681aacb5d91SPaul E. McKenney 	    rcu_seq_state(ssp->srcu_gp_seq) == SRCU_STATE_IDLE) {
682aacb5d91SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
683aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
684e0fcba9aSPaul E. McKenney 		if (likely(srcu_init_done))
685aacb5d91SPaul E. McKenney 			queue_delayed_work(rcu_gp_wq, &ssp->work,
686aacb5d91SPaul E. McKenney 					   srcu_get_delay(ssp));
687aacb5d91SPaul E. McKenney 		else if (list_empty(&ssp->work.work.entry))
688aacb5d91SPaul E. McKenney 			list_add(&ssp->work.work.entry, &srcu_boot_list);
689da915ad5SPaul E. McKenney 	}
690aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
691da915ad5SPaul E. McKenney }
692da915ad5SPaul E. McKenney 
693da915ad5SPaul E. McKenney /*
694dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
695dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
696da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
697dad81a20SPaul E. McKenney  */
698aacb5d91SPaul E. McKenney static bool try_check_zero(struct srcu_struct *ssp, int idx, int trycount)
699dad81a20SPaul E. McKenney {
700dad81a20SPaul E. McKenney 	for (;;) {
701aacb5d91SPaul E. McKenney 		if (srcu_readers_active_idx_check(ssp, idx))
702dad81a20SPaul E. McKenney 			return true;
703aacb5d91SPaul E. McKenney 		if (--trycount + !srcu_get_delay(ssp) <= 0)
704dad81a20SPaul E. McKenney 			return false;
705dad81a20SPaul E. McKenney 		udelay(SRCU_RETRY_CHECK_DELAY);
706dad81a20SPaul E. McKenney 	}
707dad81a20SPaul E. McKenney }
708dad81a20SPaul E. McKenney 
709dad81a20SPaul E. McKenney /*
710da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
711da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
712dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
713dad81a20SPaul E. McKenney  */
714aacb5d91SPaul E. McKenney static void srcu_flip(struct srcu_struct *ssp)
715dad81a20SPaul E. McKenney {
716881ec9d2SPaul E. McKenney 	/*
717881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
718881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
719881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
720881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
721881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
722881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
723881ec9d2SPaul E. McKenney 	 */
724881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
725881ec9d2SPaul E. McKenney 
726aacb5d91SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_idx, ssp->srcu_idx + 1);
727dad81a20SPaul E. McKenney 
728dad81a20SPaul E. McKenney 	/*
729dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
730dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
731dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
732dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
733dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
734dad81a20SPaul E. McKenney 	 */
735dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
736dad81a20SPaul E. McKenney }
737dad81a20SPaul E. McKenney 
738dad81a20SPaul E. McKenney /*
7392da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
7402da4b2a7SPaul E. McKenney  *
7412da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
7422da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
7432da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
7442da4b2a7SPaul E. McKenney  *
7452da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
7462da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
7472da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
7482da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
7492da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
7502da4b2a7SPaul E. McKenney  * but to accept this type of error.
7512da4b2a7SPaul E. McKenney  *
7522da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
7532da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
7542da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
7552da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
7562da4b2a7SPaul E. McKenney  * negligible when amoritized over that time period, and the extra latency
7572da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
7582da4b2a7SPaul E. McKenney  */
759aacb5d91SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *ssp)
7602da4b2a7SPaul E. McKenney {
76122607d66SPaul E. McKenney 	unsigned long curseq;
7622da4b2a7SPaul E. McKenney 	unsigned long flags;
7632da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
76422607d66SPaul E. McKenney 	unsigned long t;
765844a378dSPaul E. McKenney 	unsigned long tlast;
7662da4b2a7SPaul E. McKenney 
7672da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
7682da4b2a7SPaul E. McKenney 	local_irq_save(flags);
769aacb5d91SPaul E. McKenney 	sdp = this_cpu_ptr(ssp->sda);
7702da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
7712da4b2a7SPaul E. McKenney 		local_irq_restore(flags);
7722da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
7732da4b2a7SPaul E. McKenney 	}
7742da4b2a7SPaul E. McKenney 	local_irq_restore(flags);
7752da4b2a7SPaul E. McKenney 
7762da4b2a7SPaul E. McKenney 	/*
7772da4b2a7SPaul E. McKenney 	 * No local callbacks, so probabalistically probe global state.
7782da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
7792da4b2a7SPaul E. McKenney 	 * kill scalability, hence the probabalistic nature of the probe.
7802da4b2a7SPaul E. McKenney 	 */
78122607d66SPaul E. McKenney 
78222607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
78322607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
784844a378dSPaul E. McKenney 	tlast = READ_ONCE(ssp->srcu_last_gp_end);
78522607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
786844a378dSPaul E. McKenney 	    time_in_range_open(t, tlast, tlast + exp_holdoff))
78722607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
78822607d66SPaul E. McKenney 
78922607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
790aacb5d91SPaul E. McKenney 	curseq = rcu_seq_current(&ssp->srcu_gp_seq);
7912da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
792aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(ssp->srcu_gp_seq_needed)))
7932da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
7942da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
795aacb5d91SPaul E. McKenney 	if (curseq != rcu_seq_current(&ssp->srcu_gp_seq))
7962da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
7972da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
7982da4b2a7SPaul E. McKenney }
7992da4b2a7SPaul E. McKenney 
8002da4b2a7SPaul E. McKenney /*
801a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
802a602538eSPaul E. McKenney  */
803a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
804a602538eSPaul E. McKenney {
805a602538eSPaul E. McKenney }
806a602538eSPaul E. McKenney 
807a602538eSPaul E. McKenney /*
808da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
809da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
810da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
811dad81a20SPaul E. McKenney  *
812dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
813dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
814dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
815dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
816dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
8175ef98a63SPaul E. McKenney  * preceded the call to call_srcu().  It also means that each CPU executing
818dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
8195ef98a63SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_srcu()
820dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
821dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
822dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
823dad81a20SPaul E. McKenney  *
8245ef98a63SPaul E. McKenney  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
825dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
826dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
8275ef98a63SPaul E. McKenney  * interval between the call to call_srcu() and the invocation of "func()".
828dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
829dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
830dad81a20SPaul E. McKenney  *
831dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
832dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
833dad81a20SPaul E. McKenney  * srcu_struct structure.
834dad81a20SPaul E. McKenney  */
83511b00045SJiang Biao static void __call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
8361e9a038bSPaul E. McKenney 			rcu_callback_t func, bool do_norm)
837dad81a20SPaul E. McKenney {
838dad81a20SPaul E. McKenney 	unsigned long flags;
8390607ba84SPaul E. McKenney 	int idx;
8401e9a038bSPaul E. McKenney 	bool needexp = false;
841da915ad5SPaul E. McKenney 	bool needgp = false;
842da915ad5SPaul E. McKenney 	unsigned long s;
843da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
844dad81a20SPaul E. McKenney 
845aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
846a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
847a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
848a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
849a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
850a602538eSPaul E. McKenney 		return;
851a602538eSPaul E. McKenney 	}
852da915ad5SPaul E. McKenney 	rhp->func = func;
853aacb5d91SPaul E. McKenney 	idx = srcu_read_lock(ssp);
854da915ad5SPaul E. McKenney 	local_irq_save(flags);
855aacb5d91SPaul E. McKenney 	sdp = this_cpu_ptr(ssp->sda);
856d6331980SPaul E. McKenney 	spin_lock_rcu_node(sdp);
85777a40f97SJoel Fernandes (Google) 	rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp);
858da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
859aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
860aacb5d91SPaul E. McKenney 	s = rcu_seq_snap(&ssp->srcu_gp_seq);
861da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
862da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
863da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
864da915ad5SPaul E. McKenney 		needgp = true;
865dad81a20SPaul E. McKenney 	}
8661e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
8671e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
8681e9a038bSPaul E. McKenney 		needexp = true;
8691e9a038bSPaul E. McKenney 	}
870d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
871da915ad5SPaul E. McKenney 	if (needgp)
872aacb5d91SPaul E. McKenney 		srcu_funnel_gp_start(ssp, sdp, s, do_norm);
8731e9a038bSPaul E. McKenney 	else if (needexp)
874aacb5d91SPaul E. McKenney 		srcu_funnel_exp_start(ssp, sdp->mynode, s);
875aacb5d91SPaul E. McKenney 	srcu_read_unlock(ssp, idx);
8761e9a038bSPaul E. McKenney }
8771e9a038bSPaul E. McKenney 
8785a0465e1SPaul E. McKenney /**
8795a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
880aacb5d91SPaul E. McKenney  * @ssp: srcu_struct in queue the callback
88127fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
8825a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
8835a0465e1SPaul E. McKenney  *
8845a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
8855a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
8865a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
8875a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
8885a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
8895a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
8905a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
8915a0465e1SPaul E. McKenney  *
8925a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
8935a0465e1SPaul E. McKenney  * be fast and must not block.
8945a0465e1SPaul E. McKenney  */
895aacb5d91SPaul E. McKenney void call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
8961e9a038bSPaul E. McKenney 	       rcu_callback_t func)
8971e9a038bSPaul E. McKenney {
898aacb5d91SPaul E. McKenney 	__call_srcu(ssp, rhp, func, true);
899dad81a20SPaul E. McKenney }
900dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
901dad81a20SPaul E. McKenney 
902dad81a20SPaul E. McKenney /*
903dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
904dad81a20SPaul E. McKenney  */
905aacb5d91SPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *ssp, bool do_norm)
906dad81a20SPaul E. McKenney {
907dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
908dad81a20SPaul E. McKenney 
909aacb5d91SPaul E. McKenney 	RCU_LOCKDEP_WARN(lock_is_held(&ssp->dep_map) ||
910dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
911dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
912dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
913dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
914dad81a20SPaul E. McKenney 
915dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
916dad81a20SPaul E. McKenney 		return;
917dad81a20SPaul E. McKenney 	might_sleep();
918aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
919dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
920da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
921aacb5d91SPaul E. McKenney 	__call_srcu(ssp, &rcu.head, wakeme_after_rcu, do_norm);
922dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
923da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
92435732cf9SPaul E. McKenney 
92535732cf9SPaul E. McKenney 	/*
92635732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
927d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
92835732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
92935732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
93035732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
93135732cf9SPaul E. McKenney 	 */
93235732cf9SPaul E. McKenney 	smp_mb();
933dad81a20SPaul E. McKenney }
934dad81a20SPaul E. McKenney 
935dad81a20SPaul E. McKenney /**
936dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
937aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
938dad81a20SPaul E. McKenney  *
939dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
940dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
941dad81a20SPaul E. McKenney  *
942dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
943dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
944dad81a20SPaul E. McKenney  */
945aacb5d91SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *ssp)
946dad81a20SPaul E. McKenney {
947aacb5d91SPaul E. McKenney 	__synchronize_srcu(ssp, rcu_gp_is_normal());
948dad81a20SPaul E. McKenney }
949dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
950dad81a20SPaul E. McKenney 
951dad81a20SPaul E. McKenney /**
952dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
953aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
954dad81a20SPaul E. McKenney  *
955dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
956dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
957da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
958da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
959dad81a20SPaul E. McKenney  *
960dad81a20SPaul E. McKenney  * Can block; must be called from process context.
961dad81a20SPaul E. McKenney  *
962dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
963dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
964dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
965dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
966dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
967dad81a20SPaul E. McKenney  *
968dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
969dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
970dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
9716eb95cc4SPaul E. McKenney  * the end of its last corresponding SRCU read-side critical section
972dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
973dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
974dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
975dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
976dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
977dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
978dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
979dad81a20SPaul E. McKenney  *
980dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
981dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
982dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
983dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
984dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
985dad81a20SPaul E. McKenney  *
986dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
987dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
988dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
9892da4b2a7SPaul E. McKenney  *
9902da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
9912da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
9922da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
9932da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
994dad81a20SPaul E. McKenney  */
995aacb5d91SPaul E. McKenney void synchronize_srcu(struct srcu_struct *ssp)
996dad81a20SPaul E. McKenney {
997aacb5d91SPaul E. McKenney 	if (srcu_might_be_idle(ssp) || rcu_gp_is_expedited())
998aacb5d91SPaul E. McKenney 		synchronize_srcu_expedited(ssp);
999dad81a20SPaul E. McKenney 	else
1000aacb5d91SPaul E. McKenney 		__synchronize_srcu(ssp, true);
1001dad81a20SPaul E. McKenney }
1002dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1003dad81a20SPaul E. McKenney 
1004da915ad5SPaul E. McKenney /*
1005da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1006da915ad5SPaul E. McKenney  */
1007da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1008da915ad5SPaul E. McKenney {
1009da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1010aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1011da915ad5SPaul E. McKenney 
1012da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1013aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1014aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1015aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1016da915ad5SPaul E. McKenney }
1017da915ad5SPaul E. McKenney 
1018dad81a20SPaul E. McKenney /**
1019dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1020aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to wait for in-flight callbacks.
1021dad81a20SPaul E. McKenney  */
1022aacb5d91SPaul E. McKenney void srcu_barrier(struct srcu_struct *ssp)
1023dad81a20SPaul E. McKenney {
1024da915ad5SPaul E. McKenney 	int cpu;
1025da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1026aacb5d91SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&ssp->srcu_barrier_seq);
1027da915ad5SPaul E. McKenney 
1028aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1029aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_barrier_mutex);
1030aacb5d91SPaul E. McKenney 	if (rcu_seq_done(&ssp->srcu_barrier_seq, s)) {
1031da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1032aacb5d91SPaul E. McKenney 		mutex_unlock(&ssp->srcu_barrier_mutex);
1033da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1034da915ad5SPaul E. McKenney 	}
1035aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_barrier_seq);
1036aacb5d91SPaul E. McKenney 	init_completion(&ssp->srcu_barrier_completion);
1037da915ad5SPaul E. McKenney 
1038da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1039aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 1);
1040da915ad5SPaul E. McKenney 
1041da915ad5SPaul E. McKenney 	/*
1042da915ad5SPaul E. McKenney 	 * Each pass through this loop enqueues a callback, but only
1043da915ad5SPaul E. McKenney 	 * on CPUs already having callbacks enqueued.  Note that if
1044da915ad5SPaul E. McKenney 	 * a CPU already has callbacks enqueue, it must have already
1045da915ad5SPaul E. McKenney 	 * registered the need for a future grace period, so all we
1046da915ad5SPaul E. McKenney 	 * need do is enqueue a callback that will use the same
1047da915ad5SPaul E. McKenney 	 * grace period as the last callback already in the queue.
1048da915ad5SPaul E. McKenney 	 */
1049da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1050aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
1051d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sdp);
1052aacb5d91SPaul E. McKenney 		atomic_inc(&ssp->srcu_barrier_cpu_cnt);
1053da915ad5SPaul E. McKenney 		sdp->srcu_barrier_head.func = srcu_barrier_cb;
1054a602538eSPaul E. McKenney 		debug_rcu_head_queue(&sdp->srcu_barrier_head);
1055da915ad5SPaul E. McKenney 		if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
105677a40f97SJoel Fernandes (Google) 					   &sdp->srcu_barrier_head)) {
1057a602538eSPaul E. McKenney 			debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1058aacb5d91SPaul E. McKenney 			atomic_dec(&ssp->srcu_barrier_cpu_cnt);
1059a602538eSPaul E. McKenney 		}
1060d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1061da915ad5SPaul E. McKenney 	}
1062da915ad5SPaul E. McKenney 
1063da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1064aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1065aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1066aacb5d91SPaul E. McKenney 	wait_for_completion(&ssp->srcu_barrier_completion);
1067da915ad5SPaul E. McKenney 
1068aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_barrier_seq);
1069aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_barrier_mutex);
1070dad81a20SPaul E. McKenney }
1071dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1072dad81a20SPaul E. McKenney 
1073dad81a20SPaul E. McKenney /**
1074dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1075aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to report batch completion.
1076dad81a20SPaul E. McKenney  *
1077dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1078dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1079dad81a20SPaul E. McKenney  */
1080aacb5d91SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *ssp)
1081dad81a20SPaul E. McKenney {
1082aacb5d91SPaul E. McKenney 	return ssp->srcu_idx;
1083dad81a20SPaul E. McKenney }
1084dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1085dad81a20SPaul E. McKenney 
1086dad81a20SPaul E. McKenney /*
1087da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1088da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1089da915ad5SPaul E. McKenney  * completed in that state.
1090dad81a20SPaul E. McKenney  */
1091aacb5d91SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *ssp)
1092dad81a20SPaul E. McKenney {
1093dad81a20SPaul E. McKenney 	int idx;
1094dad81a20SPaul E. McKenney 
1095aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_gp_mutex);
1096da915ad5SPaul E. McKenney 
1097dad81a20SPaul E. McKenney 	/*
1098dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1099da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1100dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1101dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1102dad81a20SPaul E. McKenney 	 * invoking a callback.
1103dad81a20SPaul E. McKenney 	 *
1104dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1105dad81a20SPaul E. McKenney 	 * by the prior grace period.
1106dad81a20SPaul E. McKenney 	 */
1107aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq)); /* ^^^ */
1108dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1109aacb5d91SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp);
1110aacb5d91SPaul E. McKenney 		if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1111aacb5d91SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq));
1112aacb5d91SPaul E. McKenney 			spin_unlock_irq_rcu_node(ssp);
1113aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1114dad81a20SPaul E. McKenney 			return;
1115dad81a20SPaul E. McKenney 		}
1116aacb5d91SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
1117dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1118aacb5d91SPaul E. McKenney 			srcu_gp_start(ssp);
1119aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
1120da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1121aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1122dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1123dad81a20SPaul E. McKenney 		}
1124da915ad5SPaul E. McKenney 	}
1125dad81a20SPaul E. McKenney 
1126aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1127aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1128aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 1)) {
1129aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1130dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1131da915ad5SPaul E. McKenney 		}
1132aacb5d91SPaul E. McKenney 		srcu_flip(ssp);
1133aacb5d91SPaul E. McKenney 		rcu_seq_set_state(&ssp->srcu_gp_seq, SRCU_STATE_SCAN2);
1134dad81a20SPaul E. McKenney 	}
1135dad81a20SPaul E. McKenney 
1136aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1137dad81a20SPaul E. McKenney 
1138dad81a20SPaul E. McKenney 		/*
1139dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1140dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1141dad81a20SPaul E. McKenney 		 */
1142aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1143aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 2)) {
1144aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1145da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1146da915ad5SPaul E. McKenney 		}
1147aacb5d91SPaul E. McKenney 		srcu_gp_end(ssp);  /* Releases ->srcu_gp_mutex. */
1148dad81a20SPaul E. McKenney 	}
1149dad81a20SPaul E. McKenney }
1150dad81a20SPaul E. McKenney 
1151dad81a20SPaul E. McKenney /*
1152dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1153dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1154dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1155dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1156dad81a20SPaul E. McKenney  */
1157da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1158dad81a20SPaul E. McKenney {
1159da915ad5SPaul E. McKenney 	bool more;
1160dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1161dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1162da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1163aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1164dad81a20SPaul E. McKenney 
1165e81baf4cSSebastian Andrzej Siewior 	sdp = container_of(work, struct srcu_data, work);
1166e81baf4cSSebastian Andrzej Siewior 
1167aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1168dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1169d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1170da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1171aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
1172da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1173da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1174d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1175da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1176da915ad5SPaul E. McKenney 	}
1177da915ad5SPaul E. McKenney 
1178da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1179da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1180da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1181d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1182dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1183dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1184a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1185dad81a20SPaul E. McKenney 		local_bh_disable();
1186dad81a20SPaul E. McKenney 		rhp->func(rhp);
1187dad81a20SPaul E. McKenney 		local_bh_enable();
1188dad81a20SPaul E. McKenney 	}
1189da915ad5SPaul E. McKenney 
1190da915ad5SPaul E. McKenney 	/*
1191da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1192da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1193da915ad5SPaul E. McKenney 	 */
1194d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1195da915ad5SPaul E. McKenney 	rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1196da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1197aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
1198da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1199da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1200d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1201da915ad5SPaul E. McKenney 	if (more)
1202da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1203dad81a20SPaul E. McKenney }
1204dad81a20SPaul E. McKenney 
1205dad81a20SPaul E. McKenney /*
1206dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1207dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1208dad81a20SPaul E. McKenney  */
1209aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay)
1210dad81a20SPaul E. McKenney {
1211da915ad5SPaul E. McKenney 	bool pushgp = true;
1212dad81a20SPaul E. McKenney 
1213aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
1214aacb5d91SPaul E. McKenney 	if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1215aacb5d91SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq))) {
1216da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1217da915ad5SPaul E. McKenney 			pushgp = false;
1218dad81a20SPaul E. McKenney 		}
1219aacb5d91SPaul E. McKenney 	} else if (!rcu_seq_state(ssp->srcu_gp_seq)) {
1220da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1221aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
1222da915ad5SPaul E. McKenney 	}
1223aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
1224dad81a20SPaul E. McKenney 
1225da915ad5SPaul E. McKenney 	if (pushgp)
1226aacb5d91SPaul E. McKenney 		queue_delayed_work(rcu_gp_wq, &ssp->work, delay);
1227dad81a20SPaul E. McKenney }
1228dad81a20SPaul E. McKenney 
1229dad81a20SPaul E. McKenney /*
1230dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1231dad81a20SPaul E. McKenney  */
12320d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1233dad81a20SPaul E. McKenney {
1234aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1235dad81a20SPaul E. McKenney 
1236aacb5d91SPaul E. McKenney 	ssp = container_of(work, struct srcu_struct, work.work);
1237dad81a20SPaul E. McKenney 
1238aacb5d91SPaul E. McKenney 	srcu_advance_state(ssp);
1239aacb5d91SPaul E. McKenney 	srcu_reschedule(ssp, srcu_get_delay(ssp));
1240dad81a20SPaul E. McKenney }
12417f6733c3SPaul E. McKenney 
12427f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
1243aacb5d91SPaul E. McKenney 			     struct srcu_struct *ssp, int *flags,
1244aebc8264SPaul E. McKenney 			     unsigned long *gp_seq)
12457f6733c3SPaul E. McKenney {
12467f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
12477f6733c3SPaul E. McKenney 		return;
12487f6733c3SPaul E. McKenney 	*flags = 0;
1249aacb5d91SPaul E. McKenney 	*gp_seq = rcu_seq_current(&ssp->srcu_gp_seq);
12507f6733c3SPaul E. McKenney }
12517f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
12521f4f6da1SPaul E. McKenney 
1253aacb5d91SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *ssp, char *tt, char *tf)
1254115a1a52SPaul E. McKenney {
1255115a1a52SPaul E. McKenney 	int cpu;
1256115a1a52SPaul E. McKenney 	int idx;
1257ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1258115a1a52SPaul E. McKenney 
1259aacb5d91SPaul E. McKenney 	idx = ssp->srcu_idx & 0x1;
126052e17ba1SPaul E. McKenney 	pr_alert("%s%s Tree SRCU g%ld per-CPU(idx=%d):",
1261aacb5d91SPaul E. McKenney 		 tt, tf, rcu_seq_current(&ssp->srcu_gp_seq), idx);
1262115a1a52SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1263115a1a52SPaul E. McKenney 		unsigned long l0, l1;
1264115a1a52SPaul E. McKenney 		unsigned long u0, u1;
1265115a1a52SPaul E. McKenney 		long c0, c1;
12665ab07a8dSPaul E. McKenney 		struct srcu_data *sdp;
1267115a1a52SPaul E. McKenney 
1268aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
12695ab07a8dSPaul E. McKenney 		u0 = sdp->srcu_unlock_count[!idx];
12705ab07a8dSPaul E. McKenney 		u1 = sdp->srcu_unlock_count[idx];
1271115a1a52SPaul E. McKenney 
1272115a1a52SPaul E. McKenney 		/*
1273115a1a52SPaul E. McKenney 		 * Make sure that a lock is always counted if the corresponding
1274115a1a52SPaul E. McKenney 		 * unlock is counted.
1275115a1a52SPaul E. McKenney 		 */
1276115a1a52SPaul E. McKenney 		smp_rmb();
1277115a1a52SPaul E. McKenney 
12785ab07a8dSPaul E. McKenney 		l0 = sdp->srcu_lock_count[!idx];
12795ab07a8dSPaul E. McKenney 		l1 = sdp->srcu_lock_count[idx];
1280115a1a52SPaul E. McKenney 
1281115a1a52SPaul E. McKenney 		c0 = l0 - u0;
1282115a1a52SPaul E. McKenney 		c1 = l1 - u1;
12837e210a65SPaul E. McKenney 		pr_cont(" %d(%ld,%ld %c)",
12847e210a65SPaul E. McKenney 			cpu, c0, c1,
12857e210a65SPaul E. McKenney 			"C."[rcu_segcblist_empty(&sdp->srcu_cblist)]);
1286ac3748c6SPaul E. McKenney 		s0 += c0;
1287ac3748c6SPaul E. McKenney 		s1 += c1;
1288115a1a52SPaul E. McKenney 	}
1289ac3748c6SPaul E. McKenney 	pr_cont(" T(%ld,%ld)\n", s0, s1);
1290115a1a52SPaul E. McKenney }
1291115a1a52SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1292115a1a52SPaul E. McKenney 
12931f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void)
12941f4f6da1SPaul E. McKenney {
12951f4f6da1SPaul E. McKenney 	pr_info("Hierarchical SRCU implementation.\n");
12960c8e0e3cSPaul E. McKenney 	if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
12970c8e0e3cSPaul E. McKenney 		pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
12981f4f6da1SPaul E. McKenney 	return 0;
12991f4f6da1SPaul E. McKenney }
13001f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce);
1301e0fcba9aSPaul E. McKenney 
1302e0fcba9aSPaul E. McKenney void __init srcu_init(void)
1303e0fcba9aSPaul E. McKenney {
1304aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1305e0fcba9aSPaul E. McKenney 
1306e0fcba9aSPaul E. McKenney 	srcu_init_done = true;
1307e0fcba9aSPaul E. McKenney 	while (!list_empty(&srcu_boot_list)) {
1308aacb5d91SPaul E. McKenney 		ssp = list_first_entry(&srcu_boot_list, struct srcu_struct,
13094e6ea4efSPaul E. McKenney 				      work.work.entry);
1310aacb5d91SPaul E. McKenney 		check_init_srcu_struct(ssp);
1311aacb5d91SPaul E. McKenney 		list_del_init(&ssp->work.work.entry);
1312aacb5d91SPaul E. McKenney 		queue_work(rcu_gp_wq, &ssp->work.work);
1313e0fcba9aSPaul E. McKenney 	}
1314e0fcba9aSPaul E. McKenney }
1315fe15b50cSPaul E. McKenney 
1316fe15b50cSPaul E. McKenney #ifdef CONFIG_MODULES
1317fe15b50cSPaul E. McKenney 
1318fe15b50cSPaul E. McKenney /* Initialize any global-scope srcu_struct structures used by this module. */
1319fe15b50cSPaul E. McKenney static int srcu_module_coming(struct module *mod)
1320fe15b50cSPaul E. McKenney {
1321fe15b50cSPaul E. McKenney 	int i;
1322fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1323fe15b50cSPaul E. McKenney 	int ret;
1324fe15b50cSPaul E. McKenney 
1325fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++) {
1326fe15b50cSPaul E. McKenney 		ret = init_srcu_struct(*(sspp++));
1327fe15b50cSPaul E. McKenney 		if (WARN_ON_ONCE(ret))
1328fe15b50cSPaul E. McKenney 			return ret;
1329fe15b50cSPaul E. McKenney 	}
1330fe15b50cSPaul E. McKenney 	return 0;
1331fe15b50cSPaul E. McKenney }
1332fe15b50cSPaul E. McKenney 
1333fe15b50cSPaul E. McKenney /* Clean up any global-scope srcu_struct structures used by this module. */
1334fe15b50cSPaul E. McKenney static void srcu_module_going(struct module *mod)
1335fe15b50cSPaul E. McKenney {
1336fe15b50cSPaul E. McKenney 	int i;
1337fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1338fe15b50cSPaul E. McKenney 
1339fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++)
1340fe15b50cSPaul E. McKenney 		cleanup_srcu_struct(*(sspp++));
1341fe15b50cSPaul E. McKenney }
1342fe15b50cSPaul E. McKenney 
1343fe15b50cSPaul E. McKenney /* Handle one module, either coming or going. */
1344fe15b50cSPaul E. McKenney static int srcu_module_notify(struct notifier_block *self,
1345fe15b50cSPaul E. McKenney 			      unsigned long val, void *data)
1346fe15b50cSPaul E. McKenney {
1347fe15b50cSPaul E. McKenney 	struct module *mod = data;
1348fe15b50cSPaul E. McKenney 	int ret = 0;
1349fe15b50cSPaul E. McKenney 
1350fe15b50cSPaul E. McKenney 	switch (val) {
1351fe15b50cSPaul E. McKenney 	case MODULE_STATE_COMING:
1352fe15b50cSPaul E. McKenney 		ret = srcu_module_coming(mod);
1353fe15b50cSPaul E. McKenney 		break;
1354fe15b50cSPaul E. McKenney 	case MODULE_STATE_GOING:
1355fe15b50cSPaul E. McKenney 		srcu_module_going(mod);
1356fe15b50cSPaul E. McKenney 		break;
1357fe15b50cSPaul E. McKenney 	default:
1358fe15b50cSPaul E. McKenney 		break;
1359fe15b50cSPaul E. McKenney 	}
1360fe15b50cSPaul E. McKenney 	return ret;
1361fe15b50cSPaul E. McKenney }
1362fe15b50cSPaul E. McKenney 
1363fe15b50cSPaul E. McKenney static struct notifier_block srcu_module_nb = {
1364fe15b50cSPaul E. McKenney 	.notifier_call = srcu_module_notify,
1365fe15b50cSPaul E. McKenney 	.priority = 0,
1366fe15b50cSPaul E. McKenney };
1367fe15b50cSPaul E. McKenney 
1368fe15b50cSPaul E. McKenney static __init int init_srcu_module_notifier(void)
1369fe15b50cSPaul E. McKenney {
1370fe15b50cSPaul E. McKenney 	int ret;
1371fe15b50cSPaul E. McKenney 
1372fe15b50cSPaul E. McKenney 	ret = register_module_notifier(&srcu_module_nb);
1373fe15b50cSPaul E. McKenney 	if (ret)
1374fe15b50cSPaul E. McKenney 		pr_warn("Failed to register srcu module notifier\n");
1375fe15b50cSPaul E. McKenney 	return ret;
1376fe15b50cSPaul E. McKenney }
1377fe15b50cSPaul E. McKenney late_initcall(init_srcu_module_notifier);
1378fe15b50cSPaul E. McKenney 
1379fe15b50cSPaul E. McKenney #endif /* #ifdef CONFIG_MODULES */
1380