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)
56 #define OVERFLOW_ASSERT(x) ASSERT(((x) & 0xFFFFFFFF00000000ULL) == 0)
57 #define u64_to_pointer(x) (void *)(u32)((x))
58 #define pointer_to_u64(x) (u64)(u32)((x))
60 #define OVERFLOW_ASSERT(x)
61 #define u64_to_pointer(x) (void *)((x))
62 #define pointer_to_u64(x) (u64)((x))
65 typedef struct BV (clib_bihash_value)
69 BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
72 } BVT (clib_bihash_value);
74 #define BIHASH_BUCKET_OFFSET_BITS 36
82 u64 offset:BIHASH_BUCKET_OFFSET_BITS;
90 } BVT (clib_bihash_bucket);
92 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_bucket), sizeof (u64));
95 typedef CLIB_PACKED (struct {
97 * Backing store allocation. Since bihash manages its own
98 * freelists, we simple dole out memory starting from alloc_arena[alloc_arena_next].
100 u64 alloc_arena_next; /* Next offset from alloc_arena to allocate, definitely NOT a constant */
101 u64 alloc_arena_size; /* Size of the arena */
102 /* Two SVM pointers stored as 8-byte integers */
103 u64 alloc_lock_as_u64;
105 /* freelist list-head arrays/vectors */
106 u64 freelists_as_u64;
107 u32 nbuckets; /* Number of buckets */
108 /* Set when header valid */
111 }) BVT (clib_bihash_shared_header);
114 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_shared_header), 8 * sizeof (u64));
118 BVT (clib_bihash_bucket) * buckets;
119 volatile u32 *alloc_lock;
121 BVT (clib_bihash_value) ** working_copies;
122 int *working_copy_lengths;
123 BVT (clib_bihash_bucket) saved_bucket;
132 BVT (clib_bihash_shared_header) * sh;
135 BVT (clib_bihash_shared_header) sh;
138 u64 alloc_arena; /* Base of the allocation arena */
141 * A custom format function to print the Key and Value of bihash_key instead of default hexdump
143 format_function_t *fmt_fn;
148 #undef alloc_arena_next
149 #undef alloc_arena_size
151 #undef CLIB_BIHASH_READY_MAGIC
152 #define alloc_arena_next(h) (((h)->sh)->alloc_arena_next)
153 #define alloc_arena_size(h) (((h)->sh)->alloc_arena_size)
154 #define alloc_arena(h) ((h)->alloc_arena)
155 #define CLIB_BIHASH_READY_MAGIC 0xFEEDFACE
157 #undef alloc_arena_next
158 #undef alloc_arena_size
160 #undef CLIB_BIHASH_READY_MAGIC
161 #define alloc_arena_next(h) ((h)->sh.alloc_arena_next)
162 #define alloc_arena_size(h) ((h)->sh.alloc_arena_size)
163 #define alloc_arena(h) ((h)->alloc_arena)
164 #define CLIB_BIHASH_READY_MAGIC 0
167 static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h)
169 while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE))
173 static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h)
175 __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE);
178 static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
180 BVT (clib_bihash_bucket) unlocked_bucket, locked_bucket;
184 locked_bucket.as_u64 = unlocked_bucket.as_u64 = b->as_u64;
185 unlocked_bucket.lock = 0;
186 locked_bucket.lock = 1;
189 while (__atomic_compare_exchange_n (&b->as_u64, &unlocked_bucket.as_u64,
190 locked_bucket.as_u64, 1 /* weak */ ,
192 __ATOMIC_ACQUIRE) == 0);
195 static inline void BV (clib_bihash_unlock_bucket)
196 (BVT (clib_bihash_bucket) * b)
198 CLIB_MEMORY_BARRIER ();
202 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
205 u8 *hp = (u8 *) (uword) alloc_arena (h);
206 u8 *vp = hp + offset;
211 static inline int BV (clib_bihash_bucket_is_empty)
212 (BVT (clib_bihash_bucket) * b)
214 /* Note: applied to locked buckets, test offset */
215 return b->offset == 0;
218 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
223 hp = (u8 *) (uword) alloc_arena (h);
229 void BV (clib_bihash_init)
230 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
233 void BV (clib_bihash_master_init_svm)
234 (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size);
235 void BV (clib_bihash_slave_init_svm)
236 (BVT (clib_bihash) * h, char *name, int fd);
239 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
240 format_function_t * fmt_fn);
242 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
244 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
245 BVT (clib_bihash_kv) * add_v, int is_add);
246 int BV (clib_bihash_add_or_overwrite_stale) (BVT (clib_bihash) * h,
247 BVT (clib_bihash_kv) * add_v,
248 int (*is_stale_cb) (BVT
252 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
253 BVT (clib_bihash_kv) * search_v,
254 BVT (clib_bihash_kv) * return_v);
256 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
257 void *callback, void *arg);
259 format_function_t BV (format_bihash);
260 format_function_t BV (format_bihash_kvp);
261 format_function_t BV (format_bihash_lru);
263 static inline int BV (clib_bihash_search_inline_with_hash)
264 (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
267 BVT (clib_bihash_value) * v;
268 BVT (clib_bihash_bucket) * b;
271 bucket_index = hash & (h->nbuckets - 1);
272 b = &h->buckets[bucket_index];
274 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
277 if (PREDICT_FALSE (b->lock))
279 volatile BVT (clib_bihash_bucket) * bv = b;
284 hash >>= h->log2_nbuckets;
286 v = BV (clib_bihash_get_value) (h, b->offset);
288 /* If the bucket has unresolvable collisions, use linear search */
289 limit = BIHASH_KVP_PER_PAGE;
290 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
291 if (PREDICT_FALSE (b->linear_search))
292 limit <<= b->log2_pages;
294 for (i = 0; i < limit; i++)
296 if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
298 *key_result = v->kvp[i];
305 static inline int BV (clib_bihash_search_inline)
306 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
310 hash = BV (clib_bihash_hash) (key_result);
312 return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
315 static inline void BV (clib_bihash_prefetch_bucket)
316 (BVT (clib_bihash) * h, u64 hash)
319 BVT (clib_bihash_bucket) * b;
321 bucket_index = hash & (h->nbuckets - 1);
322 b = &h->buckets[bucket_index];
324 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
327 static inline void BV (clib_bihash_prefetch_data)
328 (BVT (clib_bihash) * h, u64 hash)
331 BVT (clib_bihash_value) * v;
332 BVT (clib_bihash_bucket) * b;
334 bucket_index = hash & (h->nbuckets - 1);
335 b = &h->buckets[bucket_index];
337 if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
340 hash >>= h->log2_nbuckets;
341 v = BV (clib_bihash_get_value) (h, b->offset);
343 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
345 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
348 static inline int BV (clib_bihash_search_inline_2_with_hash)
349 (BVT (clib_bihash) * h,
350 u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
353 BVT (clib_bihash_value) * v;
354 BVT (clib_bihash_bucket) * b;
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;
373 v = BV (clib_bihash_get_value) (h, b->offset);
375 /* If the bucket has unresolvable collisions, use linear search */
376 limit = BIHASH_KVP_PER_PAGE;
377 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
378 if (PREDICT_FALSE (b->linear_search))
379 limit <<= b->log2_pages;
381 for (i = 0; i < limit; i++)
383 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
392 static inline int BV (clib_bihash_search_inline_2)
393 (BVT (clib_bihash) * h,
394 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
398 hash = BV (clib_bihash_hash) (search_key);
400 return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
405 #endif /* __included_bihash_template_h__ */
410 * fd.io coding-style-patch-verification: ON
413 * eval: (c-set-style "gnu")