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 #include "urcu-qsbr-static.h"
36 /* Do not #define _LGPL_SOURCE to ensure we can emit the wrapper symbols */
37 #include "urcu-qsbr.h"
39 pthread_mutex_t urcu_mutex
= PTHREAD_MUTEX_INITIALIZER
;
42 * Global grace period counter.
47 * Written to only by each individual reader. Read by both the reader and the
50 long __thread rcu_reader_qs_gp
;
52 /* Thread IDs of registered readers */
53 #define INIT_NUM_THREADS 4
55 struct reader_registry
{
57 long *rcu_reader_qs_gp
;
61 unsigned int yield_active
;
62 unsigned int __thread rand_yield
;
65 static struct reader_registry
*registry
;
66 static int num_readers
, alloc_readers
;
68 static void internal_urcu_lock(void)
72 #ifndef DISTRUST_SIGNALS_EXTREME
73 ret
= pthread_mutex_lock(&urcu_mutex
);
75 perror("Error in pthread mutex lock");
78 #else /* #ifndef DISTRUST_SIGNALS_EXTREME */
79 while ((ret
= pthread_mutex_trylock(&urcu_mutex
)) != 0) {
80 if (ret
!= EBUSY
&& ret
!= EINTR
) {
81 printf("ret = %d, errno = %d\n", ret
, errno
);
82 perror("Error in pthread mutex lock");
87 #endif /* #else #ifndef DISTRUST_SIGNALS_EXTREME */
90 static void internal_urcu_unlock(void)
94 ret
= pthread_mutex_unlock(&urcu_mutex
);
96 perror("Error in pthread mutex unlock");
101 #ifdef HAS_INCOHERENT_CACHES
102 static void force_mb_single_thread(struct reader_registry
*index
)
106 #endif /* #ifdef HAS_INCOHERENT_CACHES */
108 static void force_mb_all_threads(void)
113 static void wait_for_quiescent_state(void)
115 struct reader_registry
*index
;
120 * Wait for each thread rcu_reader_qs_gp count to become 0.
122 for (index
= registry
; index
< registry
+ num_readers
; index
++) {
123 #ifndef HAS_INCOHERENT_CACHES
124 while (rcu_gp_ongoing(index
->rcu_reader_qs_gp
) &&
125 (*index
->rcu_reader_qs_gp
- urcu_gp_ctr
< 0))
127 #else /* #ifndef HAS_INCOHERENT_CACHES */
130 * BUSY-LOOP. Force the reader thread to commit its
131 * rcu_reader_qs_gp update to memory if we wait for too long.
133 while (rcu_gp_ongoing(index
->rcu_reader_qs_gp
) &&
134 (*index
->rcu_reader_qs_gp
- urcu_gp_ctr
< 0)) {
135 if (wait_loops
++ == KICK_READER_LOOPS
) {
136 force_mb_single_thread(index
);
142 #endif /* #else #ifndef HAS_INCOHERENT_CACHES */
146 void synchronize_rcu(void)
150 was_online
= rcu_reader_qs_gp
& 1;
153 * Mark the writer thread offline to make sure we don't wait for
154 * our own quiescent state. This allows using synchronize_rcu() in
155 * threads registered as readers.
158 _rcu_thread_offline();
160 internal_urcu_lock();
161 force_mb_all_threads();
163 wait_for_quiescent_state();
164 force_mb_all_threads();
165 internal_urcu_unlock();
168 _rcu_thread_online();
172 * library wrappers to be used by non-LGPL compatible source code.
175 void rcu_read_lock(void)
180 void rcu_read_unlock(void)
185 void *rcu_dereference(void *p
)
187 return _rcu_dereference(p
);
190 void *rcu_assign_pointer_sym(void **p
, void *v
)
193 return STORE_SHARED(p
, v
);
196 void *rcu_xchg_pointer_sym(void **p
, void *v
)
202 void *rcu_publish_content_sym(void **p
, void *v
)
206 oldptr
= _rcu_xchg_pointer(p
, v
);
211 void rcu_quiescent_state(void)
213 _rcu_quiescent_state();
216 void rcu_thread_offline(void)
218 _rcu_thread_offline();
221 void rcu_thread_online(void)
223 _rcu_thread_online();
226 static void rcu_add_reader(pthread_t id
)
228 struct reader_registry
*oldarray
;
231 alloc_readers
= INIT_NUM_THREADS
;
234 malloc(sizeof(struct reader_registry
) * alloc_readers
);
236 if (alloc_readers
< num_readers
+ 1) {
238 registry
= malloc(sizeof(struct reader_registry
)
239 * (alloc_readers
<< 1));
240 memcpy(registry
, oldarray
,
241 sizeof(struct reader_registry
) * alloc_readers
);
245 registry
[num_readers
].tid
= id
;
246 /* reference to the TLS of _this_ reader thread. */
247 registry
[num_readers
].rcu_reader_qs_gp
= &rcu_reader_qs_gp
;
252 * Never shrink (implementation limitation).
253 * This is O(nb threads). Eventually use a hash table.
255 static void rcu_remove_reader(pthread_t id
)
257 struct reader_registry
*index
;
259 assert(registry
!= NULL
);
260 for (index
= registry
; index
< registry
+ num_readers
; index
++) {
261 if (pthread_equal(index
->tid
, id
)) {
262 memcpy(index
, ®istry
[num_readers
- 1],
263 sizeof(struct reader_registry
));
264 registry
[num_readers
- 1].tid
= 0;
265 registry
[num_readers
- 1].rcu_reader_qs_gp
= NULL
;
270 /* Hrm not found, forgot to register ? */
274 void rcu_register_thread(void)
276 internal_urcu_lock();
277 rcu_add_reader(pthread_self());
278 internal_urcu_unlock();
279 _rcu_thread_online();
282 void rcu_unregister_thread(void)
285 * We have to make the thread offline otherwise we end up dealocking
286 * with a waiting writer.
288 _rcu_thread_offline();
289 internal_urcu_lock();
290 rcu_remove_reader(pthread_self());
291 internal_urcu_unlock();