GNU Linux-libre 5.4.200-gnu1
[releases.git] / kernel / rcu / srcutree.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Sleepable Read-Copy Update mechanism for mutual exclusion.
4  *
5  * Copyright (C) IBM Corporation, 2006
6  * Copyright (C) Fujitsu, 2012
7  *
8  * Author: Paul McKenney <paulmck@linux.ibm.com>
9  *         Lai Jiangshan <laijs@cn.fujitsu.com>
10  *
11  * For detailed explanation of Read-Copy Update mechanism see -
12  *              Documentation/RCU/ *.txt
13  *
14  */
15
16 #define pr_fmt(fmt) "rcu: " fmt
17
18 #include <linux/export.h>
19 #include <linux/mutex.h>
20 #include <linux/percpu.h>
21 #include <linux/preempt.h>
22 #include <linux/rcupdate_wait.h>
23 #include <linux/sched.h>
24 #include <linux/smp.h>
25 #include <linux/delay.h>
26 #include <linux/module.h>
27 #include <linux/srcu.h>
28
29 #include "rcu.h"
30 #include "rcu_segcblist.h"
31
32 /* Holdoff in nanoseconds for auto-expediting. */
33 #define DEFAULT_SRCU_EXP_HOLDOFF (25 * 1000)
34 static ulong exp_holdoff = DEFAULT_SRCU_EXP_HOLDOFF;
35 module_param(exp_holdoff, ulong, 0444);
36
37 /* Overflow-check frequency.  N bits roughly says every 2**N grace periods. */
38 static ulong counter_wrap_check = (ULONG_MAX >> 2);
39 module_param(counter_wrap_check, ulong, 0444);
40
41 /* Early-boot callback-management, so early that no lock is required! */
42 static LIST_HEAD(srcu_boot_list);
43 static bool __read_mostly srcu_init_done;
44
45 static void srcu_invoke_callbacks(struct work_struct *work);
46 static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay);
47 static void process_srcu(struct work_struct *work);
48 static void srcu_delay_timer(struct timer_list *t);
49
50 /* Wrappers for lock acquisition and release, see raw_spin_lock_rcu_node(). */
51 #define spin_lock_rcu_node(p)                                   \
52 do {                                                                    \
53         spin_lock(&ACCESS_PRIVATE(p, lock));                    \
54         smp_mb__after_unlock_lock();                                    \
55 } while (0)
56
57 #define spin_unlock_rcu_node(p) spin_unlock(&ACCESS_PRIVATE(p, lock))
58
59 #define spin_lock_irq_rcu_node(p)                                       \
60 do {                                                                    \
61         spin_lock_irq(&ACCESS_PRIVATE(p, lock));                        \
62         smp_mb__after_unlock_lock();                                    \
63 } while (0)
64
65 #define spin_unlock_irq_rcu_node(p)                                     \
66         spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
67
68 #define spin_lock_irqsave_rcu_node(p, flags)                    \
69 do {                                                                    \
70         spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags);     \
71         smp_mb__after_unlock_lock();                                    \
72 } while (0)
73
74 #define spin_unlock_irqrestore_rcu_node(p, flags)                       \
75         spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags) \
76
77 /*
78  * Initialize SRCU combining tree.  Note that statically allocated
79  * srcu_struct structures might already have srcu_read_lock() and
80  * srcu_read_unlock() running against them.  So if the is_static parameter
81  * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[].
82  */
83 static void init_srcu_struct_nodes(struct srcu_struct *ssp, bool is_static)
84 {
85         int cpu;
86         int i;
87         int level = 0;
88         int levelspread[RCU_NUM_LVLS];
89         struct srcu_data *sdp;
90         struct srcu_node *snp;
91         struct srcu_node *snp_first;
92
93         /* Initialize geometry if it has not already been initialized. */
94         rcu_init_geometry();
95
96         /* Work out the overall tree geometry. */
97         ssp->level[0] = &ssp->node[0];
98         for (i = 1; i < rcu_num_lvls; i++)
99                 ssp->level[i] = ssp->level[i - 1] + num_rcu_lvl[i - 1];
100         rcu_init_levelspread(levelspread, num_rcu_lvl);
101
102         /* Each pass through this loop initializes one srcu_node structure. */
103         srcu_for_each_node_breadth_first(ssp, snp) {
104                 spin_lock_init(&ACCESS_PRIVATE(snp, lock));
105                 WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) !=
106                              ARRAY_SIZE(snp->srcu_data_have_cbs));
107                 for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) {
108                         snp->srcu_have_cbs[i] = 0;
109                         snp->srcu_data_have_cbs[i] = 0;
110                 }
111                 snp->srcu_gp_seq_needed_exp = 0;
112                 snp->grplo = -1;
113                 snp->grphi = -1;
114                 if (snp == &ssp->node[0]) {
115                         /* Root node, special case. */
116                         snp->srcu_parent = NULL;
117                         continue;
118                 }
119
120                 /* Non-root node. */
121                 if (snp == ssp->level[level + 1])
122                         level++;
123                 snp->srcu_parent = ssp->level[level - 1] +
124                                    (snp - ssp->level[level]) /
125                                    levelspread[level - 1];
126         }
127
128         /*
129          * Initialize the per-CPU srcu_data array, which feeds into the
130          * leaves of the srcu_node tree.
131          */
132         WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) !=
133                      ARRAY_SIZE(sdp->srcu_unlock_count));
134         level = rcu_num_lvls - 1;
135         snp_first = ssp->level[level];
136         for_each_possible_cpu(cpu) {
137                 sdp = per_cpu_ptr(ssp->sda, cpu);
138                 spin_lock_init(&ACCESS_PRIVATE(sdp, lock));
139                 rcu_segcblist_init(&sdp->srcu_cblist);
140                 sdp->srcu_cblist_invoking = false;
141                 sdp->srcu_gp_seq_needed = ssp->srcu_gp_seq;
142                 sdp->srcu_gp_seq_needed_exp = ssp->srcu_gp_seq;
143                 sdp->mynode = &snp_first[cpu / levelspread[level]];
144                 for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) {
145                         if (snp->grplo < 0)
146                                 snp->grplo = cpu;
147                         snp->grphi = cpu;
148                 }
149                 sdp->cpu = cpu;
150                 INIT_WORK(&sdp->work, srcu_invoke_callbacks);
151                 timer_setup(&sdp->delay_work, srcu_delay_timer, 0);
152                 sdp->ssp = ssp;
153                 sdp->grpmask = 1 << (cpu - sdp->mynode->grplo);
154                 if (is_static)
155                         continue;
156
157                 /* Dynamically allocated, better be no srcu_read_locks()! */
158                 for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) {
159                         sdp->srcu_lock_count[i] = 0;
160                         sdp->srcu_unlock_count[i] = 0;
161                 }
162         }
163 }
164
165 /*
166  * Initialize non-compile-time initialized fields, including the
167  * associated srcu_node and srcu_data structures.  The is_static
168  * parameter is passed through to init_srcu_struct_nodes(), and
169  * also tells us that ->sda has already been wired up to srcu_data.
170  */
171 static int init_srcu_struct_fields(struct srcu_struct *ssp, bool is_static)
172 {
173         mutex_init(&ssp->srcu_cb_mutex);
174         mutex_init(&ssp->srcu_gp_mutex);
175         ssp->srcu_idx = 0;
176         ssp->srcu_gp_seq = 0;
177         ssp->srcu_barrier_seq = 0;
178         mutex_init(&ssp->srcu_barrier_mutex);
179         atomic_set(&ssp->srcu_barrier_cpu_cnt, 0);
180         INIT_DELAYED_WORK(&ssp->work, process_srcu);
181         if (!is_static)
182                 ssp->sda = alloc_percpu(struct srcu_data);
183         init_srcu_struct_nodes(ssp, is_static);
184         ssp->srcu_gp_seq_needed_exp = 0;
185         ssp->srcu_last_gp_end = ktime_get_mono_fast_ns();
186         smp_store_release(&ssp->srcu_gp_seq_needed, 0); /* Init done. */
187         return ssp->sda ? 0 : -ENOMEM;
188 }
189
190 #ifdef CONFIG_DEBUG_LOCK_ALLOC
191
192 int __init_srcu_struct(struct srcu_struct *ssp, const char *name,
193                        struct lock_class_key *key)
194 {
195         /* Don't re-initialize a lock while it is held. */
196         debug_check_no_locks_freed((void *)ssp, sizeof(*ssp));
197         lockdep_init_map(&ssp->dep_map, name, key, 0);
198         spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
199         return init_srcu_struct_fields(ssp, false);
200 }
201 EXPORT_SYMBOL_GPL(__init_srcu_struct);
202
203 #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
204
205 /**
206  * init_srcu_struct - initialize a sleep-RCU structure
207  * @ssp: structure to initialize.
208  *
209  * Must invoke this on a given srcu_struct before passing that srcu_struct
210  * to any other function.  Each srcu_struct represents a separate domain
211  * of SRCU protection.
212  */
213 int init_srcu_struct(struct srcu_struct *ssp)
214 {
215         spin_lock_init(&ACCESS_PRIVATE(ssp, lock));
216         return init_srcu_struct_fields(ssp, false);
217 }
218 EXPORT_SYMBOL_GPL(init_srcu_struct);
219
220 #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
221
222 /*
223  * First-use initialization of statically allocated srcu_struct
224  * structure.  Wiring up the combining tree is more than can be
225  * done with compile-time initialization, so this check is added
226  * to each update-side SRCU primitive.  Use ssp->lock, which -is-
227  * compile-time initialized, to resolve races involving multiple
228  * CPUs trying to garner first-use privileges.
229  */
230 static void check_init_srcu_struct(struct srcu_struct *ssp)
231 {
232         unsigned long flags;
233
234         /* The smp_load_acquire() pairs with the smp_store_release(). */
235         if (!rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq_needed))) /*^^^*/
236                 return; /* Already initialized. */
237         spin_lock_irqsave_rcu_node(ssp, flags);
238         if (!rcu_seq_state(ssp->srcu_gp_seq_needed)) {
239                 spin_unlock_irqrestore_rcu_node(ssp, flags);
240                 return;
241         }
242         init_srcu_struct_fields(ssp, true);
243         spin_unlock_irqrestore_rcu_node(ssp, flags);
244 }
245
246 /*
247  * Returns approximate total of the readers' ->srcu_lock_count[] values
248  * for the rank of per-CPU counters specified by idx.
249  */
250 static unsigned long srcu_readers_lock_idx(struct srcu_struct *ssp, int idx)
251 {
252         int cpu;
253         unsigned long sum = 0;
254
255         for_each_possible_cpu(cpu) {
256                 struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
257
258                 sum += READ_ONCE(cpuc->srcu_lock_count[idx]);
259         }
260         return sum;
261 }
262
263 /*
264  * Returns approximate total of the readers' ->srcu_unlock_count[] values
265  * for the rank of per-CPU counters specified by idx.
266  */
267 static unsigned long srcu_readers_unlock_idx(struct srcu_struct *ssp, int idx)
268 {
269         int cpu;
270         unsigned long sum = 0;
271
272         for_each_possible_cpu(cpu) {
273                 struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
274
275                 sum += READ_ONCE(cpuc->srcu_unlock_count[idx]);
276         }
277         return sum;
278 }
279
280 /*
281  * Return true if the number of pre-existing readers is determined to
282  * be zero.
283  */
284 static bool srcu_readers_active_idx_check(struct srcu_struct *ssp, int idx)
285 {
286         unsigned long unlocks;
287
288         unlocks = srcu_readers_unlock_idx(ssp, idx);
289
290         /*
291          * Make sure that a lock is always counted if the corresponding
292          * unlock is counted. Needs to be a smp_mb() as the read side may
293          * contain a read from a variable that is written to before the
294          * synchronize_srcu() in the write side. In this case smp_mb()s
295          * A and B act like the store buffering pattern.
296          *
297          * This smp_mb() also pairs with smp_mb() C to prevent accesses
298          * after the synchronize_srcu() from being executed before the
299          * grace period ends.
300          */
301         smp_mb(); /* A */
302
303         /*
304          * If the locks are the same as the unlocks, then there must have
305          * been no readers on this index at some time in between. This does
306          * not mean that there are no more readers, as one could have read
307          * the current index but not have incremented the lock counter yet.
308          *
309          * So suppose that the updater is preempted here for so long
310          * that more than ULONG_MAX non-nested readers come and go in
311          * the meantime.  It turns out that this cannot result in overflow
312          * because if a reader modifies its unlock count after we read it
313          * above, then that reader's next load of ->srcu_idx is guaranteed
314          * to get the new value, which will cause it to operate on the
315          * other bank of counters, where it cannot contribute to the
316          * overflow of these counters.  This means that there is a maximum
317          * of 2*NR_CPUS increments, which cannot overflow given current
318          * systems, especially not on 64-bit systems.
319          *
320          * OK, how about nesting?  This does impose a limit on nesting
321          * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient,
322          * especially on 64-bit systems.
323          */
324         return srcu_readers_lock_idx(ssp, idx) == unlocks;
325 }
326
327 /**
328  * srcu_readers_active - returns true if there are readers. and false
329  *                       otherwise
330  * @ssp: which srcu_struct to count active readers (holding srcu_read_lock).
331  *
332  * Note that this is not an atomic primitive, and can therefore suffer
333  * severe errors when invoked on an active srcu_struct.  That said, it
334  * can be useful as an error check at cleanup time.
335  */
336 static bool srcu_readers_active(struct srcu_struct *ssp)
337 {
338         int cpu;
339         unsigned long sum = 0;
340
341         for_each_possible_cpu(cpu) {
342                 struct srcu_data *cpuc = per_cpu_ptr(ssp->sda, cpu);
343
344                 sum += READ_ONCE(cpuc->srcu_lock_count[0]);
345                 sum += READ_ONCE(cpuc->srcu_lock_count[1]);
346                 sum -= READ_ONCE(cpuc->srcu_unlock_count[0]);
347                 sum -= READ_ONCE(cpuc->srcu_unlock_count[1]);
348         }
349         return sum;
350 }
351
352 #define SRCU_INTERVAL           1
353
354 /*
355  * Return grace-period delay, zero if there are expedited grace
356  * periods pending, SRCU_INTERVAL otherwise.
357  */
358 static unsigned long srcu_get_delay(struct srcu_struct *ssp)
359 {
360         if (ULONG_CMP_LT(READ_ONCE(ssp->srcu_gp_seq),
361                          READ_ONCE(ssp->srcu_gp_seq_needed_exp)))
362                 return 0;
363         return SRCU_INTERVAL;
364 }
365
366 /**
367  * cleanup_srcu_struct - deconstruct a sleep-RCU structure
368  * @ssp: structure to clean up.
369  *
370  * Must invoke this after you are finished using a given srcu_struct that
371  * was initialized via init_srcu_struct(), else you leak memory.
372  */
373 void cleanup_srcu_struct(struct srcu_struct *ssp)
374 {
375         int cpu;
376
377         if (WARN_ON(!srcu_get_delay(ssp)))
378                 return; /* Just leak it! */
379         if (WARN_ON(srcu_readers_active(ssp)))
380                 return; /* Just leak it! */
381         flush_delayed_work(&ssp->work);
382         for_each_possible_cpu(cpu) {
383                 struct srcu_data *sdp = per_cpu_ptr(ssp->sda, cpu);
384
385                 del_timer_sync(&sdp->delay_work);
386                 flush_work(&sdp->work);
387                 if (WARN_ON(rcu_segcblist_n_cbs(&sdp->srcu_cblist)))
388                         return; /* Forgot srcu_barrier(), so just leak it! */
389         }
390         if (WARN_ON(rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) != SRCU_STATE_IDLE) ||
391             WARN_ON(srcu_readers_active(ssp))) {
392                 pr_info("%s: Active srcu_struct %p state: %d\n",
393                         __func__, ssp, rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)));
394                 return; /* Caller forgot to stop doing call_srcu()? */
395         }
396         free_percpu(ssp->sda);
397         ssp->sda = NULL;
398 }
399 EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
400
401 /*
402  * Counts the new reader in the appropriate per-CPU element of the
403  * srcu_struct.
404  * Returns an index that must be passed to the matching srcu_read_unlock().
405  */
406 int __srcu_read_lock(struct srcu_struct *ssp)
407 {
408         int idx;
409
410         idx = READ_ONCE(ssp->srcu_idx) & 0x1;
411         this_cpu_inc(ssp->sda->srcu_lock_count[idx]);
412         smp_mb(); /* B */  /* Avoid leaking the critical section. */
413         return idx;
414 }
415 EXPORT_SYMBOL_GPL(__srcu_read_lock);
416
417 /*
418  * Removes the count for the old reader from the appropriate per-CPU
419  * element of the srcu_struct.  Note that this may well be a different
420  * CPU than that which was incremented by the corresponding srcu_read_lock().
421  */
422 void __srcu_read_unlock(struct srcu_struct *ssp, int idx)
423 {
424         smp_mb(); /* C */  /* Avoid leaking the critical section. */
425         this_cpu_inc(ssp->sda->srcu_unlock_count[idx]);
426 }
427 EXPORT_SYMBOL_GPL(__srcu_read_unlock);
428
429 /*
430  * We use an adaptive strategy for synchronize_srcu() and especially for
431  * synchronize_srcu_expedited().  We spin for a fixed time period
432  * (defined below) to allow SRCU readers to exit their read-side critical
433  * sections.  If there are still some readers after a few microseconds,
434  * we repeatedly block for 1-millisecond time periods.
435  */
436 #define SRCU_RETRY_CHECK_DELAY          5
437
438 /*
439  * Start an SRCU grace period.
440  */
441 static void srcu_gp_start(struct srcu_struct *ssp)
442 {
443         struct srcu_data *sdp = this_cpu_ptr(ssp->sda);
444         int state;
445
446         lockdep_assert_held(&ACCESS_PRIVATE(ssp, lock));
447         WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
448         spin_lock_rcu_node(sdp);  /* Interrupts already disabled. */
449         rcu_segcblist_advance(&sdp->srcu_cblist,
450                               rcu_seq_current(&ssp->srcu_gp_seq));
451         (void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
452                                        rcu_seq_snap(&ssp->srcu_gp_seq));
453         spin_unlock_rcu_node(sdp);  /* Interrupts remain disabled. */
454         smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */
455         rcu_seq_start(&ssp->srcu_gp_seq);
456         state = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
457         WARN_ON_ONCE(state != SRCU_STATE_SCAN1);
458 }
459
460
461 static void srcu_delay_timer(struct timer_list *t)
462 {
463         struct srcu_data *sdp = container_of(t, struct srcu_data, delay_work);
464
465         queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
466 }
467
468 static void srcu_queue_delayed_work_on(struct srcu_data *sdp,
469                                        unsigned long delay)
470 {
471         if (!delay) {
472                 queue_work_on(sdp->cpu, rcu_gp_wq, &sdp->work);
473                 return;
474         }
475
476         timer_reduce(&sdp->delay_work, jiffies + delay);
477 }
478
479 /*
480  * Schedule callback invocation for the specified srcu_data structure,
481  * if possible, on the corresponding CPU.
482  */
483 static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay)
484 {
485         srcu_queue_delayed_work_on(sdp, delay);
486 }
487
488 /*
489  * Schedule callback invocation for all srcu_data structures associated
490  * with the specified srcu_node structure that have callbacks for the
491  * just-completed grace period, the one corresponding to idx.  If possible,
492  * schedule this invocation on the corresponding CPUs.
493  */
494 static void srcu_schedule_cbs_snp(struct srcu_struct *ssp, struct srcu_node *snp,
495                                   unsigned long mask, unsigned long delay)
496 {
497         int cpu;
498
499         for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
500                 if (!(mask & (1 << (cpu - snp->grplo))))
501                         continue;
502                 srcu_schedule_cbs_sdp(per_cpu_ptr(ssp->sda, cpu), delay);
503         }
504 }
505
506 /*
507  * Note the end of an SRCU grace period.  Initiates callback invocation
508  * and starts a new grace period if needed.
509  *
510  * The ->srcu_cb_mutex acquisition does not protect any data, but
511  * instead prevents more than one grace period from starting while we
512  * are initiating callback invocation.  This allows the ->srcu_have_cbs[]
513  * array to have a finite number of elements.
514  */
515 static void srcu_gp_end(struct srcu_struct *ssp)
516 {
517         unsigned long cbdelay;
518         bool cbs;
519         bool last_lvl;
520         int cpu;
521         unsigned long flags;
522         unsigned long gpseq;
523         int idx;
524         unsigned long mask;
525         struct srcu_data *sdp;
526         struct srcu_node *snp;
527
528         /* Prevent more than one additional grace period. */
529         mutex_lock(&ssp->srcu_cb_mutex);
530
531         /* End the current grace period. */
532         spin_lock_irq_rcu_node(ssp);
533         idx = rcu_seq_state(ssp->srcu_gp_seq);
534         WARN_ON_ONCE(idx != SRCU_STATE_SCAN2);
535         cbdelay = srcu_get_delay(ssp);
536         WRITE_ONCE(ssp->srcu_last_gp_end, ktime_get_mono_fast_ns());
537         rcu_seq_end(&ssp->srcu_gp_seq);
538         gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
539         if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, gpseq))
540                 ssp->srcu_gp_seq_needed_exp = gpseq;
541         spin_unlock_irq_rcu_node(ssp);
542         mutex_unlock(&ssp->srcu_gp_mutex);
543         /* A new grace period can start at this point.  But only one. */
544
545         /* Initiate callback invocation as needed. */
546         idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs);
547         srcu_for_each_node_breadth_first(ssp, snp) {
548                 spin_lock_irq_rcu_node(snp);
549                 cbs = false;
550                 last_lvl = snp >= ssp->level[rcu_num_lvls - 1];
551                 if (last_lvl)
552                         cbs = snp->srcu_have_cbs[idx] == gpseq;
553                 snp->srcu_have_cbs[idx] = gpseq;
554                 rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1);
555                 if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq))
556                         snp->srcu_gp_seq_needed_exp = gpseq;
557                 mask = snp->srcu_data_have_cbs[idx];
558                 snp->srcu_data_have_cbs[idx] = 0;
559                 spin_unlock_irq_rcu_node(snp);
560                 if (cbs)
561                         srcu_schedule_cbs_snp(ssp, snp, mask, cbdelay);
562
563                 /* Occasionally prevent srcu_data counter wrap. */
564                 if (!(gpseq & counter_wrap_check) && last_lvl)
565                         for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) {
566                                 sdp = per_cpu_ptr(ssp->sda, cpu);
567                                 spin_lock_irqsave_rcu_node(sdp, flags);
568                                 if (ULONG_CMP_GE(gpseq,
569                                                  sdp->srcu_gp_seq_needed + 100))
570                                         sdp->srcu_gp_seq_needed = gpseq;
571                                 if (ULONG_CMP_GE(gpseq,
572                                                  sdp->srcu_gp_seq_needed_exp + 100))
573                                         sdp->srcu_gp_seq_needed_exp = gpseq;
574                                 spin_unlock_irqrestore_rcu_node(sdp, flags);
575                         }
576         }
577
578         /* Callback initiation done, allow grace periods after next. */
579         mutex_unlock(&ssp->srcu_cb_mutex);
580
581         /* Start a new grace period if needed. */
582         spin_lock_irq_rcu_node(ssp);
583         gpseq = rcu_seq_current(&ssp->srcu_gp_seq);
584         if (!rcu_seq_state(gpseq) &&
585             ULONG_CMP_LT(gpseq, ssp->srcu_gp_seq_needed)) {
586                 srcu_gp_start(ssp);
587                 spin_unlock_irq_rcu_node(ssp);
588                 srcu_reschedule(ssp, 0);
589         } else {
590                 spin_unlock_irq_rcu_node(ssp);
591         }
592 }
593
594 /*
595  * Funnel-locking scheme to scalably mediate many concurrent expedited
596  * grace-period requests.  This function is invoked for the first known
597  * expedited request for a grace period that has already been requested,
598  * but without expediting.  To start a completely new grace period,
599  * whether expedited or not, use srcu_funnel_gp_start() instead.
600  */
601 static void srcu_funnel_exp_start(struct srcu_struct *ssp, struct srcu_node *snp,
602                                   unsigned long s)
603 {
604         unsigned long flags;
605
606         for (; snp != NULL; snp = snp->srcu_parent) {
607                 if (rcu_seq_done(&ssp->srcu_gp_seq, s) ||
608                     ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s))
609                         return;
610                 spin_lock_irqsave_rcu_node(snp, flags);
611                 if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) {
612                         spin_unlock_irqrestore_rcu_node(snp, flags);
613                         return;
614                 }
615                 WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s);
616                 spin_unlock_irqrestore_rcu_node(snp, flags);
617         }
618         spin_lock_irqsave_rcu_node(ssp, flags);
619         if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
620                 ssp->srcu_gp_seq_needed_exp = s;
621         spin_unlock_irqrestore_rcu_node(ssp, flags);
622 }
623
624 /*
625  * Funnel-locking scheme to scalably mediate many concurrent grace-period
626  * requests.  The winner has to do the work of actually starting grace
627  * period s.  Losers must either ensure that their desired grace-period
628  * number is recorded on at least their leaf srcu_node structure, or they
629  * must take steps to invoke their own callbacks.
630  *
631  * Note that this function also does the work of srcu_funnel_exp_start(),
632  * in some cases by directly invoking it.
633  */
634 static void srcu_funnel_gp_start(struct srcu_struct *ssp, struct srcu_data *sdp,
635                                  unsigned long s, bool do_norm)
636 {
637         unsigned long flags;
638         int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs);
639         struct srcu_node *snp = sdp->mynode;
640         unsigned long snp_seq;
641
642         /* Each pass through the loop does one level of the srcu_node tree. */
643         for (; snp != NULL; snp = snp->srcu_parent) {
644                 if (rcu_seq_done(&ssp->srcu_gp_seq, s) && snp != sdp->mynode)
645                         return; /* GP already done and CBs recorded. */
646                 spin_lock_irqsave_rcu_node(snp, flags);
647                 if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) {
648                         snp_seq = snp->srcu_have_cbs[idx];
649                         if (snp == sdp->mynode && snp_seq == s)
650                                 snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
651                         spin_unlock_irqrestore_rcu_node(snp, flags);
652                         if (snp == sdp->mynode && snp_seq != s) {
653                                 srcu_schedule_cbs_sdp(sdp, do_norm
654                                                            ? SRCU_INTERVAL
655                                                            : 0);
656                                 return;
657                         }
658                         if (!do_norm)
659                                 srcu_funnel_exp_start(ssp, snp, s);
660                         return;
661                 }
662                 snp->srcu_have_cbs[idx] = s;
663                 if (snp == sdp->mynode)
664                         snp->srcu_data_have_cbs[idx] |= sdp->grpmask;
665                 if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s))
666                         snp->srcu_gp_seq_needed_exp = s;
667                 spin_unlock_irqrestore_rcu_node(snp, flags);
668         }
669
670         /* Top of tree, must ensure the grace period will be started. */
671         spin_lock_irqsave_rcu_node(ssp, flags);
672         if (ULONG_CMP_LT(ssp->srcu_gp_seq_needed, s)) {
673                 /*
674                  * Record need for grace period s.  Pair with load
675                  * acquire setting up for initialization.
676                  */
677                 smp_store_release(&ssp->srcu_gp_seq_needed, s); /*^^^*/
678         }
679         if (!do_norm && ULONG_CMP_LT(ssp->srcu_gp_seq_needed_exp, s))
680                 ssp->srcu_gp_seq_needed_exp = s;
681
682         /* If grace period not already done and none in progress, start it. */
683         if (!rcu_seq_done(&ssp->srcu_gp_seq, s) &&
684             rcu_seq_state(ssp->srcu_gp_seq) == SRCU_STATE_IDLE) {
685                 WARN_ON_ONCE(ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed));
686                 srcu_gp_start(ssp);
687                 if (likely(srcu_init_done))
688                         queue_delayed_work(rcu_gp_wq, &ssp->work,
689                                            srcu_get_delay(ssp));
690                 else if (list_empty(&ssp->work.work.entry))
691                         list_add(&ssp->work.work.entry, &srcu_boot_list);
692         }
693         spin_unlock_irqrestore_rcu_node(ssp, flags);
694 }
695
696 /*
697  * Wait until all readers counted by array index idx complete, but
698  * loop an additional time if there is an expedited grace period pending.
699  * The caller must ensure that ->srcu_idx is not changed while checking.
700  */
701 static bool try_check_zero(struct srcu_struct *ssp, int idx, int trycount)
702 {
703         for (;;) {
704                 if (srcu_readers_active_idx_check(ssp, idx))
705                         return true;
706                 if (--trycount + !srcu_get_delay(ssp) <= 0)
707                         return false;
708                 udelay(SRCU_RETRY_CHECK_DELAY);
709         }
710 }
711
712 /*
713  * Increment the ->srcu_idx counter so that future SRCU readers will
714  * use the other rank of the ->srcu_(un)lock_count[] arrays.  This allows
715  * us to wait for pre-existing readers in a starvation-free manner.
716  */
717 static void srcu_flip(struct srcu_struct *ssp)
718 {
719         /*
720          * Ensure that if this updater saw a given reader's increment
721          * from __srcu_read_lock(), that reader was using an old value
722          * of ->srcu_idx.  Also ensure that if a given reader sees the
723          * new value of ->srcu_idx, this updater's earlier scans cannot
724          * have seen that reader's increments (which is OK, because this
725          * grace period need not wait on that reader).
726          */
727         smp_mb(); /* E */  /* Pairs with B and C. */
728
729         WRITE_ONCE(ssp->srcu_idx, ssp->srcu_idx + 1);
730
731         /*
732          * Ensure that if the updater misses an __srcu_read_unlock()
733          * increment, that task's next __srcu_read_lock() will see the
734          * above counter update.  Note that both this memory barrier
735          * and the one in srcu_readers_active_idx_check() provide the
736          * guarantee for __srcu_read_lock().
737          */
738         smp_mb(); /* D */  /* Pairs with C. */
739 }
740
741 /*
742  * If SRCU is likely idle, return true, otherwise return false.
743  *
744  * Note that it is OK for several current from-idle requests for a new
745  * grace period from idle to specify expediting because they will all end
746  * up requesting the same grace period anyhow.  So no loss.
747  *
748  * Note also that if any CPU (including the current one) is still invoking
749  * callbacks, this function will nevertheless say "idle".  This is not
750  * ideal, but the overhead of checking all CPUs' callback lists is even
751  * less ideal, especially on large systems.  Furthermore, the wakeup
752  * can happen before the callback is fully removed, so we have no choice
753  * but to accept this type of error.
754  *
755  * This function is also subject to counter-wrap errors, but let's face
756  * it, if this function was preempted for enough time for the counters
757  * to wrap, it really doesn't matter whether or not we expedite the grace
758  * period.  The extra overhead of a needlessly expedited grace period is
759  * negligible when amoritized over that time period, and the extra latency
760  * of a needlessly non-expedited grace period is similarly negligible.
761  */
762 static bool srcu_might_be_idle(struct srcu_struct *ssp)
763 {
764         unsigned long curseq;
765         unsigned long flags;
766         struct srcu_data *sdp;
767         unsigned long t;
768         unsigned long tlast;
769
770         /* If the local srcu_data structure has callbacks, not idle.  */
771         local_irq_save(flags);
772         sdp = this_cpu_ptr(ssp->sda);
773         if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) {
774                 local_irq_restore(flags);
775                 return false; /* Callbacks already present, so not idle. */
776         }
777         local_irq_restore(flags);
778
779         /*
780          * No local callbacks, so probabalistically probe global state.
781          * Exact information would require acquiring locks, which would
782          * kill scalability, hence the probabalistic nature of the probe.
783          */
784
785         /* First, see if enough time has passed since the last GP. */
786         t = ktime_get_mono_fast_ns();
787         tlast = READ_ONCE(ssp->srcu_last_gp_end);
788         if (exp_holdoff == 0 ||
789             time_in_range_open(t, tlast, tlast + exp_holdoff))
790                 return false; /* Too soon after last GP. */
791
792         /* Next, check for probable idleness. */
793         curseq = rcu_seq_current(&ssp->srcu_gp_seq);
794         smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */
795         if (ULONG_CMP_LT(curseq, READ_ONCE(ssp->srcu_gp_seq_needed)))
796                 return false; /* Grace period in progress, so not idle. */
797         smp_mb(); /* Order ->srcu_gp_seq with prior access. */
798         if (curseq != rcu_seq_current(&ssp->srcu_gp_seq))
799                 return false; /* GP # changed, so not idle. */
800         return true; /* With reasonable probability, idle! */
801 }
802
803 /*
804  * SRCU callback function to leak a callback.
805  */
806 static void srcu_leak_callback(struct rcu_head *rhp)
807 {
808 }
809
810 /*
811  * Enqueue an SRCU callback on the srcu_data structure associated with
812  * the current CPU and the specified srcu_struct structure, initiating
813  * grace-period processing if it is not already running.
814  *
815  * Note that all CPUs must agree that the grace period extended beyond
816  * all pre-existing SRCU read-side critical section.  On systems with
817  * more than one CPU, this means that when "func()" is invoked, each CPU
818  * is guaranteed to have executed a full memory barrier since the end of
819  * its last corresponding SRCU read-side critical section whose beginning
820  * preceded the call to call_srcu().  It also means that each CPU executing
821  * an SRCU read-side critical section that continues beyond the start of
822  * "func()" must have executed a memory barrier after the call_srcu()
823  * but before the beginning of that SRCU read-side critical section.
824  * Note that these guarantees include CPUs that are offline, idle, or
825  * executing in user mode, as well as CPUs that are executing in the kernel.
826  *
827  * Furthermore, if CPU A invoked call_srcu() and CPU B invoked the
828  * resulting SRCU callback function "func()", then both CPU A and CPU
829  * B are guaranteed to execute a full memory barrier during the time
830  * interval between the call to call_srcu() and the invocation of "func()".
831  * This guarantee applies even if CPU A and CPU B are the same CPU (but
832  * again only if the system has more than one CPU).
833  *
834  * Of course, these guarantees apply only for invocations of call_srcu(),
835  * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
836  * srcu_struct structure.
837  */
838 static void __call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
839                         rcu_callback_t func, bool do_norm)
840 {
841         unsigned long flags;
842         int idx;
843         bool needexp = false;
844         bool needgp = false;
845         unsigned long s;
846         struct srcu_data *sdp;
847
848         check_init_srcu_struct(ssp);
849         if (debug_rcu_head_queue(rhp)) {
850                 /* Probable double call_srcu(), so leak the callback. */
851                 WRITE_ONCE(rhp->func, srcu_leak_callback);
852                 WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n");
853                 return;
854         }
855         rhp->func = func;
856         idx = srcu_read_lock(ssp);
857         local_irq_save(flags);
858         sdp = this_cpu_ptr(ssp->sda);
859         spin_lock_rcu_node(sdp);
860         rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp, false);
861         rcu_segcblist_advance(&sdp->srcu_cblist,
862                               rcu_seq_current(&ssp->srcu_gp_seq));
863         s = rcu_seq_snap(&ssp->srcu_gp_seq);
864         (void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s);
865         if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) {
866                 sdp->srcu_gp_seq_needed = s;
867                 needgp = true;
868         }
869         if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) {
870                 sdp->srcu_gp_seq_needed_exp = s;
871                 needexp = true;
872         }
873         spin_unlock_irqrestore_rcu_node(sdp, flags);
874         if (needgp)
875                 srcu_funnel_gp_start(ssp, sdp, s, do_norm);
876         else if (needexp)
877                 srcu_funnel_exp_start(ssp, sdp->mynode, s);
878         srcu_read_unlock(ssp, idx);
879 }
880
881 /**
882  * call_srcu() - Queue a callback for invocation after an SRCU grace period
883  * @ssp: srcu_struct in queue the callback
884  * @rhp: structure to be used for queueing the SRCU callback.
885  * @func: function to be invoked after the SRCU grace period
886  *
887  * The callback function will be invoked some time after a full SRCU
888  * grace period elapses, in other words after all pre-existing SRCU
889  * read-side critical sections have completed.  However, the callback
890  * function might well execute concurrently with other SRCU read-side
891  * critical sections that started after call_srcu() was invoked.  SRCU
892  * read-side critical sections are delimited by srcu_read_lock() and
893  * srcu_read_unlock(), and may be nested.
894  *
895  * The callback will be invoked from process context, but must nevertheless
896  * be fast and must not block.
897  */
898 void call_srcu(struct srcu_struct *ssp, struct rcu_head *rhp,
899                rcu_callback_t func)
900 {
901         __call_srcu(ssp, rhp, func, true);
902 }
903 EXPORT_SYMBOL_GPL(call_srcu);
904
905 /*
906  * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
907  */
908 static void __synchronize_srcu(struct srcu_struct *ssp, bool do_norm)
909 {
910         struct rcu_synchronize rcu;
911
912         RCU_LOCKDEP_WARN(lock_is_held(&ssp->dep_map) ||
913                          lock_is_held(&rcu_bh_lock_map) ||
914                          lock_is_held(&rcu_lock_map) ||
915                          lock_is_held(&rcu_sched_lock_map),
916                          "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section");
917
918         if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE)
919                 return;
920         might_sleep();
921         check_init_srcu_struct(ssp);
922         init_completion(&rcu.completion);
923         init_rcu_head_on_stack(&rcu.head);
924         __call_srcu(ssp, &rcu.head, wakeme_after_rcu, do_norm);
925         wait_for_completion(&rcu.completion);
926         destroy_rcu_head_on_stack(&rcu.head);
927
928         /*
929          * Make sure that later code is ordered after the SRCU grace
930          * period.  This pairs with the spin_lock_irq_rcu_node()
931          * in srcu_invoke_callbacks().  Unlike Tree RCU, this is needed
932          * because the current CPU might have been totally uninvolved with
933          * (and thus unordered against) that grace period.
934          */
935         smp_mb();
936 }
937
938 /**
939  * synchronize_srcu_expedited - Brute-force SRCU grace period
940  * @ssp: srcu_struct with which to synchronize.
941  *
942  * Wait for an SRCU grace period to elapse, but be more aggressive about
943  * spinning rather than blocking when waiting.
944  *
945  * Note that synchronize_srcu_expedited() has the same deadlock and
946  * memory-ordering properties as does synchronize_srcu().
947  */
948 void synchronize_srcu_expedited(struct srcu_struct *ssp)
949 {
950         __synchronize_srcu(ssp, rcu_gp_is_normal());
951 }
952 EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
953
954 /**
955  * synchronize_srcu - wait for prior SRCU read-side critical-section completion
956  * @ssp: srcu_struct with which to synchronize.
957  *
958  * Wait for the count to drain to zero of both indexes. To avoid the
959  * possible starvation of synchronize_srcu(), it waits for the count of
960  * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first,
961  * and then flip the srcu_idx and wait for the count of the other index.
962  *
963  * Can block; must be called from process context.
964  *
965  * Note that it is illegal to call synchronize_srcu() from the corresponding
966  * SRCU read-side critical section; doing so will result in deadlock.
967  * However, it is perfectly legal to call synchronize_srcu() on one
968  * srcu_struct from some other srcu_struct's read-side critical section,
969  * as long as the resulting graph of srcu_structs is acyclic.
970  *
971  * There are memory-ordering constraints implied by synchronize_srcu().
972  * On systems with more than one CPU, when synchronize_srcu() returns,
973  * each CPU is guaranteed to have executed a full memory barrier since
974  * the end of its last corresponding SRCU read-side critical section
975  * whose beginning preceded the call to synchronize_srcu().  In addition,
976  * each CPU having an SRCU read-side critical section that extends beyond
977  * the return from synchronize_srcu() is guaranteed to have executed a
978  * full memory barrier after the beginning of synchronize_srcu() and before
979  * the beginning of that SRCU read-side critical section.  Note that these
980  * guarantees include CPUs that are offline, idle, or executing in user mode,
981  * as well as CPUs that are executing in the kernel.
982  *
983  * Furthermore, if CPU A invoked synchronize_srcu(), which returned
984  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
985  * to have executed a full memory barrier during the execution of
986  * synchronize_srcu().  This guarantee applies even if CPU A and CPU B
987  * are the same CPU, but again only if the system has more than one CPU.
988  *
989  * Of course, these memory-ordering guarantees apply only when
990  * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
991  * passed the same srcu_struct structure.
992  *
993  * If SRCU is likely idle, expedite the first request.  This semantic
994  * was provided by Classic SRCU, and is relied upon by its users, so TREE
995  * SRCU must also provide it.  Note that detecting idleness is heuristic
996  * and subject to both false positives and negatives.
997  */
998 void synchronize_srcu(struct srcu_struct *ssp)
999 {
1000         if (srcu_might_be_idle(ssp) || rcu_gp_is_expedited())
1001                 synchronize_srcu_expedited(ssp);
1002         else
1003                 __synchronize_srcu(ssp, true);
1004 }
1005 EXPORT_SYMBOL_GPL(synchronize_srcu);
1006
1007 /*
1008  * Callback function for srcu_barrier() use.
1009  */
1010 static void srcu_barrier_cb(struct rcu_head *rhp)
1011 {
1012         struct srcu_data *sdp;
1013         struct srcu_struct *ssp;
1014
1015         sdp = container_of(rhp, struct srcu_data, srcu_barrier_head);
1016         ssp = sdp->ssp;
1017         if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1018                 complete(&ssp->srcu_barrier_completion);
1019 }
1020
1021 /**
1022  * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
1023  * @ssp: srcu_struct on which to wait for in-flight callbacks.
1024  */
1025 void srcu_barrier(struct srcu_struct *ssp)
1026 {
1027         int cpu;
1028         struct srcu_data *sdp;
1029         unsigned long s = rcu_seq_snap(&ssp->srcu_barrier_seq);
1030
1031         check_init_srcu_struct(ssp);
1032         mutex_lock(&ssp->srcu_barrier_mutex);
1033         if (rcu_seq_done(&ssp->srcu_barrier_seq, s)) {
1034                 smp_mb(); /* Force ordering following return. */
1035                 mutex_unlock(&ssp->srcu_barrier_mutex);
1036                 return; /* Someone else did our work for us. */
1037         }
1038         rcu_seq_start(&ssp->srcu_barrier_seq);
1039         init_completion(&ssp->srcu_barrier_completion);
1040
1041         /* Initial count prevents reaching zero until all CBs are posted. */
1042         atomic_set(&ssp->srcu_barrier_cpu_cnt, 1);
1043
1044         /*
1045          * Each pass through this loop enqueues a callback, but only
1046          * on CPUs already having callbacks enqueued.  Note that if
1047          * a CPU already has callbacks enqueue, it must have already
1048          * registered the need for a future grace period, so all we
1049          * need do is enqueue a callback that will use the same
1050          * grace period as the last callback already in the queue.
1051          */
1052         for_each_possible_cpu(cpu) {
1053                 sdp = per_cpu_ptr(ssp->sda, cpu);
1054                 spin_lock_irq_rcu_node(sdp);
1055                 atomic_inc(&ssp->srcu_barrier_cpu_cnt);
1056                 sdp->srcu_barrier_head.func = srcu_barrier_cb;
1057                 debug_rcu_head_queue(&sdp->srcu_barrier_head);
1058                 if (!rcu_segcblist_entrain(&sdp->srcu_cblist,
1059                                            &sdp->srcu_barrier_head, 0)) {
1060                         debug_rcu_head_unqueue(&sdp->srcu_barrier_head);
1061                         atomic_dec(&ssp->srcu_barrier_cpu_cnt);
1062                 }
1063                 spin_unlock_irq_rcu_node(sdp);
1064         }
1065
1066         /* Remove the initial count, at which point reaching zero can happen. */
1067         if (atomic_dec_and_test(&ssp->srcu_barrier_cpu_cnt))
1068                 complete(&ssp->srcu_barrier_completion);
1069         wait_for_completion(&ssp->srcu_barrier_completion);
1070
1071         rcu_seq_end(&ssp->srcu_barrier_seq);
1072         mutex_unlock(&ssp->srcu_barrier_mutex);
1073 }
1074 EXPORT_SYMBOL_GPL(srcu_barrier);
1075
1076 /**
1077  * srcu_batches_completed - return batches completed.
1078  * @ssp: srcu_struct on which to report batch completion.
1079  *
1080  * Report the number of batches, correlated with, but not necessarily
1081  * precisely the same as, the number of grace periods that have elapsed.
1082  */
1083 unsigned long srcu_batches_completed(struct srcu_struct *ssp)
1084 {
1085         return ssp->srcu_idx;
1086 }
1087 EXPORT_SYMBOL_GPL(srcu_batches_completed);
1088
1089 /*
1090  * Core SRCU state machine.  Push state bits of ->srcu_gp_seq
1091  * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has
1092  * completed in that state.
1093  */
1094 static void srcu_advance_state(struct srcu_struct *ssp)
1095 {
1096         int idx;
1097
1098         mutex_lock(&ssp->srcu_gp_mutex);
1099
1100         /*
1101          * Because readers might be delayed for an extended period after
1102          * fetching ->srcu_idx for their index, at any point in time there
1103          * might well be readers using both idx=0 and idx=1.  We therefore
1104          * need to wait for readers to clear from both index values before
1105          * invoking a callback.
1106          *
1107          * The load-acquire ensures that we see the accesses performed
1108          * by the prior grace period.
1109          */
1110         idx = rcu_seq_state(smp_load_acquire(&ssp->srcu_gp_seq)); /* ^^^ */
1111         if (idx == SRCU_STATE_IDLE) {
1112                 spin_lock_irq_rcu_node(ssp);
1113                 if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1114                         WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq));
1115                         spin_unlock_irq_rcu_node(ssp);
1116                         mutex_unlock(&ssp->srcu_gp_mutex);
1117                         return;
1118                 }
1119                 idx = rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq));
1120                 if (idx == SRCU_STATE_IDLE)
1121                         srcu_gp_start(ssp);
1122                 spin_unlock_irq_rcu_node(ssp);
1123                 if (idx != SRCU_STATE_IDLE) {
1124                         mutex_unlock(&ssp->srcu_gp_mutex);
1125                         return; /* Someone else started the grace period. */
1126                 }
1127         }
1128
1129         if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN1) {
1130                 idx = 1 ^ (ssp->srcu_idx & 1);
1131                 if (!try_check_zero(ssp, idx, 1)) {
1132                         mutex_unlock(&ssp->srcu_gp_mutex);
1133                         return; /* readers present, retry later. */
1134                 }
1135                 srcu_flip(ssp);
1136                 rcu_seq_set_state(&ssp->srcu_gp_seq, SRCU_STATE_SCAN2);
1137         }
1138
1139         if (rcu_seq_state(READ_ONCE(ssp->srcu_gp_seq)) == SRCU_STATE_SCAN2) {
1140
1141                 /*
1142                  * SRCU read-side critical sections are normally short,
1143                  * so check at least twice in quick succession after a flip.
1144                  */
1145                 idx = 1 ^ (ssp->srcu_idx & 1);
1146                 if (!try_check_zero(ssp, idx, 2)) {
1147                         mutex_unlock(&ssp->srcu_gp_mutex);
1148                         return; /* readers present, retry later. */
1149                 }
1150                 srcu_gp_end(ssp);  /* Releases ->srcu_gp_mutex. */
1151         }
1152 }
1153
1154 /*
1155  * Invoke a limited number of SRCU callbacks that have passed through
1156  * their grace period.  If there are more to do, SRCU will reschedule
1157  * the workqueue.  Note that needed memory barriers have been executed
1158  * in this task's context by srcu_readers_active_idx_check().
1159  */
1160 static void srcu_invoke_callbacks(struct work_struct *work)
1161 {
1162         bool more;
1163         struct rcu_cblist ready_cbs;
1164         struct rcu_head *rhp;
1165         struct srcu_data *sdp;
1166         struct srcu_struct *ssp;
1167
1168         sdp = container_of(work, struct srcu_data, work);
1169
1170         ssp = sdp->ssp;
1171         rcu_cblist_init(&ready_cbs);
1172         spin_lock_irq_rcu_node(sdp);
1173         rcu_segcblist_advance(&sdp->srcu_cblist,
1174                               rcu_seq_current(&ssp->srcu_gp_seq));
1175         if (sdp->srcu_cblist_invoking ||
1176             !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) {
1177                 spin_unlock_irq_rcu_node(sdp);
1178                 return;  /* Someone else on the job or nothing to do. */
1179         }
1180
1181         /* We are on the job!  Extract and invoke ready callbacks. */
1182         sdp->srcu_cblist_invoking = true;
1183         rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs);
1184         spin_unlock_irq_rcu_node(sdp);
1185         rhp = rcu_cblist_dequeue(&ready_cbs);
1186         for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) {
1187                 debug_rcu_head_unqueue(rhp);
1188                 local_bh_disable();
1189                 rhp->func(rhp);
1190                 local_bh_enable();
1191         }
1192
1193         /*
1194          * Update counts, accelerate new callbacks, and if needed,
1195          * schedule another round of callback invocation.
1196          */
1197         spin_lock_irq_rcu_node(sdp);
1198         rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs);
1199         (void)rcu_segcblist_accelerate(&sdp->srcu_cblist,
1200                                        rcu_seq_snap(&ssp->srcu_gp_seq));
1201         sdp->srcu_cblist_invoking = false;
1202         more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist);
1203         spin_unlock_irq_rcu_node(sdp);
1204         if (more)
1205                 srcu_schedule_cbs_sdp(sdp, 0);
1206 }
1207
1208 /*
1209  * Finished one round of SRCU grace period.  Start another if there are
1210  * more SRCU callbacks queued, otherwise put SRCU into not-running state.
1211  */
1212 static void srcu_reschedule(struct srcu_struct *ssp, unsigned long delay)
1213 {
1214         bool pushgp = true;
1215
1216         spin_lock_irq_rcu_node(ssp);
1217         if (ULONG_CMP_GE(ssp->srcu_gp_seq, ssp->srcu_gp_seq_needed)) {
1218                 if (!WARN_ON_ONCE(rcu_seq_state(ssp->srcu_gp_seq))) {
1219                         /* All requests fulfilled, time to go idle. */
1220                         pushgp = false;
1221                 }
1222         } else if (!rcu_seq_state(ssp->srcu_gp_seq)) {
1223                 /* Outstanding request and no GP.  Start one. */
1224                 srcu_gp_start(ssp);
1225         }
1226         spin_unlock_irq_rcu_node(ssp);
1227
1228         if (pushgp)
1229                 queue_delayed_work(rcu_gp_wq, &ssp->work, delay);
1230 }
1231
1232 /*
1233  * This is the work-queue function that handles SRCU grace periods.
1234  */
1235 static void process_srcu(struct work_struct *work)
1236 {
1237         struct srcu_struct *ssp;
1238
1239         ssp = container_of(work, struct srcu_struct, work.work);
1240
1241         srcu_advance_state(ssp);
1242         srcu_reschedule(ssp, srcu_get_delay(ssp));
1243 }
1244
1245 void srcutorture_get_gp_data(enum rcutorture_type test_type,
1246                              struct srcu_struct *ssp, int *flags,
1247                              unsigned long *gp_seq)
1248 {
1249         if (test_type != SRCU_FLAVOR)
1250                 return;
1251         *flags = 0;
1252         *gp_seq = rcu_seq_current(&ssp->srcu_gp_seq);
1253 }
1254 EXPORT_SYMBOL_GPL(srcutorture_get_gp_data);
1255
1256 void srcu_torture_stats_print(struct srcu_struct *ssp, char *tt, char *tf)
1257 {
1258         int cpu;
1259         int idx;
1260         unsigned long s0 = 0, s1 = 0;
1261
1262         idx = ssp->srcu_idx & 0x1;
1263         pr_alert("%s%s Tree SRCU g%ld per-CPU(idx=%d):",
1264                  tt, tf, rcu_seq_current(&ssp->srcu_gp_seq), idx);
1265         for_each_possible_cpu(cpu) {
1266                 unsigned long l0, l1;
1267                 unsigned long u0, u1;
1268                 long c0, c1;
1269                 struct srcu_data *sdp;
1270
1271                 sdp = per_cpu_ptr(ssp->sda, cpu);
1272                 u0 = sdp->srcu_unlock_count[!idx];
1273                 u1 = sdp->srcu_unlock_count[idx];
1274
1275                 /*
1276                  * Make sure that a lock is always counted if the corresponding
1277                  * unlock is counted.
1278                  */
1279                 smp_rmb();
1280
1281                 l0 = sdp->srcu_lock_count[!idx];
1282                 l1 = sdp->srcu_lock_count[idx];
1283
1284                 c0 = l0 - u0;
1285                 c1 = l1 - u1;
1286                 pr_cont(" %d(%ld,%ld %c)",
1287                         cpu, c0, c1,
1288                         "C."[rcu_segcblist_empty(&sdp->srcu_cblist)]);
1289                 s0 += c0;
1290                 s1 += c1;
1291         }
1292         pr_cont(" T(%ld,%ld)\n", s0, s1);
1293 }
1294 EXPORT_SYMBOL_GPL(srcu_torture_stats_print);
1295
1296 static int __init srcu_bootup_announce(void)
1297 {
1298         pr_info("Hierarchical SRCU implementation.\n");
1299         if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF)
1300                 pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff);
1301         return 0;
1302 }
1303 early_initcall(srcu_bootup_announce);
1304
1305 void __init srcu_init(void)
1306 {
1307         struct srcu_struct *ssp;
1308
1309         srcu_init_done = true;
1310         while (!list_empty(&srcu_boot_list)) {
1311                 ssp = list_first_entry(&srcu_boot_list, struct srcu_struct,
1312                                       work.work.entry);
1313                 check_init_srcu_struct(ssp);
1314                 list_del_init(&ssp->work.work.entry);
1315                 queue_work(rcu_gp_wq, &ssp->work.work);
1316         }
1317 }
1318
1319 #ifdef CONFIG_MODULES
1320
1321 /* Initialize any global-scope srcu_struct structures used by this module. */
1322 static int srcu_module_coming(struct module *mod)
1323 {
1324         int i;
1325         struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1326         int ret;
1327
1328         for (i = 0; i < mod->num_srcu_structs; i++) {
1329                 ret = init_srcu_struct(*(sspp++));
1330                 if (WARN_ON_ONCE(ret))
1331                         return ret;
1332         }
1333         return 0;
1334 }
1335
1336 /* Clean up any global-scope srcu_struct structures used by this module. */
1337 static void srcu_module_going(struct module *mod)
1338 {
1339         int i;
1340         struct srcu_struct **sspp = mod->srcu_struct_ptrs;
1341
1342         for (i = 0; i < mod->num_srcu_structs; i++)
1343                 cleanup_srcu_struct(*(sspp++));
1344 }
1345
1346 /* Handle one module, either coming or going. */
1347 static int srcu_module_notify(struct notifier_block *self,
1348                               unsigned long val, void *data)
1349 {
1350         struct module *mod = data;
1351         int ret = 0;
1352
1353         switch (val) {
1354         case MODULE_STATE_COMING:
1355                 ret = srcu_module_coming(mod);
1356                 break;
1357         case MODULE_STATE_GOING:
1358                 srcu_module_going(mod);
1359                 break;
1360         default:
1361                 break;
1362         }
1363         return ret;
1364 }
1365
1366 static struct notifier_block srcu_module_nb = {
1367         .notifier_call = srcu_module_notify,
1368         .priority = 0,
1369 };
1370
1371 static __init int init_srcu_module_notifier(void)
1372 {
1373         int ret;
1374
1375         ret = register_module_notifier(&srcu_module_nb);
1376         if (ret)
1377                 pr_warn("Failed to register srcu module notifier\n");
1378         return ret;
1379 }
1380 late_initcall(init_srcu_module_notifier);
1381
1382 #endif /* #ifdef CONFIG_MODULES */