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>
29 #include <vppinfra/cache.h>
30 #include <vppinfra/lock.h>
33 #error BIHASH_TYPE not defined
37 #define __bv(a,b) _bv(a,b)
38 #define BV(a) __bv(a,BIHASH_TYPE)
40 #define _bvt(a,b) a##b##_t
41 #define __bvt(a,b) _bvt(a,b)
42 #define BVT(a) __bvt(a,BIHASH_TYPE)
44 typedef struct BV (clib_bihash_value)
48 BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
49 struct BV (clib_bihash_value) * next_free;
51 } BVT (clib_bihash_value);
53 #define BIHASH_BUCKET_OFFSET_BITS 36
61 u64 offset:BIHASH_BUCKET_OFFSET_BITS;
69 } BVT (clib_bihash_bucket);
71 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_bucket), sizeof (u64));
75 BVT (clib_bihash_value) * values;
76 BVT (clib_bihash_bucket) * buckets;
77 volatile u32 *alloc_lock;
79 BVT (clib_bihash_value) ** working_copies;
80 int *working_copy_lengths;
81 BVT (clib_bihash_bucket) saved_bucket;
90 BVT (clib_bihash_value) ** freelists;
93 * Backing store allocation. Since bihash manages its own
94 * freelists, we simple dole out memory at alloc_arena_next.
97 uword alloc_arena_next;
98 uword alloc_arena_size;
101 * A custom format function to print the Key and Value of bihash_key instead of default hexdump
103 format_function_t *fmt_fn;
107 static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h)
109 while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE))
113 static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h)
115 __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE);
118 static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
120 BVT (clib_bihash_bucket) unlocked_bucket, locked_bucket;
124 locked_bucket.as_u64 = unlocked_bucket.as_u64 = b->as_u64;
125 unlocked_bucket.lock = 0;
126 locked_bucket.lock = 1;
129 while (__atomic_compare_exchange_n (&b->as_u64, &unlocked_bucket.as_u64,
130 locked_bucket.as_u64, 1 /* weak */ ,
132 __ATOMIC_ACQUIRE) == 0);
135 static inline void BV (clib_bihash_unlock_bucket)
136 (BVT (clib_bihash_bucket) * b)
138 CLIB_MEMORY_BARRIER ();
142 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
145 u8 *hp = (u8 *) h->alloc_arena;
146 u8 *vp = hp + offset;
151 static inline int BV (clib_bihash_bucket_is_empty)
152 (BVT (clib_bihash_bucket) * b)
154 /* Note: applied to locked buckets, test offset */
155 return b->offset == 0;
158 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
163 hp = (u8 *) h->alloc_arena;
169 void BV (clib_bihash_init)
170 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
172 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
173 format_function_t * fmt_fn);
175 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
177 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
178 BVT (clib_bihash_kv) * add_v, int is_add);
179 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
180 BVT (clib_bihash_kv) * search_v,
181 BVT (clib_bihash_kv) * return_v);
183 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
184 void *callback, void *arg);
186 format_function_t BV (format_bihash);
187 format_function_t BV (format_bihash_kvp);
188 format_function_t BV (format_bihash_lru);
190 static inline int BV (clib_bihash_search_inline_with_hash)
191 (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
194 BVT (clib_bihash_value) * v;
195 BVT (clib_bihash_bucket) * b;
198 bucket_index = hash & (h->nbuckets - 1);
199 b = &h->buckets[bucket_index];
201 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
204 if (PREDICT_FALSE (b->lock))
206 volatile BVT (clib_bihash_bucket) * bv = b;
211 hash >>= h->log2_nbuckets;
213 v = BV (clib_bihash_get_value) (h, b->offset);
215 /* If the bucket has unresolvable collisions, use linear search */
216 limit = BIHASH_KVP_PER_PAGE;
217 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
218 if (PREDICT_FALSE (b->linear_search))
219 limit <<= b->log2_pages;
221 for (i = 0; i < limit; i++)
223 if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
225 *key_result = v->kvp[i];
232 static inline int BV (clib_bihash_search_inline)
233 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
237 hash = BV (clib_bihash_hash) (key_result);
239 return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
242 static inline void BV (clib_bihash_prefetch_bucket)
243 (BVT (clib_bihash) * h, u64 hash)
246 BVT (clib_bihash_bucket) * b;
248 bucket_index = hash & (h->nbuckets - 1);
249 b = &h->buckets[bucket_index];
251 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
254 static inline void BV (clib_bihash_prefetch_data)
255 (BVT (clib_bihash) * h, u64 hash)
258 BVT (clib_bihash_value) * v;
259 BVT (clib_bihash_bucket) * b;
261 bucket_index = hash & (h->nbuckets - 1);
262 b = &h->buckets[bucket_index];
264 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
267 hash >>= h->log2_nbuckets;
268 v = BV (clib_bihash_get_value) (h, b->offset);
270 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
272 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
275 static inline int BV (clib_bihash_search_inline_2_with_hash)
276 (BVT (clib_bihash) * h,
277 u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
280 BVT (clib_bihash_value) * v;
281 BVT (clib_bihash_bucket) * b;
286 bucket_index = hash & (h->nbuckets - 1);
287 b = &h->buckets[bucket_index];
289 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
292 if (PREDICT_FALSE (b->lock))
294 volatile BVT (clib_bihash_bucket) * bv = b;
299 hash >>= h->log2_nbuckets;
300 v = BV (clib_bihash_get_value) (h, b->offset);
302 /* If the bucket has unresolvable collisions, use linear search */
303 limit = BIHASH_KVP_PER_PAGE;
304 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
305 if (PREDICT_FALSE (b->linear_search))
306 limit <<= b->log2_pages;
308 for (i = 0; i < limit; i++)
310 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
319 static inline int BV (clib_bihash_search_inline_2)
320 (BVT (clib_bihash) * h,
321 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
325 hash = BV (clib_bihash_hash) (search_key);
327 return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
332 #endif /* __included_bihash_template_h__ */
337 * fd.io coding-style-patch-verification: ON
340 * eval: (c-set-style "gnu")