remove experimental tags from all symbol definitions
[dpdk.git] / lib / librte_hash / rte_cuckoo_hash.c
index c55a4f2..51198b4 100644 (file)
@@ -26,6 +26,7 @@
 #include <rte_spinlock.h>
 #include <rte_ring.h>
 #include <rte_compat.h>
+#include <rte_vect.h>
 
 #include "rte_hash.h"
 #include "rte_cuckoo_hash.h"
@@ -140,6 +141,7 @@ rte_hash_create(const struct rte_hash_parameters *params)
        unsigned int readwrite_concur_support = 0;
        unsigned int writer_takes_lock = 0;
        unsigned int no_free_on_del = 0;
+       uint32_t *ext_bkt_to_free = NULL;
        uint32_t *tbl_chng_cnt = NULL;
        unsigned int readwrite_concur_lf_support = 0;
 
@@ -170,15 +172,6 @@ rte_hash_create(const struct rte_hash_parameters *params)
                return NULL;
        }
 
-       if ((params->extra_flag & RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY_LF) &&
-           (params->extra_flag & RTE_HASH_EXTRA_FLAGS_EXT_TABLE)) {
-               rte_errno = EINVAL;
-               RTE_LOG(ERR, HASH, "rte_hash_create: extendable bucket "
-                       "feature not supported with rw concurrency "
-                       "lock free\n");
-               return NULL;
-       }
-
        /* Check extra flags field to check extra options. */
        if (params->extra_flag & RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT)
                hw_trans_mem_support = 1;
@@ -302,6 +295,16 @@ rte_hash_create(const struct rte_hash_parameters *params)
                 */
                for (i = 1; i <= num_buckets; i++)
                        rte_ring_sp_enqueue(r_ext, (void *)((uintptr_t) i));
+
+               if (readwrite_concur_lf_support) {
+                       ext_bkt_to_free = rte_zmalloc(NULL, sizeof(uint32_t) *
+                                                               num_key_slots, 0);
+                       if (ext_bkt_to_free == NULL) {
+                               RTE_LOG(ERR, HASH, "ext bkt to free memory allocation "
+                                                               "failed\n");
+                               goto err_unlock;
+                       }
+               }
        }
 
        const uint32_t key_entry_size =
@@ -378,7 +381,7 @@ rte_hash_create(const struct rte_hash_parameters *params)
                default_hash_func = (rte_hash_function)rte_hash_crc;
 #endif
        /* Setup hash context */
-       snprintf(h->name, sizeof(h->name), "%s", params->name);
+       strlcpy(h->name, params->name, sizeof(h->name));
        h->entries = params->entries;
        h->key_len = params->key_len;
        h->key_entry_size = key_entry_size;
@@ -393,6 +396,7 @@ rte_hash_create(const struct rte_hash_parameters *params)
                default_hash_func : params->hash_func;
        h->key_store = k;
        h->free_slots = r;
+       h->ext_bkt_to_free = ext_bkt_to_free;
        h->tbl_chng_cnt = tbl_chng_cnt;
        *h->tbl_chng_cnt = 0;
        h->hw_trans_mem_support = hw_trans_mem_support;
@@ -407,6 +411,10 @@ rte_hash_create(const struct rte_hash_parameters *params)
        if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE2))
                h->sig_cmp_fn = RTE_HASH_COMPARE_SSE;
        else
+#elif defined(RTE_ARCH_ARM64)
+       if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_NEON))
+               h->sig_cmp_fn = RTE_HASH_COMPARE_NEON;
+       else
 #endif
                h->sig_cmp_fn = RTE_HASH_COMPARE_SCALAR;
 
@@ -443,6 +451,7 @@ err:
        rte_free(buckets_ext);
        rte_free(k);
        rte_free(tbl_chng_cnt);
+       rte_free(ext_bkt_to_free);
        return NULL;
 }
 
