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);
51 #if BIHASH_KVP_CACHE_SIZE > 5
52 #error Requested KVP cache LRU data exceeds 16 bits
68 #if BIHASH_KVP_CACHE_SIZE > 0
69 BVT (clib_bihash_kv) cache[BIHASH_KVP_CACHE_SIZE];
71 } BVT (clib_bihash_bucket);
75 BVT (clib_bihash_value) * values;
76 BVT (clib_bihash_bucket) * buckets;
77 volatile u32 *writer_lock;
79 BVT (clib_bihash_value) ** working_copies;
80 int *working_copy_lengths;
81 BVT (clib_bihash_bucket) saved_bucket;
91 BVT (clib_bihash_value) ** freelists;
98 BV (clib_bihash_update_lru) (BVT (clib_bihash_bucket) * b, u8 slot)
100 u16 value, tmp, mask;
104 if (BIHASH_KVP_CACHE_SIZE < 2)
107 ASSERT (slot < BIHASH_KVP_CACHE_SIZE);
109 /* First, find the slot in cache_lru */
111 if (BIHASH_KVP_CACHE_SIZE > 1)
113 if (BIHASH_KVP_CACHE_SIZE > 2)
115 if (BIHASH_KVP_CACHE_SIZE > 3)
117 if (BIHASH_KVP_CACHE_SIZE > 4)
120 value = b->cache_lru;
123 /* Already the most-recently used? */
127 found_lru_pos = ((tmp & (7 << 3)) == 0) ? 1 : 0;
128 if (BIHASH_KVP_CACHE_SIZE > 2)
129 found_lru_pos = ((tmp & (7 << 6)) == 0) ? 2 : found_lru_pos;
130 if (BIHASH_KVP_CACHE_SIZE > 3)
131 found_lru_pos = ((tmp & (7 << 9)) == 0) ? 3 : found_lru_pos;
132 if (BIHASH_KVP_CACHE_SIZE > 4)
133 found_lru_pos = ((tmp & (7 << 12)) == 0) ? 4 : found_lru_pos;
135 ASSERT (found_lru_pos);
137 /* create a mask to kill bits in or above slot */
138 mask = 0xFFFF << found_lru_pos;
139 mask <<= found_lru_pos;
140 mask <<= found_lru_pos;
144 /* Save bits above slot */
147 save_hi = value & mask;
149 value = save_hi | (tmp << 3) | slot;
151 b->cache_lru = value;
155 BV (clib_bihash_update_lru_not_inline) (BVT (clib_bihash_bucket) * b,
158 static inline u8 BV (clib_bihash_get_lru) (BVT (clib_bihash_bucket) * b)
160 #if BIHASH_KVP_CACHE_SIZE > 0
161 return (b->cache_lru >> (3 * (BIHASH_KVP_CACHE_SIZE - 1))) & 7;
167 static inline void BV (clib_bihash_reset_cache) (BVT (clib_bihash_bucket) * b)
169 #if BIHASH_KVP_CACHE_SIZE > 0
170 u16 initial_lru_value;
172 memset (b->cache, 0xff, sizeof (b->cache));
175 * We'll want the cache to be loaded from slot 0 -> slot N, so
176 * the initial LRU order is reverse index order.
178 if (BIHASH_KVP_CACHE_SIZE == 1)
179 initial_lru_value = 0;
180 else if (BIHASH_KVP_CACHE_SIZE == 2)
181 initial_lru_value = (0 << 3) | (1 << 0);
182 else if (BIHASH_KVP_CACHE_SIZE == 3)
183 initial_lru_value = (0 << 6) | (1 << 3) | (2 << 0);
184 else if (BIHASH_KVP_CACHE_SIZE == 4)
185 initial_lru_value = (0 << 9) | (1 << 6) | (2 << 3) | (3 << 0);
186 else if (BIHASH_KVP_CACHE_SIZE == 5)
187 initial_lru_value = (0 << 12) | (1 << 9) | (2 << 6) | (3 << 3) | (4 << 0);
189 b->cache_lru = initial_lru_value;
193 static inline int BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
195 BVT (clib_bihash_bucket) tmp_b;
199 tmp_b.cache_lru = 1 << 15;
201 rv = __sync_fetch_and_or (&b->as_u64, tmp_b.as_u64);
203 /* Was already locked? */
204 if (tmp_b.cache_lru & (1 << 15))
209 static inline void BV (clib_bihash_unlock_bucket)
210 (BVT (clib_bihash_bucket) * b)
212 BVT (clib_bihash_bucket) tmp_b;
214 tmp_b.as_u64 = b->as_u64;
215 tmp_b.cache_lru &= ~(1 << 15);
216 b->as_u64 = tmp_b.as_u64;
219 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
223 u8 *vp = hp + offset;
228 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
233 hp = (u8 *) h->mheap;
236 ASSERT ((vp - hp) < 0x100000000ULL);
240 void BV (clib_bihash_init)
241 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
243 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
245 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
246 BVT (clib_bihash_kv) * add_v, int is_add);
247 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
248 BVT (clib_bihash_kv) * search_v,
249 BVT (clib_bihash_kv) * return_v);
251 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
252 void *callback, void *arg);
254 format_function_t BV (format_bihash);
255 format_function_t BV (format_bihash_kvp);
256 format_function_t BV (format_bihash_lru);
258 static inline int BV (clib_bihash_search_inline)
259 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
263 BVT (clib_bihash_value) * v;
264 BVT (clib_bihash_bucket) * b;
265 #if BIHASH_KVP_CACHE_SIZE > 0
266 BVT (clib_bihash_kv) * kvp;
270 hash = BV (clib_bihash_hash) (key_result);
272 bucket_index = hash & (h->nbuckets - 1);
273 b = &h->buckets[bucket_index];
278 #if BIHASH_KVP_CACHE_SIZE > 0
279 /* Check the cache, if not currently locked */
280 if (PREDICT_TRUE ((b->cache_lru & (1 << 15)) == 0))
282 limit = BIHASH_KVP_CACHE_SIZE;
284 for (i = 0; i < limit; i++)
286 if (BV (clib_bihash_key_compare) (kvp[i].key, key_result->key))
288 *key_result = kvp[i];
296 hash >>= h->log2_nbuckets;
298 v = BV (clib_bihash_get_value) (h, b->offset);
300 /* If the bucket has unresolvable collisions, use linear search */
301 limit = BIHASH_KVP_PER_PAGE;
302 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
303 if (PREDICT_FALSE (b->linear_search))
304 limit <<= b->log2_pages;
306 for (i = 0; i < limit; i++)
308 if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
310 *key_result = v->kvp[i];
312 #if BIHASH_KVP_CACHE_SIZE > 0
314 /* Try to lock the bucket */
315 if (BV (clib_bihash_lock_bucket) (b))
317 cache_slot = BV (clib_bihash_get_lru) (b);
318 b->cache[cache_slot] = v->kvp[i];
319 BV (clib_bihash_update_lru) (b, cache_slot);
321 /* Unlock the bucket */
322 BV (clib_bihash_unlock_bucket) (b);
332 static inline int BV (clib_bihash_search_inline_2)
333 (BVT (clib_bihash) * h,
334 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
338 BVT (clib_bihash_value) * v;
339 BVT (clib_bihash_bucket) * b;
340 #if BIHASH_KVP_CACHE_SIZE > 0
341 BVT (clib_bihash_kv) * kvp;
347 hash = BV (clib_bihash_hash) (search_key);
349 bucket_index = hash & (h->nbuckets - 1);
350 b = &h->buckets[bucket_index];
355 /* Check the cache, if currently unlocked */
356 #if BIHASH_KVP_CACHE_SIZE > 0
357 if (PREDICT_TRUE ((b->cache_lru & (1 << 15)) == 0))
359 limit = BIHASH_KVP_CACHE_SIZE;
361 for (i = 0; i < limit; i++)
363 if (BV (clib_bihash_key_compare) (kvp[i].key, search_key->key))
373 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, search_key->key))
388 #if BIHASH_KVP_CACHE_SIZE > 0
391 /* Try to lock the bucket */
392 if (BV (clib_bihash_lock_bucket) (b))
394 cache_slot = BV (clib_bihash_get_lru) (b);
395 b->cache[cache_slot] = v->kvp[i];
396 BV (clib_bihash_update_lru) (b, cache_slot);
398 /* Reenable the cache */
399 BV (clib_bihash_unlock_bucket) (b);
409 #endif /* __included_bihash_template_h__ */
414 * fd.io coding-style-patch-verification: ON
417 * eval: (c-set-style "gnu")