net/mlx5: handle Rx CQE compression
[dpdk.git] / lib / librte_hash / rte_cuckoo_hash.c
index 15c5da5..e3cc3a7 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  *
- *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
  *   All rights reserved.
  *
  *   Redistribution and use in source and binary forms, with or without
 #include <rte_rwlock.h>
 #include <rte_spinlock.h>
 #include <rte_ring.h>
+#include <rte_compat.h>
 
 #include "rte_hash.h"
+#include "rte_cuckoo_hash.h"
+
+#if defined(RTE_ARCH_X86)
+#include "rte_cuckoo_hash_x86.h"
+#endif
 
 TAILQ_HEAD(rte_hash_list, rte_tailq_entry);
 
@@ -66,80 +72,6 @@ static struct rte_tailq_elem rte_hash_tailq = {
 };
 EAL_REGISTER_TAILQ(rte_hash_tailq)
 
-/* Macro to enable/disable run-time checking of function parameters */
-#if defined(RTE_LIBRTE_HASH_DEBUG)
-#define RETURN_IF_TRUE(cond, retval) do { \
-       if (cond) \
-               return retval; \
-} while (0)
-#else
-#define RETURN_IF_TRUE(cond, retval)
-#endif
-
-/* Hash function used if none is specified */
-#ifdef RTE_MACHINE_CPUFLAG_SSE4_2
-#include <rte_hash_crc.h>
-#define DEFAULT_HASH_FUNC       rte_hash_crc
-#else
-#include <rte_jhash.h>
-#define DEFAULT_HASH_FUNC       rte_jhash
-#endif
-
-/** Number of items per bucket. */
-#define RTE_HASH_BUCKET_ENTRIES                4
-
-#define NULL_SIGNATURE                 0
-
-typedef int (*rte_hash_cmp_eq_t)(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k16_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k32_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k48_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k64_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k80_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k96_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k112_cmp_eq(const void *key1, const void *key2, size_t key_len);
-static int rte_hash_k128_cmp_eq(const void *key1, const void *key2, size_t key_len);
-
-/** A hash table structure. */
-struct rte_hash {
-       char name[RTE_HASH_NAMESIZE];   /**< Name of the hash. */
-       uint32_t entries;               /**< Total table entries. */
-       uint32_t num_buckets;           /**< Number of buckets in table. */
-       uint32_t key_len;               /**< Length of hash key. */
-       rte_hash_function hash_func;    /**< Function used to calculate hash. */
-       rte_hash_cmp_eq_t rte_hash_cmp_eq; /**< Function used to compare keys. */
-       uint32_t hash_func_init_val;    /**< Init value used by hash_func. */
-       uint32_t bucket_bitmask;        /**< Bitmask for getting bucket index
-                                               from hash signature. */
-       uint32_t key_entry_size;         /**< Size of each key entry. */
-
-       struct rte_ring *free_slots;    /**< Ring that stores all indexes
-                                               of the free slots in the key table */
-       void *key_store;                /**< Table storing all keys and data */
-       struct rte_hash_bucket *buckets;        /**< Table with buckets storing all the
-                                                       hash values and key indexes
-                                                       to the key table*/
-} __rte_cache_aligned;
-
-/* Structure storing both primary and secondary hashes */
-struct rte_hash_signatures {
-       union {
-               struct {
-                       hash_sig_t current;
-                       hash_sig_t alt;
-               };
-               uint64_t sig;
-       };
-};
-
-/** Bucket structure */
-struct rte_hash_bucket {
-       struct rte_hash_signatures signatures[RTE_HASH_BUCKET_ENTRIES];
-       /* Includes dummy key index that always contains index 0 */
-       uint32_t key_idx[RTE_HASH_BUCKET_ENTRIES + 1];
-       uint8_t flag[RTE_HASH_BUCKET_ENTRIES];
-} __rte_cache_aligned;
-
 struct rte_hash *
 rte_hash_find_existing(const char *name)
 {
@@ -164,6 +96,20 @@ rte_hash_find_existing(const char *name)
        return h;
 }
 
+void rte_hash_set_cmp_func(struct rte_hash *h, rte_hash_cmp_eq_t func)
+{
+       h->rte_hash_custom_cmp_eq = func;
+}
+
+static inline int
+rte_hash_cmp_eq(const void *key1, const void *key2, const struct rte_hash *h)
+{
+       if (h->cmp_jump_table_idx == KEY_CUSTOM)
+               return h->rte_hash_custom_cmp_eq(key1, key2, h->key_len);
+       else
+               return cmp_jump_table[h->cmp_jump_table_idx](key1, key2, h->key_len);
+}
+
 struct rte_hash *
 rte_hash_create(const struct rte_hash_parameters *params)
 {
@@ -172,9 +118,11 @@ rte_hash_create(const struct rte_hash_parameters *params)
        struct rte_hash_list *hash_list;
        struct rte_ring *r = NULL;
        char hash_name[RTE_HASH_NAMESIZE];
-       void *ptr, *k = NULL;
+       void *k = NULL;
        void *buckets = NULL;
        char ring_name[RTE_RING_NAMESIZE];
+       unsigned num_key_slots;
+       unsigned hw_trans_mem_support = 0;
        unsigned i;
 
        hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
@@ -194,17 +142,52 @@ rte_hash_create(const struct rte_hash_parameters *params)
                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;
+
+       /* Store all keys and leave the first entry as a dummy entry for lookup_bulk */
+       if (hw_trans_mem_support)
+               /*
+                * Increase number of slots by total number of indices
+                * that can be stored in the lcore caches
+                * except for the first cache
+                */
+               num_key_slots = params->entries + (RTE_MAX_LCORE - 1) *
+                                       LCORE_CACHE_SIZE + 1;
+       else
+               num_key_slots = params->entries + 1;
+
+       snprintf(ring_name, sizeof(ring_name), "HT_%s", params->name);
+       r = rte_ring_create(ring_name, rte_align32pow2(num_key_slots),
+                       params->socket_id, 0);
+       if (r == NULL) {
+               RTE_LOG(ERR, HASH, "memory allocation failed\n");
+               goto err;
+       }
+
        snprintf(hash_name, sizeof(hash_name), "HT_%s", params->name);
 
-       /* Guarantee there's no existing */
-       h = rte_hash_find_existing(params->name);
-       if (h != NULL)
-               return h;
+       rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
+
+       /* guarantee there's no existing: this is normally already checked
+        * by ring creation above */
+       TAILQ_FOREACH(te, hash_list, next) {
+               h = (struct rte_hash *) te->data;
+               if (strncmp(params->name, h->name, RTE_HASH_NAMESIZE) == 0)
+                       break;
+       }
+       h = NULL;
+       if (te != NULL) {
+               rte_errno = EEXIST;
+               te = NULL;
+               goto err_unlock;
+       }
 
        te = rte_zmalloc("HASH_TAILQ_ENTRY", sizeof(*te), 0);
        if (te == NULL) {
                RTE_LOG(ERR, HASH, "tailq entry allocation failed\n");
-               goto err;
+               goto err_unlock;
        }
 
        h = (struct rte_hash *)rte_zmalloc_socket(hash_name, sizeof(struct rte_hash),
@@ -212,7 +195,7 @@ rte_hash_create(const struct rte_hash_parameters *params)
 
        if (h == NULL) {
                RTE_LOG(ERR, HASH, "memory allocation failed\n");
-               goto err;
+               goto err_unlock;
        }
 
        const uint32_t num_buckets = rte_align32pow2(params->entries)
@@ -224,64 +207,63 @@ rte_hash_create(const struct rte_hash_parameters *params)
 
        if (buckets == NULL) {
                RTE_LOG(ERR, HASH, "memory allocation failed\n");
-               goto err;
+               goto err_unlock;
        }
 
-       const uint32_t key_entry_size = params->key_len;
-       /* Store all keys and leave the first entry as a dummy entry for lookup_bulk */
-       const uint64_t key_tbl_size = key_entry_size * (params->entries + 1);
+       const uint32_t key_entry_size = sizeof(struct rte_hash_key) + params->key_len;
+       const uint64_t key_tbl_size = (uint64_t) key_entry_size * num_key_slots;
 
        k = rte_zmalloc_socket(NULL, key_tbl_size,
                        RTE_CACHE_LINE_SIZE, params->socket_id);
 
        if (k == NULL) {
                RTE_LOG(ERR, HASH, "memory allocation failed\n");
-               goto err;
+               goto err_unlock;
        }
 
+/*
+ * If x86 architecture is used, select appropriate compare function,
+ * which may use x86 intrinsics, otherwise use memcmp
+ */
+#if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64)
        /* Select function to compare keys */
        switch (params->key_len) {
        case 16:
-               h->rte_hash_cmp_eq = rte_hash_k16_cmp_eq;
+               h->cmp_jump_table_idx = KEY_16_BYTES;
                break;
        case 32:
-               h->rte_hash_cmp_eq = rte_hash_k32_cmp_eq;
+               h->cmp_jump_table_idx = KEY_32_BYTES;
                break;
        case 48:
-               h->rte_hash_cmp_eq = rte_hash_k48_cmp_eq;
+               h->cmp_jump_table_idx = KEY_48_BYTES;
                break;
        case 64:
-               h->rte_hash_cmp_eq = rte_hash_k64_cmp_eq;
+               h->cmp_jump_table_idx = KEY_64_BYTES;
                break;
        case 80:
-               h->rte_hash_cmp_eq = rte_hash_k80_cmp_eq;
+               h->cmp_jump_table_idx = KEY_80_BYTES;
                break;
        case 96:
-               h->rte_hash_cmp_eq = rte_hash_k96_cmp_eq;
+               h->cmp_jump_table_idx = KEY_96_BYTES;
                break;
        case 112:
-               h->rte_hash_cmp_eq = rte_hash_k112_cmp_eq;
+               h->cmp_jump_table_idx = KEY_112_BYTES;
                break;
        case 128:
-               h->rte_hash_cmp_eq = rte_hash_k128_cmp_eq;
+               h->cmp_jump_table_idx = KEY_128_BYTES;
                break;
        default:
                /* If key is not multiple of 16, use generic memcmp */
-               h->rte_hash_cmp_eq = memcmp;
+               h->cmp_jump_table_idx = KEY_OTHER_BYTES;
        }
+#else
+       h->cmp_jump_table_idx = KEY_OTHER_BYTES;
+#endif
 
-       snprintf(ring_name, sizeof(ring_name), "HT_%s", params->name);
-       r = rte_ring_lookup(ring_name);
-       if (r != NULL) {
-               /* clear the free ring */
-               while (rte_ring_dequeue(r, &ptr) == 0)
-                       rte_pause();
-       } else
-               r = rte_ring_create(ring_name, rte_align32pow2(params->entries + 1),
-                               params->socket_id, 0);
-       if (r == NULL) {
-               RTE_LOG(ERR, HASH, "memory allocation failed\n");
-               goto err;
+       if (hw_trans_mem_support) {
+               h->local_free_slots = rte_zmalloc_socket(NULL,
+                               sizeof(struct lcore_cache) * RTE_MAX_LCORE,
+                               RTE_CACHE_LINE_SIZE, params->socket_id);
        }
 
        /* Setup hash context */
@@ -296,21 +278,39 @@ rte_hash_create(const struct rte_hash_parameters *params)
        h->buckets = buckets;
        h->hash_func = (params->hash_func == NULL) ?
                DEFAULT_HASH_FUNC : params->hash_func;
-
        h->key_store = k;
        h->free_slots = r;
+       h->hw_trans_mem_support = hw_trans_mem_support;
 
-       /* populate the free slots ring. Entry zero is reserved for key misses */
+       /* Turn on multi-writer only with explicit flat from user and TM
+        * support.
+        */
+       if (params->extra_flag & RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD) {
+               if (h->hw_trans_mem_support) {
+                       h->add_key = ADD_KEY_MULTIWRITER_TM;
+               } else {
+                       h->add_key = ADD_KEY_MULTIWRITER;
+                       h->multiwriter_lock = rte_malloc(NULL,
+                                                       sizeof(rte_spinlock_t),
+                                                       LCORE_CACHE_SIZE);
+                       rte_spinlock_init(h->multiwriter_lock);
+               }
+       } else
+               h->add_key = ADD_KEY_SINGLEWRITER;
+
+       /* Populate free slots ring. Entry zero is reserved for key misses. */
        for (i = 1; i < params->entries + 1; i++)
                rte_ring_sp_enqueue(r, (void *)((uintptr_t) i));
 
-       rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
        te->data = (void *) h;
        TAILQ_INSERT_TAIL(hash_list, te, next);
        rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 
        return h;
+err_unlock:
+       rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 err:
+       rte_ring_free(r);
        rte_free(te);
        rte_free(h);
        rte_free(buckets);
@@ -346,6 +346,12 @@ rte_hash_free(struct rte_hash *h)
 
        rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 
+       if (h->hw_trans_mem_support)
+               rte_free(h->local_free_slots);
+
+       if (h->add_key == ADD_KEY_MULTIWRITER)
+               rte_free(h->multiwriter_lock);
+       rte_ring_free(h->free_slots);
        rte_free(h->key_store);
        rte_free(h->buckets);
        rte_free(h);
@@ -368,7 +374,7 @@ rte_hash_secondary_hash(const hash_sig_t primary_hash)
 
        uint32_t tag = primary_hash >> all_bits_shift;
 
-       return (primary_hash ^ ((tag + 1) * alt_bits_xor));
+       return primary_hash ^ ((tag + 1) * alt_bits_xor);
 }
 
 void
@@ -390,6 +396,12 @@ rte_hash_reset(struct rte_hash *h)
        /* Repopulate the free slots ring. Entry zero is reserved for key misses */
        for (i = 1; i < h->entries + 1; i++)
                rte_ring_sp_enqueue(h->free_slots, (void *)((uintptr_t) i));
+
+       if (h->hw_trans_mem_support) {
+               /* Reset local caches per lcore */
+               for (i = 0; i < RTE_MAX_LCORE; i++)
+                       h->local_free_slots[i].len = 0;
+       }
 }
 
 /* Search for an entry that can be pushed to its alternative location */
@@ -432,11 +444,8 @@ make_space_bucket(const struct rte_hash *h, struct rte_hash_bucket *bkt)
                        break;
 
        /* All entries have been pushed, so entry cannot be added */
-       if (i == RTE_HASH_BUCKET_ENTRIES) {
-               /* Reset flag */
-               bkt->flag[i] = 0;
+       if (i == RTE_HASH_BUCKET_ENTRIES)
                return -ENOSPC;
-       }
 
        /* Set flag to indicate that this entry is going to be pushed */
        bkt->flag[i] = 1;
@@ -459,18 +468,41 @@ make_space_bucket(const struct rte_hash *h, struct rte_hash_bucket *bkt)
 
 }
 
+/*
+ * Function called to enqueue back an index in the cache/ring,
+ * as slot has not being used and it can be used in the
+ * next addition attempt.
+ */
+static inline void
+enqueue_slot_back(const struct rte_hash *h,
+               struct lcore_cache *cached_free_slots,
+               void *slot_id)
+{
+       if (h->hw_trans_mem_support) {
+               cached_free_slots->objs[cached_free_slots->len] = slot_id;
+               cached_free_slots->len++;
+       } else
+               rte_ring_sp_enqueue(h->free_slots, slot_id);
+}
+
 static inline int32_t
 __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
-                                               hash_sig_t sig)
+                                               hash_sig_t sig, void *data)
 {
        hash_sig_t alt_hash;
        uint32_t prim_bucket_idx, sec_bucket_idx;
        unsigned i;
        struct rte_hash_bucket *prim_bkt, *sec_bkt;
-       void *new_k, *k, *keys = h->key_store;
-       void *slot_id;
+       struct rte_hash_key *new_k, *k, *keys = h->key_store;
+       void *slot_id = NULL;
        uint32_t new_idx;
        int ret;
+       unsigned n_slots;
+       unsigned lcore_id;
+       struct lcore_cache *cached_free_slots = NULL;
+
+       if (h->add_key == ADD_KEY_MULTIWRITER)
+               rte_spinlock_lock(h->multiwriter_lock);
 
        prim_bucket_idx = sig & h->bucket_bitmask;
        prim_bkt = &h->buckets[prim_bucket_idx];
@@ -482,8 +514,28 @@ __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
        rte_prefetch0(sec_bkt);
 
        /* Get a new slot for storing the new key */
-       if (rte_ring_sc_dequeue(h->free_slots, &slot_id) != 0)
-               return -ENOSPC;
+       if (h->hw_trans_mem_support) {
+               lcore_id = rte_lcore_id();
+               cached_free_slots = &h->local_free_slots[lcore_id];
+               /* Try to get a free slot from the local cache */
+               if (cached_free_slots->len == 0) {
+                       /* Need to get another burst of free slots from global ring */
+                       n_slots = rte_ring_mc_dequeue_burst(h->free_slots,
+                                       cached_free_slots->objs, LCORE_CACHE_SIZE);
+                       if (n_slots == 0)
+                               return -ENOSPC;
+
+                       cached_free_slots->len += n_slots;
+               }
+
+               /* Get a free slot from the local cache */
+               cached_free_slots->len--;
+               slot_id = cached_free_slots->objs[cached_free_slots->len];
+       } else {
+               if (rte_ring_sc_dequeue(h->free_slots, &slot_id) != 0)
+                       return -ENOSPC;
+       }
+
        new_k = RTE_PTR_ADD(keys, (uintptr_t)slot_id * h->key_entry_size);
        rte_prefetch0(new_k);
        new_idx = (uint32_t)((uintptr_t) slot_id);
@@ -491,15 +543,19 @@ __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
        /* Check if key is already inserted in primary location */
        for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
                if (prim_bkt->signatures[i].current == sig &&
-                               prim_bkt->signatures[i].alt == alt_hash)  {
-                       k = (char *)keys + prim_bkt->key_idx[i] * h->key_entry_size;
-                       if (h->rte_hash_cmp_eq(key, k, h->key_len) == 0) {
-                               rte_ring_sp_enqueue(h->free_slots, &slot_id);
+                               prim_bkt->signatures[i].alt == alt_hash) {
+                       k = (struct rte_hash_key *) ((char *)keys +
+                                       prim_bkt->key_idx[i] * h->key_entry_size);
+                       if (rte_hash_cmp_eq(key, k->key, h) == 0) {
+                               /* Enqueue index of free slot back in the ring. */
+                               enqueue_slot_back(h, cached_free_slots, slot_id);
+                               /* Update data */
+                               k->pdata = data;
                                /*
                                 * Return index where key is stored,
                                 * substracting the first dummy index
                                 */
-                               return (prim_bkt->key_idx[i] - 1);
+                               return prim_bkt->key_idx[i] - 1;
                        }
                }
        }
@@ -507,53 +563,89 @@ __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
        /* Check if key is already inserted in secondary location */
        for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
                if (sec_bkt->signatures[i].alt == sig &&
-                               sec_bkt->signatures[i].current == alt_hash)  {
-                       k = (char *)keys + sec_bkt->key_idx[i] * h->key_entry_size;
-                       if (h->rte_hash_cmp_eq(key, k, h->key_len) == 0) {
-                               rte_ring_sp_enqueue(h->free_slots, &slot_id);
+                               sec_bkt->signatures[i].current == alt_hash) {
+                       k = (struct rte_hash_key *) ((char *)keys +
+                                       sec_bkt->key_idx[i] * h->key_entry_size);
+                       if (rte_hash_cmp_eq(key, k->key, h) == 0) {
+                               /* Enqueue index of free slot back in the ring. */
+                               enqueue_slot_back(h, cached_free_slots, slot_id);
+                               /* Update data */
+                               k->pdata = data;
                                /*
                                 * Return index where key is stored,
                                 * substracting the first dummy index
                                 */
-                               return (sec_bkt->key_idx[i] - 1);
+                               return sec_bkt->key_idx[i] - 1;
                        }
                }
        }
 
        /* Copy key */
-       rte_memcpy(new_k, key, h->key_len);
+       rte_memcpy(new_k->key, key, h->key_len);
+       new_k->pdata = data;
+
+#if defined(RTE_ARCH_X86) /* currently only x86 support HTM */
+       if (h->add_key == ADD_KEY_MULTIWRITER_TM) {
+               ret = rte_hash_cuckoo_insert_mw_tm(prim_bkt,
+                               sig, alt_hash, new_idx);
+               if (ret >= 0)
+                       return new_idx - 1;
 
-       /* Insert new entry is there is room in the primary bucket */
-       for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
-               /* Check if slot is available */
-               if (likely(prim_bkt->signatures[i].sig == NULL_SIGNATURE)) {
-                       prim_bkt->signatures[i].current = sig;
-                       prim_bkt->signatures[i].alt = alt_hash;
-                       prim_bkt->key_idx[i] = new_idx;
+               /* Primary bucket full, need to make space for new entry */
+               ret = rte_hash_cuckoo_make_space_mw_tm(h, prim_bkt, sig,
+                                                       alt_hash, new_idx);
+
+               if (ret >= 0)
+                       return new_idx - 1;
+
+               /* Also search secondary bucket to get better occupancy */
+               ret = rte_hash_cuckoo_make_space_mw_tm(h, sec_bkt, sig,
+                                                       alt_hash, new_idx);
+
+               if (ret >= 0)
                        return new_idx - 1;
+       } else {
+#endif
+               for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
+                       /* Check if slot is available */
+                       if (likely(prim_bkt->signatures[i].sig == NULL_SIGNATURE)) {
+                               prim_bkt->signatures[i].current = sig;
+                               prim_bkt->signatures[i].alt = alt_hash;
+                               prim_bkt->key_idx[i] = new_idx;
+                               break;
+                       }
                }
-       }
 
-       /* Primary bucket is full, so we need to make space for new entry */
-       ret = make_space_bucket(h, prim_bkt);
-       /*
-        * After recursive function.
-        * Insert the new entry in the position of the pushed entry
-        * if successful or return error and
-        * store the new slot back in the ring
-        */
-       if (ret >= 0) {
-               prim_bkt->signatures[ret].current = sig;
-               prim_bkt->signatures[ret].alt = alt_hash;
-               prim_bkt->key_idx[ret] = new_idx;
-               return (new_idx - 1);
-       }
+               if (i != RTE_HASH_BUCKET_ENTRIES) {
+                       if (h->add_key == ADD_KEY_MULTIWRITER)
+                               rte_spinlock_unlock(h->multiwriter_lock);
+                       return new_idx - 1;
+               }
 
+               /* Primary bucket full, need to make space for new entry
+                * After recursive function.
+                * Insert the new entry in the position of the pushed entry
+                * if successful or return error and
+                * store the new slot back in the ring
+                */
+               ret = make_space_bucket(h, prim_bkt);
+               if (ret >= 0) {
+                       prim_bkt->signatures[ret].current = sig;
+                       prim_bkt->signatures[ret].alt = alt_hash;
+                       prim_bkt->key_idx[ret] = new_idx;
+                       if (h->add_key == ADD_KEY_MULTIWRITER)
+                               rte_spinlock_unlock(h->multiwriter_lock);
+                       return new_idx - 1;
+               }
+#if defined(RTE_ARCH_X86)
+       }
+#endif
        /* Error in addition, store new slot back in the ring and return error */
