FD.io VPP  v21.01.1
Vector Packet Processing
bihash_8_16.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 #undef BIHASH_USE_HEAP
23 
24 #define BIHASH_TYPE _8_16
25 #define BIHASH_KVP_PER_PAGE 7
26 #define BIHASH_KVP_AT_BUCKET_LEVEL 1
27 #define BIHASH_LAZY_INSTANTIATE 0
28 #define BIHASH_BUCKET_PREFETCH_CACHE_LINES 2
29 #define BIHASH_USE_HEAP 1
30 
31 #ifndef __included_bihash_8_16_h__
32 #define __included_bihash_8_16_h__
33 
34 #include <vppinfra/heap.h>
35 #include <vppinfra/format.h>
36 #include <vppinfra/pool.h>
37 #include <vppinfra/xxhash.h>
38 #include <vppinfra/crc32.h>
39 
40 /** 8 octet key, 8 octet key value pair */
41 typedef struct
42 {
43  u64 key; /**< the key */
44  u64 value[2]; /**< the value */
46 
47 /** Decide if a clib_bihash_kv_8_16_t instance is free
48  @param v- pointer to the (key,value) pair
49 */
50 static inline int
52 {
53  if (v->key == ~0ULL && v->value[0] == ~0ULL && v->value[1] == ~0ULL)
54  return 1;
55  return 0;
56 }
57 
58 /** Hash a clib_bihash_kv_8_16_t instance
59  @param v - pointer to the (key,value) pair, hash the key (only)
60 */
61 static inline u64
63 {
64  /* Note: to torture-test linear scan, make this fn return a constant */
65 #ifdef clib_crc32c_uses_intrinsics
66  return clib_crc32c ((u8 *) & v->key, 8);
67 #else
68  return clib_xxhash (v->key);
69 #endif
70 }
71 
72 /** Format a clib_bihash_kv_8_16_t instance
73  @param s - u8 * vector under construction
74  @param args (vararg) - the (key,value) pair to format
75  @return s - the u8 * vector under construction
76 */
77 static inline u8 *
78 format_bihash_kvp_8_16 (u8 * s, va_list * args)
79 {
80  clib_bihash_kv_8_16_t *v = va_arg (*args, clib_bihash_kv_8_16_t *);
81 
82  s =
83  format (s, "key %llu value [%ll,%llx]u", v->key, v->value[0],
84  v->value[1]);
85  return s;
86 }
87 
88 /** Compare two clib_bihash_kv_8_16_t instances
89  @param a - first key
90  @param b - second key
91 */
92 static inline int
94 {
95  return a == b;
96 }
97 
98 #undef __included_bihash_template_h__
100 
101 #endif /* __included_bihash_8_16_h__ */
102 
103 /*
104  * fd.io coding-style-patch-verification: ON
105  *
106  * Local Variables:
107  * eval: (c-set-style "gnu")
108  * End:
109  */
a
Definition: bitmap.h:544
unsigned long u64
Definition: types.h:89
Fixed length block allocator.
static u64 clib_xxhash(u64 key)
Definition: xxhash.h:58
unsigned char u8
Definition: types.h:56
static u64 clib_bihash_hash_8_16(clib_bihash_kv_8_16_t *v)
Hash a clib_bihash_kv_8_16_t instance.
Definition: bihash_8_16.h:62
description fragment has unexpected format
Definition: map.api:433
const cJSON *const b
Definition: cJSON.h:255
8 octet key, 8 octet key value pair
Definition: bihash_8_16.h:41
u64 value[2]
the value
Definition: bihash_8_16.h:44
static int clib_bihash_is_free_8_16(clib_bihash_kv_8_16_t *v)
Decide if a clib_bihash_kv_8_16_t instance is free.
Definition: bihash_8_16.h:51
u8 value
Definition: qos.api:54
static u8 * format_bihash_kvp_8_16(u8 *s, va_list *args)
Format a clib_bihash_kv_8_16_t instance.
Definition: bihash_8_16.h:78
static int clib_bihash_key_compare_8_16(u64 a, u64 b)
Compare two clib_bihash_kv_8_16_t instances.
Definition: bihash_8_16.h:93