From: Pierre-Marc Fournier Date: Fri, 19 Jun 2009 20:51:23 +0000 (-0400) Subject: urcu: add quick start guide to README X-Git-Tag: v0.1~124 X-Git-Url: https://git.lttng.org/?p=urcu.git;a=commitdiff_plain;h=c97ae6eb5bf6baea503d9df98e8376c0bd36b629 urcu: add quick start guide to README Signed-off-by: Pierre-Marc Fournier Signed-off-by: Mathieu Desnoyers --- diff --git a/README b/README index 02cec26..d71bbe7 100644 --- a/README +++ b/README @@ -1,14 +1,43 @@ -build instructions for userspace-rcu library : +Userspace RCU Implementatation +by Mathieu Desnoyers and Paul E. McKenney -make -make install +BUILDING +-------- -Usage : + make + make install + -Registration of _each thread_ calling read-side critical sections must be done -with rcu_register_thread() before using rcu_read_lock()/rcu_read_unlock(). +QUICK START GUIDE +----------------- -Unregistration should be performed with rcu_unregister_thread() before exiting -the thread. +Initialization + + Each thread that has reader critical sections (that uses + rcu_read_lock()/rcu_read_unlock() must first register to the URCU + library. This is done by calling rcu_register_thread(). + +Reading + + Reader critical sections must be protected by locating them between + calls to rcu_read_lock() and rcu_read_unlock(). Inside that lock, + rcu_dereference() may be called to read an RCU protected pointer. + +Writing + + rcu_assign_pointer() and rcu_xchg_pointer() may be called anywhere. + After, synchronize_rcu() must be called. When it returns, the old values + are not in usage anymore. + + +Usage of DEBUG_FULL_MB + + DEBUG_FULL_MB uses full SMP barriers for readers. This eliminates the + need for signals but results in slower reads. + + +Usage of DEBUG_YIELD + + DEBUG_YIELD is used to add random delays in the code for testing + purposes. - Mathieu Desnoyers