From: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Date: Sun, 27 Sep 2009 21:26:39 +0000 (-0400)
Subject: Document call_rcu() usage
X-Git-Tag: v0.1~24
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=8a13058c6fb398132fbe05253d1ac55f4cf4cbd1;p=urcu.git

Document call_rcu() usage

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
---

diff --git a/urcu-defer.h b/urcu-defer.h
index ac2f53b..e32156c 100644
--- a/urcu-defer.h
+++ b/urcu-defer.h
@@ -38,6 +38,10 @@
  * Each thread queuing memory reclamation must be registered with
  * rcu_defer_register_thread(). rcu_defer_unregister_thread() should be
  * called before the thread exits.
+ *
+ * *NEVER* use call_rcu()/rcu_defer_queue() within a RCU read-side critical
+ * section, because this primitive need to call synchronize_rcu() if the thread
+ * queue is full.
  */
 
 #define call_rcu		rcu_defer_queue