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