urcu.h

   1 #ifndef _URCU_H
   2 #define _URCU_H
   3
   4 /*
   5  * urcu.h
   6  *
   7  * Userspace RCU header
   8  *
   9  * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
  10  *
  11  * Credits for Paul e. McKenney <paulmck@linux.vnet.ibm.com>
  12  * for inspiration coming from the Linux kernel RCU and rcu-preempt.
  13  *
  14  * The barrier, mb, rmb, wmb, atomic_inc, smp_read_barrier_depends, ACCESS_ONCE
  15  * and rcu_dereference primitives come from the Linux kernel.
  16  *
  17  * Distributed under GPLv2
  18  */
  19
  20 #define __USE_GNU
  21 #include <stdlib.h>
  22 #include <pthread.h>
  23
  24 /* The "volatile" is due to gcc bugs */
  25 #define barrier() __asm__ __volatile__("": : :"memory")
  26
  27 #define likely(x)       __builtin_expect(!!(x), 1)
  28 #define unlikely(x)     __builtin_expect(!!(x), 0)
  29
  30 /* x86 32/64 specific */
  31 #define mb()    asm volatile("mfence":::"memory")
  32 #define rmb()   asm volatile("lfence":::"memory")
  33 #define wmb()   asm volatile("sfence" ::: "memory")
  34
  35 static inline void atomic_inc(int *v)
  36 {
  37         asm volatile("lock; incl %0"
  38                      : "+m" (*v));
  39 }
  40
  41 #define xchg(ptr, v)                                                    \
  42         ((__typeof__(*(ptr)))__xchg((unsigned long)(v), (ptr), sizeof(*(ptr))))
  43
  44 struct __xchg_dummy {
  45         unsigned long a[100];
  46 };
  47 #define __xg(x) ((struct __xchg_dummy *)(x))
  48
  49 /*
  50  * Note: no "lock" prefix even on SMP: xchg always implies lock anyway
  51  * Note 2: xchg has side effect, so that attribute volatile is necessary,
  52  *        but generally the primitive is invalid, *ptr is output argument. --ANK
  53  */
  54 static inline unsigned long __xchg(unsigned long x, volatile void *ptr,
  55                                    int size)
  56 {
  57         switch (size) {
  58         case 1:
  59                 asm volatile("xchgb %b0,%1"
  60                              : "=q" (x)
  61                              : "m" (*__xg(ptr)), "0" (x)
  62                              : "memory");
  63                 break;
  64         case 2:
  65                 asm volatile("xchgw %w0,%1"
  66                              : "=r" (x)
  67                              : "m" (*__xg(ptr)), "0" (x)
  68                              : "memory");
  69                 break;
  70         case 4:
  71                 asm volatile("xchgl %k0,%1"
  72                              : "=r" (x)
  73                              : "m" (*__xg(ptr)), "0" (x)
  74                              : "memory");
  75                 break;
  76         case 8:
  77                 asm volatile("xchgq %0,%1"
  78                              : "=r" (x)
  79                              : "m" (*__xg(ptr)), "0" (x)
  80                              : "memory");
  81                 break;
  82         }
  83         return x;
  84 }
  85
  86 /* Nop everywhere except on alpha. */
  87 #define smp_read_barrier_depends()
  88
  89 /*
  90  * Prevent the compiler from merging or refetching accesses.  The compiler
  91  * is also forbidden from reordering successive instances of ACCESS_ONCE(),
  92  * but only when the compiler is aware of some particular ordering.  One way
  93  * to make the compiler aware of ordering is to put the two invocations of
  94  * ACCESS_ONCE() in different C statements.
  95  *
  96  * This macro does absolutely -nothing- to prevent the CPU from reordering,
  97  * merging, or refetching absolutely anything at any time.  Its main intended
  98  * use is to mediate communication between process-level code and irq/NMI
  99  * handlers, all running on the same CPU.
 100  */
 101 #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
 102
 103 /**
 104  * rcu_dereference - fetch an RCU-protected pointer in an
 105  * RCU read-side critical section.  This pointer may later
 106  * be safely dereferenced.
 107  *
 108  * Inserts memory barriers on architectures that require them
 109  * (currently only the Alpha), and, more importantly, documents
 110  * exactly which pointers are protected by RCU.
 111  */
 112
 113 #define rcu_dereference(p)     ({ \
 114                                 typeof(p) _________p1 = ACCESS_ONCE(p); \
 115                                 smp_read_barrier_depends(); \
 116                                 (_________p1); \
 117                                 })
 118
 119 #define SIGURCU SIGUSR1
 120
 121 #ifdef DEBUG_YIELD
 122 #include <sched.h>
 123 #include <time.h>
 124 #include <pthread.h>
 125
 126 #define YIELD_READ      (1 << 0)
 127 #define YIELD_WRITE     (1 << 1)
 128
 129 extern unsigned int yield_active;
 130 extern unsigned int __thread rand_yield;
 131
 132 static inline void debug_yield_read(void)
 133 {
 134         if (yield_active & YIELD_READ)
 135                 if (rand_r(&rand_yield) & 0x1)
 136                         sched_yield();
 137 }
 138
 139 static inline void debug_yield_write(void)
 140 {
 141         if (yield_active & YIELD_WRITE)
 142                 if (rand_r(&rand_yield) & 0x1)
 143                         sched_yield();
 144 }
 145
 146 static inline void debug_yield_init(void)
 147 {
 148         rand_yield = time(NULL) ^ pthread_self();
 149 }
 150 #else
 151 static inline void debug_yield_read(void)
 152 {
 153 }
 154
 155 static inline void debug_yield_write(void)
 156 {
 157 }
 158
 159 static inline void debug_yield_init(void)
 160 {
 161
 162 }
 163 #endif
 164
 165 /*
 166  * Limiting the nesting level to 256 to keep instructions small in the read
 167  * fast-path.
 168  */
 169 #define RCU_GP_COUNT            (1U << 0)
 170 #define RCU_GP_CTR_BIT          (1U << 8)
 171 #define RCU_GP_CTR_NEST_MASK    (RCU_GP_CTR_BIT - 1)
 172
 173 /*
 174  * Global quiescent period counter with low-order bits unused.
 175  * Using a int rather than a char to eliminate false register dependencies
 176  * causing stalls on some architectures.
 177  */
 178 extern int urcu_gp_ctr;
 179
 180 extern int __thread urcu_active_readers;
 181
 182 static inline int rcu_old_gp_ongoing(int *value)
 183 {
 184         int v;
 185
 186         if (value == NULL)
 187                 return 0;
 188         debug_yield_write();
 189         v = ACCESS_ONCE(*value);
 190         debug_yield_write();
 191         return (v & RCU_GP_CTR_NEST_MASK) &&
 192                  ((v ^ ACCESS_ONCE(urcu_gp_ctr)) & RCU_GP_CTR_BIT);
 193 }
 194
 195 static inline void rcu_read_lock(void)
 196 {
 197         int tmp;
 198
 199         debug_yield_read();
 200         tmp = urcu_active_readers;
 201         debug_yield_read();
 202         if (likely(!(tmp & RCU_GP_CTR_NEST_MASK)))
 203                 urcu_active_readers = urcu_gp_ctr + RCU_GP_COUNT;
 204         else
 205                 urcu_active_readers = tmp + RCU_GP_COUNT;
 206         debug_yield_read();
 207         /*
 208          * Increment active readers count before accessing the pointer.
 209          * See force_mb_all_threads().
 210          */
 211         barrier();
 212         debug_yield_read();
 213 }
 214
 215 static inline void rcu_read_unlock(void)
 216 {
 217         debug_yield_read();
 218         barrier();
 219         debug_yield_read();
 220         /*
 221          * Finish using rcu before decrementing the pointer.
 222          * See force_mb_all_threads().
 223          */
 224         urcu_active_readers -= RCU_GP_COUNT;
 225         debug_yield_read();
 226 }
 227
 228 /**
 229  * rcu_assign_pointer - assign (publicize) a pointer to a newly
 230  * initialized structure that will be dereferenced by RCU read-side
 231  * critical sections.  Returns the value assigned.
 232  *
 233  * Inserts memory barriers on architectures that require them
 234  * (pretty much all of them other than x86), and also prevents
 235  * the compiler from reordering the code that initializes the
 236  * structure after the pointer assignment.  More importantly, this
 237  * call documents which pointers will be dereferenced by RCU read-side
 238  * code.
 239  */
 240
 241 #define rcu_assign_pointer(p, v) \
 242         ({ \
 243                 if (!__builtin_constant_p(v) || \
 244                     ((v) != NULL)) \
 245                         wmb(); \
 246                 (p) = (v); \
 247         })
 248
 249 #define rcu_xchg_pointer(p, v) \
 250         ({ \
 251                 if (!__builtin_constant_p(v) || \
 252                     ((v) != NULL)) \
 253                         wmb(); \
 254                 xchg(p, v); \
 255         })
 256
 257 extern void synchronize_rcu(void);
 258
 259 /*
 260  * Exchanges the pointer and waits for quiescent state.
 261  * The pointer returned can be freed.
 262  */
 263 #define urcu_publish_content(p, v) \
 264         ({ \
 265                 void *oldptr; \
 266                 debug_yield_write(); \
 267                 oldptr = rcu_xchg_pointer(p, v); \
 268                 synchronize_rcu(); \
 269                 oldptr; \
 270         })
 271
 272 /*
 273  * Reader thread registration.
 274  */
 275 extern void urcu_register_thread(void);
 276 extern void urcu_unregister_thread(void);
 277
 278 #endif /* _URCU_H */