Fix: tests: invoke destroy APIs for queues/stacks
[urcu.git] / urcu.h
CommitLineData
27b012e2
MD
1#ifndef _URCU_H
2#define _URCU_H
3
b257a10b
MD
4/*
5 * urcu.h
6 *
7 * Userspace RCU header
8 *
6982d6d7 9 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
af02d47e 10 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
5e7e64b9 11 *
121a5d44 12 * LGPL-compatible code should include this header with :
5e7e64b9 13 *
121a5d44
MD
14 * #define _LGPL_SOURCE
15 * #include <urcu.h>
16 *
af02d47e
MD
17 * This library is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU Lesser General Public
19 * License as published by the Free Software Foundation; either
20 * version 2.1 of the License, or (at your option) any later version.
21 *
22 * This library is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 * Lesser General Public License for more details.
26 *
27 * You should have received a copy of the GNU Lesser General Public
28 * License along with this library; if not, write to the Free Software
29 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
54843abc
PM
30 *
31 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
b257a10b
MD
32 */
33
1430ee0b 34#include <stdlib.h>
69a757c9 35#include <pthread.h>
1430ee0b 36
7e30abe3 37/*
af7c2dbe
MD
38 * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
39 * publication headers.
7e30abe3
MD
40 */
41#include <urcu-pointer.h>
42
36bc70a8
MD
43#ifdef __cplusplus
44extern "C" {
67ecffc0 45#endif
36bc70a8 46
ee6fabe1 47#include <urcu/map/urcu.h>
5e77fc1f 48
92b752ee
MD
49/*
50 * Important !
51 *
52 * Each thread containing read-side critical sections must be registered
5e77fc1f
PM
53 * with rcu_register_thread_mb() before calling rcu_read_lock_mb().
54 * rcu_unregister_thread_mb() should be called before the thread exits.
92b752ee
MD
55 */
56
121a5d44 57#ifdef _LGPL_SOURCE
b0d5e790 58
af7c2dbe 59#include <urcu/static/urcu.h>
3a86deba
MD
60
61/*
121a5d44
MD
62 * Mappings for static use of the userspace RCU library.
63 * Should only be used in LGPL-compatible code.
3a86deba 64 */
3a86deba 65
7e30abe3
MD
66/*
67 * rcu_read_lock()
68 * rcu_read_unlock()
69 *
70 * Mark the beginning and end of a read-side critical section.
71 * DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH
72 * READ-SIDE CRITICAL SECTION.
73 */
5e77fc1f 74#ifdef RCU_MEMBARRIER
ef84facf
PM
75#define rcu_read_lock_memb _rcu_read_lock
76#define rcu_read_unlock_memb _rcu_read_unlock
882f3357 77#define rcu_read_ongoing_memb _rcu_read_ongoing
5e77fc1f 78#elif defined(RCU_SIGNAL)
ef84facf
PM
79#define rcu_read_lock_sig _rcu_read_lock
80#define rcu_read_unlock_sig _rcu_read_unlock
882f3357 81#define rcu_read_ongoing_sig _rcu_read_ongoing
5e77fc1f 82#elif defined(RCU_MB)
ef84facf
PM
83#define rcu_read_lock_mb _rcu_read_lock
84#define rcu_read_unlock_mb _rcu_read_unlock
882f3357 85#define rcu_read_ongoing_mb _rcu_read_ongoing
5e77fc1f 86#endif
41718ff9 87
121a5d44 88#else /* !_LGPL_SOURCE */
27b012e2 89
40e140c9 90/*
121a5d44 91 * library wrappers to be used by non-LGPL compatible source code.
af7c2dbe 92 * See LGPL-only urcu/static/urcu-pointer.h for documentation.
40e140c9 93 */
cf380c2f 94
121a5d44
MD
95extern void rcu_read_lock(void);
96extern void rcu_read_unlock(void);
882f3357 97extern int rcu_read_ongoing(void);
cf380c2f 98
121a5d44 99#endif /* !_LGPL_SOURCE */
f4a486ac 100
e462817e 101extern void synchronize_rcu(void);
27b012e2
MD
102
103/*
104 * Reader thread registration.
105 */
121a5d44
MD
106extern void rcu_register_thread(void);
107extern void rcu_unregister_thread(void);
27b012e2 108
e95f4e7f 109/*
02be5561 110 * Explicit rcu initialization, for "early" use within library constructors.
e95f4e7f 111 */
02be5561 112extern void rcu_init(void);
e95f4e7f 113
51b03c6f
MD
114/*
115 * Q.S. reporting are no-ops for these URCU flavors.
116 */
117static inline void rcu_quiescent_state(void)
118{
119}
120
121static inline void rcu_thread_offline(void)
122{
123}
124
125static inline void rcu_thread_online(void)
126{
127}
128
67ecffc0 129#ifdef __cplusplus
36bc70a8
MD
130}
131#endif
132
ee6fabe1
MD
133#include <urcu-call-rcu.h>
134#include <urcu-defer.h>
541d828d 135#include <urcu-flavor.h>
5e77fc1f 136
27b012e2 137#endif /* _URCU_H */
This page took 0.059508 seconds and 4 git commands to generate.