-       rte_ring_sp_enqueue(h->free_slots,
-               (void *)((uintptr_t) new_idx));
-       return ret;
+       enqueue_slot_back(h, cached_free_slots, (void *)((uintptr_t) new_idx));
 
+       if (h->add_key == ADD_KEY_MULTIWRITER)
+               rte_spinlock_unlock(h->multiwriter_lock);
+       return ret;
 }
 
 int32_t
@@ -561,25 +653,52 @@ rte_hash_add_key_with_hash(const struct rte_hash *h,
                        const void *key, hash_sig_t sig)
 {
        RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
-       return __rte_hash_add_key_with_hash(h, key, sig);
+       return __rte_hash_add_key_with_hash(h, key, sig, 0);
 }
 
 int32_t
 rte_hash_add_key(const struct rte_hash *h, const void *key)
 {
        RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
-       return __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key));
+       return __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), 0);
+}
+
+int
+rte_hash_add_key_with_hash_data(const struct rte_hash *h,
+                       const void *key, hash_sig_t sig, void *data)
+{
+       int ret;
+
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       ret = __rte_hash_add_key_with_hash(h, key, sig, data);
+       if (ret >= 0)
+               return 0;
+       else
+               return ret;
 }
 
+int
+rte_hash_add_key_data(const struct rte_hash *h, const void *key, void *data)
+{
+       int ret;
+
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+
+       ret = __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), data);
+       if (ret >= 0)
+               return 0;
+       else
+               return ret;
+}
 static inline int32_t
 __rte_hash_lookup_with_hash(const struct rte_hash *h, const void *key,
-                                       hash_sig_t sig)
+                                       hash_sig_t sig, void **data)
 {
        uint32_t bucket_idx;
        hash_sig_t alt_hash;
        unsigned i;
        struct rte_hash_bucket *bkt;
-       void *k, *keys = h->key_store;
+       struct rte_hash_key *k, *keys = h->key_store;
 
        bucket_idx = sig & h->bucket_bitmask;
        bkt = &h->buckets[bucket_idx];
@@ -588,13 +707,17 @@ __rte_hash_lookup_with_hash(const struct rte_hash *h, const void *key,
        for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
                if (bkt->signatures[i].current == sig &&
                                bkt->signatures[i].sig != NULL_SIGNATURE) {
-                       k = (char *)keys + bkt->key_idx[i] * h->key_entry_size;
-                       if (h->rte_hash_cmp_eq(key, k, h->key_len) == 0)
+                       k = (struct rte_hash_key *) ((char *)keys +
+                                       bkt->key_idx[i] * h->key_entry_size);
+                       if (rte_hash_cmp_eq(key, k->key, h) == 0) {
+                               if (data != NULL)
+                                       *data = k->pdata;
                                /*
                                 * Return index where key is stored,
                                 * substracting the first dummy index
                                 */
-                               return (bkt->key_idx[i] - 1);
+                               return bkt->key_idx[i] - 1;
+                       }
                }
        }
 
@@ -607,13 +730,17 @@ __rte_hash_lookup_with_hash(const struct rte_hash *h, const void *key,
        for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
                if (bkt->signatures[i].current == alt_hash &&
                                bkt->signatures[i].alt == sig) {
-                       k = (char *)keys + bkt->key_idx[i] * h->key_entry_size;
-                       if (h->rte_hash_cmp_eq(key, k, h->key_len) == 0)
+                       k = (struct rte_hash_key *) ((char *)keys +
+                                       bkt->key_idx[i] * h->key_entry_size);
+                       if (rte_hash_cmp_eq(key, k->key, h) == 0) {
+                               if (data != NULL)
+                                       *data = k->pdata;
                                /*
                                 * Return index where key is stored,
                                 * substracting the first dummy index
                                 */
-                               return (bkt->key_idx[i] - 1);
+                               return bkt->key_idx[i] - 1;
+                       }
                }
        }
 
@@ -625,14 +752,57 @@ rte_hash_lookup_with_hash(const struct rte_hash *h,
                        const void *key, hash_sig_t sig)
 {
        RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
-       return __rte_hash_lookup_with_hash(h, key, sig);
+       return __rte_hash_lookup_with_hash(h, key, sig, NULL);
 }
 
 int32_t
 rte_hash_lookup(const struct rte_hash *h, const void *key)
 {
        RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
-       return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key));
+       return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), NULL);
+}
+
+int
+rte_hash_lookup_with_hash_data(const struct rte_hash *h,
+                       const void *key, hash_sig_t sig, void **data)
+{
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_lookup_with_hash(h, key, sig, data);
+}
+
+int
+rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data)
+{
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), data);
+}
+
+static inline void
+remove_entry(const struct rte_hash *h, struct rte_hash_bucket *bkt, unsigned i)
+{
+       unsigned lcore_id, n_slots;
+       struct lcore_cache *cached_free_slots;
+
+       bkt->signatures[i].sig = NULL_SIGNATURE;
+       if (h->hw_trans_mem_support) {
+               lcore_id = rte_lcore_id();
+               cached_free_slots = &h->local_free_slots[lcore_id];
+               /* Cache full, need to free it. */
+               if (cached_free_slots->len == LCORE_CACHE_SIZE) {
+                       /* Need to enqueue the free slots in global ring. */
+                       n_slots = rte_ring_mp_enqueue_burst(h->free_slots,
+                                               cached_free_slots->objs,
+                                               LCORE_CACHE_SIZE);
+                       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)bkt->key_idx[i]);
+               cached_free_slots->len++;
+       } else {
+               rte_ring_sp_enqueue(h->free_slots,
+                               (void *)((uintptr_t)bkt->key_idx[i]));
+       }
 }
 
 static inline int32_t
