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 #ifdef BIHASH_32_64_SVM
  37 #undef HAVE_MEMFD_CREATE
  38 #include <vppinfra/linux/syscall.h>
  39 #include <fcntl.h>
  40 #define F_LINUX_SPECIFIC_BASE 1024
  41 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
  42 #define F_SEAL_SHRINK (2)
  43 /* Max page size 2**16 due to refcount width  */
  44 #define BIHASH_FREELIST_LENGTH 17
  45 #endif
  46
  47 #define _bv(a,b) a##b
  48 #define __bv(a,b) _bv(a,b)
  49 #define BV(a) __bv(a,BIHASH_TYPE)
  50
  51 #define _bvt(a,b) a##b##_t
  52 #define __bvt(a,b) _bvt(a,b)
  53 #define BVT(a) __bvt(a,BIHASH_TYPE)
  54
  55 #define _bvs(a,b) struct a##b
  56 #define __bvs(a,b) _bvs(a,b)
  57 #define BVS(a) __bvs(a,BIHASH_TYPE)
  58
  59 #if _LP64 == 0
  60 #define OVERFLOW_ASSERT(x) ASSERT(((x) & 0xFFFFFFFF00000000ULL) == 0)
  61 #define u64_to_pointer(x) (void *)(u32)((x))
  62 #define pointer_to_u64(x) (u64)(u32)((x))
  63 #else
  64 #define OVERFLOW_ASSERT(x)
  65 #define u64_to_pointer(x) (void *)((x))
  66 #define pointer_to_u64(x) (u64)((x))
  67 #endif
  68
  69 typedef struct BV (clib_bihash_value)
  70 {
  71   union
  72   {
  73     BVT (clib_bihash_kv) kvp[BIHASH_KVP_PER_PAGE];
  74     u64 next_free_as_u64;
  75   };
  76 } BVT (clib_bihash_value);
  77
  78 #define BIHASH_BUCKET_OFFSET_BITS 36
  79
  80 typedef struct
  81 {
  82   union
  83   {
  84     struct
  85     {
  86       u64 offset:BIHASH_BUCKET_OFFSET_BITS;
  87       u64 lock:1;
  88       u64 linear_search:1;
  89       u64 log2_pages:8;
  90       u64 refcnt:16;
  91     };
  92     u64 as_u64;
  93   };
  94 } BVT (clib_bihash_bucket);
  95
  96 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_bucket), sizeof (u64));
  97
  98 /* *INDENT-OFF* */
  99 typedef CLIB_PACKED (struct {
 100   /*
 101    * Backing store allocation. Since bihash manages its own
 102    * freelists, we simple dole out memory starting from alloc_arena[alloc_arena_next].
 103    */
 104   u64 alloc_arena_next; /* Next offset from alloc_arena to allocate, definitely NOT a constant */
 105   u64 alloc_arena_size; /* Size of the arena */
 106   /* Two SVM pointers stored as 8-byte integers */
 107   u64 alloc_lock_as_u64;
 108   u64 buckets_as_u64;
 109   /* freelist list-head arrays/vectors */
 110   u64 freelists_as_u64;
 111   u32 nbuckets; /* Number of buckets */
 112   /* Set when header valid */
 113   volatile u32 ready;
 114   u64 pad[2];
 115 }) BVT (clib_bihash_shared_header);
 116 /* *INDENT-ON* */
 117
 118 STATIC_ASSERT_SIZEOF (BVT (clib_bihash_shared_header), 8 * sizeof (u64));
 119
 120 typedef
 121 BVS (clib_bihash)
 122 {
 123   BVT (clib_bihash_bucket) * buckets;
 124   volatile u32 *alloc_lock;
 125
 126   BVT (clib_bihash_value) ** working_copies;
 127   int *working_copy_lengths;
 128   BVT (clib_bihash_bucket) saved_bucket;
 129
 130   u32 nbuckets;
 131   u32 log2_nbuckets;
 132   u64 memory_size;
 133   u8 *name;
 134
 135   u64 *freelists;
 136
 137 #if BIHASH_32_64_SVM
 138   BVT (clib_bihash_shared_header) * sh;
 139   int memfd;
 140 #else
 141   BVT (clib_bihash_shared_header) sh;
 142 #endif
 143
 144   u64 alloc_arena;              /* Base of the allocation arena */
 145   volatile u8 instantiated;
 146
 147   /**
 148     * A custom format function to print the Key and Value of bihash_key instead of default hexdump
 149     */
 150   format_function_t *fmt_fn;
 151
 152   /** Optional statistics-gathering callback */
 153 #if BIHASH_ENABLE_STATS
 154   void (*inc_stats_callback) (BVS (clib_bihash) *, int stat_id, u64 count);
 155
 156   /** Statistics callback context (e.g. address of stats data structure) */
 157   void *inc_stats_context;
 158 #endif
 159
 160 } BVT (clib_bihash);
 161
 162 typedef struct
 163 {
 164   BVT (clib_bihash) * h;
 165   char *name;
 166   u32 nbuckets;
 167   uword memory_size;
 168   format_function_t *fmt_fn;
 169   u8 instantiate_immediately;
 170   u8 dont_add_to_all_bihash_list;
 171 } BVT (clib_bihash_init2_args);
 172
 173 extern void **clib_all_bihashes;
 174
 175 #if BIHASH_32_64_SVM
 176 #undef alloc_arena_next
 177 #undef alloc_arena_size
 178 #undef alloc_arena
 179 #undef CLIB_BIHASH_READY_MAGIC
 180 #define alloc_arena_next(h) (((h)->sh)->alloc_arena_next)
 181 #define alloc_arena_size(h) (((h)->sh)->alloc_arena_size)
 182 #define alloc_arena(h) ((h)->alloc_arena)
 183 #define CLIB_BIHASH_READY_MAGIC 0xFEEDFACE
 184 #else
 185 #undef alloc_arena_next
 186 #undef alloc_arena_size
 187 #undef alloc_arena
 188 #undef CLIB_BIHASH_READY_MAGIC
 189 #define alloc_arena_next(h) ((h)->sh.alloc_arena_next)
 190 #define alloc_arena_size(h) ((h)->sh.alloc_arena_size)
 191 #define alloc_arena(h) ((h)->alloc_arena)
 192 #define CLIB_BIHASH_READY_MAGIC 0
 193 #endif
 194
 195 #ifndef BIHASH_STAT_IDS
 196 #define BIHASH_STAT_IDS 1
 197
 198 #define foreach_bihash_stat                     \
 199 _(alloc_add)                                    \
 200 _(add)                                          \
 201 _(split_add)                                    \
 202 _(replace)                                      \
 203 _(update)                                       \
 204 _(del)                                          \
 205 _(del_free)                                     \
 206 _(linear)                                       \
 207 _(resplit)                                      \
 208 _(working_copy_lost)                            \
 209 _(splits)                       /* must be last */
 210
 211 typedef enum
 212 {
 213 #define _(a) BIHASH_STAT_##a,
 214   foreach_bihash_stat
 215 #undef _
 216     BIHASH_STAT_N_STATS,
 217 } BVT (clib_bihash_stat_id);
 218 #endif /* BIHASH_STAT_IDS */
 219
 220 static inline void BV (clib_bihash_increment_stat) (BVT (clib_bihash) * h,
 221                                                     int stat_id, u64 count)
 222 {
 223 #if BIHASH_ENABLE_STATS
 224   if (PREDICT_FALSE (h->inc_stats_callback != 0))
 225     h->inc_stats_callback (h, stat_id, count);
 226 #endif
 227 }
 228
 229 #if BIHASH_ENABLE_STATS
 230 static inline void BV (clib_bihash_set_stats_callback)
 231   (BVT (clib_bihash) * h, void (*cb) (BVT (clib_bihash) *, int, u64),
 232    void *ctx)
 233 {
 234   h->inc_stats_callback = cb;
 235   h->inc_stats_context = ctx;
 236 }
 237 #endif
 238
 239
 240 static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h)
 241 {
 242   while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE))
 243     CLIB_PAUSE ();
 244 }
 245
 246 static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h)
 247 {
 248   __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE);
 249 }
 250
 251 static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b)
 252 {
 253   BVT (clib_bihash_bucket) unlocked_bucket, locked_bucket;
 254
 255   do
 256     {
 257       locked_bucket.as_u64 = unlocked_bucket.as_u64 = b->as_u64;
 258       unlocked_bucket.lock = 0;
 259       locked_bucket.lock = 1;
 260       CLIB_PAUSE ();
 261     }
 262   while (__atomic_compare_exchange_n (&b->as_u64, &unlocked_bucket.as_u64,
 263                                       locked_bucket.as_u64, 1 /* weak */ ,
 264                                       __ATOMIC_ACQUIRE,
 265                                       __ATOMIC_ACQUIRE) == 0);
 266 }
 267
 268 static inline void BV (clib_bihash_unlock_bucket)
 269   (BVT (clib_bihash_bucket) * b)
 270 {
 271   CLIB_MEMORY_BARRIER ();
 272   b->lock = 0;
 273 }
 274
 275 static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h,
 276                                                 uword offset)
 277 {
 278   u8 *hp = (u8 *) (uword) alloc_arena (h);
 279   u8 *vp = hp + offset;
 280
 281   return (void *) vp;
 282 }
 283
 284 static inline int BV (clib_bihash_bucket_is_empty)
 285   (BVT (clib_bihash_bucket) * b)
 286 {
 287   /* Note: applied to locked buckets, test offset */
 288   return b->offset == 0;
 289 }
 290
 291 static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h,
 292                                                  void *v)
 293 {
 294   u8 *hp, *vp;
 295
 296   hp = (u8 *) (uword) alloc_arena (h);
 297   vp = (u8 *) v;
 298
 299   return vp - hp;
 300 }
 301
 302 void BV (clib_bihash_init)
 303   (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size);
 304
 305 void BV (clib_bihash_init2) (BVT (clib_bihash_init2_args) * a);
 306
 307 #if BIHASH_32_64_SVM
 308 void BV (clib_bihash_master_init_svm)
 309   (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size);
 310 void BV (clib_bihash_slave_init_svm)
 311   (BVT (clib_bihash) * h, char *name, int fd);
 312 #endif
 313
 314 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
 315                                          format_function_t * fmt_fn);
 316
 317 void BV (clib_bihash_free) (BVT (clib_bihash) * h);
 318
 319 int BV (clib_bihash_add_del) (BVT (clib_bihash) * h,
 320                               BVT (clib_bihash_kv) * add_v, int is_add);
 321 int BV (clib_bihash_add_or_overwrite_stale) (BVT (clib_bihash) * h,
 322                                              BVT (clib_bihash_kv) * add_v,
 323                                              int (*is_stale_cb) (BVT
 324                                                                  (clib_bihash_kv)
 325                                                                  *, void *),
 326                                              void *arg);
 327 int BV (clib_bihash_search) (BVT (clib_bihash) * h,
 328                              BVT (clib_bihash_kv) * search_v,
 329                              BVT (clib_bihash_kv) * return_v);
 330
 331 void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h,
 332                                               void *callback, void *arg);
 333 void *clib_all_bihash_set_heap (void);
 334 void clib_bihash_copied (void *dst, void *src);
 335
 336 format_function_t BV (format_bihash);
 337 format_function_t BV (format_bihash_kvp);
 338 format_function_t BV (format_bihash_lru);
 339
 340 static inline int BV (clib_bihash_search_inline_with_hash)
 341   (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result)
 342 {
 343   u32 bucket_index;
 344   BVT (clib_bihash_value) * v;
 345   BVT (clib_bihash_bucket) * b;
 346   int i, limit;
 347
 348   if (PREDICT_FALSE (alloc_arena (h) == 0))
 349     return -1;
 350
 351   bucket_index = hash & (h->nbuckets - 1);
 352   b = &h->buckets[bucket_index];
 353
 354   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 355     return -1;
 356
 357   if (PREDICT_FALSE (b->lock))
 358     {
 359       volatile BVT (clib_bihash_bucket) * bv = b;
 360       while (bv->lock)
 361         CLIB_PAUSE ();
 362     }
 363
 364   hash >>= h->log2_nbuckets;
 365
 366   v = BV (clib_bihash_get_value) (h, b->offset);
 367
 368   /* If the bucket has unresolvable collisions, use linear search */
 369   limit = BIHASH_KVP_PER_PAGE;
 370   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 371   if (PREDICT_FALSE (b->linear_search))
 372     limit <<= b->log2_pages;
 373
 374   for (i = 0; i < limit; i++)
 375     {
 376       if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key))
 377         {
 378           *key_result = v->kvp[i];
 379           return 0;
 380         }
 381     }
 382   return -1;
 383 }
 384
 385 static inline int BV (clib_bihash_search_inline)
 386   (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result)
 387 {
 388   u64 hash;
 389
 390   hash = BV (clib_bihash_hash) (key_result);
 391
 392   return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result);
 393 }
 394
 395 static inline void BV (clib_bihash_prefetch_bucket)
 396   (BVT (clib_bihash) * h, u64 hash)
 397 {
 398   u32 bucket_index;
 399   BVT (clib_bihash_bucket) * b;
 400
 401   bucket_index = hash & (h->nbuckets - 1);
 402   b = &h->buckets[bucket_index];
 403
 404   CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, READ);
 405 }
 406
 407 static inline void BV (clib_bihash_prefetch_data)
 408   (BVT (clib_bihash) * h, u64 hash)
 409 {
 410   u32 bucket_index;
 411   BVT (clib_bihash_value) * v;
 412   BVT (clib_bihash_bucket) * b;
 413
 414   if (PREDICT_FALSE (alloc_arena (h) == 0))
 415     return;
 416
 417   bucket_index = hash & (h->nbuckets - 1);
 418   b = &h->buckets[bucket_index];
 419
 420   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 421     return;
 422
 423   hash >>= h->log2_nbuckets;
 424   v = BV (clib_bihash_get_value) (h, b->offset);
 425
 426   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 427
 428   CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, READ);
 429 }
 430
 431 static inline int BV (clib_bihash_search_inline_2_with_hash)
 432   (BVT (clib_bihash) * h,
 433    u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
 434 {
 435   u32 bucket_index;
 436   BVT (clib_bihash_value) * v;
 437   BVT (clib_bihash_bucket) * b;
 438   int i, limit;
 439
 440   ASSERT (valuep);
 441
 442   if (PREDICT_FALSE (alloc_arena (h) == 0))
 443     return -1;
 444
 445   bucket_index = hash & (h->nbuckets - 1);
 446   b = &h->buckets[bucket_index];
 447
 448   if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b)))
 449     return -1;
 450
 451   if (PREDICT_FALSE (b->lock))
 452     {
 453       volatile BVT (clib_bihash_bucket) * bv = b;
 454       while (bv->lock)
 455         CLIB_PAUSE ();
 456     }
 457
 458   hash >>= h->log2_nbuckets;
 459   v = BV (clib_bihash_get_value) (h, b->offset);
 460
 461   /* If the bucket has unresolvable collisions, use linear search */
 462   limit = BIHASH_KVP_PER_PAGE;
 463   v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
 464   if (PREDICT_FALSE (b->linear_search))
 465     limit <<= b->log2_pages;
 466
 467   for (i = 0; i < limit; i++)
 468     {
 469       if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
 470         {
 471           *valuep = v->kvp[i];
 472           return 0;
 473         }
 474     }
 475   return -1;
 476 }
 477
 478 static inline int BV (clib_bihash_search_inline_2)
 479   (BVT (clib_bihash) * h,
 480    BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
 481 {
 482   u64 hash;
 483
 484   hash = BV (clib_bihash_hash) (search_key);
 485
 486   return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key,
 487                                                      valuep);
 488 }
 489
 490
 491 #endif /* __included_bihash_template_h__ */
 492
 493 /** @endcond */
 494
 495 /*
 496  * fd.io coding-style-patch-verification: ON
 497  *
 498  * Local Variables:
 499  * eval: (c-set-style "gnu")
 500  * End:
 501  */