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) + 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),
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),
283 RTE_CACHE_LINE_SIZE);
284 if (h->multiwriter_lock == NULL)
287 rte_spinlock_init(h->multiwriter_lock);
290 h->add_key = ADD_KEY_SINGLEWRITER;
292 /* Populate free slots ring. Entry zero is reserved for key misses. */
293 for (i = 1; i < num_key_slots; i++)
294 rte_ring_sp_enqueue(r, (void *)((uintptr_t) i));
296 te->data = (void *) h;
297 TAILQ_INSERT_TAIL(hash_list, te, next);
298 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
302 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
313 rte_hash_free(struct rte_hash *h)
315 struct rte_tailq_entry *te;
316 struct rte_hash_list *hash_list;
321 hash_list = RTE_TAILQ_CAST(rte_hash_tailq.head, rte_hash_list);
323 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
325 /* find out tailq entry */
326 TAILQ_FOREACH(te, hash_list, next) {
327 if (te->data == (void *) h)
332 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
336 TAILQ_REMOVE(hash_list, te, next);
338 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
340 if (h->hw_trans_mem_support)
341 rte_free(h->local_free_slots);
343 if (h->add_key == ADD_KEY_MULTIWRITER)
344 rte_free(h->multiwriter_lock);
345 rte_ring_free(h->free_slots);
346 rte_free(h->key_store);
347 rte_free(h->buckets);
353 rte_hash_hash(const struct rte_hash *h, const void *key)
355 /* calc hash result by key */
356 return h->hash_func(key, h->key_len, h->hash_func_init_val);
359 /* Calc the secondary hash value from the primary hash value of a given key */
360 static inline hash_sig_t
361 rte_hash_secondary_hash(const hash_sig_t primary_hash)
363 static const unsigned all_bits_shift = 12;
364 static const unsigned alt_bits_xor = 0x5bd1e995;
366 uint32_t tag = primary_hash >> all_bits_shift;
368 return primary_hash ^ ((tag + 1) * alt_bits_xor);
372 rte_hash_reset(struct rte_hash *h)
375 uint32_t tot_ring_cnt, i;
380 memset(h->buckets, 0, h->num_buckets * sizeof(struct rte_hash_bucket));
381 memset(h->key_store, 0, h->key_entry_size * (h->entries + 1));
383 /* clear the free ring */
384 while (rte_ring_dequeue(h->free_slots, &ptr) == 0)
387 /* Repopulate the free slots ring. Entry zero is reserved for key misses */
388 if (h->hw_trans_mem_support)
389 tot_ring_cnt = h->entries + (RTE_MAX_LCORE - 1) *
390 (LCORE_CACHE_SIZE - 1);
392 tot_ring_cnt = h->entries;
394 for (i = 1; i < tot_ring_cnt + 1; i++)
395 rte_ring_sp_enqueue(h->free_slots, (void *)((uintptr_t) i));
397 if (h->hw_trans_mem_support) {
398 /* Reset local caches per lcore */
399 for (i = 0; i < RTE_MAX_LCORE; i++)
400 h->local_free_slots[i].len = 0;
404 /* Search for an entry that can be pushed to its alternative location */
406 make_space_bucket(const struct rte_hash *h, struct rte_hash_bucket *bkt,
407 unsigned int *nr_pushes)
411 uint32_t next_bucket_idx;
412 struct rte_hash_bucket *next_bkt[RTE_HASH_BUCKET_ENTRIES];
415 * Push existing item (search for bucket with space in
416 * alternative locations) to its alternative location
418 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
419 /* Search for space in alternative locations */
420 next_bucket_idx = bkt->sig_alt[i] & h->bucket_bitmask;
421 next_bkt[i] = &h->buckets[next_bucket_idx];
422 for (j = 0; j < RTE_HASH_BUCKET_ENTRIES; j++) {
423 if (next_bkt[i]->key_idx[j] == EMPTY_SLOT)
427 if (j != RTE_HASH_BUCKET_ENTRIES)
431 /* Alternative location has spare room (end of recursive function) */
432 if (i != RTE_HASH_BUCKET_ENTRIES) {
433 next_bkt[i]->sig_alt[j] = bkt->sig_current[i];
434 next_bkt[i]->sig_current[j] = bkt->sig_alt[i];
435 next_bkt[i]->key_idx[j] = bkt->key_idx[i];
439 /* Pick entry that has not been pushed yet */
440 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++)
441 if (bkt->flag[i] == 0)
444 /* All entries have been pushed, so entry cannot be added */
445 if (i == RTE_HASH_BUCKET_ENTRIES || ++(*nr_pushes) > RTE_HASH_MAX_PUSHES)
448 /* Set flag to indicate that this entry is going to be pushed */
451 /* Need room in alternative bucket to insert the pushed entry */
452 ret = make_space_bucket(h, next_bkt[i], nr_pushes);
454 * After recursive function.
455 * Clear flags and insert the pushed entry
456 * in its alternative location if successful,
461 next_bkt[i]->sig_alt[ret] = bkt->sig_current[i];
462 next_bkt[i]->sig_current[ret] = bkt->sig_alt[i];
463 next_bkt[i]->key_idx[ret] = bkt->key_idx[i];
471 * Function called to enqueue back an index in the cache/ring,
472 * as slot has not being used and it can be used in the
473 * next addition attempt.
476 enqueue_slot_back(const struct rte_hash *h,
477 struct lcore_cache *cached_free_slots,
480 if (h->hw_trans_mem_support) {
481 cached_free_slots->objs[cached_free_slots->len] = slot_id;
482 cached_free_slots->len++;
484 rte_ring_sp_enqueue(h->free_slots, slot_id);
487 static inline int32_t
488 __rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key,
489 hash_sig_t sig, void *data)
492 uint32_t prim_bucket_idx, sec_bucket_idx;
494 struct rte_hash_bucket *prim_bkt, *sec_bkt;
495 struct rte_hash_key *new_k, *k, *keys = h->key_store;
496 void *slot_id = NULL;
501 struct lcore_cache *cached_free_slots = NULL;
502 unsigned int nr_pushes = 0;
504 if (h->add_key == ADD_KEY_MULTIWRITER)
505 rte_spinlock_lock(h->multiwriter_lock);
507 prim_bucket_idx = sig & h->bucket_bitmask;
508 prim_bkt = &h->buckets[prim_bucket_idx];
509 rte_prefetch0(prim_bkt);
511 alt_hash = rte_hash_secondary_hash(sig);
512 sec_bucket_idx = alt_hash & h->bucket_bitmask;
513 sec_bkt = &h->buckets[sec_bucket_idx];
514 rte_prefetch0(sec_bkt);
516 /* Get a new slot for storing the new key */
517 if (h->hw_trans_mem_support) {
518 lcore_id = rte_lcore_id();
519 cached_free_slots = &h->local_free_slots[lcore_id];
520 /* Try to get a free slot from the local cache */
521 if (cached_free_slots->len == 0) {
522 /* Need to get another burst of free slots from global ring */
523 n_slots = rte_ring_mc_dequeue_burst(h->free_slots,
524 cached_free_slots->objs,
525 LCORE_CACHE_SIZE, NULL);
531 cached_free_slots->len += n_slots;
534 /* Get a free slot from the local cache */
535 cached_free_slots->len--;
536 slot_id = cached_free_slots->objs[cached_free_slots->len];
538 if (rte_ring_sc_dequeue(h->free_slots, &slot_id) != 0) {
544 new_k = RTE_PTR_ADD(keys, (uintptr_t)slot_id * h->key_entry_size);
545 rte_prefetch0(new_k);
546 new_idx = (uint32_t)((uintptr_t) slot_id);
548 /* Check if key is already inserted in primary location */
549 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
550 if (prim_bkt->sig_current[i] == sig &&
551 prim_bkt->sig_alt[i] == alt_hash) {
552 k = (struct rte_hash_key *) ((char *)keys +
553 prim_bkt->key_idx[i] * h->key_entry_size);
554 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
555 /* Enqueue index of free slot back in the ring. */
556 enqueue_slot_back(h, cached_free_slots, slot_id);
560 * Return index where key is stored,
561 * subtracting the first dummy index
563 ret = prim_bkt->key_idx[i] - 1;
569 /* Check if key is already inserted in secondary location */
570 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
571 if (sec_bkt->sig_alt[i] == sig &&
572 sec_bkt->sig_current[i] == alt_hash) {
573 k = (struct rte_hash_key *) ((char *)keys +
574 sec_bkt->key_idx[i] * h->key_entry_size);
575 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
576 /* Enqueue index of free slot back in the ring. */
577 enqueue_slot_back(h, cached_free_slots, slot_id);
581 * Return index where key is stored,
582 * subtracting the first dummy index
584 ret = sec_bkt->key_idx[i] - 1;
591 rte_memcpy(new_k->key, key, h->key_len);
594 #if defined(RTE_ARCH_X86) /* currently only x86 support HTM */
595 if (h->add_key == ADD_KEY_MULTIWRITER_TM) {
596 ret = rte_hash_cuckoo_insert_mw_tm(prim_bkt,
597 sig, alt_hash, new_idx);
601 /* Primary bucket full, need to make space for new entry */
602 ret = rte_hash_cuckoo_make_space_mw_tm(h, prim_bkt, sig,
608 /* Also search secondary bucket to get better occupancy */
609 ret = rte_hash_cuckoo_make_space_mw_tm(h, sec_bkt, sig,
616 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
617 /* Check if slot is available */
618 if (likely(prim_bkt->key_idx[i] == EMPTY_SLOT)) {
619 prim_bkt->sig_current[i] = sig;
620 prim_bkt->sig_alt[i] = alt_hash;
621 prim_bkt->key_idx[i] = new_idx;
626 if (i != RTE_HASH_BUCKET_ENTRIES) {
627 if (h->add_key == ADD_KEY_MULTIWRITER)
628 rte_spinlock_unlock(h->multiwriter_lock);
632 /* Primary bucket full, need to make space for new entry
633 * After recursive function.
634 * Insert the new entry in the position of the pushed entry
635 * if successful or return error and
636 * store the new slot back in the ring
638 ret = make_space_bucket(h, prim_bkt, &nr_pushes);
640 prim_bkt->sig_current[ret] = sig;
641 prim_bkt->sig_alt[ret] = alt_hash;
642 prim_bkt->key_idx[ret] = new_idx;
643 if (h->add_key == ADD_KEY_MULTIWRITER)
644 rte_spinlock_unlock(h->multiwriter_lock);
647 #if defined(RTE_ARCH_X86)
650 /* Error in addition, store new slot back in the ring and return error */
651 enqueue_slot_back(h, cached_free_slots, (void *)((uintptr_t) new_idx));
654 if (h->add_key == ADD_KEY_MULTIWRITER)
655 rte_spinlock_unlock(h->multiwriter_lock);
660 rte_hash_add_key_with_hash(const struct rte_hash *h,
661 const void *key, hash_sig_t sig)
663 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
664 return __rte_hash_add_key_with_hash(h, key, sig, 0);
668 rte_hash_add_key(const struct rte_hash *h, const void *key)
670 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
671 return __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), 0);
675 rte_hash_add_key_with_hash_data(const struct rte_hash *h,
676 const void *key, hash_sig_t sig, void *data)
680 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
681 ret = __rte_hash_add_key_with_hash(h, key, sig, data);
689 rte_hash_add_key_data(const struct rte_hash *h, const void *key, void *data)
693 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
695 ret = __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key), data);
701 static inline int32_t
702 __rte_hash_lookup_with_hash(const struct rte_hash *h, const void *key,
703 hash_sig_t sig, void **data)
708 struct rte_hash_bucket *bkt;
709 struct rte_hash_key *k, *keys = h->key_store;
711 bucket_idx = sig & h->bucket_bitmask;
712 bkt = &h->buckets[bucket_idx];
714 /* Check if key is in primary location */
715 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
716 if (bkt->sig_current[i] == sig &&
717 bkt->key_idx[i] != EMPTY_SLOT) {
718 k = (struct rte_hash_key *) ((char *)keys +
719 bkt->key_idx[i] * h->key_entry_size);
720 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
724 * Return index where key is stored,
725 * subtracting the first dummy index
727 return bkt->key_idx[i] - 1;
732 /* Calculate secondary hash */
733 alt_hash = rte_hash_secondary_hash(sig);
734 bucket_idx = alt_hash & h->bucket_bitmask;
735 bkt = &h->buckets[bucket_idx];
737 /* Check if key is in secondary location */
738 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
739 if (bkt->sig_current[i] == alt_hash &&
740 bkt->sig_alt[i] == sig) {
741 k = (struct rte_hash_key *) ((char *)keys +
742 bkt->key_idx[i] * h->key_entry_size);
743 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
747 * Return index where key is stored,
748 * subtracting the first dummy index
750 return bkt->key_idx[i] - 1;
759 rte_hash_lookup_with_hash(const struct rte_hash *h,
760 const void *key, hash_sig_t sig)
762 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
763 return __rte_hash_lookup_with_hash(h, key, sig, NULL);
767 rte_hash_lookup(const struct rte_hash *h, const void *key)
769 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
770 return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), NULL);
774 rte_hash_lookup_with_hash_data(const struct rte_hash *h,
775 const void *key, hash_sig_t sig, void **data)
777 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
778 return __rte_hash_lookup_with_hash(h, key, sig, data);
782 rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data)
784 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
785 return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key), data);
789 remove_entry(const struct rte_hash *h, struct rte_hash_bucket *bkt, unsigned i)
791 unsigned lcore_id, n_slots;
792 struct lcore_cache *cached_free_slots;
794 bkt->sig_current[i] = NULL_SIGNATURE;
795 bkt->sig_alt[i] = NULL_SIGNATURE;
796 if (h->hw_trans_mem_support) {
797 lcore_id = rte_lcore_id();
798 cached_free_slots = &h->local_free_slots[lcore_id];
799 /* Cache full, need to free it. */
800 if (cached_free_slots->len == LCORE_CACHE_SIZE) {
801 /* Need to enqueue the free slots in global ring. */
802 n_slots = rte_ring_mp_enqueue_burst(h->free_slots,
803 cached_free_slots->objs,
804 LCORE_CACHE_SIZE, NULL);
805 cached_free_slots->len -= n_slots;
807 /* Put index of new free slot in cache. */
808 cached_free_slots->objs[cached_free_slots->len] =
809 (void *)((uintptr_t)bkt->key_idx[i]);
810 cached_free_slots->len++;
812 rte_ring_sp_enqueue(h->free_slots,
813 (void *)((uintptr_t)bkt->key_idx[i]));
817 static inline int32_t
818 __rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key,
824 struct rte_hash_bucket *bkt;
825 struct rte_hash_key *k, *keys = h->key_store;
828 bucket_idx = sig & h->bucket_bitmask;
829 bkt = &h->buckets[bucket_idx];
831 /* Check if key is in primary location */
832 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
833 if (bkt->sig_current[i] == sig &&
834 bkt->key_idx[i] != EMPTY_SLOT) {
835 k = (struct rte_hash_key *) ((char *)keys +
836 bkt->key_idx[i] * h->key_entry_size);
837 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
838 remove_entry(h, bkt, i);
841 * Return index where key is stored,
842 * subtracting the first dummy index
844 ret = bkt->key_idx[i] - 1;
845 bkt->key_idx[i] = EMPTY_SLOT;
851 /* Calculate secondary hash */
852 alt_hash = rte_hash_secondary_hash(sig);
853 bucket_idx = alt_hash & h->bucket_bitmask;
854 bkt = &h->buckets[bucket_idx];
856 /* Check if key is in secondary location */
857 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
858 if (bkt->sig_current[i] == alt_hash &&
859 bkt->key_idx[i] != EMPTY_SLOT) {
860 k = (struct rte_hash_key *) ((char *)keys +
861 bkt->key_idx[i] * h->key_entry_size);
862 if (rte_hash_cmp_eq(key, k->key, h) == 0) {
863 remove_entry(h, bkt, i);
866 * Return index where key is stored,
867 * subtracting the first dummy index
869 ret = bkt->key_idx[i] - 1;
870 bkt->key_idx[i] = EMPTY_SLOT;
880 rte_hash_del_key_with_hash(const struct rte_hash *h,
881 const void *key, hash_sig_t sig)
883 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
884 return __rte_hash_del_key_with_hash(h, key, sig);
888 rte_hash_del_key(const struct rte_hash *h, const void *key)
890 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
891 return __rte_hash_del_key_with_hash(h, key, rte_hash_hash(h, key));
895 rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
898 RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
900 struct rte_hash_key *k, *keys = h->key_store;
901 k = (struct rte_hash_key *) ((char *) keys + (position + 1) *
906 __rte_hash_lookup_with_hash(h, *key, rte_hash_hash(h, *key),
915 compare_signatures(uint32_t *prim_hash_matches, uint32_t *sec_hash_matches,
916 const struct rte_hash_bucket *prim_bkt,
917 const struct rte_hash_bucket *sec_bkt,
918 hash_sig_t prim_hash, hash_sig_t sec_hash,
919 enum rte_hash_sig_compare_function sig_cmp_fn)
923 switch (sig_cmp_fn) {
924 #ifdef RTE_MACHINE_CPUFLAG_AVX2
925 case RTE_HASH_COMPARE_AVX2:
926 *prim_hash_matches = _mm256_movemask_ps((__m256)_mm256_cmpeq_epi32(
928 (__m256i const *)prim_bkt->sig_current),
929 _mm256_set1_epi32(prim_hash)));
930 *sec_hash_matches = _mm256_movemask_ps((__m256)_mm256_cmpeq_epi32(
932 (__m256i const *)sec_bkt->sig_current),
933 _mm256_set1_epi32(sec_hash)));
936 #ifdef RTE_MACHINE_CPUFLAG_SSE2
937 case RTE_HASH_COMPARE_SSE:
938 /* Compare the first 4 signatures in the bucket */
939 *prim_hash_matches = _mm_movemask_ps((__m128)_mm_cmpeq_epi16(
941 (__m128i const *)prim_bkt->sig_current),
942 _mm_set1_epi32(prim_hash)));
943 *prim_hash_matches |= (_mm_movemask_ps((__m128)_mm_cmpeq_epi16(
945 (__m128i const *)&prim_bkt->sig_current[4]),
946 _mm_set1_epi32(prim_hash)))) << 4;
947 /* Compare the first 4 signatures in the bucket */
948 *sec_hash_matches = _mm_movemask_ps((__m128)_mm_cmpeq_epi16(
950 (__m128i const *)sec_bkt->sig_current),
951 _mm_set1_epi32(sec_hash)));
952 *sec_hash_matches |= (_mm_movemask_ps((__m128)_mm_cmpeq_epi16(
954 (__m128i const *)&sec_bkt->sig_current[4]),
955 _mm_set1_epi32(sec_hash)))) << 4;
959 for (i = 0; i < RTE_HASH_BUCKET_ENTRIES; i++) {
960 *prim_hash_matches |=
961 ((prim_hash == prim_bkt->sig_current[i]) << i);
963 ((sec_hash == sec_bkt->sig_current[i]) << i);
969 #define PREFETCH_OFFSET 4
971 __rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
972 int32_t num_keys, int32_t *positions,
973 uint64_t *hit_mask, void *data[])
977 uint32_t prim_hash[RTE_HASH_LOOKUP_BULK_MAX];
978 uint32_t sec_hash[RTE_HASH_LOOKUP_BULK_MAX];
979 const struct rte_hash_bucket *primary_bkt[RTE_HASH_LOOKUP_BULK_MAX];
980 const struct rte_hash_bucket *secondary_bkt[RTE_HASH_LOOKUP_BULK_MAX];
981 uint32_t prim_hitmask[RTE_HASH_LOOKUP_BULK_MAX] = {0};
982 uint32_t sec_hitmask[RTE_HASH_LOOKUP_BULK_MAX] = {0};
984 /* Prefetch first keys */
985 for (i = 0; i < PREFETCH_OFFSET && i < num_keys; i++)
986 rte_prefetch0(keys[i]);
989 * Prefetch rest of the keys, calculate primary and
990 * secondary bucket and prefetch them
992 for (i = 0; i < (num_keys - PREFETCH_OFFSET); i++) {
993 rte_prefetch0(keys[i + PREFETCH_OFFSET]);
995 prim_hash[i] = rte_hash_hash(h, keys[i]);
996 sec_hash[i] = rte_hash_secondary_hash(prim_hash[i]);
998 primary_bkt[i] = &h->buckets[prim_hash[i] & h->bucket_bitmask];
999 secondary_bkt[i] = &h->buckets[sec_hash[i] & h->bucket_bitmask];
1001 rte_prefetch0(primary_bkt[i]);
1002 rte_prefetch0(secondary_bkt[i]);
1005 /* Calculate and prefetch rest of the buckets */
1006 for (; i < num_keys; i++) {
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 /* Compare signatures and prefetch key slot of first hit */
1018 for (i = 0; i < num_keys; i++) {
1019 compare_signatures(&prim_hitmask[i], &sec_hitmask[i],
1020 primary_bkt[i], secondary_bkt[i],
1021 prim_hash[i], sec_hash[i], h->sig_cmp_fn);
1023 if (prim_hitmask[i]) {
1024 uint32_t first_hit = __builtin_ctzl(prim_hitmask[i]);
1025 uint32_t key_idx = primary_bkt[i]->key_idx[first_hit];
1026 const struct rte_hash_key *key_slot =
1027 (const struct rte_hash_key *)(
1028 (const char *)h->key_store +
1029 key_idx * h->key_entry_size);
1030 rte_prefetch0(key_slot);
1034 if (sec_hitmask[i]) {
1035 uint32_t first_hit = __builtin_ctzl(sec_hitmask[i]);
1036 uint32_t key_idx = secondary_bkt[i]->key_idx[first_hit];
1037 const struct rte_hash_key *key_slot =
1038 (const struct rte_hash_key *)(
1039 (const char *)h->key_store +
1040 key_idx * h->key_entry_size);
1041 rte_prefetch0(key_slot);
1045 /* Compare keys, first hits in primary first */
1046 for (i = 0; i < num_keys; i++) {
1047 positions[i] = -ENOENT;
1048 while (prim_hitmask[i]) {
1049 uint32_t hit_index = __builtin_ctzl(prim_hitmask[i]);
1051 uint32_t key_idx = primary_bkt[i]->key_idx[hit_index];
1052 const struct rte_hash_key *key_slot =
1053 (const struct rte_hash_key *)(
1054 (const char *)h->key_store +
1055 key_idx * h->key_entry_size);
1057 * If key index is 0, do not compare key,
1058 * as it is checking the dummy slot
1060 if (!!key_idx & !rte_hash_cmp_eq(key_slot->key, keys[i], h)) {
1062 data[i] = key_slot->pdata;
1065 positions[i] = key_idx - 1;
1068 prim_hitmask[i] &= ~(1 << (hit_index));
1071 while (sec_hitmask[i]) {
1072 uint32_t hit_index = __builtin_ctzl(sec_hitmask[i]);
1074 uint32_t key_idx = secondary_bkt[i]->key_idx[hit_index];
1075 const struct rte_hash_key *key_slot =
1076 (const struct rte_hash_key *)(
1077 (const char *)h->key_store +
1078 key_idx * h->key_entry_size);
1080 * If key index is 0, do not compare key,
1081 * as it is checking the dummy slot
1084 if (!!key_idx & !rte_hash_cmp_eq(key_slot->key, keys[i], h)) {
1086 data[i] = key_slot->pdata;
1089 positions[i] = key_idx - 1;
1092 sec_hitmask[i] &= ~(1 << (hit_index));
1099 if (hit_mask != NULL)
1104 rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
1105 uint32_t num_keys, int32_t *positions)
1107 RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
1108 (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
1109 (positions == NULL)), -EINVAL);
1111 __rte_hash_lookup_bulk(h, keys, num_keys, positions, NULL, NULL);
1116 rte_hash_lookup_bulk_data(const struct rte_hash *h, const void **keys,
1117 uint32_t num_keys, uint64_t *hit_mask, void *data[])
1119 RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
1120 (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
1121 (hit_mask == NULL)), -EINVAL);
1123 int32_t positions[num_keys];
1125 __rte_hash_lookup_bulk(h, keys, num_keys, positions, hit_mask, data);
1127 /* Return number of hits */
1128 return __builtin_popcountl(*hit_mask);
1132 rte_hash_iterate(const struct rte_hash *h, const void **key, void **data, uint32_t *next)
1134 uint32_t bucket_idx, idx, position;
1135 struct rte_hash_key *next_key;
1137 RETURN_IF_TRUE(((h == NULL) || (next == NULL)), -EINVAL);
1139 const uint32_t total_entries = h->num_buckets * RTE_HASH_BUCKET_ENTRIES;
1141 if (*next >= total_entries)
1144 /* Calculate bucket and index of current iterator */
1145 bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
1146 idx = *next % RTE_HASH_BUCKET_ENTRIES;
1148 /* If current position is empty, go to the next one */
1149 while (h->buckets[bucket_idx].key_idx[idx] == EMPTY_SLOT) {
1152 if (*next == total_entries)
1154 bucket_idx = *next / RTE_HASH_BUCKET_ENTRIES;
1155 idx = *next % RTE_HASH_BUCKET_ENTRIES;
1158 /* Get position of entry in key table */
1159 position = h->buckets[bucket_idx].key_idx[idx];
1160 next_key = (struct rte_hash_key *) ((char *)h->key_store +
1161 position * h->key_entry_size);
1162 /* Return key and data */
1163 *key = next_key->key;
1164 *data = next_key->pdata;
1166 /* Increment iterator */
1169 return position - 1;