Install urcu/map/*.h into system
[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
MD
37/*
38 * See urcu-pointer.h and urcu-pointer-static.h for pointer publication headers.
39 */
40#include <urcu-pointer.h>
41
36bc70a8
MD
42#ifdef __cplusplus
43extern "C" {
44#endif
45
57760d44 46#include "urcu/map/urcu.h"
5e77fc1f 47
92b752ee
MD
48/*
49 * Important !
50 *
51 * Each thread containing read-side critical sections must be registered
5e77fc1f
PM
52 * with rcu_register_thread_mb() before calling rcu_read_lock_mb().
53 * rcu_unregister_thread_mb() should be called before the thread exits.
92b752ee
MD
54 */
55
121a5d44 56#ifdef _LGPL_SOURCE
b0d5e790 57
121a5d44 58#include <urcu-static.h>
3a86deba
MD
59
60/*
121a5d44
MD
61 * Mappings for static use of the userspace RCU library.
62 * Should only be used in LGPL-compatible code.
3a86deba 63 */
3a86deba 64
7e30abe3
MD
65/*
66 * rcu_read_lock()
67 * rcu_read_unlock()
68 *
69 * Mark the beginning and end of a read-side critical section.
70 * DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH
71 * READ-SIDE CRITICAL SECTION.
72 */
5e77fc1f 73#ifdef RCU_MEMBARRIER
ef84facf
PM
74#define rcu_read_lock_memb _rcu_read_lock
75#define rcu_read_unlock_memb _rcu_read_unlock
5e77fc1f 76#elif defined(RCU_SIGNAL)
ef84facf
PM
77#define rcu_read_lock_sig _rcu_read_lock
78#define rcu_read_unlock_sig _rcu_read_unlock
5e77fc1f 79#elif defined(RCU_MB)
ef84facf
PM
80#define rcu_read_lock_mb _rcu_read_lock
81#define rcu_read_unlock_mb _rcu_read_unlock
5e77fc1f 82#endif
41718ff9 83
121a5d44 84#else /* !_LGPL_SOURCE */
27b012e2 85
40e140c9 86/*
121a5d44 87 * library wrappers to be used by non-LGPL compatible source code.
7e30abe3 88 * See LGPL-only urcu-pointer-static.h for documentation.
40e140c9 89 */
cf380c2f 90
121a5d44
MD
91extern void rcu_read_lock(void);
92extern void rcu_read_unlock(void);
cf380c2f 93
121a5d44 94#endif /* !_LGPL_SOURCE */
f4a486ac 95
e462817e 96extern void synchronize_rcu(void);
27b012e2
MD
97
98/*
99 * Reader thread registration.
100 */
121a5d44
MD
101extern void rcu_register_thread(void);
102extern void rcu_unregister_thread(void);
27b012e2 103
e95f4e7f 104/*
02be5561 105 * Explicit rcu initialization, for "early" use within library constructors.
e95f4e7f 106 */
02be5561 107extern void rcu_init(void);
e95f4e7f 108
36bc70a8
MD
109#ifdef __cplusplus
110}
111#endif
112
5e77fc1f 113#include "urcu-call-rcu.h"
0376e7b2 114#include "urcu-defer.h"
5e77fc1f 115
27b012e2 116#endif /* _URCU_H */
This page took 0.048026 seconds and 4 git commands to generate.