vppinfra: fix corner-cases in bihash lookup
[vpp.git] / src / vppinfra / bihash_8_8_stats.h
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_8_stats
25 #define BIHASH_KVP_PER_PAGE 4
26 #define BIHASH_ENABLE_STATS 1
27 #define BIHASH_KVP_AT_BUCKET_LEVEL 0
28 #define BIHASH_LAZY_INSTANTIATE 1
29 #define BIHASH_BUCKET_PREFETCH_CACHE_LINES 1
30 #define BIHASH_USE_HEAP 1
31
32 #ifndef __included_bihash_8_8_stats_h__
33 #define __included_bihash_8_8__stats_h__
34
35 #include <vppinfra/heap.h>
36 #include <vppinfra/format.h>
37 #include <vppinfra/pool.h>
38 #include <vppinfra/xxhash.h>
39 #include <vppinfra/crc32.h>
40
41 /** 8 octet key, 8 octet key value pair */
42 typedef struct
43 {
44   u64 key;                      /**< the key */
45   u64 value;                    /**< the value */
46 } clib_bihash_kv_8_8_stats_t;
47
48 static inline void
49 clib_bihash_mark_free_8_8_stats (clib_bihash_kv_8_8_stats_t *v)
50 {
51   v->value = 0xFEEDFACE8BADF00DULL;
52 }
53
54 /** Decide if a clib_bihash_kv_8_8_t instance is free
55     @param v- pointer to the (key,value) pair
56 */
57 static inline int
58 clib_bihash_is_free_8_8_stats (clib_bihash_kv_8_8_stats_t * v)
59 {
60   if (v->value == 0xFEEDFACE8BADF00DULL)
61     return 1;
62   return 0;
63 }
64
65 /** Hash a clib_bihash_kv_8_8_t instance
66     @param v - pointer to the (key,value) pair, hash the key (only)
67 */
68 static inline u64
69 clib_bihash_hash_8_8_stats (clib_bihash_kv_8_8_stats_t * v)
70 {
71   /* Note: to torture-test linear scan, make this fn return a constant */
72 #ifdef clib_crc32c_uses_intrinsics
73   return clib_crc32c ((u8 *) & v->key, 8);
74 #else
75   return clib_xxhash (v->key);
76 #endif
77 }
78
79 /** Format a clib_bihash_kv_8_8_t instance
80     @param s - u8 * vector under construction
81     @param args (vararg) - the (key,value) pair to format
82     @return s - the u8 * vector under construction
83 */
84 static inline u8 *
85 format_bihash_kvp_8_8_stats (u8 * s, va_list * args)
86 {
87   clib_bihash_kv_8_8_stats_t *v =
88     va_arg (*args, clib_bihash_kv_8_8_stats_t *);
89
90   s = format (s, "key %llu value %llu", v->key, v->value);
91   return s;
92 }
93
94 /** Compare two clib_bihash_kv_8_8_t instances
95     @param a - first key
96     @param b - second key
97 */
98 static inline int
99 clib_bihash_key_compare_8_8_stats (u64 a, u64 b)
100 {
101   return a == b;
102 }
103
104 #undef __included_bihash_template_h__
105 #include <vppinfra/bihash_template.h>
106
107 #endif /* __included_bihash_8_8_stats_h__ */
108
109 /*
110  * fd.io coding-style-patch-verification: ON
111  *
112  * Local Variables:
113  * eval: (c-set-style "gnu")
114  * End:
115  */