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