From: Lai Jiangshan <laijs@cn.fujitsu.com>
Date: Thu, 9 Aug 2012 14:10:08 +0000 (-0400)
Subject: urcu: add hint to DEFINE_URCU_TLS() for compound types
X-Git-Tag: v0.7.4~6
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=c85e62f37e4db48038e4494c202f5a2c923262f2;p=urcu.git

urcu: add hint to DEFINE_URCU_TLS() for compound types

Just a hint.

Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/urcu/tls-compat.h b/urcu/tls-compat.h
index 9686eca..192a536 100644
--- a/urcu/tls-compat.h
+++ b/urcu/tls-compat.h
@@ -34,6 +34,21 @@ extern "C" {
 
 #ifdef CONFIG_RCU_TLS	/* Based on ax_tls.m4 */
 
+/*
+ * Hint: How to define/declare TLS variables of compound types
+ *       such as array or function pointers?
+ *
+ * Answer: Use typedef to assign a type_name to the compound type.
+ * Example: Define a TLS variable which is an int array with len=4:
+ *
+ * 	typedef int my_int_array_type[4];
+ * 	DEFINE_URCU_TLS(my_int_array_type, var_name);
+ *
+ * Another exmaple:
+ * 	typedef void (*call_rcu_flavor)(struct rcu_head *, XXXX);
+ * 	DECLARE_URCU_TLS(call_rcu_flavor, p_call_rcu);
+ */
+
 # define DECLARE_URCU_TLS(type, name)	\
 	CONFIG_RCU_TLS type name