DPDK  18.11.10
rte_cuckoo_hash.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2016 Intel Corporation
3  * Copyright(c) 2018 Arm Limited
4  */
5 
6 /* rte_cuckoo_hash.h
7  * This file hold Cuckoo Hash private data structures to allows include from
8  * platform specific files like rte_cuckoo_hash_x86.h
9  */
10 
11 #ifndef _RTE_CUCKOO_HASH_H_
12 #define _RTE_CUCKOO_HASH_H_
13 
14 #if defined(RTE_ARCH_X86)
15 #include "rte_cmp_x86.h"
16 #endif
17 
18 #if defined(RTE_ARCH_ARM64)
19 #include "rte_cmp_arm64.h"
20 #endif
21 
22 #if defined(RTE_ARCH_MIPS_64)
23 #include "rte_cmp_mips.h"
24 #endif
25 
26 /* Macro to enable/disable run-time checking of function parameters */
27 #if defined(RTE_LIBRTE_HASH_DEBUG)
28 #define RETURN_IF_TRUE(cond, retval) do { \
29  if (cond) \
30  return retval; \
31 } while (0)
32 #else
33 #define RETURN_IF_TRUE(cond, retval)
34 #endif
35 
36 #if defined(RTE_LIBRTE_HASH_DEBUG)
37 #define ERR_IF_TRUE(cond, fmt, args...) do { \
38  if (cond) { \
39  RTE_LOG(ERR, HASH, fmt, ##args); \
40  return; \
41  } \
42 } while (0)
43 #else
44 #define ERR_IF_TRUE(cond, fmt, args...)
45 #endif
46 
47 #include <rte_hash_crc.h>
48 #include <rte_jhash.h>
49 
50 #if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64) || \
51  defined(RTE_ARCH_MIPS_64)
52 /*
53  * All different options to select a key compare function,
54  * based on the key size and custom function.
55  */
56 enum cmp_jump_table_case {
57  KEY_CUSTOM = 0,
58  KEY_16_BYTES,
59  KEY_32_BYTES,
60  KEY_48_BYTES,
61  KEY_64_BYTES,
62  KEY_80_BYTES,
63  KEY_96_BYTES,
64  KEY_112_BYTES,
65  KEY_128_BYTES,
66  KEY_OTHER_BYTES,
67  NUM_KEY_CMP_CASES,
68 };
69 
70 /*
71  * Table storing all different key compare functions
72  * (multi-process supported)
73  */
74 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
75  NULL,
76  rte_hash_k16_cmp_eq,
77  rte_hash_k32_cmp_eq,
78  rte_hash_k48_cmp_eq,
79  rte_hash_k64_cmp_eq,
80  rte_hash_k80_cmp_eq,
81  rte_hash_k96_cmp_eq,
82  rte_hash_k112_cmp_eq,
83  rte_hash_k128_cmp_eq,
84  memcmp
85 };
86 #else
87 /*
88  * All different options to select a key compare function,
89  * based on the key size and custom function.
90  */
91 enum cmp_jump_table_case {
92  KEY_CUSTOM = 0,
93  KEY_OTHER_BYTES,
94  NUM_KEY_CMP_CASES,
95 };
96 
97 /*
98  * Table storing all different key compare functions
99  * (multi-process supported)
100  */
101 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
102  NULL,
103  memcmp
104 };
105 
106 #endif
107 
108 
110 #define RTE_HASH_BUCKET_ENTRIES 8
111 
112 #if !RTE_IS_POWER_OF_2(RTE_HASH_BUCKET_ENTRIES)
113 #error RTE_HASH_BUCKET_ENTRIES must be a power of 2
114 #endif
115 
116 #define NULL_SIGNATURE 0
117 
118 #define EMPTY_SLOT 0
119 
120 #define KEY_ALIGNMENT 16
121 
122 #define LCORE_CACHE_SIZE 64
123 
124 #define RTE_HASH_BFS_QUEUE_MAX_LEN 1000
125 
126 #define RTE_XABORT_CUCKOO_PATH_INVALIDED 0x4
127 
128 #define RTE_HASH_TSX_MAX_RETRY 10
129 
130 struct lcore_cache {
131  unsigned len;
132  void *objs[LCORE_CACHE_SIZE];
134 
135 /* Structure that stores key-value pair */
136 struct rte_hash_key {
137  union {
138  uintptr_t idata;
139  void *pdata;
140  };
141  /* Variable key size */
142  char key[0];
143 };
144 
145 /* All different signature compare functions */
146 enum rte_hash_sig_compare_function {
147  RTE_HASH_COMPARE_SCALAR = 0,
148  RTE_HASH_COMPARE_SSE,
149  RTE_HASH_COMPARE_NUM
150 };
151 
154  uint16_t sig_current[RTE_HASH_BUCKET_ENTRIES];
155 
156  uint32_t key_idx[RTE_HASH_BUCKET_ENTRIES];
157 
158  uint8_t flag[RTE_HASH_BUCKET_ENTRIES];
159 
160  void *next;
162 
164 struct rte_hash {
165  char name[RTE_HASH_NAMESIZE];
166  uint32_t entries;
167  uint32_t num_buckets;
172  struct lcore_cache *local_free_slots;
175  /* Fields used in lookup */
176 
177  uint32_t key_len __rte_cache_aligned;
188  uint8_t no_free_on_del;
202  enum cmp_jump_table_case cmp_jump_table_idx;
204  enum rte_hash_sig_compare_function sig_cmp_fn;
206  uint32_t bucket_bitmask;
208  uint32_t key_entry_size;
210  void *key_store;
218  uint32_t *tbl_chng_cnt;
221 
222 struct queue_node {
223  struct rte_hash_bucket *bkt; /* Current bucket on the bfs search */
224  uint32_t cur_bkt_idx;
225 
226  struct queue_node *prev; /* Parent(bucket) in search path */
227  int prev_slot; /* Parent(slot) in search path */
228 };
229 
230 #endif
uint8_t readwrite_concur_lf_support
uint32_t(* rte_hash_function)(const void *key, uint32_t key_len, uint32_t init_val)
Definition: rte_hash.h:66
uint8_t use_local_cache
void * key_store
uint32_t * tbl_chng_cnt
uint8_t readwrite_concur_support
uint32_t entries
uint32_t key_len __rte_cache_aligned
rte_hash_function hash_func
uint32_t num_buckets
#define RTE_HASH_NAMESIZE
Definition: rte_hash.h:27
uint8_t no_free_on_del
struct rte_ring * free_slots
uint32_t key_entry_size
uint32_t bucket_bitmask
struct rte_ring * free_ext_bkts
int(* rte_hash_cmp_eq_t)(const void *key1, const void *key2, size_t key_len)
Definition: rte_hash.h:70
struct lcore_cache * local_free_slots
rte_rwlock_t * readwrite_lock
uint8_t hw_trans_mem_support
#define __rte_cache_aligned
Definition: rte_memory.h:67
struct rte_hash_bucket * buckets_ext
rte_hash_cmp_eq_t rte_hash_custom_cmp_eq
uint8_t writer_takes_lock
uint8_t ext_table_support
uint32_t hash_func_init_val
struct rte_hash_bucket * buckets