From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Fri, 14 Jun 2013 12:30:21 +0000 (-0400)
Subject: document rcu barrier
X-Git-Tag: v0.8.0~72
X-Git-Url: https://git.liburcu.org/?p=urcu.git;a=commitdiff_plain;h=5e338f70a9e0bef4085a4494b377d51919eb6343;hp=63f0fc6d9616fd7eb72bc983bb70368ad2b4cf71

document rcu barrier

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/doc/rcu-api.txt b/doc/rcu-api.txt
index 2a7e734..b647316 100644
--- a/doc/rcu-api.txt
+++ b/doc/rcu-api.txt
@@ -62,6 +62,15 @@ void call_rcu(struct rcu_head *head,
 	call_rcu should be called from registered RCU read-side threads.
 	For the QSBR flavor, the caller should be online.
 
+void rcu_barrier(void);
+
+	Wait for all call_rcu() work initiated prior to rcu_barrier() by
+	_any_ thread on the system to have completed before rcu_barrier()
+	returns. rcu_barrier() should never be called from a call_rcu()
+	thread. This function can be used, for instance, to ensure that
+	all memory reclaim involving a shared object has completed
+	before allowing dlclose() of this shared object to complete.
+
 struct call_rcu_data *create_call_rcu_data(unsigned long flags,
 					   int cpu_affinity);