2 Copyright (c) 2014 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */
20 * Note: to instantiate the template multiple times in a single file,
21 * #undef __included_bihash_template_h__...
23 #ifndef __included_bihash_template_h__
24 #define __included_bihash_template_h__
26 #include <vppinfra/heap.h>
27 #include <vppinfra/format.h>
28 #include <vppinfra/pool.h>
31 #error BIHASH_TYPE not defined
35 #define __bv(a,b) _bv(a,b)
36 #define BV(a) __bv(a,BIHASH_TYPE)
38 #define _bvt(a,b) a##b##_t
39 #define __bvt(a,b) _bvt(a,b)
40 #define BVT(a) __bvt(a,BIHASH_TYPE)
42 typedef struct BV (clib_bihash_value)
46 BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
47 struct BV (clib_bihash_value) * next_free;
49 } BVT (clib_bihash_value);
52 * This is shared across all uses of the template, so it needs
53 * a "personal" #include recursion block
55 #ifndef __defined_clib_bihash_bucket_t__
56 #define __defined_clib_bihash_bucket_t__
70 } clib_bihash_bucket_t;
71 #endif /* __defined_clib_bihash_bucket_t__ */
75 BVT (clib_bihash_value) * values;
76 clib_bihash_bucket_t *buckets;
77 volatile u32 *writer_lock;
79 BVT (clib_bihash_value) ** working_copies;
80 clib_bihash_bucket_t saved_bucket;
87 BVT (clib_bihash_value) ** freelists;
93 static inline void *BV (clib_bihash_get_value) (const BVT (clib_bihash) * h,
102 static inline uword BV (clib_bihash_get_offset) (const BVT (clib_bihash) * h,
107 hp = (u8 *) h->mheap;
110 ASSERT ((vp - hp) < 0x100000000ULL);
114 void BV (clib_bihash_init)
115 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
117 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
119 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
120 BVT (clib_bihash_kv) * add_v, int is_add);
121 int BV (clib_bihash_search) (const BVT (clib_bihash) * h,
122 BVT (clib_bihash_kv) * search_v,
123 BVT (clib_bihash_kv) * return_v);
125 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
126 void *callback, void *arg);
128 format_function_t BV (format_bihash);
129 format_function_t BV (format_bihash_kvp);
132 static inline int BV (clib_bihash_search_inline)
133 (const BVT (clib_bihash) * h, BVT (clib_bihash_kv) * kvp)
137 BVT (clib_bihash_value) * v;
138 clib_bihash_bucket_t *b;
141 hash = BV (clib_bihash_hash) (kvp);
143 bucket_index = hash & (h->nbuckets - 1);
144 b = &h->buckets[bucket_index];
149 hash >>= h->log2_nbuckets;
151 v = BV (clib_bihash_get_value) (h, b->offset);
153 /* If the bucket has unresolvable collisions, use linear search */
154 limit = BIHASH_KVP_PER_PAGE;
155 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
156 if (PREDICT_FALSE (b->linear_search))
157 limit <<= b->log2_pages;
159 for (i = 0; i < limit; i++)
161 if (BV (clib_bihash_key_compare) (v->kvp[i].key, kvp->key))
170 static inline int BV (clib_bihash_search_inline_2)
171 (const BVT (clib_bihash) * h,
172 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
176 BVT (clib_bihash_value) * v;
177 clib_bihash_bucket_t *b;
182 hash = BV (clib_bihash_hash) (search_key);
184 bucket_index = hash & (h->nbuckets - 1);
185 b = &h->buckets[bucket_index];
190 hash >>= h->log2_nbuckets;
191 v = BV (clib_bihash_get_value) (h, b->offset);
193 /* If the bucket has unresolvable collisions, use linear search */
194 limit = BIHASH_KVP_PER_PAGE;
195 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
196 if (PREDICT_FALSE (b->linear_search))
197 limit <<= b->log2_pages;
199 for (i = 0; i < limit; i++)
201 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
211 #endif /* __included_bihash_template_h__ */
216 * fd.io coding-style-patch-verification: ON
219 * eval: (c-set-style "gnu")