FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
cuckoo_8_8.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #undef CLIB_CUCKOO_TYPE
16 
17 #define CLIB_CUCKOO_TYPE _8_8
18 #define CLIB_CUCKOO_KVP_PER_BUCKET (4)
19 #define CLIB_CUCKOO_LOG2_KVP_PER_BUCKET (2)
20 #define CLIB_CUCKOO_BFS_MAX_STEPS (2000)
21 #define CLIB_CUCKOO_BFS_MAX_PATH_LENGTH (8)
22 
23 #ifndef __included_cuckoo_8_8_h__
24 #define __included_cuckoo_8_8_h__
25 
26 #include <vppinfra/heap.h>
27 #include <vppinfra/format.h>
28 #include <vppinfra/pool.h>
29 #include <vppinfra/xxhash.h>
30 #include <vppinfra/cuckoo_debug.h>
31 #include <vppinfra/cuckoo_common.h>
32 
33 #undef CLIB_CUCKOO_OPTIMIZE_PREFETCH
34 #undef CLIB_CUCKOO_OPTIMIZE_UNROLL
35 #undef CLIB_CUCKOO_OPTIMIZE_USE_COUNT_LIMITS_SEARCH
36 #define CLIB_CUCKOO_OPTIMIZE_PREFETCH 1
37 #define CLIB_CUCKOO_OPTIMIZE_UNROLL 1
38 #define CLIB_CUCKOO_OPTIMIZE_USE_COUNT_LIMITS_SEARCH 1
39 
40 #if __SSE4_2__ && !defined (__i386__)
41 #include <x86intrin.h>
42 #endif
43 
44 /** 8 octet key, 8 octet key value pair */
45 typedef struct
46 {
47  u64 key; /**< the key */
48  u64 value; /**< the value */
50 
51 /** Decide if a clib_cuckoo_kv_8_8_t instance is free
52  @param v- pointer to the (key,value) pair
53 */
54 always_inline int
56 {
57  if (v->key == ~0ULL && v->value == ~0ULL)
58  return 1;
59  return 0;
60 }
61 
62 always_inline void
64 {
65  clib_memset (v, 0xff, sizeof (*v));
66 }
67 
68 /** Format a clib_cuckoo_kv_8_8_t instance
69  @param s - u8 * vector under construction
70  @param args (vararg) - the (key,value) pair to format
71  @return s - the u8 * vector under construction
72 */
74 format_cuckoo_kvp_8_8 (u8 * s, va_list * args)
75 {
76  clib_cuckoo_kv_8_8_t *v = va_arg (*args, clib_cuckoo_kv_8_8_t *);
77 
79  {
80  s = format (s, " -- empty -- ");
81  }
82  else
83  {
84  s = format (s, "key %llu value %llu", v->key, v->value);
85  }
86  return s;
87 }
88 
91 {
92 #if defined(clib_crc32c_uses_intrinsics) && !defined (__i386__)
93  return crc32_u64 (0, v->key);
94 #else
95  return clib_xxhash (v->key);
96 #endif
97 }
98 
99 /** Compare two clib_cuckoo_kv_8_8_t instances
100  @param a - first key
101  @param b - second key
102 */
103 always_inline int
105 {
106  return a == b;
107 }
108 
109 #undef __included_cuckoo_template_h__
111 
112 #endif /* __included_cuckoo_8_8_h__ */
113 
114 /*
115  * fd.io coding-style-patch-verification: ON
116  *
117  * Local Variables:
118  * eval: (c-set-style "gnu")
119  * End:
120  */
clib_cuckoo_kv_8_8_t::key
u64 key
the key
Definition: cuckoo_8_8.h:47
cuckoo_template.h
cuckoo_debug.h
cuckoo debugs
clib_cuckoo_kv_8_8_t::value
u64 value
the value
Definition: cuckoo_8_8.h:48
clib_cuckoo_hash_8_8
static u64 clib_cuckoo_hash_8_8(clib_cuckoo_kv_8_8_t *v)
Definition: cuckoo_8_8.h:90
clib_cuckoo_kv_set_free_8_8
static void clib_cuckoo_kv_set_free_8_8(clib_cuckoo_kv_8_8_t *v)
Definition: cuckoo_8_8.h:63
pool.h
Fixed length block allocator. Pools are built from clib vectors and bitmaps. Use pools when repeatedl...
clib_cuckoo_kv_8_8_t
8 octet key, 8 octet key value pair
Definition: cuckoo_8_8.h:45
format.h
clib_xxhash
static u64 clib_xxhash(u64 key)
Definition: xxhash.h:58
clib_cuckoo_kv_is_free_8_8
static int clib_cuckoo_kv_is_free_8_8(const clib_cuckoo_kv_8_8_t *v)
Decide if a clib_cuckoo_kv_8_8_t instance is free.
Definition: cuckoo_8_8.h:55
xxhash.h
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
format_cuckoo_kvp_8_8
static u8 * format_cuckoo_kvp_8_8(u8 *s, va_list *args)
Format a clib_cuckoo_kv_8_8_t instance.
Definition: cuckoo_8_8.h:74
u64
unsigned long u64
Definition: types.h:89
format
description fragment has unexpected format
Definition: map.api:433
clib_cuckoo_key_compare_8_8
static int clib_cuckoo_key_compare_8_8(u64 a, u64 b)
Compare two clib_cuckoo_kv_8_8_t instances.
Definition: cuckoo_8_8.h:104
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
b
vlib_buffer_t ** b
Definition: nat44_ei_out2in.c:717
u8
unsigned char u8
Definition: types.h:56
a
a
Definition: bitmap.h:544
cuckoo_common.h
heap.h