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>
32 #error BIHASH_TYPE not defined
36 #define __bv(a,b) _bv(a,b)
37 #define BV(a) __bv(a,BIHASH_TYPE)
39 #define _bvt(a,b) a##b##_t
40 #define __bvt(a,b) _bvt(a,b)
41 #define BVT(a) __bvt(a,BIHASH_TYPE)
43 typedef struct BV (clib_bihash_value)
47 BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
48 struct BV (clib_bihash_value) * next_free;
50 } BVT (clib_bihash_value);
52 #if BIHASH_KVP_CACHE_SIZE > 5
53 #error Requested KVP cache LRU data exceeds 16 bits
69 #if BIHASH_KVP_CACHE_SIZE > 0
71 BVT (clib_bihash_kv) cache[BIHASH_KVP_CACHE_SIZE];
73 } BVT (clib_bihash_bucket);
77 BVT (clib_bihash_value) * values;
78 BVT (clib_bihash_bucket) * buckets;
79 volatile u32 *writer_lock;
81 BVT (clib_bihash_value) ** working_copies;
82 int *working_copy_lengths;
83 BVT (clib_bihash_bucket) saved_bucket;
92 BVT (clib_bihash_value) ** freelists;
95 * Backing store allocation. Since bihash manages its own
96 * freelists, we simple dole out memory at alloc_arena_next.
99 uword alloc_arena_next;
100 uword alloc_arena_size;
103 * A custom format function to print the Key and Value of bihash_key instead of default hexdump
105 format_function_t *fmt_fn;
111 BV (clib_bihash_update_lru) (BVT (clib_bihash_bucket) * b, u8 slot)
113 #if BIHASH_KVP_CACHE_SIZE > 1
114 u16 value, tmp, mask;
118 ASSERT (slot < BIHASH_KVP_CACHE_SIZE);
120 /* First, find the slot in cache_lru */
122 if (BIHASH_KVP_CACHE_SIZE > 1)
124 if (BIHASH_KVP_CACHE_SIZE > 2)
126 if (BIHASH_KVP_CACHE_SIZE > 3)
128 if (BIHASH_KVP_CACHE_SIZE > 4)
131 value = b->cache_lru;
134 /* Already the most-recently used? */
138 found_lru_pos = ((tmp & (7 << 3)) == 0) ? 1 : 0;
139 if (BIHASH_KVP_CACHE_SIZE > 2)
140 found_lru_pos = ((tmp & (7 << 6)) == 0) ? 2 : found_lru_pos;
141 if (BIHASH_KVP_CACHE_SIZE > 3)
142 found_lru_pos = ((tmp & (7 << 9)) == 0) ? 3 : found_lru_pos;
143 if (BIHASH_KVP_CACHE_SIZE > 4)
144 found_lru_pos = ((tmp & (7 << 12)) == 0) ? 4 : found_lru_pos;
146 ASSERT (found_lru_pos);
148 /* create a mask to kill bits in or above slot */
149 mask = 0xFFFF << found_lru_pos;
150 mask <<= found_lru_pos;
151 mask <<= found_lru_pos;
155 /* Save bits above slot */
158 save_hi = value & mask;
160 value = save_hi | (tmp << 3) | slot;
162 b->cache_lru = value;
167 BV (clib_bihash_update_lru_not_inline) (BVT (clib_bihash_bucket) * b,
170 static inline u8 BV (clib_bihash_get_lru) (BVT (clib_bihash_bucket) * b)
172 #if BIHASH_KVP_CACHE_SIZE > 0
173 return (b->cache_lru >> (3 * (BIHASH_KVP_CACHE_SIZE - 1))) & 7;
179 static inline void BV (clib_bihash_reset_cache) (BVT (clib_bihash_bucket) * b)
181 #if BIHASH_KVP_CACHE_SIZE > 0
182 u16 initial_lru_value;
184 memset (b->cache, 0xff, sizeof (b->cache));
187 * We'll want the cache to be loaded from slot 0 -> slot N, so
188 * the initial LRU order is reverse index order.
190 if (BIHASH_KVP_CACHE_SIZE == 1)
191 initial_lru_value = 0;
192 else if (BIHASH_KVP_CACHE_SIZE == 2)
193 initial_lru_value = (0 << 3) | (1 << 0);
194 else if (BIHASH_KVP_CACHE_SIZE == 3)
195 initial_lru_value = (0 << 6) | (1 << 3) | (2 << 0);
196 else if (BIHASH_KVP_CACHE_SIZE == 4)
197 initial_lru_value = (0 << 9) | (1 << 6) | (2 << 3) | (3 << 0);
198 else if (BIHASH_KVP_CACHE_SIZE == 5)
199 initial_lru_value = (0 << 12) | (1 << 9) | (2 << 6) | (3 << 3) | (4 << 0);
201 b->cache_lru = initial_lru_value;
205 static inline int BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
207 #if BIHASH_KVP_CACHE_SIZE > 0
211 cache_lru_bit = 1 << 15;
213 rv = __sync_fetch_and_or (&b->cache_lru, cache_lru_bit);
214 /* Was already locked? */
221 static inline void BV (clib_bihash_unlock_bucket)
222 (BVT (clib_bihash_bucket) * b)
224 #if BIHASH_KVP_CACHE_SIZE > 0
227 cache_lru = b->cache_lru & ~(1 << 15);
228 b->cache_lru = cache_lru;
232 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
235 u8 *hp = (u8 *) h->alloc_arena;
236 u8 *vp = hp + offset;
241 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
246 hp = (u8 *) h->alloc_arena;
252 void BV (clib_bihash_init)
253 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
255 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
256 format_function_t * fmt_fn);
258 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
260 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
261 BVT (clib_bihash_kv) * add_v, int is_add);
262 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
263 BVT (clib_bihash_kv) * search_v,
264 BVT (clib_bihash_kv) * return_v);
266 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
267 void *callback, void *arg);
269 format_function_t BV (format_bihash);
270 format_function_t BV (format_bihash_kvp);
271 format_function_t BV (format_bihash_lru);
273 static inline int BV (clib_bihash_search_inline_with_hash)
274 (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
277 BVT (clib_bihash_value) * v;
278 BVT (clib_bihash_bucket) * b;
279 #if BIHASH_KVP_CACHE_SIZE > 0
280 BVT (clib_bihash_kv) * kvp;
284 bucket_index = hash & (h->nbuckets - 1);
285 b = &h->buckets[bucket_index];
290 #if BIHASH_KVP_CACHE_SIZE > 0
291 /* Check the cache, if not currently locked */
292 if (PREDICT_TRUE ((b->cache_lru & (1 << 15)) == 0))
294 limit = BIHASH_KVP_CACHE_SIZE;
296 for (i = 0; i < limit; i++)
298 if (BV (clib_bihash_key_compare) (kvp[i].key, key_result->key))
300 *key_result = kvp[i];
308 hash >>= h->log2_nbuckets;
310 v = BV (clib_bihash_get_value) (h, b->offset);
312 /* If the bucket has unresolvable collisions, use linear search */
313 limit = BIHASH_KVP_PER_PAGE;
314 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
315 if (PREDICT_FALSE (b->linear_search))
316 limit <<= b->log2_pages;
318 for (i = 0; i < limit; i++)
320 if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
322 *key_result = v->kvp[i];
324 #if BIHASH_KVP_CACHE_SIZE > 0
326 /* Try to lock the bucket */
327 if (BV (clib_bihash_lock_bucket) (b))
329 cache_slot = BV (clib_bihash_get_lru) (b);
330 b->cache[cache_slot] = v->kvp[i];
331 BV (clib_bihash_update_lru) (b, cache_slot);
333 /* Unlock the bucket */
334 BV (clib_bihash_unlock_bucket) (b);
344 static inline int BV (clib_bihash_search_inline)
345 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
349 hash = BV (clib_bihash_hash) (key_result);
351 return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
354 static inline void BV (clib_bihash_prefetch_bucket)
355 (BVT (clib_bihash) * h, u64 hash)
358 BVT (clib_bihash_bucket) * b;
360 bucket_index = hash & (h->nbuckets - 1);
361 b = &h->buckets[bucket_index];
363 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
366 static inline void BV (clib_bihash_prefetch_data)
367 (BVT (clib_bihash) * h, u64 hash)
370 BVT (clib_bihash_value) * v;
371 BVT (clib_bihash_bucket) * b;
373 bucket_index = hash & (h->nbuckets - 1);
374 b = &h->buckets[bucket_index];
376 if (PREDICT_FALSE (b->offset == 0))
379 hash >>= h->log2_nbuckets;
380 v = BV (clib_bihash_get_value) (h, b->offset);
382 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
384 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
387 static inline int BV (clib_bihash_search_inline_2)
388 (BVT (clib_bihash) * h,
389 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
393 BVT (clib_bihash_value) * v;
394 BVT (clib_bihash_bucket) * b;
395 #if BIHASH_KVP_CACHE_SIZE > 0
396 BVT (clib_bihash_kv) * kvp;
402 hash = BV (clib_bihash_hash) (search_key);
404 bucket_index = hash & (h->nbuckets - 1);
405 b = &h->buckets[bucket_index];
410 /* Check the cache, if currently unlocked */
411 #if BIHASH_KVP_CACHE_SIZE > 0
412 if (PREDICT_TRUE ((b->cache_lru & (1 << 15)) == 0))
414 limit = BIHASH_KVP_CACHE_SIZE;
416 for (i = 0; i < limit; i++)
418 if (BV (clib_bihash_key_compare) (kvp[i].key, search_key->key))
428 hash >>= h->log2_nbuckets;
429 v = BV (clib_bihash_get_value) (h, b->offset);
431 /* If the bucket has unresolvable collisions, use linear search */
432 limit = BIHASH_KVP_PER_PAGE;
433 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
434 if (PREDICT_FALSE (b->linear_search))
435 limit <<= b->log2_pages;
437 for (i = 0; i < limit; i++)
439 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
443 #if BIHASH_KVP_CACHE_SIZE > 0
446 /* Try to lock the bucket */
447 if (BV (clib_bihash_lock_bucket) (b))
449 cache_slot = BV (clib_bihash_get_lru) (b);
450 b->cache[cache_slot] = v->kvp[i];
451 BV (clib_bihash_update_lru) (b, cache_slot);
453 /* Reenable the cache */
454 BV (clib_bihash_unlock_bucket) (b);
464 #endif /* __included_bihash_template_h__ */
469 * fd.io coding-style-patch-verification: ON
472 * eval: (c-set-style "gnu")