FD.io VPP  v19.04.4-rc0-5-ge88582fac
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 
18 #define BIHASH_TYPE _8_8
19 #define BIHASH_KVP_PER_PAGE 4
20 
21 #ifndef __included_bihash_8_8_h__
22 #define __included_bihash_8_8_h__
23 
24 #include <vppinfra/heap.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/pool.h>
27 #include <vppinfra/xxhash.h>
28 #include <vppinfra/crc32.h>
29 
30 /** 8 octet key, 8 octet key value pair */
31 typedef struct
32 {
33  u64 key; /**< the key */
34  u64 value; /**< the value */
36 
37 /** Decide if a clib_bihash_kv_8_8_t instance is free
38  @param v- pointer to the (key,value) pair
39 */
40 static inline int
42 {
43  if (v->key == ~0ULL && v->value == ~0ULL)
44  return 1;
45  return 0;
46 }
47 
48 /** Hash a clib_bihash_kv_8_8_t instance
49  @param v - pointer to the (key,value) pair, hash the key (only)
50 */
51 static inline u64
53 {
54  /* Note: to torture-test linear scan, make this fn return a constant */
55 #ifdef clib_crc32c_uses_intrinsics
56  return clib_crc32c ((u8 *) & v->key, 8);
57 #else
58  return clib_xxhash (v->key);
59 #endif
60 }
61 
62 /** Format a clib_bihash_kv_8_8_t instance
63  @param s - u8 * vector under construction
64  @param args (vararg) - the (key,value) pair to format
65  @return s - the u8 * vector under construction
66 */
67 static inline u8 *
68 format_bihash_kvp_8_8 (u8 * s, va_list * args)
69 {
70  clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
71 
72  s = format (s, "key %llu value %llu", v->key, v->value);
73  return s;
74 }
75 
76 /** Compare two clib_bihash_kv_8_8_t instances
77  @param a - first key
78  @param b - second key
79 */
80 static inline int
82 {
83  return a == b;
84 }
85 
86 #undef __included_bihash_template_h__
88 
89 #endif /* __included_bihash_8_8_h__ */
90 
91 /*
92  * fd.io coding-style-patch-verification: ON
93  *
94  * Local Variables:
95  * eval: (c-set-style "gnu")
96  * End:
97  */
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:41
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:33
u64 value
the value
Definition: bihash_8_8.h:34
8 octet key, 8 octet key value pair
Definition: bihash_8_8.h:31
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:68
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:52
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:81