Add rcu_read_ongoing() API to each urcu flavor
[urcu.git] / urcu / map / urcu.h
CommitLineData
5e77fc1f
PM
1#ifndef _URCU_MAP_H
2#define _URCU_MAP_H
3
4/*
5 * urcu-map.h
6 *
7 * Userspace RCU header -- name mapping to allow multiple flavors to be
8 * used in the same executable.
9 *
10 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
12 *
13 * LGPL-compatible code should include this header with :
14 *
15 * #define _LGPL_SOURCE
16 * #include <urcu.h>
17 *
18 * This library is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU Lesser General Public
20 * License as published by the Free Software Foundation; either
21 * version 2.1 of the License, or (at your option) any later version.
22 *
23 * This library is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26 * Lesser General Public License for more details.
27 *
28 * You should have received a copy of the GNU Lesser General Public
29 * License along with this library; if not, write to the Free Software
30 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31 *
32 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
33 */
34
35/* Mapping macros to allow multiple flavors in a single binary. */
36
0376e7b2 37#if !defined(RCU_MEMBARRIER) && !defined(RCU_SIGNAL) && !defined(RCU_MB)
052fdaee 38#define RCU_MEMBARRIER
0376e7b2
PM
39#endif
40
4a0b347a
MD
41/*
42 * RCU_MEMBARRIER is only possibly available on Linux. Fallback to
43 * RCU_MB
44 * otherwise.
45 */
46#if !defined(__linux__) && defined(RCU_MEMBARRIER)
47#undef RCU_MEMBARRIER
48#define RCU_MB
49#endif
50
51#ifdef RCU_MEMBARRIER
52#include <syscall.h>
53
54/* If the headers do not support SYS_membarrier, statically use RCU_MB */
55#ifdef SYS_membarrier
56# define MEMBARRIER_EXPEDITED (1 << 0)
57# define MEMBARRIER_DELAYED (1 << 1)
58# define MEMBARRIER_QUERY (1 << 16)
59# define membarrier(...) syscall(SYS_membarrier, __VA_ARGS__)
60#else
61# undef RCU_MEMBARRIER
62# define RCU_MB
63#endif
64#endif
65
5e77fc1f
PM
66#ifdef RCU_MEMBARRIER
67
68#define rcu_read_lock rcu_read_lock_memb
69#define _rcu_read_lock _rcu_read_lock_memb
70#define rcu_read_unlock rcu_read_unlock_memb
71#define _rcu_read_unlock _rcu_read_unlock_memb
882f3357
MD
72#define rcu_read_ongoing rcu_read_ongoing_memb
73#define _rcu_read_ongoing _rcu_read_ongoing_memb
5e77fc1f
PM
74#define rcu_register_thread rcu_register_thread_memb
75#define rcu_unregister_thread rcu_unregister_thread_memb
76#define rcu_init rcu_init_memb
77#define rcu_exit rcu_exit_memb
78#define synchronize_rcu synchronize_rcu_memb
79#define rcu_reader rcu_reader_memb
80#define rcu_gp_ctr rcu_gp_ctr_memb
1de4df4b 81#define rcu_gp_futex rcu_gp_futex_memb
5e77fc1f
PM
82
83#define get_cpu_call_rcu_data get_cpu_call_rcu_data_memb
84#define get_call_rcu_thread get_call_rcu_thread_memb
85#define create_call_rcu_data create_call_rcu_data_memb
86#define set_cpu_call_rcu_data set_cpu_call_rcu_data_memb
87#define get_default_call_rcu_data get_default_call_rcu_data_memb
88#define get_call_rcu_data get_call_rcu_data_memb
89#define get_thread_call_rcu_data get_thread_call_rcu_data_memb
90#define set_thread_call_rcu_data set_thread_call_rcu_data_memb
91#define create_all_cpu_call_rcu_data create_all_cpu_call_rcu_data_memb
92#define free_all_cpu_call_rcu_data free_all_cpu_call_rcu_data_memb
93#define call_rcu call_rcu_memb
1de4df4b
MD
94#define call_rcu_data_free call_rcu_data_free_memb
95#define call_rcu_before_fork call_rcu_before_fork_memb
96#define call_rcu_after_fork_parent call_rcu_after_fork_parent_memb
97#define call_rcu_after_fork_child call_rcu_after_fork_child_memb
5e77fc1f 98
0376e7b2
PM
99#define defer_rcu defer_rcu_memb
100#define rcu_defer_register_thread rcu_defer_register_thread_memb
101#define rcu_defer_unregister_thread rcu_defer_unregister_thread_memb
102#define rcu_defer_barrier rcu_defer_barrier_memb
103#define rcu_defer_barrier_thread rcu_defer_barrier_thread_memb
1de4df4b 104#define rcu_defer_exit rcu_defer_exit_memb
0376e7b2 105
541d828d
LJ
106#define rcu_flavor rcu_flavor_memb
107
1de4df4b
MD
108#define rcu_yield_active rcu_yield_active_memb
109#define rcu_rand_yield rcu_rand_yield_memb
110
111/* Specific to MEMBARRIER flavor */
112#define rcu_has_sys_membarrier rcu_has_sys_membarrier_memb
113
5e77fc1f
PM
114#elif defined(RCU_SIGNAL)
115
116#define rcu_read_lock rcu_read_lock_sig
117#define _rcu_read_lock _rcu_read_lock_sig
118#define rcu_read_unlock rcu_read_unlock_sig
119#define _rcu_read_unlock _rcu_read_unlock_sig
882f3357
MD
120#define rcu_read_ongoing rcu_read_ongoing_sig
121#define _rcu_read_ongoing _rcu_read_ongoing_sig
5e77fc1f
PM
122#define rcu_register_thread rcu_register_thread_sig
123#define rcu_unregister_thread rcu_unregister_thread_sig
124#define rcu_init rcu_init_sig
125#define rcu_exit rcu_exit_sig
126#define synchronize_rcu synchronize_rcu_sig
127#define rcu_reader rcu_reader_sig
128#define rcu_gp_ctr rcu_gp_ctr_sig
1de4df4b 129#define rcu_gp_futex rcu_gp_futex_sig
5e77fc1f
PM
130
131#define get_cpu_call_rcu_data get_cpu_call_rcu_data_sig
132#define get_call_rcu_thread get_call_rcu_thread_sig
133#define create_call_rcu_data create_call_rcu_data_sig
134#define set_cpu_call_rcu_data set_cpu_call_rcu_data_sig
135#define get_default_call_rcu_data get_default_call_rcu_data_sig
136#define get_call_rcu_data get_call_rcu_data_sig
137#define get_thread_call_rcu_data get_thread_call_rcu_data_sig
138#define set_thread_call_rcu_data set_thread_call_rcu_data_sig
139#define create_all_cpu_call_rcu_data create_all_cpu_call_rcu_data_sig
140#define free_all_cpu_call_rcu_data free_all_cpu_call_rcu_data_sig
141#define call_rcu call_rcu_sig
1de4df4b
MD
142#define call_rcu_data_free call_rcu_data_free_sig
143#define call_rcu_before_fork call_rcu_before_fork_sig
144#define call_rcu_after_fork_parent call_rcu_after_fork_parent_sig
145#define call_rcu_after_fork_child call_rcu_after_fork_child_sig
5e77fc1f 146
0376e7b2
PM
147#define defer_rcu defer_rcu_sig
148#define rcu_defer_register_thread rcu_defer_register_thread_sig
149#define rcu_defer_unregister_thread rcu_defer_unregister_thread_sig
150#define rcu_defer_barrier rcu_defer_barrier_sig
151#define rcu_defer_barrier_thread rcu_defer_barrier_thread_sig
1de4df4b 152#define rcu_defer_exit rcu_defer_exit_sig
0376e7b2 153
541d828d
LJ
154#define rcu_flavor rcu_flavor_sig
155
1de4df4b
MD
156#define rcu_yield_active rcu_yield_active_sig
157#define rcu_rand_yield rcu_rand_yield_sig
158
5e77fc1f
PM
159#elif defined(RCU_MB)
160
161#define rcu_read_lock rcu_read_lock_mb
162#define _rcu_read_lock _rcu_read_lock_mb
163#define rcu_read_unlock rcu_read_unlock_mb
164#define _rcu_read_unlock _rcu_read_unlock_mb
882f3357
MD
165#define rcu_read_ongoing rcu_read_ongoing_mb
166#define _rcu_read_ongoing _rcu_read_ongoing_mb
5e77fc1f
PM
167#define rcu_register_thread rcu_register_thread_mb
168#define rcu_unregister_thread rcu_unregister_thread_mb
169#define rcu_init rcu_init_mb
170#define rcu_exit rcu_exit_mb
171#define synchronize_rcu synchronize_rcu_mb
172#define rcu_reader rcu_reader_mb
173#define rcu_gp_ctr rcu_gp_ctr_mb
1de4df4b 174#define rcu_gp_futex rcu_gp_futex_mb
5e77fc1f
PM
175
176#define get_cpu_call_rcu_data get_cpu_call_rcu_data_mb
177#define get_call_rcu_thread get_call_rcu_thread_mb
178#define create_call_rcu_data create_call_rcu_data_mb
179#define set_cpu_call_rcu_data set_cpu_call_rcu_data_mb
180#define get_default_call_rcu_data get_default_call_rcu_data_mb
181#define get_call_rcu_data get_call_rcu_data_mb
182#define get_thread_call_rcu_data get_thread_call_rcu_data_mb
183#define set_thread_call_rcu_data set_thread_call_rcu_data_mb
184#define create_all_cpu_call_rcu_data create_all_cpu_call_rcu_data_mb
185#define free_all_cpu_call_rcu_data free_all_cpu_call_rcu_data_mb
186#define call_rcu call_rcu_mb
1de4df4b
MD
187#define call_rcu_data_free call_rcu_data_free_mb
188#define call_rcu_before_fork call_rcu_before_fork_mb
189#define call_rcu_after_fork_parent call_rcu_after_fork_parent_mb
190#define call_rcu_after_fork_child call_rcu_after_fork_child_mb
5e77fc1f 191
0376e7b2
PM
192#define defer_rcu defer_rcu_mb
193#define rcu_defer_register_thread rcu_defer_register_thread_mb
194#define rcu_defer_unregister_thread rcu_defer_unregister_thread_mb
195#define rcu_defer_barrier rcu_defer_barrier_mb
196#define rcu_defer_barrier_thread rcu_defer_barrier_thread_mb
1de4df4b 197#define rcu_defer_exit rcu_defer_exit_mb
0376e7b2 198
541d828d
LJ
199#define rcu_flavor rcu_flavor_mb
200
1de4df4b
MD
201#define rcu_yield_active rcu_yield_active_mb
202#define rcu_rand_yield rcu_rand_yield_mb
203
0376e7b2
PM
204#else
205
206#error "Undefined selection"
207
5e77fc1f
PM
208#endif
209
210#endif /* _URCU_MAP_H */
This page took 0.048448 seconds and 4 git commands to generate.