rculfhash: rename likely/unlikely (add caa_ prefix)
[urcu.git] / rculfhash.c
index 668f93672a17899e7fc27e9cd049e1ccf9350d74..d1a17669f9fa176660b9552241808f2760f6bdcc 100644 (file)
 /* Value of the end pointer. Should not interact with flags. */
 #define END_VALUE              NULL
 
+/*
+ * ht_items_count: Split-counters counting the number of node addition
+ * and removal in the table. Only used if the CDS_LFHT_ACCOUNTING flag
+ * is set at hash table creation.
+ *
+ * These are free-running counters, never reset to zero. They count the
+ * number of add/remove, and trigger every (1 << COUNT_COMMIT_ORDER)
+ * operations to update the global counter. We choose a power-of-2 value
+ * for the trigger to deal with 32 or 64-bit overflow of the counter.
+ */
 struct ht_items_count {
        unsigned long add, del;
 } __attribute__((aligned(CAA_CACHE_LINE_SIZE)));
 
+/*
+ * rcu_level: Contains the per order-index-level dummy node table. The
+ * size of each dummy node table is half the number of hashes contained
+ * in this order (except for order 0). The minimum allocation size
+ * parameter allows combining the dummy node arrays of the lowermost
+ * levels to improve cache locality for small index orders.
+ */
 struct rcu_level {
        /* Note: manually update allocation length when adding a field */
        struct _cds_lfht_node nodes[0];
 };
 
