Document rcu_register_thread in README
[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 *
af02d47e
MD
9 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
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
121a5d44 37#ifdef _LGPL_SOURCE
b0d5e790 38
121a5d44 39#include <urcu-static.h>
3a86deba
MD
40
41/*
121a5d44
MD
42 * Mappings for static use of the userspace RCU library.
43 * Should only be used in LGPL-compatible code.
3a86deba 44 */
3a86deba 45
121a5d44
MD
46#define rcu_dereference _rcu_dereference
47#define rcu_read_lock _rcu_read_lock
48#define rcu_read_unlock _rcu_read_unlock
41718ff9 49
121a5d44
MD
50#define rcu_assign_pointer _rcu_assign_pointer
51#define rcu_xchg_pointer _rcu_xchg_pointer
52#define rcu_publish_content _rcu_publish_content
41718ff9 53
121a5d44 54#else /* !_LGPL_SOURCE */
27b012e2 55
40e140c9 56/*
121a5d44 57 * library wrappers to be used by non-LGPL compatible source code.
40e140c9 58 */
cf380c2f 59
121a5d44
MD
60extern void rcu_read_lock(void);
61extern void rcu_read_unlock(void);
cf380c2f 62
121a5d44 63extern void *rcu_dereference(void *p);
bb488185 64
121a5d44 65extern void *rcu_assign_pointer_sym(void **p, void *v);
cf380c2f 66
121a5d44
MD
67#define rcu_assign_pointer(p, v) \
68 rcu_assign_pointer_sym((void **)(p), (v))
cf380c2f 69
121a5d44
MD
70extern void *rcu_xchg_pointer_sym(void **p, void *v);
71#define rcu_xchg_pointer(p, v) \
72 rcu_xchg_pointer_sym((void **)(p), (v))
9d335088 73
121a5d44
MD
74extern void *rcu_publish_content_sym(void **p, void *v);
75#define rcu_publish_content(p, v) \
76 rcu_publish_content_sym((void **)(p), (v))
cf380c2f 77
121a5d44 78#endif /* !_LGPL_SOURCE */
f4a486ac 79
e462817e 80extern void synchronize_rcu(void);
27b012e2
MD
81
82/*
83 * Reader thread registration.
84 */
121a5d44
MD
85extern void rcu_register_thread(void);
86extern void rcu_unregister_thread(void);
27b012e2
MD
87
88#endif /* _URCU_H */
This page took 0.036169 seconds and 4 git commands to generate.