xref: /linux-6.15/kernel/rcu/srcutree.c (revision ac3748c6)
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);
54da915ad5SPaul E. McKenney 
55da915ad5SPaul E. McKenney /*
56da915ad5SPaul E. McKenney  * Initialize SRCU combining tree.  Note that statically allocated
57da915ad5SPaul E. McKenney  * srcu_struct structures might already have srcu_read_lock() and
58da915ad5SPaul E. McKenney  * srcu_read_unlock() running against them.  So if the is_static parameter
59da915ad5SPaul E. McKenney  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
60da915ad5SPaul E. McKenney  */
61da915ad5SPaul E. McKenney static void init_srcu_struct_nodes(struct srcu_struct *sp, bool is_static)
62dad81a20SPaul E. McKenney {
63da915ad5SPaul E. McKenney 	int cpu;
64da915ad5SPaul E. McKenney 	int i;
65da915ad5SPaul E. McKenney 	int level = 0;
66da915ad5SPaul E. McKenney 	int levelspread[RCU_NUM_LVLS];
67da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
68da915ad5SPaul E. McKenney 	struct srcu_node *snp;
69da915ad5SPaul E. McKenney 	struct srcu_node *snp_first;
70da915ad5SPaul E. McKenney 
71da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
72da915ad5SPaul E. McKenney 	sp->level[0] = &sp->node[0];
73da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
74da915ad5SPaul E. McKenney 		sp->level[i] = sp->level[i - 1] + num_rcu_lvl[i - 1];
75da915ad5SPaul E. McKenney 	rcu_init_levelspread(levelspread, num_rcu_lvl);
76da915ad5SPaul E. McKenney 
77da915ad5SPaul E. McKenney 	/* Each pass through this loop initializes one srcu_node structure. */
78da915ad5SPaul E. McKenney 	rcu_for_each_node_breadth_first(sp, snp) {
79a3883df3SPaul E. McKenney 		raw_spin_lock_init(&ACCESS_PRIVATE(snp, lock));
80c7e88067SPaul E. McKenney 		WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
81c7e88067SPaul E. McKenney 			     ARRAY_SIZE(snp->srcu_data_have_cbs));
82c7e88067SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
83da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[i] = 0;
84c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[i] = 0;
85c7e88067SPaul E. McKenney 		}
861e9a038bSPaul E. McKenney 		snp->srcu_gp_seq_needed_exp = 0;
87da915ad5SPaul E. McKenney 		snp->grplo = -1;
88da915ad5SPaul E. McKenney 		snp->grphi = -1;
89da915ad5SPaul E. McKenney 		if (snp == &sp->node[0]) {
90da915ad5SPaul E. McKenney 			/* Root node, special case. */
91da915ad5SPaul E. McKenney 			snp->srcu_parent = NULL;
92da915ad5SPaul E. McKenney 			continue;
93da915ad5SPaul E. McKenney 		}
94da915ad5SPaul E. McKenney 
95da915ad5SPaul E. McKenney 		/* Non-root node. */
96da915ad5SPaul E. McKenney 		if (snp == sp->level[level + 1])
97da915ad5SPaul E. McKenney 			level++;
98da915ad5SPaul E. McKenney 		snp->srcu_parent = sp->level[level - 1] +
99da915ad5SPaul E. McKenney 				   (snp - sp->level[level]) /
100da915ad5SPaul E. McKenney 				   levelspread[level - 1];
101da915ad5SPaul E. McKenney 	}
102da915ad5SPaul E. McKenney 
103da915ad5SPaul E. McKenney 	/*
104da915ad5SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
105da915ad5SPaul E. McKenney 	 * leaves of the srcu_node tree.
106da915ad5SPaul E. McKenney 	 */
107da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
108da915ad5SPaul E. McKenney 		     ARRAY_SIZE(sdp->srcu_unlock_count));
109da915ad5SPaul E. McKenney 	level = rcu_num_lvls - 1;
110da915ad5SPaul E. McKenney 	snp_first = sp->level[level];
111da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
112da915ad5SPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
113a3883df3SPaul E. McKenney 		raw_spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
114da915ad5SPaul E. McKenney 		rcu_segcblist_init(&sdp->srcu_cblist);
115da915ad5SPaul E. McKenney 		sdp->srcu_cblist_invoking = false;
116da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = sp->srcu_gp_seq;
1171e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = sp->srcu_gp_seq;
118da915ad5SPaul E. McKenney 		sdp->mynode = &snp_first[cpu / levelspread[level]];
119da915ad5SPaul E. McKenney 		for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
120da915ad5SPaul E. McKenney 			if (snp->grplo < 0)
121da915ad5SPaul E. McKenney 				snp->grplo = cpu;
122da915ad5SPaul E. McKenney 			snp->grphi = cpu;
123da915ad5SPaul E. McKenney 		}
124da915ad5SPaul E. McKenney 		sdp->cpu = cpu;
125da915ad5SPaul E. McKenney 		INIT_DELAYED_WORK(&sdp->work, srcu_invoke_callbacks);
126da915ad5SPaul E. McKenney 		sdp->sp = sp;
127c7e88067SPaul E. McKenney 		sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
128da915ad5SPaul E. McKenney 		if (is_static)
129da915ad5SPaul E. McKenney 			continue;
130da915ad5SPaul E. McKenney 
131da915ad5SPaul E. McKenney 		/* Dynamically allocated, better be no srcu_read_locks()! */
132da915ad5SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) {
133da915ad5SPaul E. McKenney 			sdp->srcu_lock_count[i] = 0;
134da915ad5SPaul E. McKenney 			sdp->srcu_unlock_count[i] = 0;
135da915ad5SPaul E. McKenney 		}
136da915ad5SPaul E. McKenney 	}
137da915ad5SPaul E. McKenney }
138da915ad5SPaul E. McKenney 
139da915ad5SPaul E. McKenney /*
140da915ad5SPaul E. McKenney  * Initialize non-compile-time initialized fields, including the
141da915ad5SPaul E. McKenney  * associated srcu_node and srcu_data structures.  The is_static
142da915ad5SPaul E. McKenney  * parameter is passed through to init_srcu_struct_nodes(), and
143da915ad5SPaul E. McKenney  * also tells us that ->sda has already been wired up to srcu_data.
144da915ad5SPaul E. McKenney  */
145da915ad5SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *sp, bool is_static)
146da915ad5SPaul E. McKenney {
147da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_cb_mutex);
148da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_gp_mutex);
149da915ad5SPaul E. McKenney 	sp->srcu_idx = 0;
150dad81a20SPaul E. McKenney 	sp->srcu_gp_seq = 0;
151da915ad5SPaul E. McKenney 	sp->srcu_barrier_seq = 0;
152da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_barrier_mutex);
153da915ad5SPaul E. McKenney 	atomic_set(&sp->srcu_barrier_cpu_cnt, 0);
154dad81a20SPaul E. McKenney 	INIT_DELAYED_WORK(&sp->work, process_srcu);
155da915ad5SPaul E. McKenney 	if (!is_static)
156da915ad5SPaul E. McKenney 		sp->sda = alloc_percpu(struct srcu_data);
157da915ad5SPaul E. McKenney 	init_srcu_struct_nodes(sp, is_static);
1581e9a038bSPaul E. McKenney 	sp->srcu_gp_seq_needed_exp = 0;
15922607d66SPaul E. McKenney 	sp->srcu_last_gp_end = ktime_get_mono_fast_ns();
160da915ad5SPaul E. McKenney 	smp_store_release(&sp->srcu_gp_seq_needed, 0); /* Init done. */
161da915ad5SPaul E. McKenney 	return sp->sda ? 0 : -ENOMEM;
162dad81a20SPaul E. McKenney }
163dad81a20SPaul E. McKenney 
164dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
165dad81a20SPaul E. McKenney 
166dad81a20SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *sp, const char *name,
167dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
168dad81a20SPaul E. McKenney {
169dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
170dad81a20SPaul E. McKenney 	debug_check_no_locks_freed((void *)sp, sizeof(*sp));
171dad81a20SPaul E. McKenney 	lockdep_init_map(&sp->dep_map, name, key, 0);
172a3883df3SPaul E. McKenney 	raw_spin_lock_init(&ACCESS_PRIVATE(sp, lock));
173da915ad5SPaul E. McKenney 	return init_srcu_struct_fields(sp, false);
174dad81a20SPaul E. McKenney }
175dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
176dad81a20SPaul E. McKenney 
177dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
178dad81a20SPaul E. McKenney 
179dad81a20SPaul E. McKenney /**
180dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
181dad81a20SPaul E. McKenney  * @sp: structure to initialize.
182dad81a20SPaul E. McKenney  *
183dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
184dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
185dad81a20SPaul E. McKenney  * of SRCU protection.
186dad81a20SPaul E. McKenney  */
187dad81a20SPaul E. McKenney int init_srcu_struct(struct srcu_struct *sp)
188dad81a20SPaul E. McKenney {
189a3883df3SPaul E. McKenney 	raw_spin_lock_init(&ACCESS_PRIVATE(sp, lock));
190da915ad5SPaul E. McKenney 	return init_srcu_struct_fields(sp, false);
191dad81a20SPaul E. McKenney }
192dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
193dad81a20SPaul E. McKenney 
194dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
195dad81a20SPaul E. McKenney 
196dad81a20SPaul E. McKenney /*
197da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
198da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
199da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
200a3883df3SPaul E. McKenney  * to each update-side SRCU primitive.  Use sp->lock, which -is-
201da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
202da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
203da915ad5SPaul E. McKenney  */
204da915ad5SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *sp)
205da915ad5SPaul E. McKenney {
206da915ad5SPaul E. McKenney 	unsigned long flags;
207da915ad5SPaul E. McKenney 
208da915ad5SPaul E. McKenney 	WARN_ON_ONCE(rcu_scheduler_active == RCU_SCHEDULER_INIT);
209da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
210da915ad5SPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq_needed))) /*^^^*/
211da915ad5SPaul E. McKenney 		return; /* Already initialized. */
212a3883df3SPaul E. McKenney 	raw_spin_lock_irqsave_rcu_node(sp, flags);
213da915ad5SPaul E. McKenney 	if (!rcu_seq_state(sp->srcu_gp_seq_needed)) {
214a3883df3SPaul E. McKenney 		raw_spin_unlock_irqrestore_rcu_node(sp, flags);
215da915ad5SPaul E. McKenney 		return;
216da915ad5SPaul E. McKenney 	}
217da915ad5SPaul E. McKenney 	init_srcu_struct_fields(sp, true);
218a3883df3SPaul E. McKenney 	raw_spin_unlock_irqrestore_rcu_node(sp, flags);
219da915ad5SPaul E. McKenney }
220da915ad5SPaul E. McKenney 
221da915ad5SPaul E. McKenney /*
222da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
223da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
224dad81a20SPaul E. McKenney  */
225dad81a20SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *sp, int idx)
226dad81a20SPaul E. McKenney {
227dad81a20SPaul E. McKenney 	int cpu;
228dad81a20SPaul E. McKenney 	unsigned long sum = 0;
229dad81a20SPaul E. McKenney 
230dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
231da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
232dad81a20SPaul E. McKenney 
233da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[idx]);
234dad81a20SPaul E. McKenney 	}
235dad81a20SPaul E. McKenney 	return sum;
236dad81a20SPaul E. McKenney }
237dad81a20SPaul E. McKenney 
238dad81a20SPaul E. McKenney /*
239da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
240da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
241dad81a20SPaul E. McKenney  */
242dad81a20SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *sp, int idx)
243dad81a20SPaul E. McKenney {
244dad81a20SPaul E. McKenney 	int cpu;
245dad81a20SPaul E. McKenney 	unsigned long sum = 0;
246dad81a20SPaul E. McKenney 
247dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
248da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
249dad81a20SPaul E. McKenney 
250da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_unlock_count[idx]);
251dad81a20SPaul E. McKenney 	}
252dad81a20SPaul E. McKenney 	return sum;
253dad81a20SPaul E. McKenney }
254dad81a20SPaul E. McKenney 
255dad81a20SPaul E. McKenney /*
256dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
257dad81a20SPaul E. McKenney  * be zero.
258dad81a20SPaul E. McKenney  */
259dad81a20SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *sp, int idx)
260dad81a20SPaul E. McKenney {
261dad81a20SPaul E. McKenney 	unsigned long unlocks;
262dad81a20SPaul E. McKenney 
263dad81a20SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(sp, idx);
264dad81a20SPaul E. McKenney 
265dad81a20SPaul E. McKenney 	/*
266dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
267dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
268dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
269dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
270dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
271dad81a20SPaul E. McKenney 	 *
272dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
273dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
274dad81a20SPaul E. McKenney 	 * grace period ends.
275dad81a20SPaul E. McKenney 	 */
276dad81a20SPaul E. McKenney 	smp_mb(); /* A */
277dad81a20SPaul E. McKenney 
278dad81a20SPaul E. McKenney 	/*
279dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
280dad81a20SPaul E. McKenney 	 * been no readers on this index at some time in between. This does
281dad81a20SPaul E. McKenney 	 * not mean that there are no more readers, as one could have read
282dad81a20SPaul E. McKenney 	 * the current index but not have incremented the lock counter yet.
283dad81a20SPaul E. McKenney 	 *
284881ec9d2SPaul E. McKenney 	 * So suppose that the updater is preempted here for so long
285881ec9d2SPaul E. McKenney 	 * that more than ULONG_MAX non-nested readers come and go in
286881ec9d2SPaul E. McKenney 	 * the meantime.  It turns out that this cannot result in overflow
287881ec9d2SPaul E. McKenney 	 * because if a reader modifies its unlock count after we read it
288881ec9d2SPaul E. McKenney 	 * above, then that reader's next load of ->srcu_idx is guaranteed
289881ec9d2SPaul E. McKenney 	 * to get the new value, which will cause it to operate on the
290881ec9d2SPaul E. McKenney 	 * other bank of counters, where it cannot contribute to the
291881ec9d2SPaul E. McKenney 	 * overflow of these counters.  This means that there is a maximum
292881ec9d2SPaul E. McKenney 	 * of 2*NR_CPUS increments, which cannot overflow given current
293881ec9d2SPaul E. McKenney 	 * systems, especially not on 64-bit systems.
294881ec9d2SPaul E. McKenney 	 *
295881ec9d2SPaul E. McKenney 	 * OK, how about nesting?  This does impose a limit on nesting
296881ec9d2SPaul E. McKenney 	 * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
297881ec9d2SPaul E. McKenney 	 * especially on 64-bit systems.
298dad81a20SPaul E. McKenney 	 */
299dad81a20SPaul E. McKenney 	return srcu_readers_lock_idx(sp, idx) == unlocks;
300dad81a20SPaul E. McKenney }
301dad81a20SPaul E. McKenney 
302dad81a20SPaul E. McKenney /**
303dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
304dad81a20SPaul E. McKenney  *                       otherwise
305dad81a20SPaul E. McKenney  * @sp: which srcu_struct to count active readers (holding srcu_read_lock).
306dad81a20SPaul E. McKenney  *
307dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
308dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
309dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
310dad81a20SPaul E. McKenney  */
311dad81a20SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *sp)
312dad81a20SPaul E. McKenney {
313dad81a20SPaul E. McKenney 	int cpu;
314dad81a20SPaul E. McKenney 	unsigned long sum = 0;
315dad81a20SPaul E. McKenney 
316dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
317da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
318dad81a20SPaul E. McKenney 
319da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[0]);
320da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[1]);
321da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[0]);
322da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[1]);
323dad81a20SPaul E. McKenney 	}
324dad81a20SPaul E. McKenney 	return sum;
325dad81a20SPaul E. McKenney }
326dad81a20SPaul E. McKenney 
327dad81a20SPaul E. McKenney #define SRCU_INTERVAL		1
328dad81a20SPaul E. McKenney 
3291e9a038bSPaul E. McKenney /*
3301e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
3311e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
3321e9a038bSPaul E. McKenney  */
3331e9a038bSPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *sp)
3341e9a038bSPaul E. McKenney {
3351e9a038bSPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(sp->srcu_gp_seq),
3361e9a038bSPaul E. McKenney 			 READ_ONCE(sp->srcu_gp_seq_needed_exp)))
3371e9a038bSPaul E. McKenney 		return 0;
3381e9a038bSPaul E. McKenney 	return SRCU_INTERVAL;
3391e9a038bSPaul E. McKenney }
3401e9a038bSPaul E. McKenney 
341dad81a20SPaul E. McKenney /**
342dad81a20SPaul E. McKenney  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
343dad81a20SPaul E. McKenney  * @sp: structure to clean up.
344dad81a20SPaul E. McKenney  *
345dad81a20SPaul E. McKenney  * Must invoke this after you are finished using a given srcu_struct that
346dad81a20SPaul E. McKenney  * was initialized via init_srcu_struct(), else you leak memory.
347dad81a20SPaul E. McKenney  */
348dad81a20SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *sp)
349dad81a20SPaul E. McKenney {
350da915ad5SPaul E. McKenney 	int cpu;
351da915ad5SPaul E. McKenney 
3521e9a038bSPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(sp)))
3531e9a038bSPaul E. McKenney 		return; /* Leakage unless caller handles error. */
354dad81a20SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(sp)))
355dad81a20SPaul E. McKenney 		return; /* Leakage unless caller handles error. */
356dad81a20SPaul E. McKenney 	flush_delayed_work(&sp->work);
357da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu)
358da915ad5SPaul E. McKenney 		flush_delayed_work(&per_cpu_ptr(sp->sda, cpu)->work);
359da915ad5SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
360da915ad5SPaul E. McKenney 	    WARN_ON(srcu_readers_active(sp))) {
361da915ad5SPaul E. McKenney 		pr_info("cleanup_srcu_struct: Active srcu_struct %p state: %d\n", sp, rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)));
362dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
363dad81a20SPaul E. McKenney 	}
364da915ad5SPaul E. McKenney 	free_percpu(sp->sda);
365da915ad5SPaul E. McKenney 	sp->sda = NULL;
366dad81a20SPaul E. McKenney }
367dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
368dad81a20SPaul E. McKenney 
369dad81a20SPaul E. McKenney /*
370dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
371cdf7abc4SPaolo Bonzini  * srcu_struct.
372dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
373dad81a20SPaul E. McKenney  */
374dad81a20SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *sp)
375dad81a20SPaul E. McKenney {
376dad81a20SPaul E. McKenney 	int idx;
377dad81a20SPaul E. McKenney 
378da915ad5SPaul E. McKenney 	idx = READ_ONCE(sp->srcu_idx) & 0x1;
379cdf7abc4SPaolo Bonzini 	this_cpu_inc(sp->sda->srcu_lock_count[idx]);
380dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
381dad81a20SPaul E. McKenney 	return idx;
382dad81a20SPaul E. McKenney }
383dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
384dad81a20SPaul E. McKenney 
385dad81a20SPaul E. McKenney /*
386dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
387dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
388dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
389dad81a20SPaul E. McKenney  */
390dad81a20SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *sp, int idx)
391dad81a20SPaul E. McKenney {
392dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
393da915ad5SPaul E. McKenney 	this_cpu_inc(sp->sda->srcu_unlock_count[idx]);
394dad81a20SPaul E. McKenney }
395dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
396dad81a20SPaul E. McKenney 
397dad81a20SPaul E. McKenney /*
398dad81a20SPaul E. McKenney  * We use an adaptive strategy for synchronize_srcu() and especially for
399dad81a20SPaul E. McKenney  * synchronize_srcu_expedited().  We spin for a fixed time period
400dad81a20SPaul E. McKenney  * (defined below) to allow SRCU readers to exit their read-side critical
401dad81a20SPaul E. McKenney  * sections.  If there are still some readers after a few microseconds,
402dad81a20SPaul E. McKenney  * we repeatedly block for 1-millisecond time periods.
403dad81a20SPaul E. McKenney  */
404dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY		5
405dad81a20SPaul E. McKenney 
406dad81a20SPaul E. McKenney /*
407dad81a20SPaul E. McKenney  * Start an SRCU grace period.
408dad81a20SPaul E. McKenney  */
409dad81a20SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *sp)
410dad81a20SPaul E. McKenney {
411da915ad5SPaul E. McKenney 	struct srcu_data *sdp = this_cpu_ptr(sp->sda);
412dad81a20SPaul E. McKenney 	int state;
413dad81a20SPaul E. McKenney 
414a3883df3SPaul E. McKenney 	lockdep_assert_held(&sp->lock);
415da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed));
416da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
417da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
418da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
419dad81a20SPaul E. McKenney 				       rcu_seq_snap(&sp->srcu_gp_seq));
4202da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
421dad81a20SPaul E. McKenney 	rcu_seq_start(&sp->srcu_gp_seq);
422dad81a20SPaul E. McKenney 	state = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq));
423dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
424dad81a20SPaul E. McKenney }
425dad81a20SPaul E. McKenney 
426dad81a20SPaul E. McKenney /*
427da915ad5SPaul E. McKenney  * Track online CPUs to guide callback workqueue placement.
428da915ad5SPaul E. McKenney  */
429da915ad5SPaul E. McKenney DEFINE_PER_CPU(bool, srcu_online);
430da915ad5SPaul E. McKenney 
431da915ad5SPaul E. McKenney void srcu_online_cpu(unsigned int cpu)
432da915ad5SPaul E. McKenney {
433da915ad5SPaul E. McKenney 	WRITE_ONCE(per_cpu(srcu_online, cpu), true);
434da915ad5SPaul E. McKenney }
435da915ad5SPaul E. McKenney 
436da915ad5SPaul E. McKenney void srcu_offline_cpu(unsigned int cpu)
437da915ad5SPaul E. McKenney {
438da915ad5SPaul E. McKenney 	WRITE_ONCE(per_cpu(srcu_online, cpu), false);
439da915ad5SPaul E. McKenney }
440da915ad5SPaul E. McKenney 
441da915ad5SPaul E. McKenney /*
442da915ad5SPaul E. McKenney  * Place the workqueue handler on the specified CPU if online, otherwise
443da915ad5SPaul E. McKenney  * just run it whereever.  This is useful for placing workqueue handlers
444da915ad5SPaul E. McKenney  * that are to invoke the specified CPU's callbacks.
445da915ad5SPaul E. McKenney  */
446da915ad5SPaul E. McKenney static bool srcu_queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
447da915ad5SPaul E. McKenney 				       struct delayed_work *dwork,
448da915ad5SPaul E. McKenney 				       unsigned long delay)
449da915ad5SPaul E. McKenney {
450da915ad5SPaul E. McKenney 	bool ret;
451da915ad5SPaul E. McKenney 
452da915ad5SPaul E. McKenney 	preempt_disable();
453da915ad5SPaul E. McKenney 	if (READ_ONCE(per_cpu(srcu_online, cpu)))
454da915ad5SPaul E. McKenney 		ret = queue_delayed_work_on(cpu, wq, dwork, delay);
455da915ad5SPaul E. McKenney 	else
456da915ad5SPaul E. McKenney 		ret = queue_delayed_work(wq, dwork, delay);
457da915ad5SPaul E. McKenney 	preempt_enable();
458da915ad5SPaul E. McKenney 	return ret;
459da915ad5SPaul E. McKenney }
460da915ad5SPaul E. McKenney 
461da915ad5SPaul E. McKenney /*
462da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
463da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
464da915ad5SPaul E. McKenney  */
465da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
466da915ad5SPaul E. McKenney {
467da915ad5SPaul E. McKenney 	srcu_queue_delayed_work_on(sdp->cpu, system_power_efficient_wq,
468da915ad5SPaul E. McKenney 				   &sdp->work, delay);
469da915ad5SPaul E. McKenney }
470da915ad5SPaul E. McKenney 
471da915ad5SPaul E. McKenney /*
472da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
473c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
474c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
475c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
476da915ad5SPaul E. McKenney  */
477c7e88067SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *sp, struct srcu_node *snp,
4781e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
479da915ad5SPaul E. McKenney {
480da915ad5SPaul E. McKenney 	int cpu;
481da915ad5SPaul E. McKenney 
482c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
483c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
484c7e88067SPaul E. McKenney 			continue;
4851e9a038bSPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(sp->sda, cpu), delay);
486da915ad5SPaul E. McKenney 	}
487c7e88067SPaul E. McKenney }
488da915ad5SPaul E. McKenney 
489da915ad5SPaul E. McKenney /*
490da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
491da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
492da915ad5SPaul E. McKenney  *
493da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
494da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
495da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
496da915ad5SPaul E. McKenney  * array to have a finite number of elements.
497da915ad5SPaul E. McKenney  */
498da915ad5SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *sp)
499da915ad5SPaul E. McKenney {
5001e9a038bSPaul E. McKenney 	unsigned long cbdelay;
501da915ad5SPaul E. McKenney 	bool cbs;
502c350c008SPaul E. McKenney 	int cpu;
503c350c008SPaul E. McKenney 	unsigned long flags;
504da915ad5SPaul E. McKenney 	unsigned long gpseq;
505da915ad5SPaul E. McKenney 	int idx;
506da915ad5SPaul E. McKenney 	int idxnext;
507c7e88067SPaul E. McKenney 	unsigned long mask;
508c350c008SPaul E. McKenney 	struct srcu_data *sdp;
509da915ad5SPaul E. McKenney 	struct srcu_node *snp;
510da915ad5SPaul E. McKenney 
511da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
512da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_cb_mutex);
513da915ad5SPaul E. McKenney 
514da915ad5SPaul E. McKenney 	/* End the current grace period. */
515a3883df3SPaul E. McKenney 	raw_spin_lock_irq_rcu_node(sp);
516da915ad5SPaul E. McKenney 	idx = rcu_seq_state(sp->srcu_gp_seq);
517da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
5181e9a038bSPaul E. McKenney 	cbdelay = srcu_get_delay(sp);
51922607d66SPaul E. McKenney 	sp->srcu_last_gp_end = ktime_get_mono_fast_ns();
520da915ad5SPaul E. McKenney 	rcu_seq_end(&sp->srcu_gp_seq);
521da915ad5SPaul E. McKenney 	gpseq = rcu_seq_current(&sp->srcu_gp_seq);
5221e9a038bSPaul E. McKenney 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, gpseq))
5231e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = gpseq;
524a3883df3SPaul E. McKenney 	raw_spin_unlock_irq_rcu_node(sp);
525da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_gp_mutex);
526da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
527da915ad5SPaul E. McKenney 
528da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
529da915ad5SPaul E. McKenney 	idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
530da915ad5SPaul E. McKenney 	idxnext = (idx + 1) % ARRAY_SIZE(snp->srcu_have_cbs);
531da915ad5SPaul E. McKenney 	rcu_for_each_node_breadth_first(sp, snp) {
532a3883df3SPaul E. McKenney 		raw_spin_lock_irq_rcu_node(snp);
533da915ad5SPaul E. McKenney 		cbs = false;
534da915ad5SPaul E. McKenney 		if (snp >= sp->level[rcu_num_lvls - 1])
535da915ad5SPaul E. McKenney 			cbs = snp->srcu_have_cbs[idx] == gpseq;
536da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = gpseq;
537da915ad5SPaul E. McKenney 		rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
5381e9a038bSPaul E. McKenney 		if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
5391e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = gpseq;
540c7e88067SPaul E. McKenney 		mask = snp->srcu_data_have_cbs[idx];
541c7e88067SPaul E. McKenney 		snp->srcu_data_have_cbs[idx] = 0;
542a3883df3SPaul E. McKenney 		raw_spin_unlock_irq_rcu_node(snp);
543a3883df3SPaul E. McKenney 		if (cbs)
5441e9a038bSPaul E. McKenney 			srcu_schedule_cbs_snp(sp, snp, mask, cbdelay);
545c350c008SPaul E. McKenney 
546c350c008SPaul E. McKenney 		/* Occasionally prevent srcu_data counter wrap. */
547c350c008SPaul E. McKenney 		if (!(gpseq & counter_wrap_check))
548c350c008SPaul E. McKenney 			for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
549c350c008SPaul E. McKenney 				sdp = per_cpu_ptr(sp->sda, cpu);
550a3883df3SPaul E. McKenney 				raw_spin_lock_irqsave_rcu_node(sdp, flags);
551c350c008SPaul E. McKenney 				if (ULONG_CMP_GE(gpseq,
552c350c008SPaul E. McKenney 						 sdp->srcu_gp_seq_needed + 100))
553c350c008SPaul E. McKenney 					sdp->srcu_gp_seq_needed = gpseq;
554a3883df3SPaul E. McKenney 				raw_spin_unlock_irqrestore_rcu_node(sdp, flags);
555c350c008SPaul E. McKenney 			}
556da915ad5SPaul E. McKenney 	}
557da915ad5SPaul E. McKenney 
558da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
559da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_cb_mutex);
560da915ad5SPaul E. McKenney 
561da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
562a3883df3SPaul E. McKenney 	raw_spin_lock_irq_rcu_node(sp);
563da915ad5SPaul E. McKenney 	gpseq = rcu_seq_current(&sp->srcu_gp_seq);
564da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
565da915ad5SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, sp->srcu_gp_seq_needed)) {
566da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
567a3883df3SPaul E. McKenney 		raw_spin_unlock_irq_rcu_node(sp);
568da915ad5SPaul E. McKenney 		/* Throttle expedited grace periods: Should be rare! */
5691e9a038bSPaul E. McKenney 		srcu_reschedule(sp, rcu_seq_ctr(gpseq) & 0x3ff
5701e9a038bSPaul E. McKenney 				    ? 0 : SRCU_INTERVAL);
571da915ad5SPaul E. McKenney 	} else {
572a3883df3SPaul E. McKenney 		raw_spin_unlock_irq_rcu_node(sp);
573da915ad5SPaul E. McKenney 	}
574da915ad5SPaul E. McKenney }
575da915ad5SPaul E. McKenney 
576da915ad5SPaul E. McKenney /*
5771e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
5781e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
5791e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
5801e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
5811e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
5821e9a038bSPaul E. McKenney  */
5831e9a038bSPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *sp, struct srcu_node *snp,
5841e9a038bSPaul E. McKenney 				  unsigned long s)
5851e9a038bSPaul E. McKenney {
5861e9a038bSPaul E. McKenney 	unsigned long flags;
5871e9a038bSPaul E. McKenney 
5881e9a038bSPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
5891e9a038bSPaul E. McKenney 		if (rcu_seq_done(&sp->srcu_gp_seq, s) ||
5901e9a038bSPaul E. McKenney 		    ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
5911e9a038bSPaul E. McKenney 			return;
592a3883df3SPaul E. McKenney 		raw_spin_lock_irqsave_rcu_node(snp, flags);
5931e9a038bSPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
594a3883df3SPaul E. McKenney 			raw_spin_unlock_irqrestore_rcu_node(snp, flags);
5951e9a038bSPaul E. McKenney 			return;
5961e9a038bSPaul E. McKenney 		}
5971e9a038bSPaul E. McKenney 		WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
598a3883df3SPaul E. McKenney 		raw_spin_unlock_irqrestore_rcu_node(snp, flags);
5991e9a038bSPaul E. McKenney 	}
600a3883df3SPaul E. McKenney 	raw_spin_lock_irqsave_rcu_node(sp, flags);
6011e9a038bSPaul E. McKenney 	if (!ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s))
6021e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = s;
603a3883df3SPaul E. McKenney 	raw_spin_unlock_irqrestore_rcu_node(sp, flags);
6041e9a038bSPaul E. McKenney }
6051e9a038bSPaul E. McKenney 
6061e9a038bSPaul E. McKenney /*
607da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
608da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
609da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
610da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
611da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
612da915ad5SPaul E. McKenney  */
6131e9a038bSPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *sp, struct srcu_data *sdp,
6141e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
615da915ad5SPaul E. McKenney {
616da915ad5SPaul E. McKenney 	unsigned long flags;
617da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
618da915ad5SPaul E. McKenney 	struct srcu_node *snp = sdp->mynode;
619da915ad5SPaul E. McKenney 	unsigned long snp_seq;
620da915ad5SPaul E. McKenney 
621da915ad5SPaul E. McKenney 	/* Each pass through the loop does one level of the srcu_node tree. */
622da915ad5SPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
623da915ad5SPaul E. McKenney 		if (rcu_seq_done(&sp->srcu_gp_seq, s) && snp != sdp->mynode)
624da915ad5SPaul E. McKenney 			return; /* GP already done and CBs recorded. */
625a3883df3SPaul E. McKenney 		raw_spin_lock_irqsave_rcu_node(snp, flags);
626da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
627da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
628c7e88067SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq == s)
629c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
630a3883df3SPaul E. McKenney 			raw_spin_unlock_irqrestore_rcu_node(snp, flags);
631da915ad5SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq != s) {
6321e9a038bSPaul E. McKenney 				srcu_schedule_cbs_sdp(sdp, do_norm
6331e9a038bSPaul E. McKenney 							   ? SRCU_INTERVAL
6341e9a038bSPaul E. McKenney 							   : 0);
6351e9a038bSPaul E. McKenney 				return;
636da915ad5SPaul E. McKenney 			}
6371e9a038bSPaul E. McKenney 			if (!do_norm)
6381e9a038bSPaul E. McKenney 				srcu_funnel_exp_start(sp, snp, s);
639da915ad5SPaul E. McKenney 			return;
640da915ad5SPaul E. McKenney 		}
641da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = s;
642c7e88067SPaul E. McKenney 		if (snp == sdp->mynode)
643c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
6441e9a038bSPaul E. McKenney 		if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
6451e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = s;
646a3883df3SPaul E. McKenney 		raw_spin_unlock_irqrestore_rcu_node(snp, flags);
647da915ad5SPaul E. McKenney 	}
648da915ad5SPaul E. McKenney 
649da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
650a3883df3SPaul E. McKenney 	raw_spin_lock_irqsave_rcu_node(sp, flags);
651da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed, s)) {
652da915ad5SPaul E. McKenney 		/*
653da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
654da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
655da915ad5SPaul E. McKenney 		 */
656da915ad5SPaul E. McKenney 		smp_store_release(&sp->srcu_gp_seq_needed, s); /*^^^*/
657da915ad5SPaul E. McKenney 	}
6581e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s))
6591e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = s;
660da915ad5SPaul E. McKenney 
661da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
662da915ad5SPaul E. McKenney 	if (!rcu_seq_done(&sp->srcu_gp_seq, s) &&
663da915ad5SPaul E. McKenney 	    rcu_seq_state(sp->srcu_gp_seq) == SRCU_STATE_IDLE) {
664da915ad5SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed));
665da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
666da915ad5SPaul E. McKenney 		queue_delayed_work(system_power_efficient_wq, &sp->work,
6671e9a038bSPaul E. McKenney 				   srcu_get_delay(sp));
668da915ad5SPaul E. McKenney 	}
669a3883df3SPaul E. McKenney 	raw_spin_unlock_irqrestore_rcu_node(sp, flags);
670da915ad5SPaul E. McKenney }
671da915ad5SPaul E. McKenney 
672da915ad5SPaul E. McKenney /*
673dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
674dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
675da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
676dad81a20SPaul E. McKenney  */
677dad81a20SPaul E. McKenney static bool try_check_zero(struct srcu_struct *sp, int idx, int trycount)
678dad81a20SPaul E. McKenney {
679dad81a20SPaul E. McKenney 	for (;;) {
680dad81a20SPaul E. McKenney 		if (srcu_readers_active_idx_check(sp, idx))
681dad81a20SPaul E. McKenney 			return true;
6821e9a038bSPaul E. McKenney 		if (--trycount + !srcu_get_delay(sp) <= 0)
683dad81a20SPaul E. McKenney 			return false;
684dad81a20SPaul E. McKenney 		udelay(SRCU_RETRY_CHECK_DELAY);
685dad81a20SPaul E. McKenney 	}
686dad81a20SPaul E. McKenney }
687dad81a20SPaul E. McKenney 
688dad81a20SPaul E. McKenney /*
689da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
690da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
691dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
692dad81a20SPaul E. McKenney  */
693dad81a20SPaul E. McKenney static void srcu_flip(struct srcu_struct *sp)
694dad81a20SPaul E. McKenney {
695881ec9d2SPaul E. McKenney 	/*
696881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
697881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
698881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
699881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
700881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
701881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
702881ec9d2SPaul E. McKenney 	 */
703881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
704881ec9d2SPaul E. McKenney 
705da915ad5SPaul E. McKenney 	WRITE_ONCE(sp->srcu_idx, sp->srcu_idx + 1);
706dad81a20SPaul E. McKenney 
707dad81a20SPaul E. McKenney 	/*
708dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
709dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
710dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
711dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
712dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
713dad81a20SPaul E. McKenney 	 */
714dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
715dad81a20SPaul E. McKenney }
716dad81a20SPaul E. McKenney 
717dad81a20SPaul E. McKenney /*
7182da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
7192da4b2a7SPaul E. McKenney  *
7202da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
7212da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
7222da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
7232da4b2a7SPaul E. McKenney  *
7242da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
7252da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
7262da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
7272da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
7282da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
7292da4b2a7SPaul E. McKenney  * but to accept this type of error.
7302da4b2a7SPaul E. McKenney  *
7312da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
7322da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
7332da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
7342da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
7352da4b2a7SPaul E. McKenney  * negligible when amoritized over that time period, and the extra latency
7362da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
7372da4b2a7SPaul E. McKenney  */
7382da4b2a7SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *sp)
7392da4b2a7SPaul E. McKenney {
74022607d66SPaul E. McKenney 	unsigned long curseq;
7412da4b2a7SPaul E. McKenney 	unsigned long flags;
7422da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
74322607d66SPaul E. McKenney 	unsigned long t;
7442da4b2a7SPaul E. McKenney 
7452da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
7462da4b2a7SPaul E. McKenney 	local_irq_save(flags);
7472da4b2a7SPaul E. McKenney 	sdp = this_cpu_ptr(sp->sda);
7482da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
7492da4b2a7SPaul E. McKenney 		local_irq_restore(flags);
7502da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
7512da4b2a7SPaul E. McKenney 	}
7522da4b2a7SPaul E. McKenney 	local_irq_restore(flags);
7532da4b2a7SPaul E. McKenney 
7542da4b2a7SPaul E. McKenney 	/*
7552da4b2a7SPaul E. McKenney 	 * No local callbacks, so probabalistically probe global state.
7562da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
7572da4b2a7SPaul E. McKenney 	 * kill scalability, hence the probabalistic nature of the probe.
7582da4b2a7SPaul E. McKenney 	 */
75922607d66SPaul E. McKenney 
76022607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
76122607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
76222607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
76322607d66SPaul E. McKenney 	    time_in_range_open(t, sp->srcu_last_gp_end,
76422607d66SPaul E. McKenney 			       sp->srcu_last_gp_end + exp_holdoff))
76522607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
76622607d66SPaul E. McKenney 
76722607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
7682da4b2a7SPaul E. McKenney 	curseq = rcu_seq_current(&sp->srcu_gp_seq);
7692da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
7702da4b2a7SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(sp->srcu_gp_seq_needed)))
7712da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
7722da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
7732da4b2a7SPaul E. McKenney 	if (curseq != rcu_seq_current(&sp->srcu_gp_seq))
7742da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
7752da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
7762da4b2a7SPaul E. McKenney }
7772da4b2a7SPaul E. McKenney 
7782da4b2a7SPaul E. McKenney /*
779a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
780a602538eSPaul E. McKenney  */
781a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
782a602538eSPaul E. McKenney {
783a602538eSPaul E. McKenney }
784a602538eSPaul E. McKenney 
785a602538eSPaul E. McKenney /*
786da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
787da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
788da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
789dad81a20SPaul E. McKenney  *
790dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
791dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
792dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
793dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
794dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
795dad81a20SPaul E. McKenney  * preceded the call to call_rcu().  It also means that each CPU executing
796dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
797dad81a20SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_rcu()
798dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
799dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
800dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
801dad81a20SPaul E. McKenney  *
802dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked call_rcu() and CPU B invoked the
803dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
804dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
805dad81a20SPaul E. McKenney  * interval between the call to call_rcu() and the invocation of "func()".
806dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
807dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
808dad81a20SPaul E. McKenney  *
809dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
810dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
811dad81a20SPaul E. McKenney  * srcu_struct structure.
812dad81a20SPaul E. McKenney  */
8131e9a038bSPaul E. McKenney void __call_srcu(struct srcu_struct *sp, struct rcu_head *rhp,
8141e9a038bSPaul E. McKenney 		 rcu_callback_t func, bool do_norm)
815dad81a20SPaul E. McKenney {
816dad81a20SPaul E. McKenney 	unsigned long flags;
8171e9a038bSPaul E. McKenney 	bool needexp = false;
818da915ad5SPaul E. McKenney 	bool needgp = false;
819da915ad5SPaul E. McKenney 	unsigned long s;
820da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
821dad81a20SPaul E. McKenney 
822da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
823a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
824a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
825a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
826a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
827a602538eSPaul E. McKenney 		return;
828a602538eSPaul E. McKenney 	}
829da915ad5SPaul E. McKenney 	rhp->func = func;
830da915ad5SPaul E. McKenney 	local_irq_save(flags);
831da915ad5SPaul E. McKenney 	sdp = this_cpu_ptr(sp->sda);
832a3883df3SPaul E. McKenney 	raw_spin_lock_rcu_node(sdp);
833da915ad5SPaul E. McKenney 	rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp, false);
834da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
835da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
836da915ad5SPaul E. McKenney 	s = rcu_seq_snap(&sp->srcu_gp_seq);
837da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
838da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
839da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
840da915ad5SPaul E. McKenney 		needgp = true;
841dad81a20SPaul E. McKenney 	}
8421e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
8431e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
8441e9a038bSPaul E. McKenney 		needexp = true;
8451e9a038bSPaul E. McKenney 	}
846a3883df3SPaul E. McKenney 	raw_spin_unlock_irqrestore_rcu_node(sdp, flags);
847da915ad5SPaul E. McKenney 	if (needgp)
8481e9a038bSPaul E. McKenney 		srcu_funnel_gp_start(sp, sdp, s, do_norm);
8491e9a038bSPaul E. McKenney 	else if (needexp)
8501e9a038bSPaul E. McKenney 		srcu_funnel_exp_start(sp, sdp->mynode, s);
8511e9a038bSPaul E. McKenney }
8521e9a038bSPaul E. McKenney 
8535a0465e1SPaul E. McKenney /**
8545a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
8555a0465e1SPaul E. McKenney  * @sp: srcu_struct in queue the callback
8565a0465e1SPaul E. McKenney  * @head: structure to be used for queueing the SRCU callback.
8575a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
8585a0465e1SPaul E. McKenney  *
8595a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
8605a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
8615a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
8625a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
8635a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
8645a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
8655a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
8665a0465e1SPaul E. McKenney  *
8675a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
8685a0465e1SPaul E. McKenney  * be fast and must not block.
8695a0465e1SPaul E. McKenney  */
8701e9a038bSPaul E. McKenney void call_srcu(struct srcu_struct *sp, struct rcu_head *rhp,
8711e9a038bSPaul E. McKenney 	       rcu_callback_t func)
8721e9a038bSPaul E. McKenney {
8731e9a038bSPaul E. McKenney 	__call_srcu(sp, rhp, func, true);
874dad81a20SPaul E. McKenney }
875dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
876dad81a20SPaul E. McKenney 
877dad81a20SPaul E. McKenney /*
878dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
879dad81a20SPaul E. McKenney  */
8801e9a038bSPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *sp, bool do_norm)
881dad81a20SPaul E. McKenney {
882dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
883dad81a20SPaul E. McKenney 
884dad81a20SPaul E. McKenney 	RCU_LOCKDEP_WARN(lock_is_held(&sp->dep_map) ||
885dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
886dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
887dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
888dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
889dad81a20SPaul E. McKenney 
890dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
891dad81a20SPaul E. McKenney 		return;
892dad81a20SPaul E. McKenney 	might_sleep();
893da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
894dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
895da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
8961e9a038bSPaul E. McKenney 	__call_srcu(sp, &rcu.head, wakeme_after_rcu, do_norm);
897dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
898da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
899dad81a20SPaul E. McKenney }
900dad81a20SPaul E. McKenney 
901dad81a20SPaul E. McKenney /**
902dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
903dad81a20SPaul E. McKenney  * @sp: srcu_struct with which to synchronize.
904dad81a20SPaul E. McKenney  *
905dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
906dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
907dad81a20SPaul E. McKenney  *
908dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
909dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
910dad81a20SPaul E. McKenney  */
911dad81a20SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *sp)
912dad81a20SPaul E. McKenney {
9131e9a038bSPaul E. McKenney 	__synchronize_srcu(sp, rcu_gp_is_normal());
914dad81a20SPaul E. McKenney }
915dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
916dad81a20SPaul E. McKenney 
917dad81a20SPaul E. McKenney /**
918dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
919dad81a20SPaul E. McKenney  * @sp: srcu_struct with which to synchronize.
920dad81a20SPaul E. McKenney  *
921dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
922dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
923da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
924da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
925dad81a20SPaul E. McKenney  *
926dad81a20SPaul E. McKenney  * Can block; must be called from process context.
927dad81a20SPaul E. McKenney  *
928dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
929dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
930dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
931dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
932dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
933dad81a20SPaul E. McKenney  *
934dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
935dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
936dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
937dad81a20SPaul E. McKenney  * the end of its last corresponding SRCU-sched read-side critical section
938dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
939dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
940dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
941dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
942dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
943dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
944dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
945dad81a20SPaul E. McKenney  *
946dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
947dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
948dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
949dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
950dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
951dad81a20SPaul E. McKenney  *
952dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
953dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
954dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
9552da4b2a7SPaul E. McKenney  *
9562da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
9572da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
9582da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
9592da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
960dad81a20SPaul E. McKenney  */
961dad81a20SPaul E. McKenney void synchronize_srcu(struct srcu_struct *sp)
962dad81a20SPaul E. McKenney {
9632da4b2a7SPaul E. McKenney 	if (srcu_might_be_idle(sp) || rcu_gp_is_expedited())
964dad81a20SPaul E. McKenney 		synchronize_srcu_expedited(sp);
965dad81a20SPaul E. McKenney 	else
9661e9a038bSPaul E. McKenney 		__synchronize_srcu(sp, true);
967dad81a20SPaul E. McKenney }
968dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
969dad81a20SPaul E. McKenney 
970da915ad5SPaul E. McKenney /*
971da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
972da915ad5SPaul E. McKenney  */
973da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
974da915ad5SPaul E. McKenney {
975da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
976da915ad5SPaul E. McKenney 	struct srcu_struct *sp;
977da915ad5SPaul E. McKenney 
978da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
979da915ad5SPaul E. McKenney 	sp = sdp->sp;
980da915ad5SPaul E. McKenney 	if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt))
981da915ad5SPaul E. McKenney 		complete(&sp->srcu_barrier_completion);
982da915ad5SPaul E. McKenney }
983da915ad5SPaul E. McKenney 
984dad81a20SPaul E. McKenney /**
985dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
986dad81a20SPaul E. McKenney  * @sp: srcu_struct on which to wait for in-flight callbacks.
987dad81a20SPaul E. McKenney  */
988dad81a20SPaul E. McKenney void srcu_barrier(struct srcu_struct *sp)
989dad81a20SPaul E. McKenney {
990da915ad5SPaul E. McKenney 	int cpu;
991da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
992da915ad5SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&sp->srcu_barrier_seq);
993da915ad5SPaul E. McKenney 
994da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
995da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_barrier_mutex);
996da915ad5SPaul E. McKenney 	if (rcu_seq_done(&sp->srcu_barrier_seq, s)) {
997da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
998da915ad5SPaul E. McKenney 		mutex_unlock(&sp->srcu_barrier_mutex);
999da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1000da915ad5SPaul E. McKenney 	}
1001da915ad5SPaul E. McKenney 	rcu_seq_start(&sp->srcu_barrier_seq);
1002da915ad5SPaul E. McKenney 	init_completion(&sp->srcu_barrier_completion);
1003da915ad5SPaul E. McKenney 
1004da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1005da915ad5SPaul E. McKenney 	atomic_set(&sp->srcu_barrier_cpu_cnt, 1);
1006da915ad5SPaul E. McKenney 
1007da915ad5SPaul E. McKenney 	/*
1008da915ad5SPaul E. McKenney 	 * Each pass through this loop enqueues a callback, but only
1009da915ad5SPaul E. McKenney 	 * on CPUs already having callbacks enqueued.  Note that if
1010da915ad5SPaul E. McKenney 	 * a CPU already has callbacks enqueue, it must have already
1011da915ad5SPaul E. McKenney 	 * registered the need for a future grace period, so all we
1012da915ad5SPaul E. McKenney 	 * need do is enqueue a callback that will use the same
1013da915ad5SPaul E. McKenney 	 * grace period as the last callback already in the queue.
1014da915ad5SPaul E. McKenney 	 */
1015da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1016da915ad5SPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
1017a3883df3SPaul E. McKenney 		raw_spin_lock_irq_rcu_node(sdp);
1018da915ad5SPaul E. McKenney 		atomic_inc(&sp->srcu_barrier_cpu_cnt);
1019da915ad5SPaul E. McKenney 		sdp->srcu_barrier_head.func = srcu_barrier_cb;
1020a602538eSPaul E. McKenney 		debug_rcu_head_queue(&sdp->srcu_barrier_head);
1021da915ad5SPaul E. McKenney 		if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1022a602538eSPaul E. McKenney 					   &sdp->srcu_barrier_head, 0)) {
1023a602538eSPaul E. McKenney 			debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1024da915ad5SPaul E. McKenney 			atomic_dec(&sp->srcu_barrier_cpu_cnt);
1025a602538eSPaul E. McKenney 		}
1026a3883df3SPaul E. McKenney 		raw_spin_unlock_irq_rcu_node(sdp);
1027da915ad5SPaul E. McKenney 	}
1028da915ad5SPaul E. McKenney 
1029da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1030da915ad5SPaul E. McKenney 	if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt))
1031da915ad5SPaul E. McKenney 		complete(&sp->srcu_barrier_completion);
1032da915ad5SPaul E. McKenney 	wait_for_completion(&sp->srcu_barrier_completion);
1033da915ad5SPaul E. McKenney 
1034da915ad5SPaul E. McKenney 	rcu_seq_end(&sp->srcu_barrier_seq);
1035da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_barrier_mutex);
1036dad81a20SPaul E. McKenney }
1037dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1038dad81a20SPaul E. McKenney 
1039dad81a20SPaul E. McKenney /**
1040dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1041dad81a20SPaul E. McKenney  * @sp: srcu_struct on which to report batch completion.
1042dad81a20SPaul E. McKenney  *
1043dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1044dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1045dad81a20SPaul E. McKenney  */
1046dad81a20SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *sp)
1047dad81a20SPaul E. McKenney {
1048da915ad5SPaul E. McKenney 	return sp->srcu_idx;
1049dad81a20SPaul E. McKenney }
1050dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1051dad81a20SPaul E. McKenney 
1052dad81a20SPaul E. McKenney /*
1053da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1054da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1055da915ad5SPaul E. McKenney  * completed in that state.
1056dad81a20SPaul E. McKenney  */
1057da915ad5SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *sp)
1058dad81a20SPaul E. McKenney {
1059dad81a20SPaul E. McKenney 	int idx;
1060dad81a20SPaul E. McKenney 
1061da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_gp_mutex);
1062da915ad5SPaul E. McKenney 
1063dad81a20SPaul E. McKenney 	/*
1064dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1065da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1066dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1067dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1068dad81a20SPaul E. McKenney 	 * invoking a callback.
1069dad81a20SPaul E. McKenney 	 *
1070dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1071dad81a20SPaul E. McKenney 	 * by the prior grace period.
1072dad81a20SPaul E. McKenney 	 */
1073dad81a20SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq)); /* ^^^ */
1074dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1075a3883df3SPaul E. McKenney 		raw_spin_lock_irq_rcu_node(sp);
1076da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) {
1077da915ad5SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq));
1078a3883df3SPaul E. McKenney 			raw_spin_unlock_irq_rcu_node(sp);
1079da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1080dad81a20SPaul E. McKenney 			return;
1081dad81a20SPaul E. McKenney 		}
1082dad81a20SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq));
1083dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1084dad81a20SPaul E. McKenney 			srcu_gp_start(sp);
1085a3883df3SPaul E. McKenney 		raw_spin_unlock_irq_rcu_node(sp);
1086da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1087da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1088dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1089dad81a20SPaul E. McKenney 		}
1090da915ad5SPaul E. McKenney 	}
1091dad81a20SPaul E. McKenney 
1092dad81a20SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1093da915ad5SPaul E. McKenney 		idx = 1 ^ (sp->srcu_idx & 1);
1094da915ad5SPaul E. McKenney 		if (!try_check_zero(sp, idx, 1)) {
1095da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1096dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1097da915ad5SPaul E. McKenney 		}
1098dad81a20SPaul E. McKenney 		srcu_flip(sp);
1099dad81a20SPaul E. McKenney 		rcu_seq_set_state(&sp->srcu_gp_seq, SRCU_STATE_SCAN2);
1100dad81a20SPaul E. McKenney 	}
1101dad81a20SPaul E. McKenney 
1102dad81a20SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1103dad81a20SPaul E. McKenney 
1104dad81a20SPaul E. McKenney 		/*
1105dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1106dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1107dad81a20SPaul E. McKenney 		 */
1108da915ad5SPaul E. McKenney 		idx = 1 ^ (sp->srcu_idx & 1);
1109da915ad5SPaul E. McKenney 		if (!try_check_zero(sp, idx, 2)) {
1110da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1111da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1112da915ad5SPaul E. McKenney 		}
1113da915ad5SPaul E. McKenney 		srcu_gp_end(sp);  /* Releases ->srcu_gp_mutex. */
1114dad81a20SPaul E. McKenney 	}
1115dad81a20SPaul E. McKenney }
1116dad81a20SPaul E. McKenney 
1117dad81a20SPaul E. McKenney /*
1118dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1119dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1120dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1121dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1122dad81a20SPaul E. McKenney  */
1123da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1124dad81a20SPaul E. McKenney {
1125da915ad5SPaul E. McKenney 	bool more;
1126dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1127dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1128da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1129da915ad5SPaul E. McKenney 	struct srcu_struct *sp;
1130dad81a20SPaul E. McKenney 
1131da915ad5SPaul E. McKenney 	sdp = container_of(work, struct srcu_data, work.work);
1132da915ad5SPaul E. McKenney 	sp = sdp->sp;
1133dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1134a3883df3SPaul E. McKenney 	raw_spin_lock_irq_rcu_node(sdp);
1135da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1136da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
1137da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1138da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1139a3883df3SPaul E. McKenney 		raw_spin_unlock_irq_rcu_node(sdp);
1140da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1141da915ad5SPaul E. McKenney 	}
1142da915ad5SPaul E. McKenney 
1143da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1144da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1145da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1146a3883df3SPaul E. McKenney 	raw_spin_unlock_irq_rcu_node(sdp);
1147dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1148dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1149a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1150dad81a20SPaul E. McKenney 		local_bh_disable();
1151dad81a20SPaul E. McKenney 		rhp->func(rhp);
1152dad81a20SPaul E. McKenney 		local_bh_enable();
1153dad81a20SPaul E. McKenney 	}
1154da915ad5SPaul E. McKenney 
1155da915ad5SPaul E. McKenney 	/*
1156da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1157da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1158da915ad5SPaul E. McKenney 	 */
1159a3883df3SPaul E. McKenney 	raw_spin_lock_irq_rcu_node(sdp);
1160da915ad5SPaul E. McKenney 	rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1161da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1162da915ad5SPaul E. McKenney 				       rcu_seq_snap(&sp->srcu_gp_seq));
1163da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1164da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1165a3883df3SPaul E. McKenney 	raw_spin_unlock_irq_rcu_node(sdp);
1166da915ad5SPaul E. McKenney 	if (more)
1167da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1168dad81a20SPaul E. McKenney }
1169dad81a20SPaul E. McKenney 
1170dad81a20SPaul E. McKenney /*
1171dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1172dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1173dad81a20SPaul E. McKenney  */
1174dad81a20SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay)
1175dad81a20SPaul E. McKenney {
1176da915ad5SPaul E. McKenney 	bool pushgp = true;
1177dad81a20SPaul E. McKenney 
1178a3883df3SPaul E. McKenney 	raw_spin_lock_irq_rcu_node(sp);
1179da915ad5SPaul E. McKenney 	if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) {
1180da915ad5SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq))) {
1181da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1182da915ad5SPaul E. McKenney 			pushgp = false;
1183dad81a20SPaul E. McKenney 		}
1184da915ad5SPaul E. McKenney 	} else if (!rcu_seq_state(sp->srcu_gp_seq)) {
1185da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1186da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
1187da915ad5SPaul E. McKenney 	}
1188a3883df3SPaul E. McKenney 	raw_spin_unlock_irq_rcu_node(sp);
1189dad81a20SPaul E. McKenney 
1190da915ad5SPaul E. McKenney 	if (pushgp)
1191dad81a20SPaul E. McKenney 		queue_delayed_work(system_power_efficient_wq, &sp->work, delay);
1192dad81a20SPaul E. McKenney }
1193dad81a20SPaul E. McKenney 
1194dad81a20SPaul E. McKenney /*
1195dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1196dad81a20SPaul E. McKenney  */
1197dad81a20SPaul E. McKenney void process_srcu(struct work_struct *work)
1198dad81a20SPaul E. McKenney {
1199dad81a20SPaul E. McKenney 	struct srcu_struct *sp;
1200dad81a20SPaul E. McKenney 
1201dad81a20SPaul E. McKenney 	sp = container_of(work, struct srcu_struct, work.work);
1202dad81a20SPaul E. McKenney 
1203da915ad5SPaul E. McKenney 	srcu_advance_state(sp);
12041e9a038bSPaul E. McKenney 	srcu_reschedule(sp, srcu_get_delay(sp));
1205dad81a20SPaul E. McKenney }
1206dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(process_srcu);
12077f6733c3SPaul E. McKenney 
12087f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
12097f6733c3SPaul E. McKenney 			     struct srcu_struct *sp, int *flags,
12101e9a038bSPaul E. McKenney 			     unsigned long *gpnum, unsigned long *completed)
12117f6733c3SPaul E. McKenney {
12127f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
12137f6733c3SPaul E. McKenney 		return;
12147f6733c3SPaul E. McKenney 	*flags = 0;
12157f6733c3SPaul E. McKenney 	*completed = rcu_seq_ctr(sp->srcu_gp_seq);
12167f6733c3SPaul E. McKenney 	*gpnum = rcu_seq_ctr(sp->srcu_gp_seq_needed);
12177f6733c3SPaul E. McKenney }
12187f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
12191f4f6da1SPaul E. McKenney 
1220115a1a52SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *sp, char *tt, char *tf)
1221115a1a52SPaul E. McKenney {
1222115a1a52SPaul E. McKenney 	int cpu;
1223115a1a52SPaul E. McKenney 	int idx;
1224*ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1225115a1a52SPaul E. McKenney 
1226115a1a52SPaul E. McKenney 	idx = sp->srcu_idx & 0x1;
1227115a1a52SPaul E. McKenney 	pr_alert("%s%s Tree SRCU per-CPU(idx=%d):", tt, tf, idx);
1228115a1a52SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1229115a1a52SPaul E. McKenney 		unsigned long l0, l1;
1230115a1a52SPaul E. McKenney 		unsigned long u0, u1;
1231115a1a52SPaul E. McKenney 		long c0, c1;
1232115a1a52SPaul E. McKenney 		struct srcu_data *counts;
1233115a1a52SPaul E. McKenney 
1234115a1a52SPaul E. McKenney 		counts = per_cpu_ptr(sp->sda, cpu);
1235115a1a52SPaul E. McKenney 		u0 = counts->srcu_unlock_count[!idx];
1236115a1a52SPaul E. McKenney 		u1 = counts->srcu_unlock_count[idx];
1237115a1a52SPaul E. McKenney 
1238115a1a52SPaul E. McKenney 		/*
1239115a1a52SPaul E. McKenney 		 * Make sure that a lock is always counted if the corresponding
1240115a1a52SPaul E. McKenney 		 * unlock is counted.
1241115a1a52SPaul E. McKenney 		 */
1242115a1a52SPaul E. McKenney 		smp_rmb();
1243115a1a52SPaul E. McKenney 
1244115a1a52SPaul E. McKenney 		l0 = counts->srcu_lock_count[!idx];
1245115a1a52SPaul E. McKenney 		l1 = counts->srcu_lock_count[idx];
1246115a1a52SPaul E. McKenney 
1247115a1a52SPaul E. McKenney 		c0 = l0 - u0;
1248115a1a52SPaul E. McKenney 		c1 = l1 - u1;
1249115a1a52SPaul E. McKenney 		pr_cont(" %d(%ld,%ld)", cpu, c0, c1);
1250*ac3748c6SPaul E. McKenney 		s0 += c0;
1251*ac3748c6SPaul E. McKenney 		s1 += c1;
1252115a1a52SPaul E. McKenney 	}
1253*ac3748c6SPaul E. McKenney 	pr_cont(" T(%ld,%ld)\n", s0, s1);
1254115a1a52SPaul E. McKenney }
1255115a1a52SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1256115a1a52SPaul E. McKenney 
12571f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void)
12581f4f6da1SPaul E. McKenney {
12591f4f6da1SPaul E. McKenney 	pr_info("Hierarchical SRCU implementation.\n");
12600c8e0e3cSPaul E. McKenney 	if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
12610c8e0e3cSPaul E. McKenney 		pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
12621f4f6da1SPaul E. McKenney 	return 0;
12631f4f6da1SPaul E. McKenney }
12641f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce);
1265