+/*
+ * rcu_table: Contains the size and desired new size if a resize
+ * operation is in progress, as well as the statically-sized array of
+ * rcu_level pointers.
+ */
 struct rcu_table {
        unsigned long size;     /* always a power of 2, shared (RCU) */
        unsigned long resize_target;
@@ -238,6 +260,11 @@ struct rcu_table {
        struct rcu_level *tbl[MAX_TABLE_ORDER];
 };
 
+/*
+ * cds_lfht: Top-level data structure representing a lock-free hash
+ * table. Defined in the implementation file to make it be an opaque
+ * cookie to users.
+ */
 struct cds_lfht {
        struct rcu_table t;
        cds_lfht_hash_fct hash_fct;
@@ -269,11 +296,20 @@ struct cds_lfht {
        struct ht_items_count *split_count;     /* split item count */
 };
 
+/*
+ * rcu_resize_work: Contains arguments passed to RCU worker thread
+ * responsible for performing lazy resize.
+ */
 struct rcu_resize_work {
        struct rcu_head head;
        struct cds_lfht *ht;
 };
 
+/*
+ * partition_resize_work: Contains arguments passed to worker threads
+ * executing the hash table resize on partitions of the hash table
+ * assigned to each processor's worker thread.
+ */
 struct partition_resize_work {
        pthread_t thread_id;
        struct cds_lfht *ht;
@@ -454,7 +490,7 @@ unsigned int fls_u32(uint32_t x)
 
 unsigned int fls_ulong(unsigned long x)
 {
-#if (CAA_BITS_PER_lONG == 32)
+#if (CAA_BITS_PER_LONG == 32)
        return fls_u32(x);
 #else
        return fls_u64(x);
@@ -486,10 +522,12 @@ int get_count_order_ulong(unsigned long x)
 }
 
 #ifdef POISON_FREE
-#define poison_free(ptr)                               \
-       do {                                            \
-               memset(ptr, 0x42, sizeof(*(ptr)));      \
-               free(ptr);                              \
+#define poison_free(ptr)                                       \
+       do {                                                    \
+               if (ptr) {                                      \
+                       memset(ptr, 0x42, sizeof(*(ptr)));      \
+                       free(ptr);                              \
+               }                                               \
        } while (0)
 #else
 #define poison_free(ptr)       free(ptr)
@@ -530,7 +568,7 @@ static void ht_init_nr_cpus_mask(void)
 #endif /* #else #if defined(HAVE_SYSCONF) */
 
 static
-struct ht_items_count *alloc_split_items_count(void)
+void alloc_split_items_count(struct cds_lfht *ht)
 {
        struct ht_items_count *count;
 
@@ -543,13 +581,19 @@ struct ht_items_count *alloc_split_items_count(void)
        }
 
        assert(split_count_mask >= 0);
-       return calloc(split_count_mask + 1, sizeof(*count));
+
+       if (ht->flags & CDS_LFHT_ACCOUNTING) {
+               ht->split_count = calloc(split_count_mask + 1, sizeof(*count));
+               assert(ht->split_count);
+       } else {
+               ht->split_count = NULL;
+       }
 }
 
 static
-void free_split_items_count(struct ht_items_count *count)
+void free_split_items_count(struct cds_lfht *ht)
 {
-       poison_free(count);
+       poison_free(ht->split_count);
 }
 
 #if defined(HAVE_SCHED_GETCPU)
@@ -560,7 +604,7 @@ int ht_get_split_count_index(unsigned long hash)
 
        assert(split_count_mask >= 0);
        cpu = sched_getcpu();
-       if (unlikely(cpu < 0))
+       if (caa_unlikely(cpu < 0))
                return hash & split_count_mask;
        else
                return cpu & split_count_mask;
@@ -579,11 +623,11 @@ void ht_count_add(struct cds_lfht *ht, unsigned long size, unsigned long hash)
        unsigned long split_count;
        int index;
 
-       if (unlikely(!ht->split_count))
+       if (caa_unlikely(!ht->split_count))
                return;
        index = ht_get_split_count_index(hash);
        split_count = uatomic_add_return(&ht->split_count[index].add, 1);
-       if (unlikely(!(split_count & ((1UL << COUNT_COMMIT_ORDER) - 1)))) {
+       if (caa_unlikely(!(split_count & ((1UL << COUNT_COMMIT_ORDER) - 1)))) {
                long count;
 
                dbg_printf("add split count %lu\n", split_count);
@@ -606,11 +650,11 @@ void ht_count_del(struct cds_lfht *ht, unsigned long size, unsigned long hash)
        unsigned long split_count;
        int index;
 
-       if (unlikely(!ht->split_count))
+       if (caa_unlikely(!ht->split_count))
                return;
        index = ht_get_split_count_index(hash);
        split_count = uatomic_add_return(&ht->split_count[index].del, 1);
-       if (unlikely(!(split_count & ((1UL << COUNT_COMMIT_ORDER) - 1)))) {
+       if (caa_unlikely(!(split_count & ((1UL << COUNT_COMMIT_ORDER) - 1)))) {
                long count;
 
                dbg_printf("del split count %lu\n", split_count);
@@ -762,12 +806,12 @@ void _cds_lfht_gc_bucket(struct cds_lfht_node *dummy, struct cds_lfht_node *node
                 */
                assert(dummy != node);
                for (;;) {
-                       if (unlikely(is_end(iter)))
+                       if (caa_unlikely(is_end(iter)))
                                return;
-                       if (likely(clear_flag(iter)->p.reverse_hash > node->p.reverse_hash))
+                       if (caa_likely(clear_flag(iter)->p.reverse_hash > node->p.reverse_hash))
                                return;
                        next = rcu_dereference(clear_flag(iter)->p.next);
-                       if (likely(is_removed(next)))
+                       if (caa_likely(is_removed(next)))
                                break;
                        iter_prev = clear_flag(iter);
                        iter = next;
@@ -871,9 +915,9 @@ void _cds_lfht_add(struct cds_lfht *ht,
                iter = rcu_dereference(iter_prev->p.next);
                assert(iter_prev->p.reverse_hash <= node->p.reverse_hash);
                for (;;) {
-                       if (unlikely(is_end(iter)))
+                       if (caa_unlikely(is_end(iter)))
                                goto insert;
-                       if (likely(clear_flag(iter)->p.reverse_hash > node->p.reverse_hash))
+                       if (caa_likely(clear_flag(iter)->p.reverse_hash > node->p.reverse_hash))
                                goto insert;
 
                        /* dummy node is the first node of the identical-hash-value chain */
@@ -881,7 +925,7 @@ void _cds_lfht_add(struct cds_lfht *ht,
                                goto insert;
 
                        next = rcu_dereference(clear_flag(iter)->p.next);
-                       if (unlikely(is_removed(next)))
+                       if (caa_unlikely(is_removed(next)))
                                goto gc_node;
 
                        /* uniquely add */
@@ -971,7 +1015,7 @@ int _cds_lfht_del(struct cds_lfht *ht, unsigned long size,
                struct cds_lfht_node *new_next;
 
                next = old;
-               if (unlikely(is_removed(next)))
+               if (caa_unlikely(is_removed(next)))
                        return -ENOENT;
                if (dummy_removal)
                        assert(is_dummy(next));
@@ -1322,6 +1366,7 @@ struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
        init_size = max(init_size, min_alloc_size);
        ht = calloc(1, sizeof(struct cds_lfht));
        assert(ht);
+       ht->flags = flags;
        ht->hash_fct = hash_fct;
        ht->compare_fct = compare_fct;
        ht->hash_seed = hash_seed;
@@ -1334,16 +1379,15 @@ struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
        ht->cds_lfht_rcu_register_thread = cds_lfht_rcu_register_thread;
        ht->cds_lfht_rcu_unregister_thread = cds_lfht_rcu_unregister_thread;
        ht->resize_attr = attr;
-       ht->split_count = alloc_split_items_count();
+       alloc_split_items_count(ht);
        /* this mutex should not nest in read-side C.S. */
        pthread_mutex_init(&ht->resize_mutex, NULL);
-       ht->flags = flags;
        order = get_count_order_ulong(init_size);
        ht->t.resize_target = 1UL << order;
-       cds_lfht_create_dummy(ht, 1UL << order);
-       ht->t.size = 1UL << order;
        ht->min_alloc_size = min_alloc_size;
        ht->min_alloc_order = get_count_order_ulong(min_alloc_size);
+       cds_lfht_create_dummy(ht, 1UL << order);
+       ht->t.size = 1UL << order;
        return ht;
 }
 
@@ -1364,19 +1408,20 @@ void cds_lfht_lookup(struct cds_lfht *ht, void *key, size_t key_len,
        node = rcu_dereference(dummy_node->p.next);
        node = clear_flag(node);
        for (;;) {
-               if (unlikely(is_end(node))) {
+               if (caa_unlikely(is_end(node))) {
                        node = next = NULL;
                        break;
                }
-               if (unlikely(node->p.reverse_hash > reverse_hash)) {
+               if (caa_unlikely(node->p.reverse_hash > reverse_hash)) {
                        node = next = NULL;
                        break;
                }
                next = rcu_dereference(node->p.next);
-               if (likely(!is_removed(next))
+               assert(node == clear_flag(node));
+               if (caa_likely(!is_removed(next))
                    && !is_dummy(next)
-                   && clear_flag(node)->p.reverse_hash == reverse_hash
-                   && likely(!ht->compare_fct(node->key, node->key_len, key, key_len))) {
+                   && node->p.reverse_hash == reverse_hash
+                   && caa_likely(!ht->compare_fct(node->key, node->key_len, key, key_len))) {
                                break;
                }
                node = clear_flag(next);
@@ -1401,18 +1446,18 @@ void cds_lfht_next_duplicate(struct cds_lfht *ht, struct cds_lfht_iter *iter)
        node = clear_flag(next);
 
        for (;;) {
-               if (unlikely(is_end(node))) {
+               if (caa_unlikely(is_end(node))) {
                        node = next = NULL;
                        break;
                }
-               if (unlikely(node->p.reverse_hash > reverse_hash)) {
+               if (caa_unlikely(node->p.reverse_hash > reverse_hash)) {
                        node = next = NULL;
                        break;
                }
                next = rcu_dereference(node->p.next);
-               if (likely(!is_removed(next))
+               if (caa_likely(!is_removed(next))
                    && !is_dummy(next)
-                   && likely(!ht->compare_fct(node->key, node->key_len, key, key_len))) {
+                   && caa_likely(!ht->compare_fct(node->key, node->key_len, key, key_len))) {
                                break;
                }
                node = clear_flag(next);
@@ -1428,12 +1473,12 @@ void cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_iter *iter)
 
        node = clear_flag(iter->next);
        for (;;) {
-               if (unlikely(is_end(node))) {
+               if (caa_unlikely(is_end(node))) {
                        node = next = NULL;
                        break;
                }
                next = rcu_dereference(node->p.next);
-               if (likely(!is_removed(next))
+               if (caa_likely(!is_removed(next))
                    && !is_dummy(next)) {
                                break;
                }
@@ -1589,7 +1634,7 @@ int cds_lfht_destroy(struct cds_lfht *ht, pthread_attr_t **attr)
        ret = cds_lfht_delete_dummy(ht);
        if (ret)
                return ret;
-       free_split_items_count(ht->split_count);
+       free_split_items_count(ht);
        if (attr)
                *attr = ht->resize_attr;
        poison_free(ht);
@@ -1607,7 +1652,7 @@ void cds_lfht_count_nodes(struct cds_lfht *ht,
        unsigned long nr_dummy = 0;
 
        *approx_before = 0;
-       if (split_count_mask >= 0) {
+       if (ht->split_count) {
                int i;
 
                for (i = 0; i < split_count_mask + 1; i++) {
@@ -1637,7 +1682,7 @@ void cds_lfht_count_nodes(struct cds_lfht *ht,
        } while (!is_end(node));
        dbg_printf("number of dummy nodes: %lu\n", nr_dummy);
        *approx_after = 0;
-       if (split_count_mask >= 0) {
+       if (ht->split_count) {
                int i;
 
                for (i = 0; i < split_count_mask + 1; i++) {
This page took 0.027351 seconds and 4 git commands to generate.