X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=README;h=ce498b939938868e06334e1e7d0aec87a5b5506f;hp=2d29c1d4e1c670800ec808a693f41cca2344ea0c;hb=882f335739b978d1c55be2faeed077f315afe5d7;hpb=07bd1a22e2ae42578d2a1854de8430cd1af13227 diff --git a/README b/README index 2d29c1d..ce498b9 100644 --- a/README +++ b/README @@ -48,6 +48,8 @@ supported, with the following exceptions: support. For ARM this was introduced with gcc 4.4: http://gcc.gnu.org/gcc-4.4/changes.html +Clang version 3.0 (based on LLVM 3.0) is supported. + For developers using the git tree: This source tree is based on the autotools suite from GNU to simplify @@ -73,11 +75,11 @@ API See the relevant API documentation files in doc/. The APIs provided by Userspace RCU are, by prefix: -- rcu_ : Read-Copy Update +- rcu_ : Read-Copy Update (see doc/rcu-api.txt) - cmm_ : Concurrent Memory Model - caa_ : Concurrent Architecture Abstraction -- cds_ : Concurrent Data Structures -- uatomic_: Userspace Atomic +- cds_ : Concurrent Data Structures (see doc/cds-api.txt) +- uatomic_: Userspace Atomic (see doc/uatomic-api.txt) QUICK START GUIDE @@ -232,28 +234,6 @@ Interaction with mutexes should only be taken when the RCU reader thread is "offline" (this can be performed by calling rcu_thread_offline()). -Usage of DEBUG_RCU - - DEBUG_RCU is used to add internal debugging self-checks to the - RCU library. This define adds a performance penalty when enabled. - Can be enabled by uncommenting the corresponding line in - Makefile.build.inc. - -Usage of DEBUG_YIELD - - DEBUG_YIELD is used to add random delays in the code for testing - purposes. - -SMP support - - By default the library is configured to use synchronization primitives - adequate for SMP systems. On uniprocessor systems, support for SMP - systems can be disabled with: - - ./configure --disable-smp-support - - theoretically yielding slightly better performance. - Interaction with fork() Special care must be taken for applications performing fork() without @@ -294,3 +274,25 @@ Thread Local Storage (TLS) TLS variables on systems where it is not available. This behavior can be forced by specifying --disable-compiler-tls as configure argument. + +Usage of DEBUG_RCU + + DEBUG_RCU is used to add internal debugging self-checks to the + RCU library. This define adds a performance penalty when enabled. + Can be enabled by uncommenting the corresponding line in + Makefile.build.inc. + +Usage of DEBUG_YIELD + + DEBUG_YIELD is used to add random delays in the code for testing + purposes. + +SMP support + + By default the library is configured to use synchronization primitives + adequate for SMP systems. On uniprocessor systems, support for SMP + systems can be disabled with: + + ./configure --disable-smp-support + + theoretically yielding slightly better performance.