xref: /linux-6.15/kernel/rcu/srcutree.c (revision bde50d8f)
1e7ee1501SPaul E. McKenney // SPDX-License-Identifier: GPL-2.0+
2dad81a20SPaul E. McKenney /*
3dad81a20SPaul E. McKenney  * Sleepable Read-Copy Update mechanism for mutual exclusion.
4dad81a20SPaul E. McKenney  *
5dad81a20SPaul E. McKenney  * Copyright (C) IBM Corporation, 2006
6dad81a20SPaul E. McKenney  * Copyright (C) Fujitsu, 2012
7dad81a20SPaul E. McKenney  *
865bb0dc4SSeongJae Park  * Authors: Paul McKenney <[email protected]>
9dad81a20SPaul E. McKenney  *	   Lai Jiangshan <[email protected]>
10dad81a20SPaul E. McKenney  *
11dad81a20SPaul E. McKenney  * For detailed explanation of Read-Copy Update mechanism see -
12dad81a20SPaul E. McKenney  *		Documentation/RCU/ *.txt
13dad81a20SPaul E. McKenney  *
14dad81a20SPaul E. McKenney  */
15dad81a20SPaul E. McKenney 
16a7538352SJoe Perches #define pr_fmt(fmt) "rcu: " fmt
17a7538352SJoe Perches 
18dad81a20SPaul E. McKenney #include <linux/export.h>
19dad81a20SPaul E. McKenney #include <linux/mutex.h>
20dad81a20SPaul E. McKenney #include <linux/percpu.h>
21dad81a20SPaul E. McKenney #include <linux/preempt.h>
22dad81a20SPaul E. McKenney #include <linux/rcupdate_wait.h>
23dad81a20SPaul E. McKenney #include <linux/sched.h>
24dad81a20SPaul E. McKenney #include <linux/smp.h>
25dad81a20SPaul E. McKenney #include <linux/delay.h>
2622607d66SPaul E. McKenney #include <linux/module.h>
27dad81a20SPaul E. McKenney #include <linux/srcu.h>
28dad81a20SPaul E. McKenney 
29dad81a20SPaul E. McKenney #include "rcu.h"
3045753c5fSIngo Molnar #include "rcu_segcblist.h"
31dad81a20SPaul E. McKenney 
324f58820fSPaul E. McKenney #ifndef data_race
334f58820fSPaul E. McKenney #define data_race(expr)							\
344f58820fSPaul E. McKenney 	({								\
354f58820fSPaul E. McKenney 		expr;							\
364f58820fSPaul E. McKenney 	})
374f58820fSPaul E. McKenney #endif
384f58820fSPaul E. McKenney #ifndef ASSERT_EXCLUSIVE_WRITER
394f58820fSPaul E. McKenney #define ASSERT_EXCLUSIVE_WRITER(var) do { } while (0)
404f58820fSPaul E. McKenney #endif
414f58820fSPaul E. McKenney #ifndef ASSERT_EXCLUSIVE_ACCESS
424f58820fSPaul E. McKenney #define ASSERT_EXCLUSIVE_ACCESS(var) do { } while (0)
434f58820fSPaul E. McKenney #endif
444f58820fSPaul 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);
61e81baf4cSSebastian 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;
160e81baf4cSSebastian Andrzej Siewior 		INIT_WORK(&sdp->work, srcu_invoke_callbacks);
161e81baf4cSSebastian 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 
376f5ad3991SPaul E. McKenney /**
377f5ad3991SPaul E. McKenney  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
378f5ad3991SPaul E. McKenney  * @ssp: structure to clean up.
379f5ad3991SPaul E. McKenney  *
380f5ad3991SPaul E. McKenney  * Must invoke this after you are finished using a given srcu_struct that
381f5ad3991SPaul E. McKenney  * was initialized via init_srcu_struct(), else you leak memory.
382f5ad3991SPaul E. McKenney  */
383f5ad3991SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *ssp)
384dad81a20SPaul E. McKenney {
385da915ad5SPaul E. McKenney 	int cpu;
386da915ad5SPaul E. McKenney 
387aacb5d91SPaul E. McKenney 	if (WARN_ON(!srcu_get_delay(ssp)))
388f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
389aacb5d91SPaul E. McKenney 	if (WARN_ON(srcu_readers_active(ssp)))
390f7194ac3SPaul E. McKenney 		return; /* Just leak it! */
391aacb5d91SPaul E. McKenney 	flush_delayed_work(&ssp->work);
392e81baf4cSSebastian Andrzej Siewior 	for_each_possible_cpu(cpu) {
393e81baf4cSSebastian Andrzej Siewior 		struct srcu_data *sdp = per_cpu_ptr(ssp->sda, cpu);
394e81baf4cSSebastian Andrzej Siewior 
395e81baf4cSSebastian Andrzej Siewior 		del_timer_sync(&sdp->delay_work);
396e81baf4cSSebastian Andrzej Siewior 		flush_work(&sdp->work);
3975cdfd174SPaul E. McKenney 		if (WARN_ON(rcu_segcblist_n_cbs(&sdp->srcu_cblist)))
3985cdfd174SPaul E. McKenney 			return; /* Forgot srcu_barrier(), so just leak it! */
399f7194ac3SPaul E. McKenney 	}
400aacb5d91SPaul E. McKenney 	if (WARN_ON(rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
401aacb5d91SPaul E. McKenney 	    WARN_ON(srcu_readers_active(ssp))) {
402a7538352SJoe Perches 		pr_info("%s: Active srcu_struct %p state: %d\n",
403aacb5d91SPaul E. McKenney 			__func__, ssp, rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)));
404dad81a20SPaul E. McKenney 		return; /* Caller forgot to stop doing call_srcu()? */
405dad81a20SPaul E. McKenney 	}
406aacb5d91SPaul E. McKenney 	free_percpu(ssp->sda);
407aacb5d91SPaul E. McKenney 	ssp->sda = NULL;
408dad81a20SPaul E. McKenney }
409f5ad3991SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
410dad81a20SPaul E. McKenney 
411dad81a20SPaul E. McKenney /*
412dad81a20SPaul E. McKenney  * Counts the new reader in the appropriate per-CPU element of the
413cdf7abc4SPaolo Bonzini  * srcu_struct.
414dad81a20SPaul E. McKenney  * Returns an index that must be passed to the matching srcu_read_unlock().
415dad81a20SPaul E. McKenney  */
416aacb5d91SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *ssp)
417dad81a20SPaul E. McKenney {
418dad81a20SPaul E. McKenney 	int idx;
419dad81a20SPaul E. McKenney 
420aacb5d91SPaul E. McKenney 	idx = READ_ONCE(ssp->srcu_idx) & 0x1;
421aacb5d91SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_lock_count[idx]);
422dad81a20SPaul E. McKenney 	smp_mb(); /* B */  /* Avoid leaking the critical section. */
423dad81a20SPaul E. McKenney 	return idx;
424dad81a20SPaul E. McKenney }
425dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock);
426dad81a20SPaul E. McKenney 
427dad81a20SPaul E. McKenney /*
428dad81a20SPaul E. McKenney  * Removes the count for the old reader from the appropriate per-CPU
429dad81a20SPaul E. McKenney  * element of the srcu_struct.  Note that this may well be a different
430dad81a20SPaul E. McKenney  * CPU than that which was incremented by the corresponding srcu_read_lock().
431dad81a20SPaul E. McKenney  */
432aacb5d91SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *ssp, int idx)
433dad81a20SPaul E. McKenney {
434dad81a20SPaul E. McKenney 	smp_mb(); /* C */  /* Avoid leaking the critical section. */
435aacb5d91SPaul E. McKenney 	this_cpu_inc(ssp->sda->srcu_unlock_count[idx]);
436dad81a20SPaul E. McKenney }
437dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock);
438dad81a20SPaul E. McKenney 
439dad81a20SPaul E. McKenney /*
440dad81a20SPaul E. McKenney  * We use an adaptive strategy for synchronize_srcu() and especially for
441dad81a20SPaul E. McKenney  * synchronize_srcu_expedited().  We spin for a fixed time period
442dad81a20SPaul E. McKenney  * (defined below) to allow SRCU readers to exit their read-side critical
443dad81a20SPaul E. McKenney  * sections.  If there are still some readers after a few microseconds,
444dad81a20SPaul E. McKenney  * we repeatedly block for 1-millisecond time periods.
445dad81a20SPaul E. McKenney  */
446dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY		5
447dad81a20SPaul E. McKenney 
448dad81a20SPaul E. McKenney /*
449dad81a20SPaul E. McKenney  * Start an SRCU grace period.
450dad81a20SPaul E. McKenney  */
451aacb5d91SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *ssp)
452dad81a20SPaul E. McKenney {
453aacb5d91SPaul E. McKenney 	struct srcu_data *sdp = this_cpu_ptr(ssp->sda);
454dad81a20SPaul E. McKenney 	int state;
455dad81a20SPaul E. McKenney 
456aacb5d91SPaul E. McKenney 	lockdep_assert_held(&ACCESS_PRIVATE(ssp, lock));
457aacb5d91SPaul E. McKenney 	WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
458eb4c2382SDennis Krein 	spin_lock_rcu_node(sdp);  /* Interrupts already disabled. */
459da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
460aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
461da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
462aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
463eb4c2382SDennis Krein 	spin_unlock_rcu_node(sdp);  /* Interrupts remain disabled. */
4642da4b2a7SPaul E. McKenney 	smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
465aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_gp_seq);
46671042606SPaul E. McKenney 	state = rcu_seq_state(ssp->srcu_gp_seq);
467dad81a20SPaul E. McKenney 	WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
468dad81a20SPaul E. McKenney }
469dad81a20SPaul E. McKenney 
470da915ad5SPaul E. McKenney 
471e81baf4cSSebastian Andrzej Siewior static void srcu_delay_timer(struct timer_list *t)
472da915ad5SPaul E. McKenney {
473e81baf4cSSebastian Andrzej Siewior 	struct srcu_data *sdp = container_of(t, struct srcu_data, delay_work);
474e81baf4cSSebastian Andrzej Siewior 
475e81baf4cSSebastian Andrzej Siewior 	queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
476da915ad5SPaul E. McKenney }
477da915ad5SPaul E. McKenney 
478e81baf4cSSebastian Andrzej Siewior static void srcu_queue_delayed_work_on(struct srcu_data *sdp,
479da915ad5SPaul E. McKenney 				       unsigned long delay)
480da915ad5SPaul E. McKenney {
481e81baf4cSSebastian Andrzej Siewior 	if (!delay) {
482e81baf4cSSebastian Andrzej Siewior 		queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
483e81baf4cSSebastian Andrzej Siewior 		return;
484e81baf4cSSebastian Andrzej Siewior 	}
485da915ad5SPaul E. McKenney 
486e81baf4cSSebastian Andrzej Siewior 	timer_reduce(&sdp->delay_work, jiffies + delay);
487da915ad5SPaul E. McKenney }
488da915ad5SPaul E. McKenney 
489da915ad5SPaul E. McKenney /*
490da915ad5SPaul E. McKenney  * Schedule callback invocation for the specified srcu_data structure,
491da915ad5SPaul E. McKenney  * if possible, on the corresponding CPU.
492da915ad5SPaul E. McKenney  */
493da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
494da915ad5SPaul E. McKenney {
495e81baf4cSSebastian Andrzej Siewior 	srcu_queue_delayed_work_on(sdp, delay);
496da915ad5SPaul E. McKenney }
497da915ad5SPaul E. McKenney 
498da915ad5SPaul E. McKenney /*
499da915ad5SPaul E. McKenney  * Schedule callback invocation for all srcu_data structures associated
500c7e88067SPaul E. McKenney  * with the specified srcu_node structure that have callbacks for the
501c7e88067SPaul E. McKenney  * just-completed grace period, the one corresponding to idx.  If possible,
502c7e88067SPaul E. McKenney  * schedule this invocation on the corresponding CPUs.
503da915ad5SPaul E. McKenney  */
504aacb5d91SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *ssp, struct srcu_node *snp,
5051e9a038bSPaul E. McKenney 				  unsigned long mask, unsigned long delay)
506da915ad5SPaul E. McKenney {
507da915ad5SPaul E. McKenney 	int cpu;
508da915ad5SPaul E. McKenney 
509c7e88067SPaul E. McKenney 	for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
510c7e88067SPaul E. McKenney 		if (!(mask & (1 << (cpu - snp->grplo))))
511c7e88067SPaul E. McKenney 			continue;
512aacb5d91SPaul E. McKenney 		srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, cpu), delay);
513da915ad5SPaul E. McKenney 	}
514c7e88067SPaul E. McKenney }
515da915ad5SPaul E. McKenney 
516da915ad5SPaul E. McKenney /*
517da915ad5SPaul E. McKenney  * Note the end of an SRCU grace period.  Initiates callback invocation
518da915ad5SPaul E. McKenney  * and starts a new grace period if needed.
519da915ad5SPaul E. McKenney  *
520da915ad5SPaul E. McKenney  * The ->srcu_cb_mutex acquisition does not protect any data, but
521da915ad5SPaul E. McKenney  * instead prevents more than one grace period from starting while we
522da915ad5SPaul E. McKenney  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
523da915ad5SPaul E. McKenney  * array to have a finite number of elements.
524da915ad5SPaul E. McKenney  */
525aacb5d91SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *ssp)
526da915ad5SPaul E. McKenney {
5271e9a038bSPaul E. McKenney 	unsigned long cbdelay;
528da915ad5SPaul E. McKenney 	bool cbs;
5298ddbd883SIldar Ismagilov 	bool last_lvl;
530c350c008SPaul E. McKenney 	int cpu;
531c350c008SPaul E. McKenney 	unsigned long flags;
532da915ad5SPaul E. McKenney 	unsigned long gpseq;
533da915ad5SPaul E. McKenney 	int idx;
534c7e88067SPaul E. McKenney 	unsigned long mask;
535c350c008SPaul E. McKenney 	struct srcu_data *sdp;
536da915ad5SPaul E. McKenney 	struct srcu_node *snp;
537da915ad5SPaul E. McKenney 
538da915ad5SPaul E. McKenney 	/* Prevent more than one additional grace period. */
539aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_cb_mutex);
540da915ad5SPaul E. McKenney 
541da915ad5SPaul E. McKenney 	/* End the current grace period. */
542aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
543aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(ssp->srcu_gp_seq);
544da915ad5SPaul E. McKenney 	WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
545aacb5d91SPaul E. McKenney 	cbdelay = srcu_get_delay(ssp);
546844a378dSPaul E. McKenney 	WRITE_ONCE(ssp->srcu_last_gp_end, ktime_get_mono_fast_ns());
547aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_gp_seq);
548aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
549aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, gpseq))
5508c9e0cb3SPaul E. McKenney 		WRITE_ONCE(ssp->srcu_gp_seq_needed_exp, gpseq);
551aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
552aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_gp_mutex);
553da915ad5SPaul E. McKenney 	/* A new grace period can start at this point.  But only one. */
554da915ad5SPaul E. McKenney 
555da915ad5SPaul E. McKenney 	/* Initiate callback invocation as needed. */
556da915ad5SPaul E. McKenney 	idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
557aacb5d91SPaul E. McKenney 	srcu_for_each_node_breadth_first(ssp, snp) {
558d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(snp);
559da915ad5SPaul E. McKenney 		cbs = false;
560aacb5d91SPaul E. McKenney 		last_lvl = snp >= ssp->level[rcu_num_lvls - 1];
5618ddbd883SIldar Ismagilov 		if (last_lvl)
562da915ad5SPaul E. McKenney 			cbs = snp->srcu_have_cbs[idx] == gpseq;
563da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = gpseq;
564da915ad5SPaul E. McKenney 		rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
5651e9a038bSPaul E. McKenney 		if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
5667ff8b450SPaul E. McKenney 			WRITE_ONCE(snp->srcu_gp_seq_needed_exp, gpseq);
567c7e88067SPaul E. McKenney 		mask = snp->srcu_data_have_cbs[idx];
568c7e88067SPaul E. McKenney 		snp->srcu_data_have_cbs[idx] = 0;
569d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(snp);
570a3883df3SPaul E. McKenney 		if (cbs)
571aacb5d91SPaul E. McKenney 			srcu_schedule_cbs_snp(ssp, snp, mask, cbdelay);
572c350c008SPaul E. McKenney 
573c350c008SPaul E. McKenney 		/* Occasionally prevent srcu_data counter wrap. */
5748ddbd883SIldar Ismagilov 		if (!(gpseq & counter_wrap_check) && last_lvl)
575c350c008SPaul E. McKenney 			for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
576aacb5d91SPaul E. McKenney 				sdp = per_cpu_ptr(ssp->sda, cpu);
577d6331980SPaul E. McKenney 				spin_lock_irqsave_rcu_node(sdp, flags);
578c350c008SPaul E. McKenney 				if (ULONG_CMP_GE(gpseq,
579c350c008SPaul E. McKenney 						 sdp->srcu_gp_seq_needed + 100))
580c350c008SPaul E. McKenney 					sdp->srcu_gp_seq_needed = gpseq;
581a35d13ecSIldar Ismagilov 				if (ULONG_CMP_GE(gpseq,
582a35d13ecSIldar Ismagilov 						 sdp->srcu_gp_seq_needed_exp + 100))
583a35d13ecSIldar Ismagilov 					sdp->srcu_gp_seq_needed_exp = gpseq;
584d6331980SPaul E. McKenney 				spin_unlock_irqrestore_rcu_node(sdp, flags);
585c350c008SPaul E. McKenney 			}
586da915ad5SPaul E. McKenney 	}
587da915ad5SPaul E. McKenney 
588da915ad5SPaul E. McKenney 	/* Callback initiation done, allow grace periods after next. */
589aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_cb_mutex);
590da915ad5SPaul E. McKenney 
591da915ad5SPaul E. McKenney 	/* Start a new grace period if needed. */
592aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
593aacb5d91SPaul E. McKenney 	gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
594da915ad5SPaul E. McKenney 	if (!rcu_seq_state(gpseq) &&
595aacb5d91SPaul E. McKenney 	    ULONG_CMP_LT(gpseq, ssp->srcu_gp_seq_needed)) {
596aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
597aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
598aacb5d91SPaul E. McKenney 		srcu_reschedule(ssp, 0);
599da915ad5SPaul E. McKenney 	} else {
600aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
601da915ad5SPaul E. McKenney 	}
602da915ad5SPaul E. McKenney }
603da915ad5SPaul E. McKenney 
604da915ad5SPaul E. McKenney /*
6051e9a038bSPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent expedited
6061e9a038bSPaul E. McKenney  * grace-period requests.  This function is invoked for the first known
6071e9a038bSPaul E. McKenney  * expedited request for a grace period that has already been requested,
6081e9a038bSPaul E. McKenney  * but without expediting.  To start a completely new grace period,
6091e9a038bSPaul E. McKenney  * whether expedited or not, use srcu_funnel_gp_start() instead.
6101e9a038bSPaul E. McKenney  */
611aacb5d91SPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *ssp, struct srcu_node *snp,
6121e9a038bSPaul E. McKenney 				  unsigned long s)
6131e9a038bSPaul E. McKenney {
6141e9a038bSPaul E. McKenney 	unsigned long flags;
6151e9a038bSPaul E. McKenney 
6161e9a038bSPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
617aacb5d91SPaul E. McKenney 		if (rcu_seq_done(&ssp->srcu_gp_seq, s) ||
6181e9a038bSPaul E. McKenney 		    ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
6191e9a038bSPaul E. McKenney 			return;
620d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
6211e9a038bSPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
622d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
6231e9a038bSPaul E. McKenney 			return;
6241e9a038bSPaul E. McKenney 		}
6251e9a038bSPaul E. McKenney 		WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
626d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
6271e9a038bSPaul E. McKenney 	}
628aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
629aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
6308c9e0cb3SPaul E. McKenney 		WRITE_ONCE(ssp->srcu_gp_seq_needed_exp, s);
631aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
6321e9a038bSPaul E. McKenney }
6331e9a038bSPaul E. McKenney 
6341e9a038bSPaul E. McKenney /*
635da915ad5SPaul E. McKenney  * Funnel-locking scheme to scalably mediate many concurrent grace-period
636da915ad5SPaul E. McKenney  * requests.  The winner has to do the work of actually starting grace
637da915ad5SPaul E. McKenney  * period s.  Losers must either ensure that their desired grace-period
638da915ad5SPaul E. McKenney  * number is recorded on at least their leaf srcu_node structure, or they
639da915ad5SPaul E. McKenney  * must take steps to invoke their own callbacks.
64017294ce6SPaul E. McKenney  *
64117294ce6SPaul E. McKenney  * Note that this function also does the work of srcu_funnel_exp_start(),
64217294ce6SPaul E. McKenney  * in some cases by directly invoking it.
643da915ad5SPaul E. McKenney  */
644aacb5d91SPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *ssp, struct srcu_data *sdp,
6451e9a038bSPaul E. McKenney 				 unsigned long s, bool do_norm)
646da915ad5SPaul E. McKenney {
647da915ad5SPaul E. McKenney 	unsigned long flags;
648da915ad5SPaul E. McKenney 	int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
649da915ad5SPaul E. McKenney 	struct srcu_node *snp = sdp->mynode;
650da915ad5SPaul E. McKenney 	unsigned long snp_seq;
651da915ad5SPaul E. McKenney 
652da915ad5SPaul E. McKenney 	/* Each pass through the loop does one level of the srcu_node tree. */
653da915ad5SPaul E. McKenney 	for (; snp != NULL; snp = snp->srcu_parent) {
654aacb5d91SPaul E. McKenney 		if (rcu_seq_done(&ssp->srcu_gp_seq, s) && snp != sdp->mynode)
655da915ad5SPaul E. McKenney 			return; /* GP already done and CBs recorded. */
656d6331980SPaul E. McKenney 		spin_lock_irqsave_rcu_node(snp, flags);
657da915ad5SPaul E. McKenney 		if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
658da915ad5SPaul E. McKenney 			snp_seq = snp->srcu_have_cbs[idx];
659c7e88067SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq == s)
660c7e88067SPaul E. McKenney 				snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
661d6331980SPaul E. McKenney 			spin_unlock_irqrestore_rcu_node(snp, flags);
662da915ad5SPaul E. McKenney 			if (snp == sdp->mynode && snp_seq != s) {
6631e9a038bSPaul E. McKenney 				srcu_schedule_cbs_sdp(sdp, do_norm
6641e9a038bSPaul E. McKenney 							   ? SRCU_INTERVAL
6651e9a038bSPaul E. McKenney 							   : 0);
6661e9a038bSPaul E. McKenney 				return;
667da915ad5SPaul E. McKenney 			}
6681e9a038bSPaul E. McKenney 			if (!do_norm)
669aacb5d91SPaul E. McKenney 				srcu_funnel_exp_start(ssp, snp, s);
670da915ad5SPaul E. McKenney 			return;
671da915ad5SPaul E. McKenney 		}
672da915ad5SPaul E. McKenney 		snp->srcu_have_cbs[idx] = s;
673c7e88067SPaul E. McKenney 		if (snp == sdp->mynode)
674c7e88067SPaul E. McKenney 			snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
6751e9a038bSPaul E. McKenney 		if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
6767ff8b450SPaul E. McKenney 			WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
677d6331980SPaul E. McKenney 		spin_unlock_irqrestore_rcu_node(snp, flags);
678da915ad5SPaul E. McKenney 	}
679da915ad5SPaul E. McKenney 
680da915ad5SPaul E. McKenney 	/* Top of tree, must ensure the grace period will be started. */
681aacb5d91SPaul E. McKenney 	spin_lock_irqsave_rcu_node(ssp, flags);
682aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed, s)) {
683da915ad5SPaul E. McKenney 		/*
684da915ad5SPaul E. McKenney 		 * Record need for grace period s.  Pair with load
685da915ad5SPaul E. McKenney 		 * acquire setting up for initialization.
686da915ad5SPaul E. McKenney 		 */
687aacb5d91SPaul E. McKenney 		smp_store_release(&ssp->srcu_gp_seq_needed, s); /*^^^*/
688da915ad5SPaul E. McKenney 	}
689aacb5d91SPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
6908c9e0cb3SPaul E. McKenney 		WRITE_ONCE(ssp->srcu_gp_seq_needed_exp, s);
691da915ad5SPaul E. McKenney 
692da915ad5SPaul E. McKenney 	/* If grace period not already done and none in progress, start it. */
693aacb5d91SPaul E. McKenney 	if (!rcu_seq_done(&ssp->srcu_gp_seq, s) &&
694aacb5d91SPaul E. McKenney 	    rcu_seq_state(ssp->srcu_gp_seq) == SRCU_STATE_IDLE) {
695aacb5d91SPaul E. McKenney 		WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
696aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
697e0fcba9aSPaul E. McKenney 		if (likely(srcu_init_done))
698aacb5d91SPaul E. McKenney 			queue_delayed_work(rcu_gp_wq, &ssp->work,
699aacb5d91SPaul E. McKenney 					   srcu_get_delay(ssp));
700aacb5d91SPaul E. McKenney 		else if (list_empty(&ssp->work.work.entry))
701aacb5d91SPaul E. McKenney 			list_add(&ssp->work.work.entry, &srcu_boot_list);
702da915ad5SPaul E. McKenney 	}
703aacb5d91SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(ssp, flags);
704da915ad5SPaul E. McKenney }
705da915ad5SPaul E. McKenney 
706da915ad5SPaul E. McKenney /*
707dad81a20SPaul E. McKenney  * Wait until all readers counted by array index idx complete, but
708dad81a20SPaul E. McKenney  * loop an additional time if there is an expedited grace period pending.
709da915ad5SPaul E. McKenney  * The caller must ensure that ->srcu_idx is not changed while checking.
710dad81a20SPaul E. McKenney  */
711aacb5d91SPaul E. McKenney static bool try_check_zero(struct srcu_struct *ssp, int idx, int trycount)
712dad81a20SPaul E. McKenney {
713dad81a20SPaul E. McKenney 	for (;;) {
714aacb5d91SPaul E. McKenney 		if (srcu_readers_active_idx_check(ssp, idx))
715dad81a20SPaul E. McKenney 			return true;
716aacb5d91SPaul E. McKenney 		if (--trycount + !srcu_get_delay(ssp) <= 0)
717dad81a20SPaul E. McKenney 			return false;
718dad81a20SPaul E. McKenney 		udelay(SRCU_RETRY_CHECK_DELAY);
719dad81a20SPaul E. McKenney 	}
720dad81a20SPaul E. McKenney }
721dad81a20SPaul E. McKenney 
722dad81a20SPaul E. McKenney /*
723da915ad5SPaul E. McKenney  * Increment the ->srcu_idx counter so that future SRCU readers will
724da915ad5SPaul E. McKenney  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
725dad81a20SPaul E. McKenney  * us to wait for pre-existing readers in a starvation-free manner.
726dad81a20SPaul E. McKenney  */
727aacb5d91SPaul E. McKenney static void srcu_flip(struct srcu_struct *ssp)
728dad81a20SPaul E. McKenney {
729881ec9d2SPaul E. McKenney 	/*
730881ec9d2SPaul E. McKenney 	 * Ensure that if this updater saw a given reader's increment
731881ec9d2SPaul E. McKenney 	 * from __srcu_read_lock(), that reader was using an old value
732881ec9d2SPaul E. McKenney 	 * of ->srcu_idx.  Also ensure that if a given reader sees the
733881ec9d2SPaul E. McKenney 	 * new value of ->srcu_idx, this updater's earlier scans cannot
734881ec9d2SPaul E. McKenney 	 * have seen that reader's increments (which is OK, because this
735881ec9d2SPaul E. McKenney 	 * grace period need not wait on that reader).
736881ec9d2SPaul E. McKenney 	 */
737881ec9d2SPaul E. McKenney 	smp_mb(); /* E */  /* Pairs with B and C. */
738881ec9d2SPaul E. McKenney 
739aacb5d91SPaul E. McKenney 	WRITE_ONCE(ssp->srcu_idx, ssp->srcu_idx + 1);
740dad81a20SPaul E. McKenney 
741dad81a20SPaul E. McKenney 	/*
742dad81a20SPaul E. McKenney 	 * Ensure that if the updater misses an __srcu_read_unlock()
743dad81a20SPaul E. McKenney 	 * increment, that task's next __srcu_read_lock() will see the
744dad81a20SPaul E. McKenney 	 * above counter update.  Note that both this memory barrier
745dad81a20SPaul E. McKenney 	 * and the one in srcu_readers_active_idx_check() provide the
746dad81a20SPaul E. McKenney 	 * guarantee for __srcu_read_lock().
747dad81a20SPaul E. McKenney 	 */
748dad81a20SPaul E. McKenney 	smp_mb(); /* D */  /* Pairs with C. */
749dad81a20SPaul E. McKenney }
750dad81a20SPaul E. McKenney 
751dad81a20SPaul E. McKenney /*
7522da4b2a7SPaul E. McKenney  * If SRCU is likely idle, return true, otherwise return false.
7532da4b2a7SPaul E. McKenney  *
7542da4b2a7SPaul E. McKenney  * Note that it is OK for several current from-idle requests for a new
7552da4b2a7SPaul E. McKenney  * grace period from idle to specify expediting because they will all end
7562da4b2a7SPaul E. McKenney  * up requesting the same grace period anyhow.  So no loss.
7572da4b2a7SPaul E. McKenney  *
7582da4b2a7SPaul E. McKenney  * Note also that if any CPU (including the current one) is still invoking
7592da4b2a7SPaul E. McKenney  * callbacks, this function will nevertheless say "idle".  This is not
7602da4b2a7SPaul E. McKenney  * ideal, but the overhead of checking all CPUs' callback lists is even
7612da4b2a7SPaul E. McKenney  * less ideal, especially on large systems.  Furthermore, the wakeup
7622da4b2a7SPaul E. McKenney  * can happen before the callback is fully removed, so we have no choice
7632da4b2a7SPaul E. McKenney  * but to accept this type of error.
7642da4b2a7SPaul E. McKenney  *
7652da4b2a7SPaul E. McKenney  * This function is also subject to counter-wrap errors, but let's face
7662da4b2a7SPaul E. McKenney  * it, if this function was preempted for enough time for the counters
7672da4b2a7SPaul E. McKenney  * to wrap, it really doesn't matter whether or not we expedite the grace
7682da4b2a7SPaul E. McKenney  * period.  The extra overhead of a needlessly expedited grace period is
7697fef6cffSEthon Paul  * negligible when amortized over that time period, and the extra latency
7702da4b2a7SPaul E. McKenney  * of a needlessly non-expedited grace period is similarly negligible.
7712da4b2a7SPaul E. McKenney  */
772aacb5d91SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *ssp)
7732da4b2a7SPaul E. McKenney {
77422607d66SPaul E. McKenney 	unsigned long curseq;
7752da4b2a7SPaul E. McKenney 	unsigned long flags;
7762da4b2a7SPaul E. McKenney 	struct srcu_data *sdp;
77722607d66SPaul E. McKenney 	unsigned long t;
778844a378dSPaul E. McKenney 	unsigned long tlast;
7792da4b2a7SPaul E. McKenney 
780*bde50d8fSSebastian Andrzej Siewior 	check_init_srcu_struct(ssp);
7812da4b2a7SPaul E. McKenney 	/* If the local srcu_data structure has callbacks, not idle.  */
782*bde50d8fSSebastian Andrzej Siewior 	sdp = raw_cpu_ptr(ssp->sda);
783*bde50d8fSSebastian Andrzej Siewior 	spin_lock_irqsave_rcu_node(sdp, flags);
7842da4b2a7SPaul E. McKenney 	if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
785*bde50d8fSSebastian Andrzej Siewior 		spin_unlock_irqrestore_rcu_node(sdp, flags);
7862da4b2a7SPaul E. McKenney 		return false; /* Callbacks already present, so not idle. */
7872da4b2a7SPaul E. McKenney 	}
788*bde50d8fSSebastian Andrzej Siewior 	spin_unlock_irqrestore_rcu_node(sdp, flags);
7892da4b2a7SPaul E. McKenney 
7902da4b2a7SPaul E. McKenney 	/*
7912da4b2a7SPaul E. McKenney 	 * No local callbacks, so probabalistically probe global state.
7922da4b2a7SPaul E. McKenney 	 * Exact information would require acquiring locks, which would
7932da4b2a7SPaul E. McKenney 	 * kill scalability, hence the probabalistic nature of the probe.
7942da4b2a7SPaul E. McKenney 	 */
79522607d66SPaul E. McKenney 
79622607d66SPaul E. McKenney 	/* First, see if enough time has passed since the last GP. */
79722607d66SPaul E. McKenney 	t = ktime_get_mono_fast_ns();
798844a378dSPaul E. McKenney 	tlast = READ_ONCE(ssp->srcu_last_gp_end);
79922607d66SPaul E. McKenney 	if (exp_holdoff == 0 ||
800844a378dSPaul E. McKenney 	    time_in_range_open(t, tlast, tlast + exp_holdoff))
80122607d66SPaul E. McKenney 		return false; /* Too soon after last GP. */
80222607d66SPaul E. McKenney 
80322607d66SPaul E. McKenney 	/* Next, check for probable idleness. */
804aacb5d91SPaul E. McKenney 	curseq = rcu_seq_current(&ssp->srcu_gp_seq);
8052da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
806aacb5d91SPaul E. McKenney 	if (ULONG_CMP_LT(curseq, READ_ONCE(ssp->srcu_gp_seq_needed)))
8072da4b2a7SPaul E. McKenney 		return false; /* Grace period in progress, so not idle. */
8082da4b2a7SPaul E. McKenney 	smp_mb(); /* Order ->srcu_gp_seq with prior access. */
809aacb5d91SPaul E. McKenney 	if (curseq != rcu_seq_current(&ssp->srcu_gp_seq))
8102da4b2a7SPaul E. McKenney 		return false; /* GP # changed, so not idle. */
8112da4b2a7SPaul E. McKenney 	return true; /* With reasonable probability, idle! */
8122da4b2a7SPaul E. McKenney }
8132da4b2a7SPaul E. McKenney 
8142da4b2a7SPaul E. McKenney /*
815a602538eSPaul E. McKenney  * SRCU callback function to leak a callback.
816a602538eSPaul E. McKenney  */
817a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp)
818a602538eSPaul E. McKenney {
819a602538eSPaul E. McKenney }
820a602538eSPaul E. McKenney 
821a602538eSPaul E. McKenney /*
822da915ad5SPaul E. McKenney  * Enqueue an SRCU callback on the srcu_data structure associated with
823da915ad5SPaul E. McKenney  * the current CPU and the specified srcu_struct structure, initiating
824da915ad5SPaul E. McKenney  * grace-period processing if it is not already running.
825dad81a20SPaul E. McKenney  *
826dad81a20SPaul E. McKenney  * Note that all CPUs must agree that the grace period extended beyond
827dad81a20SPaul E. McKenney  * all pre-existing SRCU read-side critical section.  On systems with
828dad81a20SPaul E. McKenney  * more than one CPU, this means that when "func()" is invoked, each CPU
829dad81a20SPaul E. McKenney  * is guaranteed to have executed a full memory barrier since the end of
830dad81a20SPaul E. McKenney  * its last corresponding SRCU read-side critical section whose beginning
8315ef98a63SPaul E. McKenney  * preceded the call to call_srcu().  It also means that each CPU executing
832dad81a20SPaul E. McKenney  * an SRCU read-side critical section that continues beyond the start of
8335ef98a63SPaul E. McKenney  * "func()" must have executed a memory barrier after the call_srcu()
834dad81a20SPaul E. McKenney  * but before the beginning of that SRCU read-side critical section.
835dad81a20SPaul E. McKenney  * Note that these guarantees include CPUs that are offline, idle, or
836dad81a20SPaul E. McKenney  * executing in user mode, as well as CPUs that are executing in the kernel.
837dad81a20SPaul E. McKenney  *
8385ef98a63SPaul E. McKenney  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
839dad81a20SPaul E. McKenney  * resulting SRCU callback function "func()", then both CPU A and CPU
840dad81a20SPaul E. McKenney  * B are guaranteed to execute a full memory barrier during the time
8415ef98a63SPaul E. McKenney  * interval between the call to call_srcu() and the invocation of "func()".
842dad81a20SPaul E. McKenney  * This guarantee applies even if CPU A and CPU B are the same CPU (but
843dad81a20SPaul E. McKenney  * again only if the system has more than one CPU).
844dad81a20SPaul E. McKenney  *
845dad81a20SPaul E. McKenney  * Of course, these guarantees apply only for invocations of call_srcu(),
846dad81a20SPaul E. McKenney  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
847dad81a20SPaul E. McKenney  * srcu_struct structure.
848dad81a20SPaul E. McKenney  */
84911b00045SJiang Biao static void __call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
8501e9a038bSPaul E. McKenney 			rcu_callback_t func, bool do_norm)
851dad81a20SPaul E. McKenney {
852dad81a20SPaul E. McKenney 	unsigned long flags;
8530607ba84SPaul E. McKenney 	int idx;
8541e9a038bSPaul E. McKenney 	bool needexp = false;
855da915ad5SPaul E. McKenney 	bool needgp = false;
856da915ad5SPaul E. McKenney 	unsigned long s;
857da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
858dad81a20SPaul E. McKenney 
859aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
860a602538eSPaul E. McKenney 	if (debug_rcu_head_queue(rhp)) {
861a602538eSPaul E. McKenney 		/* Probable double call_srcu(), so leak the callback. */
862a602538eSPaul E. McKenney 		WRITE_ONCE(rhp->func, srcu_leak_callback);
863a602538eSPaul E. McKenney 		WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
864a602538eSPaul E. McKenney 		return;
865a602538eSPaul E. McKenney 	}
866da915ad5SPaul E. McKenney 	rhp->func = func;
867aacb5d91SPaul E. McKenney 	idx = srcu_read_lock(ssp);
868*bde50d8fSSebastian Andrzej Siewior 	sdp = raw_cpu_ptr(ssp->sda);
869*bde50d8fSSebastian Andrzej Siewior 	spin_lock_irqsave_rcu_node(sdp, flags);
87077a40f97SJoel Fernandes (Google) 	rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp);
871da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
872aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
873aacb5d91SPaul E. McKenney 	s = rcu_seq_snap(&ssp->srcu_gp_seq);
874da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
875da915ad5SPaul E. McKenney 	if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
876da915ad5SPaul E. McKenney 		sdp->srcu_gp_seq_needed = s;
877da915ad5SPaul E. McKenney 		needgp = true;
878dad81a20SPaul E. McKenney 	}
8791e9a038bSPaul E. McKenney 	if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
8801e9a038bSPaul E. McKenney 		sdp->srcu_gp_seq_needed_exp = s;
8811e9a038bSPaul E. McKenney 		needexp = true;
8821e9a038bSPaul E. McKenney 	}
883d6331980SPaul E. McKenney 	spin_unlock_irqrestore_rcu_node(sdp, flags);
884da915ad5SPaul E. McKenney 	if (needgp)
885aacb5d91SPaul E. McKenney 		srcu_funnel_gp_start(ssp, sdp, s, do_norm);
8861e9a038bSPaul E. McKenney 	else if (needexp)
887aacb5d91SPaul E. McKenney 		srcu_funnel_exp_start(ssp, sdp->mynode, s);
888aacb5d91SPaul E. McKenney 	srcu_read_unlock(ssp, idx);
8891e9a038bSPaul E. McKenney }
8901e9a038bSPaul E. McKenney 
8915a0465e1SPaul E. McKenney /**
8925a0465e1SPaul E. McKenney  * call_srcu() - Queue a callback for invocation after an SRCU grace period
893aacb5d91SPaul E. McKenney  * @ssp: srcu_struct in queue the callback
89427fdb35fSPaul E. McKenney  * @rhp: structure to be used for queueing the SRCU callback.
8955a0465e1SPaul E. McKenney  * @func: function to be invoked after the SRCU grace period
8965a0465e1SPaul E. McKenney  *
8975a0465e1SPaul E. McKenney  * The callback function will be invoked some time after a full SRCU
8985a0465e1SPaul E. McKenney  * grace period elapses, in other words after all pre-existing SRCU
8995a0465e1SPaul E. McKenney  * read-side critical sections have completed.  However, the callback
9005a0465e1SPaul E. McKenney  * function might well execute concurrently with other SRCU read-side
9015a0465e1SPaul E. McKenney  * critical sections that started after call_srcu() was invoked.  SRCU
9025a0465e1SPaul E. McKenney  * read-side critical sections are delimited by srcu_read_lock() and
9035a0465e1SPaul E. McKenney  * srcu_read_unlock(), and may be nested.
9045a0465e1SPaul E. McKenney  *
9055a0465e1SPaul E. McKenney  * The callback will be invoked from process context, but must nevertheless
9065a0465e1SPaul E. McKenney  * be fast and must not block.
9075a0465e1SPaul E. McKenney  */
908aacb5d91SPaul E. McKenney void call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
9091e9a038bSPaul E. McKenney 	       rcu_callback_t func)
9101e9a038bSPaul E. McKenney {
911aacb5d91SPaul E. McKenney 	__call_srcu(ssp, rhp, func, true);
912dad81a20SPaul E. McKenney }
913dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu);
914dad81a20SPaul E. McKenney 
915dad81a20SPaul E. McKenney /*
916dad81a20SPaul E. McKenney  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
917dad81a20SPaul E. McKenney  */
918aacb5d91SPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *ssp, bool do_norm)
919dad81a20SPaul E. McKenney {
920dad81a20SPaul E. McKenney 	struct rcu_synchronize rcu;
921dad81a20SPaul E. McKenney 
922aacb5d91SPaul E. McKenney 	RCU_LOCKDEP_WARN(lock_is_held(&ssp->dep_map) ||
923dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_bh_lock_map) ||
924dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_lock_map) ||
925dad81a20SPaul E. McKenney 			 lock_is_held(&rcu_sched_lock_map),
926dad81a20SPaul E. McKenney 			 "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
927dad81a20SPaul E. McKenney 
928dad81a20SPaul E. McKenney 	if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
929dad81a20SPaul E. McKenney 		return;
930dad81a20SPaul E. McKenney 	might_sleep();
931aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
932dad81a20SPaul E. McKenney 	init_completion(&rcu.completion);
933da915ad5SPaul E. McKenney 	init_rcu_head_on_stack(&rcu.head);
934aacb5d91SPaul E. McKenney 	__call_srcu(ssp, &rcu.head, wakeme_after_rcu, do_norm);
935dad81a20SPaul E. McKenney 	wait_for_completion(&rcu.completion);
936da915ad5SPaul E. McKenney 	destroy_rcu_head_on_stack(&rcu.head);
93735732cf9SPaul E. McKenney 
93835732cf9SPaul E. McKenney 	/*
93935732cf9SPaul E. McKenney 	 * Make sure that later code is ordered after the SRCU grace
940d6331980SPaul E. McKenney 	 * period.  This pairs with the spin_lock_irq_rcu_node()
94135732cf9SPaul E. McKenney 	 * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
94235732cf9SPaul E. McKenney 	 * because the current CPU might have been totally uninvolved with
94335732cf9SPaul E. McKenney 	 * (and thus unordered against) that grace period.
94435732cf9SPaul E. McKenney 	 */
94535732cf9SPaul E. McKenney 	smp_mb();
946dad81a20SPaul E. McKenney }
947dad81a20SPaul E. McKenney 
948dad81a20SPaul E. McKenney /**
949dad81a20SPaul E. McKenney  * synchronize_srcu_expedited - Brute-force SRCU grace period
950aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
951dad81a20SPaul E. McKenney  *
952dad81a20SPaul E. McKenney  * Wait for an SRCU grace period to elapse, but be more aggressive about
953dad81a20SPaul E. McKenney  * spinning rather than blocking when waiting.
954dad81a20SPaul E. McKenney  *
955dad81a20SPaul E. McKenney  * Note that synchronize_srcu_expedited() has the same deadlock and
956dad81a20SPaul E. McKenney  * memory-ordering properties as does synchronize_srcu().
957dad81a20SPaul E. McKenney  */
958aacb5d91SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *ssp)
959dad81a20SPaul E. McKenney {
960aacb5d91SPaul E. McKenney 	__synchronize_srcu(ssp, rcu_gp_is_normal());
961dad81a20SPaul E. McKenney }
962dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
963dad81a20SPaul E. McKenney 
964dad81a20SPaul E. McKenney /**
965dad81a20SPaul E. McKenney  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
966aacb5d91SPaul E. McKenney  * @ssp: srcu_struct with which to synchronize.
967dad81a20SPaul E. McKenney  *
968dad81a20SPaul E. McKenney  * Wait for the count to drain to zero of both indexes. To avoid the
969dad81a20SPaul E. McKenney  * possible starvation of synchronize_srcu(), it waits for the count of
970da915ad5SPaul E. McKenney  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
971da915ad5SPaul E. McKenney  * and then flip the srcu_idx and wait for the count of the other index.
972dad81a20SPaul E. McKenney  *
973dad81a20SPaul E. McKenney  * Can block; must be called from process context.
974dad81a20SPaul E. McKenney  *
975dad81a20SPaul E. McKenney  * Note that it is illegal to call synchronize_srcu() from the corresponding
976dad81a20SPaul E. McKenney  * SRCU read-side critical section; doing so will result in deadlock.
977dad81a20SPaul E. McKenney  * However, it is perfectly legal to call synchronize_srcu() on one
978dad81a20SPaul E. McKenney  * srcu_struct from some other srcu_struct's read-side critical section,
979dad81a20SPaul E. McKenney  * as long as the resulting graph of srcu_structs is acyclic.
980dad81a20SPaul E. McKenney  *
981dad81a20SPaul E. McKenney  * There are memory-ordering constraints implied by synchronize_srcu().
982dad81a20SPaul E. McKenney  * On systems with more than one CPU, when synchronize_srcu() returns,
983dad81a20SPaul E. McKenney  * each CPU is guaranteed to have executed a full memory barrier since
9846eb95cc4SPaul E. McKenney  * the end of its last corresponding SRCU read-side critical section
985dad81a20SPaul E. McKenney  * whose beginning preceded the call to synchronize_srcu().  In addition,
986dad81a20SPaul E. McKenney  * each CPU having an SRCU read-side critical section that extends beyond
987dad81a20SPaul E. McKenney  * the return from synchronize_srcu() is guaranteed to have executed a
988dad81a20SPaul E. McKenney  * full memory barrier after the beginning of synchronize_srcu() and before
989dad81a20SPaul E. McKenney  * the beginning of that SRCU read-side critical section.  Note that these
990dad81a20SPaul E. McKenney  * guarantees include CPUs that are offline, idle, or executing in user mode,
991dad81a20SPaul E. McKenney  * as well as CPUs that are executing in the kernel.
992dad81a20SPaul E. McKenney  *
993dad81a20SPaul E. McKenney  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
994dad81a20SPaul E. McKenney  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
995dad81a20SPaul E. McKenney  * to have executed a full memory barrier during the execution of
996dad81a20SPaul E. McKenney  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
997dad81a20SPaul E. McKenney  * are the same CPU, but again only if the system has more than one CPU.
998dad81a20SPaul E. McKenney  *
999dad81a20SPaul E. McKenney  * Of course, these memory-ordering guarantees apply only when
1000dad81a20SPaul E. McKenney  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
1001dad81a20SPaul E. McKenney  * passed the same srcu_struct structure.
10022da4b2a7SPaul E. McKenney  *
10032da4b2a7SPaul E. McKenney  * If SRCU is likely idle, expedite the first request.  This semantic
10042da4b2a7SPaul E. McKenney  * was provided by Classic SRCU, and is relied upon by its users, so TREE
10052da4b2a7SPaul E. McKenney  * SRCU must also provide it.  Note that detecting idleness is heuristic
10062da4b2a7SPaul E. McKenney  * and subject to both false positives and negatives.
1007dad81a20SPaul E. McKenney  */
1008aacb5d91SPaul E. McKenney void synchronize_srcu(struct srcu_struct *ssp)
1009dad81a20SPaul E. McKenney {
1010aacb5d91SPaul E. McKenney 	if (srcu_might_be_idle(ssp) || rcu_gp_is_expedited())
1011aacb5d91SPaul E. McKenney 		synchronize_srcu_expedited(ssp);
1012dad81a20SPaul E. McKenney 	else
1013aacb5d91SPaul E. McKenney 		__synchronize_srcu(ssp, true);
1014dad81a20SPaul E. McKenney }
1015dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu);
1016dad81a20SPaul E. McKenney 
1017da915ad5SPaul E. McKenney /*
1018da915ad5SPaul E. McKenney  * Callback function for srcu_barrier() use.
1019da915ad5SPaul E. McKenney  */
1020da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp)
1021da915ad5SPaul E. McKenney {
1022da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1023aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1024da915ad5SPaul E. McKenney 
1025da915ad5SPaul E. McKenney 	sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1026aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1027aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1028aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1029da915ad5SPaul E. McKenney }
1030da915ad5SPaul E. McKenney 
1031dad81a20SPaul E. McKenney /**
1032dad81a20SPaul E. McKenney  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1033aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to wait for in-flight callbacks.
1034dad81a20SPaul E. McKenney  */
1035aacb5d91SPaul E. McKenney void srcu_barrier(struct srcu_struct *ssp)
1036dad81a20SPaul E. McKenney {
1037da915ad5SPaul E. McKenney 	int cpu;
1038da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1039aacb5d91SPaul E. McKenney 	unsigned long s = rcu_seq_snap(&ssp->srcu_barrier_seq);
1040da915ad5SPaul E. McKenney 
1041aacb5d91SPaul E. McKenney 	check_init_srcu_struct(ssp);
1042aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_barrier_mutex);
1043aacb5d91SPaul E. McKenney 	if (rcu_seq_done(&ssp->srcu_barrier_seq, s)) {
1044da915ad5SPaul E. McKenney 		smp_mb(); /* Force ordering following return. */
1045aacb5d91SPaul E. McKenney 		mutex_unlock(&ssp->srcu_barrier_mutex);
1046da915ad5SPaul E. McKenney 		return; /* Someone else did our work for us. */
1047da915ad5SPaul E. McKenney 	}
1048aacb5d91SPaul E. McKenney 	rcu_seq_start(&ssp->srcu_barrier_seq);
1049aacb5d91SPaul E. McKenney 	init_completion(&ssp->srcu_barrier_completion);
1050da915ad5SPaul E. McKenney 
1051da915ad5SPaul E. McKenney 	/* Initial count prevents reaching zero until all CBs are posted. */
1052aacb5d91SPaul E. McKenney 	atomic_set(&ssp->srcu_barrier_cpu_cnt, 1);
1053da915ad5SPaul E. McKenney 
1054da915ad5SPaul E. McKenney 	/*
1055da915ad5SPaul E. McKenney 	 * Each pass through this loop enqueues a callback, but only
1056da915ad5SPaul E. McKenney 	 * on CPUs already having callbacks enqueued.  Note that if
1057da915ad5SPaul E. McKenney 	 * a CPU already has callbacks enqueue, it must have already
1058da915ad5SPaul E. McKenney 	 * registered the need for a future grace period, so all we
1059da915ad5SPaul E. McKenney 	 * need do is enqueue a callback that will use the same
1060da915ad5SPaul E. McKenney 	 * grace period as the last callback already in the queue.
1061da915ad5SPaul E. McKenney 	 */
1062da915ad5SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1063aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
1064d6331980SPaul E. McKenney 		spin_lock_irq_rcu_node(sdp);
1065aacb5d91SPaul E. McKenney 		atomic_inc(&ssp->srcu_barrier_cpu_cnt);
1066da915ad5SPaul E. McKenney 		sdp->srcu_barrier_head.func = srcu_barrier_cb;
1067a602538eSPaul E. McKenney 		debug_rcu_head_queue(&sdp->srcu_barrier_head);
1068da915ad5SPaul E. McKenney 		if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
106977a40f97SJoel Fernandes (Google) 					   &sdp->srcu_barrier_head)) {
1070a602538eSPaul E. McKenney 			debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1071aacb5d91SPaul E. McKenney 			atomic_dec(&ssp->srcu_barrier_cpu_cnt);
1072a602538eSPaul E. McKenney 		}
1073d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1074da915ad5SPaul E. McKenney 	}
1075da915ad5SPaul E. McKenney 
1076da915ad5SPaul E. McKenney 	/* Remove the initial count, at which point reaching zero can happen. */
1077aacb5d91SPaul E. McKenney 	if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1078aacb5d91SPaul E. McKenney 		complete(&ssp->srcu_barrier_completion);
1079aacb5d91SPaul E. McKenney 	wait_for_completion(&ssp->srcu_barrier_completion);
1080da915ad5SPaul E. McKenney 
1081aacb5d91SPaul E. McKenney 	rcu_seq_end(&ssp->srcu_barrier_seq);
1082aacb5d91SPaul E. McKenney 	mutex_unlock(&ssp->srcu_barrier_mutex);
1083dad81a20SPaul E. McKenney }
1084dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier);
1085dad81a20SPaul E. McKenney 
1086dad81a20SPaul E. McKenney /**
1087dad81a20SPaul E. McKenney  * srcu_batches_completed - return batches completed.
1088aacb5d91SPaul E. McKenney  * @ssp: srcu_struct on which to report batch completion.
1089dad81a20SPaul E. McKenney  *
1090dad81a20SPaul E. McKenney  * Report the number of batches, correlated with, but not necessarily
1091dad81a20SPaul E. McKenney  * precisely the same as, the number of grace periods that have elapsed.
1092dad81a20SPaul E. McKenney  */
1093aacb5d91SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *ssp)
1094dad81a20SPaul E. McKenney {
109539f91504SPaul E. McKenney 	return READ_ONCE(ssp->srcu_idx);
1096dad81a20SPaul E. McKenney }
1097dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed);
1098dad81a20SPaul E. McKenney 
1099dad81a20SPaul E. McKenney /*
1100da915ad5SPaul E. McKenney  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1101da915ad5SPaul E. McKenney  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1102da915ad5SPaul E. McKenney  * completed in that state.
1103dad81a20SPaul E. McKenney  */
1104aacb5d91SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *ssp)
1105dad81a20SPaul E. McKenney {
1106dad81a20SPaul E. McKenney 	int idx;
1107dad81a20SPaul E. McKenney 
1108aacb5d91SPaul E. McKenney 	mutex_lock(&ssp->srcu_gp_mutex);
1109da915ad5SPaul E. McKenney 
1110dad81a20SPaul E. McKenney 	/*
1111dad81a20SPaul E. McKenney 	 * Because readers might be delayed for an extended period after
1112da915ad5SPaul E. McKenney 	 * fetching ->srcu_idx for their index, at any point in time there
1113dad81a20SPaul E. McKenney 	 * might well be readers using both idx=0 and idx=1.  We therefore
1114dad81a20SPaul E. McKenney 	 * need to wait for readers to clear from both index values before
1115dad81a20SPaul E. McKenney 	 * invoking a callback.
1116dad81a20SPaul E. McKenney 	 *
1117dad81a20SPaul E. McKenney 	 * The load-acquire ensures that we see the accesses performed
1118dad81a20SPaul E. McKenney 	 * by the prior grace period.
1119dad81a20SPaul E. McKenney 	 */
1120aacb5d91SPaul E. McKenney 	idx = rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq)); /* ^^^ */
1121dad81a20SPaul E. McKenney 	if (idx == SRCU_STATE_IDLE) {
1122aacb5d91SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp);
1123aacb5d91SPaul E. McKenney 		if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1124aacb5d91SPaul E. McKenney 			WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq));
1125aacb5d91SPaul E. McKenney 			spin_unlock_irq_rcu_node(ssp);
1126aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1127dad81a20SPaul E. McKenney 			return;
1128dad81a20SPaul E. McKenney 		}
1129aacb5d91SPaul E. McKenney 		idx = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
1130dad81a20SPaul E. McKenney 		if (idx == SRCU_STATE_IDLE)
1131aacb5d91SPaul E. McKenney 			srcu_gp_start(ssp);
1132aacb5d91SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
1133da915ad5SPaul E. McKenney 		if (idx != SRCU_STATE_IDLE) {
1134aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1135dad81a20SPaul E. McKenney 			return; /* Someone else started the grace period. */
1136dad81a20SPaul E. McKenney 		}
1137da915ad5SPaul E. McKenney 	}
1138dad81a20SPaul E. McKenney 
1139aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1140aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1141aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 1)) {
1142aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1143dad81a20SPaul E. McKenney 			return; /* readers present, retry later. */
1144da915ad5SPaul E. McKenney 		}
1145aacb5d91SPaul E. McKenney 		srcu_flip(ssp);
114671042606SPaul E. McKenney 		spin_lock_irq_rcu_node(ssp);
1147aacb5d91SPaul E. McKenney 		rcu_seq_set_state(&ssp->srcu_gp_seq, SRCU_STATE_SCAN2);
114871042606SPaul E. McKenney 		spin_unlock_irq_rcu_node(ssp);
1149dad81a20SPaul E. McKenney 	}
1150dad81a20SPaul E. McKenney 
1151aacb5d91SPaul E. McKenney 	if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1152dad81a20SPaul E. McKenney 
1153dad81a20SPaul E. McKenney 		/*
1154dad81a20SPaul E. McKenney 		 * SRCU read-side critical sections are normally short,
1155dad81a20SPaul E. McKenney 		 * so check at least twice in quick succession after a flip.
1156dad81a20SPaul E. McKenney 		 */
1157aacb5d91SPaul E. McKenney 		idx = 1 ^ (ssp->srcu_idx & 1);
1158aacb5d91SPaul E. McKenney 		if (!try_check_zero(ssp, idx, 2)) {
1159aacb5d91SPaul E. McKenney 			mutex_unlock(&ssp->srcu_gp_mutex);
1160da915ad5SPaul E. McKenney 			return; /* readers present, retry later. */
1161da915ad5SPaul E. McKenney 		}
1162aacb5d91SPaul E. McKenney 		srcu_gp_end(ssp);  /* Releases ->srcu_gp_mutex. */
1163dad81a20SPaul E. McKenney 	}
1164dad81a20SPaul E. McKenney }
1165dad81a20SPaul E. McKenney 
1166dad81a20SPaul E. McKenney /*
1167dad81a20SPaul E. McKenney  * Invoke a limited number of SRCU callbacks that have passed through
1168dad81a20SPaul E. McKenney  * their grace period.  If there are more to do, SRCU will reschedule
1169dad81a20SPaul E. McKenney  * the workqueue.  Note that needed memory barriers have been executed
1170dad81a20SPaul E. McKenney  * in this task's context by srcu_readers_active_idx_check().
1171dad81a20SPaul E. McKenney  */
1172da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work)
1173dad81a20SPaul E. McKenney {
1174da915ad5SPaul E. McKenney 	bool more;
1175dad81a20SPaul E. McKenney 	struct rcu_cblist ready_cbs;
1176dad81a20SPaul E. McKenney 	struct rcu_head *rhp;
1177da915ad5SPaul E. McKenney 	struct srcu_data *sdp;
1178aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1179dad81a20SPaul E. McKenney 
1180e81baf4cSSebastian Andrzej Siewior 	sdp = container_of(work, struct srcu_data, work);
1181e81baf4cSSebastian Andrzej Siewior 
1182aacb5d91SPaul E. McKenney 	ssp = sdp->ssp;
1183dad81a20SPaul E. McKenney 	rcu_cblist_init(&ready_cbs);
1184d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1185da915ad5SPaul E. McKenney 	rcu_segcblist_advance(&sdp->srcu_cblist,
1186aacb5d91SPaul E. McKenney 			      rcu_seq_current(&ssp->srcu_gp_seq));
1187da915ad5SPaul E. McKenney 	if (sdp->srcu_cblist_invoking ||
1188da915ad5SPaul E. McKenney 	    !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1189d6331980SPaul E. McKenney 		spin_unlock_irq_rcu_node(sdp);
1190da915ad5SPaul E. McKenney 		return;  /* Someone else on the job or nothing to do. */
1191da915ad5SPaul E. McKenney 	}
1192da915ad5SPaul E. McKenney 
1193da915ad5SPaul E. McKenney 	/* We are on the job!  Extract and invoke ready callbacks. */
1194da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = true;
1195da915ad5SPaul E. McKenney 	rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1196d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1197dad81a20SPaul E. McKenney 	rhp = rcu_cblist_dequeue(&ready_cbs);
1198dad81a20SPaul E. McKenney 	for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1199a602538eSPaul E. McKenney 		debug_rcu_head_unqueue(rhp);
1200dad81a20SPaul E. McKenney 		local_bh_disable();
1201dad81a20SPaul E. McKenney 		rhp->func(rhp);
1202dad81a20SPaul E. McKenney 		local_bh_enable();
1203dad81a20SPaul E. McKenney 	}
1204da915ad5SPaul E. McKenney 
1205da915ad5SPaul E. McKenney 	/*
1206da915ad5SPaul E. McKenney 	 * Update counts, accelerate new callbacks, and if needed,
1207da915ad5SPaul E. McKenney 	 * schedule another round of callback invocation.
1208da915ad5SPaul E. McKenney 	 */
1209d6331980SPaul E. McKenney 	spin_lock_irq_rcu_node(sdp);
1210da915ad5SPaul E. McKenney 	rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1211da915ad5SPaul E. McKenney 	(void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1212aacb5d91SPaul E. McKenney 				       rcu_seq_snap(&ssp->srcu_gp_seq));
1213da915ad5SPaul E. McKenney 	sdp->srcu_cblist_invoking = false;
1214da915ad5SPaul E. McKenney 	more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1215d6331980SPaul E. McKenney 	spin_unlock_irq_rcu_node(sdp);
1216da915ad5SPaul E. McKenney 	if (more)
1217da915ad5SPaul E. McKenney 		srcu_schedule_cbs_sdp(sdp, 0);
1218dad81a20SPaul E. McKenney }
1219dad81a20SPaul E. McKenney 
1220dad81a20SPaul E. McKenney /*
1221dad81a20SPaul E. McKenney  * Finished one round of SRCU grace period.  Start another if there are
1222dad81a20SPaul E. McKenney  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1223dad81a20SPaul E. McKenney  */
1224aacb5d91SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay)
1225dad81a20SPaul E. McKenney {
1226da915ad5SPaul E. McKenney 	bool pushgp = true;
1227dad81a20SPaul E. McKenney 
1228aacb5d91SPaul E. McKenney 	spin_lock_irq_rcu_node(ssp);
1229aacb5d91SPaul E. McKenney 	if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1230aacb5d91SPaul E. McKenney 		if (!WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq))) {
1231da915ad5SPaul E. McKenney 			/* All requests fulfilled, time to go idle. */
1232da915ad5SPaul E. McKenney 			pushgp = false;
1233dad81a20SPaul E. McKenney 		}
1234aacb5d91SPaul E. McKenney 	} else if (!rcu_seq_state(ssp->srcu_gp_seq)) {
1235da915ad5SPaul E. McKenney 		/* Outstanding request and no GP.  Start one. */
1236aacb5d91SPaul E. McKenney 		srcu_gp_start(ssp);
1237da915ad5SPaul E. McKenney 	}
1238aacb5d91SPaul E. McKenney 	spin_unlock_irq_rcu_node(ssp);
1239dad81a20SPaul E. McKenney 
1240da915ad5SPaul E. McKenney 	if (pushgp)
1241aacb5d91SPaul E. McKenney 		queue_delayed_work(rcu_gp_wq, &ssp->work, delay);
1242dad81a20SPaul E. McKenney }
1243dad81a20SPaul E. McKenney 
1244dad81a20SPaul E. McKenney /*
1245dad81a20SPaul E. McKenney  * This is the work-queue function that handles SRCU grace periods.
1246dad81a20SPaul E. McKenney  */
12470d8a1e83SPaul E. McKenney static void process_srcu(struct work_struct *work)
1248dad81a20SPaul E. McKenney {
1249aacb5d91SPaul E. McKenney 	struct srcu_struct *ssp;
1250dad81a20SPaul E. McKenney 
1251aacb5d91SPaul E. McKenney 	ssp = container_of(work, struct srcu_struct, work.work);
1252dad81a20SPaul E. McKenney 
1253aacb5d91SPaul E. McKenney 	srcu_advance_state(ssp);
1254aacb5d91SPaul E. McKenney 	srcu_reschedule(ssp, srcu_get_delay(ssp));
1255dad81a20SPaul E. McKenney }
12567f6733c3SPaul E. McKenney 
12577f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type,
1258aacb5d91SPaul E. McKenney 			     struct srcu_struct *ssp, int *flags,
1259aebc8264SPaul E. McKenney 			     unsigned long *gp_seq)
12607f6733c3SPaul E. McKenney {
12617f6733c3SPaul E. McKenney 	if (test_type != SRCU_FLAVOR)
12627f6733c3SPaul E. McKenney 		return;
12637f6733c3SPaul E. McKenney 	*flags = 0;
1264aacb5d91SPaul E. McKenney 	*gp_seq = rcu_seq_current(&ssp->srcu_gp_seq);
12657f6733c3SPaul E. McKenney }
12667f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
12671f4f6da1SPaul E. McKenney 
1268aacb5d91SPaul E. McKenney void srcu_torture_stats_print(struct srcu_struct *ssp, char *tt, char *tf)
1269115a1a52SPaul E. McKenney {
1270115a1a52SPaul E. McKenney 	int cpu;
1271115a1a52SPaul E. McKenney 	int idx;
1272ac3748c6SPaul E. McKenney 	unsigned long s0 = 0, s1 = 0;
1273115a1a52SPaul E. McKenney 
1274aacb5d91SPaul E. McKenney 	idx = ssp->srcu_idx & 0x1;
127552e17ba1SPaul E. McKenney 	pr_alert("%s%s Tree SRCU g%ld per-CPU(idx=%d):",
1276aacb5d91SPaul E. McKenney 		 tt, tf, rcu_seq_current(&ssp->srcu_gp_seq), idx);
1277115a1a52SPaul E. McKenney 	for_each_possible_cpu(cpu) {
1278115a1a52SPaul E. McKenney 		unsigned long l0, l1;
1279115a1a52SPaul E. McKenney 		unsigned long u0, u1;
1280115a1a52SPaul E. McKenney 		long c0, c1;
12815ab07a8dSPaul E. McKenney 		struct srcu_data *sdp;
1282115a1a52SPaul E. McKenney 
1283aacb5d91SPaul E. McKenney 		sdp = per_cpu_ptr(ssp->sda, cpu);
1284b68c6146SPaul E. McKenney 		u0 = data_race(sdp->srcu_unlock_count[!idx]);
1285b68c6146SPaul E. McKenney 		u1 = data_race(sdp->srcu_unlock_count[idx]);
1286115a1a52SPaul E. McKenney 
1287115a1a52SPaul E. McKenney 		/*
1288115a1a52SPaul E. McKenney 		 * Make sure that a lock is always counted if the corresponding
1289115a1a52SPaul E. McKenney 		 * unlock is counted.
1290115a1a52SPaul E. McKenney 		 */
1291115a1a52SPaul E. McKenney 		smp_rmb();
1292115a1a52SPaul E. McKenney 
1293b68c6146SPaul E. McKenney 		l0 = data_race(sdp->srcu_lock_count[!idx]);
1294b68c6146SPaul E. McKenney 		l1 = data_race(sdp->srcu_lock_count[idx]);
1295115a1a52SPaul E. McKenney 
1296115a1a52SPaul E. McKenney 		c0 = l0 - u0;
1297115a1a52SPaul E. McKenney 		c1 = l1 - u1;
12987e210a65SPaul E. McKenney 		pr_cont(" %d(%ld,%ld %c)",
12997e210a65SPaul E. McKenney 			cpu, c0, c1,
13007e210a65SPaul E. McKenney 			"C."[rcu_segcblist_empty(&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 }
1330fe15b50cSPaul E. McKenney 
1331fe15b50cSPaul E. McKenney #ifdef CONFIG_MODULES
1332fe15b50cSPaul E. McKenney 
1333fe15b50cSPaul E. McKenney /* Initialize any global-scope srcu_struct structures used by this module. */
1334fe15b50cSPaul E. McKenney static int srcu_module_coming(struct module *mod)
1335fe15b50cSPaul E. McKenney {
1336fe15b50cSPaul E. McKenney 	int i;
1337fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1338fe15b50cSPaul E. McKenney 	int ret;
1339fe15b50cSPaul E. McKenney 
1340fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++) {
1341fe15b50cSPaul E. McKenney 		ret = init_srcu_struct(*(sspp++));
1342fe15b50cSPaul E. McKenney 		if (WARN_ON_ONCE(ret))
1343fe15b50cSPaul E. McKenney 			return ret;
1344fe15b50cSPaul E. McKenney 	}
1345fe15b50cSPaul E. McKenney 	return 0;
1346fe15b50cSPaul E. McKenney }
1347fe15b50cSPaul E. McKenney 
1348fe15b50cSPaul E. McKenney /* Clean up any global-scope srcu_struct structures used by this module. */
1349fe15b50cSPaul E. McKenney static void srcu_module_going(struct module *mod)
1350fe15b50cSPaul E. McKenney {
1351fe15b50cSPaul E. McKenney 	int i;
1352fe15b50cSPaul E. McKenney 	struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1353fe15b50cSPaul E. McKenney 
1354fe15b50cSPaul E. McKenney 	for (i = 0; i < mod->num_srcu_structs; i++)
1355fe15b50cSPaul E. McKenney 		cleanup_srcu_struct(*(sspp++));
1356fe15b50cSPaul E. McKenney }
1357fe15b50cSPaul E. McKenney 
1358fe15b50cSPaul E. McKenney /* Handle one module, either coming or going. */
1359fe15b50cSPaul E. McKenney static int srcu_module_notify(struct notifier_block *self,
1360fe15b50cSPaul E. McKenney 			      unsigned long val, void *data)
1361fe15b50cSPaul E. McKenney {
1362fe15b50cSPaul E. McKenney 	struct module *mod = data;
1363fe15b50cSPaul E. McKenney 	int ret = 0;
1364fe15b50cSPaul E. McKenney 
1365fe15b50cSPaul E. McKenney 	switch (val) {
1366fe15b50cSPaul E. McKenney 	case MODULE_STATE_COMING:
1367fe15b50cSPaul E. McKenney 		ret = srcu_module_coming(mod);
1368fe15b50cSPaul E. McKenney 		break;
1369fe15b50cSPaul E. McKenney 	case MODULE_STATE_GOING:
1370fe15b50cSPaul E. McKenney 		srcu_module_going(mod);
1371fe15b50cSPaul E. McKenney 		break;
1372fe15b50cSPaul E. McKenney 	default:
1373fe15b50cSPaul E. McKenney 		break;
1374fe15b50cSPaul E. McKenney 	}
1375fe15b50cSPaul E. McKenney 	return ret;
1376fe15b50cSPaul E. McKenney }
1377fe15b50cSPaul E. McKenney 
1378fe15b50cSPaul E. McKenney static struct notifier_block srcu_module_nb = {
1379fe15b50cSPaul E. McKenney 	.notifier_call = srcu_module_notify,
1380fe15b50cSPaul E. McKenney 	.priority = 0,
1381fe15b50cSPaul E. McKenney };
1382fe15b50cSPaul E. McKenney 
1383fe15b50cSPaul E. McKenney static __init int init_srcu_module_notifier(void)
1384fe15b50cSPaul E. McKenney {
1385fe15b50cSPaul E. McKenney 	int ret;
1386fe15b50cSPaul E. McKenney 
1387fe15b50cSPaul E. McKenney 	ret = register_module_notifier(&srcu_module_nb);
1388fe15b50cSPaul E. McKenney 	if (ret)
1389fe15b50cSPaul E. McKenney 		pr_warn("Failed to register srcu module notifier\n");
1390fe15b50cSPaul E. McKenney 	return ret;
1391fe15b50cSPaul E. McKenney }
1392fe15b50cSPaul E. McKenney late_initcall(init_srcu_module_notifier);
1393fe15b50cSPaul E. McKenney 
1394fe15b50cSPaul E. McKenney #endif /* #ifdef CONFIG_MODULES */
1395