xref: /linux-6.15/kernel/rcu/srcutree.c (revision a32e01ee)
1dad81a20SPaul E. McKenney /*
2dad81a20SPaul E. McKenney  * Sleepable Read-Copy Update mechanism for mutual exclusion.
3dad81a20SPaul E. McKenney  *
4dad81a20SPaul E. McKenney  * This program is free software; you can redistribute it and/or modify
5dad81a20SPaul E. McKenney  * it under the terms of the GNU General Public License as published by
6dad81a20SPaul E. McKenney  * the Free Software Foundation; either version 2 of the License, or
7dad81a20SPaul E. McKenney  * (at your option) any later version.
8dad81a20SPaul E. McKenney  *
9dad81a20SPaul E. McKenney  * This program is distributed in the hope that it will be useful,
10dad81a20SPaul E. McKenney  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11dad81a20SPaul E. McKenney  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12dad81a20SPaul E. McKenney  * GNU General Public License for more details.
13dad81a20SPaul E. McKenney  *
14dad81a20SPaul E. McKenney  * You should have received a copy of the GNU General Public License
15dad81a20SPaul E. McKenney  * along with this program; if not, you can access it online at
16dad81a20SPaul E. McKenney  * http://www.gnu.org/licenses/gpl-2.0.html.
17dad81a20SPaul E. McKenney  *
18dad81a20SPaul E. McKenney  * Copyright (C) IBM Corporation, 2006
19dad81a20SPaul E. McKenney  * Copyright (C) Fujitsu, 2012
20dad81a20SPaul E. McKenney  *
21dad81a20SPaul E. McKenney  * Author: Paul McKenney <[email protected]>
22dad81a20SPaul E. McKenney  *	   Lai Jiangshan <[email protected]>
23dad81a20SPaul E. McKenney  *
24dad81a20SPaul E. McKenney  * For detailed explanation of Read-Copy Update mechanism see -
25dad81a20SPaul E. McKenney  *		Documentation/RCU/ *.txt
26dad81a20SPaul E. McKenney  *
27dad81a20SPaul E. McKenney  */
28dad81a20SPaul E. McKenney 
29dad81a20SPaul E. McKenney #include <linux/export.h>
30dad81a20SPaul E. McKenney #include <linux/mutex.h>
31dad81a20SPaul E. McKenney #include <linux/percpu.h>
32dad81a20SPaul E. McKenney #include <linux/preempt.h>
33dad81a20SPaul E. McKenney #include <linux/rcupdate_wait.h>
34dad81a20SPaul E. McKenney #include <linux/sched.h>
35dad81a20SPaul E. McKenney #include <linux/smp.h>
36dad81a20SPaul E. McKenney #include <linux/delay.h>
3722607d66SPaul E. McKenney #include <linux/module.h>
38dad81a20SPaul E. McKenney #include <linux/srcu.h>
39dad81a20SPaul E. McKenney 
40dad81a20SPaul E. McKenney #include "rcu.h"
4145753c5fSIngo Molnar #include "rcu_segcblist.h"
42dad81a20SPaul E. McKenney 
430c8e0e3cSPaul E. McKenney /* Holdoff in nanoseconds for auto-expediting. */
440c8e0e3cSPaul E. McKenney #define DEFAULT_SRCU_EXP_HOLDOFF (25 * 1000)
450c8e0e3cSPaul E. McKenney static ulong exp_holdoff = DEFAULT_SRCU_EXP_HOLDOFF;
4622607d66SPaul E. McKenney module_param(exp_holdoff, ulong, 0444);
4722607d66SPaul E. McKenney 
48c350c008SPaul E. McKenney /* Overflow-check frequency.  N bits roughly says every 2**N grace periods. */
49c350c008SPaul E. McKenney static ulong counter_wrap_check = (ULONG_MAX >> 2);
50c350c008SPaul E. McKenney module_param(counter_wrap_check, ulong, 0444);
51c350c008SPaul E. McKenney 
52da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work);
53da915ad5SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay);
540d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work);
55da915ad5SPaul E. McKenney 
56d6331980SPaul E. McKenney /* Wrappers for lock acquisition and release, see raw_spin_lock_rcu_node(). */
57d6331980SPaul E. McKenney #define spin_lock_rcu_node(p)					\
58d6331980SPaul E. McKenney do {									\
59d6331980SPaul E. McKenney 	spin_lock(&ACCESS_PRIVATE(p, lock));			\
60d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
61d6331980SPaul E. McKenney } while (0)
62d6331980SPaul E. McKenney 
63d6331980SPaul E. McKenney #define spin_unlock_rcu_node(p) spin_unlock(&ACCESS_PRIVATE(p, lock))
64d6331980SPaul E. McKenney 
65d6331980SPaul E. McKenney #define spin_lock_irq_rcu_node(p)					\
66d6331980SPaul E. McKenney do {									\
67d6331980SPaul E. McKenney 	spin_lock_irq(&ACCESS_PRIVATE(p, lock));			\
68d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
69d6331980SPaul E. McKenney } while (0)
70d6331980SPaul E. McKenney 
71d6331980SPaul E. McKenney #define spin_unlock_irq_rcu_node(p)					\
72d6331980SPaul E. McKenney 	spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
73d6331980SPaul E. McKenney 
74d6331980SPaul E. McKenney #define spin_lock_irqsave_rcu_node(p, flags)			\
75d6331980SPaul E. McKenney do {									\
76d6331980SPaul E. McKenney 	spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags);	\
77d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
78d6331980SPaul E. McKenney } while (0)
79d6331980SPaul E. McKenney 
80d6331980SPaul E. McKenney #define spin_unlock_irqrestore_rcu_node(p, flags)			\
81d6331980SPaul E. McKenney 	spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags)	\
82d6331980SPaul E. McKenney 
83da915ad5SPaul E. McKenney /*
84da915ad5SPaul E. McKenney  * Initialize SRCU combining tree.  Note that statically allocated
85da915ad5SPaul E. McKenney  * srcu_struct structures might already have srcu_read_lock() and
86da915ad5SPaul E. McKenney  * srcu_read_unlock() running against them.  So if the is_static parameter
87da915ad5SPaul E. McKenney  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
88da915ad5SPaul E. McKenney  */
89da915ad5SPaul E. McKenney static void init_srcu_struct_nodes(struct srcu_struct *sp, bool is_static)
90dad81a20SPaul E. McKenney {
91da915ad5SPaul E. McKenney 	int cpu;
92da915ad5SPaul E. McKenney 	int i;
93da915ad5SPaul E. McKenney 	int level = 0;
94da915ad5SPaul E. McKenney 	int levelspread[RCU_NUM_LVLS];
95da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
96da915ad5SPaul E. McKenney 	struct srcu_node *snp;
97da915ad5SPaul E. McKenney 	struct srcu_node *snp_first;
98da915ad5SPaul E. McKenney 
99da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
100da915ad5SPaul E. McKenney 	sp->level[0] = &sp->node[0];
101da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
102da915ad5SPaul E. McKenney 		sp->level[i] = sp->level[i - 1] + num_rcu_lvl[i - 1];
103da915ad5SPaul E. McKenney 	rcu_init_levelspread(levelspread, num_rcu_lvl);
104da915ad5SPaul E. McKenney 
105da915ad5SPaul E. McKenney 	/* Each pass through this loop initializes one srcu_node structure. */
106da915ad5SPaul E. McKenney 	rcu_for_each_node_breadth_first(sp, snp) {
107d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(snp, lock));
108c7e88067SPaul E. McKenney 		WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
109c7e88067SPaul E. McKenney 			     ARRAY_SIZE(snp->srcu_data_have_cbs));
110c7e88067SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
111da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[i] = 0;
112c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[i] = 0;
113c7e88067SPaul E. McKenney 		}
1141e9a038bSPaul E. McKenney 		snp->srcu_gp_seq_needed_exp = 0;
115da915ad5SPaul E. McKenney 		snp->grplo = -1;
116da915ad5SPaul E. McKenney 		snp->grphi = -1;
117da915ad5SPaul E. McKenney 		if (snp == &sp->node[0]) {
118da915ad5SPaul E. McKenney 			/* Root node, special case. */
119da915ad5SPaul E. McKenney 			snp->srcu_parent = NULL;
120da915ad5SPaul E. McKenney 			continue;
121da915ad5SPaul E. McKenney 		}
122da915ad5SPaul E. McKenney 
123da915ad5SPaul E. McKenney 		/* Non-root node. */
124da915ad5SPaul E. McKenney 		if (snp == sp->level[level + 1])
125da915ad5SPaul E. McKenney 			level++;
126da915ad5SPaul E. McKenney 		snp->srcu_parent = sp->level[level - 1] +
127da915ad5SPaul E. McKenney 				   (snp - sp->level[level]) /
128da915ad5SPaul E. McKenney 				   levelspread[level - 1];
129da915ad5SPaul E. McKenney 	}
130da915ad5SPaul E. McKenney 
131da915ad5SPaul E. McKenney 	/*
132da915ad5SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
133da915ad5SPaul E. McKenney 	 * leaves of the srcu_node tree.
134da915ad5SPaul E. McKenney 	 */
135da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
136da915ad5SPaul E. McKenney 		     ARRAY_SIZE(sdp->srcu_unlock_count));
137da915ad5SPaul E. McKenney 	level = rcu_num_lvls - 1;
138da915ad5SPaul E. McKenney 	snp_first = sp->level[level];
139da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
140da915ad5SPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
141d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
142da915ad5SPaul E. McKenney 		rcu_segcblist_init(&sdp->srcu_cblist);
143da915ad5SPaul E. McKenney 		sdp->srcu_cblist_invoking = false;
144da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = sp->srcu_gp_seq;
1451e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = sp->srcu_gp_seq;
146da915ad5SPaul E. McKenney 		sdp->mynode = &snp_first[cpu / levelspread[level]];
147da915ad5SPaul E. McKenney 		for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
148da915ad5SPaul E. McKenney 			if (snp->grplo < 0)
149da915ad5SPaul E. McKenney 				snp->grplo = cpu;
150da915ad5SPaul E. McKenney 			snp->grphi = cpu;
151da915ad5SPaul E. McKenney 		}
152da915ad5SPaul E. McKenney 		sdp->cpu = cpu;
153da915ad5SPaul E. McKenney 		INIT_DELAYED_WORK(&sdp->work, srcu_invoke_callbacks);
154da915ad5SPaul E. McKenney 		sdp->sp = sp;
155c7e88067SPaul E. McKenney 		sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
156da915ad5SPaul E. McKenney 		if (is_static)
157da915ad5SPaul E. McKenney 			continue;
158da915ad5SPaul E. McKenney 
159da915ad5SPaul E. McKenney 		/* Dynamically allocated, better be no srcu_read_locks()! */
160da915ad5SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) {
161da915ad5SPaul E. McKenney 			sdp->srcu_lock_count[i] = 0;
162da915ad5SPaul E. McKenney 			sdp->srcu_unlock_count[i] = 0;
163da915ad5SPaul E. McKenney 		}
164da915ad5SPaul E. McKenney 	}
165da915ad5SPaul E. McKenney }
166da915ad5SPaul E. McKenney 
167da915ad5SPaul E. McKenney /*
168da915ad5SPaul E. McKenney  * Initialize non-compile-time initialized fields, including the
169da915ad5SPaul E. McKenney  * associated srcu_node and srcu_data structures.  The is_static
170da915ad5SPaul E. McKenney  * parameter is passed through to init_srcu_struct_nodes(), and
171da915ad5SPaul E. McKenney  * also tells us that ->sda has already been wired up to srcu_data.
172da915ad5SPaul E. McKenney  */
173da915ad5SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *sp, bool is_static)
174da915ad5SPaul E. McKenney {
175da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_cb_mutex);
176da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_gp_mutex);
177da915ad5SPaul E. McKenney 	sp->srcu_idx = 0;
178dad81a20SPaul E. McKenney 	sp->srcu_gp_seq = 0;
179da915ad5SPaul E. McKenney 	sp->srcu_barrier_seq = 0;
180da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_barrier_mutex);
181da915ad5SPaul E. McKenney 	atomic_set(&sp->srcu_barrier_cpu_cnt, 0);
182dad81a20SPaul E. McKenney 	INIT_DELAYED_WORK(&sp->work, process_srcu);
183da915ad5SPaul E. McKenney 	if (!is_static)
184da915ad5SPaul E. McKenney 		sp->sda = alloc_percpu(struct srcu_data);
185da915ad5SPaul E. McKenney 	init_srcu_struct_nodes(sp, is_static);
1861e9a038bSPaul E. McKenney 	sp->srcu_gp_seq_needed_exp = 0;
18722607d66SPaul E. McKenney 	sp->srcu_last_gp_end = ktime_get_mono_fast_ns();
188da915ad5SPaul E. McKenney 	smp_store_release(&sp->srcu_gp_seq_needed, 0); /* Init done. */
189da915ad5SPaul E. McKenney 	return sp->sda ? 0 : -ENOMEM;
190dad81a20SPaul E. McKenney }
191dad81a20SPaul E. McKenney 
192dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
193dad81a20SPaul E. McKenney 
194dad81a20SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *sp, const char *name,
195dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
196dad81a20SPaul E. McKenney {
197dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
198dad81a20SPaul E. McKenney 	debug_check_no_locks_freed((void *)sp, sizeof(*sp));
199dad81a20SPaul E. McKenney 	lockdep_init_map(&sp->dep_map, name, key, 0);
200d6331980SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(sp, lock));
201da915ad5SPaul E. McKenney 	return init_srcu_struct_fields(sp, false);
202dad81a20SPaul E. McKenney }
203dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
204dad81a20SPaul E. McKenney 
205dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
206dad81a20SPaul E. McKenney 
207dad81a20SPaul E. McKenney /**
208dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
209dad81a20SPaul E. McKenney  * @sp: structure to initialize.
210dad81a20SPaul E. McKenney  *
211dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
212dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
213dad81a20SPaul E. McKenney  * of SRCU protection.
214dad81a20SPaul E. McKenney  */
215dad81a20SPaul E. McKenney int init_srcu_struct(struct srcu_struct *sp)
216dad81a20SPaul E. McKenney {
217d6331980SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(sp, lock));
218da915ad5SPaul E. McKenney 	return init_srcu_struct_fields(sp, false);
219dad81a20SPaul E. McKenney }
220dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
221dad81a20SPaul E. McKenney 
222dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
223dad81a20SPaul E. McKenney 
224dad81a20SPaul E. McKenney /*
225da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
226da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
227da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
228a3883df3SPaul E. McKenney  * to each update-side SRCU primitive.  Use sp->lock, which -is-
229da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
230da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
231da915ad5SPaul E. McKenney  */
232da915ad5SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *sp)
233da915ad5SPaul E. McKenney {
234da915ad5SPaul E. McKenney 	unsigned long flags;
235da915ad5SPaul E. McKenney 
236da915ad5SPaul E. McKenney 	WARN_ON_ONCE(rcu_scheduler_active == RCU_SCHEDULER_INIT);
237da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
238da915ad5SPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq_needed))) /*^^^*/
239da915ad5SPaul E. McKenney 		return; /* Already initialized. */
240d6331980SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sp, flags);
241da915ad5SPaul E. McKenney 	if (!rcu_seq_state(sp->srcu_gp_seq_needed)) {
242d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(sp, flags);
243da915ad5SPaul E. McKenney 		return;
244da915ad5SPaul E. McKenney 	}
245da915ad5SPaul E. McKenney 	init_srcu_struct_fields(sp, true);
246d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sp, flags);
247da915ad5SPaul E. McKenney }
248da915ad5SPaul E. McKenney 
249da915ad5SPaul E. McKenney /*
250da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
251da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
252dad81a20SPaul E. McKenney  */
253dad81a20SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *sp, int idx)
254dad81a20SPaul E. McKenney {
255dad81a20SPaul E. McKenney 	int cpu;
256dad81a20SPaul E. McKenney 	unsigned long sum = 0;
257dad81a20SPaul E. McKenney 
258dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
259da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
260dad81a20SPaul E. McKenney 
261da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[idx]);
262dad81a20SPaul E. McKenney 	}
263dad81a20SPaul E. McKenney 	return sum;
264dad81a20SPaul E. McKenney }
265dad81a20SPaul E. McKenney 
266dad81a20SPaul E. McKenney /*
267da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
268da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
269dad81a20SPaul E. McKenney  */
270dad81a20SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *sp, int idx)
271dad81a20SPaul E. McKenney {
272dad81a20SPaul E. McKenney 	int cpu;
273dad81a20SPaul E. McKenney 	unsigned long sum = 0;
274dad81a20SPaul E. McKenney 
275dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
276da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
277dad81a20SPaul E. McKenney 
278da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_unlock_count[idx]);
279dad81a20SPaul E. McKenney 	}
280dad81a20SPaul E. McKenney 	return sum;
281dad81a20SPaul E. McKenney }
282dad81a20SPaul E. McKenney 
283dad81a20SPaul E. McKenney /*
284dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
285dad81a20SPaul E. McKenney  * be zero.
286dad81a20SPaul E. McKenney  */
287dad81a20SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *sp, int idx)
288dad81a20SPaul E. McKenney {
289dad81a20SPaul E. McKenney 	unsigned long unlocks;
290dad81a20SPaul E. McKenney 
291dad81a20SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(sp, idx);
292dad81a20SPaul E. McKenney 
293dad81a20SPaul E. McKenney 	/*
294dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
295dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
296dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
297dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
298dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
299dad81a20SPaul E. McKenney 	 *
300dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
301dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
302dad81a20SPaul E. McKenney 	 * grace period ends.
303dad81a20SPaul E. McKenney 	 */
304dad81a20SPaul E. McKenney 	smp_mb(); /* A */
305dad81a20SPaul E. McKenney 
306dad81a20SPaul E. McKenney 	/*
307dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
308dad81a20SPaul E. McKenney 	 * been no readers on this index at some time in between. This does
309dad81a20SPaul E. McKenney 	 * not mean that there are no more readers, as one could have read
310dad81a20SPaul E. McKenney 	 * the current index but not have incremented the lock counter yet.
311dad81a20SPaul E. McKenney 	 *
312881ec9d2SPaul E. McKenney 	 * So suppose that the updater is preempted here for so long
313881ec9d2SPaul E. McKenney 	 * that more than ULONG_MAX non-nested readers come and go in
314881ec9d2SPaul E. McKenney 	 * the meantime.  It turns out that this cannot result in overflow
315881ec9d2SPaul E. McKenney 	 * because if a reader modifies its unlock count after we read it
316881ec9d2SPaul E. McKenney 	 * above, then that reader's next load of ->srcu_idx is guaranteed
317881ec9d2SPaul E. McKenney 	 * to get the new value, which will cause it to operate on the
318881ec9d2SPaul E. McKenney 	 * other bank of counters, where it cannot contribute to the
319881ec9d2SPaul E. McKenney 	 * overflow of these counters.  This means that there is a maximum
320881ec9d2SPaul E. McKenney 	 * of 2*NR_CPUS increments, which cannot overflow given current
321881ec9d2SPaul E. McKenney 	 * systems, especially not on 64-bit systems.
322881ec9d2SPaul E. McKenney 	 *
323881ec9d2SPaul E. McKenney 	 * OK, how about nesting?  This does impose a limit on nesting
324881ec9d2SPaul E. McKenney 	 * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
325881ec9d2SPaul E. McKenney 	 * especially on 64-bit systems.
326dad81a20SPaul E. McKenney 	 */
327dad81a20SPaul E. McKenney 	return srcu_readers_lock_idx(sp, idx) == unlocks;
328dad81a20SPaul E. McKenney }
329dad81a20SPaul E. McKenney 
330dad81a20SPaul E. McKenney /**
331dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
332dad81a20SPaul E. McKenney  *                       otherwise
333dad81a20SPaul E. McKenney  * @sp: which srcu_struct to count active readers (holding srcu_read_lock).
334dad81a20SPaul E. McKenney  *
335dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
336dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
337dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
338dad81a20SPaul E. McKenney  */
339dad81a20SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *sp)
340dad81a20SPaul E. McKenney {
341dad81a20SPaul E. McKenney 	int cpu;
342dad81a20SPaul E. McKenney 	unsigned long sum = 0;
343dad81a20SPaul E. McKenney 
344dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
345da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
346dad81a20SPaul E. McKenney 
347da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[0]);
348da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[1]);
349da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[0]);
350da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[1]);
351dad81a20SPaul E. McKenney 	}
352dad81a20SPaul E. McKenney 	return sum;
353dad81a20SPaul E. McKenney }
354dad81a20SPaul E. McKenney 
355dad81a20SPaul E. McKenney #define SRCU_INTERVAL		1
356dad81a20SPaul E. McKenney 
3571e9a038bSPaul E. McKenney /*
3581e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
3591e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
3601e9a038bSPaul E. McKenney  */
3611e9a038bSPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *sp)
3621e9a038bSPaul E. McKenney {
3631e9a038bSPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(sp->srcu_gp_seq),
3641e9a038bSPaul E. McKenney 			 READ_ONCE(sp->srcu_gp_seq_needed_exp)))
3651e9a038bSPaul E. McKenney 		return 0;
3661e9a038bSPaul E. McKenney 	return SRCU_INTERVAL;
3671e9a038bSPaul E. McKenney }
3681e9a038bSPaul E. McKenney 
369dad81a20SPaul E. McKenney /**
370dad81a20SPaul E. McKenney  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
371dad81a20SPaul E. McKenney  * @sp: structure to clean up.
372dad81a20SPaul E. McKenney  *
373dad81a20SPaul E. McKenney  * Must invoke this after you are finished using a given srcu_struct that
374dad81a20SPaul E. McKenney  * was initialized via init_srcu_struct(), else you leak memory.
375dad81a20SPaul E. McKenney  */
376dad81a20SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *sp)
377dad81a20SPaul E. McKenney {
378da915ad5SPaul E. McKenney 	int cpu;
379da915ad5SPaul E. McKenney 
3801e9a038bSPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(sp)))
3811e9a038bSPaul E. McKenney 		return; /* Leakage unless caller handles error. */
382dad81a20SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(sp)))
383dad81a20SPaul E. McKenney 		return; /* Leakage unless caller handles error. */
384dad81a20SPaul E. McKenney 	flush_delayed_work(&sp->work);
385da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu)
386da915ad5SPaul E. McKenney 		flush_delayed_work(&per_cpu_ptr(sp->sda, cpu)->work);
387da915ad5SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
388da915ad5SPaul E. McKenney 	    WARN_ON(srcu_readers_active(sp))) {
389da915ad5SPaul E. McKenney 		pr_info("cleanup_srcu_struct: Active srcu_struct %p state: %d\n", sp, rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)));
390dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
391dad81a20SPaul E. McKenney 	}
392da915ad5SPaul E. McKenney 	free_percpu(sp->sda);
393da915ad5SPaul E. McKenney 	sp->sda = NULL;
394dad81a20SPaul E. McKenney }
395dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
396dad81a20SPaul E. McKenney 
397dad81a20SPaul E. McKenney /*
398dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
399cdf7abc4SPaolo Bonzini  * srcu_struct.
400dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
401dad81a20SPaul E. McKenney  */
402dad81a20SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *sp)
403dad81a20SPaul E. McKenney {
404dad81a20SPaul E. McKenney 	int idx;
405dad81a20SPaul E. McKenney 
406da915ad5SPaul E. McKenney 	idx = READ_ONCE(sp->srcu_idx) & 0x1;
407cdf7abc4SPaolo Bonzini 	this_cpu_inc(sp->sda->srcu_lock_count[idx]);
408dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
409dad81a20SPaul E. McKenney 	return idx;
410dad81a20SPaul E. McKenney }
411dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
412dad81a20SPaul E. McKenney 
413dad81a20SPaul E. McKenney /*
414dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
415dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
416dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
417dad81a20SPaul E. McKenney  */
418dad81a20SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *sp, int idx)
419dad81a20SPaul E. McKenney {
420dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
421da915ad5SPaul E. McKenney 	this_cpu_inc(sp->sda->srcu_unlock_count[idx]);
422dad81a20SPaul E. McKenney }
423dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
424dad81a20SPaul E. McKenney 
425dad81a20SPaul E. McKenney /*
426dad81a20SPaul E. McKenney  * We use an adaptive strategy for synchronize_srcu() and especially for
427dad81a20SPaul E. McKenney  * synchronize_srcu_expedited().  We spin for a fixed time period
428dad81a20SPaul E. McKenney  * (defined below) to allow SRCU readers to exit their read-side critical
429dad81a20SPaul E. McKenney  * sections.  If there are still some readers after a few microseconds,
430dad81a20SPaul E. McKenney  * we repeatedly block for 1-millisecond time periods.
431dad81a20SPaul E. McKenney  */
432dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY		5
433dad81a20SPaul E. McKenney 
434dad81a20SPaul E. McKenney /*
435dad81a20SPaul E. McKenney  * Start an SRCU grace period.
436dad81a20SPaul E. McKenney  */
437dad81a20SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *sp)
438dad81a20SPaul E. McKenney {
439da915ad5SPaul E. McKenney 	struct srcu_data *sdp = this_cpu_ptr(sp->sda);
440dad81a20SPaul E. McKenney 	int state;
441dad81a20SPaul E. McKenney 
442*a32e01eeSMatthew Wilcox 	lockdep_assert_held(&ACCESS_PRIVATE(sp, lock));
443da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed));
444da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
445da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
446da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
447dad81a20SPaul E. McKenney 				       rcu_seq_snap(&sp->srcu_gp_seq));
4482da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
449dad81a20SPaul E. McKenney 	rcu_seq_start(&sp->srcu_gp_seq);
450dad81a20SPaul E. McKenney 	state = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq));
451dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
452dad81a20SPaul E. McKenney }
453dad81a20SPaul E. McKenney 
454dad81a20SPaul E. McKenney /*
455da915ad5SPaul E. McKenney  * Track online CPUs to guide callback workqueue placement.
456da915ad5SPaul E. McKenney  */
457da915ad5SPaul E. McKenney DEFINE_PER_CPU(bool, srcu_online);
458da915ad5SPaul E. McKenney 
459da915ad5SPaul E. McKenney void srcu_online_cpu(unsigned int cpu)
460da915ad5SPaul E. McKenney {
461da915ad5SPaul E. McKenney 	WRITE_ONCE(per_cpu(srcu_online, cpu), true);
462da915ad5SPaul E. McKenney }
463da915ad5SPaul E. McKenney 
464da915ad5SPaul E. McKenney void srcu_offline_cpu(unsigned int cpu)
465da915ad5SPaul E. McKenney {
466da915ad5SPaul E. McKenney 	WRITE_ONCE(per_cpu(srcu_online, cpu), false);
467da915ad5SPaul E. McKenney }
468da915ad5SPaul E. McKenney 
469da915ad5SPaul E. McKenney /*
470da915ad5SPaul E. McKenney  * Place the workqueue handler on the specified CPU if online, otherwise
471da915ad5SPaul E. McKenney  * just run it whereever.  This is useful for placing workqueue handlers
472da915ad5SPaul E. McKenney  * that are to invoke the specified CPU's callbacks.
473da915ad5SPaul E. McKenney  */
474da915ad5SPaul E. McKenney static bool srcu_queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
475da915ad5SPaul E. McKenney 				       struct delayed_work *dwork,
476da915ad5SPaul E. McKenney 				       unsigned long delay)
477da915ad5SPaul E. McKenney {
478da915ad5SPaul E. McKenney 	bool ret;
479da915ad5SPaul E. McKenney 
480da915ad5SPaul E. McKenney 	preempt_disable();
481da915ad5SPaul E. McKenney 	if (READ_ONCE(per_cpu(srcu_online, cpu)))
482da915ad5SPaul E. McKenney 		ret = queue_delayed_work_on(cpu, wq, dwork, delay);
483da915ad5SPaul E. McKenney 	else
484da915ad5SPaul E. McKenney 		ret = queue_delayed_work(wq, dwork, delay);
485da915ad5SPaul E. McKenney 	preempt_enable();
486da915ad5SPaul E. McKenney 	return ret;
487da915ad5SPaul E. McKenney }
488da915ad5SPaul E. McKenney 
489da915ad5SPaul E. McKenney /*
490da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
491da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
492da915ad5SPaul E. McKenney  */
493da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
494da915ad5SPaul E. McKenney {
495da915ad5SPaul E. McKenney 	srcu_queue_delayed_work_on(sdp->cpu, system_power_efficient_wq,
496da915ad5SPaul E. McKenney 				   &sdp->work, delay);
497da915ad5SPaul E. McKenney }
498da915ad5SPaul E. McKenney 
499da915ad5SPaul E. McKenney /*
500da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
501c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
502c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
503c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
504da915ad5SPaul E. McKenney  */
505c7e88067SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *sp, struct srcu_node *snp,
5061e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
507da915ad5SPaul E. McKenney {
508da915ad5SPaul E. McKenney 	int cpu;
509da915ad5SPaul E. McKenney 
510c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
511c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
512c7e88067SPaul E. McKenney 			continue;
5131e9a038bSPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(sp->sda, cpu), delay);
514da915ad5SPaul E. McKenney 	}
515c7e88067SPaul E. McKenney }
516da915ad5SPaul E. McKenney 
517da915ad5SPaul E. McKenney /*
518da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
519da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
520da915ad5SPaul E. McKenney  *
521da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
522da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
523da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
524da915ad5SPaul E. McKenney  * array to have a finite number of elements.
525da915ad5SPaul E. McKenney  */
526da915ad5SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *sp)
527da915ad5SPaul E. McKenney {
5281e9a038bSPaul E. McKenney 	unsigned long cbdelay;
529da915ad5SPaul E. McKenney 	bool cbs;
530c350c008SPaul E. McKenney 	int cpu;
531c350c008SPaul E. McKenney 	unsigned long flags;
532da915ad5SPaul E. McKenney 	unsigned long gpseq;
533da915ad5SPaul E. McKenney 	int idx;
534da915ad5SPaul E. McKenney 	int idxnext;
535c7e88067SPaul E. McKenney 	unsigned long mask;
536c350c008SPaul E. McKenney 	struct srcu_data *sdp;
537da915ad5SPaul E. McKenney 	struct srcu_node *snp;
538da915ad5SPaul E. McKenney 
539da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
540da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_cb_mutex);
541da915ad5SPaul E. McKenney 
542da915ad5SPaul E. McKenney 	/* End the current grace period. */
543d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sp);
544da915ad5SPaul E. McKenney 	idx = rcu_seq_state(sp->srcu_gp_seq);
545da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
5461e9a038bSPaul E. McKenney 	cbdelay = srcu_get_delay(sp);
54722607d66SPaul E. McKenney 	sp->srcu_last_gp_end = ktime_get_mono_fast_ns();
548da915ad5SPaul E. McKenney 	rcu_seq_end(&sp->srcu_gp_seq);
549da915ad5SPaul E. McKenney 	gpseq = rcu_seq_current(&sp->srcu_gp_seq);
5501e9a038bSPaul E. McKenney 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, gpseq))
5511e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = gpseq;
552d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sp);
553da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_gp_mutex);
554da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
555da915ad5SPaul E. McKenney 
556da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
557da915ad5SPaul E. McKenney 	idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
558da915ad5SPaul E. McKenney 	idxnext = (idx + 1) % ARRAY_SIZE(snp->srcu_have_cbs);
559da915ad5SPaul E. McKenney 	rcu_for_each_node_breadth_first(sp, snp) {
560d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(snp);
561da915ad5SPaul E. McKenney 		cbs = false;
562da915ad5SPaul E. McKenney 		if (snp >= sp->level[rcu_num_lvls - 1])
563da915ad5SPaul E. McKenney 			cbs = snp->srcu_have_cbs[idx] == gpseq;
564da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = gpseq;
565da915ad5SPaul E. McKenney 		rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
5661e9a038bSPaul E. McKenney 		if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
5671e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = gpseq;
568c7e88067SPaul E. McKenney 		mask = snp->srcu_data_have_cbs[idx];
569c7e88067SPaul E. McKenney 		snp->srcu_data_have_cbs[idx] = 0;
570d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(snp);
571a3883df3SPaul E. McKenney 		if (cbs)
5721e9a038bSPaul E. McKenney 			srcu_schedule_cbs_snp(sp, snp, mask, cbdelay);
573c350c008SPaul E. McKenney 
574c350c008SPaul E. McKenney 		/* Occasionally prevent srcu_data counter wrap. */
575c350c008SPaul E. McKenney 		if (!(gpseq & counter_wrap_check))
576c350c008SPaul E. McKenney 			for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
577c350c008SPaul E. McKenney 				sdp = per_cpu_ptr(sp->sda, cpu);
578d6331980SPaul E. McKenney 				spin_lock_irqsave_rcu_node(sdp, flags);
579c350c008SPaul E. McKenney 				if (ULONG_CMP_GE(gpseq,
580c350c008SPaul E. McKenney 						 sdp->srcu_gp_seq_needed + 100))
581c350c008SPaul E. McKenney 					sdp->srcu_gp_seq_needed = gpseq;
582d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(sdp, flags);
583c350c008SPaul E. McKenney 			}
584da915ad5SPaul E. McKenney 	}
585da915ad5SPaul E. McKenney 
586da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
587da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_cb_mutex);
588da915ad5SPaul E. McKenney 
589da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
590d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sp);
591da915ad5SPaul E. McKenney 	gpseq = rcu_seq_current(&sp->srcu_gp_seq);
592da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
593da915ad5SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, sp->srcu_gp_seq_needed)) {
594da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
595d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sp);
596da915ad5SPaul E. McKenney 		/* Throttle expedited grace periods: Should be rare! */
5971e9a038bSPaul E. McKenney 		srcu_reschedule(sp, rcu_seq_ctr(gpseq) & 0x3ff
5981e9a038bSPaul E. McKenney 				    ? 0 : SRCU_INTERVAL);
599da915ad5SPaul E. McKenney 	} else {
600d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sp);
601da915ad5SPaul E. McKenney 	}
602da915ad5SPaul E. McKenney }
603da915ad5SPaul E. McKenney 
604da915ad5SPaul E. McKenney /*
6051e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
6061e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
6071e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
6081e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
6091e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
6101e9a038bSPaul E. McKenney  */
6111e9a038bSPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *sp, struct srcu_node *snp,
6121e9a038bSPaul E. McKenney 				  unsigned long s)
6131e9a038bSPaul E. McKenney {
6141e9a038bSPaul E. McKenney 	unsigned long flags;
6151e9a038bSPaul E. McKenney 
6161e9a038bSPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
6171e9a038bSPaul E. McKenney 		if (rcu_seq_done(&sp->srcu_gp_seq, s) ||
6181e9a038bSPaul E. McKenney 		    ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
6191e9a038bSPaul E. McKenney 			return;
620d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
6211e9a038bSPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
622d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
6231e9a038bSPaul E. McKenney 			return;
6241e9a038bSPaul E. McKenney 		}
6251e9a038bSPaul E. McKenney 		WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
626d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
6271e9a038bSPaul E. McKenney 	}
628d6331980SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sp, flags);
6291e9a038bSPaul E. McKenney 	if (!ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s))
6301e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = s;
631d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sp, flags);
6321e9a038bSPaul E. McKenney }
6331e9a038bSPaul E. McKenney 
6341e9a038bSPaul E. McKenney /*
635da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
636da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
637da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
638da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
639da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
640da915ad5SPaul E. McKenney  */
6411e9a038bSPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *sp, struct srcu_data *sdp,
6421e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
643da915ad5SPaul E. McKenney {
644da915ad5SPaul E. McKenney 	unsigned long flags;
645da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
646da915ad5SPaul E. McKenney 	struct srcu_node *snp = sdp->mynode;
647da915ad5SPaul E. McKenney 	unsigned long snp_seq;
648da915ad5SPaul E. McKenney 
649da915ad5SPaul E. McKenney 	/* Each pass through the loop does one level of the srcu_node tree. */
650da915ad5SPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
651da915ad5SPaul E. McKenney 		if (rcu_seq_done(&sp->srcu_gp_seq, s) && snp != sdp->mynode)
652da915ad5SPaul E. McKenney 			return; /* GP already done and CBs recorded. */
653d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
654da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
655da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
656c7e88067SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq == s)
657c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
658d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
659da915ad5SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq != s) {
6601e9a038bSPaul E. McKenney 				srcu_schedule_cbs_sdp(sdp, do_norm
6611e9a038bSPaul E. McKenney 							   ? SRCU_INTERVAL
6621e9a038bSPaul E. McKenney 							   : 0);
6631e9a038bSPaul E. McKenney 				return;
664da915ad5SPaul E. McKenney 			}
6651e9a038bSPaul E. McKenney 			if (!do_norm)
6661e9a038bSPaul E. McKenney 				srcu_funnel_exp_start(sp, snp, s);
667da915ad5SPaul E. McKenney 			return;
668da915ad5SPaul E. McKenney 		}
669da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = s;
670c7e88067SPaul E. McKenney 		if (snp == sdp->mynode)
671c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
6721e9a038bSPaul E. McKenney 		if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
6731e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = s;
674d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
675da915ad5SPaul E. McKenney 	}
676da915ad5SPaul E. McKenney 
677da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
678d6331980SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sp, flags);
679da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed, s)) {
680da915ad5SPaul E. McKenney 		/*
681da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
682da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
683da915ad5SPaul E. McKenney 		 */
684da915ad5SPaul E. McKenney 		smp_store_release(&sp->srcu_gp_seq_needed, s); /*^^^*/
685da915ad5SPaul E. McKenney 	}
6861e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s))
6871e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = s;
688da915ad5SPaul E. McKenney 
689da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
690da915ad5SPaul E. McKenney 	if (!rcu_seq_done(&sp->srcu_gp_seq, s) &&
691da915ad5SPaul E. McKenney 	    rcu_seq_state(sp->srcu_gp_seq) == SRCU_STATE_IDLE) {
692da915ad5SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed));
693da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
694da915ad5SPaul E. McKenney 		queue_delayed_work(system_power_efficient_wq, &sp->work,
6951e9a038bSPaul E. McKenney 				   srcu_get_delay(sp));
696da915ad5SPaul E. McKenney 	}
697d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sp, flags);
698da915ad5SPaul E. McKenney }
699da915ad5SPaul E. McKenney 
700da915ad5SPaul E. McKenney /*
701dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
702dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
703da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
704dad81a20SPaul E. McKenney  */
705dad81a20SPaul E. McKenney static bool try_check_zero(struct srcu_struct *sp, int idx, int trycount)
706dad81a20SPaul E. McKenney {
707dad81a20SPaul E. McKenney 	for (;;) {
708dad81a20SPaul E. McKenney 		if (srcu_readers_active_idx_check(sp, idx))
709dad81a20SPaul E. McKenney 			return true;
7101e9a038bSPaul E. McKenney 		if (--trycount + !srcu_get_delay(sp) <= 0)
711dad81a20SPaul E. McKenney 			return false;
712dad81a20SPaul E. McKenney 		udelay(SRCU_RETRY_CHECK_DELAY);
713dad81a20SPaul E. McKenney 	}
714dad81a20SPaul E. McKenney }
715dad81a20SPaul E. McKenney 
716dad81a20SPaul E. McKenney /*
717da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
718da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
719dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
720dad81a20SPaul E. McKenney  */
721dad81a20SPaul E. McKenney static void srcu_flip(struct srcu_struct *sp)
722dad81a20SPaul E. McKenney {
723881ec9d2SPaul E. McKenney 	/*
724881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
725881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
726881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
727881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
728881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
729881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
730881ec9d2SPaul E. McKenney 	 */
731881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
732881ec9d2SPaul E. McKenney 
733da915ad5SPaul E. McKenney 	WRITE_ONCE(sp->srcu_idx, sp->srcu_idx + 1);
734dad81a20SPaul E. McKenney 
735dad81a20SPaul E. McKenney 	/*
736dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
737dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
738dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
739dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
740dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
741dad81a20SPaul E. McKenney 	 */
742dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
743dad81a20SPaul E. McKenney }
744dad81a20SPaul E. McKenney 
745dad81a20SPaul E. McKenney /*
7462da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
7472da4b2a7SPaul E. McKenney  *
7482da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
7492da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
7502da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
7512da4b2a7SPaul E. McKenney  *
7522da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
7532da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
7542da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
7552da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
7562da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
7572da4b2a7SPaul E. McKenney  * but to accept this type of error.
7582da4b2a7SPaul E. McKenney  *
7592da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
7602da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
7612da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
7622da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
7632da4b2a7SPaul E. McKenney  * negligible when amoritized over that time period, and the extra latency
7642da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
7652da4b2a7SPaul E. McKenney  */
7662da4b2a7SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *sp)
7672da4b2a7SPaul E. McKenney {
76822607d66SPaul E. McKenney 	unsigned long curseq;
7692da4b2a7SPaul E. McKenney 	unsigned long flags;
7702da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
77122607d66SPaul E. McKenney 	unsigned long t;
7722da4b2a7SPaul E. McKenney 
7732da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
7742da4b2a7SPaul E. McKenney 	local_irq_save(flags);
7752da4b2a7SPaul E. McKenney 	sdp = this_cpu_ptr(sp->sda);
7762da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
7772da4b2a7SPaul E. McKenney 		local_irq_restore(flags);
7782da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
7792da4b2a7SPaul E. McKenney 	}
7802da4b2a7SPaul E. McKenney 	local_irq_restore(flags);
7812da4b2a7SPaul E. McKenney 
7822da4b2a7SPaul E. McKenney 	/*
7832da4b2a7SPaul E. McKenney 	 * No local callbacks, so probabalistically probe global state.
7842da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
7852da4b2a7SPaul E. McKenney 	 * kill scalability, hence the probabalistic nature of the probe.
7862da4b2a7SPaul E. McKenney 	 */
78722607d66SPaul E. McKenney 
78822607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
78922607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
79022607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
79122607d66SPaul E. McKenney 	    time_in_range_open(t, sp->srcu_last_gp_end,
79222607d66SPaul E. McKenney 			       sp->srcu_last_gp_end + exp_holdoff))
79322607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
79422607d66SPaul E. McKenney 
79522607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
7962da4b2a7SPaul E. McKenney 	curseq = rcu_seq_current(&sp->srcu_gp_seq);
7972da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
7982da4b2a7SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(sp->srcu_gp_seq_needed)))
7992da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
8002da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
8012da4b2a7SPaul E. McKenney 	if (curseq != rcu_seq_current(&sp->srcu_gp_seq))
8022da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
8032da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
8042da4b2a7SPaul E. McKenney }
8052da4b2a7SPaul E. McKenney 
8062da4b2a7SPaul E. McKenney /*
807a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
808a602538eSPaul E. McKenney  */
809a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
810a602538eSPaul E. McKenney {
811a602538eSPaul E. McKenney }
812a602538eSPaul E. McKenney 
813a602538eSPaul E. McKenney /*
814da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
815da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
816da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
817dad81a20SPaul E. McKenney  *
818dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
819dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
820dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
821dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
822dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
823dad81a20SPaul E. McKenney  * preceded the call to call_rcu().  It also means that each CPU executing
824dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
825dad81a20SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_rcu()
826dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
827dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
828dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
829dad81a20SPaul E. McKenney  *
830dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked call_rcu() and CPU B invoked the
831dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
832dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
833dad81a20SPaul E. McKenney  * interval between the call to call_rcu() and the invocation of "func()".
834dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
835dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
836dad81a20SPaul E. McKenney  *
837dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
838dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
839dad81a20SPaul E. McKenney  * srcu_struct structure.
840dad81a20SPaul E. McKenney  */
8411e9a038bSPaul E. McKenney void __call_srcu(struct srcu_struct *sp, struct rcu_head *rhp,
8421e9a038bSPaul E. McKenney 		 rcu_callback_t func, bool do_norm)
843dad81a20SPaul E. McKenney {
844dad81a20SPaul E. McKenney 	unsigned long flags;
8451e9a038bSPaul E. McKenney 	bool needexp = false;
846da915ad5SPaul E. McKenney 	bool needgp = false;
847da915ad5SPaul E. McKenney 	unsigned long s;
848da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
849dad81a20SPaul E. McKenney 
850da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
851a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
852a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
853a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
854a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
855a602538eSPaul E. McKenney 		return;
856a602538eSPaul E. McKenney 	}
857da915ad5SPaul E. McKenney 	rhp->func = func;
858da915ad5SPaul E. McKenney 	local_irq_save(flags);
859da915ad5SPaul E. McKenney 	sdp = this_cpu_ptr(sp->sda);
860d6331980SPaul E. McKenney 	spin_lock_rcu_node(sdp);
861da915ad5SPaul E. McKenney 	rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp, false);
862da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
863da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
864da915ad5SPaul E. McKenney 	s = rcu_seq_snap(&sp->srcu_gp_seq);
865da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
866da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
867da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
868da915ad5SPaul E. McKenney 		needgp = true;
869dad81a20SPaul E. McKenney 	}
8701e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
8711e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
8721e9a038bSPaul E. McKenney 		needexp = true;
8731e9a038bSPaul E. McKenney 	}
874d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
875da915ad5SPaul E. McKenney 	if (needgp)
8761e9a038bSPaul E. McKenney 		srcu_funnel_gp_start(sp, sdp, s, do_norm);
8771e9a038bSPaul E. McKenney 	else if (needexp)
8781e9a038bSPaul E. McKenney 		srcu_funnel_exp_start(sp, sdp->mynode, s);
8791e9a038bSPaul E. McKenney }
8801e9a038bSPaul E. McKenney 
8815a0465e1SPaul E. McKenney /**
8825a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
8835a0465e1SPaul E. McKenney  * @sp: srcu_struct in queue the callback
88427fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
8855a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
8865a0465e1SPaul E. McKenney  *
8875a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
8885a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
8895a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
8905a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
8915a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
8925a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
8935a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
8945a0465e1SPaul E. McKenney  *
8955a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
8965a0465e1SPaul E. McKenney  * be fast and must not block.
8975a0465e1SPaul E. McKenney  */
8981e9a038bSPaul E. McKenney void call_srcu(struct srcu_struct *sp, struct rcu_head *rhp,
8991e9a038bSPaul E. McKenney 	       rcu_callback_t func)
9001e9a038bSPaul E. McKenney {
9011e9a038bSPaul E. McKenney 	__call_srcu(sp, rhp, func, true);
902dad81a20SPaul E. McKenney }
903dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
904dad81a20SPaul E. McKenney 
905dad81a20SPaul E. McKenney /*
906dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
907dad81a20SPaul E. McKenney  */
9081e9a038bSPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *sp, bool do_norm)
909dad81a20SPaul E. McKenney {
910dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
911dad81a20SPaul E. McKenney 
912dad81a20SPaul E. McKenney 	RCU_LOCKDEP_WARN(lock_is_held(&sp->dep_map) ||
913dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
914dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
915dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
916dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
917dad81a20SPaul E. McKenney 
918dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
919dad81a20SPaul E. McKenney 		return;
920dad81a20SPaul E. McKenney 	might_sleep();
921da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
922dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
923da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
9241e9a038bSPaul E. McKenney 	__call_srcu(sp, &rcu.head, wakeme_after_rcu, do_norm);
925dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
926da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
92735732cf9SPaul E. McKenney 
92835732cf9SPaul E. McKenney 	/*
92935732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
930d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
93135732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
93235732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
93335732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
93435732cf9SPaul E. McKenney 	 */
93535732cf9SPaul E. McKenney 	smp_mb();
936dad81a20SPaul E. McKenney }
937dad81a20SPaul E. McKenney 
938dad81a20SPaul E. McKenney /**
939dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
940dad81a20SPaul E. McKenney  * @sp: srcu_struct with which to synchronize.
941dad81a20SPaul E. McKenney  *
942dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
943dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
944dad81a20SPaul E. McKenney  *
945dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
946dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
947dad81a20SPaul E. McKenney  */
948dad81a20SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *sp)
949dad81a20SPaul E. McKenney {
9501e9a038bSPaul E. McKenney 	__synchronize_srcu(sp, rcu_gp_is_normal());
951dad81a20SPaul E. McKenney }
952dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
953dad81a20SPaul E. McKenney 
954dad81a20SPaul E. McKenney /**
955dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
956dad81a20SPaul E. McKenney  * @sp: srcu_struct with which to synchronize.
957dad81a20SPaul E. McKenney  *
958dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
959dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
960da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
961da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
962dad81a20SPaul E. McKenney  *
963dad81a20SPaul E. McKenney  * Can block; must be called from process context.
964dad81a20SPaul E. McKenney  *
965dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
966dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
967dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
968dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
969dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
970dad81a20SPaul E. McKenney  *
971dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
972dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
973dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
974dad81a20SPaul E. McKenney  * the end of its last corresponding SRCU-sched read-side critical section
975dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
976dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
977dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
978dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
979dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
980dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
981dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
982dad81a20SPaul E. McKenney  *
983dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
984dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
985dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
986dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
987dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
988dad81a20SPaul E. McKenney  *
989dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
990dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
991dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
9922da4b2a7SPaul E. McKenney  *
9932da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
9942da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
9952da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
9962da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
997dad81a20SPaul E. McKenney  */
998dad81a20SPaul E. McKenney void synchronize_srcu(struct srcu_struct *sp)
999dad81a20SPaul E. McKenney {
10002da4b2a7SPaul E. McKenney 	if (srcu_might_be_idle(sp) || rcu_gp_is_expedited())
1001dad81a20SPaul E. McKenney 		synchronize_srcu_expedited(sp);
1002dad81a20SPaul E. McKenney 	else
10031e9a038bSPaul E. McKenney 		__synchronize_srcu(sp, true);
1004dad81a20SPaul E. McKenney }
1005dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1006dad81a20SPaul E. McKenney 
1007da915ad5SPaul E. McKenney /*
1008da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1009da915ad5SPaul E. McKenney  */
1010da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1011da915ad5SPaul E. McKenney {
1012da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1013da915ad5SPaul E. McKenney 	struct srcu_struct *sp;
1014da915ad5SPaul E. McKenney 
1015da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1016da915ad5SPaul E. McKenney 	sp = sdp->sp;
1017da915ad5SPaul E. McKenney 	if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt))
1018da915ad5SPaul E. McKenney 		complete(&sp->srcu_barrier_completion);
1019da915ad5SPaul E. McKenney }
1020da915ad5SPaul E. McKenney 
1021dad81a20SPaul E. McKenney /**
1022dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1023dad81a20SPaul E. McKenney  * @sp: srcu_struct on which to wait for in-flight callbacks.
1024dad81a20SPaul E. McKenney  */
1025dad81a20SPaul E. McKenney void srcu_barrier(struct srcu_struct *sp)
1026dad81a20SPaul E. McKenney {
1027da915ad5SPaul E. McKenney 	int cpu;
1028da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1029da915ad5SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&sp->srcu_barrier_seq);
1030da915ad5SPaul E. McKenney 
1031da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
1032da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_barrier_mutex);
1033da915ad5SPaul E. McKenney 	if (rcu_seq_done(&sp->srcu_barrier_seq, s)) {
1034da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1035da915ad5SPaul E. McKenney 		mutex_unlock(&sp->srcu_barrier_mutex);
1036da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1037da915ad5SPaul E. McKenney 	}
1038da915ad5SPaul E. McKenney 	rcu_seq_start(&sp->srcu_barrier_seq);
1039da915ad5SPaul E. McKenney 	init_completion(&sp->srcu_barrier_completion);
1040da915ad5SPaul E. McKenney 
1041da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1042da915ad5SPaul E. McKenney 	atomic_set(&sp->srcu_barrier_cpu_cnt, 1);
1043da915ad5SPaul E. McKenney 
1044da915ad5SPaul E. McKenney 	/*
1045da915ad5SPaul E. McKenney 	 * Each pass through this loop enqueues a callback, but only
1046da915ad5SPaul E. McKenney 	 * on CPUs already having callbacks enqueued.  Note that if
1047da915ad5SPaul E. McKenney 	 * a CPU already has callbacks enqueue, it must have already
1048da915ad5SPaul E. McKenney 	 * registered the need for a future grace period, so all we
1049da915ad5SPaul E. McKenney 	 * need do is enqueue a callback that will use the same
1050da915ad5SPaul E. McKenney 	 * grace period as the last callback already in the queue.
1051da915ad5SPaul E. McKenney 	 */
1052da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1053da915ad5SPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
1054d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sdp);
1055da915ad5SPaul E. McKenney 		atomic_inc(&sp->srcu_barrier_cpu_cnt);
1056da915ad5SPaul E. McKenney 		sdp->srcu_barrier_head.func = srcu_barrier_cb;
1057a602538eSPaul E. McKenney 		debug_rcu_head_queue(&sdp->srcu_barrier_head);
1058da915ad5SPaul E. McKenney 		if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1059a602538eSPaul E. McKenney 					   &sdp->srcu_barrier_head, 0)) {
1060a602538eSPaul E. McKenney 			debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1061da915ad5SPaul E. McKenney 			atomic_dec(&sp->srcu_barrier_cpu_cnt);
1062a602538eSPaul E. McKenney 		}
1063d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1064da915ad5SPaul E. McKenney 	}
1065da915ad5SPaul E. McKenney 
1066da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1067da915ad5SPaul E. McKenney 	if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt))
1068da915ad5SPaul E. McKenney 		complete(&sp->srcu_barrier_completion);
1069da915ad5SPaul E. McKenney 	wait_for_completion(&sp->srcu_barrier_completion);
1070da915ad5SPaul E. McKenney 
1071da915ad5SPaul E. McKenney 	rcu_seq_end(&sp->srcu_barrier_seq);
1072da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_barrier_mutex);
1073dad81a20SPaul E. McKenney }
1074dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1075dad81a20SPaul E. McKenney 
1076dad81a20SPaul E. McKenney /**
1077dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1078dad81a20SPaul E. McKenney  * @sp: srcu_struct on which to report batch completion.
1079dad81a20SPaul E. McKenney  *
1080dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1081dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1082dad81a20SPaul E. McKenney  */
1083dad81a20SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *sp)
1084dad81a20SPaul E. McKenney {
1085da915ad5SPaul E. McKenney 	return sp->srcu_idx;
1086dad81a20SPaul E. McKenney }
1087dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1088dad81a20SPaul E. McKenney 
1089dad81a20SPaul E. McKenney /*
1090da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1091da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1092da915ad5SPaul E. McKenney  * completed in that state.
1093dad81a20SPaul E. McKenney  */
1094da915ad5SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *sp)
1095dad81a20SPaul E. McKenney {
1096dad81a20SPaul E. McKenney 	int idx;
1097dad81a20SPaul E. McKenney 
1098da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_gp_mutex);
1099da915ad5SPaul E. McKenney 
1100dad81a20SPaul E. McKenney 	/*
1101dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1102da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1103dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1104dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1105dad81a20SPaul E. McKenney 	 * invoking a callback.
1106dad81a20SPaul E. McKenney 	 *
1107dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1108dad81a20SPaul E. McKenney 	 * by the prior grace period.
1109dad81a20SPaul E. McKenney 	 */
1110dad81a20SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq)); /* ^^^ */
1111dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1112d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sp);
1113da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) {
1114da915ad5SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq));
1115d6331980SPaul E. McKenney 			spin_unlock_irq_rcu_node(sp);
1116da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1117dad81a20SPaul E. McKenney 			return;
1118dad81a20SPaul E. McKenney 		}
1119dad81a20SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq));
1120dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1121dad81a20SPaul E. McKenney 			srcu_gp_start(sp);
1122d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sp);
1123da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1124da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1125dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1126dad81a20SPaul E. McKenney 		}
1127da915ad5SPaul E. McKenney 	}
1128dad81a20SPaul E. McKenney 
1129dad81a20SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1130da915ad5SPaul E. McKenney 		idx = 1 ^ (sp->srcu_idx & 1);
1131da915ad5SPaul E. McKenney 		if (!try_check_zero(sp, idx, 1)) {
1132da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1133dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1134da915ad5SPaul E. McKenney 		}
1135dad81a20SPaul E. McKenney 		srcu_flip(sp);
1136dad81a20SPaul E. McKenney 		rcu_seq_set_state(&sp->srcu_gp_seq, SRCU_STATE_SCAN2);
1137dad81a20SPaul E. McKenney 	}
1138dad81a20SPaul E. McKenney 
1139dad81a20SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1140dad81a20SPaul E. McKenney 
1141dad81a20SPaul E. McKenney 		/*
1142dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1143dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1144dad81a20SPaul E. McKenney 		 */
1145da915ad5SPaul E. McKenney 		idx = 1 ^ (sp->srcu_idx & 1);
1146da915ad5SPaul E. McKenney 		if (!try_check_zero(sp, idx, 2)) {
1147da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1148da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1149da915ad5SPaul E. McKenney 		}
1150da915ad5SPaul E. McKenney 		srcu_gp_end(sp);  /* Releases ->srcu_gp_mutex. */
1151dad81a20SPaul E. McKenney 	}
1152dad81a20SPaul E. McKenney }
1153dad81a20SPaul E. McKenney 
1154dad81a20SPaul E. McKenney /*
1155dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1156dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1157dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1158dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1159dad81a20SPaul E. McKenney  */
1160da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1161dad81a20SPaul E. McKenney {
1162da915ad5SPaul E. McKenney 	bool more;
1163dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1164dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1165da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1166da915ad5SPaul E. McKenney 	struct srcu_struct *sp;
1167dad81a20SPaul E. McKenney 
1168da915ad5SPaul E. McKenney 	sdp = container_of(work, struct srcu_data, work.work);
1169da915ad5SPaul E. McKenney 	sp = sdp->sp;
1170dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1171d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1172da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1173da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
1174da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1175da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1176d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1177da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1178da915ad5SPaul E. McKenney 	}
1179da915ad5SPaul E. McKenney 
1180da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1181da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1182da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1183d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1184dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1185dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1186a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1187dad81a20SPaul E. McKenney 		local_bh_disable();
1188dad81a20SPaul E. McKenney 		rhp->func(rhp);
1189dad81a20SPaul E. McKenney 		local_bh_enable();
1190dad81a20SPaul E. McKenney 	}
1191da915ad5SPaul E. McKenney 
1192da915ad5SPaul E. McKenney 	/*
1193da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1194da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1195da915ad5SPaul E. McKenney 	 */
1196d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1197da915ad5SPaul E. McKenney 	rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1198da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1199da915ad5SPaul E. McKenney 				       rcu_seq_snap(&sp->srcu_gp_seq));
1200da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1201da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1202d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1203da915ad5SPaul E. McKenney 	if (more)
1204da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1205dad81a20SPaul E. McKenney }
1206dad81a20SPaul E. McKenney 
1207dad81a20SPaul E. McKenney /*
1208dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1209dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1210dad81a20SPaul E. McKenney  */
1211dad81a20SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay)
1212dad81a20SPaul E. McKenney {
1213da915ad5SPaul E. McKenney 	bool pushgp = true;
1214dad81a20SPaul E. McKenney 
1215d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sp);
1216da915ad5SPaul E. McKenney 	if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) {
1217da915ad5SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq))) {
1218da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1219da915ad5SPaul E. McKenney 			pushgp = false;
1220dad81a20SPaul E. McKenney 		}
1221da915ad5SPaul E. McKenney 	} else if (!rcu_seq_state(sp->srcu_gp_seq)) {
1222da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1223da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
1224da915ad5SPaul E. McKenney 	}
1225d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sp);
1226dad81a20SPaul E. McKenney 
1227da915ad5SPaul E. McKenney 	if (pushgp)
1228dad81a20SPaul E. McKenney 		queue_delayed_work(system_power_efficient_wq, &sp->work, delay);
1229dad81a20SPaul E. McKenney }
1230dad81a20SPaul E. McKenney 
1231dad81a20SPaul E. McKenney /*
1232dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1233dad81a20SPaul E. McKenney  */
12340d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1235dad81a20SPaul E. McKenney {
1236dad81a20SPaul E. McKenney 	struct srcu_struct *sp;
1237dad81a20SPaul E. McKenney 
1238dad81a20SPaul E. McKenney 	sp = container_of(work, struct srcu_struct, work.work);
1239dad81a20SPaul E. McKenney 
1240da915ad5SPaul E. McKenney 	srcu_advance_state(sp);
12411e9a038bSPaul E. McKenney 	srcu_reschedule(sp, srcu_get_delay(sp));
1242dad81a20SPaul E. McKenney }
12437f6733c3SPaul E. McKenney 
12447f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
12457f6733c3SPaul E. McKenney 			     struct srcu_struct *sp, int *flags,
12461e9a038bSPaul E. McKenney 			     unsigned long *gpnum, unsigned long *completed)
12477f6733c3SPaul E. McKenney {
12487f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
12497f6733c3SPaul E. McKenney 		return;
12507f6733c3SPaul E. McKenney 	*flags = 0;
12517f6733c3SPaul E. McKenney 	*completed = rcu_seq_ctr(sp->srcu_gp_seq);
12527f6733c3SPaul E. McKenney 	*gpnum = rcu_seq_ctr(sp->srcu_gp_seq_needed);
12537f6733c3SPaul E. McKenney }
12547f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
12551f4f6da1SPaul E. McKenney 
1256115a1a52SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *sp, char *tt, char *tf)
1257115a1a52SPaul E. McKenney {
1258115a1a52SPaul E. McKenney 	int cpu;
1259115a1a52SPaul E. McKenney 	int idx;
1260ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1261115a1a52SPaul E. McKenney 
1262115a1a52SPaul E. McKenney 	idx = sp->srcu_idx & 0x1;
1263115a1a52SPaul E. McKenney 	pr_alert("%s%s Tree SRCU per-CPU(idx=%d):", tt, tf, idx);
1264115a1a52SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1265115a1a52SPaul E. McKenney 		unsigned long l0, l1;
1266115a1a52SPaul E. McKenney 		unsigned long u0, u1;
1267115a1a52SPaul E. McKenney 		long c0, c1;
1268115a1a52SPaul E. McKenney 		struct srcu_data *counts;
1269115a1a52SPaul E. McKenney 
1270115a1a52SPaul E. McKenney 		counts = per_cpu_ptr(sp->sda, cpu);
1271115a1a52SPaul E. McKenney 		u0 = counts->srcu_unlock_count[!idx];
1272115a1a52SPaul E. McKenney 		u1 = counts->srcu_unlock_count[idx];
1273115a1a52SPaul E. McKenney 
1274115a1a52SPaul E. McKenney 		/*
1275115a1a52SPaul E. McKenney 		 * Make sure that a lock is always counted if the corresponding
1276115a1a52SPaul E. McKenney 		 * unlock is counted.
1277115a1a52SPaul E. McKenney 		 */
1278115a1a52SPaul E. McKenney 		smp_rmb();
1279115a1a52SPaul E. McKenney 
1280115a1a52SPaul E. McKenney 		l0 = counts->srcu_lock_count[!idx];
1281115a1a52SPaul E. McKenney 		l1 = counts->srcu_lock_count[idx];
1282115a1a52SPaul E. McKenney 
1283115a1a52SPaul E. McKenney 		c0 = l0 - u0;
1284115a1a52SPaul E. McKenney 		c1 = l1 - u1;
1285115a1a52SPaul E. McKenney 		pr_cont(" %d(%ld,%ld)", cpu, c0, c1);
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);
1301