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
36 #ifdef BIHASH_32_64_SVM
37 #undef HAVE_MEMFD_CREATE
38 #include <vppinfra/linux/syscall.h>
40 #define F_LINUX_SPECIFIC_BASE 1024
41 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
42 #define F_SEAL_SHRINK (2)
43 /* Max page size 2**16 due to refcount width */
44 #define BIHASH_FREELIST_LENGTH 17
48 #define __bv(a,b) _bv(a,b)
49 #define BV(a) __bv(a,BIHASH_TYPE)
51 #define _bvt(a,b) a##b##_t
52 #define __bvt(a,b) _bvt(a,b)
53 #define BVT(a) __bvt(a,BIHASH_TYPE)
55 #define _bvs(a,b) struct a##b
56 #define __bvs(a,b) _bvs(a,b)
57 #define BVS(a) __bvs(a,BIHASH_TYPE)
60 #define OVERFLOW_ASSERT(x) ASSERT(((x) & 0xFFFFFFFF00000000ULL) == 0)
61 #define u64_to_pointer(x) (void *)(u32)((x))
62 #define pointer_to_u64(x) (u64)(u32)((x))
64 #define OVERFLOW_ASSERT(x)
65 #define u64_to_pointer(x) (void *)((x))
66 #define pointer_to_u64(x) (u64)((x))
69 typedef struct BV (clib_bihash_value)
73 BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
76 } BVT (clib_bihash_value);
78 #define BIHASH_BUCKET_OFFSET_BITS 36
86 u64 offset:BIHASH_BUCKET_OFFSET_BITS;
94 } BVT (clib_bihash_bucket);
96 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_bucket), sizeof (u64));
99 typedef CLIB_PACKED (struct {
101 * Backing store allocation. Since bihash manages its own
102 * freelists, we simple dole out memory starting from alloc_arena[alloc_arena_next].
104 u64 alloc_arena_next; /* Next offset from alloc_arena to allocate, definitely NOT a constant */
105 u64 alloc_arena_size; /* Size of the arena */
106 /* Two SVM pointers stored as 8-byte integers */
107 u64 alloc_lock_as_u64;
109 /* freelist list-head arrays/vectors */
110 u64 freelists_as_u64;
111 u32 nbuckets; /* Number of buckets */
112 /* Set when header valid */
115 }) BVT (clib_bihash_shared_header);
118 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_shared_header), 8 * sizeof (u64));
123 BVT (clib_bihash_bucket) * buckets;
124 volatile u32 *alloc_lock;
126 BVT (clib_bihash_value) ** working_copies;
127 int *working_copy_lengths;
128 BVT (clib_bihash_bucket) saved_bucket;
138 BVT (clib_bihash_shared_header) * sh;
141 BVT (clib_bihash_shared_header) sh;
144 u64 alloc_arena; /* Base of the allocation arena */
145 volatile u8 instantiated;
148 * A custom format function to print the Key and Value of bihash_key instead of default hexdump
150 format_function_t *fmt_fn;
152 /** Optional statistics-gathering callback */
153 #if BIHASH_ENABLE_STATS
154 void (*inc_stats_callback) (BVS (clib_bihash) *, int stat_id, u64 count);
156 /** Statistics callback context (e.g. address of stats data structure) */
157 void *inc_stats_context;
164 BVT (clib_bihash) * h;
168 format_function_t *fmt_fn;
169 u8 instantiate_immediately;
170 u8 dont_add_to_all_bihash_list;
171 } BVT (clib_bihash_init2_args);
173 extern void **clib_all_bihashes;
176 #undef alloc_arena_next
177 #undef alloc_arena_size
179 #undef CLIB_BIHASH_READY_MAGIC
180 #define alloc_arena_next(h) (((h)->sh)->alloc_arena_next)
181 #define alloc_arena_size(h) (((h)->sh)->alloc_arena_size)
182 #define alloc_arena(h) ((h)->alloc_arena)
183 #define CLIB_BIHASH_READY_MAGIC 0xFEEDFACE
185 #undef alloc_arena_next
186 #undef alloc_arena_size
188 #undef CLIB_BIHASH_READY_MAGIC
189 #define alloc_arena_next(h) ((h)->sh.alloc_arena_next)
190 #define alloc_arena_size(h) ((h)->sh.alloc_arena_size)
191 #define alloc_arena(h) ((h)->alloc_arena)
192 #define CLIB_BIHASH_READY_MAGIC 0
195 #ifndef BIHASH_STAT_IDS
196 #define BIHASH_STAT_IDS 1
198 #define foreach_bihash_stat \
208 _(working_copy_lost) \
209 _(splits) /* must be last */
213 #define _(a) BIHASH_STAT_##a,
217 } BVT (clib_bihash_stat_id);
218 #endif /* BIHASH_STAT_IDS */
220 static inline void BV (clib_bihash_increment_stat) (BVT (clib_bihash) * h,
221 int stat_id, u64 count)
223 #if BIHASH_ENABLE_STATS
224 if (PREDICT_FALSE (h->inc_stats_callback != 0))
225 h->inc_stats_callback (h, stat_id, count);
229 #if BIHASH_ENABLE_STATS
230 static inline void BV (clib_bihash_set_stats_callback)
231 (BVT (clib_bihash) * h, void (*cb) (BVT (clib_bihash) *, int, u64),
234 h->inc_stats_callback = cb;
235 h->inc_stats_context = ctx;
240 static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h)
242 while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE))
246 static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h)
248 __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE);
251 static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
253 BVT (clib_bihash_bucket) unlocked_bucket, locked_bucket;
257 locked_bucket.as_u64 = unlocked_bucket.as_u64 = b->as_u64;
258 unlocked_bucket.lock = 0;
259 locked_bucket.lock = 1;
262 while (__atomic_compare_exchange_n (&b->as_u64, &unlocked_bucket.as_u64,
263 locked_bucket.as_u64, 1 /* weak */ ,
265 __ATOMIC_ACQUIRE) == 0);
268 static inline void BV (clib_bihash_unlock_bucket)
269 (BVT (clib_bihash_bucket) * b)
271 CLIB_MEMORY_BARRIER ();
275 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
278 u8 *hp = (u8 *) (uword) alloc_arena (h);
279 u8 *vp = hp + offset;
284 static inline int BV (clib_bihash_bucket_is_empty)
285 (BVT (clib_bihash_bucket) * b)
287 /* Note: applied to locked buckets, test offset */
288 return b->offset == 0;
291 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
296 hp = (u8 *) (uword) alloc_arena (h);
302 void BV (clib_bihash_init)
303 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
305 void BV (clib_bihash_init2) (BVT (clib_bihash_init2_args) * a);
308 void BV (clib_bihash_master_init_svm)
309 (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size);
310 void BV (clib_bihash_slave_init_svm)
311 (BVT (clib_bihash) * h, char *name, int fd);
314 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
315 format_function_t * fmt_fn);
317 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
319 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
320 BVT (clib_bihash_kv) * add_v, int is_add);
321 int BV (clib_bihash_add_or_overwrite_stale) (BVT (clib_bihash) * h,
322 BVT (clib_bihash_kv) * add_v,
323 int (*is_stale_cb) (BVT
327 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
328 BVT (clib_bihash_kv) * search_v,
329 BVT (clib_bihash_kv) * return_v);
331 #define BIHASH_WALK_STOP 0
332 #define BIHASH_WALK_CONTINUE 1
335 int (*BV (clib_bihash_foreach_key_value_pair_cb)) (BVT (clib_bihash_kv) *,
337 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
339 (clib_bihash_foreach_key_value_pair_cb)
341 void *clib_all_bihash_set_heap (void);
342 void clib_bihash_copied (void *dst, void *src);
344 format_function_t BV (format_bihash);
345 format_function_t BV (format_bihash_kvp);
346 format_function_t BV (format_bihash_lru);
348 static inline int BV (clib_bihash_search_inline_with_hash)
349 (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
352 BVT (clib_bihash_value) * v;
353 BVT (clib_bihash_bucket) * b;
356 if (PREDICT_FALSE (alloc_arena (h) == 0))
359 bucket_index = hash & (h->nbuckets - 1);
360 b = &h->buckets[bucket_index];
362 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
365 if (PREDICT_FALSE (b->lock))
367 volatile BVT (clib_bihash_bucket) * bv = b;
372 hash >>= h->log2_nbuckets;
374 v = BV (clib_bihash_get_value) (h, b->offset);
376 /* If the bucket has unresolvable collisions, use linear search */
377 limit = BIHASH_KVP_PER_PAGE;
378 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
379 if (PREDICT_FALSE (b->linear_search))
380 limit <<= b->log2_pages;
382 for (i = 0; i < limit; i++)
384 if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
386 *key_result = v->kvp[i];
393 static inline int BV (clib_bihash_search_inline)
394 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
398 hash = BV (clib_bihash_hash) (key_result);
400 return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
403 static inline void BV (clib_bihash_prefetch_bucket)
404 (BVT (clib_bihash) * h, u64 hash)
407 BVT (clib_bihash_bucket) * b;
409 bucket_index = hash & (h->nbuckets - 1);
410 b = &h->buckets[bucket_index];
412 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
415 static inline void BV (clib_bihash_prefetch_data)
416 (BVT (clib_bihash) * h, u64 hash)
419 BVT (clib_bihash_value) * v;
420 BVT (clib_bihash_bucket) * b;
422 if (PREDICT_FALSE (alloc_arena (h) == 0))
425 bucket_index = hash & (h->nbuckets - 1);
426 b = &h->buckets[bucket_index];
428 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
431 hash >>= h->log2_nbuckets;
432 v = BV (clib_bihash_get_value) (h, b->offset);
434 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
436 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
439 static inline int BV (clib_bihash_search_inline_2_with_hash)
440 (BVT (clib_bihash) * h,
441 u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
444 BVT (clib_bihash_value) * v;
445 BVT (clib_bihash_bucket) * b;
450 if (PREDICT_FALSE (alloc_arena (h) == 0))
453 bucket_index = hash & (h->nbuckets - 1);
454 b = &h->buckets[bucket_index];
456 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
459 if (PREDICT_FALSE (b->lock))
461 volatile BVT (clib_bihash_bucket) * bv = b;
466 hash >>= h->log2_nbuckets;
467 v = BV (clib_bihash_get_value) (h, b->offset);
469 /* If the bucket has unresolvable collisions, use linear search */
470 limit = BIHASH_KVP_PER_PAGE;
471 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
472 if (PREDICT_FALSE (b->linear_search))
473 limit <<= b->log2_pages;
475 for (i = 0; i < limit; i++)
477 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
486 static inline int BV (clib_bihash_search_inline_2)
487 (BVT (clib_bihash) * h,
488 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
492 hash = BV (clib_bihash_hash) (search_key);
494 return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
499 #endif /* __included_bihash_template_h__ */
504 * fd.io coding-style-patch-verification: ON
507 * eval: (c-set-style "gnu")