Commit | Line | Data |
---|---|---|
adcfce54 MD |
1 | #ifndef _URCU_STATIC_H |
2 | #define _URCU_STATIC_H | |
3 | ||
4 | /* | |
5 | * urcu-static.h | |
6 | * | |
d2d23035 | 7 | * Userspace RCU header. |
adcfce54 | 8 | * |
a5a9f428 PM |
9 | * TO BE INCLUDED ONLY IN CODE THAT IS TO BE RECOMPILED ON EACH LIBURCU |
10 | * RELEASE. See urcu.h for linking dynamically with the userspace rcu library. | |
adcfce54 | 11 | * |
6982d6d7 | 12 | * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
d2d23035 | 13 | * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. |
adcfce54 | 14 | * |
d2d23035 MD |
15 | * This library is free software; you can redistribute it and/or |
16 | * modify it under the terms of the GNU Lesser General Public | |
17 | * License as published by the Free Software Foundation; either | |
18 | * version 2.1 of the License, or (at your option) any later version. | |
19 | * | |
20 | * This library is distributed in the hope that it will be useful, | |
21 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
22 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
23 | * Lesser General Public License for more details. | |
24 | * | |
25 | * You should have received a copy of the GNU Lesser General Public | |
26 | * License along with this library; if not, write to the Free Software | |
27 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
adcfce54 MD |
28 | * |
29 | * IBM's contributions to this file may be relicensed under LGPLv2 or later. | |
30 | */ | |
31 | ||
32 | #include <stdlib.h> | |
33 | #include <pthread.h> | |
bc6c15bb | 34 | #include <unistd.h> |
6d841bc2 | 35 | #include <stdint.h> |
adcfce54 | 36 | |
ec4e58a3 MD |
37 | #include <urcu/compiler.h> |
38 | #include <urcu/arch.h> | |
7e30abe3 | 39 | #include <urcu/system.h> |
a2e7bf9c | 40 | #include <urcu/uatomic.h> |
e3b0cef0 | 41 | #include <urcu/list.h> |
41849996 | 42 | #include <urcu/futex.h> |
bd252a04 | 43 | #include <urcu/tls-compat.h> |
e1c0b55c | 44 | #include <urcu/rand-compat.h> |
791151d0 | 45 | #include <urcu/urcu-checker.h> |
bc6c15bb | 46 | |
36bc70a8 MD |
47 | #ifdef __cplusplus |
48 | extern "C" { | |
49 | #endif | |
50 | ||
65f1e634 | 51 | /* Default is RCU_MEMBARRIER */ |
fdf01eed | 52 | #if !defined(RCU_MEMBARRIER) && !defined(RCU_MB) && !defined(RCU_SIGNAL) |
65f1e634 MD |
53 | #define RCU_MEMBARRIER |
54 | #endif | |
55 | ||
adcfce54 MD |
56 | /* |
57 | * This code section can only be included in LGPL 2.1 compatible source code. | |
58 | * See below for the function call wrappers which can be used in code meant to | |
59 | * be only linked with the Userspace RCU library. This comes with a small | |
60 | * performance degradation on the read-side due to the added function calls. | |
61 | * This is required to permit relinking with newer versions of the library. | |
62 | */ | |
63 | ||
64 | /* | |
65 | * The signal number used by the RCU library can be overridden with | |
02be5561 | 66 | * -DSIGRCU= when compiling the library. |
ddf7eefb | 67 | * Provide backward compatibility for liburcu 0.3.x SIGURCU. |
adcfce54 | 68 | */ |
ddf7eefb MD |
69 | #ifdef SIGURCU |
70 | #define SIGRCU SIGURCU | |
71 | #endif | |
72 | ||
02be5561 MD |
73 | #ifndef SIGRCU |
74 | #define SIGRCU SIGUSR1 | |
adcfce54 MD |
75 | #endif |
76 | ||
fd189fa5 MD |
77 | enum rcu_state { |
78 | RCU_READER_ACTIVE_CURRENT, | |
79 | RCU_READER_ACTIVE_OLD, | |
80 | RCU_READER_INACTIVE, | |
81 | }; | |
82 | ||
7ac06cef MD |
83 | #ifdef DEBUG_RCU |
84 | #define rcu_assert(args...) assert(args) | |
85 | #else | |
86 | #define rcu_assert(args...) | |
87 | #endif | |
88 | ||
25cc6d18 MD |
89 | /* |
90 | * RCU memory barrier broadcast group. Currently, only broadcast to all process | |
91 | * threads is supported (group 0). | |
92 | * | |
93 | * Slave barriers are only guaranteed to be ordered wrt master barriers. | |
94 | * | |
95 | * The pair ordering is detailed as (O: ordered, X: not ordered) : | |
96 | * slave master | |
97 | * slave X O | |
98 | * master O O | |
99 | */ | |
100 | ||
101 | #define MB_GROUP_ALL 0 | |
102 | #define RCU_MB_GROUP MB_GROUP_ALL | |
103 | ||
fdf01eed | 104 | #ifdef RCU_MEMBARRIER |
1de4df4b | 105 | extern int rcu_has_sys_membarrier; |
fdf01eed | 106 | |
25cc6d18 | 107 | static inline void smp_mb_slave(int group) |
fdf01eed | 108 | { |
1de4df4b | 109 | if (caa_likely(rcu_has_sys_membarrier)) |
5481ddb3 | 110 | cmm_barrier(); |
fdf01eed | 111 | else |
5481ddb3 | 112 | cmm_smp_mb(); |
fdf01eed MD |
113 | } |
114 | #endif | |
115 | ||
02be5561 | 116 | #ifdef RCU_MB |
25cc6d18 | 117 | static inline void smp_mb_slave(int group) |
adcfce54 | 118 | { |
5481ddb3 | 119 | cmm_smp_mb(); |
adcfce54 | 120 | } |
fdf01eed MD |
121 | #endif |
122 | ||
123 | #ifdef RCU_SIGNAL | |
25cc6d18 | 124 | static inline void smp_mb_slave(int group) |
adcfce54 | 125 | { |
5481ddb3 | 126 | cmm_barrier(); |
adcfce54 MD |
127 | } |
128 | #endif | |
129 | ||
130 | /* | |
02be5561 MD |
131 | * The trick here is that RCU_GP_CTR_PHASE must be a multiple of 8 so we can use |
132 | * a full 8-bits, 16-bits or 32-bits bitmask for the lower order bits. | |
adcfce54 MD |
133 | */ |
134 | #define RCU_GP_COUNT (1UL << 0) | |
135 | /* Use the amount of bits equal to half of the architecture long size */ | |
27d65bc5 | 136 | #define RCU_GP_CTR_PHASE (1UL << (sizeof(unsigned long) << 2)) |
02be5561 | 137 | #define RCU_GP_CTR_NEST_MASK (RCU_GP_CTR_PHASE - 1) |
adcfce54 | 138 | |
4de0cd31 | 139 | struct rcu_gp { |
ed1b099e LJ |
140 | /* |
141 | * Global grace period counter. | |
142 | * Contains the current RCU_GP_CTR_PHASE. | |
143 | * Also has a RCU_GP_COUNT of 1, to accelerate the reader fast path. | |
144 | * Written to only by writer with mutex taken. | |
145 | * Read by both writer and readers. | |
146 | */ | |
147 | unsigned long ctr; | |
148 | ||
149 | int32_t futex; | |
150 | } __attribute__((aligned(CAA_CACHE_LINE_SIZE))); | |
151 | ||
4de0cd31 | 152 | extern struct rcu_gp rcu_gp; |
adcfce54 | 153 | |
02be5561 | 154 | struct rcu_reader { |
bd1a5e15 | 155 | /* Data used by both reader and synchronize_rcu() */ |
27d65bc5 | 156 | unsigned long ctr; |
e3b0cef0 | 157 | char need_mb; |
bd1a5e15 | 158 | /* Data used for registry */ |
16aa9ee8 | 159 | struct cds_list_head node __attribute__((aligned(CAA_CACHE_LINE_SIZE))); |
bd1a5e15 | 160 | pthread_t tid; |
e3b0cef0 MD |
161 | }; |
162 | ||
bd252a04 | 163 | extern DECLARE_URCU_TLS(struct rcu_reader, rcu_reader); |
adcfce54 | 164 | |
bc6c15bb MD |
165 | /* |
166 | * Wake-up waiting synchronize_rcu(). Called from many concurrent threads. | |
167 | */ | |
168 | static inline void wake_up_gp(void) | |
169 | { | |
ed1b099e LJ |
170 | if (caa_unlikely(uatomic_read(&rcu_gp.futex) == -1)) { |
171 | uatomic_set(&rcu_gp.futex, 0); | |
172 | futex_async(&rcu_gp.futex, FUTEX_WAKE, 1, | |
bc6c15bb MD |
173 | NULL, NULL, 0); |
174 | } | |
175 | } | |
176 | ||
fd189fa5 | 177 | static inline enum rcu_state rcu_reader_state(unsigned long *ctr) |
adcfce54 | 178 | { |
27d65bc5 | 179 | unsigned long v; |
adcfce54 | 180 | |
adcfce54 MD |
181 | /* |
182 | * Make sure both tests below are done on the same version of *value | |
183 | * to insure consistency. | |
184 | */ | |
6cf3827c | 185 | v = CMM_LOAD_SHARED(*ctr); |
fd189fa5 MD |
186 | if (!(v & RCU_GP_CTR_NEST_MASK)) |
187 | return RCU_READER_INACTIVE; | |
ed1b099e | 188 | if (!((v ^ rcu_gp.ctr) & RCU_GP_CTR_PHASE)) |
fd189fa5 MD |
189 | return RCU_READER_ACTIVE_CURRENT; |
190 | return RCU_READER_ACTIVE_OLD; | |
adcfce54 MD |
191 | } |
192 | ||
a5a9f428 | 193 | /* |
ed1b099e | 194 | * Helper for _rcu_read_lock(). The format of rcu_gp.ctr (as well as |
a5a9f428 PM |
195 | * the per-thread rcu_reader.ctr) has the upper bits containing a count of |
196 | * _rcu_read_lock() nesting, and a lower-order bit that contains either zero | |
197 | * or RCU_GP_CTR_PHASE. The smp_mb_slave() ensures that the accesses in | |
198 | * _rcu_read_lock() happen before the subsequent read-side critical section. | |
199 | */ | |
200 | static inline void _rcu_read_lock_update(unsigned long tmp) | |
adcfce54 | 201 | { |
a0b7f7ea | 202 | if (caa_likely(!(tmp & RCU_GP_CTR_NEST_MASK))) { |
ed1b099e | 203 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader).ctr, _CMM_LOAD_SHARED(rcu_gp.ctr)); |
25cc6d18 | 204 | smp_mb_slave(RCU_MB_GROUP); |
a5a9f428 | 205 | } else |
bd252a04 | 206 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader).ctr, tmp + RCU_GP_COUNT); |
adcfce54 MD |
207 | } |
208 | ||
a5a9f428 PM |
209 | /* |
210 | * Enter an RCU read-side critical section. | |
211 | * | |
212 | * The first cmm_barrier() call ensures that the compiler does not reorder | |
213 | * the body of _rcu_read_lock() with a mutex. | |
214 | * | |
215 | * This function and its helper are both less than 10 lines long. The | |
216 | * intent is that this function meets the 10-line criterion in LGPL, | |
217 | * allowing this function to be invoked directly from non-LGPL code. | |
218 | */ | |
219 | static inline void _rcu_read_lock(void) | |
adcfce54 | 220 | { |
27d65bc5 | 221 | unsigned long tmp; |
bc6c15bb | 222 | |
791151d0 | 223 | rcu_read_lock_debug(); |
a5a9f428 | 224 | cmm_barrier(); |
bd252a04 | 225 | tmp = URCU_TLS(rcu_reader).ctr; |
a5a9f428 PM |
226 | _rcu_read_lock_update(tmp); |
227 | } | |
228 | ||
229 | /* | |
230 | * This is a helper function for _rcu_read_unlock(). | |
231 | * | |
232 | * The first smp_mb_slave() call ensures that the critical section is | |
233 | * seen to precede the store to rcu_reader.ctr. | |
234 | * The second smp_mb_slave() call ensures that we write to rcu_reader.ctr | |
235 | * before reading the update-side futex. | |
236 | */ | |
237 | static inline void _rcu_read_unlock_update_and_wakeup(unsigned long tmp) | |
238 | { | |
a0b7f7ea | 239 | if (caa_likely((tmp & RCU_GP_CTR_NEST_MASK) == RCU_GP_COUNT)) { |
25cc6d18 | 240 | smp_mb_slave(RCU_MB_GROUP); |
bd252a04 | 241 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader).ctr, URCU_TLS(rcu_reader).ctr - RCU_GP_COUNT); |
25cc6d18 | 242 | smp_mb_slave(RCU_MB_GROUP); |
bc6c15bb | 243 | wake_up_gp(); |
a5a9f428 | 244 | } else |
bd252a04 | 245 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader).ctr, URCU_TLS(rcu_reader).ctr - RCU_GP_COUNT); |
a5a9f428 PM |
246 | } |
247 | ||
248 | /* | |
249 | * Exit an RCU read-side crtical section. Both this function and its | |
250 | * helper are smaller than 10 lines of code, and are intended to be | |
251 | * usable by non-LGPL code, as called out in LGPL. | |
252 | */ | |
253 | static inline void _rcu_read_unlock(void) | |
254 | { | |
255 | unsigned long tmp; | |
256 | ||
257 | tmp = URCU_TLS(rcu_reader).ctr; | |
258 | _rcu_read_unlock_update_and_wakeup(tmp); | |
5481ddb3 | 259 | cmm_barrier(); /* Ensure the compiler does not reorder us with mutex */ |
791151d0 | 260 | rcu_read_unlock_debug(); |
adcfce54 MD |
261 | } |
262 | ||
882f3357 MD |
263 | /* |
264 | * Returns whether within a RCU read-side critical section. | |
265 | * | |
266 | * This function is less than 10 lines long. The intent is that this | |
267 | * function meets the 10-line criterion for LGPL, allowing this function | |
268 | * to be invoked directly from non-LGPL code. | |
269 | */ | |
270 | static inline int _rcu_read_ongoing(void) | |
271 | { | |
272 | return URCU_TLS(rcu_reader).ctr & RCU_GP_CTR_NEST_MASK; | |
273 | } | |
274 | ||
ad918eeb | 275 | #ifdef __cplusplus |
36bc70a8 MD |
276 | } |
277 | #endif | |
278 | ||
adcfce54 | 279 | #endif /* _URCU_STATIC_H */ |