@@ -643,7 +813,7 @@ __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
        hash_sig_t alt_hash;
        unsigned i;
        struct rte_hash_bucket *bkt;
-       void *k, *keys = h->key_store;
+       struct rte_hash_key *k, *keys = h->key_store;
 
        bucket_idx = sig & h->bucket_bitmask;
        bkt = &h->buckets[bucket_idx];
@@ -652,16 +822,16 @@ __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
        for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
                if (bkt->signatures[i].current == sig &&
                                bkt->signatures[i].sig != NULL_SIGNATURE) {
-                       k = (char *)keys + bkt->key_idx[i] * h->key_entry_size;
-                       if (h->rte_hash_cmp_eq(key, k, h->key_len) == 0) {
-                               bkt->signatures[i].sig = NULL_SIGNATURE;
-                               rte_ring_sp_enqueue(h->free_slots,
-                                               (void *)((uintptr_t)bkt->key_idx[i]));
+                       k = (struct rte_hash_key *) ((char *)keys +
+                                       bkt->key_idx[i] * h->key_entry_size);
+                       if (rte_hash_cmp_eq(key, k->key, h) == 0) {
+                               remove_entry(h, bkt, i);
+
                                /*
                                 * Return index where key is stored,
                                 * substracting the first dummy index
                                 */
-                               return (bkt->key_idx[i] - 1);
+                               return bkt->key_idx[i] - 1;
                        }
                }
        }
