rculfhash: document algorithms

[urcu.git] / urcu / rculfhash.h

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index c88740097c885beb07acb2f3d5ce80e7df94745f..b98b4932922e02fab3cd53e6630a46ca3b848a06 100644 (file)
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -8,13 +8,16 @@
 extern "C" {
 #endif
 
+struct _rcu_ht_node {
+       struct rcu_ht_node *next;       /* ptr | DUMMY_FLAG | REMOVED_FLAG */
+       unsigned long reverse_hash;
+};
+
 struct rcu_ht_node {
        /* cache-hot for iteration */
-       struct rcu_ht_node *next;
-       unsigned long reverse_hash;
+       struct _rcu_ht_node p;          /* needs to be first field */
        void *key;
        unsigned int key_len;
-       unsigned int dummy;
        /* cache-cold for iteration */
        struct rcu_head head;
 };
@@ -37,7 +40,6 @@ void ht_node_init(struct rcu_ht_node *node, void *key,
 {
        node->key = key;
        node->key_len = key_len;
-       node->dummy = 0;
 }
 
 /*