FD.io VPP  v20.05-21-gb1500e9ff
Vector Packet Processing
bihash_8_8.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 BIHASH_TYPE
16 #undef BIHASH_KVP_PER_PAGE
17 #undef BIHASH_32_64_SVM
18 #undef BIHASH_ENABLE_STATS
19 #undef BIHASH_KVP_AT_BUCKET_LEVEL
20 #undef BIHASH_LAZY_INSTANTIATE
21 #undef BIHASH_BUCKET_PREFETCH_CACHE_LINES
22 
23 #define BIHASH_TYPE _8_8
24 #define BIHASH_KVP_PER_PAGE 7
25 #define BIHASH_KVP_AT_BUCKET_LEVEL 1
26 #define BIHASH_LAZY_INSTANTIATE 0
27 #define BIHASH_BUCKET_PREFETCH_CACHE_LINES 2
28 
29 #ifndef __included_bihash_8_8_h__
30 #define __included_bihash_8_8_h__
31 
32 #include <vppinfra/heap.h>
33 #include <vppinfra/format.h>
34 #include <vppinfra/pool.h>
35 #include <vppinfra/xxhash.h>
36 #include <vppinfra/crc32.h>
37 
38 /** 8 octet key, 8 octet key value pair */
39 typedef struct
40 {
41  u64 key; /**< the key */
42  u64 value; /**< the value */
44 
45 /** Decide if a clib_bihash_kv_8_8_t instance is free
46  @param v- pointer to the (key,value) pair
47 */
48 static inline int
50 {
51  if (v->key == ~0ULL && v->value == ~0ULL)
52  return 1;
53  return 0;
54 }
55 
56 /** Hash a clib_bihash_kv_8_8_t instance
57  @param v - pointer to the (key,value) pair, hash the key (only)
58 */
59 static inline u64
61 {
62  /* Note: to torture-test linear scan, make this fn return a constant */
63 #ifdef clib_crc32c_uses_intrinsics
64  return clib_crc32c ((u8 *) & v->key, 8);
65 #else
66  return clib_xxhash (v->key);
67 #endif
68 }
69 
70 /** Format a clib_bihash_kv_8_8_t instance
71  @param s - u8 * vector under construction
72  @param args (vararg) - the (key,value) pair to format
73  @return s - the u8 * vector under construction
74 */
75 static inline u8 *
76 format_bihash_kvp_8_8 (u8 * s, va_list * args)
77 {
78  clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
79 
80  s = format (s, "key %llu value %llu", v->key, v->value);
81  return s;
82 }
83 
84 /** Compare two clib_bihash_kv_8_8_t instances
85  @param a - first key
86  @param b - second key
87 */
88 static inline int
90 {
91  return a == b;
92 }
93 
94 #undef __included_bihash_template_h__
96 
97 #endif /* __included_bihash_8_8_h__ */
98 
99 /*
100  * fd.io coding-style-patch-verification: ON
101  *
102  * Local Variables:
103  * eval: (c-set-style "gnu")
104  * End:
105  */
a
Definition: bitmap.h:538
unsigned long u64
Definition: types.h:89
Fixed length block allocator.
static u64 clib_xxhash(u64 key)
Definition: xxhash.h:58
static int clib_bihash_is_free_8_8(clib_bihash_kv_8_8_t *v)
Decide if a clib_bihash_kv_8_8_t instance is free.
Definition: bihash_8_8.h:49
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
unsigned char u8
Definition: types.h:56
u64 key
the key
Definition: bihash_8_8.h:41
u64 value
the value
Definition: bihash_8_8.h:42
8 octet key, 8 octet key value pair
Definition: bihash_8_8.h:39
static u8 * format_bihash_kvp_8_8(u8 *s, va_list *args)
Format a clib_bihash_kv_8_8_t instance.
Definition: bihash_8_8.h:76
static u64 clib_bihash_hash_8_8(clib_bihash_kv_8_8_t *v)
Hash a clib_bihash_kv_8_8_t instance.
Definition: bihash_8_8.h:60
static int clib_bihash_key_compare_8_8(u64 a, u64 b)
Compare two clib_bihash_kv_8_8_t instances.
Definition: bihash_8_8.h:89