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