Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
a71fca58 | 2 | * Read-Copy Update mechanism for mutual exclusion |
1da177e4 LT |
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, write to the Free Software | |
16 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
17 | * | |
01c1c660 | 18 | * Copyright IBM Corporation, 2001 |
1da177e4 LT |
19 | * |
20 | * Author: Dipankar Sarma <dipankar@in.ibm.com> | |
a71fca58 | 21 | * |
595182bc | 22 | * Based on the original work by Paul McKenney <paulmck@us.ibm.com> |
1da177e4 LT |
23 | * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen. |
24 | * Papers: | |
25 | * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf | |
26 | * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001) | |
27 | * | |
28 | * For detailed explanation of Read-Copy Update mechanism see - | |
a71fca58 | 29 | * http://lse.sourceforge.net/locking/rcupdate.html |
1da177e4 LT |
30 | * |
31 | */ | |
32 | ||
33 | #ifndef __LINUX_RCUPDATE_H | |
34 | #define __LINUX_RCUPDATE_H | |
35 | ||
99098751 | 36 | #include <linux/types.h> |
1da177e4 LT |
37 | #include <linux/cache.h> |
38 | #include <linux/spinlock.h> | |
39 | #include <linux/threads.h> | |
1da177e4 LT |
40 | #include <linux/cpumask.h> |
41 | #include <linux/seqlock.h> | |
851a67b8 | 42 | #include <linux/lockdep.h> |
4446a36f | 43 | #include <linux/completion.h> |
551d55a9 | 44 | #include <linux/debugobjects.h> |
ca5ecddf | 45 | #include <linux/compiler.h> |
1da177e4 | 46 | |
e5ab6772 DY |
47 | #ifdef CONFIG_RCU_TORTURE_TEST |
48 | extern int rcutorture_runnable; /* for sysctl */ | |
49 | #endif /* #ifdef CONFIG_RCU_TORTURE_TEST */ | |
50 | ||
4a298656 PM |
51 | #if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU) |
52 | extern void rcutorture_record_test_transition(void); | |
53 | extern void rcutorture_record_progress(unsigned long vernum); | |
54 | #else | |
55 | static inline void rcutorture_record_test_transition(void) | |
56 | { | |
57 | } | |
58 | static inline void rcutorture_record_progress(unsigned long vernum) | |
59 | { | |
60 | } | |
61 | #endif | |
62 | ||
e27fc964 TH |
63 | #define UINT_CMP_GE(a, b) (UINT_MAX / 2 >= (a) - (b)) |
64 | #define UINT_CMP_LT(a, b) (UINT_MAX / 2 < (a) - (b)) | |
a3dc3fb1 PM |
65 | #define ULONG_CMP_GE(a, b) (ULONG_MAX / 2 >= (a) - (b)) |
66 | #define ULONG_CMP_LT(a, b) (ULONG_MAX / 2 < (a) - (b)) | |
67 | ||
03b042bf | 68 | /* Exported common interfaces */ |
7b0b759b PM |
69 | extern void call_rcu_sched(struct rcu_head *head, |
70 | void (*func)(struct rcu_head *rcu)); | |
71 | extern void synchronize_sched(void); | |
03b042bf PM |
72 | extern void rcu_barrier_bh(void); |
73 | extern void rcu_barrier_sched(void); | |
03b042bf | 74 | |
7b0b759b PM |
75 | static inline void __rcu_read_lock_bh(void) |
76 | { | |
77 | local_bh_disable(); | |
78 | } | |
79 | ||
80 | static inline void __rcu_read_unlock_bh(void) | |
81 | { | |
82 | local_bh_enable(); | |
83 | } | |
a6826048 | 84 | |
a3dc3fb1 PM |
85 | #ifdef CONFIG_PREEMPT_RCU |
86 | ||
7b0b759b PM |
87 | extern void __rcu_read_lock(void); |
88 | extern void __rcu_read_unlock(void); | |
89 | void synchronize_rcu(void); | |
90 | ||
a3dc3fb1 PM |
91 | /* |
92 | * Defined as a macro as it is a very low level header included from | |
93 | * areas that don't even know about current. This gives the rcu_read_lock() | |
94 | * nesting depth, but makes sense only if CONFIG_PREEMPT_RCU -- in other | |
95 | * types of kernel builds, the rcu_read_lock() nesting depth is unknowable. | |
96 | */ | |
97 | #define rcu_preempt_depth() (current->rcu_read_lock_nesting) | |
98 | ||
7b0b759b PM |
99 | #else /* #ifdef CONFIG_PREEMPT_RCU */ |
100 | ||
101 | static inline void __rcu_read_lock(void) | |
102 | { | |
103 | preempt_disable(); | |
104 | } | |
105 | ||
106 | static inline void __rcu_read_unlock(void) | |
107 | { | |
108 | preempt_enable(); | |
109 | } | |
110 | ||
111 | static inline void synchronize_rcu(void) | |
112 | { | |
113 | synchronize_sched(); | |
114 | } | |
115 | ||
116 | static inline int rcu_preempt_depth(void) | |
117 | { | |
118 | return 0; | |
119 | } | |
120 | ||
121 | #endif /* #else #ifdef CONFIG_PREEMPT_RCU */ | |
122 | ||
123 | /* Internal to kernel */ | |
7b0b759b PM |
124 | extern void rcu_sched_qs(int cpu); |
125 | extern void rcu_bh_qs(int cpu); | |
126 | extern void rcu_check_callbacks(int cpu, int user); | |
127 | struct notifier_block; | |
128 | ||
129 | #ifdef CONFIG_NO_HZ | |
130 | ||
131 | extern void rcu_enter_nohz(void); | |
132 | extern void rcu_exit_nohz(void); | |
133 | ||
134 | #else /* #ifdef CONFIG_NO_HZ */ | |
135 | ||
136 | static inline void rcu_enter_nohz(void) | |
137 | { | |
138 | } | |
139 | ||
140 | static inline void rcu_exit_nohz(void) | |
141 | { | |
142 | } | |
143 | ||
144 | #endif /* #else #ifdef CONFIG_NO_HZ */ | |
a3dc3fb1 | 145 | |
f41d911f | 146 | #if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU) |
64db4cff | 147 | #include <linux/rcutree.h> |
a57eb940 | 148 | #elif defined(CONFIG_TINY_RCU) || defined(CONFIG_TINY_PREEMPT_RCU) |
9b1d82fa | 149 | #include <linux/rcutiny.h> |
64db4cff PM |
150 | #else |
151 | #error "Unknown RCU implementation specified to kernel configuration" | |
6b3ef48a | 152 | #endif |
01c1c660 | 153 | |
551d55a9 MD |
154 | /* |
155 | * init_rcu_head_on_stack()/destroy_rcu_head_on_stack() are needed for dynamic | |
156 | * initialization and destruction of rcu_head on the stack. rcu_head structures | |
157 | * allocated dynamically in the heap or defined statically don't need any | |
158 | * initialization. | |
159 | */ | |
160 | #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD | |
161 | extern void init_rcu_head_on_stack(struct rcu_head *head); | |
162 | extern void destroy_rcu_head_on_stack(struct rcu_head *head); | |
163 | #else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */ | |
4376030a MD |
164 | static inline void init_rcu_head_on_stack(struct rcu_head *head) |
165 | { | |
166 | } | |
167 | ||
168 | static inline void destroy_rcu_head_on_stack(struct rcu_head *head) | |
169 | { | |
170 | } | |
551d55a9 | 171 | #endif /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */ |
4376030a | 172 | |
bc33f24b | 173 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
632ee200 | 174 | |
bc33f24b | 175 | extern struct lockdep_map rcu_lock_map; |
632ee200 PM |
176 | # define rcu_read_acquire() \ |
177 | lock_acquire(&rcu_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_) | |
bc33f24b | 178 | # define rcu_read_release() lock_release(&rcu_lock_map, 1, _THIS_IP_) |
632ee200 PM |
179 | |
180 | extern struct lockdep_map rcu_bh_lock_map; | |
181 | # define rcu_read_acquire_bh() \ | |
182 | lock_acquire(&rcu_bh_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_) | |
183 | # define rcu_read_release_bh() lock_release(&rcu_bh_lock_map, 1, _THIS_IP_) | |
184 | ||
185 | extern struct lockdep_map rcu_sched_lock_map; | |
186 | # define rcu_read_acquire_sched() \ | |
187 | lock_acquire(&rcu_sched_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_) | |
188 | # define rcu_read_release_sched() \ | |
189 | lock_release(&rcu_sched_lock_map, 1, _THIS_IP_) | |
190 | ||
bc293d62 | 191 | extern int debug_lockdep_rcu_enabled(void); |
54dbf96c | 192 | |
632ee200 | 193 | /** |
ca5ecddf | 194 | * rcu_read_lock_held() - might we be in RCU read-side critical section? |
632ee200 | 195 | * |
d20200b5 PM |
196 | * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an RCU |
197 | * read-side critical section. In absence of CONFIG_DEBUG_LOCK_ALLOC, | |
632ee200 | 198 | * this assumes we are in an RCU read-side critical section unless it can |
ca5ecddf PM |
199 | * prove otherwise. This is useful for debug checks in functions that |
200 | * require that they be called within an RCU read-side critical section. | |
54dbf96c | 201 | * |
ca5ecddf | 202 | * Checks debug_lockdep_rcu_enabled() to prevent false positives during boot |
32c141a0 | 203 | * and while lockdep is disabled. |
632ee200 PM |
204 | */ |
205 | static inline int rcu_read_lock_held(void) | |
206 | { | |
54dbf96c PM |
207 | if (!debug_lockdep_rcu_enabled()) |
208 | return 1; | |
209 | return lock_is_held(&rcu_lock_map); | |
632ee200 PM |
210 | } |
211 | ||
e3818b8d PM |
212 | /* |
213 | * rcu_read_lock_bh_held() is defined out of line to avoid #include-file | |
214 | * hell. | |
632ee200 | 215 | */ |
e3818b8d | 216 | extern int rcu_read_lock_bh_held(void); |
632ee200 PM |
217 | |
218 | /** | |
ca5ecddf | 219 | * rcu_read_lock_sched_held() - might we be in RCU-sched read-side critical section? |
632ee200 | 220 | * |
d20200b5 PM |
221 | * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an |
222 | * RCU-sched read-side critical section. In absence of | |
223 | * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side | |
224 | * critical section unless it can prove otherwise. Note that disabling | |
225 | * of preemption (including disabling irqs) counts as an RCU-sched | |
ca5ecddf PM |
226 | * read-side critical section. This is useful for debug checks in functions |
227 | * that required that they be called within an RCU-sched read-side | |
228 | * critical section. | |
54dbf96c | 229 | * |
32c141a0 PM |
230 | * Check debug_lockdep_rcu_enabled() to prevent false positives during boot |
231 | * and while lockdep is disabled. | |
632ee200 | 232 | */ |
bdd4e85d | 233 | #ifdef CONFIG_PREEMPT_COUNT |
632ee200 PM |
234 | static inline int rcu_read_lock_sched_held(void) |
235 | { | |
236 | int lockdep_opinion = 0; | |
237 | ||
54dbf96c PM |
238 | if (!debug_lockdep_rcu_enabled()) |
239 | return 1; | |
632ee200 PM |
240 | if (debug_locks) |
241 | lockdep_opinion = lock_is_held(&rcu_sched_lock_map); | |
0cff810f | 242 | return lockdep_opinion || preempt_count() != 0 || irqs_disabled(); |
632ee200 | 243 | } |
bdd4e85d | 244 | #else /* #ifdef CONFIG_PREEMPT_COUNT */ |
e6033e3b PM |
245 | static inline int rcu_read_lock_sched_held(void) |
246 | { | |
247 | return 1; | |
632ee200 | 248 | } |
bdd4e85d | 249 | #endif /* #else #ifdef CONFIG_PREEMPT_COUNT */ |
632ee200 PM |
250 | |
251 | #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */ | |
252 | ||
253 | # define rcu_read_acquire() do { } while (0) | |
254 | # define rcu_read_release() do { } while (0) | |
255 | # define rcu_read_acquire_bh() do { } while (0) | |
256 | # define rcu_read_release_bh() do { } while (0) | |
257 | # define rcu_read_acquire_sched() do { } while (0) | |
258 | # define rcu_read_release_sched() do { } while (0) | |
259 | ||
260 | static inline int rcu_read_lock_held(void) | |
261 | { | |
262 | return 1; | |
263 | } | |
264 | ||
265 | static inline int rcu_read_lock_bh_held(void) | |
266 | { | |
267 | return 1; | |
268 | } | |
269 | ||
bdd4e85d | 270 | #ifdef CONFIG_PREEMPT_COUNT |
632ee200 PM |
271 | static inline int rcu_read_lock_sched_held(void) |
272 | { | |
bbad9379 | 273 | return preempt_count() != 0 || irqs_disabled(); |
632ee200 | 274 | } |
bdd4e85d | 275 | #else /* #ifdef CONFIG_PREEMPT_COUNT */ |
e6033e3b PM |
276 | static inline int rcu_read_lock_sched_held(void) |
277 | { | |
278 | return 1; | |
632ee200 | 279 | } |
bdd4e85d | 280 | #endif /* #else #ifdef CONFIG_PREEMPT_COUNT */ |
632ee200 PM |
281 | |
282 | #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */ | |
283 | ||
284 | #ifdef CONFIG_PROVE_RCU | |
285 | ||
ee84b824 PM |
286 | extern int rcu_my_thread_group_empty(void); |
287 | ||
4221a991 TH |
288 | /** |
289 | * rcu_lockdep_assert - emit lockdep splat if specified condition not met | |
290 | * @c: condition to check | |
b3fbab05 | 291 | * @s: informative message |
4221a991 | 292 | */ |
b3fbab05 | 293 | #define rcu_lockdep_assert(c, s) \ |
2b3fc35f LJ |
294 | do { \ |
295 | static bool __warned; \ | |
296 | if (debug_lockdep_rcu_enabled() && !__warned && !(c)) { \ | |
297 | __warned = true; \ | |
b3fbab05 | 298 | lockdep_rcu_suspicious(__FILE__, __LINE__, s); \ |
2b3fc35f LJ |
299 | } \ |
300 | } while (0) | |
301 | ||
b3fbab05 PM |
302 | #define rcu_sleep_check() \ |
303 | do { \ | |
304 | rcu_lockdep_assert(!lock_is_held(&rcu_bh_lock_map), \ | |
305 | "Illegal context switch in RCU-bh" \ | |
306 | " read-side critical section"); \ | |
307 | rcu_lockdep_assert(!lock_is_held(&rcu_sched_lock_map), \ | |
308 | "Illegal context switch in RCU-sched"\ | |
309 | " read-side critical section"); \ | |
310 | } while (0) | |
311 | ||
ca5ecddf PM |
312 | #else /* #ifdef CONFIG_PROVE_RCU */ |
313 | ||
b3fbab05 PM |
314 | #define rcu_lockdep_assert(c, s) do { } while (0) |
315 | #define rcu_sleep_check() do { } while (0) | |
ca5ecddf PM |
316 | |
317 | #endif /* #else #ifdef CONFIG_PROVE_RCU */ | |
318 | ||
319 | /* | |
320 | * Helper functions for rcu_dereference_check(), rcu_dereference_protected() | |
321 | * and rcu_assign_pointer(). Some of these could be folded into their | |
322 | * callers, but they are left separate in order to ease introduction of | |
323 | * multiple flavors of pointers to match the multiple flavors of RCU | |
324 | * (e.g., __rcu_bh, * __rcu_sched, and __srcu), should this make sense in | |
325 | * the future. | |
326 | */ | |
53ecfba2 PM |
327 | |
328 | #ifdef __CHECKER__ | |
329 | #define rcu_dereference_sparse(p, space) \ | |
330 | ((void)(((typeof(*p) space *)p) == p)) | |
331 | #else /* #ifdef __CHECKER__ */ | |
332 | #define rcu_dereference_sparse(p, space) | |
333 | #endif /* #else #ifdef __CHECKER__ */ | |
334 | ||
ca5ecddf PM |
335 | #define __rcu_access_pointer(p, space) \ |
336 | ({ \ | |
337 | typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \ | |
53ecfba2 | 338 | rcu_dereference_sparse(p, space); \ |
ca5ecddf PM |
339 | ((typeof(*p) __force __kernel *)(_________p1)); \ |
340 | }) | |
341 | #define __rcu_dereference_check(p, c, space) \ | |
342 | ({ \ | |
343 | typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \ | |
b3fbab05 PM |
344 | rcu_lockdep_assert(c, "suspicious rcu_dereference_check()" \ |
345 | " usage"); \ | |
53ecfba2 | 346 | rcu_dereference_sparse(p, space); \ |
ca5ecddf PM |
347 | smp_read_barrier_depends(); \ |
348 | ((typeof(*p) __force __kernel *)(_________p1)); \ | |
349 | }) | |
350 | #define __rcu_dereference_protected(p, c, space) \ | |
351 | ({ \ | |
b3fbab05 PM |
352 | rcu_lockdep_assert(c, "suspicious rcu_dereference_protected()" \ |
353 | " usage"); \ | |
53ecfba2 | 354 | rcu_dereference_sparse(p, space); \ |
ca5ecddf PM |
355 | ((typeof(*p) __force __kernel *)(p)); \ |
356 | }) | |
357 | ||
a4dd9925 PM |
358 | #define __rcu_access_index(p, space) \ |
359 | ({ \ | |
360 | typeof(p) _________p1 = ACCESS_ONCE(p); \ | |
361 | rcu_dereference_sparse(p, space); \ | |
362 | (_________p1); \ | |
363 | }) | |
ca5ecddf PM |
364 | #define __rcu_dereference_index_check(p, c) \ |
365 | ({ \ | |
366 | typeof(p) _________p1 = ACCESS_ONCE(p); \ | |
b3fbab05 PM |
367 | rcu_lockdep_assert(c, \ |
368 | "suspicious rcu_dereference_index_check()" \ | |
369 | " usage"); \ | |
ca5ecddf PM |
370 | smp_read_barrier_depends(); \ |
371 | (_________p1); \ | |
372 | }) | |
373 | #define __rcu_assign_pointer(p, v, space) \ | |
374 | ({ \ | |
375 | if (!__builtin_constant_p(v) || \ | |
376 | ((v) != NULL)) \ | |
377 | smp_wmb(); \ | |
378 | (p) = (typeof(*v) __force space *)(v); \ | |
379 | }) | |
380 | ||
381 | ||
382 | /** | |
383 | * rcu_access_pointer() - fetch RCU pointer with no dereferencing | |
384 | * @p: The pointer to read | |
385 | * | |
386 | * Return the value of the specified RCU-protected pointer, but omit the | |
387 | * smp_read_barrier_depends() and keep the ACCESS_ONCE(). This is useful | |
388 | * when the value of this pointer is accessed, but the pointer is not | |
389 | * dereferenced, for example, when testing an RCU-protected pointer against | |
390 | * NULL. Although rcu_access_pointer() may also be used in cases where | |
391 | * update-side locks prevent the value of the pointer from changing, you | |
392 | * should instead use rcu_dereference_protected() for this use case. | |
393 | */ | |
394 | #define rcu_access_pointer(p) __rcu_access_pointer((p), __rcu) | |
395 | ||
632ee200 | 396 | /** |
ca5ecddf | 397 | * rcu_dereference_check() - rcu_dereference with debug checking |
c08c68dd DH |
398 | * @p: The pointer to read, prior to dereferencing |
399 | * @c: The conditions under which the dereference will take place | |
632ee200 | 400 | * |
c08c68dd | 401 | * Do an rcu_dereference(), but check that the conditions under which the |
ca5ecddf PM |
402 | * dereference will take place are correct. Typically the conditions |
403 | * indicate the various locking conditions that should be held at that | |
404 | * point. The check should return true if the conditions are satisfied. | |
405 | * An implicit check for being in an RCU read-side critical section | |
406 | * (rcu_read_lock()) is included. | |
c08c68dd DH |
407 | * |
408 | * For example: | |
409 | * | |
ca5ecddf | 410 | * bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock)); |
c08c68dd DH |
411 | * |
412 | * could be used to indicate to lockdep that foo->bar may only be dereferenced | |
ca5ecddf | 413 | * if either rcu_read_lock() is held, or that the lock required to replace |
c08c68dd DH |
414 | * the bar struct at foo->bar is held. |
415 | * | |
416 | * Note that the list of conditions may also include indications of when a lock | |
417 | * need not be held, for example during initialisation or destruction of the | |
418 | * target struct: | |
419 | * | |
ca5ecddf | 420 | * bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock) || |
c08c68dd | 421 | * atomic_read(&foo->usage) == 0); |
ca5ecddf PM |
422 | * |
423 | * Inserts memory barriers on architectures that require them | |
424 | * (currently only the Alpha), prevents the compiler from refetching | |
425 | * (and from merging fetches), and, more importantly, documents exactly | |
426 | * which pointers are protected by RCU and checks that the pointer is | |
427 | * annotated as __rcu. | |
632ee200 PM |
428 | */ |
429 | #define rcu_dereference_check(p, c) \ | |
ca5ecddf PM |
430 | __rcu_dereference_check((p), rcu_read_lock_held() || (c), __rcu) |
431 | ||
432 | /** | |
433 | * rcu_dereference_bh_check() - rcu_dereference_bh with debug checking | |
434 | * @p: The pointer to read, prior to dereferencing | |
435 | * @c: The conditions under which the dereference will take place | |
436 | * | |
437 | * This is the RCU-bh counterpart to rcu_dereference_check(). | |
438 | */ | |
439 | #define rcu_dereference_bh_check(p, c) \ | |
440 | __rcu_dereference_check((p), rcu_read_lock_bh_held() || (c), __rcu) | |
632ee200 | 441 | |
b62730ba | 442 | /** |
ca5ecddf PM |
443 | * rcu_dereference_sched_check() - rcu_dereference_sched with debug checking |
444 | * @p: The pointer to read, prior to dereferencing | |
445 | * @c: The conditions under which the dereference will take place | |
446 | * | |
447 | * This is the RCU-sched counterpart to rcu_dereference_check(). | |
448 | */ | |
449 | #define rcu_dereference_sched_check(p, c) \ | |
450 | __rcu_dereference_check((p), rcu_read_lock_sched_held() || (c), \ | |
451 | __rcu) | |
452 | ||
453 | #define rcu_dereference_raw(p) rcu_dereference_check(p, 1) /*@@@ needed? @@@*/ | |
454 | ||
a4dd9925 PM |
455 | /** |
456 | * rcu_access_index() - fetch RCU index with no dereferencing | |
457 | * @p: The index to read | |
458 | * | |
459 | * Return the value of the specified RCU-protected index, but omit the | |
460 | * smp_read_barrier_depends() and keep the ACCESS_ONCE(). This is useful | |
461 | * when the value of this index is accessed, but the index is not | |
462 | * dereferenced, for example, when testing an RCU-protected index against | |
463 | * -1. Although rcu_access_index() may also be used in cases where | |
464 | * update-side locks prevent the value of the index from changing, you | |
465 | * should instead use rcu_dereference_index_protected() for this use case. | |
466 | */ | |
467 | #define rcu_access_index(p) __rcu_access_index((p), __rcu) | |
468 | ||
ca5ecddf PM |
469 | /** |
470 | * rcu_dereference_index_check() - rcu_dereference for indices with debug checking | |
471 | * @p: The pointer to read, prior to dereferencing | |
472 | * @c: The conditions under which the dereference will take place | |
473 | * | |
474 | * Similar to rcu_dereference_check(), but omits the sparse checking. | |
475 | * This allows rcu_dereference_index_check() to be used on integers, | |
476 | * which can then be used as array indices. Attempting to use | |
477 | * rcu_dereference_check() on an integer will give compiler warnings | |
478 | * because the sparse address-space mechanism relies on dereferencing | |
479 | * the RCU-protected pointer. Dereferencing integers is not something | |
480 | * that even gcc will put up with. | |
481 | * | |
482 | * Note that this function does not implicitly check for RCU read-side | |
483 | * critical sections. If this function gains lots of uses, it might | |
484 | * make sense to provide versions for each flavor of RCU, but it does | |
485 | * not make sense as of early 2010. | |
486 | */ | |
487 | #define rcu_dereference_index_check(p, c) \ | |
488 | __rcu_dereference_index_check((p), (c)) | |
489 | ||
490 | /** | |
491 | * rcu_dereference_protected() - fetch RCU pointer when updates prevented | |
492 | * @p: The pointer to read, prior to dereferencing | |
493 | * @c: The conditions under which the dereference will take place | |
b62730ba PM |
494 | * |
495 | * Return the value of the specified RCU-protected pointer, but omit | |
496 | * both the smp_read_barrier_depends() and the ACCESS_ONCE(). This | |
497 | * is useful in cases where update-side locks prevent the value of the | |
498 | * pointer from changing. Please note that this primitive does -not- | |
499 | * prevent the compiler from repeating this reference or combining it | |
500 | * with other references, so it should not be used without protection | |
501 | * of appropriate locks. | |
ca5ecddf PM |
502 | * |
503 | * This function is only for update-side use. Using this function | |
504 | * when protected only by rcu_read_lock() will result in infrequent | |
505 | * but very ugly failures. | |
b62730ba PM |
506 | */ |
507 | #define rcu_dereference_protected(p, c) \ | |
ca5ecddf | 508 | __rcu_dereference_protected((p), (c), __rcu) |
b62730ba | 509 | |
ca5ecddf PM |
510 | /** |
511 | * rcu_dereference_bh_protected() - fetch RCU-bh pointer when updates prevented | |
512 | * @p: The pointer to read, prior to dereferencing | |
513 | * @c: The conditions under which the dereference will take place | |
514 | * | |
515 | * This is the RCU-bh counterpart to rcu_dereference_protected(). | |
516 | */ | |
517 | #define rcu_dereference_bh_protected(p, c) \ | |
518 | __rcu_dereference_protected((p), (c), __rcu) | |
632ee200 | 519 | |
ca5ecddf PM |
520 | /** |
521 | * rcu_dereference_sched_protected() - fetch RCU-sched pointer when updates prevented | |
522 | * @p: The pointer to read, prior to dereferencing | |
523 | * @c: The conditions under which the dereference will take place | |
524 | * | |
525 | * This is the RCU-sched counterpart to rcu_dereference_protected(). | |
526 | */ | |
527 | #define rcu_dereference_sched_protected(p, c) \ | |
528 | __rcu_dereference_protected((p), (c), __rcu) | |
632ee200 | 529 | |
bc33f24b | 530 | |
b62730ba | 531 | /** |
ca5ecddf PM |
532 | * rcu_dereference() - fetch RCU-protected pointer for dereferencing |
533 | * @p: The pointer to read, prior to dereferencing | |
b62730ba | 534 | * |
ca5ecddf | 535 | * This is a simple wrapper around rcu_dereference_check(). |
b62730ba | 536 | */ |
ca5ecddf | 537 | #define rcu_dereference(p) rcu_dereference_check(p, 0) |
b62730ba | 538 | |
1da177e4 | 539 | /** |
ca5ecddf PM |
540 | * rcu_dereference_bh() - fetch an RCU-bh-protected pointer for dereferencing |
541 | * @p: The pointer to read, prior to dereferencing | |
542 | * | |
543 | * Makes rcu_dereference_check() do the dirty work. | |
544 | */ | |
545 | #define rcu_dereference_bh(p) rcu_dereference_bh_check(p, 0) | |
546 | ||
547 | /** | |
548 | * rcu_dereference_sched() - fetch RCU-sched-protected pointer for dereferencing | |
549 | * @p: The pointer to read, prior to dereferencing | |
550 | * | |
551 | * Makes rcu_dereference_check() do the dirty work. | |
552 | */ | |
553 | #define rcu_dereference_sched(p) rcu_dereference_sched_check(p, 0) | |
554 | ||
555 | /** | |
556 | * rcu_read_lock() - mark the beginning of an RCU read-side critical section | |
1da177e4 | 557 | * |
9b06e818 | 558 | * When synchronize_rcu() is invoked on one CPU while other CPUs |
1da177e4 | 559 | * are within RCU read-side critical sections, then the |
9b06e818 | 560 | * synchronize_rcu() is guaranteed to block until after all the other |
1da177e4 LT |
561 | * CPUs exit their critical sections. Similarly, if call_rcu() is invoked |
562 | * on one CPU while other CPUs are within RCU read-side critical | |
563 | * sections, invocation of the corresponding RCU callback is deferred | |
564 | * until after the all the other CPUs exit their critical sections. | |
565 | * | |
566 | * Note, however, that RCU callbacks are permitted to run concurrently | |
77d8485a | 567 | * with new RCU read-side critical sections. One way that this can happen |
1da177e4 LT |
568 | * is via the following sequence of events: (1) CPU 0 enters an RCU |
569 | * read-side critical section, (2) CPU 1 invokes call_rcu() to register | |
570 | * an RCU callback, (3) CPU 0 exits the RCU read-side critical section, | |
571 | * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU | |
572 | * callback is invoked. This is legal, because the RCU read-side critical | |
573 | * section that was running concurrently with the call_rcu() (and which | |
574 | * therefore might be referencing something that the corresponding RCU | |
575 | * callback would free up) has completed before the corresponding | |
576 | * RCU callback is invoked. | |
577 | * | |
578 | * RCU read-side critical sections may be nested. Any deferred actions | |
579 | * will be deferred until the outermost RCU read-side critical section | |
580 | * completes. | |
581 | * | |
9079fd7c PM |
582 | * You can avoid reading and understanding the next paragraph by |
583 | * following this rule: don't put anything in an rcu_read_lock() RCU | |
584 | * read-side critical section that would block in a !PREEMPT kernel. | |
585 | * But if you want the full story, read on! | |
586 | * | |
587 | * In non-preemptible RCU implementations (TREE_RCU and TINY_RCU), it | |
588 | * is illegal to block while in an RCU read-side critical section. In | |
589 | * preemptible RCU implementations (TREE_PREEMPT_RCU and TINY_PREEMPT_RCU) | |
590 | * in CONFIG_PREEMPT kernel builds, RCU read-side critical sections may | |
591 | * be preempted, but explicit blocking is illegal. Finally, in preemptible | |
592 | * RCU implementations in real-time (CONFIG_PREEMPT_RT) kernel builds, | |
593 | * RCU read-side critical sections may be preempted and they may also | |
594 | * block, but only when acquiring spinlocks that are subject to priority | |
595 | * inheritance. | |
1da177e4 | 596 | */ |
bc33f24b PM |
597 | static inline void rcu_read_lock(void) |
598 | { | |
599 | __rcu_read_lock(); | |
600 | __acquire(RCU); | |
601 | rcu_read_acquire(); | |
602 | } | |
1da177e4 | 603 | |
1da177e4 LT |
604 | /* |
605 | * So where is rcu_write_lock()? It does not exist, as there is no | |
606 | * way for writers to lock out RCU readers. This is a feature, not | |
607 | * a bug -- this property is what provides RCU's performance benefits. | |
608 | * Of course, writers must coordinate with each other. The normal | |
609 | * spinlock primitives work well for this, but any other technique may be | |
610 | * used as well. RCU does not care how the writers keep out of each | |
611 | * others' way, as long as they do so. | |
612 | */ | |
3d76c082 PM |
613 | |
614 | /** | |
ca5ecddf | 615 | * rcu_read_unlock() - marks the end of an RCU read-side critical section. |
3d76c082 PM |
616 | * |
617 | * See rcu_read_lock() for more information. | |
618 | */ | |
bc33f24b PM |
619 | static inline void rcu_read_unlock(void) |
620 | { | |
621 | rcu_read_release(); | |
622 | __release(RCU); | |
623 | __rcu_read_unlock(); | |
624 | } | |
1da177e4 LT |
625 | |
626 | /** | |
ca5ecddf | 627 | * rcu_read_lock_bh() - mark the beginning of an RCU-bh critical section |
1da177e4 LT |
628 | * |
629 | * This is equivalent of rcu_read_lock(), but to be used when updates | |
ca5ecddf PM |
630 | * are being done using call_rcu_bh() or synchronize_rcu_bh(). Since |
631 | * both call_rcu_bh() and synchronize_rcu_bh() consider completion of a | |
632 | * softirq handler to be a quiescent state, a process in RCU read-side | |
633 | * critical section must be protected by disabling softirqs. Read-side | |
634 | * critical sections in interrupt context can use just rcu_read_lock(), | |
635 | * though this should at least be commented to avoid confusing people | |
636 | * reading the code. | |
1da177e4 | 637 | */ |
bc33f24b PM |
638 | static inline void rcu_read_lock_bh(void) |
639 | { | |
640 | __rcu_read_lock_bh(); | |
641 | __acquire(RCU_BH); | |
632ee200 | 642 | rcu_read_acquire_bh(); |
bc33f24b | 643 | } |
1da177e4 LT |
644 | |
645 | /* | |
646 | * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section | |
647 | * | |
648 | * See rcu_read_lock_bh() for more information. | |
649 | */ | |
bc33f24b PM |
650 | static inline void rcu_read_unlock_bh(void) |
651 | { | |
632ee200 | 652 | rcu_read_release_bh(); |
bc33f24b PM |
653 | __release(RCU_BH); |
654 | __rcu_read_unlock_bh(); | |
655 | } | |
1da177e4 | 656 | |
1c50b728 | 657 | /** |
ca5ecddf | 658 | * rcu_read_lock_sched() - mark the beginning of a RCU-sched critical section |
1c50b728 | 659 | * |
ca5ecddf PM |
660 | * This is equivalent of rcu_read_lock(), but to be used when updates |
661 | * are being done using call_rcu_sched() or synchronize_rcu_sched(). | |
662 | * Read-side critical sections can also be introduced by anything that | |
663 | * disables preemption, including local_irq_disable() and friends. | |
1c50b728 | 664 | */ |
d6714c22 PM |
665 | static inline void rcu_read_lock_sched(void) |
666 | { | |
667 | preempt_disable(); | |
bc33f24b | 668 | __acquire(RCU_SCHED); |
632ee200 | 669 | rcu_read_acquire_sched(); |
d6714c22 | 670 | } |
1eba8f84 PM |
671 | |
672 | /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */ | |
7c614d64 | 673 | static inline notrace void rcu_read_lock_sched_notrace(void) |
d6714c22 PM |
674 | { |
675 | preempt_disable_notrace(); | |
bc33f24b | 676 | __acquire(RCU_SCHED); |
d6714c22 | 677 | } |
1c50b728 MD |
678 | |
679 | /* | |
680 | * rcu_read_unlock_sched - marks the end of a RCU-classic critical section | |
681 | * | |
682 | * See rcu_read_lock_sched for more information. | |
683 | */ | |
d6714c22 PM |
684 | static inline void rcu_read_unlock_sched(void) |
685 | { | |
632ee200 | 686 | rcu_read_release_sched(); |
bc33f24b | 687 | __release(RCU_SCHED); |
d6714c22 PM |
688 | preempt_enable(); |
689 | } | |
1eba8f84 PM |
690 | |
691 | /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */ | |
7c614d64 | 692 | static inline notrace void rcu_read_unlock_sched_notrace(void) |
d6714c22 | 693 | { |
bc33f24b | 694 | __release(RCU_SCHED); |
d6714c22 PM |
695 | preempt_enable_notrace(); |
696 | } | |
1c50b728 | 697 | |
1da177e4 | 698 | /** |
ca5ecddf PM |
699 | * rcu_assign_pointer() - assign to RCU-protected pointer |
700 | * @p: pointer to assign to | |
701 | * @v: value to assign (publish) | |
c26d34a5 | 702 | * |
ca5ecddf PM |
703 | * Assigns the specified value to the specified RCU-protected |
704 | * pointer, ensuring that any concurrent RCU readers will see | |
705 | * any prior initialization. Returns the value assigned. | |
1da177e4 LT |
706 | * |
707 | * Inserts memory barriers on architectures that require them | |
708 | * (pretty much all of them other than x86), and also prevents | |
709 | * the compiler from reordering the code that initializes the | |
710 | * structure after the pointer assignment. More importantly, this | |
711 | * call documents which pointers will be dereferenced by RCU read-side | |
712 | * code. | |
713 | */ | |
d99c4f6b | 714 | #define rcu_assign_pointer(p, v) \ |
ca5ecddf PM |
715 | __rcu_assign_pointer((p), (v), __rcu) |
716 | ||
717 | /** | |
718 | * RCU_INIT_POINTER() - initialize an RCU protected pointer | |
719 | * | |
720 | * Initialize an RCU-protected pointer in such a way to avoid RCU-lockdep | |
721 | * splats. | |
722 | */ | |
723 | #define RCU_INIT_POINTER(p, v) \ | |
724 | p = (typeof(*v) __force __rcu *)(v) | |
1da177e4 | 725 | |
4446a36f PM |
726 | /* Infrastructure to implement the synchronize_() primitives. */ |
727 | ||
728 | struct rcu_synchronize { | |
729 | struct rcu_head head; | |
730 | struct completion completion; | |
731 | }; | |
732 | ||
733 | extern void wakeme_after_rcu(struct rcu_head *head); | |
734 | ||
7b0b759b PM |
735 | #ifdef CONFIG_PREEMPT_RCU |
736 | ||
01c1c660 | 737 | /** |
ca5ecddf | 738 | * call_rcu() - Queue an RCU callback for invocation after a grace period. |
01c1c660 | 739 | * @head: structure to be used for queueing the RCU updates. |
77d8485a | 740 | * @func: actual callback function to be invoked after the grace period |
01c1c660 | 741 | * |
77d8485a PM |
742 | * The callback function will be invoked some time after a full grace |
743 | * period elapses, in other words after all pre-existing RCU read-side | |
744 | * critical sections have completed. However, the callback function | |
745 | * might well execute concurrently with RCU read-side critical sections | |
746 | * that started after call_rcu() was invoked. RCU read-side critical | |
01c1c660 PM |
747 | * sections are delimited by rcu_read_lock() and rcu_read_unlock(), |
748 | * and may be nested. | |
749 | */ | |
750 | extern void call_rcu(struct rcu_head *head, | |
751 | void (*func)(struct rcu_head *head)); | |
752 | ||
7b0b759b PM |
753 | #else /* #ifdef CONFIG_PREEMPT_RCU */ |
754 | ||
755 | /* In classic RCU, call_rcu() is just call_rcu_sched(). */ | |
756 | #define call_rcu call_rcu_sched | |
757 | ||
758 | #endif /* #else #ifdef CONFIG_PREEMPT_RCU */ | |
759 | ||
01c1c660 | 760 | /** |
ca5ecddf | 761 | * call_rcu_bh() - Queue an RCU for invocation after a quicker grace period. |
01c1c660 | 762 | * @head: structure to be used for queueing the RCU updates. |
77d8485a | 763 | * @func: actual callback function to be invoked after the grace period |
01c1c660 | 764 | * |
77d8485a | 765 | * The callback function will be invoked some time after a full grace |
01c1c660 PM |
766 | * period elapses, in other words after all currently executing RCU |
767 | * read-side critical sections have completed. call_rcu_bh() assumes | |
768 | * that the read-side critical sections end on completion of a softirq | |
769 | * handler. This means that read-side critical sections in process | |
770 | * context must not be interrupted by softirqs. This interface is to be | |
771 | * used when most of the read-side critical sections are in softirq context. | |
772 | * RCU read-side critical sections are delimited by : | |
773 | * - rcu_read_lock() and rcu_read_unlock(), if in interrupt context. | |
774 | * OR | |
775 | * - rcu_read_lock_bh() and rcu_read_unlock_bh(), if in process context. | |
776 | * These may be nested. | |
777 | */ | |
778 | extern void call_rcu_bh(struct rcu_head *head, | |
779 | void (*func)(struct rcu_head *head)); | |
780 | ||
551d55a9 MD |
781 | /* |
782 | * debug_rcu_head_queue()/debug_rcu_head_unqueue() are used internally | |
783 | * by call_rcu() and rcu callback execution, and are therefore not part of the | |
784 | * RCU API. Leaving in rcupdate.h because they are used by all RCU flavors. | |
785 | */ | |
786 | ||
787 | #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD | |
788 | # define STATE_RCU_HEAD_READY 0 | |
789 | # define STATE_RCU_HEAD_QUEUED 1 | |
790 | ||
791 | extern struct debug_obj_descr rcuhead_debug_descr; | |
792 | ||
793 | static inline void debug_rcu_head_queue(struct rcu_head *head) | |
794 | { | |
b0c9d7ff | 795 | WARN_ON_ONCE((unsigned long)head & 0x3); |
551d55a9 MD |
796 | debug_object_activate(head, &rcuhead_debug_descr); |
797 | debug_object_active_state(head, &rcuhead_debug_descr, | |
798 | STATE_RCU_HEAD_READY, | |
799 | STATE_RCU_HEAD_QUEUED); | |
800 | } | |
801 | ||
802 | static inline void debug_rcu_head_unqueue(struct rcu_head *head) | |
803 | { | |
804 | debug_object_active_state(head, &rcuhead_debug_descr, | |
805 | STATE_RCU_HEAD_QUEUED, | |
806 | STATE_RCU_HEAD_READY); | |
807 | debug_object_deactivate(head, &rcuhead_debug_descr); | |
808 | } | |
809 | #else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */ | |
810 | static inline void debug_rcu_head_queue(struct rcu_head *head) | |
811 | { | |
812 | } | |
813 | ||
814 | static inline void debug_rcu_head_unqueue(struct rcu_head *head) | |
815 | { | |
816 | } | |
817 | #endif /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */ | |
818 | ||
9ab1544e LJ |
819 | static __always_inline bool __is_kfree_rcu_offset(unsigned long offset) |
820 | { | |
821 | return offset < 4096; | |
822 | } | |
823 | ||
824 | static __always_inline | |
825 | void __kfree_rcu(struct rcu_head *head, unsigned long offset) | |
826 | { | |
827 | typedef void (*rcu_callback)(struct rcu_head *); | |
828 | ||
829 | BUILD_BUG_ON(!__builtin_constant_p(offset)); | |
830 | ||
831 | /* See the kfree_rcu() header comment. */ | |
832 | BUILD_BUG_ON(!__is_kfree_rcu_offset(offset)); | |
833 | ||
834 | call_rcu(head, (rcu_callback)offset); | |
835 | } | |
836 | ||
837 | extern void kfree(const void *); | |
838 | ||
839 | static inline void __rcu_reclaim(struct rcu_head *head) | |
840 | { | |
841 | unsigned long offset = (unsigned long)head->func; | |
842 | ||
843 | if (__is_kfree_rcu_offset(offset)) | |
844 | kfree((void *)head - offset); | |
845 | else | |
846 | head->func(head); | |
847 | } | |
848 | ||
849 | /** | |
850 | * kfree_rcu() - kfree an object after a grace period. | |
851 | * @ptr: pointer to kfree | |
852 | * @rcu_head: the name of the struct rcu_head within the type of @ptr. | |
853 | * | |
854 | * Many rcu callbacks functions just call kfree() on the base structure. | |
855 | * These functions are trivial, but their size adds up, and furthermore | |
856 | * when they are used in a kernel module, that module must invoke the | |
857 | * high-latency rcu_barrier() function at module-unload time. | |
858 | * | |
859 | * The kfree_rcu() function handles this issue. Rather than encoding a | |
860 | * function address in the embedded rcu_head structure, kfree_rcu() instead | |
861 | * encodes the offset of the rcu_head structure within the base structure. | |
862 | * Because the functions are not allowed in the low-order 4096 bytes of | |
863 | * kernel virtual memory, offsets up to 4095 bytes can be accommodated. | |
864 | * If the offset is larger than 4095 bytes, a compile-time error will | |
865 | * be generated in __kfree_rcu(). If this error is triggered, you can | |
866 | * either fall back to use of call_rcu() or rearrange the structure to | |
867 | * position the rcu_head structure into the first 4096 bytes. | |
868 | * | |
869 | * Note that the allowable offset might decrease in the future, for example, | |
870 | * to allow something like kmem_cache_free_rcu(). | |
871 | */ | |
872 | #define kfree_rcu(ptr, rcu_head) \ | |
873 | __kfree_rcu(&((ptr)->rcu_head), offsetof(typeof(*(ptr)), rcu_head)) | |
874 | ||
1da177e4 | 875 | #endif /* __LINUX_RCUPDATE_H */ |