Fix: update ax_pthread macro to handle newer clang
[urcu.git] / urcu-qsbr.h
CommitLineData
420e5b92
MD
1#ifndef _URCU_QSBR_H
2#define _URCU_QSBR_H
3
4/*
7ac06cef 5 * urcu-qsbr.h
420e5b92 6 *
7ac06cef 7 * Userspace RCU QSBR header.
420e5b92 8 *
7ac06cef 9 * LGPL-compatible code should include this header with :
420e5b92 10 *
7ac06cef
MD
11 * #define _LGPL_SOURCE
12 * #include <urcu.h>
420e5b92
MD
13 *
14 * This library is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Lesser General Public
16 * License as published by the Free Software Foundation; either
17 * version 2.1 of the License, or (at your option) any later version.
18 *
19 * This library is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * Lesser General Public License for more details.
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 *
28 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
29 */
30
31#include <stdlib.h>
32#include <pthread.h>
420e5b92 33
7e30abe3 34/*
af7c2dbe
MD
35 * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
36 * publication headers.
7e30abe3
MD
37 */
38#include <urcu-pointer.h>
39
36bc70a8
MD
40#ifdef __cplusplus
41extern "C" {
67ecffc0 42#endif
36bc70a8 43
ee6fabe1 44#include <urcu/map/urcu-qsbr.h>
5e77fc1f 45
14740b19
MD
46#ifdef RCU_DEBUG /* For backward compatibility */
47#define DEBUG_RCU
48#endif
49
420e5b92 50/*
7ac06cef 51 * Important !
420e5b92 52 *
7ac06cef
MD
53 * Each thread containing read-side critical sections must be registered
54 * with rcu_register_thread() before calling rcu_read_lock().
55 * rcu_unregister_thread() should be called before the thread exits.
420e5b92
MD
56 */
57
7ac06cef 58#ifdef _LGPL_SOURCE
420e5b92 59
af7c2dbe 60#include <urcu/static/urcu-qsbr.h>
420e5b92
MD
61
62/*
7ac06cef
MD
63 * Mappings for static use of the userspace RCU library.
64 * Should only be used in LGPL-compatible code.
420e5b92 65 */
420e5b92 66
7e30abe3
MD
67/*
68 * rcu_read_lock()
69 * rcu_read_unlock()
70 *
71 * Mark the beginning and end of a read-side critical section.
5e77fc1f
PM
72 * DON'T FORGET TO USE rcu_register_thread/rcu_unregister_thread()
73 * FOR EACH THREAD WITH READ-SIDE CRITICAL SECTION.
7e30abe3 74 */
ef84facf
PM
75#define rcu_read_lock_qsbr _rcu_read_lock
76#define rcu_read_unlock_qsbr _rcu_read_unlock
882f3357 77#define rcu_read_ongoing_qsbr _rcu_read_ongoing
420e5b92 78
ef84facf
PM
79#define rcu_quiescent_state_qsbr _rcu_quiescent_state
80#define rcu_thread_offline_qsbr _rcu_thread_offline
81#define rcu_thread_online_qsbr _rcu_thread_online
420e5b92 82
7ac06cef 83#else /* !_LGPL_SOURCE */
420e5b92 84
420e5b92 85/*
7ac06cef 86 * library wrappers to be used by non-LGPL compatible source code.
420e5b92 87 */
420e5b92 88
727f819d
MD
89/*
90 * QSBR read lock/unlock are guaranteed to be no-ops. Therefore, we expose them
91 * in the LGPL header for any code to use. However, the debug version is not
92 * nops and may contain sanity checks. To activate it, applications must be
14740b19 93 * recompiled with -DDEBUG_RCU (even non-LGPL/GPL applications). This is the
727f819d
MD
94 * best trade-off between license/performance/code triviality and
95 * library debugging & tracing features we could come up with.
96 */
97
14740b19 98#if (!defined(BUILD_QSBR_LIB) && !defined(DEBUG_RCU))
727f819d
MD
99
100static inline void rcu_read_lock(void)
101{
102}
103
d9ce338d 104static inline void rcu_read_unlock(void)
727f819d
MD
105{
106}
107
14740b19 108#else /* !DEBUG_RCU */
727f819d 109
7ac06cef
MD
110extern void rcu_read_lock(void);
111extern void rcu_read_unlock(void);
420e5b92 112
14740b19 113#endif /* !DEBUG_RCU */
727f819d 114
882f3357 115extern int rcu_read_ongoing(void);
7ac06cef
MD
116extern void rcu_quiescent_state(void);
117extern void rcu_thread_offline(void);
118extern void rcu_thread_online(void);
420e5b92 119
7ac06cef 120#endif /* !_LGPL_SOURCE */
420e5b92
MD
121
122extern void synchronize_rcu(void);
123
124/*
125 * Reader thread registration.
126 */
127extern void rcu_register_thread(void);
128extern void rcu_unregister_thread(void);
129
67ecffc0 130#ifdef __cplusplus
36bc70a8
MD
131}
132#endif
133
ee6fabe1
MD
134#include <urcu-call-rcu.h>
135#include <urcu-defer.h>
541d828d 136#include <urcu-flavor.h>
5e77fc1f 137
420e5b92 138#endif /* _URCU_QSBR_H */
This page took 0.069379 seconds and 4 git commands to generate.