221e1f255345f822742f3aae4b71b9a83df61623
[vpp.git] / vppinfra / vppinfra / bihash_8_8.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
17 #define BIHASH_TYPE _8_8
18 #define BIHASH_KVP_PER_PAGE 4
19
20 #ifndef __included_bihash_8_8_h__
21 #define __included_bihash_8_8_h__
22
23 #include <vppinfra/heap.h>
24 #include <vppinfra/format.h>
25 #include <vppinfra/pool.h>
26 #include <vppinfra/xxhash.h>
27
28 /** 8 octet key, 8 octet key value pair */
29 typedef struct {
30   u64 key;                      /**< the key */
31   u64 value;                    /**< the value */
32 } clib_bihash_kv_8_8_t;
33
34 /** Decide if a clib_bihash_kv_8_8_t instance is free 
35     @param v- pointer to the (key,value) pair
36 */
37 static inline int clib_bihash_is_free_8_8 (clib_bihash_kv_8_8_t *v)
38 {
39   if (v->key == ~0ULL && v->value == ~0ULL)
40     return 1;
41   return 0;
42 }
43
44 /** Hash a clib_bihash_kv_8_8_t instance 
45     @param v - pointer to the (key,value) pair, hash the key (only)
46 */
47 static inline u64 clib_bihash_hash_8_8  (clib_bihash_kv_8_8_t *v)
48 {
49   return clib_xxhash (v->key);
50 }
51
52 /** Format a clib_bihash_kv_8_8_t instance 
53     @param s - u8 * vector under construction
54     @param v (vararg) - the (key,value) pair to format
55     @return s - the u8 * vector under construction
56 */
57 static inline u8 * format_bihash_kvp_8_8 (u8 * s, va_list * args)
58 {
59   clib_bihash_kv_8_8_t * v = va_arg (*args, clib_bihash_kv_8_8_t *);
60
61   s = format (s, "key %llu value %llu", v->key, v->value);
62   return s;
63 }
64
65 /** Compare two clib_bihash_kv_8_8_t instances 
66     @param a - first key
67     @param b - second key
68 */
69 static inline int clib_bihash_key_compare_8_8 (u64 a, u64 b)
70 {
71   return a == b;
72 }
73
74 #undef __included_bihash_template_h__
75 #include <vppinfra/bihash_template.h>
76
77 #endif /* __included_bihash_8_8_h__ */