Install urcu/map/*.h into system
[urcu.git] / urcu-bp.h
CommitLineData
fdee2e6d
MD
1#ifndef _URCU_BP_H
2#define _URCU_BP_H
3
4/*
5 * urcu-bp.h
6 *
7 * Userspace RCU header, "bulletproof" version.
8 *
9 * Slower RCU read-side adapted for tracing library. Does not require thread
10 * registration nor unregistration. Also signal-safe.
11 *
6982d6d7 12 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fdee2e6d
MD
13 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
14 *
15 * LGPL-compatible code should include this header with :
16 *
17 * #define _LGPL_SOURCE
18 * #include <urcu.h>
19 *
20 * This library is free software; you can redistribute it and/or
21 * modify it under the terms of the GNU Lesser General Public
22 * License as published by the Free Software Foundation; either
23 * version 2.1 of the License, or (at your option) any later version.
24 *
25 * This library is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
28 * Lesser General Public License for more details.
29 *
30 * You should have received a copy of the GNU Lesser General Public
31 * License along with this library; if not, write to the Free Software
32 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
33 *
34 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
35 */
36
37#include <stdlib.h>
38#include <pthread.h>
39
40/*
41 * See urcu-pointer.h and urcu-pointer-static.h for pointer publication headers.
42 */
43#include <urcu-pointer.h>
44
36bc70a8
MD
45#ifdef __cplusplus
46extern "C" {
47#endif
48
57760d44 49#include "urcu/map/urcu-bp.h"
5e77fc1f 50
fdee2e6d
MD
51/*
52 * Important !
53 *
54 * Each thread containing read-side critical sections must be registered
55 * with rcu_register_thread() before calling rcu_read_lock().
56 * rcu_unregister_thread() should be called before the thread exits.
57 */
58
59#ifdef _LGPL_SOURCE
60
61#include <urcu-bp-static.h>
62
63/*
64 * Mappings for static use of the userspace RCU library.
65 * Should only be used in LGPL-compatible code.
66 */
67
68/*
69 * rcu_read_lock()
70 * rcu_read_unlock()
71 *
72 * Mark the beginning and end of a read-side critical section.
73 */
ef84facf
PM
74#define rcu_read_lock_bp _rcu_read_lock
75#define rcu_read_unlock_bp _rcu_read_unlock
fdee2e6d
MD
76
77#else /* !_LGPL_SOURCE */
78
79/*
80 * library wrappers to be used by non-LGPL compatible source code.
81 * See LGPL-only urcu-pointer-static.h for documentation.
82 */
83
84extern void rcu_read_lock(void);
85extern void rcu_read_unlock(void);
86
87#endif /* !_LGPL_SOURCE */
88
89extern void synchronize_rcu(void);
90
4cf1675f
MD
91/*
92 * rcu_bp_before_fork, rcu_bp_after_fork_parent and rcu_bp_after_fork_child
93 * should be called around fork() system calls when the child process is not
94 * expected to immediately perform an exec(). For pthread users, see
95 * pthread_atfork(3).
96 */
97extern void rcu_bp_before_fork(void);
98extern void rcu_bp_after_fork_parent(void);
99extern void rcu_bp_after_fork_child(void);
100
fdee2e6d
MD
101/*
102 * In the bulletproof version, the following functions are no-ops.
103 */
104static inline void rcu_register_thread(void)
105{
106}
107
108static inline void rcu_unregister_thread(void)
109{
110}
111
02be5561 112static inline void rcu_init(void)
fdee2e6d
MD
113{
114}
115
36bc70a8
MD
116#ifdef __cplusplus
117}
118#endif
119
5e77fc1f 120#include "urcu-call-rcu.h"
0376e7b2 121#include "urcu-defer.h"
5e77fc1f 122
fdee2e6d 123#endif /* _URCU_BP_H */
This page took 0.037336 seconds and 4 git commands to generate.