f50234e5d97183d1e5baf206d2ec12044f5bb25a
[vpp.git] / src / vppinfra / bihash_vec8_8.h
1 /*
2  * Copyright (c) 2017 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
20 #define BIHASH_TYPE _vec8_8
21 #define BIHASH_KVP_PER_PAGE 4
22
23 #ifndef __included_bihash_vec8_8_h__
24 #define __included_bihash_vec8_8_h__
25
26 #include <vppinfra/heap.h>
27 #include <vppinfra/format.h>
28 #include <vppinfra/pool.h>
29 #include <vppinfra/xxhash.h>
30 #include <vppinfra/crc32.h>
31
32 /** 8 octet key, 8 octet key value pair */
33 typedef struct
34 {
35   u64 key;                      /**< the key */
36   u64 value;                    /**< the value */
37 } clib_bihash_kv_vec8_8_t;
38
39 /** Decide if a clib_bihash_kv_vec8_8_t instance is free
40     @param v- pointer to the (key,value) pair
41 */
42 static inline int
43 clib_bihash_is_free_vec8_8 (clib_bihash_kv_vec8_8_t * v)
44 {
45   if (v->key == ~0ULL && v->value == ~0ULL)
46     return 1;
47   return 0;
48 }
49
50 /** Hash a clib_bihash_kv_vec8_8_t instance
51     @param v - pointer to the (key,value) pair, hash the key (only)
52 */
53 static inline u64
54 clib_bihash_hash_vec8_8 (clib_bihash_kv_vec8_8_t * v)
55 {
56   u8 *keyp = (u8 *) (v->key);
57   /* Note: to torture-test linear scan, make this fn return a constant */
58 #ifdef clib_crc32c_uses_intrinsics
59   return clib_crc32c (keyp, vec_len (keyp));
60 #else
61   {
62     int i, j;
63     u64 sum = 0;
64
65     for (i = 0, j = 0; i < vec_len (keyp); i++)
66       {
67         sum ^= keyp[i] << (j * 8);
68         j++;
69         if (j == 4)
70           j = 0;
71       }
72
73     return clib_xxhash (sum);
74   }
75 #endif
76 }
77
78 /** Format a clib_bihash_kv_vec8_8_t instance
79     @param s - u8 * vector under construction
80     @param args (vararg) - the (key,value) pair to format
81     @return s - the u8 * vector under construction
82 */
83 static inline u8 *
84 format_bihash_kvp_vec8_8 (u8 * s, va_list * args)
85 {
86   clib_bihash_kv_vec8_8_t *v = va_arg (*args, clib_bihash_kv_vec8_8_t *);
87
88   s = format (s, "key %U value %llu",
89               format_hex_bytes, v->key, vec_len ((u8 *) (v->key)), v->value);
90   return s;
91 }
92
93 /** Compare two clib_bihash_kv_vec8_8_t instances
94     @param a - first key
95     @param b - second key
96 */
97 static inline int
98 clib_bihash_key_compare_vec8_8 (u64 a_arg, u64 b_arg)
99 {
100   u8 *a = (u8 *) a_arg;
101   u8 *b = (u8 *) b_arg;
102
103   if (a_arg == ~0ULL || b_arg == ~0ULL)
104     return 0;
105
106   if (vec_len (a) != vec_len (b))
107     return 0;
108
109   return memcmp (a, b, vec_len (a)) == 0;
110 }
111
112 #undef __included_bihash_template_h__
113 #include <vppinfra/bihash_template.h>
114
115 #endif /* __included_bihash_vec8_8_h__ */
116
117 /*
118  * fd.io coding-style-patch-verification: ON
119  *
120  * Local Variables:
121  * eval: (c-set-style "gnu")
122  * End:
123  */