X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=README;h=58ce031db89131862b05fb21b7004c883e433900;hb=c5b9f8ff1e4debcc0787cda8ef13891c69d3a729;hp=7cc8871398b4c0a8b255bf8ddabfcbb7a40ed846;hpb=c0a68bfa57908ee51e391f1a5676915b503bfb07;p=userspace-rcu.git diff --git a/README b/README index 7cc8871..58ce031 100644 --- a/README +++ b/README @@ -16,7 +16,7 @@ BUILDING * CFLAGS="-m64 -g -O2" ./configure Forcing a 32-bit build with 386 backward compatibility: - * CFLAGS="-m32 -g -O2" ./configure --target=i386-pc-linux-gnu + * CFLAGS="-m32 -g -O2" ./configure --host=i386-pc-linux-gnu ARCHITECTURES SUPPORTED ----------------------- @@ -100,10 +100,18 @@ Usage of liburcu-defer * #include * Link with "-lurcu-defer" - * Provides call_rcu() primitive to enqueue delayed callbacks. Queued + * Provides defer_rcu() primitive to enqueue delayed callbacks. Queued callbacks are executed in batch periodically after a grace period. - Do _not_ use call_rcu() within a read-side critical section, because + Do _not_ use defer_rcu() within a read-side critical section, because it may call synchronize_rcu() if the thread queue is full. + * Provides defer_rcu_ratelimit() primitive, which acts just like + defer_rcu(), but takes an additional rate limiter callback forcing + synchronized callback execution of the limiter returns non-zero. + * Requires that rcu_defer_barrier() must be called in library destructor + if a library queues callbacks and is expected to be unloaded with + dlclose(). + * Its API is currently experimental. It may change in future library + releases. Being careful with signals