Fix: take RCU read-side lock within hash table functions
authorMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Thu, 6 Aug 2015 22:02:21 +0000 (18:02 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 14 Aug 2015 21:45:29 +0000 (17:45 -0400)
After review, a great deal of caller sites miss the RCU read-side lock
when using the hash table modification functions. This is a case where
having a slight performance degradation might be worthwhile if we can be
a bit more stability. So instead of playing whack-a-mole, add the RCU
read-side lock in the hash table modification functions to ensure
protection from ABA.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
src/common/hashtable/hashtable.c

index 3a38cbf0f83e20a6d6c315d5fc0c3deef5843a87..d1049d1e2b9dea53b9747a0bcaf8cea4108833cd 100644 (file)
@@ -33,6 +33,13 @@ unsigned long lttng_ht_seed;
 static unsigned long min_hash_alloc_size = 1;
 static unsigned long max_hash_buckets_size = 0;
 
+/*
+ * Getter/lookup functions need to be called with RCU read-side lock
+ * held. However, modification functions (add, add_unique, replace, del)
+ * take the RCU lock internally, so it does not matter whether the
+ * caller hold the RCU lock or not.
+ */
+
 /*
  * Match function for string node.
  */
@@ -253,8 +260,11 @@ void lttng_ht_add_unique_str(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        node_ptr = cds_lfht_add_unique(ht->ht, ht->hash_fct(node->key, lttng_ht_seed),
                        ht->match_fct, node->key, &node->node);
+       rcu_read_unlock();
        assert(node_ptr == &node->node);
 }
 
@@ -268,8 +278,11 @@ void lttng_ht_add_str(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        cds_lfht_add(ht->ht, ht->hash_fct(node->key, lttng_ht_seed),
                        &node->node);
+       rcu_read_unlock();
 }
 
 /*
@@ -281,8 +294,11 @@ void lttng_ht_add_ulong(struct lttng_ht *ht, struct lttng_ht_node_ulong *node)
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        cds_lfht_add(ht->ht, ht->hash_fct((void *) node->key, lttng_ht_seed),
                        &node->node);
+       rcu_read_unlock();
 }
 
 /*
@@ -295,8 +311,11 @@ void lttng_ht_add_u64(struct lttng_ht *ht, struct lttng_ht_node_u64 *node)
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        cds_lfht_add(ht->ht, ht->hash_fct(&node->key, lttng_ht_seed),
                        &node->node);
+       rcu_read_unlock();
 }
 
 /*
@@ -310,9 +329,12 @@ void lttng_ht_add_unique_ulong(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        node_ptr = cds_lfht_add_unique(ht->ht,
                        ht->hash_fct((void *) node->key, lttng_ht_seed), ht->match_fct,
                        (void *) node->key, &node->node);
+       rcu_read_unlock();
        assert(node_ptr == &node->node);
 }
 
@@ -327,9 +349,12 @@ void lttng_ht_add_unique_u64(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        node_ptr = cds_lfht_add_unique(ht->ht,
                        ht->hash_fct(&node->key, lttng_ht_seed), ht->match_fct,
                        &node->key, &node->node);
+       rcu_read_unlock();
        assert(node_ptr == &node->node);
 }
 
@@ -344,9 +369,12 @@ void lttng_ht_add_unique_two_u64(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        node_ptr = cds_lfht_add_unique(ht->ht,
                        ht->hash_fct((void *) &node->key, lttng_ht_seed), ht->match_fct,
                        (void *) &node->key, &node->node);
+       rcu_read_unlock();
        assert(node_ptr == &node->node);
 }
 
@@ -361,9 +389,12 @@ struct lttng_ht_node_ulong *lttng_ht_add_replace_ulong(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        node_ptr = cds_lfht_add_replace(ht->ht,
                        ht->hash_fct((void *) node->key, lttng_ht_seed), ht->match_fct,
                        (void *) node->key, &node->node);
+       rcu_read_unlock();
        if (!node_ptr) {
                return NULL;
        } else {
@@ -383,9 +414,12 @@ struct lttng_ht_node_u64 *lttng_ht_add_replace_u64(struct lttng_ht *ht,
        assert(ht->ht);
        assert(node);
 
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
        node_ptr = cds_lfht_add_replace(ht->ht,
                        ht->hash_fct(&node->key, lttng_ht_seed), ht->match_fct,
                        &node->key, &node->node);
+       rcu_read_unlock();
        if (!node_ptr) {
                return NULL;
        } else {
@@ -399,11 +433,17 @@ struct lttng_ht_node_u64 *lttng_ht_add_replace_u64(struct lttng_ht *ht,
  */
 int lttng_ht_del(struct lttng_ht *ht, struct lttng_ht_iter *iter)
 {
+       int ret;
+
        assert(ht);
        assert(ht->ht);
        assert(iter);
 
-       return cds_lfht_del(ht->ht, iter->iter.node);
+       /* RCU read lock protects from ABA. */
+       rcu_read_lock();
+       ret = cds_lfht_del(ht->ht, iter->iter.node);
+       rcu_read_unlock();
+       return ret;
 }
 
 /*
@@ -441,7 +481,10 @@ unsigned long lttng_ht_get_count(struct lttng_ht *ht)
        assert(ht);
        assert(ht->ht);
 
+       /* RCU read lock protects from ABA and allows RCU traversal. */
+       rcu_read_lock();
        cds_lfht_count_nodes(ht->ht, &scb, &count, &sca);
+       rcu_read_unlock();
 
        return count;
 }
This page took 0.037802 seconds and 4 git commands to generate.