1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
10 #include <sys/queue.h>
12 #include <rte_common.h>
13 #include <rte_memory.h> /* for definition of RTE_CACHE_LINE_SIZE */
15 #include <rte_memcpy.h>
16 #include <rte_prefetch.h>
17 #include <rte_branch_prediction.h>
18 #include <rte_malloc.h>
20 #include <rte_eal_memconfig.h>
21 #include <rte_per_lcore.h>
22 #include <rte_errno.h>
23 #include <rte_string_fns.h>
24 #include <rte_cpuflags.h>
25 #include <rte_rwlock.h>
26 #include <rte_spinlock.h>
28 #include <rte_compat.h>
29 #include <rte_pause.h>
32 #include "rte_cuckoo_hash.h"
34 #if defined(RTE_ARCH_X86)
35 #include "rte_cuckoo_hash_x86.h"
38 TAILQ_HEAD(rte_hash_list, rte_tailq_entry);
40 static struct rte_tailq_elem rte_hash_tailq = {
43 EAL_REGISTER_TAILQ(rte_hash_tailq)
46 rte_hash_find_existing(const char *name)
48 struct rte_hash *h = NULL;
49 struct rte_tailq_entry *te;
50 struct rte_hash_list *hash_list;
52 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
54 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
55 TAILQ_FOREACH(te, hash_list, next) {
56 h = (struct rte_hash *) te->data;
57 if (strncmp(name, h->name, RTE_HASH_NAMESIZE) == 0)
60 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
69 void rte_hash_set_cmp_func(struct rte_hash *h, rte_hash_cmp_eq_t func)
71 h->cmp_jump_table_idx = KEY_CUSTOM;
72 h->rte_hash_custom_cmp_eq = func;
76 rte_hash_cmp_eq(const void *key1, const void *key2, const struct rte_hash *h)
78 if (h->cmp_jump_table_idx == KEY_CUSTOM)
79 return h->rte_hash_custom_cmp_eq(key1, key2, h->key_len);
81 return cmp_jump_table[h->cmp_jump_table_idx](key1, key2, h->key_len);
85 rte_hash_create(const struct rte_hash_parameters *params)
87 struct rte_hash *h = NULL;
88 struct rte_tailq_entry *te = NULL;
89 struct rte_hash_list *hash_list;
90 struct rte_ring *r = NULL;
91 char hash_name[RTE_HASH_NAMESIZE];
94 char ring_name[RTE_RING_NAMESIZE];
95 unsigned num_key_slots;
96 unsigned hw_trans_mem_support = 0;
98 rte_hash_function default_hash_func = (rte_hash_function)rte_jhash;
100 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
102 if (params == NULL) {
103 RTE_LOG(ERR, HASH, "rte_hash_create has no parameters\n");
107 /* Check for valid parameters */
108 if ((params->entries > RTE_HASH_ENTRIES_MAX) ||
109 (params->entries < RTE_HASH_BUCKET_ENTRIES) ||
110 (params->key_len == 0)) {
112 RTE_LOG(ERR, HASH, "rte_hash_create has invalid parameters\n");
116 /* Check extra flags field to check extra options. */
117 if (params->extra_flag & RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT)
118 hw_trans_mem_support = 1;
120 /* Store all keys and leave the first entry as a dummy entry for lookup_bulk */
121 if (hw_trans_mem_support)
123 * Increase number of slots by total number of indices
124 * that can be stored in the lcore caches
125 * except for the first cache
127 num_key_slots = params->entries + (RTE_MAX_LCORE - 1) *
128 LCORE_CACHE_SIZE + 1;
130 num_key_slots = params->entries + 1;
132 snprintf(ring_name, sizeof(ring_name), "HT_%s", params->name);
133 /* Create ring (Dummy slot index is not enqueued) */
134 r = rte_ring_create(ring_name, rte_align32pow2(num_key_slots - 1),
135 params->socket_id, 0);
137 RTE_LOG(ERR, HASH, "memory allocation failed\n");
141 snprintf(hash_name, sizeof(hash_name), "HT_%s", params->name);
143 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
145 /* guarantee there's no existing: this is normally already checked
146 * by ring creation above */
147 TAILQ_FOREACH(te, hash_list, next) {
148 h = (struct rte_hash *) te->data;
149 if (strncmp(params->name, h->name, RTE_HASH_NAMESIZE) == 0)
159 te = rte_zmalloc("HASH_TAILQ_ENTRY", sizeof(*te), 0);
161 RTE_LOG(ERR, HASH, "tailq entry allocation failed\n");
165 h = (struct rte_hash *)rte_zmalloc_socket(hash_name, sizeof(struct rte_hash),
166 RTE_CACHE_LINE_SIZE, params->socket_id);
169 RTE_LOG(ERR, HASH, "memory allocation failed\n");
173 const uint32_t num_buckets = rte_align32pow2(params->entries)
174 / RTE_HASH_BUCKET_ENTRIES;
176 buckets = rte_zmalloc_socket(NULL,
177 num_buckets * sizeof(struct rte_hash_bucket),
178 RTE_CACHE_LINE_SIZE, params->socket_id);
180 if (buckets == NULL) {
181 RTE_LOG(ERR, HASH, "memory allocation failed\n");
185 const uint32_t key_entry_size = sizeof(struct rte_hash_key) + params->key_len;
186 const uint64_t key_tbl_size = (uint64_t) key_entry_size * num_key_slots;
188 k = rte_zmalloc_socket(NULL, key_tbl_size,
189 RTE_CACHE_LINE_SIZE, params->socket_id);
192 RTE_LOG(ERR, HASH, "memory allocation failed\n");
197 * If x86 architecture is used, select appropriate compare function,
198 * which may use x86 intrinsics, otherwise use memcmp
200 #if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64)
201 /* Select function to compare keys */
202 switch (params->key_len) {
204 h->cmp_jump_table_idx = KEY_16_BYTES;
207 h->cmp_jump_table_idx = KEY_32_BYTES;
210 h->cmp_jump_table_idx = KEY_48_BYTES;
213 h->cmp_jump_table_idx = KEY_64_BYTES;
216 h->cmp_jump_table_idx = KEY_80_BYTES;
219 h->cmp_jump_table_idx = KEY_96_BYTES;
222 h->cmp_jump_table_idx = KEY_112_BYTES;
225 h->cmp_jump_table_idx = KEY_128_BYTES;
228 /* If key is not multiple of 16, use generic memcmp */
229 h->cmp_jump_table_idx = KEY_OTHER_BYTES;
232 h->cmp_jump_table_idx = KEY_OTHER_BYTES;
235 if (hw_trans_mem_support) {
236 h->local_free_slots = rte_zmalloc_socket(NULL,
237 sizeof(struct lcore_cache) * RTE_MAX_LCORE,
238 RTE_CACHE_LINE_SIZE, params->socket_id);
241 /* Default hash function */
242 #if defined(RTE_ARCH_X86)
243 default_hash_func = (rte_hash_function)rte_hash_crc;
244 #elif defined(RTE_ARCH_ARM64)
245 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_CRC32))
246 default_hash_func = (rte_hash_function)rte_hash_crc;
248 /* Setup hash context */
249 snprintf(h->name, sizeof(h->name), "%s", params->name);
250 h->entries = params->entries;
251 h->key_len = params->key_len;
252 h->key_entry_size = key_entry_size;
253 h->hash_func_init_val = params->hash_func_init_val;
255 h->num_buckets = num_buckets;
256 h->bucket_bitmask = h->num_buckets - 1;
257 h->buckets = buckets;
258 h->hash_func = (params->hash_func == NULL) ?
259 default_hash_func : params->hash_func;
262 h->hw_trans_mem_support = hw_trans_mem_support;
264 #if defined(RTE_ARCH_X86)
265 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
266 h->sig_cmp_fn = RTE_HASH_COMPARE_AVX2;
267 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE2))
268 h->sig_cmp_fn = RTE_HASH_COMPARE_SSE;
271 h->sig_cmp_fn = RTE_HASH_COMPARE_SCALAR;
273 /* Turn on multi-writer only with explicit flat from user and TM
276 if (params->extra_flag & RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD) {
277 if (h->hw_trans_mem_support) {
278 h->add_key = ADD_KEY_MULTIWRITER_TM;
280 h->add_key = ADD_KEY_MULTIWRITER;
281 h->multiwriter_lock = rte_malloc(NULL,
282 sizeof(rte_spinlock_t),
284 rte_spinlock_init(h->multiwriter_lock);
287 h->add_key = ADD_KEY_SINGLEWRITER;
289 /* Populate free slots ring. Entry zero is reserved for key misses. */
290 for (i = 1; i < params->entries + 1; i++)
291 rte_ring_sp_enqueue(r, (void *)((uintptr_t) i));
293 te->data = (void *) h;
294 TAILQ_INSERT_TAIL(hash_list, te, next);
295 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
299 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
310 rte_hash_free(struct rte_hash *h)
312 struct rte_tailq_entry *te;
313 struct rte_hash_list *hash_list;
318 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
320 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
322 /* find out tailq entry */
323 TAILQ_FOREACH(te, hash_list, next) {
324 if (te->data == (void *) h)
329 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
333 TAILQ_REMOVE(hash_list, te, next);
335 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
337 if (h->hw_trans_mem_support)
338 rte_free(h->local_free_slots);
340 if (h->add_key == ADD_KEY_MULTIWRITER)
341 rte_free(h->multiwriter_lock);
342 rte_ring_free(h->free_slots);
343 rte_free(h->key_store);
344 rte_free(h->buckets);
350 rte_hash_hash(const struct rte_hash *h, const void *key)
352 /* calc hash result by key */
353 return h->hash_func(key, h->key_len, h->hash_func_init_val);
356 /* Calc the secondary hash value from the primary hash value of a given key */
357 static inline hash_sig_t
358 rte_hash_secondary_hash(const hash_sig_t primary_hash)
360 static const unsigned all_bits_shift = 12;
361 static const unsigned alt_bits_xor = 0x5bd1e995;
363 uint32_t tag = primary_hash >> all_bits_shift;
365 return primary_hash ^ ((tag + 1) * alt_bits_xor);
369 rte_hash_reset(struct rte_hash *h)
377 memset(h->buckets, 0, h->num_buckets * sizeof(struct rte_hash_bucket));
378 memset(h->key_store, 0, h->key_entry_size * (h->entries + 1));
380 /* clear the free ring */
381 while (rte_ring_dequeue(h->free_slots, &ptr) == 0)
384 /* Repopulate the free slots ring. Entry zero is reserved for key misses */
385 for (i = 1; i < h->entries + 1; i++)
386 rte_ring_sp_enqueue(h->free_slots, (void *)((uintptr_t) i));
388 if (h->hw_trans_mem_support) {
389 /* Reset local caches per lcore */
390 for (i = 0; i < RTE_MAX_LCORE; i++)
391 h->local_free_slots[i].len = 0;
395 /* Search for an entry that can be pushed to its alternative location */
397 make_space_bucket(const struct rte_hash *h, struct rte_hash_bucket *bkt,
398 unsigned int *nr_pushes)
402 uint32_t next_bucket_idx;
403 struct rte_hash_bucket *next_bkt[RTE_HASH_BUCKET_ENTRIES];
406 * Push existing item (search for bucket with space in
407 * alternative locations) to its alternative location
409 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
410 /* Search for space in alternative locations */
411 next_bucket_idx = bkt->sig_alt[i] & h->bucket_bitmask;
412 next_bkt[i] = &h->buckets[next_bucket_idx];
413 for (j = 0; j < RTE_HASH_BUCKET_ENTRIES; j++) {
414 if (next_bkt[i]->key_idx[j] == EMPTY_SLOT)
418 if (j != RTE_HASH_BUCKET_ENTRIES)
422 /* Alternative location has spare room (end of recursive function) */
423 if (i != RTE_HASH_BUCKET_ENTRIES) {
424 next_bkt[i]->sig_alt[j] = bkt->sig_current[i];
425 next_bkt[i]->sig_current[j] = bkt->sig_alt[i];
426 next_bkt[i]->key_idx[j] = bkt->key_idx[i];
430 /* Pick entry that has not been pushed yet */
431 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++)
432 if (bkt->flag[i] == 0)
435 /* All entries have been pushed, so entry cannot be added */
436 if (i == RTE_HASH_BUCKET_ENTRIES || ++(*nr_pushes) > RTE_HASH_MAX_PUSHES)
439 /* Set flag to indicate that this entry is going to be pushed */
442 /* Need room in alternative bucket to insert the pushed entry */
443 ret = make_space_bucket(h, next_bkt[i], nr_pushes);
445 * After recursive function.
446 * Clear flags and insert the pushed entry
447 * in its alternative location if successful,
452 next_bkt[i]->sig_alt[ret] = bkt->sig_current[i];
453 next_bkt[i]->sig_current[ret] = bkt->sig_alt[i];
454 next_bkt[i]->key_idx[ret] = bkt->key_idx[i];
462 * Function called to enqueue back an index in the cache/ring,
463 * as slot has not being used and it can be used in the
464 * next addition attempt.
467 enqueue_slot_back(const struct rte_hash *h,
468 struct lcore_cache *cached_free_slots,
471 if (h->hw_trans_mem_support) {
472 cached_free_slots->objs[cached_free_slots->len] = slot_id;
473 cached_free_slots->len++;
475 rte_ring_sp_enqueue(h->free_slots, slot_id);
478 static inline int32_t
479 __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
480 hash_sig_t sig, void *data)
483 uint32_t prim_bucket_idx, sec_bucket_idx;
485 struct rte_hash_bucket *prim_bkt, *sec_bkt;
486 struct rte_hash_key *new_k, *k, *keys = h->key_store;
487 void *slot_id = NULL;
492 struct lcore_cache *cached_free_slots = NULL;
493 unsigned int nr_pushes = 0;
495 if (h->add_key == ADD_KEY_MULTIWRITER)
496 rte_spinlock_lock(h->multiwriter_lock);
498 prim_bucket_idx = sig & h->bucket_bitmask;
499 prim_bkt = &h->buckets[prim_bucket_idx];
500 rte_prefetch0(prim_bkt);
502 alt_hash = rte_hash_secondary_hash(sig);
503 sec_bucket_idx = alt_hash & h->bucket_bitmask;
504 sec_bkt = &h->buckets[sec_bucket_idx];
505 rte_prefetch0(sec_bkt);
507 /* Get a new slot for storing the new key */
508 if (h->hw_trans_mem_support) {
509 lcore_id = rte_lcore_id();
510 cached_free_slots = &h->local_free_slots[lcore_id];
511 /* Try to get a free slot from the local cache */
512 if (cached_free_slots->len == 0) {
513 /* Need to get another burst of free slots from global ring */
514 n_slots = rte_ring_mc_dequeue_burst(h->free_slots,
515 cached_free_slots->objs,
516 LCORE_CACHE_SIZE, NULL);
522 cached_free_slots->len += n_slots;
525 /* Get a free slot from the local cache */
526 cached_free_slots->len--;
527 slot_id = cached_free_slots->objs[cached_free_slots->len];
529 if (rte_ring_sc_dequeue(h->free_slots, &slot_id) != 0) {
535 new_k = RTE_PTR_ADD(keys, (uintptr_t)slot_id * h->key_entry_size);
536 rte_prefetch0(new_k);
537 new_idx = (uint32_t)((uintptr_t) slot_id);
539 /* Check if key is already inserted in primary location */
540 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
541 if (prim_bkt->sig_current[i] == sig &&
542 prim_bkt->sig_alt[i] == alt_hash) {
543 k = (struct rte_hash_key *) ((char *)keys +
544 prim_bkt->key_idx[i] * h->key_entry_size);
545 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
546 /* Enqueue index of free slot back in the ring. */
547 enqueue_slot_back(h, cached_free_slots, slot_id);
551 * Return index where key is stored,
552 * subtracting the first dummy index
554 ret = prim_bkt->key_idx[i] - 1;
560 /* Check if key is already inserted in secondary location */
561 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
562 if (sec_bkt->sig_alt[i] == sig &&
563 sec_bkt->sig_current[i] == alt_hash) {
564 k = (struct rte_hash_key *) ((char *)keys +
565 sec_bkt->key_idx[i] * h->key_entry_size);
566 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
567 /* Enqueue index of free slot back in the ring. */
568 enqueue_slot_back(h, cached_free_slots, slot_id);
572 * Return index where key is stored,
573 * subtracting the first dummy index
575 ret = sec_bkt->key_idx[i] - 1;
582 rte_memcpy(new_k->key, key, h->key_len);
585 #if defined(RTE_ARCH_X86) /* currently only x86 support HTM */
586 if (h->add_key == ADD_KEY_MULTIWRITER_TM) {
587 ret = rte_hash_cuckoo_insert_mw_tm(prim_bkt,
588 sig, alt_hash, new_idx);
592 /* Primary bucket full, need to make space for new entry */
593 ret = rte_hash_cuckoo_make_space_mw_tm(h, prim_bkt, sig,
599 /* Also search secondary bucket to get better occupancy */
600 ret = rte_hash_cuckoo_make_space_mw_tm(h, sec_bkt, sig,
607 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
608 /* Check if slot is available */
609 if (likely(prim_bkt->key_idx[i] == EMPTY_SLOT)) {
610 prim_bkt->sig_current[i] = sig;
611 prim_bkt->sig_alt[i] = alt_hash;
612 prim_bkt->key_idx[i] = new_idx;
617 if (i != RTE_HASH_BUCKET_ENTRIES) {
618 if (h->add_key == ADD_KEY_MULTIWRITER)
619 rte_spinlock_unlock(h->multiwriter_lock);
623 /* Primary bucket full, need to make space for new entry
624 * After recursive function.
625 * Insert the new entry in the position of the pushed entry
626 * if successful or return error and
627 * store the new slot back in the ring
629 ret = make_space_bucket(h, prim_bkt, &nr_pushes);
631 prim_bkt->sig_current[ret] = sig;
632 prim_bkt->sig_alt[ret] = alt_hash;
633 prim_bkt->key_idx[ret] = new_idx;
634 if (h->add_key == ADD_KEY_MULTIWRITER)
635 rte_spinlock_unlock(h->multiwriter_lock);
638 #if defined(RTE_ARCH_X86)
641 /* Error in addition, store new slot back in the ring and return error */
642 enqueue_slot_back(h, cached_free_slots, (void *)((uintptr_t) new_idx));
645 if (h->add_key == ADD_KEY_MULTIWRITER)
646 rte_spinlock_unlock(h->multiwriter_lock);
651 rte_hash_add_key_with_hash(const struct rte_hash *h,
652 const void *key, hash_sig_t sig)
654 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
655 return __rte_hash_add_key_with_hash(h, key, sig, 0);
659 rte_hash_add_key(const struct rte_hash *h, const void *key)
661 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
662 return __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), 0);
666 rte_hash_add_key_with_hash_data(const struct rte_hash *h,
667 const void *key, hash_sig_t sig, void *data)
671 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
672 ret = __rte_hash_add_key_with_hash(h, key, sig, data);
680 rte_hash_add_key_data(const struct rte_hash *h, const void *key, void *data)
684 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
686 ret = __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), data);
692 static inline int32_t
693 __rte_hash_lookup_with_hash(const struct rte_hash *h, const void *key,
694 hash_sig_t sig, void **data)
699 struct rte_hash_bucket *bkt;
700 struct rte_hash_key *k, *keys = h->key_store;
702 bucket_idx = sig & h->bucket_bitmask;
703 bkt = &h->buckets[bucket_idx];
705 /* Check if key is in primary location */
706 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
707 if (bkt->sig_current[i] == sig &&
708 bkt->key_idx[i] != EMPTY_SLOT) {
709 k = (struct rte_hash_key *) ((char *)keys +
710 bkt->key_idx[i] * h->key_entry_size);
711 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
715 * Return index where key is stored,
716 * subtracting the first dummy index
718 return bkt->key_idx[i] - 1;
723 /* Calculate secondary hash */
724 alt_hash = rte_hash_secondary_hash(sig);
725 bucket_idx = alt_hash & h->bucket_bitmask;
726 bkt = &h->buckets[bucket_idx];
728 /* Check if key is in secondary location */
729 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
730 if (bkt->sig_current[i] == alt_hash &&
731 bkt->sig_alt[i] == sig) {
732 k = (struct rte_hash_key *) ((char *)keys +
733 bkt->key_idx[i] * h->key_entry_size);
734 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
738 * Return index where key is stored,
739 * subtracting the first dummy index
741 return bkt->key_idx[i] - 1;
750 rte_hash_lookup_with_hash(const struct rte_hash *h,
751 const void *key, hash_sig_t sig)
753 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
754 return __rte_hash_lookup_with_hash(h, key, sig, NULL);
758 rte_hash_lookup(const struct rte_hash *h, const void *key)
760 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
761 return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), NULL);
765 rte_hash_lookup_with_hash_data(const struct rte_hash *h,
766 const void *key, hash_sig_t sig, void **data)
768 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
769 return __rte_hash_lookup_with_hash(h, key, sig, data);
773 rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data)
775 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
776 return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), data);
780 remove_entry(const struct rte_hash *h, struct rte_hash_bucket *bkt, unsigned i)
782 unsigned lcore_id, n_slots;
783 struct lcore_cache *cached_free_slots;
785 bkt->sig_current[i] = NULL_SIGNATURE;
786 bkt->sig_alt[i] = NULL_SIGNATURE;
787 if (h->hw_trans_mem_support) {
788 lcore_id = rte_lcore_id();
789 cached_free_slots = &h->local_free_slots[lcore_id];
790 /* Cache full, need to free it. */
791 if (cached_free_slots->len == LCORE_CACHE_SIZE) {
792 /* Need to enqueue the free slots in global ring. */
793 n_slots = rte_ring_mp_enqueue_burst(h->free_slots,
794 cached_free_slots->objs,
795 LCORE_CACHE_SIZE, NULL);
796 cached_free_slots->len -= n_slots;
798 /* Put index of new free slot in cache. */
799 cached_free_slots->objs[cached_free_slots->len] =
800 (void *)((uintptr_t)bkt->key_idx[i]);
801 cached_free_slots->len++;
803 rte_ring_sp_enqueue(h->free_slots,
804 (void *)((uintptr_t)bkt->key_idx[i]));
808 static inline int32_t
809 __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
815 struct rte_hash_bucket *bkt;
816 struct rte_hash_key *k, *keys = h->key_store;
819 bucket_idx = sig & h->bucket_bitmask;
820 bkt = &h->buckets[bucket_idx];
822 /* Check if key is in primary location */
823 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
824 if (bkt->sig_current[i] == sig &&
825 bkt->key_idx[i] != EMPTY_SLOT) {
826 k = (struct rte_hash_key *) ((char *)keys +
827 bkt->key_idx[i] * h->key_entry_size);
828 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
829 remove_entry(h, bkt, i);
832 * Return index where key is stored,
833 * subtracting the first dummy index
835 ret = bkt->key_idx[i] - 1;
836 bkt->key_idx[i] = EMPTY_SLOT;
842 /* Calculate secondary hash */
843 alt_hash = rte_hash_secondary_hash(sig);
844 bucket_idx = alt_hash & h->bucket_bitmask;
845 bkt = &h->buckets[bucket_idx];
847 /* Check if key is in secondary location */
848 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
849 if (bkt->sig_current[i] == alt_hash &&
850 bkt->key_idx[i] != EMPTY_SLOT) {
851 k = (struct rte_hash_key *) ((char *)keys +
852 bkt->key_idx[i] * h->key_entry_size);
853 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
854 remove_entry(h, bkt, i);
857 * Return index where key is stored,
858 * subtracting the first dummy index
860 ret = bkt->key_idx[i] - 1;
861 bkt->key_idx[i] = EMPTY_SLOT;
871 rte_hash_del_key_with_hash(const struct rte_hash *h,
872 const void *key, hash_sig_t sig)
874 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
875 return __rte_hash_del_key_with_hash(h, key, sig);
879 rte_hash_del_key(const struct rte_hash *h, const void *key)
881 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
882 return __rte_hash_del_key_with_hash(h, key, rte_hash_hash(h, key));
886 rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
889 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
891 struct rte_hash_key *k, *keys = h->key_store;
892 k = (struct rte_hash_key *) ((char *) keys + (position + 1) *
897 __rte_hash_lookup_with_hash(h, *key, rte_hash_hash(h, *key),
906 compare_signatures(uint32_t *prim_hash_matches, uint32_t *sec_hash_matches,
907 const struct rte_hash_bucket *prim_bkt,
908 const struct rte_hash_bucket *sec_bkt,
909 hash_sig_t prim_hash, hash_sig_t sec_hash,
910 enum rte_hash_sig_compare_function sig_cmp_fn)
914 switch (sig_cmp_fn) {
915 #ifdef RTE_MACHINE_CPUFLAG_AVX2
916 case RTE_HASH_COMPARE_AVX2:
917 *prim_hash_matches = _mm256_movemask_ps((__m256)_mm256_cmpeq_epi32(
919 (__m256i const *)prim_bkt->sig_current),
920 _mm256_set1_epi32(prim_hash)));
921 *sec_hash_matches = _mm256_movemask_ps((__m256)_mm256_cmpeq_epi32(
923 (__m256i const *)sec_bkt->sig_current),
924 _mm256_set1_epi32(sec_hash)));
927 #ifdef RTE_MACHINE_CPUFLAG_SSE2
928 case RTE_HASH_COMPARE_SSE:
929 /* Compare the first 4 signatures in the bucket */
930 *prim_hash_matches = _mm_movemask_ps((__m128)_mm_cmpeq_epi16(
932 (__m128i const *)prim_bkt->sig_current),
933 _mm_set1_epi32(prim_hash)));
934 *prim_hash_matches |= (_mm_movemask_ps((__m128)_mm_cmpeq_epi16(
936 (__m128i const *)&prim_bkt->sig_current[4]),
937 _mm_set1_epi32(prim_hash)))) << 4;
938 /* Compare the first 4 signatures in the bucket */
939 *sec_hash_matches = _mm_movemask_ps((__m128)_mm_cmpeq_epi16(
941 (__m128i const *)sec_bkt->sig_current),
942 _mm_set1_epi32(sec_hash)));
943 *sec_hash_matches |= (_mm_movemask_ps((__m128)_mm_cmpeq_epi16(
945 (__m128i const *)&sec_bkt->sig_current[4]),
946 _mm_set1_epi32(sec_hash)))) << 4;
950 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
951 *prim_hash_matches |=
952 ((prim_hash == prim_bkt->sig_current[i]) << i);
954 ((sec_hash == sec_bkt->sig_current[i]) << i);
960 #define PREFETCH_OFFSET 4
962 __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
963 int32_t num_keys, int32_t *positions,
964 uint64_t *hit_mask, void *data[])
968 uint32_t prim_hash[RTE_HASH_LOOKUP_BULK_MAX];
969 uint32_t sec_hash[RTE_HASH_LOOKUP_BULK_MAX];
970 const struct rte_hash_bucket *primary_bkt[RTE_HASH_LOOKUP_BULK_MAX];
971 const struct rte_hash_bucket *secondary_bkt[RTE_HASH_LOOKUP_BULK_MAX];
972 uint32_t prim_hitmask[RTE_HASH_LOOKUP_BULK_MAX] = {0};
973 uint32_t sec_hitmask[RTE_HASH_LOOKUP_BULK_MAX] = {0};
975 /* Prefetch first keys */
976 for (i = 0; i < PREFETCH_OFFSET && i < num_keys; i++)
977 rte_prefetch0(keys[i]);
980 * Prefetch rest of the keys, calculate primary and
981 * secondary bucket and prefetch them
983 for (i = 0; i < (num_keys - PREFETCH_OFFSET); i++) {
984 rte_prefetch0(keys[i + PREFETCH_OFFSET]);
986 prim_hash[i] = rte_hash_hash(h, keys[i]);
987 sec_hash[i] = rte_hash_secondary_hash(prim_hash[i]);
989 primary_bkt[i] = &h->buckets[prim_hash[i] & h->bucket_bitmask];
990 secondary_bkt[i] = &h->buckets[sec_hash[i] & h->bucket_bitmask];
992 rte_prefetch0(primary_bkt[i]);
993 rte_prefetch0(secondary_bkt[i]);
996 /* Calculate and prefetch rest of the buckets */
997 for (; i < num_keys; i++) {
998 prim_hash[i] = rte_hash_hash(h, keys[i]);
999 sec_hash[i] = rte_hash_secondary_hash(prim_hash[i]);
1001 primary_bkt[i] = &h->buckets[prim_hash[i] & h->bucket_bitmask];
1002 secondary_bkt[i] = &h->buckets[sec_hash[i] & h->bucket_bitmask];
1004 rte_prefetch0(primary_bkt[i]);
1005 rte_prefetch0(secondary_bkt[i]);
1008 /* Compare signatures and prefetch key slot of first hit */
1009 for (i = 0; i < num_keys; i++) {
1010 compare_signatures(&prim_hitmask[i], &sec_hitmask[i],
1011 primary_bkt[i], secondary_bkt[i],
1012 prim_hash[i], sec_hash[i], h->sig_cmp_fn);
1014 if (prim_hitmask[i]) {
1015 uint32_t first_hit = __builtin_ctzl(prim_hitmask[i]);
1016 uint32_t key_idx = primary_bkt[i]->key_idx[first_hit];
1017 const struct rte_hash_key *key_slot =
1018 (const struct rte_hash_key *)(
1019 (const char *)h->key_store +
1020 key_idx * h->key_entry_size);
1021 rte_prefetch0(key_slot);
1025 if (sec_hitmask[i]) {
1026 uint32_t first_hit = __builtin_ctzl(sec_hitmask[i]);
1027 uint32_t key_idx = secondary_bkt[i]->key_idx[first_hit];
1028 const struct rte_hash_key *key_slot =
1029 (const struct rte_hash_key *)(
1030 (const char *)h->key_store +
1031 key_idx * h->key_entry_size);
1032 rte_prefetch0(key_slot);
1036 /* Compare keys, first hits in primary first */
1037 for (i = 0; i < num_keys; i++) {
1038 positions[i] = -ENOENT;
1039 while (prim_hitmask[i]) {
1040 uint32_t hit_index = __builtin_ctzl(prim_hitmask[i]);
1042 uint32_t key_idx = primary_bkt[i]->key_idx[hit_index];
1043 const struct rte_hash_key *key_slot =
1044 (const struct rte_hash_key *)(
1045 (const char *)h->key_store +
1046 key_idx * h->key_entry_size);
1048 * If key index is 0, do not compare key,
1049 * as it is checking the dummy slot
1051 if (!!key_idx & !rte_hash_cmp_eq(key_slot->key, keys[i], h)) {
1053 data[i] = key_slot->pdata;
1056 positions[i] = key_idx - 1;
1059 prim_hitmask[i] &= ~(1 << (hit_index));
1062 while (sec_hitmask[i]) {
1063 uint32_t hit_index = __builtin_ctzl(sec_hitmask[i]);
1065 uint32_t key_idx = secondary_bkt[i]->key_idx[hit_index];
1066 const struct rte_hash_key *key_slot =
1067 (const struct rte_hash_key *)(
1068 (const char *)h->key_store +
1069 key_idx * h->key_entry_size);
1071 * If key index is 0, do not compare key,
1072 * as it is checking the dummy slot
1075 if (!!key_idx & !rte_hash_cmp_eq(key_slot->key, keys[i], h)) {
1077 data[i] = key_slot->pdata;
1080 positions[i] = key_idx - 1;
1083 sec_hitmask[i] &= ~(1 << (hit_index));
1090 if (hit_mask != NULL)
1095 rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
1096 uint32_t num_keys, int32_t *positions)
1098 RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
1099 (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
1100 (positions == NULL)), -EINVAL);
1102 __rte_hash_lookup_bulk(h, keys, num_keys, positions, NULL, NULL);
1107 rte_hash_lookup_bulk_data(const struct rte_hash *h, const void **keys,
1108 uint32_t num_keys, uint64_t *hit_mask, void *data[])
1110 RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
1111 (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
1112 (hit_mask == NULL)), -EINVAL);
1114 int32_t positions[num_keys];
1116 __rte_hash_lookup_bulk(h, keys, num_keys, positions, hit_mask, data);
1118 /* Return number of hits */
1119 return __builtin_popcountl(*hit_mask);
1123 rte_hash_iterate(const struct rte_hash *h, const void **key, void **data, uint32_t *next)
1125 uint32_t bucket_idx, idx, position;
1126 struct rte_hash_key *next_key;
1128 RETURN_IF_TRUE(((h == NULL) || (next == NULL)), -EINVAL);
1130 const uint32_t total_entries = h->num_buckets * RTE_HASH_BUCKET_ENTRIES;
1132 if (*next >= total_entries)
1135 /* Calculate bucket and index of current iterator */
1136 bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
1137 idx = *next % RTE_HASH_BUCKET_ENTRIES;
1139 /* If current position is empty, go to the next one */
1140 while (h->buckets[bucket_idx].key_idx[idx] == EMPTY_SLOT) {
1143 if (*next == total_entries)
1145 bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
1146 idx = *next % RTE_HASH_BUCKET_ENTRIES;
1149 /* Get position of entry in key table */
1150 position = h->buckets[bucket_idx].key_idx[idx];
1151 next_key = (struct rte_hash_key *) ((char *)h->key_store +
1152 position * h->key_entry_size);
1153 /* Return key and data */
1154 *key = next_key->key;
1155 *data = next_key->pdata;
1157 /* Increment iterator */
1160 return position - 1;