Update README (again)
[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
MD
33
34/*
7ac06cef 35 * Important !
420e5b92 36 *
7ac06cef
MD
37 * Each thread containing read-side critical sections must be registered
38 * with rcu_register_thread() before calling rcu_read_lock().
39 * rcu_unregister_thread() should be called before the thread exits.
420e5b92
MD
40 */
41
7ac06cef 42#ifdef _LGPL_SOURCE
420e5b92 43
7ac06cef 44#include <urcu-qsbr-static.h>
420e5b92
MD
45
46/*
7ac06cef
MD
47 * Mappings for static use of the userspace RCU library.
48 * Should only be used in LGPL-compatible code.
420e5b92 49 */
420e5b92 50
7ac06cef
MD
51#define rcu_dereference _rcu_dereference
52#define rcu_read_lock _rcu_read_lock
53#define rcu_read_unlock _rcu_read_unlock
fb6e510b 54
7ac06cef
MD
55#define rcu_quiescent_state _rcu_quiescent_state
56#define rcu_thread_offline _rcu_thread_offline
57#define rcu_thread_online _rcu_thread_online
420e5b92 58
7ac06cef
MD
59#define rcu_assign_pointer _rcu_assign_pointer
60#define rcu_xchg_pointer _rcu_xchg_pointer
61#define rcu_publish_content _rcu_publish_content
420e5b92 62
7ac06cef 63#else /* !_LGPL_SOURCE */
420e5b92 64
420e5b92 65/*
7ac06cef 66 * library wrappers to be used by non-LGPL compatible source code.
420e5b92 67 */
420e5b92 68
7ac06cef
MD
69extern void rcu_read_lock(void);
70extern void rcu_read_unlock(void);
420e5b92 71
7ac06cef 72extern void *rcu_dereference(void *p);
420e5b92 73
7ac06cef
MD
74extern void rcu_quiescent_state(void);
75extern void rcu_thread_offline(void);
76extern void rcu_thread_online(void);
420e5b92 77
7ac06cef 78extern void *rcu_assign_pointer_sym(void **p, void *v);
420e5b92 79
7ac06cef
MD
80#define rcu_assign_pointer(p, v) \
81 rcu_assign_pointer_sym((void **)(p), (v))
420e5b92 82
7ac06cef
MD
83extern void *rcu_xchg_pointer_sym(void **p, void *v);
84#define rcu_xchg_pointer(p, v) \
85 rcu_xchg_pointer_sym((void **)(p), (v))
420e5b92 86
7ac06cef
MD
87extern void *rcu_publish_content_sym(void **p, void *v);
88#define rcu_publish_content(p, v) \
89 rcu_publish_content_sym((void **)(p), (v))
420e5b92 90
7ac06cef 91#endif /* !_LGPL_SOURCE */
420e5b92
MD
92
93extern void synchronize_rcu(void);
94
95/*
96 * Reader thread registration.
97 */
98extern void rcu_register_thread(void);
99extern void rcu_unregister_thread(void);
100
101#endif /* _URCU_QSBR_H */
This page took 0.037774 seconds and 4 git commands to generate.