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 BVT (clib_bihash_kv) cache[BIHASH_KVP_CACHE_SIZE];
69 } BVT (clib_bihash_bucket);
73 BVT (clib_bihash_value) * values;
74 BVT (clib_bihash_bucket) * buckets;
75 volatile u32 *writer_lock;
77 BVT (clib_bihash_value) ** working_copies;
78 int *working_copy_lengths;
79 BVT (clib_bihash_bucket) saved_bucket;
89 BVT (clib_bihash_value) ** freelists;
96 BV (clib_bihash_update_lru) (BVT (clib_bihash_bucket) * b, u8 slot)
102 if (BIHASH_KVP_CACHE_SIZE < 2)
105 ASSERT (slot < BIHASH_KVP_CACHE_SIZE);
107 /* First, find the slot in cache_lru */
109 if (BIHASH_KVP_CACHE_SIZE > 1)
111 if (BIHASH_KVP_CACHE_SIZE > 2)
113 if (BIHASH_KVP_CACHE_SIZE > 3)
115 if (BIHASH_KVP_CACHE_SIZE > 4)
118 value = b->cache_lru;
121 /* Already the most-recently used? */
125 found_lru_pos = ((tmp & (7 << 3)) == 0) ? 1 : 0;
126 if (BIHASH_KVP_CACHE_SIZE > 2)
127 found_lru_pos = ((tmp & (7 << 6)) == 0) ? 2 : found_lru_pos;
128 if (BIHASH_KVP_CACHE_SIZE > 3)
129 found_lru_pos = ((tmp & (7 << 9)) == 0) ? 3 : found_lru_pos;
130 if (BIHASH_KVP_CACHE_SIZE > 4)
131 found_lru_pos = ((tmp & (7 << 12)) == 0) ? 4 : found_lru_pos;
133 ASSERT (found_lru_pos);
135 /* create a mask to kill bits in or above slot */
136 mask = 0xFFFF << found_lru_pos;
137 mask <<= found_lru_pos;
138 mask <<= found_lru_pos;
142 /* Save bits above slot */
145 save_hi = value & mask;
147 value = save_hi | (tmp << 3) | slot;
149 b->cache_lru = value;
153 BV (clib_bihash_update_lru_not_inline) (BVT (clib_bihash_bucket) * b,
156 static inline u8 BV (clib_bihash_get_lru) (BVT (clib_bihash_bucket) * b)
158 return (b->cache_lru >> (3 * (BIHASH_KVP_CACHE_SIZE - 1))) & 7;
161 static inline void BV (clib_bihash_reset_cache) (BVT (clib_bihash_bucket) * b)
163 u16 initial_lru_value;
165 memset (b->cache, 0xff, sizeof (b->cache));
168 * We'll want the cache to be loaded from slot 0 -> slot N, so
169 * the initial LRU order is reverse index order.
171 if (BIHASH_KVP_CACHE_SIZE == 1)
172 initial_lru_value = 0;
173 else if (BIHASH_KVP_CACHE_SIZE == 2)
174 initial_lru_value = (0 << 3) | (1 << 0);
175 else if (BIHASH_KVP_CACHE_SIZE == 3)
176 initial_lru_value = (0 << 6) | (1 << 3) | (2 << 0);
177 else if (BIHASH_KVP_CACHE_SIZE == 4)
178 initial_lru_value = (0 << 9) | (1 << 6) | (2 << 3) | (3 << 0);
179 else if (BIHASH_KVP_CACHE_SIZE == 5)
180 initial_lru_value = (0 << 12) | (1 << 9) | (2 << 6) | (3 << 3) | (4 << 0);
182 b->cache_lru = initial_lru_value;
185 static inline void BV (clib_bihash_cache_enable_disable)
186 (BVT (clib_bihash_bucket) * b, u8 enable)
188 BVT (clib_bihash_bucket) tmp_b;
189 tmp_b.as_u64 = b->as_u64;
190 tmp_b.cache_lru &= 0x7FFF;
191 tmp_b.cache_lru |= enable << 15;
192 b->as_u64 = tmp_b.as_u64;
195 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
199 u8 *vp = hp + offset;
204 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
209 hp = (u8 *) h->mheap;
212 ASSERT ((vp - hp) < 0x100000000ULL);
216 void BV (clib_bihash_init)
217 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
219 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
221 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
222 BVT (clib_bihash_kv) * add_v, int is_add);
223 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
224 BVT (clib_bihash_kv) * search_v,
225 BVT (clib_bihash_kv) * return_v);
227 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
228 void *callback, void *arg);
230 format_function_t BV (format_bihash);
231 format_function_t BV (format_bihash_kvp);
232 format_function_t BV (format_bihash_lru);
234 static inline int BV (clib_bihash_search_inline)
235 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
239 BVT (clib_bihash_value) * v;
240 BVT (clib_bihash_bucket) * b;
241 BVT (clib_bihash_kv) * kvp;
244 hash = BV (clib_bihash_hash) (key_result);
246 bucket_index = hash & (h->nbuckets - 1);
247 b = &h->buckets[bucket_index];
252 /* Check the cache, if currently enabled */
253 if (PREDICT_TRUE (b->cache_lru & (1 << 15)))
255 limit = BIHASH_KVP_CACHE_SIZE;
257 for (i = 0; i < limit; i++)
259 if (BV (clib_bihash_key_compare) (kvp[i].key, key_result->key))
261 *key_result = kvp[i];
268 hash >>= h->log2_nbuckets;
270 v = BV (clib_bihash_get_value) (h, b->offset);
272 /* If the bucket has unresolvable collisions, use linear search */
273 limit = BIHASH_KVP_PER_PAGE;
274 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
275 if (PREDICT_FALSE (b->linear_search))
276 limit <<= b->log2_pages;
278 for (i = 0; i < limit; i++)
280 if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
283 *key_result = v->kvp[i];
285 /* Shut off the cache */
286 BV (clib_bihash_cache_enable_disable) (b, 0);
287 CLIB_MEMORY_BARRIER ();
289 cache_slot = BV (clib_bihash_get_lru) (b);
290 b->cache[cache_slot] = v->kvp[i];
291 BV (clib_bihash_update_lru) (b, cache_slot);
293 /* Reenable the cache */
294 BV (clib_bihash_cache_enable_disable) (b, 1);
302 static inline int BV (clib_bihash_search_inline_2)
303 (BVT (clib_bihash) * h,
304 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
308 BVT (clib_bihash_value) * v;
309 BVT (clib_bihash_bucket) * b;
310 BVT (clib_bihash_kv) * kvp;
315 hash = BV (clib_bihash_hash) (search_key);
317 bucket_index = hash & (h->nbuckets - 1);
318 b = &h->buckets[bucket_index];
323 /* Check the cache, if currently enabled */
324 if (PREDICT_TRUE (b->cache_lru & (1 << 15)))
326 limit = BIHASH_KVP_CACHE_SIZE;
328 for (i = 0; i < limit; i++)
330 if (BV (clib_bihash_key_compare) (kvp[i].key, search_key->key))
339 hash >>= h->log2_nbuckets;
340 v = BV (clib_bihash_get_value) (h, b->offset);
342 /* If the bucket has unresolvable collisions, use linear search */
343 limit = BIHASH_KVP_PER_PAGE;
344 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
345 if (PREDICT_FALSE (b->linear_search))
346 limit <<= b->log2_pages;
348 for (i = 0; i < limit; i++)
350 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
355 /* Shut off the cache */
356 BV (clib_bihash_cache_enable_disable) (b, 0);
357 CLIB_MEMORY_BARRIER ();
359 cache_slot = BV (clib_bihash_get_lru) (b);
360 b->cache[cache_slot] = v->kvp[i];
361 BV (clib_bihash_update_lru) (b, cache_slot);
363 /* Reenable the cache */
364 BV (clib_bihash_cache_enable_disable) (b, 1);
372 #endif /* __included_bihash_template_h__ */
377 * fd.io coding-style-patch-verification: ON
380 * eval: (c-set-style "gnu")