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 /* Hash function used if none is specified */
32 #if defined(RTE_ARCH_X86) || defined(RTE_MACHINE_CPUFLAG_CRC32)
33 #include <rte_hash_crc.h>
34 #define DEFAULT_HASH_FUNC rte_hash_crc
36 #include <rte_jhash.h>
37 #define DEFAULT_HASH_FUNC rte_jhash
40 #if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64)
42 * All different options to select a key compare function,
43 * based on the key size and custom function.
45 enum cmp_jump_table_case {
60 * Table storing all different key compare functions
61 * (multi-process supported)
63 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
77 * All different options to select a key compare function,
78 * based on the key size and custom function.
80 enum cmp_jump_table_case {
87 * Table storing all different key compare functions
88 * (multi-process supported)
90 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
98 ADD_KEY_SINGLEWRITER = 0,
100 ADD_KEY_MULTIWRITER_TM,
103 /** Number of items per bucket. */
104 #define RTE_HASH_BUCKET_ENTRIES 8
106 #define NULL_SIGNATURE 0
110 #define KEY_ALIGNMENT 16
112 #define LCORE_CACHE_SIZE 64
114 #define RTE_HASH_MAX_PUSHES 100
116 #define RTE_HASH_BFS_QUEUE_MAX_LEN 1000
118 #define RTE_XABORT_CUCKOO_PATH_INVALIDED 0x4
120 #define RTE_HASH_TSX_MAX_RETRY 10
123 unsigned len; /**< Cache len */
124 void *objs[LCORE_CACHE_SIZE]; /**< Cache objects */
125 } __rte_cache_aligned;
127 /* Structure that stores key-value pair */
128 struct rte_hash_key {
133 /* Variable key size */
135 } __attribute__((aligned(KEY_ALIGNMENT)));
137 /* All different signature compare functions */
138 enum rte_hash_sig_compare_function {
139 RTE_HASH_COMPARE_SCALAR = 0,
140 RTE_HASH_COMPARE_SSE,
141 RTE_HASH_COMPARE_AVX2,
145 /** Bucket structure */
146 struct rte_hash_bucket {
147 hash_sig_t sig_current[RTE_HASH_BUCKET_ENTRIES];
149 uint32_t key_idx[RTE_HASH_BUCKET_ENTRIES];
151 hash_sig_t sig_alt[RTE_HASH_BUCKET_ENTRIES];
153 uint8_t flag[RTE_HASH_BUCKET_ENTRIES];
154 } __rte_cache_aligned;
156 /** A hash table structure. */
158 char name[RTE_HASH_NAMESIZE]; /**< Name of the hash. */
159 uint32_t entries; /**< Total table entries. */
160 uint32_t num_buckets; /**< Number of buckets in table. */
162 struct rte_ring *free_slots;
163 /**< Ring that stores all indexes of the free slots in the key table */
164 uint8_t hw_trans_mem_support;
165 /**< Hardware transactional memory support */
166 struct lcore_cache *local_free_slots;
167 /**< Local cache per lcore, storing some indexes of the free slots */
168 enum add_key_case add_key; /**< Multi-writer hash add behavior */
170 rte_spinlock_t *multiwriter_lock; /**< Multi-writer spinlock for w/o TM */
172 /* Fields used in lookup */
174 uint32_t key_len __rte_cache_aligned;
175 /**< Length of hash key. */
176 rte_hash_function hash_func; /**< Function used to calculate hash. */
177 uint32_t hash_func_init_val; /**< Init value used by hash_func. */
178 rte_hash_cmp_eq_t rte_hash_custom_cmp_eq;
179 /**< Custom function used to compare keys. */
180 enum cmp_jump_table_case cmp_jump_table_idx;
181 /**< Indicates which compare function to use. */
182 enum rte_hash_sig_compare_function sig_cmp_fn;
183 /**< Indicates which signature compare function to use. */
184 uint32_t bucket_bitmask;
185 /**< Bitmask for getting bucket index from hash signature. */
186 uint32_t key_entry_size; /**< Size of each key entry. */
188 void *key_store; /**< Table storing all keys and data */
189 struct rte_hash_bucket *buckets;
190 /**< Table with buckets storing all the hash values and key indexes
193 } __rte_cache_aligned;
196 struct rte_hash_bucket *bkt; /* Current bucket on the bfs search */
198 struct queue_node *prev; /* Parent(bucket) in search path */
199 int prev_slot; /* Parent(slot) in search path */