@@ -675,16 +845,16 @@ __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
        for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
                if (bkt->signatures[i].current == alt_hash &&
                                bkt->signatures[i].sig != NULL_SIGNATURE) {
-                       k = (char *)keys + bkt->key_idx[i] * h->key_entry_size;
-                       if (h->rte_hash_cmp_eq(key, k, h->key_len) == 0) {
-                               bkt->signatures[i].sig = NULL_SIGNATURE;
-                               rte_ring_sp_enqueue(h->free_slots,
-                                               (void *)((uintptr_t)bkt->key_idx[i]));
+                       k = (struct rte_hash_key *) ((char *)keys +
+                                       bkt->key_idx[i] * h->key_entry_size);
+                       if (rte_hash_cmp_eq(key, k->key, h) == 0) {
+                               remove_entry(h, bkt, i);
+
                                /*
                                 * Return index where key is stored,
                                 * substracting the first dummy index
                                 */
-                               return (bkt->key_idx[i] - 1);
+                               return bkt->key_idx[i] - 1;
                        }
                }
        }
@@ -750,7 +920,7 @@ static inline void
 lookup_stage2(unsigned idx, hash_sig_t prim_hash, hash_sig_t sec_hash,
                const struct rte_hash_bucket *prim_bkt,
                const struct rte_hash_bucket *sec_bkt,
-               const void **key_slot, int32_t *positions,
+               const struct rte_hash_key **key_slot, int32_t *positions,
                uint64_t *extra_hits_mask, const void *keys,
                const struct rte_hash *h)
 {
@@ -770,7 +940,8 @@ lookup_stage2(unsigned idx, hash_sig_t prim_hash, hash_sig_t sec_hash,
 
        total_hash_matches = (prim_hash_matches |
                                (sec_hash_matches << (RTE_HASH_BUCKET_ENTRIES + 1)));
-       *key_slot = (const char *)keys + key_idx * h->key_entry_size;
+       *key_slot = (const struct rte_hash_key *) ((const char *)keys +
+                                       key_idx * h->key_entry_size);
 
        rte_prefetch0(*key_slot);
        /*
@@ -784,26 +955,38 @@ lookup_stage2(unsigned idx, hash_sig_t prim_hash, hash_sig_t sec_hash,
 }
 
 
-/* Lookup bulk stage 3: Check if key matches, update hit mask */
+/* Lookup bulk stage 3: Check if key matches, update hit mask and return data */
 static inline void
-lookup_stage3(unsigned idx, const void *key_slot, const void * const *keys,
-               uint64_t *hits, const struct rte_hash *h)
+lookup_stage3(unsigned idx, const struct rte_hash_key *key_slot, const void * const *keys,
+               const int32_t *positions, void *data[], uint64_t *hits,
+               const struct rte_hash *h)
 {
        unsigned hit;
+       unsigned key_idx;
+
+       hit = !rte_hash_cmp_eq(key_slot->key, keys[idx], h);
+       if (data != NULL)
+               data[idx] = key_slot->pdata;
 
-       hit = !h->rte_hash_cmp_eq(key_slot, keys[idx], h->key_len);
-       *hits |= (uint64_t)(hit) << idx;
+       key_idx = positions[idx] + 1;
+       /*
+        * If key index is 0, force hit to be 0, in case key to be looked up
+        * is all zero (as in the dummy slot), which would result in a wrong hit
+        */
+       *hits |= (uint64_t)(hit && !!key_idx)  << idx;
 }
 
 static inline void
 __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
-                     uint32_t num_keys, int32_t *positions)
+                       uint32_t num_keys, int32_t *positions,
+                       uint64_t *hit_mask, void *data[])
 {
        uint64_t hits = 0;
        uint64_t extra_hits_mask = 0;
        uint64_t lookup_mask, miss_mask;
        unsigned idx;
        const void *key_store = h->key_store;
+       int ret;
        hash_sig_t hash_vals[RTE_HASH_LOOKUP_BULK_MAX];
 
        unsigned idx00, idx01, idx10, idx11, idx20, idx21, idx30, idx31;
@@ -811,7 +994,7 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
        const struct rte_hash_bucket *secondary_bkt10, *secondary_bkt11;
        const struct rte_hash_bucket *primary_bkt20, *primary_bkt21;
        const struct rte_hash_bucket *secondary_bkt20, *secondary_bkt21;
-       const void *k_slot20, *k_slot21, *k_slot30, *k_slot31;
+       const struct rte_hash_key *k_slot20, *k_slot21, *k_slot30, *k_slot31;
        hash_sig_t primary_hash10, primary_hash11;
        hash_sig_t secondary_hash10, secondary_hash11;
        hash_sig_t primary_hash20, primary_hash21;
@@ -882,8 +1065,8 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
                lookup_stage2(idx21, primary_hash21, secondary_hash21,
                        primary_bkt21, secondary_bkt21, &k_slot21, positions,
                        &extra_hits_mask, key_store, h);
-               lookup_stage3(idx30, k_slot30, keys, &hits, h);
-               lookup_stage3(idx31, k_slot31, keys, &hits, h);
+               lookup_stage3(idx30, k_slot30, keys, positions, data, &hits, h);
+               lookup_stage3(idx31, k_slot31, keys, positions, data, &hits, h);
        }
 
        k_slot30 = k_slot20, k_slot31 = k_slot21;
