Commit | Line | Data |
---|---|---|
fdee2e6d MD |
1 | #ifndef _URCU_BP_H |
2 | #define _URCU_BP_H | |
3 | ||
4 | /* | |
5 | * urcu-bp.h | |
6 | * | |
7 | * Userspace RCU header, "bulletproof" version. | |
8 | * | |
9 | * Slower RCU read-side adapted for tracing library. Does not require thread | |
10 | * registration nor unregistration. Also signal-safe. | |
11 | * | |
6982d6d7 | 12 | * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
fdee2e6d MD |
13 | * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. |
14 | * | |
15 | * LGPL-compatible code should include this header with : | |
16 | * | |
17 | * #define _LGPL_SOURCE | |
18 | * #include <urcu.h> | |
19 | * | |
20 | * This library is free software; you can redistribute it and/or | |
21 | * modify it under the terms of the GNU Lesser General Public | |
22 | * License as published by the Free Software Foundation; either | |
23 | * version 2.1 of the License, or (at your option) any later version. | |
24 | * | |
25 | * This library is distributed in the hope that it will be useful, | |
26 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
27 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
28 | * Lesser General Public License for more details. | |
29 | * | |
30 | * You should have received a copy of the GNU Lesser General Public | |
31 | * License along with this library; if not, write to the Free Software | |
32 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
33 | * | |
34 | * IBM's contributions to this file may be relicensed under LGPLv2 or later. | |
35 | */ | |
36 | ||
37 | #include <stdlib.h> | |
38 | #include <pthread.h> | |
39 | ||
36bc70a8 MD |
40 | #ifdef __cplusplus |
41 | extern "C" { | |
42 | #endif | |
43 | ||
ee6fabe1 | 44 | #include <urcu/map/urcu-bp.h> |
5e77fc1f | 45 | |
fdee2e6d MD |
46 | /* |
47 | * Important ! | |
48 | * | |
49 | * Each thread containing read-side critical sections must be registered | |
50 | * with rcu_register_thread() before calling rcu_read_lock(). | |
51 | * rcu_unregister_thread() should be called before the thread exits. | |
52 | */ | |
53 | ||
5efd3cd2 MD |
54 | /* |
55 | * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer | |
56 | * publication headers. | |
57 | */ | |
58 | #include <urcu-pointer.h> | |
59 | ||
fdee2e6d MD |
60 | #ifdef _LGPL_SOURCE |
61 | ||
af7c2dbe | 62 | #include <urcu/static/urcu-bp.h> |
fdee2e6d MD |
63 | |
64 | /* | |
65 | * Mappings for static use of the userspace RCU library. | |
66 | * Should only be used in LGPL-compatible code. | |
67 | */ | |
68 | ||
69 | /* | |
70 | * rcu_read_lock() | |
71 | * rcu_read_unlock() | |
72 | * | |
73 | * Mark the beginning and end of a read-side critical section. | |
74 | */ | |
ef84facf PM |
75 | #define rcu_read_lock_bp _rcu_read_lock |
76 | #define rcu_read_unlock_bp _rcu_read_unlock | |
fdee2e6d | 77 | |
5efd3cd2 MD |
78 | #define rcu_dereference_bp rcu_dereference |
79 | #define rcu_cmpxchg_pointer_bp rcu_cmpxchg_pointer | |
80 | #define rcu_xchg_pointer_bp rcu_xchg_pointer | |
81 | #define rcu_set_pointer_bp rcu_set_pointer | |
82 | ||
fdee2e6d MD |
83 | #else /* !_LGPL_SOURCE */ |
84 | ||
85 | /* | |
86 | * library wrappers to be used by non-LGPL compatible source code. | |
af7c2dbe | 87 | * See LGPL-only urcu/static/urcu-pointer.h for documentation. |
fdee2e6d MD |
88 | */ |
89 | ||
125ea9db MD |
90 | extern void rcu_read_lock(void); |
91 | extern void rcu_read_unlock(void); | |
5efd3cd2 | 92 | |
125ea9db | 93 | extern void *rcu_dereference_sym_bp(void *p); |
5efd3cd2 MD |
94 | #define rcu_dereference_bp(p) \ |
95 | ({ \ | |
96 | typeof(p) _________p1 = URCU_FORCE_CAST(typeof(p), \ | |
97 | rcu_dereference_sym_bp(URCU_FORCE_CAST(void *, p))); \ | |
98 | (_________p1); \ | |
99 | }) | |
100 | ||
125ea9db | 101 | extern void *rcu_cmpxchg_pointer_sym_bp(void **p, void *old, void *_new); |
5efd3cd2 MD |
102 | #define rcu_cmpxchg_pointer_bp(p, old, _new) \ |
103 | ({ \ | |
104 | typeof(*(p)) _________pold = (old); \ | |
105 | typeof(*(p)) _________pnew = (_new); \ | |
106 | typeof(*(p)) _________p1 = URCU_FORCE_CAST(typeof(*(p)), \ | |
107 | rcu_cmpxchg_pointer_sym_bp(URCU_FORCE_CAST(void **, p),\ | |
108 | _________pold, \ | |
109 | _________pnew)); \ | |
110 | (_________p1); \ | |
111 | }) | |
112 | ||
125ea9db | 113 | extern void *rcu_xchg_pointer_sym_bp(void **p, void *v); |
5efd3cd2 MD |
114 | #define rcu_xchg_pointer_bp(p, v) \ |
115 | ({ \ | |
116 | typeof(*(p)) _________pv = (v); \ | |
117 | typeof(*(p)) _________p1 = URCU_FORCE_CAST(typeof(*(p)), \ | |
118 | rcu_xchg_pointer_sym_bp(URCU_FORCE_CAST(void **, p), \ | |
119 | _________pv)); \ | |
120 | (_________p1); \ | |
121 | }) | |
122 | ||
125ea9db | 123 | extern void *rcu_set_pointer_sym_bp(void **p, void *v); |
5efd3cd2 MD |
124 | #define rcu_set_pointer_bp(p, v) \ |
125 | ({ \ | |
126 | typeof(*(p)) _________pv = (v); \ | |
127 | typeof(*(p)) _________p1 = URCU_FORCE_CAST(typeof(*(p)), \ | |
128 | rcu_set_pointer_sym_bp(URCU_FORCE_CAST(void **, p), \ | |
129 | _________pv)); \ | |
130 | (_________p1); \ | |
131 | }) | |
fdee2e6d MD |
132 | |
133 | #endif /* !_LGPL_SOURCE */ | |
134 | ||
135 | extern void synchronize_rcu(void); | |
136 | ||
4cf1675f MD |
137 | /* |
138 | * rcu_bp_before_fork, rcu_bp_after_fork_parent and rcu_bp_after_fork_child | |
139 | * should be called around fork() system calls when the child process is not | |
140 | * expected to immediately perform an exec(). For pthread users, see | |
141 | * pthread_atfork(3). | |
142 | */ | |
143 | extern void rcu_bp_before_fork(void); | |
144 | extern void rcu_bp_after_fork_parent(void); | |
145 | extern void rcu_bp_after_fork_child(void); | |
146 | ||
fdee2e6d MD |
147 | /* |
148 | * In the bulletproof version, the following functions are no-ops. | |
149 | */ | |
150 | static inline void rcu_register_thread(void) | |
151 | { | |
152 | } | |
153 | ||
154 | static inline void rcu_unregister_thread(void) | |
155 | { | |
156 | } | |
157 | ||
02be5561 | 158 | static inline void rcu_init(void) |
fdee2e6d MD |
159 | { |
160 | } | |
161 | ||
765f3ead MD |
162 | /* |
163 | * Q.S. reporting are no-ops for these URCU flavors. | |
164 | */ | |
165 | static inline void rcu_quiescent_state(void) | |
166 | { | |
167 | } | |
168 | ||
169 | static inline void rcu_thread_offline(void) | |
170 | { | |
171 | } | |
172 | ||
173 | static inline void rcu_thread_online(void) | |
174 | { | |
175 | } | |
176 | ||
36bc70a8 MD |
177 | #ifdef __cplusplus |
178 | } | |
179 | #endif | |
180 | ||
ee6fabe1 MD |
181 | #include <urcu-call-rcu.h> |
182 | #include <urcu-defer.h> | |
5e77fc1f | 183 | |
fdee2e6d | 184 | #endif /* _URCU_BP_H */ |