Add rcu_flavor
[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" {
42#endif
43
ee6fabe1 44#include <urcu/map/urcu-qsbr.h>
5e77fc1f 45
420e5b92 46/*
7ac06cef 47 * Important !
420e5b92 48 *
7ac06cef
MD
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.
420e5b92
MD
52 */
53
7ac06cef 54#ifdef _LGPL_SOURCE
420e5b92 55
af7c2dbe 56#include <urcu/static/urcu-qsbr.h>
420e5b92
MD
57
58/*
7ac06cef
MD
59 * Mappings for static use of the userspace RCU library.
60 * Should only be used in LGPL-compatible code.
420e5b92 61 */
420e5b92 62
7e30abe3
MD
63/*
64 * rcu_read_lock()
65 * rcu_read_unlock()
66 *
67 * Mark the beginning and end of a read-side critical section.
5e77fc1f
PM
68 * DON'T FORGET TO USE rcu_register_thread/rcu_unregister_thread()
69 * FOR EACH THREAD WITH READ-SIDE CRITICAL SECTION.
7e30abe3 70 */
ef84facf
PM
71#define rcu_read_lock_qsbr _rcu_read_lock
72#define rcu_read_unlock_qsbr _rcu_read_unlock
420e5b92 73
ef84facf
PM
74#define rcu_quiescent_state_qsbr _rcu_quiescent_state
75#define rcu_thread_offline_qsbr _rcu_thread_offline
76#define rcu_thread_online_qsbr _rcu_thread_online
420e5b92 77
7ac06cef 78#else /* !_LGPL_SOURCE */
420e5b92 79
420e5b92 80/*
7ac06cef 81 * library wrappers to be used by non-LGPL compatible source code.
420e5b92 82 */
420e5b92 83
727f819d
MD
84/*
85 * QSBR read lock/unlock are guaranteed to be no-ops. Therefore, we expose them
86 * in the LGPL header for any code to use. However, the debug version is not
87 * nops and may contain sanity checks. To activate it, applications must be
02be5561 88 * recompiled with -DRCU_DEBUG (even non-LGPL/GPL applications). This is the
727f819d
MD
89 * best trade-off between license/performance/code triviality and
90 * library debugging & tracing features we could come up with.
91 */
92
02be5561 93#if (!defined(BUILD_QSBR_LIB) && defined(RCU_DEBUG))
727f819d
MD
94
95static inline void rcu_read_lock(void)
96{
97}
98
d9ce338d 99static inline void rcu_read_unlock(void)
727f819d
MD
100{
101}
102
02be5561 103#else /* !RCU_DEBUG */
727f819d 104
7ac06cef
MD
105extern void rcu_read_lock(void);
106extern void rcu_read_unlock(void);
420e5b92 107
02be5561 108#endif /* !RCU_DEBUG */
727f819d 109
7ac06cef
MD
110extern void rcu_quiescent_state(void);
111extern void rcu_thread_offline(void);
112extern void rcu_thread_online(void);
420e5b92 113
7ac06cef 114#endif /* !_LGPL_SOURCE */
420e5b92
MD
115
116extern void synchronize_rcu(void);
117
118/*
119 * Reader thread registration.
120 */
121extern void rcu_register_thread(void);
122extern void rcu_unregister_thread(void);
123
36bc70a8
MD
124#ifdef __cplusplus
125}
126#endif
127
ee6fabe1
MD
128#include <urcu-call-rcu.h>
129#include <urcu-defer.h>
541d828d 130#include <urcu-flavor.h>
5e77fc1f 131
420e5b92 132#endif /* _URCU_QSBR_H */
This page took 0.043777 seconds and 4 git commands to generate.