X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=71eec3530465ebe2093093dce57b4871b0facd66;hb=f9a5fd0a930d01089381b23a66a22344a72d2aeb;hp=b47fe48c2c181e833c633c8b6b973ddcbf0f5186;hpb=a669219f71cabe41a5832bdda98c94e4ad63e529;p=urcu.git diff --git a/README b/README index b47fe48..71eec35 100644 --- a/README +++ b/README @@ -4,11 +4,16 @@ by Mathieu Desnoyers and Paul E. McKenney BUILDING -------- + ./bootstrap (skip if using tarball) + ./configure make - #force 32-bit build with: make -f Makefile32 - #force 64-bit build with: make -f Makefile64 make install - + + Note: Forcing 32-bit build: + * CFLAGS=-m32 ./configure + + Forcing 64-bit build: + * CFLAGS=-m64 ./configure QUICK START GUIDE ----------------- @@ -50,6 +55,17 @@ Usage of liburcu-qsbr the threads are not active. It provides the fastest read-side at the expense of more intrusiveness in the application code. +Usage of liburcu-bp + + * #include + * Link with "-lurcu-bp". + * The BP library flavor stands for "bulletproof". It is specifically + designed to help tracing library to hook on applications without + requiring to modify these applications. urcu_init(), + rcu_register_thread() and rcu_unregister_thread() all become nops. + The state is dealt with by the library internally at the expense of + read-side and write-side performance. + Initialization Each thread that has reader critical sections (that uses @@ -70,6 +86,15 @@ Writing After, synchronize_rcu() must be called. When it returns, the old values are not in usage anymore. +Usage of liburcu-defer + + * #include + * Link with "-lurcu-defer" + * Provides call_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 + it may call synchronize_rcu() if the thread queue is full. + Being careful with signals The liburcu library uses signals internally. The signal handler is