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