@@ -909,8 +1092,8 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
        lookup_stage2(idx21, primary_hash21, secondary_hash21, primary_bkt21,
                secondary_bkt21, &k_slot21, positions, &extra_hits_mask,
                key_store, h);
-       lookup_stage3(idx30, k_slot30, keys, &hits, h);
-       lookup_stage3(idx31, k_slot31, keys, &hits, h);
+       lookup_stage3(idx30, k_slot30, keys, positions, data, &hits, h);
+       lookup_stage3(idx31, k_slot31, keys, positions, data, &hits, h);
 
        k_slot30 = k_slot20, k_slot31 = k_slot21;
        idx30 = idx20, idx31 = idx21;
@@ -930,14 +1113,14 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
        lookup_stage2(idx21, primary_hash21, secondary_hash21, primary_bkt21,
                secondary_bkt21, &k_slot21, positions, &extra_hits_mask,
                key_store, h);
-       lookup_stage3(idx30, k_slot30, keys, &hits, h);
-       lookup_stage3(idx31, k_slot31, keys, &hits, h);
+       lookup_stage3(idx30, k_slot30, keys, positions, data, &hits, h);
+       lookup_stage3(idx31, k_slot31, keys, positions, data, &hits, h);
 
        k_slot30 = k_slot20, k_slot31 = k_slot21;
        idx30 = idx20, idx31 = idx21;
 
