src/vppinfra/bihash_template.h

   1 /*
   2   Copyright (c) 2014 Cisco and/or its affiliates.
   3
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15 */
  16
  17 /** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */
  18
  19 /*
  20  * Note: to instantiate the template multiple times in a single file,
  21  * #undef __included_bihash_template_h__...
  22  */
  23 #ifndef __included_bihash_template_h__
  24 #define __included_bihash_template_h__
  25
  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>
  31
  32 #ifndef BIHASH_TYPE
  33 #error BIHASH_TYPE not defined
  34 #endif
  35
  36 #define _bv(a,b) a##b
  37 #define __bv(a,b) _bv(a,b)
  38 #define BV(a) __bv(a,BIHASH_TYPE)
  39
  40 #define _bvt(a,b) a##b##_t
  41 #define __bvt(a,b) _bvt(a,b)
  42 #define BVT(a) __bvt(a,BIHASH_TYPE)
  43
  44 typedef struct BV (clib_bihash_value)
  45 {
  46   union
  47   {
  48     BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
  49     struct BV (clib_bihash_value) * next_free;
  50   };
  51 } BVT (clib_bihash_value);
  52
  53 #define BIHASH_BUCKET_OFFSET_BITS 36
  54
  55 typedef struct
  56 {
  57   union
  58   {
  59     struct
  60     {
  61       u64 offset:BIHASH_BUCKET_OFFSET_BITS;
  62       u64 lock:1;
  63       u64 linear_search:1;
  64       u64 log2_pages:8;
  65       i64 refcnt:16;
  66     };
  67     u64 as_u64;
  68   };
  69 } BVT (clib_bihash_bucket);
  70
  71 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_bucket), sizeof (u64));
  72
  73 typedef struct
  74 {
  75   BVT (clib_bihash_value) * values;
  76   BVT (clib_bihash_bucket) * buckets;
  77   volatile u32 *alloc_lock;
  78
  79     BVT (clib_bihash_value) ** working_copies;
  80   int *working_copy_lengths;
  81     BVT (clib_bihash_bucket) saved_bucket;
  82
  83   u32 nbuckets;
  84   u32 log2_nbuckets;
  85   u8 *name;
  86
  87   u64 cache_hits;
  88   u64 cache_misses;
  89
  90     BVT (clib_bihash_value) ** freelists;
  91
  92   /*
  93    * Backing store allocation. Since bihash manages its own
  94    * freelists, we simple dole out memory at alloc_arena_next.
  95    */
  96   uword alloc_arena;
  97   uword alloc_arena_next;
  98   uword alloc_arena_size;
  99
 100   /**
 101     * A custom format function to print the Key and Value of bihash_key instead of default hexdump
 102     */
 103   format_function_t *fmt_fn;
 104
 105 } BVT (clib_bihash);
 106
 107 static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h)
 108 {
 109   while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE))
 110     CLIB_PAUSE ();
 111 }
 112
 113 static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h)
 114 {
 115   __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE);
 116 }
 117
 118 static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
 119 {
 120   BVT (clib_bihash_bucket) unlocked_bucket, locked_bucket;
 121
 122   do
 123     {
 124       locked_bucket.as_u64 = unlocked_bucket.as_u64 = b->as_u64;
 125       unlocked_bucket.lock = 0;
 126       locked_bucket.lock = 1;
 127       CLIB_PAUSE ();
 128     }
 129   while (__atomic_compare_exchange_n (&b->as_u64, &unlocked_bucket.as_u64,
 130                                       locked_bucket.as_u64, 1 /* weak */ ,
 131                                       __ATOMIC_ACQUIRE,
 132                                       __ATOMIC_ACQUIRE) == 0);
 133 }
 134
 135 static inline void BV (clib_bihash_unlock_bucket)
 136   (BVT (clib_bihash_bucket) * b)
 137 {
 138   CLIB_MEMORY_BARRIER ();
 139   b->lock = 0;
 140 }
 141
 142 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
 143                                                 uword offset)
 144 {
 145   u8 *hp = (u8 *) h->alloc_arena;
 146   u8 *vp = hp + offset;
 147
 148   return (void *) vp;
 149 }
 150
 151 static inline int BV (clib_bihash_bucket_is_empty)
 152   (BVT (clib_bihash_bucket) * b)
 153 {
 154   /* Note: applied to locked buckets, test offset */
 155   return b->offset == 0;
 156 }
 157
 158 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
 159                                                  void *v)
 160 {
 161   u8 *hp, *vp;
 162
 163   hp = (u8 *) h->alloc_arena;
 164   vp = (u8 *) v;
 165
 166   return vp - hp;
 167 }
 168
 169 void BV (clib_bihash_init)
 170   (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
 171
 172 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
 173                                          format_function_t * fmt_fn);
 174
 175 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
 176
 177 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
 178                               BVT (clib_bihash_kv) * add_v, int is_add);
 179 int BV (clib_bihash_add_or_overwrite_stale) (BVT (clib_bihash) * h,
 180                                              BVT (clib_bihash_kv) * add_v,
 181                                              int (*is_stale_cb) (BVT
 182                                                                  (clib_bihash_kv)
 183                                                                  *, void *),
 184                                              void *arg);
 185 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
 186                              BVT (clib_bihash_kv) * search_v,
 187                              BVT (clib_bihash_kv) * return_v);
 188
 189 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
 190                                               void *callback, void *arg);
 191
 192 format_function_t BV (format_bihash);
 193 format_function_t BV (format_bihash_kvp);
 194 format_function_t BV (format_bihash_lru);
 195
 196 static inline int BV (clib_bihash_search_inline_with_hash)
 197   (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
 198 {
 199   u32 bucket_index;
 200   BVT (clib_bihash_value) * v;
 201   BVT (clib_bihash_bucket) * b;
 202   int i, limit;
 203
 204   bucket_index = hash & (h->nbuckets - 1);
 205   b = &h->buckets[bucket_index];
 206
 207   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 208     return -1;
 209
 210   if (PREDICT_FALSE (b->lock))
 211     {
 212       volatile BVT (clib_bihash_bucket) * bv = b;
 213       while (bv->lock)
 214         CLIB_PAUSE ();
 215     }
 216
 217   hash >>= h->log2_nbuckets;
 218
 219   v = BV (clib_bihash_get_value) (h, b->offset);
 220
 221   /* If the bucket has unresolvable collisions, use linear search */
 222   limit = BIHASH_KVP_PER_PAGE;
 223   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 224   if (PREDICT_FALSE (b->linear_search))
 225     limit <<= b->log2_pages;
 226
 227   for (i = 0; i < limit; i++)
 228     {
 229       if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
 230         {
 231           *key_result = v->kvp[i];
 232           return 0;
 233         }
 234     }
 235   return -1;
 236 }
 237
 238 static inline int BV (clib_bihash_search_inline)
 239   (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
 240 {
 241   u64 hash;
 242
 243   hash = BV (clib_bihash_hash) (key_result);
 244
 245   return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
 246 }
 247
 248 static inline void BV (clib_bihash_prefetch_bucket)
 249   (BVT (clib_bihash) * h, u64 hash)
 250 {
 251   u32 bucket_index;
 252   BVT (clib_bihash_bucket) * b;
 253
 254   bucket_index = hash & (h->nbuckets - 1);
 255   b = &h->buckets[bucket_index];
 256
 257   CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
 258 }
 259
 260 static inline void BV (clib_bihash_prefetch_data)
 261   (BVT (clib_bihash) * h, u64 hash)
 262 {
 263   u32 bucket_index;
 264   BVT (clib_bihash_value) * v;
 265   BVT (clib_bihash_bucket) * b;
 266
 267   bucket_index = hash & (h->nbuckets - 1);
 268   b = &h->buckets[bucket_index];
 269
 270   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 271     return;
 272
 273   hash >>= h->log2_nbuckets;
 274   v = BV (clib_bihash_get_value) (h, b->offset);
 275
 276   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 277
 278   CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
 279 }
 280
 281 static inline int BV (clib_bihash_search_inline_2_with_hash)
 282   (BVT (clib_bihash) * h,
 283    u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
 284 {
 285   u32 bucket_index;
 286   BVT (clib_bihash_value) * v;
 287   BVT (clib_bihash_bucket) * b;
 288   int i, limit;
 289
 290   ASSERT (valuep);
 291
 292   bucket_index = hash & (h->nbuckets - 1);
 293   b = &h->buckets[bucket_index];
 294
 295   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 296     return -1;
 297
 298   if (PREDICT_FALSE (b->lock))
 299     {
 300       volatile BVT (clib_bihash_bucket) * bv = b;
 301       while (bv->lock)
 302         CLIB_PAUSE ();
 303     }
 304
 305   hash >>= h->log2_nbuckets;
 306   v = BV (clib_bihash_get_value) (h, b->offset);
 307
 308   /* If the bucket has unresolvable collisions, use linear search */
 309   limit = BIHASH_KVP_PER_PAGE;
 310   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 311   if (PREDICT_FALSE (b->linear_search))
 312     limit <<= b->log2_pages;
 313
 314   for (i = 0; i < limit; i++)
 315     {
 316       if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
 317         {
 318           *valuep = v->kvp[i];
 319           return 0;
 320         }
 321     }
 322   return -1;
 323 }
 324
 325 static inline int BV (clib_bihash_search_inline_2)
 326   (BVT (clib_bihash) * h,
 327    BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
 328 {
 329   u64 hash;
 330
 331   hash = BV (clib_bihash_hash) (search_key);
 332
 333   return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
 334                                                      valuep);
 335 }
 336
 337
 338 #endif /* __included_bihash_template_h__ */
 339
 340 /** @endcond */
 341
 342 /*
 343  * fd.io coding-style-patch-verification: ON
 344  *
 345  * Local Variables:
 346  * eval: (c-set-style "gnu")
 347  * End:
 348  */