Add rcu-reclaim.so library
[urcu.git] / urcu-reclaim.h
CommitLineData
90075a50
MD
1#ifndef _URCU_RECLAIM_H
2#define _URCU_RECLAIM_H
3
4/*
5 * urcu-reclaim.h
6 *
7 * Userspace RCU header - memory reclamation
8 *
9 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
10 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
11 *
12 * LGPL-compatible code should include this header with :
13 *
14 * #define _LGPL_SOURCE
15 * #include <urcu-reclaim.h>
16 *
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
30 */
31
32#include <stdlib.h>
33#include <pthread.h>
34
35/*
36 * Important !
37 *
38 * Each thread queuing memory reclamation must be registered with
39 * rcu_reclaim_register_thread(). rcu_reclaim_unregister_thread() should be
40 * called before the thread exits.
41 */
42
43#ifdef _LGPL_SOURCE
44
45#include <urcu-reclaim-static.h>
46
47/*
48 * Mappings for static use of the userspace RCU library.
49 * Should only be used in LGPL-compatible code.
50 */
51
52#define rcu_reclaim_queue _rcu_reclaim_queue
53
54#else /* !_LGPL_SOURCE */
55
56/*
57 * library wrappers to be used by non-LGPL compatible source code.
58 */
59
60extern void rcu_reclaim_queue(void *p);
61
62#endif /* !_LGPL_SOURCE */
63
64/*
65 * Thread registration for reclamation.
66 */
67extern void rcu_reclaim_register_thread(void);
68extern void rcu_reclaim_unregister_thread(void);
69extern void rcu_reclaim_barrier(void);
70extern void rcu_reclaim_barrier_thread(void);
71
72#endif /* _URCU_RECLAIM_H */
This page took 0.033377 seconds and 4 git commands to generate.