4 * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <sys/queue.h>
41 #include <rte_common.h>
42 #include <rte_memory.h> /* for definition of RTE_CACHE_LINE_SIZE */
44 #include <rte_memcpy.h>
45 #include <rte_prefetch.h>
46 #include <rte_branch_prediction.h>
47 #include <rte_memzone.h>
48 #include <rte_malloc.h>
50 #include <rte_eal_memconfig.h>
51 #include <rte_per_lcore.h>
52 #include <rte_errno.h>
53 #include <rte_string_fns.h>
54 #include <rte_cpuflags.h>
55 #include <rte_rwlock.h>
56 #include <rte_spinlock.h>
58 #include <rte_compat.h>
59 #include <rte_pause.h>
62 #include "rte_cuckoo_hash.h"
64 #if defined(RTE_ARCH_X86)
65 #include "rte_cuckoo_hash_x86.h"
68 TAILQ_HEAD(rte_hash_list, rte_tailq_entry);
70 static struct rte_tailq_elem rte_hash_tailq = {
73 EAL_REGISTER_TAILQ(rte_hash_tailq)
76 rte_hash_find_existing(const char *name)
78 struct rte_hash *h = NULL;
79 struct rte_tailq_entry *te;
80 struct rte_hash_list *hash_list;
82 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
84 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
85 TAILQ_FOREACH(te, hash_list, next) {
86 h = (struct rte_hash *) te->data;
87 if (strncmp(name, h->name, RTE_HASH_NAMESIZE) == 0)
90 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
99 void rte_hash_set_cmp_func(struct rte_hash *h, rte_hash_cmp_eq_t func)
101 h->cmp_jump_table_idx = KEY_CUSTOM;
102 h->rte_hash_custom_cmp_eq = func;
106 rte_hash_cmp_eq(const void *key1, const void *key2, const struct rte_hash *h)
108 if (h->cmp_jump_table_idx == KEY_CUSTOM)
109 return h->rte_hash_custom_cmp_eq(key1, key2, h->key_len);
111 return cmp_jump_table[h->cmp_jump_table_idx](key1, key2, h->key_len);
115 rte_hash_create(const struct rte_hash_parameters *params)
117 struct rte_hash *h = NULL;
118 struct rte_tailq_entry *te = NULL;
119 struct rte_hash_list *hash_list;
120 struct rte_ring *r = NULL;
121 char hash_name[RTE_HASH_NAMESIZE];
123 void *buckets = NULL;
124 char ring_name[RTE_RING_NAMESIZE];
125 unsigned num_key_slots;
126 unsigned hw_trans_mem_support = 0;
129 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
131 if (params == NULL) {
132 RTE_LOG(ERR, HASH, "rte_hash_create has no parameters\n");
136 /* Check for valid parameters */
137 if ((params->entries > RTE_HASH_ENTRIES_MAX) ||
138 (params->entries < RTE_HASH_BUCKET_ENTRIES) ||
139 !rte_is_power_of_2(RTE_HASH_BUCKET_ENTRIES) ||
140 (params->key_len == 0)) {
142 RTE_LOG(ERR, HASH, "rte_hash_create has invalid parameters\n");
146 /* Check extra flags field to check extra options. */
147 if (params->extra_flag & RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT)
148 hw_trans_mem_support = 1;
150 /* Store all keys and leave the first entry as a dummy entry for lookup_bulk */
151 if (hw_trans_mem_support)
153 * Increase number of slots by total number of indices
154 * that can be stored in the lcore caches
155 * except for the first cache
157 num_key_slots = params->entries + (RTE_MAX_LCORE - 1) *
158 LCORE_CACHE_SIZE + 1;
160 num_key_slots = params->entries + 1;
162 snprintf(ring_name, sizeof(ring_name), "HT_%s", params->name);
163 /* Create ring (Dummy slot index is not enqueued) */
164 r = rte_ring_create(ring_name, rte_align32pow2(num_key_slots - 1),
165 params->socket_id, 0);
167 RTE_LOG(ERR, HASH, "memory allocation failed\n");
171 snprintf(hash_name, sizeof(hash_name), "HT_%s", params->name);
173 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
175 /* guarantee there's no existing: this is normally already checked
176 * by ring creation above */
177 TAILQ_FOREACH(te, hash_list, next) {
178 h = (struct rte_hash *) te->data;
179 if (strncmp(params->name, h->name, RTE_HASH_NAMESIZE) == 0)
189 te = rte_zmalloc("HASH_TAILQ_ENTRY", sizeof(*te), 0);
191 RTE_LOG(ERR, HASH, "tailq entry allocation failed\n");
195 h = (struct rte_hash *)rte_zmalloc_socket(hash_name, sizeof(struct rte_hash),
196 RTE_CACHE_LINE_SIZE, params->socket_id);
199 RTE_LOG(ERR, HASH, "memory allocation failed\n");
203 const uint32_t num_buckets = rte_align32pow2(params->entries)
204 / RTE_HASH_BUCKET_ENTRIES;
206 buckets = rte_zmalloc_socket(NULL,
207 num_buckets * sizeof(struct rte_hash_bucket),
208 RTE_CACHE_LINE_SIZE, params->socket_id);
210 if (buckets == NULL) {
211 RTE_LOG(ERR, HASH, "memory allocation failed\n");
215 const uint32_t key_entry_size = sizeof(struct rte_hash_key) + params->key_len;
216 const uint64_t key_tbl_size = (uint64_t) key_entry_size * num_key_slots;
218 k = rte_zmalloc_socket(NULL, key_tbl_size,
219 RTE_CACHE_LINE_SIZE, params->socket_id);
222 RTE_LOG(ERR, HASH, "memory allocation failed\n");
227 * If x86 architecture is used, select appropriate compare function,
228 * which may use x86 intrinsics, otherwise use memcmp
230 #if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64)
231 /* Select function to compare keys */
232 switch (params->key_len) {
234 h->cmp_jump_table_idx = KEY_16_BYTES;
237 h->cmp_jump_table_idx = KEY_32_BYTES;
240 h->cmp_jump_table_idx = KEY_48_BYTES;
243 h->cmp_jump_table_idx = KEY_64_BYTES;
246 h->cmp_jump_table_idx = KEY_80_BYTES;
249 h->cmp_jump_table_idx = KEY_96_BYTES;
252 h->cmp_jump_table_idx = KEY_112_BYTES;
255 h->cmp_jump_table_idx = KEY_128_BYTES;
258 /* If key is not multiple of 16, use generic memcmp */
259 h->cmp_jump_table_idx = KEY_OTHER_BYTES;
262 h->cmp_jump_table_idx = KEY_OTHER_BYTES;
265 if (hw_trans_mem_support) {
266 h->local_free_slots = rte_zmalloc_socket(NULL,
267 sizeof(struct lcore_cache) * RTE_MAX_LCORE,
268 RTE_CACHE_LINE_SIZE, params->socket_id);
271 /* Setup hash context */
272 snprintf(h->name, sizeof(h->name), "%s", params->name);
273 h->entries = params->entries;
274 h->key_len = params->key_len;
275 h->key_entry_size = key_entry_size;
276 h->hash_func_init_val = params->hash_func_init_val;
278 h->num_buckets = num_buckets;
279 h->bucket_bitmask = h->num_buckets - 1;
280 h->buckets = buckets;
281 h->hash_func = (params->hash_func == NULL) ?
282 DEFAULT_HASH_FUNC : params->hash_func;
285 h->hw_trans_mem_support = hw_trans_mem_support;
287 #if defined(RTE_ARCH_X86)
288 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
289 h->sig_cmp_fn = RTE_HASH_COMPARE_AVX2;
290 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE2))
291 h->sig_cmp_fn = RTE_HASH_COMPARE_SSE;
294 h->sig_cmp_fn = RTE_HASH_COMPARE_SCALAR;
296 /* Turn on multi-writer only with explicit flat from user and TM
299 if (params->extra_flag & RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD) {
300 if (h->hw_trans_mem_support) {
301 h->add_key = ADD_KEY_MULTIWRITER_TM;
303 h->add_key = ADD_KEY_MULTIWRITER;
304 h->multiwriter_lock = rte_malloc(NULL,
305 sizeof(rte_spinlock_t),
307 rte_spinlock_init(h->multiwriter_lock);
310 h->add_key = ADD_KEY_SINGLEWRITER;
312 /* Populate free slots ring. Entry zero is reserved for key misses. */
313 for (i = 1; i < params->entries + 1; i++)
314 rte_ring_sp_enqueue(r, (void *)((uintptr_t) i));
316 te->data = (void *) h;
317 TAILQ_INSERT_TAIL(hash_list, te, next);
318 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
322 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
333 rte_hash_free(struct rte_hash *h)
335 struct rte_tailq_entry *te;
336 struct rte_hash_list *hash_list;
341 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
343 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
345 /* find out tailq entry */
346 TAILQ_FOREACH(te, hash_list, next) {
347 if (te->data == (void *) h)
352 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
356 TAILQ_REMOVE(hash_list, te, next);
358 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
360 if (h->hw_trans_mem_support)
361 rte_free(h->local_free_slots);
363 if (h->add_key == ADD_KEY_MULTIWRITER)
364 rte_free(h->multiwriter_lock);
365 rte_ring_free(h->free_slots);
366 rte_free(h->key_store);
367 rte_free(h->buckets);
373 rte_hash_hash(const struct rte_hash *h, const void *key)
375 /* calc hash result by key */
376 return h->hash_func(key, h->key_len, h->hash_func_init_val);
379 /* Calc the secondary hash value from the primary hash value of a given key */
380 static inline hash_sig_t
381 rte_hash_secondary_hash(const hash_sig_t primary_hash)
383 static const unsigned all_bits_shift = 12;
384 static const unsigned alt_bits_xor = 0x5bd1e995;
386 uint32_t tag = primary_hash >> all_bits_shift;
388 return primary_hash ^ ((tag + 1) * alt_bits_xor);
392 rte_hash_reset(struct rte_hash *h)
400 memset(h->buckets, 0, h->num_buckets * sizeof(struct rte_hash_bucket));
401 memset(h->key_store, 0, h->key_entry_size * (h->entries + 1));
403 /* clear the free ring */
404 while (rte_ring_dequeue(h->free_slots, &ptr) == 0)
407 /* Repopulate the free slots ring. Entry zero is reserved for key misses */
408 for (i = 1; i < h->entries + 1; i++)
409 rte_ring_sp_enqueue(h->free_slots, (void *)((uintptr_t) i));
411 if (h->hw_trans_mem_support) {
412 /* Reset local caches per lcore */
413 for (i = 0; i < RTE_MAX_LCORE; i++)
414 h->local_free_slots[i].len = 0;
418 /* Search for an entry that can be pushed to its alternative location */
420 make_space_bucket(const struct rte_hash *h, struct rte_hash_bucket *bkt,
421 unsigned int *nr_pushes)
425 uint32_t next_bucket_idx;
426 struct rte_hash_bucket *next_bkt[RTE_HASH_BUCKET_ENTRIES];
429 * Push existing item (search for bucket with space in
430 * alternative locations) to its alternative location
432 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
433 /* Search for space in alternative locations */
434 next_bucket_idx = bkt->sig_alt[i] & h->bucket_bitmask;
435 next_bkt[i] = &h->buckets[next_bucket_idx];
436 for (j = 0; j < RTE_HASH_BUCKET_ENTRIES; j++) {
437 if (next_bkt[i]->key_idx[j] == EMPTY_SLOT)
441 if (j != RTE_HASH_BUCKET_ENTRIES)
445 /* Alternative location has spare room (end of recursive function) */
446 if (i != RTE_HASH_BUCKET_ENTRIES) {
447 next_bkt[i]->sig_alt[j] = bkt->sig_current[i];
448 next_bkt[i]->sig_current[j] = bkt->sig_alt[i];
449 next_bkt[i]->key_idx[j] = bkt->key_idx[i];
453 /* Pick entry that has not been pushed yet */
454 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++)
455 if (bkt->flag[i] == 0)
458 /* All entries have been pushed, so entry cannot be added */
459 if (i == RTE_HASH_BUCKET_ENTRIES || ++(*nr_pushes) > RTE_HASH_MAX_PUSHES)
462 /* Set flag to indicate that this entry is going to be pushed */
465 /* Need room in alternative bucket to insert the pushed entry */
466 ret = make_space_bucket(h, next_bkt[i], nr_pushes);
468 * After recursive function.
469 * Clear flags and insert the pushed entry
470 * in its alternative location if successful,
475 next_bkt[i]->sig_alt[ret] = bkt->sig_current[i];
476 next_bkt[i]->sig_current[ret] = bkt->sig_alt[i];
477 next_bkt[i]->key_idx[ret] = bkt->key_idx[i];
485 * Function called to enqueue back an index in the cache/ring,
486 * as slot has not being used and it can be used in the
487 * next addition attempt.
490 enqueue_slot_back(const struct rte_hash *h,
491 struct lcore_cache *cached_free_slots,
494 if (h->hw_trans_mem_support) {
495 cached_free_slots->objs[cached_free_slots->len] = slot_id;
496 cached_free_slots->len++;
498 rte_ring_sp_enqueue(h->free_slots, slot_id);
501 static inline int32_t
502 __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
503 hash_sig_t sig, void *data)
506 uint32_t prim_bucket_idx, sec_bucket_idx;
508 struct rte_hash_bucket *prim_bkt, *sec_bkt;
509 struct rte_hash_key *new_k, *k, *keys = h->key_store;
510 void *slot_id = NULL;
515 struct lcore_cache *cached_free_slots = NULL;
516 unsigned int nr_pushes = 0;
518 if (h->add_key == ADD_KEY_MULTIWRITER)
519 rte_spinlock_lock(h->multiwriter_lock);
521 prim_bucket_idx = sig & h->bucket_bitmask;
522 prim_bkt = &h->buckets[prim_bucket_idx];
523 rte_prefetch0(prim_bkt);
525 alt_hash = rte_hash_secondary_hash(sig);
526 sec_bucket_idx = alt_hash & h->bucket_bitmask;
527 sec_bkt = &h->buckets[sec_bucket_idx];
528 rte_prefetch0(sec_bkt);
530 /* Get a new slot for storing the new key */
531 if (h->hw_trans_mem_support) {
532 lcore_id = rte_lcore_id();
533 cached_free_slots = &h->local_free_slots[lcore_id];
534 /* Try to get a free slot from the local cache */
535 if (cached_free_slots->len == 0) {
536 /* Need to get another burst of free slots from global ring */
537 n_slots = rte_ring_mc_dequeue_burst(h->free_slots,
538 cached_free_slots->objs,
539 LCORE_CACHE_SIZE, NULL);
545 cached_free_slots->len += n_slots;
548 /* Get a free slot from the local cache */
549 cached_free_slots->len--;
550 slot_id = cached_free_slots->objs[cached_free_slots->len];
552 if (rte_ring_sc_dequeue(h->free_slots, &slot_id) != 0) {
558 new_k = RTE_PTR_ADD(keys, (uintptr_t)slot_id * h->key_entry_size);
559 rte_prefetch0(new_k);
560 new_idx = (uint32_t)((uintptr_t) slot_id);
562 /* Check if key is already inserted in primary location */
563 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
564 if (prim_bkt->sig_current[i] == sig &&
565 prim_bkt->sig_alt[i] == alt_hash) {
566 k = (struct rte_hash_key *) ((char *)keys +
567 prim_bkt->key_idx[i] * h->key_entry_size);
568 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
569 /* Enqueue index of free slot back in the ring. */
570 enqueue_slot_back(h, cached_free_slots, slot_id);
574 * Return index where key is stored,
575 * subtracting the first dummy index
577 return prim_bkt->key_idx[i] - 1;
582 /* Check if key is already inserted in secondary location */
583 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
584 if (sec_bkt->sig_alt[i] == sig &&
585 sec_bkt->sig_current[i] == alt_hash) {
586 k = (struct rte_hash_key *) ((char *)keys +
587 sec_bkt->key_idx[i] * h->key_entry_size);
588 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
589 /* Enqueue index of free slot back in the ring. */
590 enqueue_slot_back(h, cached_free_slots, slot_id);
594 * Return index where key is stored,
595 * subtracting the first dummy index
597 return sec_bkt->key_idx[i] - 1;
603 rte_memcpy(new_k->key, key, h->key_len);
606 #if defined(RTE_ARCH_X86) /* currently only x86 support HTM */
607 if (h->add_key == ADD_KEY_MULTIWRITER_TM) {
608 ret = rte_hash_cuckoo_insert_mw_tm(prim_bkt,
609 sig, alt_hash, new_idx);
613 /* Primary bucket full, need to make space for new entry */
614 ret = rte_hash_cuckoo_make_space_mw_tm(h, prim_bkt, sig,
620 /* Also search secondary bucket to get better occupancy */
621 ret = rte_hash_cuckoo_make_space_mw_tm(h, sec_bkt, sig,
628 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
629 /* Check if slot is available */
630 if (likely(prim_bkt->key_idx[i] == EMPTY_SLOT)) {
631 prim_bkt->sig_current[i] = sig;
632 prim_bkt->sig_alt[i] = alt_hash;
633 prim_bkt->key_idx[i] = new_idx;
638 if (i != RTE_HASH_BUCKET_ENTRIES) {
639 if (h->add_key == ADD_KEY_MULTIWRITER)
640 rte_spinlock_unlock(h->multiwriter_lock);
644 /* Primary bucket full, need to make space for new entry
645 * After recursive function.
646 * Insert the new entry in the position of the pushed entry
647 * if successful or return error and
648 * store the new slot back in the ring
650 ret = make_space_bucket(h, prim_bkt, &nr_pushes);
652 prim_bkt->sig_current[ret] = sig;
653 prim_bkt->sig_alt[ret] = alt_hash;
654 prim_bkt->key_idx[ret] = new_idx;
655 if (h->add_key == ADD_KEY_MULTIWRITER)
656 rte_spinlock_unlock(h->multiwriter_lock);
659 #if defined(RTE_ARCH_X86)
662 /* Error in addition, store new slot back in the ring and return error */
663 enqueue_slot_back(h, cached_free_slots, (void *)((uintptr_t) new_idx));
666 if (h->add_key == ADD_KEY_MULTIWRITER)
667 rte_spinlock_unlock(h->multiwriter_lock);
672 rte_hash_add_key_with_hash(const struct rte_hash *h,
673 const void *key, hash_sig_t sig)
675 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
676 return __rte_hash_add_key_with_hash(h, key, sig, 0);
680 rte_hash_add_key(const struct rte_hash *h, const void *key)
682 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
683 return __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), 0);
687 rte_hash_add_key_with_hash_data(const struct rte_hash *h,
688 const void *key, hash_sig_t sig, void *data)
692 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
693 ret = __rte_hash_add_key_with_hash(h, key, sig, data);
701 rte_hash_add_key_data(const struct rte_hash *h, const void *key, void *data)
705 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
707 ret = __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), data);
713 static inline int32_t
714 __rte_hash_lookup_with_hash(const struct rte_hash *h, const void *key,
715 hash_sig_t sig, void **data)
720 struct rte_hash_bucket *bkt;
721 struct rte_hash_key *k, *keys = h->key_store;
723 bucket_idx = sig & h->bucket_bitmask;
724 bkt = &h->buckets[bucket_idx];
726 /* Check if key is in primary location */
727 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
728 if (bkt->sig_current[i] == sig &&
729 bkt->key_idx[i] != EMPTY_SLOT) {
730 k = (struct rte_hash_key *) ((char *)keys +
731 bkt->key_idx[i] * h->key_entry_size);
732 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
736 * Return index where key is stored,
737 * subtracting the first dummy index
739 return bkt->key_idx[i] - 1;
744 /* Calculate secondary hash */
745 alt_hash = rte_hash_secondary_hash(sig);
746 bucket_idx = alt_hash & h->bucket_bitmask;
747 bkt = &h->buckets[bucket_idx];
749 /* Check if key is in secondary location */
750 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
751 if (bkt->sig_current[i] == alt_hash &&
752 bkt->sig_alt[i] == sig) {
753 k = (struct rte_hash_key *) ((char *)keys +
754 bkt->key_idx[i] * h->key_entry_size);
755 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
759 * Return index where key is stored,
760 * subtracting the first dummy index
762 return bkt->key_idx[i] - 1;
771 rte_hash_lookup_with_hash(const struct rte_hash *h,
772 const void *key, hash_sig_t sig)
774 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
775 return __rte_hash_lookup_with_hash(h, key, sig, NULL);
779 rte_hash_lookup(const struct rte_hash *h, const void *key)
781 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
782 return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), NULL);
786 rte_hash_lookup_with_hash_data(const struct rte_hash *h,
787 const void *key, hash_sig_t sig, void **data)
789 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
790 return __rte_hash_lookup_with_hash(h, key, sig, data);
794 rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data)
796 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
797 return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), data);
801 remove_entry(const struct rte_hash *h, struct rte_hash_bucket *bkt, unsigned i)
803 unsigned lcore_id, n_slots;
804 struct lcore_cache *cached_free_slots;
806 bkt->sig_current[i] = NULL_SIGNATURE;
807 bkt->sig_alt[i] = NULL_SIGNATURE;
808 if (h->hw_trans_mem_support) {
809 lcore_id = rte_lcore_id();
810 cached_free_slots = &h->local_free_slots[lcore_id];
811 /* Cache full, need to free it. */
812 if (cached_free_slots->len == LCORE_CACHE_SIZE) {
813 /* Need to enqueue the free slots in global ring. */
814 n_slots = rte_ring_mp_enqueue_burst(h->free_slots,
815 cached_free_slots->objs,
816 LCORE_CACHE_SIZE, NULL);
817 cached_free_slots->len -= n_slots;
819 /* Put index of new free slot in cache. */
820 cached_free_slots->objs[cached_free_slots->len] =
821 (void *)((uintptr_t)bkt->key_idx[i]);
822 cached_free_slots->len++;
824 rte_ring_sp_enqueue(h->free_slots,
825 (void *)((uintptr_t)bkt->key_idx[i]));
829 static inline int32_t
830 __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
836 struct rte_hash_bucket *bkt;
837 struct rte_hash_key *k, *keys = h->key_store;
840 bucket_idx = sig & h->bucket_bitmask;
841 bkt = &h->buckets[bucket_idx];
843 /* Check if key is in primary location */
844 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
845 if (bkt->sig_current[i] == sig &&
846 bkt->key_idx[i] != EMPTY_SLOT) {
847 k = (struct rte_hash_key *) ((char *)keys +
848 bkt->key_idx[i] * h->key_entry_size);
849 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
850 remove_entry(h, bkt, i);
853 * Return index where key is stored,
854 * subtracting the first dummy index
856 ret = bkt->key_idx[i] - 1;
857 bkt->key_idx[i] = EMPTY_SLOT;
863 /* Calculate secondary hash */
864 alt_hash = rte_hash_secondary_hash(sig);
865 bucket_idx = alt_hash & h->bucket_bitmask;
866 bkt = &h->buckets[bucket_idx];
868 /* Check if key is in secondary location */
869 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
870 if (bkt->sig_current[i] == alt_hash &&
871 bkt->key_idx[i] != EMPTY_SLOT) {
872 k = (struct rte_hash_key *) ((char *)keys +
873 bkt->key_idx[i] * h->key_entry_size);
874 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
875 remove_entry(h, bkt, i);
878 * Return index where key is stored,
879 * subtracting the first dummy index
881 ret = bkt->key_idx[i] - 1;
882 bkt->key_idx[i] = EMPTY_SLOT;
892 rte_hash_del_key_with_hash(const struct rte_hash *h,
893 const void *key, hash_sig_t sig)
895 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
896 return __rte_hash_del_key_with_hash(h, key, sig);
900 rte_hash_del_key(const struct rte_hash *h, const void *key)
902 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
903 return __rte_hash_del_key_with_hash(h, key, rte_hash_hash(h, key));
907 rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
910 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
912 struct rte_hash_key *k, *keys = h->key_store;
913 k = (struct rte_hash_key *) ((char *) keys + (position + 1) *
918 __rte_hash_lookup_with_hash(h, *key, rte_hash_hash(h, *key),
927 compare_signatures(uint32_t *prim_hash_matches, uint32_t *sec_hash_matches,
928 const struct rte_hash_bucket *prim_bkt,
929 const struct rte_hash_bucket *sec_bkt,
930 hash_sig_t prim_hash, hash_sig_t sec_hash,
931 enum rte_hash_sig_compare_function sig_cmp_fn)
935 switch (sig_cmp_fn) {
936 #ifdef RTE_MACHINE_CPUFLAG_AVX2
937 case RTE_HASH_COMPARE_AVX2:
938 *prim_hash_matches = _mm256_movemask_ps((__m256)_mm256_cmpeq_epi32(
940 (__m256i const *)prim_bkt->sig_current),
941 _mm256_set1_epi32(prim_hash)));
942 *sec_hash_matches = _mm256_movemask_ps((__m256)_mm256_cmpeq_epi32(
944 (__m256i const *)sec_bkt->sig_current),
945 _mm256_set1_epi32(sec_hash)));
948 #ifdef RTE_MACHINE_CPUFLAG_SSE2
949 case RTE_HASH_COMPARE_SSE:
950 /* Compare the first 4 signatures in the bucket */
951 *prim_hash_matches = _mm_movemask_ps((__m128)_mm_cmpeq_epi16(
953 (__m128i const *)prim_bkt->sig_current),
954 _mm_set1_epi32(prim_hash)));
955 *prim_hash_matches |= (_mm_movemask_ps((__m128)_mm_cmpeq_epi16(
957 (__m128i const *)&prim_bkt->sig_current[4]),
958 _mm_set1_epi32(prim_hash)))) << 4;
959 /* Compare the first 4 signatures in the bucket */
960 *sec_hash_matches = _mm_movemask_ps((__m128)_mm_cmpeq_epi16(
962 (__m128i const *)sec_bkt->sig_current),
963 _mm_set1_epi32(sec_hash)));
964 *sec_hash_matches |= (_mm_movemask_ps((__m128)_mm_cmpeq_epi16(
966 (__m128i const *)&sec_bkt->sig_current[4]),
967 _mm_set1_epi32(sec_hash)))) << 4;
971 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
972 *prim_hash_matches |=
973 ((prim_hash == prim_bkt->sig_current[i]) << i);
975 ((sec_hash == sec_bkt->sig_current[i]) << i);
981 #define PREFETCH_OFFSET 4
983 __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
984 int32_t num_keys, int32_t *positions,
985 uint64_t *hit_mask, void *data[])
989 uint32_t prim_hash[RTE_HASH_LOOKUP_BULK_MAX];
990 uint32_t sec_hash[RTE_HASH_LOOKUP_BULK_MAX];
991 const struct rte_hash_bucket *primary_bkt[RTE_HASH_LOOKUP_BULK_MAX];
992 const struct rte_hash_bucket *secondary_bkt[RTE_HASH_LOOKUP_BULK_MAX];
993 uint32_t prim_hitmask[RTE_HASH_LOOKUP_BULK_MAX] = {0};
994 uint32_t sec_hitmask[RTE_HASH_LOOKUP_BULK_MAX] = {0};
996 /* Prefetch first keys */
997 for (i = 0; i < PREFETCH_OFFSET && i < num_keys; i++)
998 rte_prefetch0(keys[i]);
1001 * Prefetch rest of the keys, calculate primary and
1002 * secondary bucket and prefetch them
1004 for (i = 0; i < (num_keys - PREFETCH_OFFSET); i++) {
1005 rte_prefetch0(keys[i + PREFETCH_OFFSET]);
1007 prim_hash[i] = rte_hash_hash(h, keys[i]);
1008 sec_hash[i] = rte_hash_secondary_hash(prim_hash[i]);
1010 primary_bkt[i] = &h->buckets[prim_hash[i] & h->bucket_bitmask];
1011 secondary_bkt[i] = &h->buckets[sec_hash[i] & h->bucket_bitmask];
1013 rte_prefetch0(primary_bkt[i]);
1014 rte_prefetch0(secondary_bkt[i]);
1017 /* Calculate and prefetch rest of the buckets */
1018 for (; i < num_keys; i++) {
1019 prim_hash[i] = rte_hash_hash(h, keys[i]);
1020 sec_hash[i] = rte_hash_secondary_hash(prim_hash[i]);
1022 primary_bkt[i] = &h->buckets[prim_hash[i] & h->bucket_bitmask];
1023 secondary_bkt[i] = &h->buckets[sec_hash[i] & h->bucket_bitmask];
1025 rte_prefetch0(primary_bkt[i]);
1026 rte_prefetch0(secondary_bkt[i]);
1029 /* Compare signatures and prefetch key slot of first hit */
1030 for (i = 0; i < num_keys; i++) {
1031 compare_signatures(&prim_hitmask[i], &sec_hitmask[i],
1032 primary_bkt[i], secondary_bkt[i],
1033 prim_hash[i], sec_hash[i], h->sig_cmp_fn);
1035 if (prim_hitmask[i]) {
1036 uint32_t first_hit = __builtin_ctzl(prim_hitmask[i]);
1037 uint32_t key_idx = primary_bkt[i]->key_idx[first_hit];
1038 const struct rte_hash_key *key_slot =
1039 (const struct rte_hash_key *)(
1040 (const char *)h->key_store +
1041 key_idx * h->key_entry_size);
1042 rte_prefetch0(key_slot);
1046 if (sec_hitmask[i]) {
1047 uint32_t first_hit = __builtin_ctzl(sec_hitmask[i]);
1048 uint32_t key_idx = secondary_bkt[i]->key_idx[first_hit];
1049 const struct rte_hash_key *key_slot =
1050 (const struct rte_hash_key *)(
1051 (const char *)h->key_store +
1052 key_idx * h->key_entry_size);
1053 rte_prefetch0(key_slot);
1057 /* Compare keys, first hits in primary first */
1058 for (i = 0; i < num_keys; i++) {
1059 positions[i] = -ENOENT;
1060 while (prim_hitmask[i]) {
1061 uint32_t hit_index = __builtin_ctzl(prim_hitmask[i]);
1063 uint32_t key_idx = primary_bkt[i]->key_idx[hit_index];
1064 const struct rte_hash_key *key_slot =
1065 (const struct rte_hash_key *)(
1066 (const char *)h->key_store +
1067 key_idx * h->key_entry_size);
1069 * If key index is 0, do not compare key,
1070 * as it is checking the dummy slot
1072 if (!!key_idx & !rte_hash_cmp_eq(key_slot->key, keys[i], h)) {
1074 data[i] = key_slot->pdata;
1077 positions[i] = key_idx - 1;
1080 prim_hitmask[i] &= ~(1 << (hit_index));
1083 while (sec_hitmask[i]) {
1084 uint32_t hit_index = __builtin_ctzl(sec_hitmask[i]);
1086 uint32_t key_idx = secondary_bkt[i]->key_idx[hit_index];
1087 const struct rte_hash_key *key_slot =
1088 (const struct rte_hash_key *)(
1089 (const char *)h->key_store +
1090 key_idx * h->key_entry_size);
1092 * If key index is 0, do not compare key,
1093 * as it is checking the dummy slot
1096 if (!!key_idx & !rte_hash_cmp_eq(key_slot->key, keys[i], h)) {
1098 data[i] = key_slot->pdata;
1101 positions[i] = key_idx - 1;
1104 sec_hitmask[i] &= ~(1 << (hit_index));
1111 if (hit_mask != NULL)
1116 rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
1117 uint32_t num_keys, int32_t *positions)
1119 RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
1120 (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
1121 (positions == NULL)), -EINVAL);
1123 __rte_hash_lookup_bulk(h, keys, num_keys, positions, NULL, NULL);
1128 rte_hash_lookup_bulk_data(const struct rte_hash *h, const void **keys,
1129 uint32_t num_keys, uint64_t *hit_mask, void *data[])
1131 RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
1132 (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
1133 (hit_mask == NULL)), -EINVAL);
1135 int32_t positions[num_keys];
1137 __rte_hash_lookup_bulk(h, keys, num_keys, positions, hit_mask, data);
1139 /* Return number of hits */
1140 return __builtin_popcountl(*hit_mask);
1144 rte_hash_iterate(const struct rte_hash *h, const void **key, void **data, uint32_t *next)
1146 uint32_t bucket_idx, idx, position;
1147 struct rte_hash_key *next_key;
1149 RETURN_IF_TRUE(((h == NULL) || (next == NULL)), -EINVAL);
1151 const uint32_t total_entries = h->num_buckets * RTE_HASH_BUCKET_ENTRIES;
1153 if (*next >= total_entries)
1156 /* Calculate bucket and index of current iterator */
1157 bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
1158 idx = *next % RTE_HASH_BUCKET_ENTRIES;
1160 /* If current position is empty, go to the next one */
1161 while (h->buckets[bucket_idx].key_idx[idx] == EMPTY_SLOT) {
1164 if (*next == total_entries)
1166 bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
1167 idx = *next % RTE_HASH_BUCKET_ENTRIES;
1170 /* Get position of entry in key table */
1171 position = h->buckets[bucket_idx].key_idx[idx];
1172 next_key = (struct rte_hash_key *) ((char *)h->key_store +
1173 position * h->key_entry_size);
1174 /* Return key and data */
1175 *key = next_key->key;
1176 *data = next_key->pdata;
1178 /* Increment iterator */
1181 return position - 1;