xref: /linux-6.15/kernel/rcu/srcutree.c (revision 0607ba84)
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 
29a7538352SJoe Perches #define pr_fmt(fmt) "rcu: " fmt
30a7538352SJoe Perches 
31dad81a20SPaul E. McKenney #include <linux/export.h>
32dad81a20SPaul E. McKenney #include <linux/mutex.h>
33dad81a20SPaul E. McKenney #include <linux/percpu.h>
34dad81a20SPaul E. McKenney #include <linux/preempt.h>
35dad81a20SPaul E. McKenney #include <linux/rcupdate_wait.h>
36dad81a20SPaul E. McKenney #include <linux/sched.h>
37dad81a20SPaul E. McKenney #include <linux/smp.h>
38dad81a20SPaul E. McKenney #include <linux/delay.h>
3922607d66SPaul E. McKenney #include <linux/module.h>
40dad81a20SPaul E. McKenney #include <linux/srcu.h>
41dad81a20SPaul E. McKenney 
42dad81a20SPaul E. McKenney #include "rcu.h"
4345753c5fSIngo Molnar #include "rcu_segcblist.h"
44dad81a20SPaul E. McKenney 
450c8e0e3cSPaul E. McKenney /* Holdoff in nanoseconds for auto-expediting. */
460c8e0e3cSPaul E. McKenney #define DEFAULT_SRCU_EXP_HOLDOFF (25 * 1000)
470c8e0e3cSPaul E. McKenney static ulong exp_holdoff = DEFAULT_SRCU_EXP_HOLDOFF;
4822607d66SPaul E. McKenney module_param(exp_holdoff, ulong, 0444);
4922607d66SPaul E. McKenney 
50c350c008SPaul E. McKenney /* Overflow-check frequency.  N bits roughly says every 2**N grace periods. */
51c350c008SPaul E. McKenney static ulong counter_wrap_check = (ULONG_MAX >> 2);
52c350c008SPaul E. McKenney module_param(counter_wrap_check, ulong, 0444);
53c350c008SPaul E. McKenney 
54e0fcba9aSPaul E. McKenney /* Early-boot callback-management, so early that no lock is required! */
55e0fcba9aSPaul E. McKenney static LIST_HEAD(srcu_boot_list);
56e0fcba9aSPaul E. McKenney static bool __read_mostly srcu_init_done;
57e0fcba9aSPaul E. McKenney 
58da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work);
59da915ad5SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay);
600d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work);
61da915ad5SPaul E. McKenney 
62d6331980SPaul E. McKenney /* Wrappers for lock acquisition and release, see raw_spin_lock_rcu_node(). */
63d6331980SPaul E. McKenney #define spin_lock_rcu_node(p)					\
64d6331980SPaul E. McKenney do {									\
65d6331980SPaul E. McKenney 	spin_lock(&ACCESS_PRIVATE(p, lock));			\
66d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
67d6331980SPaul E. McKenney } while (0)
68d6331980SPaul E. McKenney 
69d6331980SPaul E. McKenney #define spin_unlock_rcu_node(p) spin_unlock(&ACCESS_PRIVATE(p, lock))
70d6331980SPaul E. McKenney 
71d6331980SPaul E. McKenney #define spin_lock_irq_rcu_node(p)					\
72d6331980SPaul E. McKenney do {									\
73d6331980SPaul E. McKenney 	spin_lock_irq(&ACCESS_PRIVATE(p, lock));			\
74d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
75d6331980SPaul E. McKenney } while (0)
76d6331980SPaul E. McKenney 
77d6331980SPaul E. McKenney #define spin_unlock_irq_rcu_node(p)					\
78d6331980SPaul E. McKenney 	spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
79d6331980SPaul E. McKenney 
80d6331980SPaul E. McKenney #define spin_lock_irqsave_rcu_node(p, flags)			\
81d6331980SPaul E. McKenney do {									\
82d6331980SPaul E. McKenney 	spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags);	\
83d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
84d6331980SPaul E. McKenney } while (0)
85d6331980SPaul E. McKenney 
86d6331980SPaul E. McKenney #define spin_unlock_irqrestore_rcu_node(p, flags)			\
87d6331980SPaul E. McKenney 	spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags)	\
88d6331980SPaul E. McKenney 
89da915ad5SPaul E. McKenney /*
90da915ad5SPaul E. McKenney  * Initialize SRCU combining tree.  Note that statically allocated
91da915ad5SPaul E. McKenney  * srcu_struct structures might already have srcu_read_lock() and
92da915ad5SPaul E. McKenney  * srcu_read_unlock() running against them.  So if the is_static parameter
93da915ad5SPaul E. McKenney  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
94da915ad5SPaul E. McKenney  */
95da915ad5SPaul E. McKenney static void init_srcu_struct_nodes(struct srcu_struct *sp, bool is_static)
96dad81a20SPaul E. McKenney {
97da915ad5SPaul E. McKenney 	int cpu;
98da915ad5SPaul E. McKenney 	int i;
99da915ad5SPaul E. McKenney 	int level = 0;
100da915ad5SPaul E. McKenney 	int levelspread[RCU_NUM_LVLS];
101da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
102da915ad5SPaul E. McKenney 	struct srcu_node *snp;
103da915ad5SPaul E. McKenney 	struct srcu_node *snp_first;
104da915ad5SPaul E. McKenney 
105da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
106da915ad5SPaul E. McKenney 	sp->level[0] = &sp->node[0];
107da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
108da915ad5SPaul E. McKenney 		sp->level[i] = sp->level[i - 1] + num_rcu_lvl[i - 1];
109da915ad5SPaul E. McKenney 	rcu_init_levelspread(levelspread, num_rcu_lvl);
110da915ad5SPaul E. McKenney 
111da915ad5SPaul E. McKenney 	/* Each pass through this loop initializes one srcu_node structure. */
112aedf4ba9SPaul E. McKenney 	srcu_for_each_node_breadth_first(sp, snp) {
113d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(snp, lock));
114c7e88067SPaul E. McKenney 		WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
115c7e88067SPaul E. McKenney 			     ARRAY_SIZE(snp->srcu_data_have_cbs));
116c7e88067SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
117da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[i] = 0;
118c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[i] = 0;
119c7e88067SPaul E. McKenney 		}
1201e9a038bSPaul E. McKenney 		snp->srcu_gp_seq_needed_exp = 0;
121da915ad5SPaul E. McKenney 		snp->grplo = -1;
122da915ad5SPaul E. McKenney 		snp->grphi = -1;
123da915ad5SPaul E. McKenney 		if (snp == &sp->node[0]) {
124da915ad5SPaul E. McKenney 			/* Root node, special case. */
125da915ad5SPaul E. McKenney 			snp->srcu_parent = NULL;
126da915ad5SPaul E. McKenney 			continue;
127da915ad5SPaul E. McKenney 		}
128da915ad5SPaul E. McKenney 
129da915ad5SPaul E. McKenney 		/* Non-root node. */
130da915ad5SPaul E. McKenney 		if (snp == sp->level[level + 1])
131da915ad5SPaul E. McKenney 			level++;
132da915ad5SPaul E. McKenney 		snp->srcu_parent = sp->level[level - 1] +
133da915ad5SPaul E. McKenney 				   (snp - sp->level[level]) /
134da915ad5SPaul E. McKenney 				   levelspread[level - 1];
135da915ad5SPaul E. McKenney 	}
136da915ad5SPaul E. McKenney 
137da915ad5SPaul E. McKenney 	/*
138da915ad5SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
139da915ad5SPaul E. McKenney 	 * leaves of the srcu_node tree.
140da915ad5SPaul E. McKenney 	 */
141da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
142da915ad5SPaul E. McKenney 		     ARRAY_SIZE(sdp->srcu_unlock_count));
143da915ad5SPaul E. McKenney 	level = rcu_num_lvls - 1;
144da915ad5SPaul E. McKenney 	snp_first = sp->level[level];
145da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
146da915ad5SPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
147d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
148da915ad5SPaul E. McKenney 		rcu_segcblist_init(&sdp->srcu_cblist);
149da915ad5SPaul E. McKenney 		sdp->srcu_cblist_invoking = false;
150da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = sp->srcu_gp_seq;
1511e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = sp->srcu_gp_seq;
152da915ad5SPaul E. McKenney 		sdp->mynode = &snp_first[cpu / levelspread[level]];
153da915ad5SPaul E. McKenney 		for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
154da915ad5SPaul E. McKenney 			if (snp->grplo < 0)
155da915ad5SPaul E. McKenney 				snp->grplo = cpu;
156da915ad5SPaul E. McKenney 			snp->grphi = cpu;
157da915ad5SPaul E. McKenney 		}
158da915ad5SPaul E. McKenney 		sdp->cpu = cpu;
159da915ad5SPaul E. McKenney 		INIT_DELAYED_WORK(&sdp->work, srcu_invoke_callbacks);
160da915ad5SPaul E. McKenney 		sdp->sp = sp;
161c7e88067SPaul E. McKenney 		sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
162da915ad5SPaul E. McKenney 		if (is_static)
163da915ad5SPaul E. McKenney 			continue;
164da915ad5SPaul E. McKenney 
165da915ad5SPaul E. McKenney 		/* Dynamically allocated, better be no srcu_read_locks()! */
166da915ad5SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) {
167da915ad5SPaul E. McKenney 			sdp->srcu_lock_count[i] = 0;
168da915ad5SPaul E. McKenney 			sdp->srcu_unlock_count[i] = 0;
169da915ad5SPaul E. McKenney 		}
170da915ad5SPaul E. McKenney 	}
171da915ad5SPaul E. McKenney }
172da915ad5SPaul E. McKenney 
173da915ad5SPaul E. McKenney /*
174da915ad5SPaul E. McKenney  * Initialize non-compile-time initialized fields, including the
175da915ad5SPaul E. McKenney  * associated srcu_node and srcu_data structures.  The is_static
176da915ad5SPaul E. McKenney  * parameter is passed through to init_srcu_struct_nodes(), and
177da915ad5SPaul E. McKenney  * also tells us that ->sda has already been wired up to srcu_data.
178da915ad5SPaul E. McKenney  */
179da915ad5SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *sp, bool is_static)
180da915ad5SPaul E. McKenney {
181da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_cb_mutex);
182da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_gp_mutex);
183da915ad5SPaul E. McKenney 	sp->srcu_idx = 0;
184dad81a20SPaul E. McKenney 	sp->srcu_gp_seq = 0;
185da915ad5SPaul E. McKenney 	sp->srcu_barrier_seq = 0;
186da915ad5SPaul E. McKenney 	mutex_init(&sp->srcu_barrier_mutex);
187da915ad5SPaul E. McKenney 	atomic_set(&sp->srcu_barrier_cpu_cnt, 0);
188dad81a20SPaul E. McKenney 	INIT_DELAYED_WORK(&sp->work, process_srcu);
189da915ad5SPaul E. McKenney 	if (!is_static)
190da915ad5SPaul E. McKenney 		sp->sda = alloc_percpu(struct srcu_data);
191da915ad5SPaul E. McKenney 	init_srcu_struct_nodes(sp, is_static);
1921e9a038bSPaul E. McKenney 	sp->srcu_gp_seq_needed_exp = 0;
19322607d66SPaul E. McKenney 	sp->srcu_last_gp_end = ktime_get_mono_fast_ns();
194da915ad5SPaul E. McKenney 	smp_store_release(&sp->srcu_gp_seq_needed, 0); /* Init done. */
195da915ad5SPaul E. McKenney 	return sp->sda ? 0 : -ENOMEM;
196dad81a20SPaul E. McKenney }
197dad81a20SPaul E. McKenney 
198dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
199dad81a20SPaul E. McKenney 
200dad81a20SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *sp, const char *name,
201dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
202dad81a20SPaul E. McKenney {
203dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
204dad81a20SPaul E. McKenney 	debug_check_no_locks_freed((void *)sp, sizeof(*sp));
205dad81a20SPaul E. McKenney 	lockdep_init_map(&sp->dep_map, name, key, 0);
206d6331980SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(sp, lock));
207da915ad5SPaul E. McKenney 	return init_srcu_struct_fields(sp, false);
208dad81a20SPaul E. McKenney }
209dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
210dad81a20SPaul E. McKenney 
211dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
212dad81a20SPaul E. McKenney 
213dad81a20SPaul E. McKenney /**
214dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
215dad81a20SPaul E. McKenney  * @sp: structure to initialize.
216dad81a20SPaul E. McKenney  *
217dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
218dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
219dad81a20SPaul E. McKenney  * of SRCU protection.
220dad81a20SPaul E. McKenney  */
221dad81a20SPaul E. McKenney int init_srcu_struct(struct srcu_struct *sp)
222dad81a20SPaul E. McKenney {
223d6331980SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(sp, lock));
224da915ad5SPaul E. McKenney 	return init_srcu_struct_fields(sp, false);
225dad81a20SPaul E. McKenney }
226dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
227dad81a20SPaul E. McKenney 
228dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
229dad81a20SPaul E. McKenney 
230dad81a20SPaul E. McKenney /*
231da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
232da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
233da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
234a3883df3SPaul E. McKenney  * to each update-side SRCU primitive.  Use sp->lock, which -is-
235da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
236da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
237da915ad5SPaul E. McKenney  */
238da915ad5SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *sp)
239da915ad5SPaul E. McKenney {
240da915ad5SPaul E. McKenney 	unsigned long flags;
241da915ad5SPaul E. McKenney 
242da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
243da915ad5SPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq_needed))) /*^^^*/
244da915ad5SPaul E. McKenney 		return; /* Already initialized. */
245d6331980SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sp, flags);
246da915ad5SPaul E. McKenney 	if (!rcu_seq_state(sp->srcu_gp_seq_needed)) {
247d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(sp, flags);
248da915ad5SPaul E. McKenney 		return;
249da915ad5SPaul E. McKenney 	}
250da915ad5SPaul E. McKenney 	init_srcu_struct_fields(sp, true);
251d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sp, flags);
252da915ad5SPaul E. McKenney }
253da915ad5SPaul E. McKenney 
254da915ad5SPaul E. McKenney /*
255da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
256da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
257dad81a20SPaul E. McKenney  */
258dad81a20SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *sp, int idx)
259dad81a20SPaul E. McKenney {
260dad81a20SPaul E. McKenney 	int cpu;
261dad81a20SPaul E. McKenney 	unsigned long sum = 0;
262dad81a20SPaul E. McKenney 
263dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
264da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
265dad81a20SPaul E. McKenney 
266da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[idx]);
267dad81a20SPaul E. McKenney 	}
268dad81a20SPaul E. McKenney 	return sum;
269dad81a20SPaul E. McKenney }
270dad81a20SPaul E. McKenney 
271dad81a20SPaul E. McKenney /*
272da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
273da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
274dad81a20SPaul E. McKenney  */
275dad81a20SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *sp, int idx)
276dad81a20SPaul E. McKenney {
277dad81a20SPaul E. McKenney 	int cpu;
278dad81a20SPaul E. McKenney 	unsigned long sum = 0;
279dad81a20SPaul E. McKenney 
280dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
281da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
282dad81a20SPaul E. McKenney 
283da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_unlock_count[idx]);
284dad81a20SPaul E. McKenney 	}
285dad81a20SPaul E. McKenney 	return sum;
286dad81a20SPaul E. McKenney }
287dad81a20SPaul E. McKenney 
288dad81a20SPaul E. McKenney /*
289dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
290dad81a20SPaul E. McKenney  * be zero.
291dad81a20SPaul E. McKenney  */
292dad81a20SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *sp, int idx)
293dad81a20SPaul E. McKenney {
294dad81a20SPaul E. McKenney 	unsigned long unlocks;
295dad81a20SPaul E. McKenney 
296dad81a20SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(sp, idx);
297dad81a20SPaul E. McKenney 
298dad81a20SPaul E. McKenney 	/*
299dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
300dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
301dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
302dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
303dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
304dad81a20SPaul E. McKenney 	 *
305dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
306dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
307dad81a20SPaul E. McKenney 	 * grace period ends.
308dad81a20SPaul E. McKenney 	 */
309dad81a20SPaul E. McKenney 	smp_mb(); /* A */
310dad81a20SPaul E. McKenney 
311dad81a20SPaul E. McKenney 	/*
312dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
313dad81a20SPaul E. McKenney 	 * been no readers on this index at some time in between. This does
314dad81a20SPaul E. McKenney 	 * not mean that there are no more readers, as one could have read
315dad81a20SPaul E. McKenney 	 * the current index but not have incremented the lock counter yet.
316dad81a20SPaul E. McKenney 	 *
317881ec9d2SPaul E. McKenney 	 * So suppose that the updater is preempted here for so long
318881ec9d2SPaul E. McKenney 	 * that more than ULONG_MAX non-nested readers come and go in
319881ec9d2SPaul E. McKenney 	 * the meantime.  It turns out that this cannot result in overflow
320881ec9d2SPaul E. McKenney 	 * because if a reader modifies its unlock count after we read it
321881ec9d2SPaul E. McKenney 	 * above, then that reader's next load of ->srcu_idx is guaranteed
322881ec9d2SPaul E. McKenney 	 * to get the new value, which will cause it to operate on the
323881ec9d2SPaul E. McKenney 	 * other bank of counters, where it cannot contribute to the
324881ec9d2SPaul E. McKenney 	 * overflow of these counters.  This means that there is a maximum
325881ec9d2SPaul E. McKenney 	 * of 2*NR_CPUS increments, which cannot overflow given current
326881ec9d2SPaul E. McKenney 	 * systems, especially not on 64-bit systems.
327881ec9d2SPaul E. McKenney 	 *
328881ec9d2SPaul E. McKenney 	 * OK, how about nesting?  This does impose a limit on nesting
329881ec9d2SPaul E. McKenney 	 * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
330881ec9d2SPaul E. McKenney 	 * especially on 64-bit systems.
331dad81a20SPaul E. McKenney 	 */
332dad81a20SPaul E. McKenney 	return srcu_readers_lock_idx(sp, idx) == unlocks;
333dad81a20SPaul E. McKenney }
334dad81a20SPaul E. McKenney 
335dad81a20SPaul E. McKenney /**
336dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
337dad81a20SPaul E. McKenney  *                       otherwise
338dad81a20SPaul E. McKenney  * @sp: which srcu_struct to count active readers (holding srcu_read_lock).
339dad81a20SPaul E. McKenney  *
340dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
341dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
342dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
343dad81a20SPaul E. McKenney  */
344dad81a20SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *sp)
345dad81a20SPaul E. McKenney {
346dad81a20SPaul E. McKenney 	int cpu;
347dad81a20SPaul E. McKenney 	unsigned long sum = 0;
348dad81a20SPaul E. McKenney 
349dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
350da915ad5SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu);
351dad81a20SPaul E. McKenney 
352da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[0]);
353da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[1]);
354da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[0]);
355da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[1]);
356dad81a20SPaul E. McKenney 	}
357dad81a20SPaul E. McKenney 	return sum;
358dad81a20SPaul E. McKenney }
359dad81a20SPaul E. McKenney 
360dad81a20SPaul E. McKenney #define SRCU_INTERVAL		1
361dad81a20SPaul E. McKenney 
3621e9a038bSPaul E. McKenney /*
3631e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
3641e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
3651e9a038bSPaul E. McKenney  */
3661e9a038bSPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *sp)
3671e9a038bSPaul E. McKenney {
3681e9a038bSPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(sp->srcu_gp_seq),
3691e9a038bSPaul E. McKenney 			 READ_ONCE(sp->srcu_gp_seq_needed_exp)))
3701e9a038bSPaul E. McKenney 		return 0;
3711e9a038bSPaul E. McKenney 	return SRCU_INTERVAL;
3721e9a038bSPaul E. McKenney }
3731e9a038bSPaul E. McKenney 
374f7194ac3SPaul E. McKenney /* Helper for cleanup_srcu_struct() and cleanup_srcu_struct_quiesced(). */
375f7194ac3SPaul E. McKenney void _cleanup_srcu_struct(struct srcu_struct *sp, bool quiesced)
376dad81a20SPaul E. McKenney {
377da915ad5SPaul E. McKenney 	int cpu;
378da915ad5SPaul E. McKenney 
3791e9a038bSPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(sp)))
380f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
381dad81a20SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(sp)))
382f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
383f7194ac3SPaul E. McKenney 	if (quiesced) {
384f7194ac3SPaul E. McKenney 		if (WARN_ON(delayed_work_pending(&sp->work)))
385f7194ac3SPaul E. McKenney 			return; /* Just leak it! */
386f7194ac3SPaul E. McKenney 	} else {
387dad81a20SPaul E. McKenney 		flush_delayed_work(&sp->work);
388f7194ac3SPaul E. McKenney 	}
389da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu)
390f7194ac3SPaul E. McKenney 		if (quiesced) {
391f7194ac3SPaul E. McKenney 			if (WARN_ON(delayed_work_pending(&per_cpu_ptr(sp->sda, cpu)->work)))
392f7194ac3SPaul E. McKenney 				return; /* Just leak it! */
393f7194ac3SPaul E. McKenney 		} else {
394da915ad5SPaul E. McKenney 			flush_delayed_work(&per_cpu_ptr(sp->sda, cpu)->work);
395f7194ac3SPaul E. McKenney 		}
396da915ad5SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
397da915ad5SPaul E. McKenney 	    WARN_ON(srcu_readers_active(sp))) {
398a7538352SJoe Perches 		pr_info("%s: Active srcu_struct %p state: %d\n",
399a7538352SJoe Perches 			__func__, sp, rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)));
400dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
401dad81a20SPaul E. McKenney 	}
402da915ad5SPaul E. McKenney 	free_percpu(sp->sda);
403da915ad5SPaul E. McKenney 	sp->sda = NULL;
404dad81a20SPaul E. McKenney }
405f7194ac3SPaul E. McKenney EXPORT_SYMBOL_GPL(_cleanup_srcu_struct);
406dad81a20SPaul E. McKenney 
407dad81a20SPaul E. McKenney /*
408dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
409cdf7abc4SPaolo Bonzini  * srcu_struct.
410dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
411dad81a20SPaul E. McKenney  */
412dad81a20SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *sp)
413dad81a20SPaul E. McKenney {
414dad81a20SPaul E. McKenney 	int idx;
415dad81a20SPaul E. McKenney 
416da915ad5SPaul E. McKenney 	idx = READ_ONCE(sp->srcu_idx) & 0x1;
417cdf7abc4SPaolo Bonzini 	this_cpu_inc(sp->sda->srcu_lock_count[idx]);
418dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
419dad81a20SPaul E. McKenney 	return idx;
420dad81a20SPaul E. McKenney }
421dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
422dad81a20SPaul E. McKenney 
423dad81a20SPaul E. McKenney /*
424dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
425dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
426dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
427dad81a20SPaul E. McKenney  */
428dad81a20SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *sp, int idx)
429dad81a20SPaul E. McKenney {
430dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
431da915ad5SPaul E. McKenney 	this_cpu_inc(sp->sda->srcu_unlock_count[idx]);
432dad81a20SPaul E. McKenney }
433dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
434dad81a20SPaul E. McKenney 
435dad81a20SPaul E. McKenney /*
436dad81a20SPaul E. McKenney  * We use an adaptive strategy for synchronize_srcu() and especially for
437dad81a20SPaul E. McKenney  * synchronize_srcu_expedited().  We spin for a fixed time period
438dad81a20SPaul E. McKenney  * (defined below) to allow SRCU readers to exit their read-side critical
439dad81a20SPaul E. McKenney  * sections.  If there are still some readers after a few microseconds,
440dad81a20SPaul E. McKenney  * we repeatedly block for 1-millisecond time periods.
441dad81a20SPaul E. McKenney  */
442dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY		5
443dad81a20SPaul E. McKenney 
444dad81a20SPaul E. McKenney /*
445dad81a20SPaul E. McKenney  * Start an SRCU grace period.
446dad81a20SPaul E. McKenney  */
447dad81a20SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *sp)
448dad81a20SPaul E. McKenney {
449da915ad5SPaul E. McKenney 	struct srcu_data *sdp = this_cpu_ptr(sp->sda);
450dad81a20SPaul E. McKenney 	int state;
451dad81a20SPaul E. McKenney 
452a32e01eeSMatthew Wilcox 	lockdep_assert_held(&ACCESS_PRIVATE(sp, lock));
453da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed));
454da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
455da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
456da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
457dad81a20SPaul E. McKenney 				       rcu_seq_snap(&sp->srcu_gp_seq));
4582da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
459dad81a20SPaul E. McKenney 	rcu_seq_start(&sp->srcu_gp_seq);
460dad81a20SPaul E. McKenney 	state = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq));
461dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
462dad81a20SPaul E. McKenney }
463dad81a20SPaul E. McKenney 
464dad81a20SPaul E. McKenney /*
465da915ad5SPaul E. McKenney  * Track online CPUs to guide callback workqueue placement.
466da915ad5SPaul E. McKenney  */
467da915ad5SPaul E. McKenney DEFINE_PER_CPU(bool, srcu_online);
468da915ad5SPaul E. McKenney 
469da915ad5SPaul E. McKenney void srcu_online_cpu(unsigned int cpu)
470da915ad5SPaul E. McKenney {
471da915ad5SPaul E. McKenney 	WRITE_ONCE(per_cpu(srcu_online, cpu), true);
472da915ad5SPaul E. McKenney }
473da915ad5SPaul E. McKenney 
474da915ad5SPaul E. McKenney void srcu_offline_cpu(unsigned int cpu)
475da915ad5SPaul E. McKenney {
476da915ad5SPaul E. McKenney 	WRITE_ONCE(per_cpu(srcu_online, cpu), false);
477da915ad5SPaul E. McKenney }
478da915ad5SPaul E. McKenney 
479da915ad5SPaul E. McKenney /*
480da915ad5SPaul E. McKenney  * Place the workqueue handler on the specified CPU if online, otherwise
481da915ad5SPaul E. McKenney  * just run it whereever.  This is useful for placing workqueue handlers
482da915ad5SPaul E. McKenney  * that are to invoke the specified CPU's callbacks.
483da915ad5SPaul E. McKenney  */
484da915ad5SPaul E. McKenney static bool srcu_queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
485da915ad5SPaul E. McKenney 				       struct delayed_work *dwork,
486da915ad5SPaul E. McKenney 				       unsigned long delay)
487da915ad5SPaul E. McKenney {
488da915ad5SPaul E. McKenney 	bool ret;
489da915ad5SPaul E. McKenney 
490da915ad5SPaul E. McKenney 	preempt_disable();
491da915ad5SPaul E. McKenney 	if (READ_ONCE(per_cpu(srcu_online, cpu)))
492da915ad5SPaul E. McKenney 		ret = queue_delayed_work_on(cpu, wq, dwork, delay);
493da915ad5SPaul E. McKenney 	else
494da915ad5SPaul E. McKenney 		ret = queue_delayed_work(wq, dwork, delay);
495da915ad5SPaul E. McKenney 	preempt_enable();
496da915ad5SPaul E. McKenney 	return ret;
497da915ad5SPaul E. McKenney }
498da915ad5SPaul E. McKenney 
499da915ad5SPaul E. McKenney /*
500da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
501da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
502da915ad5SPaul E. McKenney  */
503da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
504da915ad5SPaul E. McKenney {
505ad7c946bSPaul E. McKenney 	srcu_queue_delayed_work_on(sdp->cpu, rcu_gp_wq, &sdp->work, delay);
506da915ad5SPaul E. McKenney }
507da915ad5SPaul E. McKenney 
508da915ad5SPaul E. McKenney /*
509da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
510c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
511c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
512c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
513da915ad5SPaul E. McKenney  */
514c7e88067SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *sp, struct srcu_node *snp,
5151e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
516da915ad5SPaul E. McKenney {
517da915ad5SPaul E. McKenney 	int cpu;
518da915ad5SPaul E. McKenney 
519c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
520c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
521c7e88067SPaul E. McKenney 			continue;
5221e9a038bSPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(sp->sda, cpu), delay);
523da915ad5SPaul E. McKenney 	}
524c7e88067SPaul E. McKenney }
525da915ad5SPaul E. McKenney 
526da915ad5SPaul E. McKenney /*
527da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
528da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
529da915ad5SPaul E. McKenney  *
530da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
531da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
532da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
533da915ad5SPaul E. McKenney  * array to have a finite number of elements.
534da915ad5SPaul E. McKenney  */
535da915ad5SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *sp)
536da915ad5SPaul E. McKenney {
5371e9a038bSPaul E. McKenney 	unsigned long cbdelay;
538da915ad5SPaul E. McKenney 	bool cbs;
5398ddbd883SIldar Ismagilov 	bool last_lvl;
540c350c008SPaul E. McKenney 	int cpu;
541c350c008SPaul E. McKenney 	unsigned long flags;
542da915ad5SPaul E. McKenney 	unsigned long gpseq;
543da915ad5SPaul E. McKenney 	int idx;
544c7e88067SPaul E. McKenney 	unsigned long mask;
545c350c008SPaul E. McKenney 	struct srcu_data *sdp;
546da915ad5SPaul E. McKenney 	struct srcu_node *snp;
547da915ad5SPaul E. McKenney 
548da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
549da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_cb_mutex);
550da915ad5SPaul E. McKenney 
551da915ad5SPaul E. McKenney 	/* End the current grace period. */
552d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sp);
553da915ad5SPaul E. McKenney 	idx = rcu_seq_state(sp->srcu_gp_seq);
554da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
5551e9a038bSPaul E. McKenney 	cbdelay = srcu_get_delay(sp);
55622607d66SPaul E. McKenney 	sp->srcu_last_gp_end = ktime_get_mono_fast_ns();
557da915ad5SPaul E. McKenney 	rcu_seq_end(&sp->srcu_gp_seq);
558da915ad5SPaul E. McKenney 	gpseq = rcu_seq_current(&sp->srcu_gp_seq);
5591e9a038bSPaul E. McKenney 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, gpseq))
5601e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = gpseq;
561d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sp);
562da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_gp_mutex);
563da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
564da915ad5SPaul E. McKenney 
565da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
566da915ad5SPaul E. McKenney 	idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
567aedf4ba9SPaul E. McKenney 	srcu_for_each_node_breadth_first(sp, snp) {
568d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(snp);
569da915ad5SPaul E. McKenney 		cbs = false;
5708ddbd883SIldar Ismagilov 		last_lvl = snp >= sp->level[rcu_num_lvls - 1];
5718ddbd883SIldar Ismagilov 		if (last_lvl)
572da915ad5SPaul E. McKenney 			cbs = snp->srcu_have_cbs[idx] == gpseq;
573da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = gpseq;
574da915ad5SPaul E. McKenney 		rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
5751e9a038bSPaul E. McKenney 		if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
5761e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = gpseq;
577c7e88067SPaul E. McKenney 		mask = snp->srcu_data_have_cbs[idx];
578c7e88067SPaul E. McKenney 		snp->srcu_data_have_cbs[idx] = 0;
579d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(snp);
580a3883df3SPaul E. McKenney 		if (cbs)
5811e9a038bSPaul E. McKenney 			srcu_schedule_cbs_snp(sp, snp, mask, cbdelay);
582c350c008SPaul E. McKenney 
583c350c008SPaul E. McKenney 		/* Occasionally prevent srcu_data counter wrap. */
5848ddbd883SIldar Ismagilov 		if (!(gpseq & counter_wrap_check) && last_lvl)
585c350c008SPaul E. McKenney 			for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
586c350c008SPaul E. McKenney 				sdp = per_cpu_ptr(sp->sda, cpu);
587d6331980SPaul E. McKenney 				spin_lock_irqsave_rcu_node(sdp, flags);
588c350c008SPaul E. McKenney 				if (ULONG_CMP_GE(gpseq,
589c350c008SPaul E. McKenney 						 sdp->srcu_gp_seq_needed + 100))
590c350c008SPaul E. McKenney 					sdp->srcu_gp_seq_needed = gpseq;
591a35d13ecSIldar Ismagilov 				if (ULONG_CMP_GE(gpseq,
592a35d13ecSIldar Ismagilov 						 sdp->srcu_gp_seq_needed_exp + 100))
593a35d13ecSIldar Ismagilov 					sdp->srcu_gp_seq_needed_exp = gpseq;
594d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(sdp, flags);
595c350c008SPaul E. McKenney 			}
596da915ad5SPaul E. McKenney 	}
597da915ad5SPaul E. McKenney 
598da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
599da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_cb_mutex);
600da915ad5SPaul E. McKenney 
601da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
602d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sp);
603da915ad5SPaul E. McKenney 	gpseq = rcu_seq_current(&sp->srcu_gp_seq);
604da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
605da915ad5SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, sp->srcu_gp_seq_needed)) {
606da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
607d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sp);
6086308f347SPaul E. McKenney 		srcu_reschedule(sp, 0);
609da915ad5SPaul E. McKenney 	} else {
610d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sp);
611da915ad5SPaul E. McKenney 	}
612da915ad5SPaul E. McKenney }
613da915ad5SPaul E. McKenney 
614da915ad5SPaul E. McKenney /*
6151e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
6161e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
6171e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
6181e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
6191e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
6201e9a038bSPaul E. McKenney  */
6211e9a038bSPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *sp, struct srcu_node *snp,
6221e9a038bSPaul E. McKenney 				  unsigned long s)
6231e9a038bSPaul E. McKenney {
6241e9a038bSPaul E. McKenney 	unsigned long flags;
6251e9a038bSPaul E. McKenney 
6261e9a038bSPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
6271e9a038bSPaul E. McKenney 		if (rcu_seq_done(&sp->srcu_gp_seq, s) ||
6281e9a038bSPaul E. McKenney 		    ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
6291e9a038bSPaul E. McKenney 			return;
630d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
6311e9a038bSPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
632d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
6331e9a038bSPaul E. McKenney 			return;
6341e9a038bSPaul E. McKenney 		}
6351e9a038bSPaul E. McKenney 		WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
636d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
6371e9a038bSPaul E. McKenney 	}
638d6331980SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sp, flags);
639274afd6bSIldar Ismagilov 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s))
6401e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = s;
641d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sp, flags);
6421e9a038bSPaul E. McKenney }
6431e9a038bSPaul E. McKenney 
6441e9a038bSPaul E. McKenney /*
645da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
646da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
647da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
648da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
649da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
65017294ce6SPaul E. McKenney  *
65117294ce6SPaul E. McKenney  * Note that this function also does the work of srcu_funnel_exp_start(),
65217294ce6SPaul E. McKenney  * in some cases by directly invoking it.
653da915ad5SPaul E. McKenney  */
6541e9a038bSPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *sp, struct srcu_data *sdp,
6551e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
656da915ad5SPaul E. McKenney {
657da915ad5SPaul E. McKenney 	unsigned long flags;
658da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
659da915ad5SPaul E. McKenney 	struct srcu_node *snp = sdp->mynode;
660da915ad5SPaul E. McKenney 	unsigned long snp_seq;
661da915ad5SPaul E. McKenney 
662da915ad5SPaul E. McKenney 	/* Each pass through the loop does one level of the srcu_node tree. */
663da915ad5SPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
664da915ad5SPaul E. McKenney 		if (rcu_seq_done(&sp->srcu_gp_seq, s) && snp != sdp->mynode)
665da915ad5SPaul E. McKenney 			return; /* GP already done and CBs recorded. */
666d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
667da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
668da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
669c7e88067SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq == s)
670c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
671d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
672da915ad5SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq != s) {
6731e9a038bSPaul E. McKenney 				srcu_schedule_cbs_sdp(sdp, do_norm
6741e9a038bSPaul E. McKenney 							   ? SRCU_INTERVAL
6751e9a038bSPaul E. McKenney 							   : 0);
6761e9a038bSPaul E. McKenney 				return;
677da915ad5SPaul E. McKenney 			}
6781e9a038bSPaul E. McKenney 			if (!do_norm)
6791e9a038bSPaul E. McKenney 				srcu_funnel_exp_start(sp, snp, s);
680da915ad5SPaul E. McKenney 			return;
681da915ad5SPaul E. McKenney 		}
682da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = s;
683c7e88067SPaul E. McKenney 		if (snp == sdp->mynode)
684c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
6851e9a038bSPaul E. McKenney 		if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
6861e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = s;
687d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
688da915ad5SPaul E. McKenney 	}
689da915ad5SPaul E. McKenney 
690da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
691d6331980SPaul E. McKenney 	spin_lock_irqsave_rcu_node(sp, flags);
692da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sp->srcu_gp_seq_needed, s)) {
693da915ad5SPaul E. McKenney 		/*
694da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
695da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
696da915ad5SPaul E. McKenney 		 */
697da915ad5SPaul E. McKenney 		smp_store_release(&sp->srcu_gp_seq_needed, s); /*^^^*/
698da915ad5SPaul E. McKenney 	}
6991e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s))
7001e9a038bSPaul E. McKenney 		sp->srcu_gp_seq_needed_exp = s;
701da915ad5SPaul E. McKenney 
702da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
703da915ad5SPaul E. McKenney 	if (!rcu_seq_done(&sp->srcu_gp_seq, s) &&
704da915ad5SPaul E. McKenney 	    rcu_seq_state(sp->srcu_gp_seq) == SRCU_STATE_IDLE) {
705da915ad5SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed));
706da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
707e0fcba9aSPaul E. McKenney 		if (likely(srcu_init_done))
708e0fcba9aSPaul E. McKenney 			queue_delayed_work(rcu_gp_wq, &sp->work,
709e0fcba9aSPaul E. McKenney 					   srcu_get_delay(sp));
7104e6ea4efSPaul E. McKenney 		else if (list_empty(&sp->work.work.entry))
7114e6ea4efSPaul E. McKenney 			list_add(&sp->work.work.entry, &srcu_boot_list);
712da915ad5SPaul E. McKenney 	}
713d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sp, flags);
714da915ad5SPaul E. McKenney }
715da915ad5SPaul E. McKenney 
716da915ad5SPaul E. McKenney /*
717dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
718dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
719da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
720dad81a20SPaul E. McKenney  */
721dad81a20SPaul E. McKenney static bool try_check_zero(struct srcu_struct *sp, int idx, int trycount)
722dad81a20SPaul E. McKenney {
723dad81a20SPaul E. McKenney 	for (;;) {
724dad81a20SPaul E. McKenney 		if (srcu_readers_active_idx_check(sp, idx))
725dad81a20SPaul E. McKenney 			return true;
7261e9a038bSPaul E. McKenney 		if (--trycount + !srcu_get_delay(sp) <= 0)
727dad81a20SPaul E. McKenney 			return false;
728dad81a20SPaul E. McKenney 		udelay(SRCU_RETRY_CHECK_DELAY);
729dad81a20SPaul E. McKenney 	}
730dad81a20SPaul E. McKenney }
731dad81a20SPaul E. McKenney 
732dad81a20SPaul E. McKenney /*
733da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
734da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
735dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
736dad81a20SPaul E. McKenney  */
737dad81a20SPaul E. McKenney static void srcu_flip(struct srcu_struct *sp)
738dad81a20SPaul E. McKenney {
739881ec9d2SPaul E. McKenney 	/*
740881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
741881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
742881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
743881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
744881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
745881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
746881ec9d2SPaul E. McKenney 	 */
747881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
748881ec9d2SPaul E. McKenney 
749da915ad5SPaul E. McKenney 	WRITE_ONCE(sp->srcu_idx, sp->srcu_idx + 1);
750dad81a20SPaul E. McKenney 
751dad81a20SPaul E. McKenney 	/*
752dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
753dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
754dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
755dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
756dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
757dad81a20SPaul E. McKenney 	 */
758dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
759dad81a20SPaul E. McKenney }
760dad81a20SPaul E. McKenney 
761dad81a20SPaul E. McKenney /*
7622da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
7632da4b2a7SPaul E. McKenney  *
7642da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
7652da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
7662da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
7672da4b2a7SPaul E. McKenney  *
7682da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
7692da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
7702da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
7712da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
7722da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
7732da4b2a7SPaul E. McKenney  * but to accept this type of error.
7742da4b2a7SPaul E. McKenney  *
7752da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
7762da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
7772da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
7782da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
7792da4b2a7SPaul E. McKenney  * negligible when amoritized over that time period, and the extra latency
7802da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
7812da4b2a7SPaul E. McKenney  */
7822da4b2a7SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *sp)
7832da4b2a7SPaul E. McKenney {
78422607d66SPaul E. McKenney 	unsigned long curseq;
7852da4b2a7SPaul E. McKenney 	unsigned long flags;
7862da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
78722607d66SPaul E. McKenney 	unsigned long t;
7882da4b2a7SPaul E. McKenney 
7892da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
7902da4b2a7SPaul E. McKenney 	local_irq_save(flags);
7912da4b2a7SPaul E. McKenney 	sdp = this_cpu_ptr(sp->sda);
7922da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
7932da4b2a7SPaul E. McKenney 		local_irq_restore(flags);
7942da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
7952da4b2a7SPaul E. McKenney 	}
7962da4b2a7SPaul E. McKenney 	local_irq_restore(flags);
7972da4b2a7SPaul E. McKenney 
7982da4b2a7SPaul E. McKenney 	/*
7992da4b2a7SPaul E. McKenney 	 * No local callbacks, so probabalistically probe global state.
8002da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
8012da4b2a7SPaul E. McKenney 	 * kill scalability, hence the probabalistic nature of the probe.
8022da4b2a7SPaul E. McKenney 	 */
80322607d66SPaul E. McKenney 
80422607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
80522607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
80622607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
80722607d66SPaul E. McKenney 	    time_in_range_open(t, sp->srcu_last_gp_end,
80822607d66SPaul E. McKenney 			       sp->srcu_last_gp_end + exp_holdoff))
80922607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
81022607d66SPaul E. McKenney 
81122607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
8122da4b2a7SPaul E. McKenney 	curseq = rcu_seq_current(&sp->srcu_gp_seq);
8132da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
8142da4b2a7SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(sp->srcu_gp_seq_needed)))
8152da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
8162da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
8172da4b2a7SPaul E. McKenney 	if (curseq != rcu_seq_current(&sp->srcu_gp_seq))
8182da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
8192da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
8202da4b2a7SPaul E. McKenney }
8212da4b2a7SPaul E. McKenney 
8222da4b2a7SPaul E. McKenney /*
823a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
824a602538eSPaul E. McKenney  */
825a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
826a602538eSPaul E. McKenney {
827a602538eSPaul E. McKenney }
828a602538eSPaul E. McKenney 
829a602538eSPaul E. McKenney /*
830da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
831da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
832da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
833dad81a20SPaul E. McKenney  *
834dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
835dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
836dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
837dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
838dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
8395ef98a63SPaul E. McKenney  * preceded the call to call_srcu().  It also means that each CPU executing
840dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
8415ef98a63SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_srcu()
842dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
843dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
844dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
845dad81a20SPaul E. McKenney  *
8465ef98a63SPaul E. McKenney  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
847dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
848dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
8495ef98a63SPaul E. McKenney  * interval between the call to call_srcu() and the invocation of "func()".
850dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
851dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
852dad81a20SPaul E. McKenney  *
853dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
854dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
855dad81a20SPaul E. McKenney  * srcu_struct structure.
856dad81a20SPaul E. McKenney  */
8571e9a038bSPaul E. McKenney void __call_srcu(struct srcu_struct *sp, struct rcu_head *rhp,
8581e9a038bSPaul E. McKenney 		 rcu_callback_t func, bool do_norm)
859dad81a20SPaul E. McKenney {
860dad81a20SPaul E. McKenney 	unsigned long flags;
861*0607ba84SPaul E. McKenney 	int idx;
8621e9a038bSPaul E. McKenney 	bool needexp = false;
863da915ad5SPaul E. McKenney 	bool needgp = false;
864da915ad5SPaul E. McKenney 	unsigned long s;
865da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
866dad81a20SPaul E. McKenney 
867da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
868a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
869a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
870a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
871a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
872a602538eSPaul E. McKenney 		return;
873a602538eSPaul E. McKenney 	}
874da915ad5SPaul E. McKenney 	rhp->func = func;
875*0607ba84SPaul E. McKenney 	idx = srcu_read_lock(sp);
876da915ad5SPaul E. McKenney 	local_irq_save(flags);
877da915ad5SPaul E. McKenney 	sdp = this_cpu_ptr(sp->sda);
878d6331980SPaul E. McKenney 	spin_lock_rcu_node(sdp);
879da915ad5SPaul E. McKenney 	rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp, false);
880da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
881da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
882da915ad5SPaul E. McKenney 	s = rcu_seq_snap(&sp->srcu_gp_seq);
883da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
884da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
885da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
886da915ad5SPaul E. McKenney 		needgp = true;
887dad81a20SPaul E. McKenney 	}
8881e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
8891e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
8901e9a038bSPaul E. McKenney 		needexp = true;
8911e9a038bSPaul E. McKenney 	}
892d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
893da915ad5SPaul E. McKenney 	if (needgp)
8941e9a038bSPaul E. McKenney 		srcu_funnel_gp_start(sp, sdp, s, do_norm);
8951e9a038bSPaul E. McKenney 	else if (needexp)
8961e9a038bSPaul E. McKenney 		srcu_funnel_exp_start(sp, sdp->mynode, s);
897*0607ba84SPaul E. McKenney 	srcu_read_unlock(sp, idx);
8981e9a038bSPaul E. McKenney }
8991e9a038bSPaul E. McKenney 
9005a0465e1SPaul E. McKenney /**
9015a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
9025a0465e1SPaul E. McKenney  * @sp: srcu_struct in queue the callback
90327fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
9045a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
9055a0465e1SPaul E. McKenney  *
9065a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
9075a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
9085a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
9095a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
9105a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
9115a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
9125a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
9135a0465e1SPaul E. McKenney  *
9145a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
9155a0465e1SPaul E. McKenney  * be fast and must not block.
9165a0465e1SPaul E. McKenney  */
9171e9a038bSPaul E. McKenney void call_srcu(struct srcu_struct *sp, struct rcu_head *rhp,
9181e9a038bSPaul E. McKenney 	       rcu_callback_t func)
9191e9a038bSPaul E. McKenney {
9201e9a038bSPaul E. McKenney 	__call_srcu(sp, rhp, func, true);
921dad81a20SPaul E. McKenney }
922dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
923dad81a20SPaul E. McKenney 
924dad81a20SPaul E. McKenney /*
925dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
926dad81a20SPaul E. McKenney  */
9271e9a038bSPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *sp, bool do_norm)
928dad81a20SPaul E. McKenney {
929dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
930dad81a20SPaul E. McKenney 
931dad81a20SPaul E. McKenney 	RCU_LOCKDEP_WARN(lock_is_held(&sp->dep_map) ||
932dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
933dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
934dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
935dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
936dad81a20SPaul E. McKenney 
937dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
938dad81a20SPaul E. McKenney 		return;
939dad81a20SPaul E. McKenney 	might_sleep();
940da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
941dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
942da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
9431e9a038bSPaul E. McKenney 	__call_srcu(sp, &rcu.head, wakeme_after_rcu, do_norm);
944dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
945da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
94635732cf9SPaul E. McKenney 
94735732cf9SPaul E. McKenney 	/*
94835732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
949d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
95035732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
95135732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
95235732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
95335732cf9SPaul E. McKenney 	 */
95435732cf9SPaul E. McKenney 	smp_mb();
955dad81a20SPaul E. McKenney }
956dad81a20SPaul E. McKenney 
957dad81a20SPaul E. McKenney /**
958dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
959dad81a20SPaul E. McKenney  * @sp: srcu_struct with which to synchronize.
960dad81a20SPaul E. McKenney  *
961dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
962dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
963dad81a20SPaul E. McKenney  *
964dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
965dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
966dad81a20SPaul E. McKenney  */
967dad81a20SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *sp)
968dad81a20SPaul E. McKenney {
9691e9a038bSPaul E. McKenney 	__synchronize_srcu(sp, rcu_gp_is_normal());
970dad81a20SPaul E. McKenney }
971dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
972dad81a20SPaul E. McKenney 
973dad81a20SPaul E. McKenney /**
974dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
975dad81a20SPaul E. McKenney  * @sp: srcu_struct with which to synchronize.
976dad81a20SPaul E. McKenney  *
977dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
978dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
979da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
980da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
981dad81a20SPaul E. McKenney  *
982dad81a20SPaul E. McKenney  * Can block; must be called from process context.
983dad81a20SPaul E. McKenney  *
984dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
985dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
986dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
987dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
988dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
989dad81a20SPaul E. McKenney  *
990dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
991dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
992dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
9936eb95cc4SPaul E. McKenney  * the end of its last corresponding SRCU read-side critical section
994dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
995dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
996dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
997dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
998dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
999dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
1000dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
1001dad81a20SPaul E. McKenney  *
1002dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
1003dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
1004dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
1005dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
1006dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
1007dad81a20SPaul E. McKenney  *
1008dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
1009dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
1010dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
10112da4b2a7SPaul E. McKenney  *
10122da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
10132da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
10142da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
10152da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
1016dad81a20SPaul E. McKenney  */
1017dad81a20SPaul E. McKenney void synchronize_srcu(struct srcu_struct *sp)
1018dad81a20SPaul E. McKenney {
10192da4b2a7SPaul E. McKenney 	if (srcu_might_be_idle(sp) || rcu_gp_is_expedited())
1020dad81a20SPaul E. McKenney 		synchronize_srcu_expedited(sp);
1021dad81a20SPaul E. McKenney 	else
10221e9a038bSPaul E. McKenney 		__synchronize_srcu(sp, true);
1023dad81a20SPaul E. McKenney }
1024dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1025dad81a20SPaul E. McKenney 
1026da915ad5SPaul E. McKenney /*
1027da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1028da915ad5SPaul E. McKenney  */
1029da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1030da915ad5SPaul E. McKenney {
1031da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1032da915ad5SPaul E. McKenney 	struct srcu_struct *sp;
1033da915ad5SPaul E. McKenney 
1034da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1035da915ad5SPaul E. McKenney 	sp = sdp->sp;
1036da915ad5SPaul E. McKenney 	if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt))
1037da915ad5SPaul E. McKenney 		complete(&sp->srcu_barrier_completion);
1038da915ad5SPaul E. McKenney }
1039da915ad5SPaul E. McKenney 
1040dad81a20SPaul E. McKenney /**
1041dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1042dad81a20SPaul E. McKenney  * @sp: srcu_struct on which to wait for in-flight callbacks.
1043dad81a20SPaul E. McKenney  */
1044dad81a20SPaul E. McKenney void srcu_barrier(struct srcu_struct *sp)
1045dad81a20SPaul E. McKenney {
1046da915ad5SPaul E. McKenney 	int cpu;
1047da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1048da915ad5SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&sp->srcu_barrier_seq);
1049da915ad5SPaul E. McKenney 
1050da915ad5SPaul E. McKenney 	check_init_srcu_struct(sp);
1051da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_barrier_mutex);
1052da915ad5SPaul E. McKenney 	if (rcu_seq_done(&sp->srcu_barrier_seq, s)) {
1053da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1054da915ad5SPaul E. McKenney 		mutex_unlock(&sp->srcu_barrier_mutex);
1055da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1056da915ad5SPaul E. McKenney 	}
1057da915ad5SPaul E. McKenney 	rcu_seq_start(&sp->srcu_barrier_seq);
1058da915ad5SPaul E. McKenney 	init_completion(&sp->srcu_barrier_completion);
1059da915ad5SPaul E. McKenney 
1060da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1061da915ad5SPaul E. McKenney 	atomic_set(&sp->srcu_barrier_cpu_cnt, 1);
1062da915ad5SPaul E. McKenney 
1063da915ad5SPaul E. McKenney 	/*
1064da915ad5SPaul E. McKenney 	 * Each pass through this loop enqueues a callback, but only
1065da915ad5SPaul E. McKenney 	 * on CPUs already having callbacks enqueued.  Note that if
1066da915ad5SPaul E. McKenney 	 * a CPU already has callbacks enqueue, it must have already
1067da915ad5SPaul E. McKenney 	 * registered the need for a future grace period, so all we
1068da915ad5SPaul E. McKenney 	 * need do is enqueue a callback that will use the same
1069da915ad5SPaul E. McKenney 	 * grace period as the last callback already in the queue.
1070da915ad5SPaul E. McKenney 	 */
1071da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1072da915ad5SPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
1073d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sdp);
1074da915ad5SPaul E. McKenney 		atomic_inc(&sp->srcu_barrier_cpu_cnt);
1075da915ad5SPaul E. McKenney 		sdp->srcu_barrier_head.func = srcu_barrier_cb;
1076a602538eSPaul E. McKenney 		debug_rcu_head_queue(&sdp->srcu_barrier_head);
1077da915ad5SPaul E. McKenney 		if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1078a602538eSPaul E. McKenney 					   &sdp->srcu_barrier_head, 0)) {
1079a602538eSPaul E. McKenney 			debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1080da915ad5SPaul E. McKenney 			atomic_dec(&sp->srcu_barrier_cpu_cnt);
1081a602538eSPaul E. McKenney 		}
1082d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1083da915ad5SPaul E. McKenney 	}
1084da915ad5SPaul E. McKenney 
1085da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1086da915ad5SPaul E. McKenney 	if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt))
1087da915ad5SPaul E. McKenney 		complete(&sp->srcu_barrier_completion);
1088da915ad5SPaul E. McKenney 	wait_for_completion(&sp->srcu_barrier_completion);
1089da915ad5SPaul E. McKenney 
1090da915ad5SPaul E. McKenney 	rcu_seq_end(&sp->srcu_barrier_seq);
1091da915ad5SPaul E. McKenney 	mutex_unlock(&sp->srcu_barrier_mutex);
1092dad81a20SPaul E. McKenney }
1093dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1094dad81a20SPaul E. McKenney 
1095dad81a20SPaul E. McKenney /**
1096dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1097dad81a20SPaul E. McKenney  * @sp: srcu_struct on which to report batch completion.
1098dad81a20SPaul E. McKenney  *
1099dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1100dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1101dad81a20SPaul E. McKenney  */
1102dad81a20SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *sp)
1103dad81a20SPaul E. McKenney {
1104da915ad5SPaul E. McKenney 	return sp->srcu_idx;
1105dad81a20SPaul E. McKenney }
1106dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1107dad81a20SPaul E. McKenney 
1108dad81a20SPaul E. McKenney /*
1109da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1110da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1111da915ad5SPaul E. McKenney  * completed in that state.
1112dad81a20SPaul E. McKenney  */
1113da915ad5SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *sp)
1114dad81a20SPaul E. McKenney {
1115dad81a20SPaul E. McKenney 	int idx;
1116dad81a20SPaul E. McKenney 
1117da915ad5SPaul E. McKenney 	mutex_lock(&sp->srcu_gp_mutex);
1118da915ad5SPaul E. McKenney 
1119dad81a20SPaul E. McKenney 	/*
1120dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1121da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1122dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1123dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1124dad81a20SPaul E. McKenney 	 * invoking a callback.
1125dad81a20SPaul E. McKenney 	 *
1126dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1127dad81a20SPaul E. McKenney 	 * by the prior grace period.
1128dad81a20SPaul E. McKenney 	 */
1129dad81a20SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq)); /* ^^^ */
1130dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1131d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sp);
1132da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) {
1133da915ad5SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq));
1134d6331980SPaul E. McKenney 			spin_unlock_irq_rcu_node(sp);
1135da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1136dad81a20SPaul E. McKenney 			return;
1137dad81a20SPaul E. McKenney 		}
1138dad81a20SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq));
1139dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1140dad81a20SPaul E. McKenney 			srcu_gp_start(sp);
1141d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sp);
1142da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1143da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1144dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1145dad81a20SPaul E. McKenney 		}
1146da915ad5SPaul E. McKenney 	}
1147dad81a20SPaul E. McKenney 
1148dad81a20SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1149da915ad5SPaul E. McKenney 		idx = 1 ^ (sp->srcu_idx & 1);
1150da915ad5SPaul E. McKenney 		if (!try_check_zero(sp, idx, 1)) {
1151da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1152dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1153da915ad5SPaul E. McKenney 		}
1154dad81a20SPaul E. McKenney 		srcu_flip(sp);
1155dad81a20SPaul E. McKenney 		rcu_seq_set_state(&sp->srcu_gp_seq, SRCU_STATE_SCAN2);
1156dad81a20SPaul E. McKenney 	}
1157dad81a20SPaul E. McKenney 
1158dad81a20SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1159dad81a20SPaul E. McKenney 
1160dad81a20SPaul E. McKenney 		/*
1161dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1162dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1163dad81a20SPaul E. McKenney 		 */
1164da915ad5SPaul E. McKenney 		idx = 1 ^ (sp->srcu_idx & 1);
1165da915ad5SPaul E. McKenney 		if (!try_check_zero(sp, idx, 2)) {
1166da915ad5SPaul E. McKenney 			mutex_unlock(&sp->srcu_gp_mutex);
1167da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1168da915ad5SPaul E. McKenney 		}
1169da915ad5SPaul E. McKenney 		srcu_gp_end(sp);  /* Releases ->srcu_gp_mutex. */
1170dad81a20SPaul E. McKenney 	}
1171dad81a20SPaul E. McKenney }
1172dad81a20SPaul E. McKenney 
1173dad81a20SPaul E. McKenney /*
1174dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1175dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1176dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1177dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1178dad81a20SPaul E. McKenney  */
1179da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1180dad81a20SPaul E. McKenney {
1181da915ad5SPaul E. McKenney 	bool more;
1182dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1183dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1184da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1185da915ad5SPaul E. McKenney 	struct srcu_struct *sp;
1186dad81a20SPaul E. McKenney 
1187da915ad5SPaul E. McKenney 	sdp = container_of(work, struct srcu_data, work.work);
1188da915ad5SPaul E. McKenney 	sp = sdp->sp;
1189dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1190d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1191da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1192da915ad5SPaul E. McKenney 			      rcu_seq_current(&sp->srcu_gp_seq));
1193da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1194da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1195d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1196da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1197da915ad5SPaul E. McKenney 	}
1198da915ad5SPaul E. McKenney 
1199da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1200da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1201da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1202d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1203dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1204dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1205a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1206dad81a20SPaul E. McKenney 		local_bh_disable();
1207dad81a20SPaul E. McKenney 		rhp->func(rhp);
1208dad81a20SPaul E. McKenney 		local_bh_enable();
1209dad81a20SPaul E. McKenney 	}
1210da915ad5SPaul E. McKenney 
1211da915ad5SPaul E. McKenney 	/*
1212da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1213da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1214da915ad5SPaul E. McKenney 	 */
1215d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1216da915ad5SPaul E. McKenney 	rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1217da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1218da915ad5SPaul E. McKenney 				       rcu_seq_snap(&sp->srcu_gp_seq));
1219da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1220da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1221d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1222da915ad5SPaul E. McKenney 	if (more)
1223da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1224dad81a20SPaul E. McKenney }
1225dad81a20SPaul E. McKenney 
1226dad81a20SPaul E. McKenney /*
1227dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1228dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1229dad81a20SPaul E. McKenney  */
1230dad81a20SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay)
1231dad81a20SPaul E. McKenney {
1232da915ad5SPaul E. McKenney 	bool pushgp = true;
1233dad81a20SPaul E. McKenney 
1234d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sp);
1235da915ad5SPaul E. McKenney 	if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) {
1236da915ad5SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq))) {
1237da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1238da915ad5SPaul E. McKenney 			pushgp = false;
1239dad81a20SPaul E. McKenney 		}
1240da915ad5SPaul E. McKenney 	} else if (!rcu_seq_state(sp->srcu_gp_seq)) {
1241da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1242da915ad5SPaul E. McKenney 		srcu_gp_start(sp);
1243da915ad5SPaul E. McKenney 	}
1244d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sp);
1245dad81a20SPaul E. McKenney 
1246da915ad5SPaul E. McKenney 	if (pushgp)
1247ad7c946bSPaul E. McKenney 		queue_delayed_work(rcu_gp_wq, &sp->work, delay);
1248dad81a20SPaul E. McKenney }
1249dad81a20SPaul E. McKenney 
1250dad81a20SPaul E. McKenney /*
1251dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1252dad81a20SPaul E. McKenney  */
12530d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1254dad81a20SPaul E. McKenney {
1255dad81a20SPaul E. McKenney 	struct srcu_struct *sp;
1256dad81a20SPaul E. McKenney 
1257dad81a20SPaul E. McKenney 	sp = container_of(work, struct srcu_struct, work.work);
1258dad81a20SPaul E. McKenney 
1259da915ad5SPaul E. McKenney 	srcu_advance_state(sp);
12601e9a038bSPaul E. McKenney 	srcu_reschedule(sp, srcu_get_delay(sp));
1261dad81a20SPaul E. McKenney }
12627f6733c3SPaul E. McKenney 
12637f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
12647f6733c3SPaul E. McKenney 			     struct srcu_struct *sp, int *flags,
1265aebc8264SPaul E. McKenney 			     unsigned long *gp_seq)
12667f6733c3SPaul E. McKenney {
12677f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
12687f6733c3SPaul E. McKenney 		return;
12697f6733c3SPaul E. McKenney 	*flags = 0;
1270aebc8264SPaul E. McKenney 	*gp_seq = rcu_seq_current(&sp->srcu_gp_seq);
12717f6733c3SPaul E. McKenney }
12727f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
12731f4f6da1SPaul E. McKenney 
1274115a1a52SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *sp, char *tt, char *tf)
1275115a1a52SPaul E. McKenney {
1276115a1a52SPaul E. McKenney 	int cpu;
1277115a1a52SPaul E. McKenney 	int idx;
1278ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1279115a1a52SPaul E. McKenney 
1280115a1a52SPaul E. McKenney 	idx = sp->srcu_idx & 0x1;
128152e17ba1SPaul E. McKenney 	pr_alert("%s%s Tree SRCU g%ld per-CPU(idx=%d):",
128252e17ba1SPaul E. McKenney 		 tt, tf, rcu_seq_current(&sp->srcu_gp_seq), idx);
1283115a1a52SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1284115a1a52SPaul E. McKenney 		unsigned long l0, l1;
1285115a1a52SPaul E. McKenney 		unsigned long u0, u1;
1286115a1a52SPaul E. McKenney 		long c0, c1;
12875ab07a8dSPaul E. McKenney 		struct srcu_data *sdp;
1288115a1a52SPaul E. McKenney 
12895ab07a8dSPaul E. McKenney 		sdp = per_cpu_ptr(sp->sda, cpu);
12905ab07a8dSPaul E. McKenney 		u0 = sdp->srcu_unlock_count[!idx];
12915ab07a8dSPaul E. McKenney 		u1 = sdp->srcu_unlock_count[idx];
1292115a1a52SPaul E. McKenney 
1293115a1a52SPaul E. McKenney 		/*
1294115a1a52SPaul E. McKenney 		 * Make sure that a lock is always counted if the corresponding
1295115a1a52SPaul E. McKenney 		 * unlock is counted.
1296115a1a52SPaul E. McKenney 		 */
1297115a1a52SPaul E. McKenney 		smp_rmb();
1298115a1a52SPaul E. McKenney 
12995ab07a8dSPaul E. McKenney 		l0 = sdp->srcu_lock_count[!idx];
13005ab07a8dSPaul E. McKenney 		l1 = sdp->srcu_lock_count[idx];
1301115a1a52SPaul E. McKenney 
1302115a1a52SPaul E. McKenney 		c0 = l0 - u0;
1303115a1a52SPaul E. McKenney 		c1 = l1 - u1;
13045ab07a8dSPaul E. McKenney 		pr_cont(" %d(%ld,%ld %1p)",
13055ab07a8dSPaul E. McKenney 			cpu, c0, c1, rcu_segcblist_head(&sdp->srcu_cblist));
1306ac3748c6SPaul E. McKenney 		s0 += c0;
1307ac3748c6SPaul E. McKenney 		s1 += c1;
1308115a1a52SPaul E. McKenney 	}
1309ac3748c6SPaul E. McKenney 	pr_cont(" T(%ld,%ld)\n", s0, s1);
1310115a1a52SPaul E. McKenney }
1311115a1a52SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1312115a1a52SPaul E. McKenney 
13131f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void)
13141f4f6da1SPaul E. McKenney {
13151f4f6da1SPaul E. McKenney 	pr_info("Hierarchical SRCU implementation.\n");
13160c8e0e3cSPaul E. McKenney 	if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
13170c8e0e3cSPaul E. McKenney 		pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
13181f4f6da1SPaul E. McKenney 	return 0;
13191f4f6da1SPaul E. McKenney }
13201f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce);
1321e0fcba9aSPaul E. McKenney 
1322e0fcba9aSPaul E. McKenney void __init srcu_init(void)
1323e0fcba9aSPaul E. McKenney {
1324e0fcba9aSPaul E. McKenney 	struct srcu_struct *sp;
1325e0fcba9aSPaul E. McKenney 
1326e0fcba9aSPaul E. McKenney 	srcu_init_done = true;
1327e0fcba9aSPaul E. McKenney 	while (!list_empty(&srcu_boot_list)) {
13284e6ea4efSPaul E. McKenney 		sp = list_first_entry(&srcu_boot_list, struct srcu_struct,
13294e6ea4efSPaul E. McKenney 				      work.work.entry);
1330e0fcba9aSPaul E. McKenney 		check_init_srcu_struct(sp);
13314e6ea4efSPaul E. McKenney 		list_del_init(&sp->work.work.entry);
1332e0fcba9aSPaul E. McKenney 		queue_work(rcu_gp_wq, &sp->work.work);
1333e0fcba9aSPaul E. McKenney 	}
1334e0fcba9aSPaul E. McKenney }
1335