xref: /linux-6.15/kernel/rcu/srcutree.c (revision e81baf4c)
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);
59aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay);
600d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work);
61*e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t);
62da915ad5SPaul E. McKenney 
63d6331980SPaul E. McKenney /* Wrappers for lock acquisition and release, see raw_spin_lock_rcu_node(). */
64d6331980SPaul E. McKenney #define spin_lock_rcu_node(p)					\
65d6331980SPaul E. McKenney do {									\
66d6331980SPaul E. McKenney 	spin_lock(&ACCESS_PRIVATE(p, lock));			\
67d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
68d6331980SPaul E. McKenney } while (0)
69d6331980SPaul E. McKenney 
70d6331980SPaul E. McKenney #define spin_unlock_rcu_node(p) spin_unlock(&ACCESS_PRIVATE(p, lock))
71d6331980SPaul E. McKenney 
72d6331980SPaul E. McKenney #define spin_lock_irq_rcu_node(p)					\
73d6331980SPaul E. McKenney do {									\
74d6331980SPaul E. McKenney 	spin_lock_irq(&ACCESS_PRIVATE(p, lock));			\
75d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
76d6331980SPaul E. McKenney } while (0)
77d6331980SPaul E. McKenney 
78d6331980SPaul E. McKenney #define spin_unlock_irq_rcu_node(p)					\
79d6331980SPaul E. McKenney 	spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
80d6331980SPaul E. McKenney 
81d6331980SPaul E. McKenney #define spin_lock_irqsave_rcu_node(p, flags)			\
82d6331980SPaul E. McKenney do {									\
83d6331980SPaul E. McKenney 	spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags);	\
84d6331980SPaul E. McKenney 	smp_mb__after_unlock_lock();					\
85d6331980SPaul E. McKenney } while (0)
86d6331980SPaul E. McKenney 
87d6331980SPaul E. McKenney #define spin_unlock_irqrestore_rcu_node(p, flags)			\
88d6331980SPaul E. McKenney 	spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags)	\
89d6331980SPaul E. McKenney 
90da915ad5SPaul E. McKenney /*
91da915ad5SPaul E. McKenney  * Initialize SRCU combining tree.  Note that statically allocated
92da915ad5SPaul E. McKenney  * srcu_struct structures might already have srcu_read_lock() and
93da915ad5SPaul E. McKenney  * srcu_read_unlock() running against them.  So if the is_static parameter
94da915ad5SPaul E. McKenney  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
95da915ad5SPaul E. McKenney  */
96aacb5d91SPaul E. McKenney static void init_srcu_struct_nodes(struct srcu_struct *ssp, bool is_static)
97dad81a20SPaul E. McKenney {
98da915ad5SPaul E. McKenney 	int cpu;
99da915ad5SPaul E. McKenney 	int i;
100da915ad5SPaul E. McKenney 	int level = 0;
101da915ad5SPaul E. McKenney 	int levelspread[RCU_NUM_LVLS];
102da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
103da915ad5SPaul E. McKenney 	struct srcu_node *snp;
104da915ad5SPaul E. McKenney 	struct srcu_node *snp_first;
105da915ad5SPaul E. McKenney 
106da915ad5SPaul E. McKenney 	/* Work out the overall tree geometry. */
107aacb5d91SPaul E. McKenney 	ssp->level[0] = &ssp->node[0];
108da915ad5SPaul E. McKenney 	for (i = 1; i < rcu_num_lvls; i++)
109aacb5d91SPaul E. McKenney 		ssp->level[i] = ssp->level[i - 1] + num_rcu_lvl[i - 1];
110da915ad5SPaul E. McKenney 	rcu_init_levelspread(levelspread, num_rcu_lvl);
111da915ad5SPaul E. McKenney 
112da915ad5SPaul E. McKenney 	/* Each pass through this loop initializes one srcu_node structure. */
113aacb5d91SPaul E. McKenney 	srcu_for_each_node_breadth_first(ssp, snp) {
114d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(snp, lock));
115c7e88067SPaul E. McKenney 		WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
116c7e88067SPaul E. McKenney 			     ARRAY_SIZE(snp->srcu_data_have_cbs));
117c7e88067SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
118da915ad5SPaul E. McKenney 			snp->srcu_have_cbs[i] = 0;
119c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[i] = 0;
120c7e88067SPaul E. McKenney 		}
1211e9a038bSPaul E. McKenney 		snp->srcu_gp_seq_needed_exp = 0;
122da915ad5SPaul E. McKenney 		snp->grplo = -1;
123da915ad5SPaul E. McKenney 		snp->grphi = -1;
124aacb5d91SPaul E. McKenney 		if (snp == &ssp->node[0]) {
125da915ad5SPaul E. McKenney 			/* Root node, special case. */
126da915ad5SPaul E. McKenney 			snp->srcu_parent = NULL;
127da915ad5SPaul E. McKenney 			continue;
128da915ad5SPaul E. McKenney 		}
129da915ad5SPaul E. McKenney 
130da915ad5SPaul E. McKenney 		/* Non-root node. */
131aacb5d91SPaul E. McKenney 		if (snp == ssp->level[level + 1])
132da915ad5SPaul E. McKenney 			level++;
133aacb5d91SPaul E. McKenney 		snp->srcu_parent = ssp->level[level - 1] +
134aacb5d91SPaul E. McKenney 				   (snp - ssp->level[level]) /
135da915ad5SPaul E. McKenney 				   levelspread[level - 1];
136da915ad5SPaul E. McKenney 	}
137da915ad5SPaul E. McKenney 
138da915ad5SPaul E. McKenney 	/*
139da915ad5SPaul E. McKenney 	 * Initialize the per-CPU srcu_data array, which feeds into the
140da915ad5SPaul E. McKenney 	 * leaves of the srcu_node tree.
141da915ad5SPaul E. McKenney 	 */
142da915ad5SPaul E. McKenney 	WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
143da915ad5SPaul E. McKenney 		     ARRAY_SIZE(sdp->srcu_unlock_count));
144da915ad5SPaul E. McKenney 	level = rcu_num_lvls - 1;
145aacb5d91SPaul E. McKenney 	snp_first = ssp->level[level];
146da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
147aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
148d6331980SPaul E. McKenney 		spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
149da915ad5SPaul E. McKenney 		rcu_segcblist_init(&sdp->srcu_cblist);
150da915ad5SPaul E. McKenney 		sdp->srcu_cblist_invoking = false;
151aacb5d91SPaul E. McKenney 		sdp->srcu_gp_seq_needed = ssp->srcu_gp_seq;
152aacb5d91SPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = ssp->srcu_gp_seq;
153da915ad5SPaul E. McKenney 		sdp->mynode = &snp_first[cpu / levelspread[level]];
154da915ad5SPaul E. McKenney 		for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
155da915ad5SPaul E. McKenney 			if (snp->grplo < 0)
156da915ad5SPaul E. McKenney 				snp->grplo = cpu;
157da915ad5SPaul E. McKenney 			snp->grphi = cpu;
158da915ad5SPaul E. McKenney 		}
159da915ad5SPaul E. McKenney 		sdp->cpu = cpu;
160*e81baf4cSSebastian Andrzej Siewior 		INIT_WORK(&sdp->work, srcu_invoke_callbacks);
161*e81baf4cSSebastian Andrzej Siewior 		timer_setup(&sdp->delay_work, srcu_delay_timer, 0);
162aacb5d91SPaul E. McKenney 		sdp->ssp = ssp;
163c7e88067SPaul E. McKenney 		sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
164da915ad5SPaul E. McKenney 		if (is_static)
165da915ad5SPaul E. McKenney 			continue;
166da915ad5SPaul E. McKenney 
167da915ad5SPaul E. McKenney 		/* Dynamically allocated, better be no srcu_read_locks()! */
168da915ad5SPaul E. McKenney 		for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) {
169da915ad5SPaul E. McKenney 			sdp->srcu_lock_count[i] = 0;
170da915ad5SPaul E. McKenney 			sdp->srcu_unlock_count[i] = 0;
171da915ad5SPaul E. McKenney 		}
172da915ad5SPaul E. McKenney 	}
173da915ad5SPaul E. McKenney }
174da915ad5SPaul E. McKenney 
175da915ad5SPaul E. McKenney /*
176da915ad5SPaul E. McKenney  * Initialize non-compile-time initialized fields, including the
177da915ad5SPaul E. McKenney  * associated srcu_node and srcu_data structures.  The is_static
178da915ad5SPaul E. McKenney  * parameter is passed through to init_srcu_struct_nodes(), and
179da915ad5SPaul E. McKenney  * also tells us that ->sda has already been wired up to srcu_data.
180da915ad5SPaul E. McKenney  */
181aacb5d91SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *ssp, bool is_static)
182da915ad5SPaul E. McKenney {
183aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_cb_mutex);
184aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_gp_mutex);
185aacb5d91SPaul E. McKenney 	ssp->srcu_idx = 0;
186aacb5d91SPaul E. McKenney 	ssp->srcu_gp_seq = 0;
187aacb5d91SPaul E. McKenney 	ssp->srcu_barrier_seq = 0;
188aacb5d91SPaul E. McKenney 	mutex_init(&ssp->srcu_barrier_mutex);
189aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 0);
190aacb5d91SPaul E. McKenney 	INIT_DELAYED_WORK(&ssp->work, process_srcu);
191da915ad5SPaul E. McKenney 	if (!is_static)
192aacb5d91SPaul E. McKenney 		ssp->sda = alloc_percpu(struct srcu_data);
193aacb5d91SPaul E. McKenney 	init_srcu_struct_nodes(ssp, is_static);
194aacb5d91SPaul E. McKenney 	ssp->srcu_gp_seq_needed_exp = 0;
195aacb5d91SPaul E. McKenney 	ssp->srcu_last_gp_end = ktime_get_mono_fast_ns();
196aacb5d91SPaul E. McKenney 	smp_store_release(&ssp->srcu_gp_seq_needed, 0); /* Init done. */
197aacb5d91SPaul E. McKenney 	return ssp->sda ? 0 : -ENOMEM;
198dad81a20SPaul E. McKenney }
199dad81a20SPaul E. McKenney 
200dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC
201dad81a20SPaul E. McKenney 
202aacb5d91SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *ssp, const char *name,
203dad81a20SPaul E. McKenney 		       struct lock_class_key *key)
204dad81a20SPaul E. McKenney {
205dad81a20SPaul E. McKenney 	/* Don't re-initialize a lock while it is held. */
206aacb5d91SPaul E. McKenney 	debug_check_no_locks_freed((void *)ssp, sizeof(*ssp));
207aacb5d91SPaul E. McKenney 	lockdep_init_map(&ssp->dep_map, name, key, 0);
208aacb5d91SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
209aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
210dad81a20SPaul E. McKenney }
211dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct);
212dad81a20SPaul E. McKenney 
213dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
214dad81a20SPaul E. McKenney 
215dad81a20SPaul E. McKenney /**
216dad81a20SPaul E. McKenney  * init_srcu_struct - initialize a sleep-RCU structure
217aacb5d91SPaul E. McKenney  * @ssp: structure to initialize.
218dad81a20SPaul E. McKenney  *
219dad81a20SPaul E. McKenney  * Must invoke this on a given srcu_struct before passing that srcu_struct
220dad81a20SPaul E. McKenney  * to any other function.  Each srcu_struct represents a separate domain
221dad81a20SPaul E. McKenney  * of SRCU protection.
222dad81a20SPaul E. McKenney  */
223aacb5d91SPaul E. McKenney int init_srcu_struct(struct srcu_struct *ssp)
224dad81a20SPaul E. McKenney {
225aacb5d91SPaul E. McKenney 	spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
226aacb5d91SPaul E. McKenney 	return init_srcu_struct_fields(ssp, false);
227dad81a20SPaul E. McKenney }
228dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct);
229dad81a20SPaul E. McKenney 
230dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
231dad81a20SPaul E. McKenney 
232dad81a20SPaul E. McKenney /*
233da915ad5SPaul E. McKenney  * First-use initialization of statically allocated srcu_struct
234da915ad5SPaul E. McKenney  * structure.  Wiring up the combining tree is more than can be
235da915ad5SPaul E. McKenney  * done with compile-time initialization, so this check is added
236aacb5d91SPaul E. McKenney  * to each update-side SRCU primitive.  Use ssp->lock, which -is-
237da915ad5SPaul E. McKenney  * compile-time initialized, to resolve races involving multiple
238da915ad5SPaul E. McKenney  * CPUs trying to garner first-use privileges.
239da915ad5SPaul E. McKenney  */
240aacb5d91SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *ssp)
241da915ad5SPaul E. McKenney {
242da915ad5SPaul E. McKenney 	unsigned long flags;
243da915ad5SPaul E. McKenney 
244da915ad5SPaul E. McKenney 	/* The smp_load_acquire() pairs with the smp_store_release(). */
245aacb5d91SPaul E. McKenney 	if (!rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq_needed))) /*^^^*/
246da915ad5SPaul E. McKenney 		return; /* Already initialized. */
247aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
248aacb5d91SPaul E. McKenney 	if (!rcu_seq_state(ssp->srcu_gp_seq_needed)) {
249aacb5d91SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(ssp, flags);
250da915ad5SPaul E. McKenney 		return;
251da915ad5SPaul E. McKenney 	}
252aacb5d91SPaul E. McKenney 	init_srcu_struct_fields(ssp, true);
253aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
254da915ad5SPaul E. McKenney }
255da915ad5SPaul E. McKenney 
256da915ad5SPaul E. McKenney /*
257da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_lock_count[] values
258da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
259dad81a20SPaul E. McKenney  */
260aacb5d91SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *ssp, int idx)
261dad81a20SPaul E. McKenney {
262dad81a20SPaul E. McKenney 	int cpu;
263dad81a20SPaul E. McKenney 	unsigned long sum = 0;
264dad81a20SPaul E. McKenney 
265dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
266aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
267dad81a20SPaul E. McKenney 
268da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[idx]);
269dad81a20SPaul E. McKenney 	}
270dad81a20SPaul E. McKenney 	return sum;
271dad81a20SPaul E. McKenney }
272dad81a20SPaul E. McKenney 
273dad81a20SPaul E. McKenney /*
274da915ad5SPaul E. McKenney  * Returns approximate total of the readers' ->srcu_unlock_count[] values
275da915ad5SPaul E. McKenney  * for the rank of per-CPU counters specified by idx.
276dad81a20SPaul E. McKenney  */
277aacb5d91SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *ssp, int idx)
278dad81a20SPaul E. McKenney {
279dad81a20SPaul E. McKenney 	int cpu;
280dad81a20SPaul E. McKenney 	unsigned long sum = 0;
281dad81a20SPaul E. McKenney 
282dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
283aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
284dad81a20SPaul E. McKenney 
285da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_unlock_count[idx]);
286dad81a20SPaul E. McKenney 	}
287dad81a20SPaul E. McKenney 	return sum;
288dad81a20SPaul E. McKenney }
289dad81a20SPaul E. McKenney 
290dad81a20SPaul E. McKenney /*
291dad81a20SPaul E. McKenney  * Return true if the number of pre-existing readers is determined to
292dad81a20SPaul E. McKenney  * be zero.
293dad81a20SPaul E. McKenney  */
294aacb5d91SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *ssp, int idx)
295dad81a20SPaul E. McKenney {
296dad81a20SPaul E. McKenney 	unsigned long unlocks;
297dad81a20SPaul E. McKenney 
298aacb5d91SPaul E. McKenney 	unlocks = srcu_readers_unlock_idx(ssp, idx);
299dad81a20SPaul E. McKenney 
300dad81a20SPaul E. McKenney 	/*
301dad81a20SPaul E. McKenney 	 * Make sure that a lock is always counted if the corresponding
302dad81a20SPaul E. McKenney 	 * unlock is counted. Needs to be a smp_mb() as the read side may
303dad81a20SPaul E. McKenney 	 * contain a read from a variable that is written to before the
304dad81a20SPaul E. McKenney 	 * synchronize_srcu() in the write side. In this case smp_mb()s
305dad81a20SPaul E. McKenney 	 * A and B act like the store buffering pattern.
306dad81a20SPaul E. McKenney 	 *
307dad81a20SPaul E. McKenney 	 * This smp_mb() also pairs with smp_mb() C to prevent accesses
308dad81a20SPaul E. McKenney 	 * after the synchronize_srcu() from being executed before the
309dad81a20SPaul E. McKenney 	 * grace period ends.
310dad81a20SPaul E. McKenney 	 */
311dad81a20SPaul E. McKenney 	smp_mb(); /* A */
312dad81a20SPaul E. McKenney 
313dad81a20SPaul E. McKenney 	/*
314dad81a20SPaul E. McKenney 	 * If the locks are the same as the unlocks, then there must have
315dad81a20SPaul E. McKenney 	 * been no readers on this index at some time in between. This does
316dad81a20SPaul E. McKenney 	 * not mean that there are no more readers, as one could have read
317dad81a20SPaul E. McKenney 	 * the current index but not have incremented the lock counter yet.
318dad81a20SPaul E. McKenney 	 *
319881ec9d2SPaul E. McKenney 	 * So suppose that the updater is preempted here for so long
320881ec9d2SPaul E. McKenney 	 * that more than ULONG_MAX non-nested readers come and go in
321881ec9d2SPaul E. McKenney 	 * the meantime.  It turns out that this cannot result in overflow
322881ec9d2SPaul E. McKenney 	 * because if a reader modifies its unlock count after we read it
323881ec9d2SPaul E. McKenney 	 * above, then that reader's next load of ->srcu_idx is guaranteed
324881ec9d2SPaul E. McKenney 	 * to get the new value, which will cause it to operate on the
325881ec9d2SPaul E. McKenney 	 * other bank of counters, where it cannot contribute to the
326881ec9d2SPaul E. McKenney 	 * overflow of these counters.  This means that there is a maximum
327881ec9d2SPaul E. McKenney 	 * of 2*NR_CPUS increments, which cannot overflow given current
328881ec9d2SPaul E. McKenney 	 * systems, especially not on 64-bit systems.
329881ec9d2SPaul E. McKenney 	 *
330881ec9d2SPaul E. McKenney 	 * OK, how about nesting?  This does impose a limit on nesting
331881ec9d2SPaul E. McKenney 	 * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
332881ec9d2SPaul E. McKenney 	 * especially on 64-bit systems.
333dad81a20SPaul E. McKenney 	 */
334aacb5d91SPaul E. McKenney 	return srcu_readers_lock_idx(ssp, idx) == unlocks;
335dad81a20SPaul E. McKenney }
336dad81a20SPaul E. McKenney 
337dad81a20SPaul E. McKenney /**
338dad81a20SPaul E. McKenney  * srcu_readers_active - returns true if there are readers. and false
339dad81a20SPaul E. McKenney  *                       otherwise
340aacb5d91SPaul E. McKenney  * @ssp: which srcu_struct to count active readers (holding srcu_read_lock).
341dad81a20SPaul E. McKenney  *
342dad81a20SPaul E. McKenney  * Note that this is not an atomic primitive, and can therefore suffer
343dad81a20SPaul E. McKenney  * severe errors when invoked on an active srcu_struct.  That said, it
344dad81a20SPaul E. McKenney  * can be useful as an error check at cleanup time.
345dad81a20SPaul E. McKenney  */
346aacb5d91SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *ssp)
347dad81a20SPaul E. McKenney {
348dad81a20SPaul E. McKenney 	int cpu;
349dad81a20SPaul E. McKenney 	unsigned long sum = 0;
350dad81a20SPaul E. McKenney 
351dad81a20SPaul E. McKenney 	for_each_possible_cpu(cpu) {
352aacb5d91SPaul E. McKenney 		struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
353dad81a20SPaul E. McKenney 
354da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[0]);
355da915ad5SPaul E. McKenney 		sum += READ_ONCE(cpuc->srcu_lock_count[1]);
356da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[0]);
357da915ad5SPaul E. McKenney 		sum -= READ_ONCE(cpuc->srcu_unlock_count[1]);
358dad81a20SPaul E. McKenney 	}
359dad81a20SPaul E. McKenney 	return sum;
360dad81a20SPaul E. McKenney }
361dad81a20SPaul E. McKenney 
362dad81a20SPaul E. McKenney #define SRCU_INTERVAL		1
363dad81a20SPaul E. McKenney 
3641e9a038bSPaul E. McKenney /*
3651e9a038bSPaul E. McKenney  * Return grace-period delay, zero if there are expedited grace
3661e9a038bSPaul E. McKenney  * periods pending, SRCU_INTERVAL otherwise.
3671e9a038bSPaul E. McKenney  */
368aacb5d91SPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *ssp)
3691e9a038bSPaul E. McKenney {
370aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_gp_seq),
371aacb5d91SPaul E. McKenney 			 READ_ONCE(ssp->srcu_gp_seq_needed_exp)))
3721e9a038bSPaul E. McKenney 		return 0;
3731e9a038bSPaul E. McKenney 	return SRCU_INTERVAL;
3741e9a038bSPaul E. McKenney }
3751e9a038bSPaul E. McKenney 
376f7194ac3SPaul E. McKenney /* Helper for cleanup_srcu_struct() and cleanup_srcu_struct_quiesced(). */
377aacb5d91SPaul E. McKenney void _cleanup_srcu_struct(struct srcu_struct *ssp, bool quiesced)
378dad81a20SPaul E. McKenney {
379da915ad5SPaul E. McKenney 	int cpu;
380da915ad5SPaul E. McKenney 
381aacb5d91SPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(ssp)))
382f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
383aacb5d91SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(ssp)))
384f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
385f7194ac3SPaul E. McKenney 	if (quiesced) {
386aacb5d91SPaul E. McKenney 		if (WARN_ON(delayed_work_pending(&ssp->work)))
387f7194ac3SPaul E. McKenney 			return; /* Just leak it! */
388f7194ac3SPaul E. McKenney 	} else {
389aacb5d91SPaul E. McKenney 		flush_delayed_work(&ssp->work);
390f7194ac3SPaul E. McKenney 	}
391*e81baf4cSSebastian Andrzej Siewior 	for_each_possible_cpu(cpu) {
392*e81baf4cSSebastian Andrzej Siewior 		struct srcu_data *sdp = per_cpu_ptr(ssp->sda, cpu);
393*e81baf4cSSebastian Andrzej Siewior 
394f7194ac3SPaul E. McKenney 		if (quiesced) {
395*e81baf4cSSebastian Andrzej Siewior 			if (WARN_ON(timer_pending(&sdp->delay_work)))
396*e81baf4cSSebastian Andrzej Siewior 				return; /* Just leak it! */
397*e81baf4cSSebastian Andrzej Siewior 			if (WARN_ON(work_pending(&sdp->work)))
398f7194ac3SPaul E. McKenney 				return; /* Just leak it! */
399f7194ac3SPaul E. McKenney 		} else {
400*e81baf4cSSebastian Andrzej Siewior 			del_timer_sync(&sdp->delay_work);
401*e81baf4cSSebastian Andrzej Siewior 			flush_work(&sdp->work);
402*e81baf4cSSebastian Andrzej Siewior 		}
403f7194ac3SPaul E. McKenney 	}
404aacb5d91SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
405aacb5d91SPaul E. McKenney 	    WARN_ON(srcu_readers_active(ssp))) {
406a7538352SJoe Perches 		pr_info("%s: Active srcu_struct %p state: %d\n",
407aacb5d91SPaul E. McKenney 			__func__, ssp, rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)));
408dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
409dad81a20SPaul E. McKenney 	}
410aacb5d91SPaul E. McKenney 	free_percpu(ssp->sda);
411aacb5d91SPaul E. McKenney 	ssp->sda = NULL;
412dad81a20SPaul E. McKenney }
413f7194ac3SPaul E. McKenney EXPORT_SYMBOL_GPL(_cleanup_srcu_struct);
414dad81a20SPaul E. McKenney 
415dad81a20SPaul E. McKenney /*
416dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
417cdf7abc4SPaolo Bonzini  * srcu_struct.
418dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
419dad81a20SPaul E. McKenney  */
420aacb5d91SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *ssp)
421dad81a20SPaul E. McKenney {
422dad81a20SPaul E. McKenney 	int idx;
423dad81a20SPaul E. McKenney 
424aacb5d91SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
425aacb5d91SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_lock_count[idx]);
426dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
427dad81a20SPaul E. McKenney 	return idx;
428dad81a20SPaul E. McKenney }
429dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
430dad81a20SPaul E. McKenney 
431dad81a20SPaul E. McKenney /*
432dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
433dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
434dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
435dad81a20SPaul E. McKenney  */
436aacb5d91SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *ssp, int idx)
437dad81a20SPaul E. McKenney {
438dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
439aacb5d91SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_unlock_count[idx]);
440dad81a20SPaul E. McKenney }
441dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
442dad81a20SPaul E. McKenney 
443dad81a20SPaul E. McKenney /*
444dad81a20SPaul E. McKenney  * We use an adaptive strategy for synchronize_srcu() and especially for
445dad81a20SPaul E. McKenney  * synchronize_srcu_expedited().  We spin for a fixed time period
446dad81a20SPaul E. McKenney  * (defined below) to allow SRCU readers to exit their read-side critical
447dad81a20SPaul E. McKenney  * sections.  If there are still some readers after a few microseconds,
448dad81a20SPaul E. McKenney  * we repeatedly block for 1-millisecond time periods.
449dad81a20SPaul E. McKenney  */
450dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY		5
451dad81a20SPaul E. McKenney 
452dad81a20SPaul E. McKenney /*
453dad81a20SPaul E. McKenney  * Start an SRCU grace period.
454dad81a20SPaul E. McKenney  */
455aacb5d91SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *ssp)
456dad81a20SPaul E. McKenney {
457aacb5d91SPaul E. McKenney 	struct srcu_data *sdp = this_cpu_ptr(ssp->sda);
458dad81a20SPaul E. McKenney 	int state;
459dad81a20SPaul E. McKenney 
460aacb5d91SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp, lock));
461aacb5d91SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
462eb4c2382SDennis Krein 	spin_lock_rcu_node(sdp);  /* Interrupts already disabled. */
463da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
464aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
465da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
466aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
467eb4c2382SDennis Krein 	spin_unlock_rcu_node(sdp);  /* Interrupts remain disabled. */
4682da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
469aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_gp_seq);
470aacb5d91SPaul E. McKenney 	state = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
471dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
472dad81a20SPaul E. McKenney }
473dad81a20SPaul E. McKenney 
474da915ad5SPaul E. McKenney 
475*e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t)
476da915ad5SPaul E. McKenney {
477*e81baf4cSSebastian Andrzej Siewior 	struct srcu_data *sdp = container_of(t, struct srcu_data, delay_work);
478*e81baf4cSSebastian Andrzej Siewior 
479*e81baf4cSSebastian Andrzej Siewior 	queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
480da915ad5SPaul E. McKenney }
481da915ad5SPaul E. McKenney 
482*e81baf4cSSebastian Andrzej Siewior static void srcu_queue_delayed_work_on(struct srcu_data *sdp,
483da915ad5SPaul E. McKenney 				       unsigned long delay)
484da915ad5SPaul E. McKenney {
485*e81baf4cSSebastian Andrzej Siewior 	if (!delay) {
486*e81baf4cSSebastian Andrzej Siewior 		queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
487*e81baf4cSSebastian Andrzej Siewior 		return;
488*e81baf4cSSebastian Andrzej Siewior 	}
489da915ad5SPaul E. McKenney 
490*e81baf4cSSebastian Andrzej Siewior 	timer_reduce(&sdp->delay_work, jiffies + delay);
491da915ad5SPaul E. McKenney }
492da915ad5SPaul E. McKenney 
493da915ad5SPaul E. McKenney /*
494da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
495da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
496da915ad5SPaul E. McKenney  */
497da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
498da915ad5SPaul E. McKenney {
499*e81baf4cSSebastian Andrzej Siewior 	srcu_queue_delayed_work_on(sdp, delay);
500da915ad5SPaul E. McKenney }
501da915ad5SPaul E. McKenney 
502da915ad5SPaul E. McKenney /*
503da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
504c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
505c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
506c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
507da915ad5SPaul E. McKenney  */
508aacb5d91SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *ssp, struct srcu_node *snp,
5091e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
510da915ad5SPaul E. McKenney {
511da915ad5SPaul E. McKenney 	int cpu;
512da915ad5SPaul E. McKenney 
513c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
514c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
515c7e88067SPaul E. McKenney 			continue;
516aacb5d91SPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, cpu), delay);
517da915ad5SPaul E. McKenney 	}
518c7e88067SPaul E. McKenney }
519da915ad5SPaul E. McKenney 
520da915ad5SPaul E. McKenney /*
521da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
522da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
523da915ad5SPaul E. McKenney  *
524da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
525da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
526da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
527da915ad5SPaul E. McKenney  * array to have a finite number of elements.
528da915ad5SPaul E. McKenney  */
529aacb5d91SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *ssp)
530da915ad5SPaul E. McKenney {
5311e9a038bSPaul E. McKenney 	unsigned long cbdelay;
532da915ad5SPaul E. McKenney 	bool cbs;
5338ddbd883SIldar Ismagilov 	bool last_lvl;
534c350c008SPaul E. McKenney 	int cpu;
535c350c008SPaul E. McKenney 	unsigned long flags;
536da915ad5SPaul E. McKenney 	unsigned long gpseq;
537da915ad5SPaul E. McKenney 	int idx;
538c7e88067SPaul E. McKenney 	unsigned long mask;
539c350c008SPaul E. McKenney 	struct srcu_data *sdp;
540da915ad5SPaul E. McKenney 	struct srcu_node *snp;
541da915ad5SPaul E. McKenney 
542da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
543aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_cb_mutex);
544da915ad5SPaul E. McKenney 
545da915ad5SPaul E. McKenney 	/* End the current grace period. */
546aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
547aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(ssp->srcu_gp_seq);
548da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
549aacb5d91SPaul E. McKenney 	cbdelay = srcu_get_delay(ssp);
550aacb5d91SPaul E. McKenney 	ssp->srcu_last_gp_end = ktime_get_mono_fast_ns();
551aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_gp_seq);
552aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
553aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, gpseq))
554aacb5d91SPaul E. McKenney 		ssp->srcu_gp_seq_needed_exp = gpseq;
555aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
556aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_gp_mutex);
557da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
558da915ad5SPaul E. McKenney 
559da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
560da915ad5SPaul E. McKenney 	idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
561aacb5d91SPaul E. McKenney 	srcu_for_each_node_breadth_first(ssp, snp) {
562d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(snp);
563da915ad5SPaul E. McKenney 		cbs = false;
564aacb5d91SPaul E. McKenney 		last_lvl = snp >= ssp->level[rcu_num_lvls - 1];
5658ddbd883SIldar Ismagilov 		if (last_lvl)
566da915ad5SPaul E. McKenney 			cbs = snp->srcu_have_cbs[idx] == gpseq;
567da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = gpseq;
568da915ad5SPaul E. McKenney 		rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
5691e9a038bSPaul E. McKenney 		if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
5701e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = gpseq;
571c7e88067SPaul E. McKenney 		mask = snp->srcu_data_have_cbs[idx];
572c7e88067SPaul E. McKenney 		snp->srcu_data_have_cbs[idx] = 0;
573d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(snp);
574a3883df3SPaul E. McKenney 		if (cbs)
575aacb5d91SPaul E. McKenney 			srcu_schedule_cbs_snp(ssp, snp, mask, cbdelay);
576c350c008SPaul E. McKenney 
577c350c008SPaul E. McKenney 		/* Occasionally prevent srcu_data counter wrap. */
5788ddbd883SIldar Ismagilov 		if (!(gpseq & counter_wrap_check) && last_lvl)
579c350c008SPaul E. McKenney 			for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
580aacb5d91SPaul E. McKenney 				sdp = per_cpu_ptr(ssp->sda, cpu);
581d6331980SPaul E. McKenney 				spin_lock_irqsave_rcu_node(sdp, flags);
582c350c008SPaul E. McKenney 				if (ULONG_CMP_GE(gpseq,
583c350c008SPaul E. McKenney 						 sdp->srcu_gp_seq_needed + 100))
584c350c008SPaul E. McKenney 					sdp->srcu_gp_seq_needed = gpseq;
585a35d13ecSIldar Ismagilov 				if (ULONG_CMP_GE(gpseq,
586a35d13ecSIldar Ismagilov 						 sdp->srcu_gp_seq_needed_exp + 100))
587a35d13ecSIldar Ismagilov 					sdp->srcu_gp_seq_needed_exp = gpseq;
588d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(sdp, flags);
589c350c008SPaul E. McKenney 			}
590da915ad5SPaul E. McKenney 	}
591da915ad5SPaul E. McKenney 
592da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
593aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_cb_mutex);
594da915ad5SPaul E. McKenney 
595da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
596aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
597aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
598da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
599aacb5d91SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, ssp->srcu_gp_seq_needed)) {
600aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
601aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
602aacb5d91SPaul E. McKenney 		srcu_reschedule(ssp, 0);
603da915ad5SPaul E. McKenney 	} else {
604aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
605da915ad5SPaul E. McKenney 	}
606da915ad5SPaul E. McKenney }
607da915ad5SPaul E. McKenney 
608da915ad5SPaul E. McKenney /*
6091e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
6101e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
6111e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
6121e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
6131e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
6141e9a038bSPaul E. McKenney  */
615aacb5d91SPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *ssp, struct srcu_node *snp,
6161e9a038bSPaul E. McKenney 				  unsigned long s)
6171e9a038bSPaul E. McKenney {
6181e9a038bSPaul E. McKenney 	unsigned long flags;
6191e9a038bSPaul E. McKenney 
6201e9a038bSPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
621aacb5d91SPaul E. McKenney 		if (rcu_seq_done(&ssp->srcu_gp_seq, s) ||
6221e9a038bSPaul E. McKenney 		    ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
6231e9a038bSPaul E. McKenney 			return;
624d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
6251e9a038bSPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
626d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
6271e9a038bSPaul E. McKenney 			return;
6281e9a038bSPaul E. McKenney 		}
6291e9a038bSPaul E. McKenney 		WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
630d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
6311e9a038bSPaul E. McKenney 	}
632aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
633aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
634aacb5d91SPaul E. McKenney 		ssp->srcu_gp_seq_needed_exp = s;
635aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
6361e9a038bSPaul E. McKenney }
6371e9a038bSPaul E. McKenney 
6381e9a038bSPaul E. McKenney /*
639da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
640da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
641da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
642da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
643da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
64417294ce6SPaul E. McKenney  *
64517294ce6SPaul E. McKenney  * Note that this function also does the work of srcu_funnel_exp_start(),
64617294ce6SPaul E. McKenney  * in some cases by directly invoking it.
647da915ad5SPaul E. McKenney  */
648aacb5d91SPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *ssp, struct srcu_data *sdp,
6491e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
650da915ad5SPaul E. McKenney {
651da915ad5SPaul E. McKenney 	unsigned long flags;
652da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
653da915ad5SPaul E. McKenney 	struct srcu_node *snp = sdp->mynode;
654da915ad5SPaul E. McKenney 	unsigned long snp_seq;
655da915ad5SPaul E. McKenney 
656da915ad5SPaul E. McKenney 	/* Each pass through the loop does one level of the srcu_node tree. */
657da915ad5SPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
658aacb5d91SPaul E. McKenney 		if (rcu_seq_done(&ssp->srcu_gp_seq, s) && snp != sdp->mynode)
659da915ad5SPaul E. McKenney 			return; /* GP already done and CBs recorded. */
660d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
661da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
662da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
663c7e88067SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq == s)
664c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
665d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
666da915ad5SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq != s) {
6671e9a038bSPaul E. McKenney 				srcu_schedule_cbs_sdp(sdp, do_norm
6681e9a038bSPaul E. McKenney 							   ? SRCU_INTERVAL
6691e9a038bSPaul E. McKenney 							   : 0);
6701e9a038bSPaul E. McKenney 				return;
671da915ad5SPaul E. McKenney 			}
6721e9a038bSPaul E. McKenney 			if (!do_norm)
673aacb5d91SPaul E. McKenney 				srcu_funnel_exp_start(ssp, snp, s);
674da915ad5SPaul E. McKenney 			return;
675da915ad5SPaul E. McKenney 		}
676da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = s;
677c7e88067SPaul E. McKenney 		if (snp == sdp->mynode)
678c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
6791e9a038bSPaul E. McKenney 		if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
6801e9a038bSPaul E. McKenney 			snp->srcu_gp_seq_needed_exp = s;
681d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
682da915ad5SPaul E. McKenney 	}
683da915ad5SPaul E. McKenney 
684da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
685aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
686aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed, s)) {
687da915ad5SPaul E. McKenney 		/*
688da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
689da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
690da915ad5SPaul E. McKenney 		 */
691aacb5d91SPaul E. McKenney 		smp_store_release(&ssp->srcu_gp_seq_needed, s); /*^^^*/
692da915ad5SPaul E. McKenney 	}
693aacb5d91SPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
694aacb5d91SPaul E. McKenney 		ssp->srcu_gp_seq_needed_exp = s;
695da915ad5SPaul E. McKenney 
696da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
697aacb5d91SPaul E. McKenney 	if (!rcu_seq_done(&ssp->srcu_gp_seq, s) &&
698aacb5d91SPaul E. McKenney 	    rcu_seq_state(ssp->srcu_gp_seq) == SRCU_STATE_IDLE) {
699aacb5d91SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
700aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
701e0fcba9aSPaul E. McKenney 		if (likely(srcu_init_done))
702aacb5d91SPaul E. McKenney 			queue_delayed_work(rcu_gp_wq, &ssp->work,
703aacb5d91SPaul E. McKenney 					   srcu_get_delay(ssp));
704aacb5d91SPaul E. McKenney 		else if (list_empty(&ssp->work.work.entry))
705aacb5d91SPaul E. McKenney 			list_add(&ssp->work.work.entry, &srcu_boot_list);
706da915ad5SPaul E. McKenney 	}
707aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
708da915ad5SPaul E. McKenney }
709da915ad5SPaul E. McKenney 
710da915ad5SPaul E. McKenney /*
711dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
712dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
713da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
714dad81a20SPaul E. McKenney  */
715aacb5d91SPaul E. McKenney static bool try_check_zero(struct srcu_struct *ssp, int idx, int trycount)
716dad81a20SPaul E. McKenney {
717dad81a20SPaul E. McKenney 	for (;;) {
718aacb5d91SPaul E. McKenney 		if (srcu_readers_active_idx_check(ssp, idx))
719dad81a20SPaul E. McKenney 			return true;
720aacb5d91SPaul E. McKenney 		if (--trycount + !srcu_get_delay(ssp) <= 0)
721dad81a20SPaul E. McKenney 			return false;
722dad81a20SPaul E. McKenney 		udelay(SRCU_RETRY_CHECK_DELAY);
723dad81a20SPaul E. McKenney 	}
724dad81a20SPaul E. McKenney }
725dad81a20SPaul E. McKenney 
726dad81a20SPaul E. McKenney /*
727da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
728da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
729dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
730dad81a20SPaul E. McKenney  */
731aacb5d91SPaul E. McKenney static void srcu_flip(struct srcu_struct *ssp)
732dad81a20SPaul E. McKenney {
733881ec9d2SPaul E. McKenney 	/*
734881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
735881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
736881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
737881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
738881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
739881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
740881ec9d2SPaul E. McKenney 	 */
741881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
742881ec9d2SPaul E. McKenney 
743aacb5d91SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_idx, ssp->srcu_idx + 1);
744dad81a20SPaul E. McKenney 
745dad81a20SPaul E. McKenney 	/*
746dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
747dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
748dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
749dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
750dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
751dad81a20SPaul E. McKenney 	 */
752dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
753dad81a20SPaul E. McKenney }
754dad81a20SPaul E. McKenney 
755dad81a20SPaul E. McKenney /*
7562da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
7572da4b2a7SPaul E. McKenney  *
7582da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
7592da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
7602da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
7612da4b2a7SPaul E. McKenney  *
7622da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
7632da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
7642da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
7652da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
7662da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
7672da4b2a7SPaul E. McKenney  * but to accept this type of error.
7682da4b2a7SPaul E. McKenney  *
7692da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
7702da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
7712da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
7722da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
7732da4b2a7SPaul E. McKenney  * negligible when amoritized over that time period, and the extra latency
7742da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
7752da4b2a7SPaul E. McKenney  */
776aacb5d91SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *ssp)
7772da4b2a7SPaul E. McKenney {
77822607d66SPaul E. McKenney 	unsigned long curseq;
7792da4b2a7SPaul E. McKenney 	unsigned long flags;
7802da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
78122607d66SPaul E. McKenney 	unsigned long t;
7822da4b2a7SPaul E. McKenney 
7832da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
7842da4b2a7SPaul E. McKenney 	local_irq_save(flags);
785aacb5d91SPaul E. McKenney 	sdp = this_cpu_ptr(ssp->sda);
7862da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
7872da4b2a7SPaul E. McKenney 		local_irq_restore(flags);
7882da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
7892da4b2a7SPaul E. McKenney 	}
7902da4b2a7SPaul E. McKenney 	local_irq_restore(flags);
7912da4b2a7SPaul E. McKenney 
7922da4b2a7SPaul E. McKenney 	/*
7932da4b2a7SPaul E. McKenney 	 * No local callbacks, so probabalistically probe global state.
7942da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
7952da4b2a7SPaul E. McKenney 	 * kill scalability, hence the probabalistic nature of the probe.
7962da4b2a7SPaul E. McKenney 	 */
79722607d66SPaul E. McKenney 
79822607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
79922607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
80022607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
801aacb5d91SPaul E. McKenney 	    time_in_range_open(t, ssp->srcu_last_gp_end,
802aacb5d91SPaul E. McKenney 			       ssp->srcu_last_gp_end + exp_holdoff))
80322607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
80422607d66SPaul E. McKenney 
80522607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
806aacb5d91SPaul E. McKenney 	curseq = rcu_seq_current(&ssp->srcu_gp_seq);
8072da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
808aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(ssp->srcu_gp_seq_needed)))
8092da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
8102da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
811aacb5d91SPaul E. McKenney 	if (curseq != rcu_seq_current(&ssp->srcu_gp_seq))
8122da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
8132da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
8142da4b2a7SPaul E. McKenney }
8152da4b2a7SPaul E. McKenney 
8162da4b2a7SPaul E. McKenney /*
817a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
818a602538eSPaul E. McKenney  */
819a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
820a602538eSPaul E. McKenney {
821a602538eSPaul E. McKenney }
822a602538eSPaul E. McKenney 
823a602538eSPaul E. McKenney /*
824da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
825da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
826da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
827dad81a20SPaul E. McKenney  *
828dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
829dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
830dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
831dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
832dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
8335ef98a63SPaul E. McKenney  * preceded the call to call_srcu().  It also means that each CPU executing
834dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
8355ef98a63SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_srcu()
836dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
837dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
838dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
839dad81a20SPaul E. McKenney  *
8405ef98a63SPaul E. McKenney  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
841dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
842dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
8435ef98a63SPaul E. McKenney  * interval between the call to call_srcu() and the invocation of "func()".
844dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
845dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
846dad81a20SPaul E. McKenney  *
847dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
848dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
849dad81a20SPaul E. McKenney  * srcu_struct structure.
850dad81a20SPaul E. McKenney  */
851aacb5d91SPaul E. McKenney void __call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
8521e9a038bSPaul E. McKenney 		 rcu_callback_t func, bool do_norm)
853dad81a20SPaul E. McKenney {
854dad81a20SPaul E. McKenney 	unsigned long flags;
8550607ba84SPaul E. McKenney 	int idx;
8561e9a038bSPaul E. McKenney 	bool needexp = false;
857da915ad5SPaul E. McKenney 	bool needgp = false;
858da915ad5SPaul E. McKenney 	unsigned long s;
859da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
860dad81a20SPaul E. McKenney 
861aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
862a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
863a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
864a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
865a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
866a602538eSPaul E. McKenney 		return;
867a602538eSPaul E. McKenney 	}
868da915ad5SPaul E. McKenney 	rhp->func = func;
869aacb5d91SPaul E. McKenney 	idx = srcu_read_lock(ssp);
870da915ad5SPaul E. McKenney 	local_irq_save(flags);
871aacb5d91SPaul E. McKenney 	sdp = this_cpu_ptr(ssp->sda);
872d6331980SPaul E. McKenney 	spin_lock_rcu_node(sdp);
873da915ad5SPaul E. McKenney 	rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp, false);
874da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
875aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
876aacb5d91SPaul E. McKenney 	s = rcu_seq_snap(&ssp->srcu_gp_seq);
877da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
878da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
879da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
880da915ad5SPaul E. McKenney 		needgp = true;
881dad81a20SPaul E. McKenney 	}
8821e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
8831e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
8841e9a038bSPaul E. McKenney 		needexp = true;
8851e9a038bSPaul E. McKenney 	}
886d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
887da915ad5SPaul E. McKenney 	if (needgp)
888aacb5d91SPaul E. McKenney 		srcu_funnel_gp_start(ssp, sdp, s, do_norm);
8891e9a038bSPaul E. McKenney 	else if (needexp)
890aacb5d91SPaul E. McKenney 		srcu_funnel_exp_start(ssp, sdp->mynode, s);
891aacb5d91SPaul E. McKenney 	srcu_read_unlock(ssp, idx);
8921e9a038bSPaul E. McKenney }
8931e9a038bSPaul E. McKenney 
8945a0465e1SPaul E. McKenney /**
8955a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
896aacb5d91SPaul E. McKenney  * @ssp: srcu_struct in queue the callback
89727fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
8985a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
8995a0465e1SPaul E. McKenney  *
9005a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
9015a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
9025a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
9035a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
9045a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
9055a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
9065a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
9075a0465e1SPaul E. McKenney  *
9085a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
9095a0465e1SPaul E. McKenney  * be fast and must not block.
9105a0465e1SPaul E. McKenney  */
911aacb5d91SPaul E. McKenney void call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
9121e9a038bSPaul E. McKenney 	       rcu_callback_t func)
9131e9a038bSPaul E. McKenney {
914aacb5d91SPaul E. McKenney 	__call_srcu(ssp, rhp, func, true);
915dad81a20SPaul E. McKenney }
916dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
917dad81a20SPaul E. McKenney 
918dad81a20SPaul E. McKenney /*
919dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
920dad81a20SPaul E. McKenney  */
921aacb5d91SPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *ssp, bool do_norm)
922dad81a20SPaul E. McKenney {
923dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
924dad81a20SPaul E. McKenney 
925aacb5d91SPaul E. McKenney 	RCU_LOCKDEP_WARN(lock_is_held(&ssp->dep_map) ||
926dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
927dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
928dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
929dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
930dad81a20SPaul E. McKenney 
931dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
932dad81a20SPaul E. McKenney 		return;
933dad81a20SPaul E. McKenney 	might_sleep();
934aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
935dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
936da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
937aacb5d91SPaul E. McKenney 	__call_srcu(ssp, &rcu.head, wakeme_after_rcu, do_norm);
938dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
939da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
94035732cf9SPaul E. McKenney 
94135732cf9SPaul E. McKenney 	/*
94235732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
943d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
94435732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
94535732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
94635732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
94735732cf9SPaul E. McKenney 	 */
94835732cf9SPaul E. McKenney 	smp_mb();
949dad81a20SPaul E. McKenney }
950dad81a20SPaul E. McKenney 
951dad81a20SPaul E. McKenney /**
952dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
953aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
954dad81a20SPaul E. McKenney  *
955dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
956dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
957dad81a20SPaul E. McKenney  *
958dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
959dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
960dad81a20SPaul E. McKenney  */
961aacb5d91SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *ssp)
962dad81a20SPaul E. McKenney {
963aacb5d91SPaul E. McKenney 	__synchronize_srcu(ssp, rcu_gp_is_normal());
964dad81a20SPaul E. McKenney }
965dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
966dad81a20SPaul E. McKenney 
967dad81a20SPaul E. McKenney /**
968dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
969aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
970dad81a20SPaul E. McKenney  *
971dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
972dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
973da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
974da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
975dad81a20SPaul E. McKenney  *
976dad81a20SPaul E. McKenney  * Can block; must be called from process context.
977dad81a20SPaul E. McKenney  *
978dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
979dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
980dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
981dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
982dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
983dad81a20SPaul E. McKenney  *
984dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
985dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
986dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
9876eb95cc4SPaul E. McKenney  * the end of its last corresponding SRCU read-side critical section
988dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
989dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
990dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
991dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
992dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
993dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
994dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
995dad81a20SPaul E. McKenney  *
996dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
997dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
998dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
999dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
1000dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
1001dad81a20SPaul E. McKenney  *
1002dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
1003dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
1004dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
10052da4b2a7SPaul E. McKenney  *
10062da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
10072da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
10082da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
10092da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
1010dad81a20SPaul E. McKenney  */
1011aacb5d91SPaul E. McKenney void synchronize_srcu(struct srcu_struct *ssp)
1012dad81a20SPaul E. McKenney {
1013aacb5d91SPaul E. McKenney 	if (srcu_might_be_idle(ssp) || rcu_gp_is_expedited())
1014aacb5d91SPaul E. McKenney 		synchronize_srcu_expedited(ssp);
1015dad81a20SPaul E. McKenney 	else
1016aacb5d91SPaul E. McKenney 		__synchronize_srcu(ssp, true);
1017dad81a20SPaul E. McKenney }
1018dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1019dad81a20SPaul E. McKenney 
1020da915ad5SPaul E. McKenney /*
1021da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1022da915ad5SPaul E. McKenney  */
1023da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1024da915ad5SPaul E. McKenney {
1025da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1026aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1027da915ad5SPaul E. McKenney 
1028da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1029aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1030aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1031aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1032da915ad5SPaul E. McKenney }
1033da915ad5SPaul E. McKenney 
1034dad81a20SPaul E. McKenney /**
1035dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1036aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to wait for in-flight callbacks.
1037dad81a20SPaul E. McKenney  */
1038aacb5d91SPaul E. McKenney void srcu_barrier(struct srcu_struct *ssp)
1039dad81a20SPaul E. McKenney {
1040da915ad5SPaul E. McKenney 	int cpu;
1041da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1042aacb5d91SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&ssp->srcu_barrier_seq);
1043da915ad5SPaul E. McKenney 
1044aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1045aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_barrier_mutex);
1046aacb5d91SPaul E. McKenney 	if (rcu_seq_done(&ssp->srcu_barrier_seq, s)) {
1047da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1048aacb5d91SPaul E. McKenney 		mutex_unlock(&ssp->srcu_barrier_mutex);
1049da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1050da915ad5SPaul E. McKenney 	}
1051aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_barrier_seq);
1052aacb5d91SPaul E. McKenney 	init_completion(&ssp->srcu_barrier_completion);
1053da915ad5SPaul E. McKenney 
1054da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1055aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 1);
1056da915ad5SPaul E. McKenney 
1057da915ad5SPaul E. McKenney 	/*
1058da915ad5SPaul E. McKenney 	 * Each pass through this loop enqueues a callback, but only
1059da915ad5SPaul E. McKenney 	 * on CPUs already having callbacks enqueued.  Note that if
1060da915ad5SPaul E. McKenney 	 * a CPU already has callbacks enqueue, it must have already
1061da915ad5SPaul E. McKenney 	 * registered the need for a future grace period, so all we
1062da915ad5SPaul E. McKenney 	 * need do is enqueue a callback that will use the same
1063da915ad5SPaul E. McKenney 	 * grace period as the last callback already in the queue.
1064da915ad5SPaul E. McKenney 	 */
1065da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1066aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
1067d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sdp);
1068aacb5d91SPaul E. McKenney 		atomic_inc(&ssp->srcu_barrier_cpu_cnt);
1069da915ad5SPaul E. McKenney 		sdp->srcu_barrier_head.func = srcu_barrier_cb;
1070a602538eSPaul E. McKenney 		debug_rcu_head_queue(&sdp->srcu_barrier_head);
1071da915ad5SPaul E. McKenney 		if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1072a602538eSPaul E. McKenney 					   &sdp->srcu_barrier_head, 0)) {
1073a602538eSPaul E. McKenney 			debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1074aacb5d91SPaul E. McKenney 			atomic_dec(&ssp->srcu_barrier_cpu_cnt);
1075a602538eSPaul E. McKenney 		}
1076d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1077da915ad5SPaul E. McKenney 	}
1078da915ad5SPaul E. McKenney 
1079da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1080aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1081aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1082aacb5d91SPaul E. McKenney 	wait_for_completion(&ssp->srcu_barrier_completion);
1083da915ad5SPaul E. McKenney 
1084aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_barrier_seq);
1085aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_barrier_mutex);
1086dad81a20SPaul E. McKenney }
1087dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1088dad81a20SPaul E. McKenney 
1089dad81a20SPaul E. McKenney /**
1090dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1091aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to report batch completion.
1092dad81a20SPaul E. McKenney  *
1093dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1094dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1095dad81a20SPaul E. McKenney  */
1096aacb5d91SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *ssp)
1097dad81a20SPaul E. McKenney {
1098aacb5d91SPaul E. McKenney 	return ssp->srcu_idx;
1099dad81a20SPaul E. McKenney }
1100dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1101dad81a20SPaul E. McKenney 
1102dad81a20SPaul E. McKenney /*
1103da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1104da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1105da915ad5SPaul E. McKenney  * completed in that state.
1106dad81a20SPaul E. McKenney  */
1107aacb5d91SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *ssp)
1108dad81a20SPaul E. McKenney {
1109dad81a20SPaul E. McKenney 	int idx;
1110dad81a20SPaul E. McKenney 
1111aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_gp_mutex);
1112da915ad5SPaul E. McKenney 
1113dad81a20SPaul E. McKenney 	/*
1114dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1115da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1116dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1117dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1118dad81a20SPaul E. McKenney 	 * invoking a callback.
1119dad81a20SPaul E. McKenney 	 *
1120dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1121dad81a20SPaul E. McKenney 	 * by the prior grace period.
1122dad81a20SPaul E. McKenney 	 */
1123aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq)); /* ^^^ */
1124dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1125aacb5d91SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp);
1126aacb5d91SPaul E. McKenney 		if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1127aacb5d91SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq));
1128aacb5d91SPaul E. McKenney 			spin_unlock_irq_rcu_node(ssp);
1129aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1130dad81a20SPaul E. McKenney 			return;
1131dad81a20SPaul E. McKenney 		}
1132aacb5d91SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
1133dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1134aacb5d91SPaul E. McKenney 			srcu_gp_start(ssp);
1135aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
1136da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1137aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1138dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1139dad81a20SPaul E. McKenney 		}
1140da915ad5SPaul E. McKenney 	}
1141dad81a20SPaul E. McKenney 
1142aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1143aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1144aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 1)) {
1145aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1146dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1147da915ad5SPaul E. McKenney 		}
1148aacb5d91SPaul E. McKenney 		srcu_flip(ssp);
1149aacb5d91SPaul E. McKenney 		rcu_seq_set_state(&ssp->srcu_gp_seq, SRCU_STATE_SCAN2);
1150dad81a20SPaul E. McKenney 	}
1151dad81a20SPaul E. McKenney 
1152aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1153dad81a20SPaul E. McKenney 
1154dad81a20SPaul E. McKenney 		/*
1155dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1156dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1157dad81a20SPaul E. McKenney 		 */
1158aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1159aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 2)) {
1160aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1161da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1162da915ad5SPaul E. McKenney 		}
1163aacb5d91SPaul E. McKenney 		srcu_gp_end(ssp);  /* Releases ->srcu_gp_mutex. */
1164dad81a20SPaul E. McKenney 	}
1165dad81a20SPaul E. McKenney }
1166dad81a20SPaul E. McKenney 
1167dad81a20SPaul E. McKenney /*
1168dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1169dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1170dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1171dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1172dad81a20SPaul E. McKenney  */
1173da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1174dad81a20SPaul E. McKenney {
1175da915ad5SPaul E. McKenney 	bool more;
1176dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1177dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1178da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1179aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1180dad81a20SPaul E. McKenney 
1181*e81baf4cSSebastian Andrzej Siewior 	sdp = container_of(work, struct srcu_data, work);
1182*e81baf4cSSebastian Andrzej Siewior 
1183aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1184dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1185d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1186da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1187aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
1188da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1189da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1190d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1191da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1192da915ad5SPaul E. McKenney 	}
1193da915ad5SPaul E. McKenney 
1194da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1195da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1196da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1197d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1198dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1199dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1200a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1201dad81a20SPaul E. McKenney 		local_bh_disable();
1202dad81a20SPaul E. McKenney 		rhp->func(rhp);
1203dad81a20SPaul E. McKenney 		local_bh_enable();
1204dad81a20SPaul E. McKenney 	}
1205da915ad5SPaul E. McKenney 
1206da915ad5SPaul E. McKenney 	/*
1207da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1208da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1209da915ad5SPaul E. McKenney 	 */
1210d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1211da915ad5SPaul E. McKenney 	rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1212da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1213aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
1214da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1215da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1216d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1217da915ad5SPaul E. McKenney 	if (more)
1218da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1219dad81a20SPaul E. McKenney }
1220dad81a20SPaul E. McKenney 
1221dad81a20SPaul E. McKenney /*
1222dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1223dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1224dad81a20SPaul E. McKenney  */
1225aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay)
1226dad81a20SPaul E. McKenney {
1227da915ad5SPaul E. McKenney 	bool pushgp = true;
1228dad81a20SPaul E. McKenney 
1229aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
1230aacb5d91SPaul E. McKenney 	if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1231aacb5d91SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq))) {
1232da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1233da915ad5SPaul E. McKenney 			pushgp = false;
1234dad81a20SPaul E. McKenney 		}
1235aacb5d91SPaul E. McKenney 	} else if (!rcu_seq_state(ssp->srcu_gp_seq)) {
1236da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1237aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
1238da915ad5SPaul E. McKenney 	}
1239aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
1240dad81a20SPaul E. McKenney 
1241da915ad5SPaul E. McKenney 	if (pushgp)
1242aacb5d91SPaul E. McKenney 		queue_delayed_work(rcu_gp_wq, &ssp->work, delay);
1243dad81a20SPaul E. McKenney }
1244dad81a20SPaul E. McKenney 
1245dad81a20SPaul E. McKenney /*
1246dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1247dad81a20SPaul E. McKenney  */
12480d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1249dad81a20SPaul E. McKenney {
1250aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1251dad81a20SPaul E. McKenney 
1252aacb5d91SPaul E. McKenney 	ssp = container_of(work, struct srcu_struct, work.work);
1253dad81a20SPaul E. McKenney 
1254aacb5d91SPaul E. McKenney 	srcu_advance_state(ssp);
1255aacb5d91SPaul E. McKenney 	srcu_reschedule(ssp, srcu_get_delay(ssp));
1256dad81a20SPaul E. McKenney }
12577f6733c3SPaul E. McKenney 
12587f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
1259aacb5d91SPaul E. McKenney 			     struct srcu_struct *ssp, int *flags,
1260aebc8264SPaul E. McKenney 			     unsigned long *gp_seq)
12617f6733c3SPaul E. McKenney {
12627f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
12637f6733c3SPaul E. McKenney 		return;
12647f6733c3SPaul E. McKenney 	*flags = 0;
1265aacb5d91SPaul E. McKenney 	*gp_seq = rcu_seq_current(&ssp->srcu_gp_seq);
12667f6733c3SPaul E. McKenney }
12677f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
12681f4f6da1SPaul E. McKenney 
1269aacb5d91SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *ssp, char *tt, char *tf)
1270115a1a52SPaul E. McKenney {
1271115a1a52SPaul E. McKenney 	int cpu;
1272115a1a52SPaul E. McKenney 	int idx;
1273ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1274115a1a52SPaul E. McKenney 
1275aacb5d91SPaul E. McKenney 	idx = ssp->srcu_idx & 0x1;
127652e17ba1SPaul E. McKenney 	pr_alert("%s%s Tree SRCU g%ld per-CPU(idx=%d):",
1277aacb5d91SPaul E. McKenney 		 tt, tf, rcu_seq_current(&ssp->srcu_gp_seq), idx);
1278115a1a52SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1279115a1a52SPaul E. McKenney 		unsigned long l0, l1;
1280115a1a52SPaul E. McKenney 		unsigned long u0, u1;
1281115a1a52SPaul E. McKenney 		long c0, c1;
12825ab07a8dSPaul E. McKenney 		struct srcu_data *sdp;
1283115a1a52SPaul E. McKenney 
1284aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
12855ab07a8dSPaul E. McKenney 		u0 = sdp->srcu_unlock_count[!idx];
12865ab07a8dSPaul E. McKenney 		u1 = sdp->srcu_unlock_count[idx];
1287115a1a52SPaul E. McKenney 
1288115a1a52SPaul E. McKenney 		/*
1289115a1a52SPaul E. McKenney 		 * Make sure that a lock is always counted if the corresponding
1290115a1a52SPaul E. McKenney 		 * unlock is counted.
1291115a1a52SPaul E. McKenney 		 */
1292115a1a52SPaul E. McKenney 		smp_rmb();
1293115a1a52SPaul E. McKenney 
12945ab07a8dSPaul E. McKenney 		l0 = sdp->srcu_lock_count[!idx];
12955ab07a8dSPaul E. McKenney 		l1 = sdp->srcu_lock_count[idx];
1296115a1a52SPaul E. McKenney 
1297115a1a52SPaul E. McKenney 		c0 = l0 - u0;
1298115a1a52SPaul E. McKenney 		c1 = l1 - u1;
12995ab07a8dSPaul E. McKenney 		pr_cont(" %d(%ld,%ld %1p)",
13005ab07a8dSPaul E. McKenney 			cpu, c0, c1, rcu_segcblist_head(&sdp->srcu_cblist));
1301ac3748c6SPaul E. McKenney 		s0 += c0;
1302ac3748c6SPaul E. McKenney 		s1 += c1;
1303115a1a52SPaul E. McKenney 	}
1304ac3748c6SPaul E. McKenney 	pr_cont(" T(%ld,%ld)\n", s0, s1);
1305115a1a52SPaul E. McKenney }
1306115a1a52SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1307115a1a52SPaul E. McKenney 
13081f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void)
13091f4f6da1SPaul E. McKenney {
13101f4f6da1SPaul E. McKenney 	pr_info("Hierarchical SRCU implementation.\n");
13110c8e0e3cSPaul E. McKenney 	if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
13120c8e0e3cSPaul E. McKenney 		pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
13131f4f6da1SPaul E. McKenney 	return 0;
13141f4f6da1SPaul E. McKenney }
13151f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce);
1316e0fcba9aSPaul E. McKenney 
1317e0fcba9aSPaul E. McKenney void __init srcu_init(void)
1318e0fcba9aSPaul E. McKenney {
1319aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1320e0fcba9aSPaul E. McKenney 
1321e0fcba9aSPaul E. McKenney 	srcu_init_done = true;
1322e0fcba9aSPaul E. McKenney 	while (!list_empty(&srcu_boot_list)) {
1323aacb5d91SPaul E. McKenney 		ssp = list_first_entry(&srcu_boot_list, struct srcu_struct,
13244e6ea4efSPaul E. McKenney 				      work.work.entry);
1325aacb5d91SPaul E. McKenney 		check_init_srcu_struct(ssp);
1326aacb5d91SPaul E. McKenney 		list_del_init(&ssp->work.work.entry);
1327aacb5d91SPaul E. McKenney 		queue_work(rcu_gp_wq, &ssp->work.work);
1328e0fcba9aSPaul E. McKenney 	}
1329e0fcba9aSPaul E. McKenney }
1330