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