-       lookup_stage3(idx30, k_slot30, keys, &hits, h);
-       lookup_stage3(idx31, k_slot31, keys, &hits, h);
+       lookup_stage3(idx30, k_slot30, keys, positions, data, &hits, h);
+       lookup_stage3(idx31, k_slot31, keys, positions, data, &hits, h);
 
        /* ignore any items we have already found */
        extra_hits_mask &= ~hits;
@@ -946,11 +1129,18 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
                /* run a single search for each remaining item */
                do {
                        idx = __builtin_ctzl(extra_hits_mask);
-                       positions[idx] = rte_hash_lookup_with_hash(h, keys[idx],
-                                                       hash_vals[idx]);
+                       if (data != NULL) {
+                               ret = rte_hash_lookup_with_hash_data(h,
+                                               keys[idx], hash_vals[idx], &data[idx]);
+                               if (ret >= 0)
+                                       hits |= 1ULL << idx;
+                       } else {
+                               positions[idx] = rte_hash_lookup_with_hash(h,
+                                                       keys[idx], hash_vals[idx]);
+                               if (positions[idx] >= 0)
+                                       hits |= 1llu << idx;
+                       }
                        extra_hits_mask &= ~(1llu << idx);
-                       if (positions[idx] >= 0)
-                               hits |= 1llu << idx;
                } while (extra_hits_mask);
        }
 
