4 * Userspace RCU QSBR library
6 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
7 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
35 #define BUILD_QSBR_LIB
36 #include "urcu-qsbr-static.h"
37 /* Do not #define _LGPL_SOURCE to ensure we can emit the wrapper symbols */
38 #include "urcu-qsbr.h"
40 static pthread_mutex_t urcu_mutex
= PTHREAD_MUTEX_INITIALIZER
;
43 * Global grace period counter.
45 unsigned long urcu_gp_ctr
= RCU_GP_ONLINE
;
48 * Written to only by each individual reader. Read by both the reader and the
51 unsigned long __thread rcu_reader_qs_gp
;
53 /* Thread IDs of registered readers */
54 #define INIT_NUM_THREADS 4
56 struct reader_registry
{
58 unsigned long *rcu_reader_qs_gp
;
62 unsigned int yield_active
;
63 unsigned int __thread rand_yield
;
66 static struct reader_registry
*registry
;
67 static int num_readers
, alloc_readers
;
69 static void internal_urcu_lock(void)
73 #ifndef DISTRUST_SIGNALS_EXTREME
74 ret
= pthread_mutex_lock(&urcu_mutex
);
76 perror("Error in pthread mutex lock");
79 #else /* #ifndef DISTRUST_SIGNALS_EXTREME */
80 while ((ret
= pthread_mutex_trylock(&urcu_mutex
)) != 0) {
81 if (ret
!= EBUSY
&& ret
!= EINTR
) {
82 printf("ret = %d, errno = %d\n", ret
, errno
);
83 perror("Error in pthread mutex lock");
88 #endif /* #else #ifndef DISTRUST_SIGNALS_EXTREME */
91 static void internal_urcu_unlock(void)
95 ret
= pthread_mutex_unlock(&urcu_mutex
);
97 perror("Error in pthread mutex unlock");
102 static void wait_for_quiescent_state(void)
104 struct reader_registry
*index
;
109 * Wait for each thread rcu_reader_qs_gp count to become 0.
111 for (index
= registry
; index
< registry
+ num_readers
; index
++) {
112 #ifndef HAS_INCOHERENT_CACHES
113 while (rcu_gp_ongoing(index
->rcu_reader_qs_gp
))
115 #else /* #ifndef HAS_INCOHERENT_CACHES */
116 while (rcu_gp_ongoing(index
->rcu_reader_qs_gp
))
118 #endif /* #else #ifndef HAS_INCOHERENT_CACHES */
123 * Using a two-subphases algorithm for architectures with smaller than 64-bit
124 * long-size to ensure we do not encounter an overflow bug.
127 #if (BITS_PER_LONG < 64)
129 * called with urcu_mutex held.
131 static void switch_next_urcu_qparity(void)
133 STORE_SHARED(urcu_gp_ctr
, urcu_gp_ctr
^ RCU_GP_CTR
);
136 void synchronize_rcu(void)
138 unsigned long was_online
;
140 was_online
= rcu_reader_qs_gp
;
142 /* All threads should read qparity before accessing data structure
143 * where new ptr points to.
145 /* Write new ptr before changing the qparity */
149 * Mark the writer thread offline to make sure we don't wait for
150 * our own quiescent state. This allows using synchronize_rcu() in
151 * threads registered as readers.
154 STORE_SHARED(rcu_reader_qs_gp
, 0);
156 internal_urcu_lock();
158 switch_next_urcu_qparity(); /* 0 -> 1 */
161 * Must commit qparity update to memory before waiting for parity
162 * 0 quiescent state. Failure to do so could result in the writer
163 * waiting forever while new readers are always accessing data (no
165 * Ensured by STORE_SHARED and LOAD_SHARED.
169 * Wait for previous parity to be empty of readers.
171 wait_for_quiescent_state(); /* Wait readers in parity 0 */
174 * Must finish waiting for quiescent state for parity 0 before
175 * committing qparity update to memory. Failure to do so could result in
176 * the writer waiting forever while new readers are always accessing
177 * data (no progress).
178 * Ensured by STORE_SHARED and LOAD_SHARED.
181 switch_next_urcu_qparity(); /* 1 -> 0 */
184 * Must commit qparity update to memory before waiting for parity
185 * 1 quiescent state. Failure to do so could result in the writer
186 * waiting forever while new readers are always accessing data (no
188 * Ensured by STORE_SHARED and LOAD_SHARED.
192 * Wait for previous parity to be empty of readers.
194 wait_for_quiescent_state(); /* Wait readers in parity 1 */
196 internal_urcu_unlock();
199 * Finish waiting for reader threads before letting the old ptr being
203 _STORE_SHARED(rcu_reader_qs_gp
, LOAD_SHARED(urcu_gp_ctr
));
206 #else /* !(BITS_PER_LONG < 64) */
207 void synchronize_rcu(void)
209 unsigned long was_online
;
211 was_online
= rcu_reader_qs_gp
;
214 * Mark the writer thread offline to make sure we don't wait for
215 * our own quiescent state. This allows using synchronize_rcu() in
216 * threads registered as readers.
220 STORE_SHARED(rcu_reader_qs_gp
, 0);
222 internal_urcu_lock();
223 STORE_SHARED(urcu_gp_ctr
, urcu_gp_ctr
+ RCU_GP_CTR
);
224 wait_for_quiescent_state();
225 internal_urcu_unlock();
228 _STORE_SHARED(rcu_reader_qs_gp
, LOAD_SHARED(urcu_gp_ctr
));
231 #endif /* !(BITS_PER_LONG < 64) */
234 * library wrappers to be used by non-LGPL compatible source code.
237 void rcu_read_lock(void)
242 void rcu_read_unlock(void)
247 void *rcu_dereference(void *p
)
249 return _rcu_dereference(p
);
252 void *rcu_assign_pointer_sym(void **p
, void *v
)
255 return STORE_SHARED(p
, v
);
258 void *rcu_xchg_pointer_sym(void **p
, void *v
)
264 void *rcu_publish_content_sym(void **p
, void *v
)
268 oldptr
= _rcu_xchg_pointer(p
, v
);
273 void rcu_quiescent_state(void)
275 _rcu_quiescent_state();
278 void rcu_thread_offline(void)
280 _rcu_thread_offline();
283 void rcu_thread_online(void)
285 _rcu_thread_online();
288 static void rcu_add_reader(pthread_t id
)
290 struct reader_registry
*oldarray
;
293 alloc_readers
= INIT_NUM_THREADS
;
296 malloc(sizeof(struct reader_registry
) * alloc_readers
);
298 if (alloc_readers
< num_readers
+ 1) {
300 registry
= malloc(sizeof(struct reader_registry
)
301 * (alloc_readers
<< 1));
302 memcpy(registry
, oldarray
,
303 sizeof(struct reader_registry
) * alloc_readers
);
307 registry
[num_readers
].tid
= id
;
308 /* reference to the TLS of _this_ reader thread. */
309 registry
[num_readers
].rcu_reader_qs_gp
= &rcu_reader_qs_gp
;
314 * Never shrink (implementation limitation).
315 * This is O(nb threads). Eventually use a hash table.
317 static void rcu_remove_reader(pthread_t id
)
319 struct reader_registry
*index
;
321 assert(registry
!= NULL
);
322 for (index
= registry
; index
< registry
+ num_readers
; index
++) {
323 if (pthread_equal(index
->tid
, id
)) {
324 memcpy(index
, ®istry
[num_readers
- 1],
325 sizeof(struct reader_registry
));
326 registry
[num_readers
- 1].tid
= 0;
327 registry
[num_readers
- 1].rcu_reader_qs_gp
= NULL
;
332 /* Hrm not found, forgot to register ? */
336 void rcu_register_thread(void)
338 internal_urcu_lock();
339 rcu_add_reader(pthread_self());
340 internal_urcu_unlock();
341 _rcu_thread_online();
344 void rcu_unregister_thread(void)
347 * We have to make the thread offline otherwise we end up dealocking
348 * with a waiting writer.
350 _rcu_thread_offline();
351 internal_urcu_lock();
352 rcu_remove_reader(pthread_self());
353 internal_urcu_unlock();