From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Tue, 12 Jul 2011 15:59:00 +0000 (-0400)
Subject: rculfhash: document node alignment
X-Git-Tag: v0.7.0~43^2~194
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=7f61a77fffa376ff47a2a8fb56e16d8e20787139;p=userspace-rcu.git

rculfhash: document node alignment

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

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index b98b493..40fe4df 100644
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -8,6 +8,11 @@
 extern "C" {
 #endif
 
+/*
+ * struct rcu_ht_node and struct _rcu_ht_node should be aligned on
+ * 4-bytes boundaries because the two lower bits are used as flags.
+ */
+
 struct _rcu_ht_node {
 	struct rcu_ht_node *next;	/* ptr | DUMMY_FLAG | REMOVED_FLAG */
 	unsigned long reverse_hash;