@@ -962,6 +1152,9 @@ __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
                        miss_mask &= ~(1llu << idx);
                } while (miss_mask);
        }
+
+       if (hit_mask != NULL)
+               *hit_mask = hits;
 }
 
 int
@@ -972,77 +1165,63 @@ rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
                        (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
                        (positions == NULL)), -EINVAL);
 
-       __rte_hash_lookup_bulk(h, keys, num_keys, positions);
+       __rte_hash_lookup_bulk(h, keys, num_keys, positions, NULL, NULL);
        return 0;
 }
 
-/* Functions to compare multiple of 16 byte keys (up to 128 bytes) */
-static int
-rte_hash_k16_cmp_eq(const void *key1, const void *key2, size_t key_len __rte_unused)
+int
+rte_hash_lookup_bulk_data(const struct rte_hash *h, const void **keys,
+                     uint32_t num_keys, uint64_t *hit_mask, void *data[])
 {
-       const __m128i k1 = _mm_loadu_si128((const __m128i *) key1);
-       const __m128i k2 = _mm_loadu_si128((const __m128i *) key2);
-       const __m128i x = _mm_xor_si128(k1, k2);
+       RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
+                       (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
+                       (hit_mask == NULL)), -EINVAL);
 
-       return !_mm_test_all_zeros(x, x);
-}
+       int32_t positions[num_keys];
 