@@ -484,6 +493,7 @@ rte_hash_free(struct rte_hash *h)
        rte_free(h->buckets);
        rte_free(h->buckets_ext);
        rte_free(h->tbl_chng_cnt);
+       rte_free(h->ext_bkt_to_free);
        rte_free(h);
        rte_free(te);
 }
@@ -799,7 +809,7 @@ rte_hash_cuckoo_move_insert_mw(const struct rte_hash *h,
                        __atomic_store_n(h->tbl_chng_cnt,
                                         *h->tbl_chng_cnt + 1,
                                         __ATOMIC_RELEASE);
-                       /* The stores to sig_alt and sig_current should not
+                       /* The store to sig_current should not
                         * move above the store to tbl_chng_cnt.
                         */
                        __atomic_thread_fence(__ATOMIC_RELEASE);
@@ -831,7 +841,7 @@ rte_hash_cuckoo_move_insert_mw(const struct rte_hash *h,
                __atomic_store_n(h->tbl_chng_cnt,
                                 *h->tbl_chng_cnt + 1,
                                 __ATOMIC_RELEASE);
-               /* The stores to sig_alt and sig_current should not
+               /* The store to sig_current should not
                 * move above the store to tbl_chng_cnt.
                 */
                __atomic_thread_fence(__ATOMIC_RELEASE);
@@ -1054,7 +1064,12 @@ __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
                        /* Check if slot is available */
                        if (likely(cur_bkt->key_idx[i] == EMPTY_SLOT)) {
                                cur_bkt->sig_current[i] = short_sig;
-                               cur_bkt->key_idx[i] = new_idx;
+                               /* Store to signature should not leak after
+                                * the store to key_idx
+                                */
+                               __atomic_store_n(&cur_bkt->key_idx[i],
+                                                new_idx,
+                                                __ATOMIC_RELEASE);
                                __hash_rw_writer_unlock(h);
                                return new_idx - 1;
                        }
@@ -1072,7 +1087,12 @@ __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
        bkt_id = (uint32_t)((uintptr_t)ext_bkt_id) - 1;
        /* Use the first location of the new bucket */
        (h->buckets_ext[bkt_id]).sig_current[0] = short_sig;
-       (h->buckets_ext[bkt_id]).key_idx[0] = new_idx;
+       /* Store to signature should not leak after
+        * the store to key_idx
+        */
+       __atomic_store_n(&(h->buckets_ext[bkt_id]).key_idx[0],
+                        new_idx,
+                        __ATOMIC_RELEASE);
        /* Link the new bucket to sec bucket linked list */
        last = rte_hash_get_last_bkt(sec_bkt);
        last->next = &h->buckets_ext[bkt_id];
@@ -1347,6 +1367,9 @@ remove_entry(const struct rte_hash *h, struct rte_hash_bucket *bkt, unsigned i)
                        n_slots = rte_ring_mp_enqueue_burst(h->free_slots,
                                                cached_free_slots->objs,
                                                LCORE_CACHE_SIZE, NULL);
+                       ERR_IF_TRUE((n_slots == 0),
+                               "%s: could not enqueue free slots in global ring\n",
+                               __func__);
                        cached_free_slots->len -= n_slots;
                }
                /* Put index of new free slot in cache. */
@@ -1363,7 +1386,8 @@ remove_entry(const struct rte_hash *h, struct rte_hash_bucket *bkt, unsigned i)
  * empty slot.
  */
 static inline void
-__rte_hash_compact_ll(struct rte_hash_bucket *cur_bkt, int pos) {
+__rte_hash_compact_ll(const struct rte_hash *h,
+                       struct rte_hash_bucket *cur_bkt, int pos) {
        int i;
        struct rte_hash_bucket *last_bkt;
 
@@ -1374,10 +1398,27 @@ __rte_hash_compact_ll(struct rte_hash_bucket *cur_bkt, int pos) {
 
        for (i = RTE_HASH_BUCKET_ENTRIES - 1; i >= 0; i--) {
                if (last_bkt->key_idx[i] != EMPTY_SLOT) {
-                       cur_bkt->key_idx[pos] = last_bkt->key_idx[i];
                        cur_bkt->sig_current[pos] = last_bkt->sig_current[i];
+                       __atomic_store_n(&cur_bkt->key_idx[pos],
+                                        last_bkt->key_idx[i],
+                                        __ATOMIC_RELEASE);
+                       if (h->readwrite_concur_lf_support) {
+                               /* Inform the readers that the table has changed
+                                * Since there is one writer, load acquire on
+                                * tbl_chng_cnt is not required.
+                                */
+                               __atomic_store_n(h->tbl_chng_cnt,
+                                        *h->tbl_chng_cnt + 1,
+                                        __ATOMIC_RELEASE);
+                               /* The store to sig_current should
+                                * not move above the store to tbl_chng_cnt.
+                                */
+                               __atomic_thread_fence(__ATOMIC_RELEASE);
+                       }
                        last_bkt->sig_current[i] = NULL_SIGNATURE;
-                       last_bkt->key_idx[i] = EMPTY_SLOT;
+                       __atomic_store_n(&last_bkt->key_idx[i],
+                                        EMPTY_SLOT,
+                                        __ATOMIC_RELEASE);
                        return;
                }
        }
@@ -1446,7 +1487,7 @@ __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
        /* look for key in primary bucket */
        ret = search_and_remove(h, key, prim_bkt, short_sig, &pos);
        if (ret != -1) {
-               __rte_hash_compact_ll(prim_bkt, pos);
+               __rte_hash_compact_ll(h, prim_bkt, pos);
                last_bkt = prim_bkt->next;
                prev_bkt = prim_bkt;
                goto return_bkt;
@@ -1458,7 +1499,7 @@ __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
        FOR_EACH_BUCKET(cur_bkt, sec_bkt) {
                ret = search_and_remove(h, key, cur_bkt, short_sig, &pos);
                if (ret != -1) {
-                       __rte_hash_compact_ll(cur_bkt, pos);
+                       __rte_hash_compact_ll(h, cur_bkt, pos);
                        last_bkt = sec_bkt->next;
                        prev_bkt = sec_bkt;
                        goto return_bkt;
@@ -1485,11 +1526,24 @@ return_bkt:
        }
        /* found empty bucket and recycle */
        if (i == RTE_HASH_BUCKET_ENTRIES) {
-               prev_bkt->next = last_bkt->next = NULL;
+               prev_bkt->next = NULL;
                uint32_t index = last_bkt - h->buckets_ext + 1;
-               rte_ring_sp_enqueue(h->free_ext_bkts, (void *)(uintptr_t)index);
+               /* Recycle the empty bkt if
+                * no_free_on_del is disabled.
+                */
+               if (h->no_free_on_del)
+                       /* Store index of an empty ext bkt to be recycled
+                        * on calling rte_hash_del_xxx APIs.
+                        * When lock free read-write concurrency is enabled,
+                        * an empty ext bkt cannot be put into free list
+                        * immediately (as readers might be using it still).
+                        * Hence freeing of the ext bkt is piggy-backed to
+                        * freeing of the key index.
+                        */
+                       h->ext_bkt_to_free[ret] = index;
+               else
+                       rte_ring_sp_enqueue(h->free_ext_bkts, (void *)(uintptr_t)index);
        }
-
        __hash_rw_writer_unlock(h);
        return ret;
 }
@@ -1529,19 +1583,32 @@ rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
        return 0;
 }
 
-int __rte_experimental
+int
 rte_hash_free_key_with_position(const struct rte_hash *h,
                                const int32_t position)
 {
-       RETURN_IF_TRUE(((h == NULL) || (position == EMPTY_SLOT)), -EINVAL);
+       /* Key index where key is stored, adding the first dummy index */
+       uint32_t key_idx = position + 1;
+
+       RETURN_IF_TRUE(((h == NULL) || (key_idx == EMPTY_SLOT)), -EINVAL);
 
        unsigned int lcore_id, n_slots;
        struct lcore_cache *cached_free_slots;
-       const int32_t total_entries = h->num_buckets * RTE_HASH_BUCKET_ENTRIES;
+       const uint32_t total_entries = h->use_local_cache ?
+               h->entries + (RTE_MAX_LCORE - 1) * (LCORE_CACHE_SIZE - 1) + 1
+                                                       : h->entries + 1;
 
        /* Out of bounds */
-       if (position >= total_entries)
+       if (key_idx >= total_entries)
                return -EINVAL;
+       if (h->ext_table_support && h->readwrite_concur_lf_support) {
+               uint32_t index = h->ext_bkt_to_free[position];
+               if (index) {
+                       /* Recycle empty ext bkt to free list. */
+                       rte_ring_sp_enqueue(h->free_ext_bkts, (void *)(uintptr_t)index);
+                       h->ext_bkt_to_free[position] = 0;
+               }
+       }
 
        if (h->use_local_cache) {
                lcore_id = rte_lcore_id();
@@ -1552,15 +1619,16 @@ rte_hash_free_key_with_position(const struct rte_hash *h,
                        n_slots = rte_ring_mp_enqueue_burst(h->free_slots,
                                                cached_free_slots->objs,
                                                LCORE_CACHE_SIZE, NULL);
+                       RETURN_IF_TRUE((n_slots == 0), -EFAULT);
                        cached_free_slots->len -= n_slots;
                }
                /* Put index of new free slot in cache. */
                cached_free_slots->objs[cached_free_slots->len] =
-                                       (void *)((uintptr_t)position);
+                                       (void *)((uintptr_t)key_idx);
                cached_free_slots->len++;
        } else {
                rte_ring_sp_enqueue(h->free_slots,
-                               (void *)((uintptr_t)position));
+                               (void *)((uintptr_t)key_idx));
        }
 
        return 0;
@@ -1577,7 +1645,7 @@ compare_signatures(uint32_t *prim_hash_matches, uint32_t *sec_hash_matches,
 
        /* For match mask the first bit of every two bits indicates the match */
        switch (sig_cmp_fn) {
-#ifdef RTE_MACHINE_CPUFLAG_SSE2
+#if defined(RTE_MACHINE_CPUFLAG_SSE2)
        case RTE_HASH_COMPARE_SSE:
                /* Compare all signatures in the bucket */
                *prim_hash_matches = _mm_movemask_epi8(_mm_cmpeq_epi16(
@@ -1590,6 +1658,24 @@ compare_signatures(uint32_t *prim_hash_matches, uint32_t *sec_hash_matches,
                                        (__m128i const *)sec_bkt->sig_current),
                                _mm_set1_epi16(sig)));
                break;
+#elif defined(RTE_MACHINE_CPUFLAG_NEON)
+       case RTE_HASH_COMPARE_NEON: {
+               uint16x8_t vmat, vsig, x;
+               int16x8_t shift = {-15, -13, -11, -9, -7, -5, -3, -1};
+
+               vsig = vld1q_dup_u16((uint16_t const *)&sig);
+               /* Compare all signatures in the primary bucket */
+               vmat = vceqq_u16(vsig,
+                       vld1q_u16((uint16_t const *)prim_bkt->sig_current));
+               x = vshlq_u16(vandq_u16(vmat, vdupq_n_u16(0x8000)), shift);
+               *prim_hash_matches = (uint32_t)(vaddvq_u16(x));
+               /* Compare all signatures in the secondary bucket */
+               vmat = vceqq_u16(vsig,
+                       vld1q_u16((uint16_t const *)sec_bkt->sig_current));
+               x = vshlq_u16(vandq_u16(vmat, vdupq_n_u16(0x8000)), shift);
+               *sec_hash_matches = (uint32_t)(vaddvq_u16(x));
+               }
+               break;
 #endif
        default:
                for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
@@ -1851,6 +1937,9 @@ __rte_hash_lookup_bulk_lf(const struct rte_hash *h, const void **keys,
                rte_prefetch0(secondary_bkt[i]);
        }
 
+       for (i = 0; i < num_keys; i++)
+               positions[i] = -ENOENT;
+
        do {
                /* Load the table change counter before the lookup
                 * starts. Acquire semantics will make sure that
@@ -1895,7 +1984,6 @@ __rte_hash_lookup_bulk_lf(const struct rte_hash *h, const void **keys,
 
                /* Compare keys, first hits in primary first */
                for (i = 0; i < num_keys; i++) {
-                       positions[i] = -ENOENT;
                        while (prim_hitmask[i]) {
                                uint32_t hit_index =
                                                __builtin_ctzl(prim_hitmask[i])
@@ -1968,6 +2056,35 @@ next_key:
                        continue;
                }
 
+               /* all found, do not need to go through ext bkt */
+               if (hits == ((1ULL << num_keys) - 1)) {
+                       if (hit_mask != NULL)
+                               *hit_mask = hits;
+                       return;
+               }
+               /* need to check ext buckets for match */
+               if (h->ext_table_support) {
+                       for (i = 0; i < num_keys; i++) {
+                               if ((hits & (1ULL << i)) != 0)
+                                       continue;
+                               next_bkt = secondary_bkt[i]->next;
+                               FOR_EACH_BUCKET(cur_bkt, next_bkt) {
+                                       if (data != NULL)
+                                               ret = search_one_bucket_lf(h,
+                                                       keys[i], sig[i],
+                                                       &data[i], cur_bkt);
+                                       else
+                                               ret = search_one_bucket_lf(h,
+                                                               keys[i], sig[i],
+                                                               NULL, cur_bkt);
+                                       if (ret != -1) {
+                                               positions[i] = ret;
+                                               hits |= 1ULL << i;
+                                               break;
+                                       }
+                               }
+                       }
+               }
                /* The loads of sig_current in compare_signatures
                 * should not move below the load from tbl_chng_cnt.
                 */
@@ -1984,34 +2101,6 @@ next_key:
                                        __ATOMIC_ACQUIRE);
        } while (cnt_b != cnt_a);
 
-       /* all found, do not need to go through ext bkt */
-       if ((hits == ((1ULL << num_keys) - 1)) || !h->ext_table_support) {
-               if (hit_mask != NULL)
-                       *hit_mask = hits;
-               __hash_rw_reader_unlock(h);
-               return;
-       }
-
-       /* need to check ext buckets for match */
-       for (i = 0; i < num_keys; i++) {
-               if ((hits & (1ULL << i)) != 0)
-                       continue;
-               next_bkt = secondary_bkt[i]->next;
-               FOR_EACH_BUCKET(cur_bkt, next_bkt) {
-                       if (data != NULL)
-                               ret = search_one_bucket_lf(h, keys[i],
-                                               sig[i], &data[i], cur_bkt);
-                       else
-                               ret = search_one_bucket_lf(h, keys[i],
-                                               sig[i], NULL, cur_bkt);
-                       if (ret != -1) {
-                               positions[i] = ret;
-                               hits |= 1ULL << i;
-                               break;
-                       }
-               }
-       }
-
        if (hit_mask != NULL)
                *hit_mask = hits;
 }
@@ -2022,11 +2111,11 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
                        uint64_t *hit_mask, void *data[])
 {
        if (h->readwrite_concur_lf_support)
-               return __rte_hash_lookup_bulk_lf(h, keys, num_keys,
-                                               positions, hit_mask, data);
+               __rte_hash_lookup_bulk_lf(h, keys, num_keys, positions,
+                                         hit_mask, data);
        else
-               return __rte_hash_lookup_bulk_l(h, keys, num_keys,
-                                               positions, hit_mask, data);
+               __rte_hash_lookup_bulk_l(h, keys, num_keys, positions,
+                                        hit_mask, data);
 }
 
 int