VPP-346 More VPP doc fixes
[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 {
31   u64 key;                      /**< the key */
32   u64 value;                    /**< the value */
33 } clib_bihash_kv_8_8_t;
34
35 /** Decide if a clib_bihash_kv_8_8_t instance is free
36     @param v- pointer to the (key,value) pair
37 */
38 static inline int
39 clib_bihash_is_free_8_8 (clib_bihash_kv_8_8_t * v)
40 {
41   if (v->key == ~0ULL && v->value == ~0ULL)
42     return 1;
43   return 0;
44 }
45
46 /** Hash a clib_bihash_kv_8_8_t instance
47     @param v - pointer to the (key,value) pair, hash the key (only)
48 */
49 static inline u64
50 clib_bihash_hash_8_8 (clib_bihash_kv_8_8_t * v)
51 {
52   return clib_xxhash (v->key);
53 }
54
55 /** Format a clib_bihash_kv_8_8_t instance
56     @param s - u8 * vector under construction
57     @param args (vararg) - the (key,value) pair to format
58     @return s - the u8 * vector under construction
59 */
60 static inline u8 *
61 format_bihash_kvp_8_8 (u8 * s, va_list * args)
62 {
63   clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
64
65   s = format (s, "key %llu value %llu", v->key, v->value);
66   return s;
67 }
68
69 /** Compare two clib_bihash_kv_8_8_t instances
70     @param a - first key
71     @param b - second key
72 */
73 static inline int
74 clib_bihash_key_compare_8_8 (u64 a, u64 b)
75 {
76   return a == b;
77 }
78
79 #undef __included_bihash_template_h__
80 #include <vppinfra/bihash_template.h>
81
82 #endif /* __included_bihash_8_8_h__ */
83
84 /*
85  * fd.io coding-style-patch-verification: ON
86  *
87  * Local Variables:
88  * eval: (c-set-style "gnu")
89  * End:
90  */