alarm: Force unset_alarm to grab the CV lock
[akaros.git] / kern / include / rcupdate.h
1 /*
2  * 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 IBM Corporation, 2001
19  *
20  * Author: Dipankar Sarma <dipankar@in.ibm.com>
21  *
22  * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
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 -
29  *              http://lse.sourceforge.net/locking/rcupdate.html
30  *
31  */
32
33 #ifndef __LINUX_RCUPDATE_H
34 #define __LINUX_RCUPDATE_H
35
36 #define ULONG_CMP_GE(a, b)      (ULONG_MAX / 2 >= (a) - (b))
37 #define ULONG_CMP_LT(a, b)      (ULONG_MAX / 2 < (a) - (b))
38 #define ulong2long(a)           (*(long *)(&(a)))
39
40 void call_rcu(struct rcu_head *head, rcu_callback_t func);
41
42 void synchronize_rcu(void);
43
44 /*
45  * init_rcu_head_on_stack()/destroy_rcu_head_on_stack() are needed for dynamic
46  * initialization and destruction of rcu_head on the stack. rcu_head structures
47  * allocated dynamically in the heap or defined statically don't need any
48  * initialization.
49  */
50 #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
51 void init_rcu_head(struct rcu_head *head);
52 void destroy_rcu_head(struct rcu_head *head);
53 void init_rcu_head_on_stack(struct rcu_head *head);
54 void destroy_rcu_head_on_stack(struct rcu_head *head);
55 #else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
56 static inline void init_rcu_head(struct rcu_head *head) { }
57 static inline void destroy_rcu_head(struct rcu_head *head) { }
58 static inline void init_rcu_head_on_stack(struct rcu_head *head) { }
59 static inline void destroy_rcu_head_on_stack(struct rcu_head *head) { }
60 #endif  /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
61
62 #define RCU_LOCKDEP_WARN(c, s) do { } while (0)
63 #define rcu_sleep_check() do { } while (0)
64 #define rcu_lock_acquire(a)             do { } while (0)
65 #define rcu_lock_release(a)             do { } while (0)
66 #define rcu_dereference_sparse(p, space)
67
68 static inline void __rcu_read_lock(void)
69 {
70         cmb();
71 }
72
73 static inline void __rcu_read_unlock(void)
74 {
75         cmb();
76 }
77
78 #define __rcu_access_pointer(p, space) \
79 ({ \
80         typeof(*p) *_________p1 = (typeof(*p) *__force)READ_ONCE(p); \
81         rcu_dereference_sparse(p, space); \
82         ((typeof(*p) __force __kernel *)(_________p1)); \
83 })
84 #define __rcu_dereference_check(p, c, space) \
85 ({ \
86         /* Dependency order vs. p above. */ \
87         typeof(*p) *________p1 = (typeof(*p) *__force)lockless_dereference(p); \
88         RCU_LOCKDEP_WARN(!(c), "suspicious rcu_dereference_check() usage"); \
89         rcu_dereference_sparse(p, space); \
90         ((typeof(*p) __force __kernel *)(________p1)); \
91 })
92 #define __rcu_dereference_protected(p, c, space) \
93 ({ \
94         RCU_LOCKDEP_WARN(!(c), "suspicious rcu_dereference_protected() usage"); \
95         rcu_dereference_sparse(p, space); \
96         ((typeof(*p) __force __kernel *)(p)); \
97 })
98 #define rcu_dereference_raw(p) \
99 ({ \
100         /* Dependency order vs. p above. */ \
101         typeof(p) ________p1 = lockless_dereference(p); \
102         ((typeof(*p) __force __kernel *)(________p1)); \
103 })
104
105 /**
106  * RCU_INITIALIZER() - statically initialize an RCU-protected global variable
107  * @v: The value to statically initialize with.
108  */
109 #define RCU_INITIALIZER(v) (typeof(*(v)) __force __rcu *)(v)
110
111 /**
112  * rcu_assign_pointer() - assign to RCU-protected pointer
113  * @p: pointer to assign to
114  * @v: value to assign (publish)
115  *
116  * Assigns the specified value to the specified RCU-protected
117  * pointer, ensuring that any concurrent RCU readers will see
118  * any prior initialization.
119  *
120  * Inserts memory barriers on architectures that require them
121  * (which is most of them), and also prevents the compiler from
122  * reordering the code that initializes the structure after the pointer
123  * assignment.  More importantly, this call documents which pointers
124  * will be dereferenced by RCU read-side code.
125  *
126  * In some special cases, you may use RCU_INIT_POINTER() instead
127  * of rcu_assign_pointer().  RCU_INIT_POINTER() is a bit faster due
128  * to the fact that it does not constrain either the CPU or the compiler.
129  * That said, using RCU_INIT_POINTER() when you should have used
130  * rcu_assign_pointer() is a very bad thing that results in
131  * impossible-to-diagnose memory corruption.  So please be careful.
132  * See the RCU_INIT_POINTER() comment header for details.
133  *
134  * Note that rcu_assign_pointer() evaluates each of its arguments only
135  * once, appearances notwithstanding.  One of the "extra" evaluations
136  * is in typeof() and the other visible only to sparse (__CHECKER__),
137  * neither of which actually execute the argument.  As with most cpp
138  * macros, this execute-arguments-only-once property is important, so
139  * please be careful when making changes to rcu_assign_pointer() and the
140  * other macros that it invokes.
141  */
142 #define rcu_assign_pointer(p, v)                                              \
143 ({                                                                            \
144         uintptr_t _r_a_p__v = (uintptr_t)(v);                                 \
145                                                                               \
146         if (__builtin_constant_p(v) && (_r_a_p__v) == (uintptr_t)NULL)        \
147                 WRITE_ONCE((p), (typeof(p))(_r_a_p__v));                      \
148         else                                                                  \
149                 smp_store_release(&p, RCU_INITIALIZER((typeof(p))_r_a_p__v)); \
150         _r_a_p__v;                                                            \
151 })
152
153 /**
154  * rcu_access_pointer() - fetch RCU pointer with no dereferencing
155  * @p: The pointer to read
156  *
157  * Return the value of the specified RCU-protected pointer, but omit the
158  * smp_read_barrier_depends() and keep the READ_ONCE().  This is useful
159  * when the value of this pointer is accessed, but the pointer is not
160  * dereferenced, for example, when testing an RCU-protected pointer against
161  * NULL.  Although rcu_access_pointer() may also be used in cases where
162  * update-side locks prevent the value of the pointer from changing, you
163  * should instead use rcu_dereference_protected() for this use case.
164  *
165  * It is also permissible to use rcu_access_pointer() when read-side
166  * access to the pointer was removed at least one grace period ago, as
167  * is the case in the context of the RCU callback that is freeing up
168  * the data, or after a synchronize_rcu() returns.  This can be useful
169  * when tearing down multi-linked structures after a grace period
170  * has elapsed.
171  */
172 #define rcu_access_pointer(p) __rcu_access_pointer((p), __rcu)
173
174 /**
175  * rcu_dereference_check() - rcu_dereference with debug checking
176  * @p: The pointer to read, prior to dereferencing
177  * @c: The conditions under which the dereference will take place
178  *
179  * Do an rcu_dereference(), but check that the conditions under which the
180  * dereference will take place are correct.  Typically the conditions
181  * indicate the various locking conditions that should be held at that
182  * point.  The check should return true if the conditions are satisfied.
183  * An implicit check for being in an RCU read-side critical section
184  * (rcu_read_lock()) is included.
185  *
186  * For example:
187  *
188  *      bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock));
189  *
190  * could be used to indicate to lockdep that foo->bar may only be dereferenced
191  * if either rcu_read_lock() is held, or that the lock required to replace
192  * the bar struct at foo->bar is held.
193  *
194  * Note that the list of conditions may also include indications of when a lock
195  * need not be held, for example during initialisation or destruction of the
196  * target struct:
197  *
198  *      bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock) ||
199  *                                            atomic_read(&foo->usage) == 0);
200  *
201  * Inserts memory barriers on architectures that require them
202  * (currently only the Alpha), prevents the compiler from refetching
203  * (and from merging fetches), and, more importantly, documents exactly
204  * which pointers are protected by RCU and checks that the pointer is
205  * annotated as __rcu.
206  */
207 #define rcu_dereference_check(p, c) \
208         __rcu_dereference_check((p), (c) || rcu_read_lock_held(), __rcu)
209
210 /**
211  * rcu_dereference_bh_check() - rcu_dereference_bh with debug checking
212  * @p: The pointer to read, prior to dereferencing
213  * @c: The conditions under which the dereference will take place
214  *
215  * This is the RCU-bh counterpart to rcu_dereference_check().
216  */
217 #define rcu_dereference_bh_check(p, c) \
218         __rcu_dereference_check((p), (c) || rcu_read_lock_bh_held(), __rcu)
219
220 /**
221  * rcu_dereference_sched_check() - rcu_dereference_sched with debug checking
222  * @p: The pointer to read, prior to dereferencing
223  * @c: The conditions under which the dereference will take place
224  *
225  * This is the RCU-sched counterpart to rcu_dereference_check().
226  */
227 #define rcu_dereference_sched_check(p, c) \
228         __rcu_dereference_check((p), (c) || rcu_read_lock_sched_held(), \
229                                 __rcu)
230
231 /*
232  * The tracing infrastructure traces RCU (we want that), but unfortunately
233  * some of the RCU checks causes tracing to lock up the system.
234  *
235  * The no-tracing version of rcu_dereference_raw() must not call
236  * rcu_read_lock_held().
237  */
238 #define rcu_dereference_raw_notrace(p) __rcu_dereference_check((p), 1, __rcu)
239
240 /**
241  * rcu_dereference_protected() - fetch RCU pointer when updates prevented
242  * @p: The pointer to read, prior to dereferencing
243  * @c: The conditions under which the dereference will take place
244  *
245  * Return the value of the specified RCU-protected pointer, but omit
246  * both the smp_read_barrier_depends() and the READ_ONCE().  This
247  * is useful in cases where update-side locks prevent the value of the
248  * pointer from changing.  Please note that this primitive does -not-
249  * prevent the compiler from repeating this reference or combining it
250  * with other references, so it should not be used without protection
251  * of appropriate locks.
252  *
253  * This function is only for update-side use.  Using this function
254  * when protected only by rcu_read_lock() will result in infrequent
255  * but very ugly failures.
256  */
257 #define rcu_dereference_protected(p, c) \
258         __rcu_dereference_protected((p), (c), __rcu)
259
260
261 /**
262  * rcu_dereference() - fetch RCU-protected pointer for dereferencing
263  * @p: The pointer to read, prior to dereferencing
264  *
265  * This is a simple wrapper around rcu_dereference_check().
266  */
267 #define rcu_dereference(p) rcu_dereference_check(p, 0)
268
269 /**
270  * rcu_dereference_bh() - fetch an RCU-bh-protected pointer for dereferencing
271  * @p: The pointer to read, prior to dereferencing
272  *
273  * Makes rcu_dereference_check() do the dirty work.
274  */
275 #define rcu_dereference_bh(p) rcu_dereference_bh_check(p, 0)
276
277 /**
278  * rcu_dereference_sched() - fetch RCU-sched-protected pointer for dereferencing
279  * @p: The pointer to read, prior to dereferencing
280  *
281  * Makes rcu_dereference_check() do the dirty work.
282  */
283 #define rcu_dereference_sched(p) rcu_dereference_sched_check(p, 0)
284
285 /**
286  * rcu_pointer_handoff() - Hand off a pointer from RCU to other mechanism
287  * @p: The pointer to hand off
288  *
289  * This is simply an identity function, but it documents where a pointer
290  * is handed off from RCU to some other synchronization mechanism, for
291  * example, reference counting or locking.  In C11, it would map to
292  * kill_dependency().  It could be used as follows:
293  *
294  *      rcu_read_lock();
295  *      p = rcu_dereference(gp);
296  *      long_lived = is_long_lived(p);
297  *      if (long_lived) {
298  *              if (!atomic_inc_not_zero(p->refcnt))
299  *                      long_lived = false;
300  *              else
301  *                      p = rcu_pointer_handoff(p);
302  *      }
303  *      rcu_read_unlock();
304  */
305 #define rcu_pointer_handoff(p) (p)
306
307 /**
308  * rcu_read_lock() - mark the beginning of an RCU read-side critical section
309  *
310  * When synchronize_rcu() is invoked on one CPU while other CPUs
311  * are within RCU read-side critical sections, then the
312  * synchronize_rcu() is guaranteed to block until after all the other
313  * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
314  * on one CPU while other CPUs are within RCU read-side critical
315  * sections, invocation of the corresponding RCU callback is deferred
316  * until after the all the other CPUs exit their critical sections.
317  *
318  * Note, however, that RCU callbacks are permitted to run concurrently
319  * with new RCU read-side critical sections.  One way that this can happen
320  * is via the following sequence of events: (1) CPU 0 enters an RCU
321  * read-side critical section, (2) CPU 1 invokes call_rcu() to register
322  * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
323  * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
324  * callback is invoked.  This is legal, because the RCU read-side critical
325  * section that was running concurrently with the call_rcu() (and which
326  * therefore might be referencing something that the corresponding RCU
327  * callback would free up) has completed before the corresponding
328  * RCU callback is invoked.
329  *
330  * RCU read-side critical sections may be nested.  Any deferred actions
331  * will be deferred until the outermost RCU read-side critical section
332  * completes.
333  *
334  * You can avoid reading and understanding the next paragraph by
335  * following this rule: don't put anything in an rcu_read_lock() RCU
336  * read-side critical section that would block in a !PREEMPT kernel.
337  * But if you want the full story, read on!
338  *
339  * In non-preemptible RCU implementations (TREE_RCU and TINY_RCU),
340  * it is illegal to block while in an RCU read-side critical section.
341  * In preemptible RCU implementations (PREEMPT_RCU) in CONFIG_PREEMPT
342  * kernel builds, RCU read-side critical sections may be preempted,
343  * but explicit blocking is illegal.  Finally, in preemptible RCU
344  * implementations in real-time (with -rt patchset) kernel builds, RCU
345  * read-side critical sections may be preempted and they may also block, but
346  * only when acquiring spinlocks that are subject to priority inheritance.
347  */
348 static inline void rcu_read_lock(void)
349 {
350         __rcu_read_lock();
351         __acquire(RCU);
352         rcu_lock_acquire(&rcu_lock_map);
353         RCU_LOCKDEP_WARN(!rcu_is_watching(),
354                          "rcu_read_lock() used illegally while idle");
355 }
356
357 /*
358  * So where is rcu_write_lock()?  It does not exist, as there is no
359  * way for writers to lock out RCU readers.  This is a feature, not
360  * a bug -- this property is what provides RCU's performance benefits.
361  * Of course, writers must coordinate with each other.  The normal
362  * spinlock primitives work well for this, but any other technique may be
363  * used as well.  RCU does not care how the writers keep out of each
364  * others' way, as long as they do so.
365  */
366
367 /**
368  * rcu_read_unlock() - marks the end of an RCU read-side critical section.
369  *
370  * In most situations, rcu_read_unlock() is immune from deadlock.
371  * However, in kernels built with CONFIG_RCU_BOOST, rcu_read_unlock()
372  * is responsible for deboosting, which it does via rt_mutex_unlock().
373  * Unfortunately, this function acquires the scheduler's runqueue and
374  * priority-inheritance spinlocks.  This means that deadlock could result
375  * if the caller of rcu_read_unlock() already holds one of these locks or
376  * any lock that is ever acquired while holding them; or any lock which
377  * can be taken from interrupt context because rcu_boost()->rt_mutex_lock()
378  * does not disable irqs while taking ->wait_lock.
379  *
380  * That said, RCU readers are never priority boosted unless they were
381  * preempted.  Therefore, one way to avoid deadlock is to make sure
382  * that preemption never happens within any RCU read-side critical
383  * section whose outermost rcu_read_unlock() is called with one of
384  * rt_mutex_unlock()'s locks held.  Such preemption can be avoided in
385  * a number of ways, for example, by invoking preempt_disable() before
386  * critical section's outermost rcu_read_lock().
387  *
388  * Given that the set of locks acquired by rt_mutex_unlock() might change
389  * at any time, a somewhat more future-proofed approach is to make sure
390  * that that preemption never happens within any RCU read-side critical
391  * section whose outermost rcu_read_unlock() is called with irqs disabled.
392  * This approach relies on the fact that rt_mutex_unlock() currently only
393  * acquires irq-disabled locks.
394  *
395  * The second of these two approaches is best in most situations,
396  * however, the first approach can also be useful, at least to those
397  * developers willing to keep abreast of the set of locks acquired by
398  * rt_mutex_unlock().
399  *
400  * See rcu_read_lock() for more information.
401  */
402 static inline void rcu_read_unlock(void)
403 {
404         RCU_LOCKDEP_WARN(!rcu_is_watching(),
405                          "rcu_read_unlock() used illegally while idle");
406         __release(RCU);
407         __rcu_read_unlock();
408         rcu_lock_release(&rcu_lock_map); /* Keep acq info for rls diags. */
409 }
410
411 /**
412  * RCU_INIT_POINTER() - initialize an RCU protected pointer
413  *
414  * Initialize an RCU-protected pointer in special cases where readers
415  * do not need ordering constraints on the CPU or the compiler.  These
416  * special cases are:
417  *
418  * 1.   This use of RCU_INIT_POINTER() is NULLing out the pointer -or-
419  * 2.   The caller has taken whatever steps are required to prevent
420  *      RCU readers from concurrently accessing this pointer -or-
421  * 3.   The referenced data structure has already been exposed to
422  *      readers either at compile time or via rcu_assign_pointer() -and-
423  *      a.      You have not made -any- reader-visible changes to
424  *              this structure since then -or-
425  *      b.      It is OK for readers accessing this structure from its
426  *              new location to see the old state of the structure.  (For
427  *              example, the changes were to statistical counters or to
428  *              other state where exact synchronization is not required.)
429  *
430  * Failure to follow these rules governing use of RCU_INIT_POINTER() will
431  * result in impossible-to-diagnose memory corruption.  As in the structures
432  * will look OK in crash dumps, but any concurrent RCU readers might
433  * see pre-initialized values of the referenced data structure.  So
434  * please be very careful how you use RCU_INIT_POINTER()!!!
435  *
436  * If you are creating an RCU-protected linked structure that is accessed
437  * by a single external-to-structure RCU-protected pointer, then you may
438  * use RCU_INIT_POINTER() to initialize the internal RCU-protected
439  * pointers, but you must use rcu_assign_pointer() to initialize the
440  * external-to-structure pointer -after- you have completely initialized
441  * the reader-accessible portions of the linked structure.
442  *
443  * Note that unlike rcu_assign_pointer(), RCU_INIT_POINTER() provides no
444  * ordering guarantees for either the CPU or the compiler.
445  */
446 #define RCU_INIT_POINTER(p, v) \
447         do { \
448                 rcu_dereference_sparse(p, __rcu); \
449                 WRITE_ONCE(p, RCU_INITIALIZER(v)); \
450         } while (0)
451
452 /**
453  * RCU_POINTER_INITIALIZER() - statically initialize an RCU protected pointer
454  *
455  * GCC-style initialization for an RCU-protected pointer in a structure field.
456  */
457 #define RCU_POINTER_INITIALIZER(p, v) \
458                 .p = RCU_INITIALIZER(v)
459
460 /*
461  * Does the specified offset indicate that the corresponding rcu_head
462  * structure can be handled by kfree_rcu()?
463  */
464 #define __is_kfree_rcu_offset(offset) ((offset) < 4096)
465
466 /*
467  * Helper macro for kfree_rcu() to prevent argument-expansion eyestrain.
468  */
469 #define __kfree_rcu(head, offset) \
470         do { \
471                 static_assert(__is_kfree_rcu_offset(offset)); \
472                 kfree_call_rcu(head, (rcu_callback_t)(unsigned long)(offset)); \
473         } while (0)
474
475 /**
476  * kfree_rcu() - kfree an object after a grace period.
477  * @ptr:        pointer to kfree
478  * @rcu_head:   the name of the struct rcu_head within the type of @ptr.
479  *
480  * Many rcu callbacks functions just call kfree() on the base structure.
481  * These functions are trivial, but their size adds up, and furthermore
482  * when they are used in a kernel module, that module must invoke the
483  * high-latency rcu_barrier() function at module-unload time.
484  *
485  * The kfree_rcu() function handles this issue.  Rather than encoding a
486  * function address in the embedded rcu_head structure, kfree_rcu() instead
487  * encodes the offset of the rcu_head structure within the base structure.
488  * Because the functions are not allowed in the low-order 4096 bytes of
489  * kernel virtual memory, offsets up to 4095 bytes can be accommodated.
490  * If the offset is larger than 4095 bytes, a compile-time error will
491  * be generated in __kfree_rcu().  If this error is triggered, you can
492  * either fall back to use of call_rcu() or rearrange the structure to
493  * position the rcu_head structure into the first 4096 bytes.
494  *
495  * Note that the allowable offset might decrease in the future, for example,
496  * to allow something like kmem_cache_free_rcu().
497  *
498  * The BUILD_BUG_ON check must not involve any function calls, hence the
499  * checks are done in macros here.
500  */
501 #define kfree_rcu(ptr, rcu_head)                                        \
502         __kfree_rcu(&((ptr)->rcu_head), offsetof(typeof(*(ptr)), rcu_head))
503
504
505 /*
506  * Place this after a lock-acquisition primitive to guarantee that
507  * an UNLOCK+LOCK pair acts as a full barrier.  This guarantee applies
508  * if the UNLOCK and LOCK are executed by the same CPU or if the
509  * UNLOCK and LOCK operate on the same lock variable.
510  */
511 #ifdef CONFIG_ARCH_WEAK_RELEASE_ACQUIRE
512 #define smp_mb__after_unlock_lock()     smp_mb()  /* Full ordering for lock. */
513 #else /* #ifdef CONFIG_ARCH_WEAK_RELEASE_ACQUIRE */
514 #define smp_mb__after_unlock_lock()     do { } while (0)
515 #endif /* #else #ifdef CONFIG_ARCH_WEAK_RELEASE_ACQUIRE */
516
517
518 #endif /* __LINUX_RCUPDATE_H */