-static int
-rte_hash_k32_cmp_eq(const void *key1, const void *key2, size_t key_len)
-{
-       return rte_hash_k16_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k16_cmp_eq((const char *) key1 + 16,
-                               (const char *) key2 + 16, key_len);
-}
+       __rte_hash_lookup_bulk(h, keys, num_keys, positions, hit_mask, data);
 
-static int
-rte_hash_k48_cmp_eq(const void *key1, const void *key2, size_t key_len)
-{
-       return rte_hash_k16_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k16_cmp_eq((const char *) key1 + 16,
-                               (const char *) key2 + 16, key_len) ||
-               rte_hash_k16_cmp_eq((const char *) key1 + 32,
-                               (const char *) key2 + 32, key_len);
+       /* Return number of hits */
+       return __builtin_popcountl(*hit_mask);
 }
 
-static int
-rte_hash_k64_cmp_eq(const void *key1, const void *key2, size_t key_len)
-{
-       return rte_hash_k32_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k32_cmp_eq((const char *) key1 + 32,
-                               (const char *) key2 + 32, key_len);
-}
-
-static int
-rte_hash_k80_cmp_eq(const void *key1, const void *key2, size_t key_len)
+int32_t
+rte_hash_iterate(const struct rte_hash *h, const void **key, void **data, uint32_t *next)
 {
-       return rte_hash_k64_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k16_cmp_eq((const char *) key1 + 64,
-                               (const char *) key2 + 64, key_len);
-}
+       uint32_t bucket_idx, idx, position;
+       struct rte_hash_key *next_key;
+
+       RETURN_IF_TRUE(((h == NULL) || (next == NULL)), -EINVAL);
+
+       const uint32_t total_entries = h->num_buckets * RTE_HASH_BUCKET_ENTRIES;
+       /* Out of bounds */
+       if (*next >= total_entries)
+               return -ENOENT;
+
+       /* Calculate bucket and index of current iterator */
+       bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
+       idx = *next % RTE_HASH_BUCKET_ENTRIES;
+
+       /* If current position is empty, go to the next one */
+       while (h->buckets[bucket_idx].signatures[idx].sig == NULL_SIGNATURE) {
+               (*next)++;
+               /* End of table */
+               if (*next == total_entries)
+                       return -ENOENT;
+               bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
+               idx = *next % RTE_HASH_BUCKET_ENTRIES;
+       }
 
-static int
-rte_hash_k96_cmp_eq(const void *key1, const void *key2, size_t key_len)
-{
-       return rte_hash_k64_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k32_cmp_eq((const char *) key1 + 64,
-                               (const char *) key2 + 64, key_len);
-}
+       /* Get position of entry in key table */
+       position = h->buckets[bucket_idx].key_idx[idx];
+       next_key = (struct rte_hash_key *) ((char *)h->key_store +
+                               position * h->key_entry_size);
+       /* Return key and data */
+       *key = next_key->key;
+       *data = next_key->pdata;
 
-static int
-rte_hash_k112_cmp_eq(const void *key1, const void *key2, size_t key_len)
-{
-       return rte_hash_k64_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k32_cmp_eq((const char *) key1 + 64,
-                               (const char *) key2 + 64, key_len) ||
-               rte_hash_k16_cmp_eq((const char *) key1 + 96,
-                               (const char *) key2 + 96, key_len);
-}
+       /* Increment iterator */
+       (*next)++;
 
-static int
-rte_hash_k128_cmp_eq(const void *key1, const void *key2, size_t key_len)
-{
-       return rte_hash_k64_cmp_eq(key1, key2, key_len) ||
-               rte_hash_k64_cmp_eq((const char *) key1 + 64,
-                               (const char *) key2 + 64, key_len);
+       return position - 1;
 }