#include <vppinfra/heap.h>
#include <vppinfra/format.h>
#include <vppinfra/pool.h>
+#include <vppinfra/cache.h>
#ifndef BIHASH_TYPE
#error BIHASH_TYPE not defined
{
struct
{
- u32 offset;
- u8 linear_search;
- u8 log2_pages;
- u16 cache_lru;
+ u64 offset:37;
+ u64 linear_search:1;
+ u64 log2_pages:8;
+ i64 refcnt:16;
};
u64 as_u64;
};
+#if BIHASH_KVP_CACHE_SIZE > 0
+ u16 cache_lru;
BVT (clib_bihash_kv) cache[BIHASH_KVP_CACHE_SIZE];
+#endif
} BVT (clib_bihash_bucket);
+#if BIHASH_KVP_CACHE_SIZE == 0
+STATIC_ASSERT_SIZEOF (BVT (clib_bihash_bucket), sizeof (u64));
+#endif
+
typedef struct
{
BVT (clib_bihash_value) * values;
u32 nbuckets;
u32 log2_nbuckets;
- u32 linear_buckets;
u8 *name;
u64 cache_hits;
u64 cache_misses;
BVT (clib_bihash_value) ** freelists;
- void *mheap;
+
+ /*
+ * Backing store allocation. Since bihash manages its own
+ * freelists, we simple dole out memory at alloc_arena_next.
+ */
+ uword alloc_arena;
+ uword alloc_arena_next;
+ uword alloc_arena_size;
+
+ /**
+ * A custom format function to print the Key and Value of bihash_key instead of default hexdump
+ */
+ format_function_t *fmt_fn;
} BVT (clib_bihash);
static inline void
BV (clib_bihash_update_lru) (BVT (clib_bihash_bucket) * b, u8 slot)
{
+#if BIHASH_KVP_CACHE_SIZE > 1
u16 value, tmp, mask;
u8 found_lru_pos;
u16 save_hi;
- if (BIHASH_KVP_CACHE_SIZE < 2)
- return;
-
ASSERT (slot < BIHASH_KVP_CACHE_SIZE);
/* First, find the slot in cache_lru */
value = save_hi | (tmp << 3) | slot;
b->cache_lru = value;
+#endif
}
void
static inline u8 BV (clib_bihash_get_lru) (BVT (clib_bihash_bucket) * b)
{
+#if BIHASH_KVP_CACHE_SIZE > 0
return (b->cache_lru >> (3 * (BIHASH_KVP_CACHE_SIZE - 1))) & 7;
+#else
+ return 0;
+#endif
}
static inline void BV (clib_bihash_reset_cache) (BVT (clib_bihash_bucket) * b)
{
+#if BIHASH_KVP_CACHE_SIZE > 0
u16 initial_lru_value;
memset (b->cache, 0xff, sizeof (b->cache));
initial_lru_value = (0 << 12) | (1 << 9) | (2 << 6) | (3 << 3) | (4 << 0);
b->cache_lru = initial_lru_value;
+#endif
}
-static inline void BV (clib_bihash_cache_enable_disable)
- (BVT (clib_bihash_bucket) * b, u8 enable)
+static inline int BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
{
- BVT (clib_bihash_bucket) tmp_b;
- tmp_b.as_u64 = b->as_u64;
- tmp_b.cache_lru &= 0x7FFF;
- tmp_b.cache_lru |= enable << 15;
- b->as_u64 = tmp_b.as_u64;
+#if BIHASH_KVP_CACHE_SIZE > 0
+ u16 cache_lru_bit;
+ u16 rv;
+
+ cache_lru_bit = 1 << 15;
+
+ rv = __sync_fetch_and_or (&b->cache_lru, cache_lru_bit);
+ /* Was already locked? */
+ if (rv & (1 << 15))
+ return 0;
+#endif
+ return 1;
+}
+
+static inline void BV (clib_bihash_unlock_bucket)
+ (BVT (clib_bihash_bucket) * b)
+{
+#if BIHASH_KVP_CACHE_SIZE > 0
+ u16 cache_lru;
+
+ cache_lru = b->cache_lru & ~(1 << 15);
+ b->cache_lru = cache_lru;
+#endif
}
static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
uword offset)
{
- u8 *hp = h->mheap;
+ u8 *hp = (u8 *) h->alloc_arena;
u8 *vp = hp + offset;
return (void *) vp;
}
+static inline int BV (clib_bihash_bucket_is_empty)
+ (BVT (clib_bihash_bucket) * b)
+{
+ return b->as_u64 == 0;
+}
+
static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
void *v)
{
u8 *hp, *vp;
- hp = (u8 *) h->mheap;
+ hp = (u8 *) h->alloc_arena;
vp = (u8 *) v;
- ASSERT ((vp - hp) < 0x100000000ULL);
return vp - hp;
}
void BV (clib_bihash_init)
(BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
+void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
+ format_function_t * fmt_fn);
+
void BV (clib_bihash_free) (BVT (clib_bihash) * h);
int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
format_function_t BV (format_bihash_kvp);
format_function_t BV (format_bihash_lru);
-static inline int BV (clib_bihash_search_inline)
- (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
+static inline int BV (clib_bihash_search_inline_with_hash)
+ (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
{
- u64 hash;
u32 bucket_index;
BVT (clib_bihash_value) * v;
BVT (clib_bihash_bucket) * b;
+#if BIHASH_KVP_CACHE_SIZE > 0
BVT (clib_bihash_kv) * kvp;
+#endif
int i, limit;
- hash = BV (clib_bihash_hash) (key_result);
-
bucket_index = hash & (h->nbuckets - 1);
b = &h->buckets[bucket_index];
- if (b->offset == 0)
+ if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
return -1;
- /* Check the cache, if currently enabled */
- if (PREDICT_TRUE (b->cache_lru & (1 << 15)))
+#if BIHASH_KVP_CACHE_SIZE > 0
+ /* Check the cache, if not currently locked */
+ if (PREDICT_TRUE ((b->cache_lru & (1 << 15)) == 0))
{
limit = BIHASH_KVP_CACHE_SIZE;
kvp = b->cache;
}
}
}
+#endif
hash >>= h->log2_nbuckets;
{
if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
{
- u8 cache_slot;
*key_result = v->kvp[i];
- /* Shut off the cache */
- BV (clib_bihash_cache_enable_disable) (b, 0);
- CLIB_MEMORY_BARRIER ();
-
- cache_slot = BV (clib_bihash_get_lru) (b);
- b->cache[cache_slot] = v->kvp[i];
- BV (clib_bihash_update_lru) (b, cache_slot);
+#if BIHASH_KVP_CACHE_SIZE > 0
+ u8 cache_slot;
+ /* Try to lock the bucket */
+ if (BV (clib_bihash_lock_bucket) (b))
+ {
+ cache_slot = BV (clib_bihash_get_lru) (b);
+ b->cache[cache_slot] = v->kvp[i];
+ BV (clib_bihash_update_lru) (b, cache_slot);
- /* Reenable the cache */
- BV (clib_bihash_cache_enable_disable) (b, 1);
- h->cache_misses++;
+ /* Unlock the bucket */
+ BV (clib_bihash_unlock_bucket) (b);
+ h->cache_misses++;
+ }
+#endif
return 0;
}
}
return -1;
}
-static inline int BV (clib_bihash_search_inline_2)
- (BVT (clib_bihash) * h,
- BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
+static inline int BV (clib_bihash_search_inline)
+ (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
{
u64 hash;
+
+ hash = BV (clib_bihash_hash) (key_result);
+
+ return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
+}
+
+static inline void BV (clib_bihash_prefetch_bucket)
+ (BVT (clib_bihash) * h, u64 hash)
+{
+ u32 bucket_index;
+ BVT (clib_bihash_bucket) * b;
+
+ bucket_index = hash & (h->nbuckets - 1);
+ b = &h->buckets[bucket_index];
+
+ CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
+}
+
+static inline void BV (clib_bihash_prefetch_data)
+ (BVT (clib_bihash) * h, u64 hash)
+{
u32 bucket_index;
BVT (clib_bihash_value) * v;
BVT (clib_bihash_bucket) * b;
+
+ bucket_index = hash & (h->nbuckets - 1);
+ b = &h->buckets[bucket_index];
+
+ if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
+ return;
+
+ hash >>= h->log2_nbuckets;
+ v = BV (clib_bihash_get_value) (h, b->offset);
+
+ v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
+
+ CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
+}
+
+static inline int BV (clib_bihash_search_inline_2_with_hash)
+ (BVT (clib_bihash) * h,
+ u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
+{
+ u32 bucket_index;
+ BVT (clib_bihash_value) * v;
+ BVT (clib_bihash_bucket) * b;
+#if BIHASH_KVP_CACHE_SIZE > 0
BVT (clib_bihash_kv) * kvp;
+#endif
int i, limit;
ASSERT (valuep);
- hash = BV (clib_bihash_hash) (search_key);
-
bucket_index = hash & (h->nbuckets - 1);
b = &h->buckets[bucket_index];
- if (b->offset == 0)
+ if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
return -1;
- /* Check the cache, if currently enabled */
- if (PREDICT_TRUE (b->cache_lru & (1 << 15)))
+ /* Check the cache, if currently unlocked */
+#if BIHASH_KVP_CACHE_SIZE > 0
+ if (PREDICT_TRUE ((b->cache_lru & (1 << 15)) == 0))
{
limit = BIHASH_KVP_CACHE_SIZE;
kvp = b->cache;
}
}
}
+#endif
hash >>= h->log2_nbuckets;
v = BV (clib_bihash_get_value) (h, b->offset);
{
if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
{
- u8 cache_slot;
*valuep = v->kvp[i];
- /* Shut off the cache */
- BV (clib_bihash_cache_enable_disable) (b, 0);
- CLIB_MEMORY_BARRIER ();
+#if BIHASH_KVP_CACHE_SIZE > 0
+ u8 cache_slot;
- cache_slot = BV (clib_bihash_get_lru) (b);
- b->cache[cache_slot] = v->kvp[i];
- BV (clib_bihash_update_lru) (b, cache_slot);
+ /* Try to lock the bucket */
+ if (BV (clib_bihash_lock_bucket) (b))
+ {
+ cache_slot = BV (clib_bihash_get_lru) (b);
+ b->cache[cache_slot] = v->kvp[i];
+ BV (clib_bihash_update_lru) (b, cache_slot);
- /* Reenable the cache */
- BV (clib_bihash_cache_enable_disable) (b, 1);
- h->cache_misses++;
+ /* Reenable the cache */
+ BV (clib_bihash_unlock_bucket) (b);
+ h->cache_misses++;
+ }
+#endif
return 0;
}
}
return -1;
}
+static inline int BV (clib_bihash_search_inline_2)
+ (BVT (clib_bihash) * h,
+ BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
+{
+ u64 hash;
+
+ hash = BV (clib_bihash_hash) (search_key);
+
+ return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
+ valuep);
+}
+
+
#endif /* __included_bihash_template_h__ */
/** @endcond */