Add call_rcu() interface
[urcu.git] / README
CommitLineData
7ac06cef 1Userspace RCU Implementation
c97ae6eb 2by Mathieu Desnoyers and Paul E. McKenney
6991f61a 3
c97ae6eb
PMF
4BUILDING
5--------
6991f61a 6
48d848c7
PMF
7 ./bootstrap (skip if using tarball)
8 ./configure
c97ae6eb
PMF
9 make
10 make install
9ca52251 11
7d413817 12 Hints: Forcing 32-bit build:
c4c18179 13 * CFLAGS="-m32 -g -O2" ./configure
9ca52251
MD
14
15 Forcing 64-bit build:
c4c18179 16 * CFLAGS="-m64 -g -O2" ./configure
aa8c36e0 17
f39cd442 18 Forcing a 32-bit build with 386 backward compatibility:
c5b9f8ff 19 * CFLAGS="-m32 -g -O2" ./configure --host=i386-pc-linux-gnu
7d413817 20
795d506a
MD
21 Forcing a 32-bit build for Sparcv9 (typical for Sparc v9)
22 * CFLAGS="-m32 -Wa,-Av9a -g -O2" ./configure
23
c51e75e6
MD
24ARCHITECTURES SUPPORTED
25-----------------------
26
ac6454bc
JW
27Currently, x86 (i386, i486, i586, i686), x86 64-bit, PowerPC 32/64, S390, S390x,
28ARM, Alpha, ia64 and Sparcv9 32/64 are supported. Only tested on Linux so
7bcbcfb2 29far, but should theoretically work on other operating systems.
c51e75e6 30
ac6454bc 31ARM depends on running a Linux kernel 2.6.15 or better.
3b36a2e9 32
3b38cfe1
MD
33The gcc compiler versions 3.3, 3.4, 4.0, 4.1, 4.2, 4.3, 4.4 and 4.5 are
34supported, with the following exceptions:
35
36- gcc 3.3 and 3.4 have a bug that prevents them from generating volatile
37 accesses to offsets in a TLS structure on 32-bit x86. These versions are
38 therefore not compatible with liburcu on x86 32-bit (i386, i486, i586, i686).
39 The problem has been reported to the gcc community:
40 http://www.mail-archive.com/gcc-bugs@gcc.gnu.org/msg281255.html
ac6454bc 41- Alpha, ia64 and ARM architectures depend on 4.x gcc with atomic builtins
7bcbcfb2
MD
42 support.
43
3b38cfe1 44
c97ae6eb
PMF
45QUICK START GUIDE
46-----------------
aa8c36e0 47
0a1d290b
MD
48Usage of all urcu libraries
49
50 * Define _LGPL_SOURCE (only) if your code is LGPL or GPL compatible
51 before including the urcu.h or urcu-qsbr.h header. If your application
52 is distributed under another license, function calls will be generated
53 instead of inlines, so your application can link with the library.
54 * Linking with one of the libraries below is always necessary even for
55 LGPL and GPL applications.
56
57Usage of liburcu
58
59 * #include <urcu.h>
60 * Link the application with "-lurcu".
fdf01eed
MD
61 * This is the preferred version of the library, in terms of
62 grace-period detection speed, read-side speed and flexibility.
63 Dynamically detects kernel support for sys_membarrier(). Falls back
64 on urcu-mb scheme if support is not present, which has slower
65 read-side.
0a1d290b
MD
66
67Usage of liburcu-qsbr
68
69 * #include <urcu-qsbr.h>
70 * Link with "-lurcu-qsbr".
71 * The QSBR flavor of RCU needs to have each reader thread executing
72 rcu_quiescent_state() periodically to progress. rcu_thread_online()
73 and rcu_thread_offline() can be used to mark long periods for which
74 the threads are not active. It provides the fastest read-side at the
75 expense of more intrusiveness in the application code.
76
fdf01eed
MD
77Usage of liburcu-mb
78
79 * #include <urcu.h>
80 * Compile any _LGPL_SOURCE code using this library with "-DRCU_MB".
81 * Link with "-lurcu-mb".
82 * This version of the urcu library uses memory barriers on the writer
83 and reader sides. This results in faster grace-period detection, but
84 results in slower reads.
85
86Usage of liburcu-signal
87
ee39cfb6
MD
88 * #include <urcu.h>
89 * Compile any _LGPL_SOURCE code using this library with "-DRCU_SIGNAL".
fdf01eed
MD
90 * Link the application with "-lurcu-signal".
91 * Version of the library that requires a signal, typically SIGUSR1. Can
92 be overridden with -DSIGRCU by modifying Makefile.build.inc.
93
fdee2e6d
MD
94Usage of liburcu-bp
95
96 * #include <urcu-bp.h>
97 * Link with "-lurcu-bp".
98 * The BP library flavor stands for "bulletproof". It is specifically
99 designed to help tracing library to hook on applications without
02be5561 100 requiring to modify these applications. rcu_init(),
fdee2e6d
MD
101 rcu_register_thread() and rcu_unregister_thread() all become nops.
102 The state is dealt with by the library internally at the expense of
103 read-side and write-side performance.
104
c97ae6eb
PMF
105Initialization
106
107 Each thread that has reader critical sections (that uses
108 rcu_read_lock()/rcu_read_unlock() must first register to the URCU
4c1471de
MD
109 library. This is done by calling rcu_register_thread(). Unregistration
110 must be performed before exiting the thread by using
111 rcu_unregister_thread().
c97ae6eb
PMF
112
113Reading
114
115 Reader critical sections must be protected by locating them between
116 calls to rcu_read_lock() and rcu_read_unlock(). Inside that lock,
117 rcu_dereference() may be called to read an RCU protected pointer.
118
119Writing
120
121 rcu_assign_pointer() and rcu_xchg_pointer() may be called anywhere.
9fb223da
MD
122 After, synchronize_rcu() must be called. When it returns, the old
123 values are not in usage anymore.
c97ae6eb 124
ec4e58a3
MD
125Usage of liburcu-defer
126
127 * #include <urcu-defer.h>
24c9669d
MD
128 * Link with "-lurcu-defer", and also with one of the urcu library
129 (either urcu, urcu-bp, urcu-mb or urcu-qsbr).
632dd6ba 130 * Provides defer_rcu() primitive to enqueue delayed callbacks. Queued
ec4e58a3 131 callbacks are executed in batch periodically after a grace period.
632dd6ba 132 Do _not_ use defer_rcu() within a read-side critical section, because
ec4e58a3 133 it may call synchronize_rcu() if the thread queue is full.
ec8e44cf
MD
134 * Provides defer_rcu_ratelimit() primitive, which acts just like
135 defer_rcu(), but takes an additional rate limiter callback forcing
136 synchronized callback execution of the limiter returns non-zero.
83dd659a
MD
137 * Requires that rcu_defer_barrier() must be called in library destructor
138 if a library queues callbacks and is expected to be unloaded with
139 dlclose().
9c55af9f
MD
140 * Its API is currently experimental. It may change in future library
141 releases.
ec4e58a3 142
dd052bd3
PMF
143Being careful with signals
144
0a1d290b 145 The liburcu library uses signals internally. The signal handler is
dd052bd3
PMF
146 registered with the SA_RESTART flag. However, these signals may cause
147 some non-restartable system calls to fail with errno = EINTR. Care
148 should be taken to restart system calls manually if they fail with this
149 error. A list of non-restartable system calls may be found in
0a1d290b
MD
150 signal(7). The liburcu-mb and liburcu-qsbr versions of the Userspace RCU
151 library do not require any signal.
c97ae6eb 152
0a1d290b 153 Read-side critical sections are allowed in a signal handler with
7ac06cef
MD
154 liburcu and liburcu-mb. Be careful, however, to disable these signals
155 between thread creation and calls to rcu_register_thread(), because a
156 signal handler nesting on an unregistered thread would not be allowed to
157 call rcu_read_lock().
cee02f0a 158
0a1d290b
MD
159 Read-side critical sections are _not_ allowed in a signal handler with
160 liburcu-qsbr, unless signals are disabled explicitly around each
161 rcu_quiescent_state() calls, when threads are put offline and around
162 calls to synchronize_rcu(). Even then, we do not recommend it.
c97ae6eb 163
955f5e52
MD
164Interaction with mutexes
165
166 One must be careful to do not cause deadlocks due to interaction of
167 synchronize_rcu() and RCU read-side with mutexes. If synchronize_rcu()
168 is called with a mutex held, this mutex (or any mutex which has this
169 mutex in its dependency chain) should not be acquired from within a RCU
170 read-side critical section.
171
cee02f0a
MD
172Usage of DEBUG_RCU
173
174 DEBUG_RCU is used to add internal debugging self-checks to the
0a1d290b 175 RCU library. This define adds a performance penalty when enabled.
fb6e510b
MD
176 Can be enabled by uncommenting the corresponding line in
177 Makefile.build.inc.
c97ae6eb
PMF
178
179Usage of DEBUG_YIELD
180
181 DEBUG_YIELD is used to add random delays in the code for testing
182 purposes.
7d413817
MD
183
184SMP support
185
186 By default the library is configured to use synchronization primitives
187 adequate for SMP systems. On uniprocessor systems, support for SMP
188 systems can be disabled with:
189
190 ./configure --disable-smp-support
191
192 theoretically yielding slightly better performance.
47c5a84f
MD
193
194Interaction with fork()
195
196 Special care must be taken for applications performing fork() without
197 any following exec(). This is caused by the fact that Linux only clones
198 the thread calling fork(), and thus never replicates any of the other
199 parent thread into the child process. Most liburcu implementations
200 require that all registrations (as reader, defer_rcu and call_rcu
201 threads) should be released before a fork() is performed, except for the
202 rather common scenario where fork() is immediately followed by exec() in
203 the child process. The only implementation not subject to that rule is
4cf1675f
MD
204 liburcu-bp, which is designed to handle fork() by calling
205 rcu_bp_before_fork, rcu_bp_after_fork_parent and
206 rcu_bp_after_fork_child.
This page took 0.035681 seconds and 4 git commands to generate.