X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=83330eab1e5ab82cd128dd6c68cdc247f1f272a8;hb=bf6822a6b57e21a18a01731277355ab2e4eb23f3;hp=303c6ec48fc0fd948de29d1bc1319e523d7eadd4;hpb=88ecbe6daa6da4850ea975b635cd1af8e4ca9bfe;p=urcu.git diff --git a/README b/README index 303c6ec..83330ea 100644 --- a/README +++ b/README @@ -22,6 +22,7 @@ BUILDING Forcing a 32-bit build for Sparcv9 (typical for Sparc v9) * CFLAGS="-m32 -Wa,-Av9a -g -O2" ./configure + ARCHITECTURES SUPPORTED ----------------------- @@ -66,6 +67,19 @@ Test scripts provided in the tests/ directory of the source tree depend on "bash" and the "seq" program. +API +--- + +See the relevant API documentation files in doc/. The APIs provided by +Userspace RCU are, by prefix: + +- rcu_ : Read-Copy Update +- cmm_ : Concurrent Memory Model +- caa_ : Concurrent Architecture Abstraction +- cds_ : Concurrent Data Structures +- uatomic_: Userspace Atomic + + QUICK START GUIDE ----------------- @@ -260,3 +274,10 @@ Interaction with fork() call_rcu_after_fork_parent() after the fork(). The child process must invoke call_rcu_after_fork_child(). These three APIs are suitable for passing to pthread_atfork(). + +Thread Local Storage (TLS) + + Userspace RCU can fall back on pthread_getspecific() to emulate + TLS variables on systems where it is not available. This behavior + can be forced by specifying --disable-compiler-tls as configure + argument.