1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 Intel Corporation
6 * This file hold Cuckoo Hash private data structures to allows include from
7 * platform specific files like rte_cuckoo_hash_x86.h
10 #ifndef _RTE_CUCKOO_HASH_H_
11 #define _RTE_CUCKOO_HASH_H_
13 #if defined(RTE_ARCH_X86)
14 #include "rte_cmp_x86.h"
17 #if defined(RTE_ARCH_ARM64)
18 #include "rte_cmp_arm64.h"
21 /* Macro to enable/disable run-time checking of function parameters */
22 #if defined(RTE_LIBRTE_HASH_DEBUG)
23 #define RETURN_IF_TRUE(cond, retval) do { \
28 #define RETURN_IF_TRUE(cond, retval)
31 #include <rte_hash_crc.h>
32 #include <rte_jhash.h>
34 #if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64)
36 * All different options to select a key compare function,
37 * based on the key size and custom function.
39 enum cmp_jump_table_case {
54 * Table storing all different key compare functions
55 * (multi-process supported)
57 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
71 * All different options to select a key compare function,
72 * based on the key size and custom function.
74 enum cmp_jump_table_case {
81 * Table storing all different key compare functions
82 * (multi-process supported)
84 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
92 ADD_KEY_SINGLEWRITER = 0,
94 ADD_KEY_MULTIWRITER_TM,
97 /** Number of items per bucket. */
98 #define RTE_HASH_BUCKET_ENTRIES 8
100 #define NULL_SIGNATURE 0
104 #define KEY_ALIGNMENT 16
106 #define LCORE_CACHE_SIZE 64
108 #define RTE_HASH_MAX_PUSHES 100
110 #define RTE_HASH_BFS_QUEUE_MAX_LEN 1000
112 #define RTE_XABORT_CUCKOO_PATH_INVALIDED 0x4
114 #define RTE_HASH_TSX_MAX_RETRY 10
117 unsigned len; /**< Cache len */
118 void *objs[LCORE_CACHE_SIZE]; /**< Cache objects */
119 } __rte_cache_aligned;
121 /* Structure that stores key-value pair */
122 struct rte_hash_key {
127 /* Variable key size */
129 } __attribute__((aligned(KEY_ALIGNMENT)));
131 /* All different signature compare functions */
132 enum rte_hash_sig_compare_function {
133 RTE_HASH_COMPARE_SCALAR = 0,
134 RTE_HASH_COMPARE_SSE,
135 RTE_HASH_COMPARE_AVX2,
139 /** Bucket structure */
140 struct rte_hash_bucket {
141 hash_sig_t sig_current[RTE_HASH_BUCKET_ENTRIES];
143 uint32_t key_idx[RTE_HASH_BUCKET_ENTRIES];
145 hash_sig_t sig_alt[RTE_HASH_BUCKET_ENTRIES];
147 uint8_t flag[RTE_HASH_BUCKET_ENTRIES];
148 } __rte_cache_aligned;
150 /** A hash table structure. */
152 char name[RTE_HASH_NAMESIZE]; /**< Name of the hash. */
153 uint32_t entries; /**< Total table entries. */
154 uint32_t num_buckets; /**< Number of buckets in table. */
156 struct rte_ring *free_slots;
157 /**< Ring that stores all indexes of the free slots in the key table */
158 uint8_t hw_trans_mem_support;
159 /**< Hardware transactional memory support */
160 struct lcore_cache *local_free_slots;
161 /**< Local cache per lcore, storing some indexes of the free slots */
162 enum add_key_case add_key; /**< Multi-writer hash add behavior */
164 rte_spinlock_t *multiwriter_lock; /**< Multi-writer spinlock for w/o TM */
166 /* Fields used in lookup */
168 uint32_t key_len __rte_cache_aligned;
169 /**< Length of hash key. */
170 rte_hash_function hash_func; /**< Function used to calculate hash. */
171 uint32_t hash_func_init_val; /**< Init value used by hash_func. */
172 rte_hash_cmp_eq_t rte_hash_custom_cmp_eq;
173 /**< Custom function used to compare keys. */
174 enum cmp_jump_table_case cmp_jump_table_idx;
175 /**< Indicates which compare function to use. */
176 enum rte_hash_sig_compare_function sig_cmp_fn;
177 /**< Indicates which signature compare function to use. */
178 uint32_t bucket_bitmask;
179 /**< Bitmask for getting bucket index from hash signature. */
180 uint32_t key_entry_size; /**< Size of each key entry. */
182 void *key_store; /**< Table storing all keys and data */
183 struct rte_hash_bucket *buckets;
184 /**< Table with buckets storing all the hash values and key indexes
187 } __rte_cache_aligned;
190 struct rte_hash_bucket *bkt; /* Current bucket on the bfs search */
192 struct queue_node *prev; /* Parent(bucket) in search path */
193 int prev_slot; /* Parent(slot) in search path */