DPDK  18.11.0
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 /* Macro to enable/disable run-time checking of function parameters */
23 #if defined(RTE_LIBRTE_HASH_DEBUG)
24 #define RETURN_IF_TRUE(cond, retval) do { \
25  if (cond) \
26  return retval; \
27 } while (0)
28 #else
29 #define RETURN_IF_TRUE(cond, retval)
30 #endif
31 
32 #include <rte_hash_crc.h>
33 #include <rte_jhash.h>
34 
35 #if defined(RTE_ARCH_X86) || defined(RTE_ARCH_ARM64)
36 /*
37  * All different options to select a key compare function,
38  * based on the key size and custom function.
39  */
40 enum cmp_jump_table_case {
41  KEY_CUSTOM = 0,
42  KEY_16_BYTES,
43  KEY_32_BYTES,
44  KEY_48_BYTES,
45  KEY_64_BYTES,
46  KEY_80_BYTES,
47  KEY_96_BYTES,
48  KEY_112_BYTES,
49  KEY_128_BYTES,
50  KEY_OTHER_BYTES,
51  NUM_KEY_CMP_CASES,
52 };
53 
54 /*
55  * Table storing all different key compare functions
56  * (multi-process supported)
57  */
58 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
59  NULL,
60  rte_hash_k16_cmp_eq,
61  rte_hash_k32_cmp_eq,
62  rte_hash_k48_cmp_eq,
63  rte_hash_k64_cmp_eq,
64  rte_hash_k80_cmp_eq,
65  rte_hash_k96_cmp_eq,
66  rte_hash_k112_cmp_eq,
67  rte_hash_k128_cmp_eq,
68  memcmp
69 };
70 #else
71 /*
72  * All different options to select a key compare function,
73  * based on the key size and custom function.
74  */
75 enum cmp_jump_table_case {
76  KEY_CUSTOM = 0,
77  KEY_OTHER_BYTES,
78  NUM_KEY_CMP_CASES,
79 };
80 
81 /*
82  * Table storing all different key compare functions
83  * (multi-process supported)
84  */
85 const rte_hash_cmp_eq_t cmp_jump_table[NUM_KEY_CMP_CASES] = {
86  NULL,
87  memcmp
88 };
89 
90 #endif
91 
92 
94 #define RTE_HASH_BUCKET_ENTRIES 8
95 
96 #if !RTE_IS_POWER_OF_2(RTE_HASH_BUCKET_ENTRIES)
97 #error RTE_HASH_BUCKET_ENTRIES must be a power of 2
98 #endif
99 
100 #define NULL_SIGNATURE 0
101 
102 #define EMPTY_SLOT 0
103 
104 #define KEY_ALIGNMENT 16
105 
106 #define LCORE_CACHE_SIZE 64
107 
108 #define RTE_HASH_BFS_QUEUE_MAX_LEN 1000
109 
110 #define RTE_XABORT_CUCKOO_PATH_INVALIDED 0x4
111 
112 #define RTE_HASH_TSX_MAX_RETRY 10
113 
114 struct lcore_cache {
115  unsigned len;
116  void *objs[LCORE_CACHE_SIZE];
118 
119 /* Structure that stores key-value pair */
120 struct rte_hash_key {
121  union {
122  uintptr_t idata;
123  void *pdata;
124  };
125  /* Variable key size */
126  char key[0];
127 };
128 
129 /* All different signature compare functions */
130 enum rte_hash_sig_compare_function {
131  RTE_HASH_COMPARE_SCALAR = 0,
132  RTE_HASH_COMPARE_SSE,
133  RTE_HASH_COMPARE_NUM
134 };
135 
138  uint16_t sig_current[RTE_HASH_BUCKET_ENTRIES];
139 
140  uint32_t key_idx[RTE_HASH_BUCKET_ENTRIES];
141 
142  uint8_t flag[RTE_HASH_BUCKET_ENTRIES];
143 
144  void *next;
146 
148 struct rte_hash {
150  uint32_t entries;
151  uint32_t num_buckets;
156  struct lcore_cache *local_free_slots;
159  /* Fields used in lookup */
160 
161  uint32_t key_len __rte_cache_aligned;
172  uint8_t no_free_on_del;
186  enum cmp_jump_table_case cmp_jump_table_idx;
188  enum rte_hash_sig_compare_function sig_cmp_fn;
190  uint32_t bucket_bitmask;
192  uint32_t key_entry_size;
194  void *key_store;
202  uint32_t *tbl_chng_cnt;
205 
206 struct queue_node {
207  struct rte_hash_bucket *bkt; /* Current bucket on the bfs search */
208  uint32_t cur_bkt_idx;
209 
210  struct queue_node *prev; /* Parent(bucket) in search path */
211  int prev_slot; /* Parent(slot) in search path */
212 };
213 
214 #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
enum rte_hash_sig_compare_function sig_cmp_fn
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
char name[RTE_HASH_NAMESIZE]
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:66
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
enum cmp_jump_table_case cmp_jump_table_idx