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     BVT (clib_bihash_value) ** freelists;
  88
  89   /*
  90    * Backing store allocation. Since bihash manages its own
  91    * freelists, we simple dole out memory at alloc_arena_next.
  92    */
  93   uword alloc_arena;
  94   uword alloc_arena_next;
  95   uword alloc_arena_size;
  96
  97   /**
  98     * A custom format function to print the Key and Value of bihash_key instead of default hexdump
  99     */
 100   format_function_t *fmt_fn;
 101
 102 } BVT (clib_bihash);
 103
 104 static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h)
 105 {
 106   while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE))
 107     CLIB_PAUSE ();
 108 }
 109
 110 static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h)
 111 {
 112   __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE);
 113 }
 114
 115 static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
 116 {
 117   BVT (clib_bihash_bucket) unlocked_bucket, locked_bucket;
 118
 119   do
 120     {
 121       locked_bucket.as_u64 = unlocked_bucket.as_u64 = b->as_u64;
 122       unlocked_bucket.lock = 0;
 123       locked_bucket.lock = 1;
 124       CLIB_PAUSE ();
 125     }
 126   while (__atomic_compare_exchange_n (&b->as_u64, &unlocked_bucket.as_u64,
 127                                       locked_bucket.as_u64, 1 /* weak */ ,
 128                                       __ATOMIC_ACQUIRE,
 129                                       __ATOMIC_ACQUIRE) == 0);
 130 }
 131
 132 static inline void BV (clib_bihash_unlock_bucket)
 133   (BVT (clib_bihash_bucket) * b)
 134 {
 135   CLIB_MEMORY_BARRIER ();
 136   b->lock = 0;
 137 }
 138
 139 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
 140                                                 uword offset)
 141 {
 142   u8 *hp = (u8 *) h->alloc_arena;
 143   u8 *vp = hp + offset;
 144
 145   return (void *) vp;
 146 }
 147
 148 static inline int BV (clib_bihash_bucket_is_empty)
 149   (BVT (clib_bihash_bucket) * b)
 150 {
 151   /* Note: applied to locked buckets, test offset */
 152   return b->offset == 0;
 153 }
 154
 155 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
 156                                                  void *v)
 157 {
 158   u8 *hp, *vp;
 159
 160   hp = (u8 *) h->alloc_arena;
 161   vp = (u8 *) v;
 162
 163   return vp - hp;
 164 }
 165
 166 void BV (clib_bihash_init)
 167   (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
 168
 169 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
 170                                          format_function_t * fmt_fn);
 171
 172 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
 173
 174 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
 175                               BVT (clib_bihash_kv) * add_v, int is_add);
 176 int BV (clib_bihash_add_or_overwrite_stale) (BVT (clib_bihash) * h,
 177                                              BVT (clib_bihash_kv) * add_v,
 178                                              int (*is_stale_cb) (BVT
 179                                                                  (clib_bihash_kv)
 180                                                                  *, void *),
 181                                              void *arg);
 182 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
 183                              BVT (clib_bihash_kv) * search_v,
 184                              BVT (clib_bihash_kv) * return_v);
 185
 186 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
 187                                               void *callback, void *arg);
 188
 189 format_function_t BV (format_bihash);
 190 format_function_t BV (format_bihash_kvp);
 191 format_function_t BV (format_bihash_lru);
 192
 193 static inline int BV (clib_bihash_search_inline_with_hash)
 194   (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
 195 {
 196   u32 bucket_index;
 197   BVT (clib_bihash_value) * v;
 198   BVT (clib_bihash_bucket) * b;
 199   int i, limit;
 200
 201   bucket_index = hash & (h->nbuckets - 1);
 202   b = &h->buckets[bucket_index];
 203
 204   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 205     return -1;
 206
 207   if (PREDICT_FALSE (b->lock))
 208     {
 209       volatile BVT (clib_bihash_bucket) * bv = b;
 210       while (bv->lock)
 211         CLIB_PAUSE ();
 212     }
 213
 214   hash >>= h->log2_nbuckets;
 215
 216   v = BV (clib_bihash_get_value) (h, b->offset);
 217
 218   /* If the bucket has unresolvable collisions, use linear search */
 219   limit = BIHASH_KVP_PER_PAGE;
 220   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 221   if (PREDICT_FALSE (b->linear_search))
 222     limit <<= b->log2_pages;
 223
 224   for (i = 0; i < limit; i++)
 225     {
 226       if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
 227         {
 228           *key_result = v->kvp[i];
 229           return 0;
 230         }
 231     }
 232   return -1;
 233 }
 234
 235 static inline int BV (clib_bihash_search_inline)
 236   (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
 237 {
 238   u64 hash;
 239
 240   hash = BV (clib_bihash_hash) (key_result);
 241
 242   return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
 243 }
 244
 245 static inline void BV (clib_bihash_prefetch_bucket)
 246   (BVT (clib_bihash) * h, u64 hash)
 247 {
 248   u32 bucket_index;
 249   BVT (clib_bihash_bucket) * b;
 250
 251   bucket_index = hash & (h->nbuckets - 1);
 252   b = &h->buckets[bucket_index];
 253
 254   CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
 255 }
 256
 257 static inline void BV (clib_bihash_prefetch_data)
 258   (BVT (clib_bihash) * h, u64 hash)
 259 {
 260   u32 bucket_index;
 261   BVT (clib_bihash_value) * v;
 262   BVT (clib_bihash_bucket) * b;
 263
 264   bucket_index = hash & (h->nbuckets - 1);
 265   b = &h->buckets[bucket_index];
 266
 267   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 268     return;
 269
 270   hash >>= h->log2_nbuckets;
 271   v = BV (clib_bihash_get_value) (h, b->offset);
 272
 273   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 274
 275   CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
 276 }
 277
 278 static inline int BV (clib_bihash_search_inline_2_with_hash)
 279   (BVT (clib_bihash) * h,
 280    u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
 281 {
 282   u32 bucket_index;
 283   BVT (clib_bihash_value) * v;
 284   BVT (clib_bihash_bucket) * b;
 285   int i, limit;
 286
 287   ASSERT (valuep);
 288
 289   bucket_index = hash & (h->nbuckets - 1);
 290   b = &h->buckets[bucket_index];
 291
 292   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 293     return -1;
 294
 295   if (PREDICT_FALSE (b->lock))
 296     {
 297       volatile BVT (clib_bihash_bucket) * bv = b;
 298       while (bv->lock)
 299         CLIB_PAUSE ();
 300     }
 301
 302   hash >>= h->log2_nbuckets;
 303   v = BV (clib_bihash_get_value) (h, b->offset);
 304
 305   /* If the bucket has unresolvable collisions, use linear search */
 306   limit = BIHASH_KVP_PER_PAGE;
 307   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 308   if (PREDICT_FALSE (b->linear_search))
 309     limit <<= b->log2_pages;
 310
 311   for (i = 0; i < limit; i++)
 312     {
 313       if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
 314         {
 315           *valuep = v->kvp[i];
 316           return 0;
 317         }
 318     }
 319   return -1;
 320 }
 321
 322 static inline int BV (clib_bihash_search_inline_2)
 323   (BVT (clib_bihash) * h,
 324    BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
 325 {
 326   u64 hash;
 327
 328   hash = BV (clib_bihash_hash) (search_key);
 329
 330   return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
 331                                                      valuep);
 332 }
 333
 334
 335 #endif /* __included_bihash_template_h__ */
 336
 337 /** @endcond */
 338
 339 /*
 340  * fd.io coding-style-patch-verification: ON
 341  *
 342  * Local Variables:
 343  * eval: (c-set-style "gnu")
 344  * End:
 345  */