src/vppinfra/bihash_template.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */
  17
  18 #ifndef MAP_HUGE_SHIFT
  19 #define MAP_HUGE_SHIFT 26
  20 #endif
  21
  22 #ifndef BIIHASH_MIN_ALLOC_LOG2_PAGES
  23 #define BIIHASH_MIN_ALLOC_LOG2_PAGES 10
  24 #endif
  25
  26 #ifndef BIHASH_USE_HEAP
  27 #define BIHASH_USE_HEAP 1
  28 #endif
  29
  30 static inline void *BV (alloc_aligned) (BVT (clib_bihash) * h, uword nbytes)
  31 {
  32   uword rv;
  33
  34   /* Round to an even number of cache lines */
  35   nbytes = round_pow2 (nbytes, CLIB_CACHE_LINE_BYTES);
  36
  37   if (BIHASH_USE_HEAP)
  38     {
  39       void *rv, *oldheap;
  40       uword page_sz = sizeof (BVT (clib_bihash_value));
  41       uword chunk_sz = round_pow2 (page_sz << BIIHASH_MIN_ALLOC_LOG2_PAGES,
  42                                    CLIB_CACHE_LINE_BYTES);
  43
  44       BVT (clib_bihash_alloc_chunk) * chunk = h->chunks;
  45
  46       /* if there is enough space in the currenrt chunk */
  47       if (chunk && chunk->bytes_left >= nbytes)
  48         {
  49           rv = chunk->next_alloc;
  50           chunk->bytes_left -= nbytes;
  51           chunk->next_alloc += nbytes;
  52           return rv;
  53         }
  54
  55       /* requested allocation is bigger than chunk size */
  56       if (nbytes >= chunk_sz)
  57         {
  58           oldheap = clib_mem_set_heap (h->heap);
  59           chunk = clib_mem_alloc_aligned (nbytes + sizeof (*chunk),
  60                                           CLIB_CACHE_LINE_BYTES);
  61           clib_mem_set_heap (oldheap);
  62           clib_memset_u8 (chunk, 0, sizeof (*chunk));
  63           chunk->size = nbytes;
  64           rv = (u8 *) (chunk + 1);
  65           if (h->chunks)
  66             {
  67               /* take 2nd place in the list */
  68               chunk->next = h->chunks->next;
  69               chunk->prev = h->chunks;
  70               h->chunks->next = chunk;
  71               if (chunk->next)
  72                 chunk->next->prev = chunk;
  73             }
  74           else
  75             h->chunks = chunk;
  76
  77           return rv;
  78         }
  79
  80       oldheap = clib_mem_set_heap (h->heap);
  81       chunk = clib_mem_alloc_aligned (chunk_sz + sizeof (*chunk),
  82                                       CLIB_CACHE_LINE_BYTES);
  83       clib_mem_set_heap (oldheap);
  84       chunk->size = chunk_sz;
  85       chunk->bytes_left = chunk_sz;
  86       chunk->next_alloc = (u8 *) (chunk + 1);
  87       chunk->next = h->chunks;
  88       chunk->prev = 0;
  89       if (chunk->next)
  90         chunk->next->prev = chunk;
  91       h->chunks = chunk;
  92       rv = chunk->next_alloc;
  93       chunk->bytes_left -= nbytes;
  94       chunk->next_alloc += nbytes;
  95       return rv;
  96     }
  97
  98   rv = alloc_arena_next (h);
  99   alloc_arena_next (h) += nbytes;
 100
 101   if (alloc_arena_next (h) > alloc_arena_size (h))
 102     os_out_of_memory ();
 103
 104   if (alloc_arena_next (h) > alloc_arena_mapped (h))
 105     {
 106       void *base, *rv;
 107       uword alloc = alloc_arena_next (h) - alloc_arena_mapped (h);
 108       int mmap_flags = MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS;
 109 #if __linux__
 110       int mmap_flags_huge = (mmap_flags | MAP_HUGETLB | MAP_LOCKED |
 111                              BIHASH_LOG2_HUGEPAGE_SIZE << MAP_HUGE_SHIFT);
 112 #endif /* __linux__ */
 113
 114       /* new allocation is 25% of existing one */
 115       if (alloc_arena_mapped (h) >> 2 > alloc)
 116         alloc = alloc_arena_mapped (h) >> 2;
 117
 118       /* round allocation to page size */
 119       alloc = round_pow2 (alloc, 1 << BIHASH_LOG2_HUGEPAGE_SIZE);
 120
 121       base = (void *) (uword) (alloc_arena (h) + alloc_arena_mapped (h));
 122
 123 #if __linux__
 124       rv = mmap (base, alloc, PROT_READ | PROT_WRITE, mmap_flags_huge, -1, 0);
 125 #elif __FreeBSD__
 126       rv = MAP_FAILED;
 127 #endif /* __linux__ */
 128
 129       /* fallback - maybe we are still able to allocate normal pages */
 130       if (rv == MAP_FAILED || mlock (base, alloc) != 0)
 131         rv = mmap (base, alloc, PROT_READ | PROT_WRITE, mmap_flags, -1, 0);
 132
 133       if (rv == MAP_FAILED)
 134         os_out_of_memory ();
 135
 136       alloc_arena_mapped (h) += alloc;
 137     }
 138
 139   return (void *) (uword) (rv + alloc_arena (h));
 140 }
 141
 142 static void BV (clib_bihash_instantiate) (BVT (clib_bihash) * h)
 143 {
 144   uword bucket_size;
 145
 146   if (BIHASH_USE_HEAP)
 147     {
 148       h->heap = clib_mem_get_heap ();
 149       h->chunks = 0;
 150       alloc_arena (h) = (uword) clib_mem_get_heap_base (h->heap);
 151     }
 152   else
 153     {
 154       alloc_arena (h) = clib_mem_vm_reserve (0, h->memory_size,
 155                                              BIHASH_LOG2_HUGEPAGE_SIZE);
 156       if (alloc_arena (h) == ~0)
 157         os_out_of_memory ();
 158       alloc_arena_next (h) = 0;
 159       alloc_arena_size (h) = h->memory_size;
 160       alloc_arena_mapped (h) = 0;
 161     }
 162
 163   bucket_size = h->nbuckets * sizeof (h->buckets[0]);
 164
 165   if (BIHASH_KVP_AT_BUCKET_LEVEL)
 166     bucket_size +=
 167       h->nbuckets * BIHASH_KVP_PER_PAGE * sizeof (BVT (clib_bihash_kv));
 168
 169   h->buckets = BV (alloc_aligned) (h, bucket_size);
 170   clib_memset_u8 (h->buckets, 0, bucket_size);
 171
 172   if (BIHASH_KVP_AT_BUCKET_LEVEL)
 173     {
 174       int i, j;
 175       BVT (clib_bihash_bucket) * b;
 176
 177       b = h->buckets;
 178
 179       for (i = 0; i < h->nbuckets; i++)
 180         {
 181           BVT (clib_bihash_kv) * v;
 182           b->offset = BV (clib_bihash_get_offset) (h, (void *) (b + 1));
 183           b->refcnt = 1;
 184           /* Mark all elements free */
 185           v = (void *) (b + 1);
 186           for (j = 0; j < BIHASH_KVP_PER_PAGE; j++)
 187             {
 188               BV (clib_bihash_mark_free) (v);
 189               v++;
 190             }
 191           /* Compute next bucket start address */
 192           b = (void *) (((uword) b) + sizeof (*b) +
 193                         (BIHASH_KVP_PER_PAGE *
 194                          sizeof (BVT (clib_bihash_kv))));
 195         }
 196     }
 197   CLIB_MEMORY_STORE_BARRIER ();
 198   h->instantiated = 1;
 199 }
 200
 201 void BV (clib_bihash_init2) (BVT (clib_bihash_init2_args) * a)
 202 {
 203   int i;
 204   void *oldheap;
 205   BVT (clib_bihash) * h = a->h;
 206
 207   a->nbuckets = 1 << (max_log2 (a->nbuckets));
 208
 209   h->name = (u8 *) a->name;
 210   h->nbuckets = a->nbuckets;
 211   h->log2_nbuckets = max_log2 (a->nbuckets);
 212   h->memory_size = BIHASH_USE_HEAP ? 0 : a->memory_size;
 213   h->instantiated = 0;
 214   h->dont_add_to_all_bihash_list = a->dont_add_to_all_bihash_list;
 215   h->fmt_fn = BV (format_bihash);
 216   h->kvp_fmt_fn = a->kvp_fmt_fn;
 217
 218   alloc_arena (h) = 0;
 219
 220   /*
 221    * Make sure the requested size is rational. The max table
 222    * size without playing the alignment card is 64 Gbytes.
 223    * If someone starts complaining that's not enough, we can shift
 224    * the offset by CLIB_LOG2_CACHE_LINE_BYTES...
 225    */
 226   if (BIHASH_USE_HEAP)
 227     ASSERT (h->memory_size < (1ULL << BIHASH_BUCKET_OFFSET_BITS));
 228
 229   /* Add this hash table to the list */
 230   if (a->dont_add_to_all_bihash_list == 0)
 231     {
 232       for (i = 0; i < vec_len (clib_all_bihashes); i++)
 233         if (clib_all_bihashes[i] == h)
 234           goto do_lock;
 235       oldheap = clib_all_bihash_set_heap ();
 236       vec_add1 (clib_all_bihashes, (void *) h);
 237       clib_mem_set_heap (oldheap);
 238     }
 239
 240 do_lock:
 241   if (h->alloc_lock)
 242     clib_mem_free ((void *) h->alloc_lock);
 243
 244   /*
 245    * Set up the lock now, so we can use it to make the first add
 246    * thread-safe
 247    */
 248   h->alloc_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
 249                                           CLIB_CACHE_LINE_BYTES);
 250   h->alloc_lock[0] = 0;
 251
 252 #if BIHASH_LAZY_INSTANTIATE
 253   if (a->instantiate_immediately)
 254 #endif
 255     BV (clib_bihash_instantiate) (h);
 256 }
 257
 258 void BV (clib_bihash_init)
 259   (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size)
 260 {
 261   BVT (clib_bihash_init2_args) _a, *a = &_a;
 262
 263   memset (a, 0, sizeof (*a));
 264
 265   a->h = h;
 266   a->name = name;
 267   a->nbuckets = nbuckets;
 268   a->memory_size = memory_size;
 269
 270   BV (clib_bihash_init2) (a);
 271 }
 272
 273 #if BIHASH_32_64_SVM
 274 #if !defined (MFD_ALLOW_SEALING)
 275 #define MFD_ALLOW_SEALING 0x0002U
 276 #endif
 277
 278 void BV (clib_bihash_initiator_init_svm)
 279   (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size)
 280 {
 281   uword bucket_size;
 282   u8 *mmap_addr;
 283   vec_header_t *freelist_vh;
 284   int fd;
 285
 286   ASSERT (BIHASH_USE_HEAP == 0);
 287
 288   ASSERT (memory_size < (1ULL << 32));
 289   /* Set up for memfd sharing */
 290   if ((fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, name) == -1)
 291     {
 292       clib_unix_warning ("memfd_create");
 293       return;
 294     }
 295
 296   if (ftruncate (fd, memory_size) < 0)
 297     {
 298       clib_unix_warning ("ftruncate");
 299       return;
 300     }
 301
 302   /* Not mission-critical, complain and continue */
 303   if ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
 304     clib_unix_warning ("fcntl (F_ADD_SEALS)");
 305
 306   mmap_addr = mmap (0, memory_size,
 307                     PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 /* offset */ );
 308
 309   if (mmap_addr == MAP_FAILED)
 310     {
 311       clib_unix_warning ("mmap failed");
 312       ASSERT (0);
 313     }
 314
 315   h->sh = (void *) mmap_addr;
 316   h->memfd = fd;
 317   nbuckets = 1 << (max_log2 (nbuckets));
 318
 319   h->name = (u8 *) name;
 320   h->sh->nbuckets = h->nbuckets = nbuckets;
 321   h->log2_nbuckets = max_log2 (nbuckets);
 322
 323   alloc_arena (h) = (u64) (uword) mmap_addr;
 324   alloc_arena_next (h) = CLIB_CACHE_LINE_BYTES;
 325   alloc_arena_size (h) = memory_size;
 326
 327   bucket_size = nbuckets * sizeof (h->buckets[0]);
 328   h->buckets = BV (alloc_aligned) (h, bucket_size);
 329   clib_memset_u8 (h->buckets, 0, bucket_size);
 330   h->sh->buckets_as_u64 = (u64) BV (clib_bihash_get_offset) (h, h->buckets);
 331
 332   h->alloc_lock = BV (alloc_aligned) (h, CLIB_CACHE_LINE_BYTES);
 333   h->alloc_lock[0] = 0;
 334
 335   h->sh->alloc_lock_as_u64 =
 336     (u64) BV (clib_bihash_get_offset) (h, (void *) h->alloc_lock);
 337   freelist_vh =
 338     BV (alloc_aligned) (h,
 339                         sizeof (vec_header_t) +
 340                         BIHASH_FREELIST_LENGTH * sizeof (u64));
 341   freelist_vh->len = BIHASH_FREELIST_LENGTH;
 342   h->sh->freelists_as_u64 =
 343     (u64) BV (clib_bihash_get_offset) (h, freelist_vh->vector_data);
 344   h->freelists = (void *) (freelist_vh->vector_data);
 345
 346   h->fmt_fn = BV (format_bihash);
 347   h->kvp_fmt_fn = NULL;
 348   h->instantiated = 1;
 349 }
 350
 351 void BV (clib_bihash_responder_init_svm)
 352   (BVT (clib_bihash) * h, char *name, int fd)
 353 {
 354   u8 *mmap_addr;
 355   u64 memory_size;
 356   BVT (clib_bihash_shared_header) * sh;
 357
 358   ASSERT (BIHASH_USE_HEAP == 0);
 359
 360   /* Trial mapping, to learn the segment size */
 361   mmap_addr = mmap (0, 4096, PROT_READ, MAP_SHARED, fd, 0 /* offset */ );
 362   if (mmap_addr == MAP_FAILED)
 363     {
 364       clib_unix_warning ("trial mmap failed");
 365       ASSERT (0);
 366     }
 367
 368   sh = (BVT (clib_bihash_shared_header) *) mmap_addr;
 369
 370   memory_size = sh->alloc_arena_size;
 371
 372   munmap (mmap_addr, 4096);
 373
 374   /* Actual mapping, at the required size */
 375   mmap_addr = mmap (0, memory_size,
 376                     PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 /* offset */ );
 377
 378   if (mmap_addr == MAP_FAILED)
 379     {
 380       clib_unix_warning ("mmap failed");
 381       ASSERT (0);
 382     }
 383
 384   (void) close (fd);
 385
 386   h->sh = (void *) mmap_addr;
 387   alloc_arena (h) = (u64) (uword) mmap_addr;
 388   h->memfd = -1;
 389
 390   h->name = (u8 *) name;
 391   h->buckets = BV (clib_bihash_get_value) (h, h->sh->buckets_as_u64);
 392   h->nbuckets = h->sh->nbuckets;
 393   h->log2_nbuckets = max_log2 (h->nbuckets);
 394
 395   h->alloc_lock = BV (clib_bihash_get_value) (h, h->sh->alloc_lock_as_u64);
 396   h->freelists = BV (clib_bihash_get_value) (h, h->sh->freelists_as_u64);
 397   h->fmt_fn = BV (format_bihash);
 398   h->kvp_fmt_fn = NULL;
 399 }
 400 #endif /* BIHASH_32_64_SVM */
 401
 402 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
 403                                          format_function_t * kvp_fmt_fn)
 404 {
 405   h->kvp_fmt_fn = kvp_fmt_fn;
 406 }
 407
 408 int BV (clib_bihash_is_initialised) (const BVT (clib_bihash) * h)
 409 {
 410   return (h->instantiated != 0);
 411 }
 412
 413 void BV (clib_bihash_free) (BVT (clib_bihash) * h)
 414 {
 415   int i;
 416
 417   if (PREDICT_FALSE (h->instantiated == 0))
 418     goto never_initialized;
 419
 420   h->instantiated = 0;
 421
 422   if (BIHASH_USE_HEAP)
 423     {
 424       BVT (clib_bihash_alloc_chunk) * next, *chunk;
 425       void *oldheap = clib_mem_set_heap (h->heap);
 426
 427       chunk = h->chunks;
 428       while (chunk)
 429         {
 430           next = chunk->next;
 431           clib_mem_free (chunk);
 432           chunk = next;
 433         }
 434       clib_mem_set_heap (oldheap);
 435     }
 436
 437   vec_free (h->working_copies);
 438   vec_free (h->working_copy_lengths);
 439   clib_mem_free ((void *) h->alloc_lock);
 440 #if BIHASH_32_64_SVM == 0
 441   vec_free (h->freelists);
 442 #else
 443   if (h->memfd > 0)
 444     (void) close (h->memfd);
 445 #endif
 446   if (BIHASH_USE_HEAP == 0)
 447     clib_mem_vm_free ((void *) (uword) (alloc_arena (h)),
 448                       alloc_arena_size (h));
 449 never_initialized:
 450   if (h->dont_add_to_all_bihash_list)
 451     {
 452       clib_memset_u8 (h, 0, sizeof (*h));
 453       return;
 454     }
 455   clib_memset_u8 (h, 0, sizeof (*h));
 456   for (i = 0; i < vec_len (clib_all_bihashes); i++)
 457     {
 458       if ((void *) h == clib_all_bihashes[i])
 459         {
 460           vec_delete (clib_all_bihashes, 1, i);
 461           return;
 462         }
 463     }
 464   clib_warning ("Couldn't find hash table %llx on clib_all_bihashes...",
 465                 (u64) (uword) h);
 466 }
 467
 468 static
 469 BVT (clib_bihash_value) *
 470 BV (value_alloc) (BVT (clib_bihash) * h, u32 log2_pages)
 471 {
 472   int i;
 473   BVT (clib_bihash_value) * rv = 0;
 474
 475   ASSERT (h->alloc_lock[0]);
 476
 477 #if BIHASH_32_64_SVM
 478   ASSERT (log2_pages < vec_len (h->freelists));
 479 #endif
 480
 481   if (log2_pages >= vec_len (h->freelists) || h->freelists[log2_pages] == 0)
 482     {
 483       vec_validate_init_empty (h->freelists, log2_pages, 0);
 484       rv = BV (alloc_aligned) (h, (sizeof (*rv) * (1 << log2_pages)));
 485       goto initialize;
 486     }
 487   rv = BV (clib_bihash_get_value) (h, (uword) h->freelists[log2_pages]);
 488   h->freelists[log2_pages] = rv->next_free_as_u64;
 489
 490 initialize:
 491   ASSERT (rv);
 492
 493   BVT (clib_bihash_kv) * v;
 494   v = (BVT (clib_bihash_kv) *) rv;
 495
 496   for (i = 0; i < BIHASH_KVP_PER_PAGE * (1 << log2_pages); i++)
 497     {
 498       BV (clib_bihash_mark_free) (v);
 499       v++;
 500     }
 501   return rv;
 502 }
 503
 504 static void
 505 BV (value_free) (BVT (clib_bihash) * h, BVT (clib_bihash_value) * v,
 506                  u32 log2_pages)
 507 {
 508   ASSERT (h->alloc_lock[0]);
 509
 510   ASSERT (vec_len (h->freelists) > log2_pages);
 511
 512   if (BIHASH_USE_HEAP && log2_pages >= BIIHASH_MIN_ALLOC_LOG2_PAGES)
 513     {
 514       /* allocations bigger or equal to chunk size always contain single
 515        * alloc and they can be given back to heap */
 516       void *oldheap;
 517       BVT (clib_bihash_alloc_chunk) * c;
 518       c = (BVT (clib_bihash_alloc_chunk) *) v - 1;
 519
 520       if (c->prev)
 521         c->prev->next = c->next;
 522       else
 523         h->chunks = c->next;
 524
 525       if (c->next)
 526         c->next->prev = c->prev;
 527
 528       oldheap = clib_mem_set_heap (h->heap);
 529       clib_mem_free (c);
 530       clib_mem_set_heap (oldheap);
 531       return;
 532     }
 533
 534   if (CLIB_DEBUG > 0)
 535     clib_memset_u8 (v, 0xFE, sizeof (*v) * (1 << log2_pages));
 536
 537   v->next_free_as_u64 = (u64) h->freelists[log2_pages];
 538   h->freelists[log2_pages] = (u64) BV (clib_bihash_get_offset) (h, v);
 539 }
 540
 541 static inline void
 542 BV (make_working_copy) (BVT (clib_bihash) * h, BVT (clib_bihash_bucket) * b)
 543 {
 544   BVT (clib_bihash_value) * v;
 545   BVT (clib_bihash_bucket) working_bucket __attribute__ ((aligned (8)));
 546   BVT (clib_bihash_value) * working_copy;
 547   u32 thread_index = os_get_thread_index ();
 548   int log2_working_copy_length;
 549
 550   ASSERT (h->alloc_lock[0]);
 551
 552   if (thread_index >= vec_len (h->working_copies))
 553     {
 554       vec_validate (h->working_copies, thread_index);
 555       vec_validate_init_empty (h->working_copy_lengths, thread_index, ~0);
 556     }
 557
 558   /*
 559    * working_copies are per-cpu so that near-simultaneous
 560    * updates from multiple threads will not result in sporadic, spurious
 561    * lookup failures.
 562    */
 563   working_copy = h->working_copies[thread_index];
 564   log2_working_copy_length = h->working_copy_lengths[thread_index];
 565
 566   h->saved_bucket.as_u64 = b->as_u64;
 567
 568   if (b->log2_pages > log2_working_copy_length)
 569     {
 570       /*
 571        * It's not worth the bookkeeping to free working copies
 572        *   if (working_copy)
 573        *     clib_mem_free (working_copy);
 574        */
 575       working_copy = BV (alloc_aligned)
 576         (h, sizeof (working_copy[0]) * (1 << b->log2_pages));
 577       h->working_copy_lengths[thread_index] = b->log2_pages;
 578       h->working_copies[thread_index] = working_copy;
 579
 580       BV (clib_bihash_increment_stat) (h, BIHASH_STAT_working_copy_lost,
 581                                        1ULL << b->log2_pages);
 582     }
 583
 584   v = BV (clib_bihash_get_value) (h, b->offset);
 585
 586   clib_memcpy_fast (working_copy, v, sizeof (*v) * (1 << b->log2_pages));
 587   working_bucket.as_u64 = b->as_u64;
 588   working_bucket.offset = BV (clib_bihash_get_offset) (h, working_copy);
 589   CLIB_MEMORY_STORE_BARRIER ();
 590   b->as_u64 = working_bucket.as_u64;
 591   h->working_copies[thread_index] = working_copy;
 592 }
 593
 594 static
 595 BVT (clib_bihash_value) *
 596 BV (split_and_rehash)
 597   (BVT (clib_bihash) * h,
 598    BVT (clib_bihash_value) * old_values, u32 old_log2_pages,
 599    u32 new_log2_pages)
 600 {
 601   BVT (clib_bihash_value) * new_values, *new_v;
 602   int i, j, length_in_kvs;
 603
 604   ASSERT (h->alloc_lock[0]);
 605
 606   new_values = BV (value_alloc) (h, new_log2_pages);
 607   length_in_kvs = (1 << old_log2_pages) * BIHASH_KVP_PER_PAGE;
 608
 609   for (i = 0; i < length_in_kvs; i++)
 610     {
 611       u64 new_hash;
 612
 613       /* Entry not in use? Forget it */
 614       if (BV (clib_bihash_is_free) (&(old_values->kvp[i])))
 615         continue;
 616
 617       /* rehash the item onto its new home-page */
 618       new_hash = BV (clib_bihash_hash) (&(old_values->kvp[i]));
 619       new_hash = extract_bits (new_hash, h->log2_nbuckets, new_log2_pages);
 620       new_v = &new_values[new_hash];
 621
 622       /* Across the new home-page */
 623       for (j = 0; j < BIHASH_KVP_PER_PAGE; j++)
 624         {
 625           /* Empty slot */
 626           if (BV (clib_bihash_is_free) (&(new_v->kvp[j])))
 627             {
 628               clib_memcpy_fast (&(new_v->kvp[j]), &(old_values->kvp[i]),
 629                                 sizeof (new_v->kvp[j]));
 630               goto doublebreak;
 631             }
 632         }
 633       /* Crap. Tell caller to try again */
 634       BV (value_free) (h, new_values, new_log2_pages);
 635       return 0;
 636     doublebreak:;
 637     }
 638
 639   return new_values;
 640 }
 641
 642 static
 643 BVT (clib_bihash_value) *
 644 BV (split_and_rehash_linear)
 645   (BVT (clib_bihash) * h,
 646    BVT (clib_bihash_value) * old_values, u32 old_log2_pages,
 647    u32 new_log2_pages)
 648 {
 649   BVT (clib_bihash_value) * new_values;
 650   int i, j, new_length, old_length;
 651
 652   ASSERT (h->alloc_lock[0]);
 653
 654   new_values = BV (value_alloc) (h, new_log2_pages);
 655   new_length = (1 << new_log2_pages) * BIHASH_KVP_PER_PAGE;
 656   old_length = (1 << old_log2_pages) * BIHASH_KVP_PER_PAGE;
 657
 658   j = 0;
 659   /* Across the old value array */
 660   for (i = 0; i < old_length; i++)
 661     {
 662       /* Find a free slot in the new linear scan bucket */
 663       for (; j < new_length; j++)
 664         {
 665           /* Old value not in use? Forget it. */
 666           if (BV (clib_bihash_is_free) (&(old_values->kvp[i])))
 667             goto doublebreak;
 668
 669           /* New value should never be in use */
 670           if (BV (clib_bihash_is_free) (&(new_values->kvp[j])))
 671             {
 672               /* Copy the old value and move along */
 673               clib_memcpy_fast (&(new_values->kvp[j]), &(old_values->kvp[i]),
 674                                 sizeof (new_values->kvp[j]));
 675               j++;
 676               goto doublebreak;
 677             }
 678         }
 679       /* This should never happen... */
 680       clib_warning ("BUG: linear rehash failed!");
 681       BV (value_free) (h, new_values, new_log2_pages);
 682       return 0;
 683
 684     doublebreak:;
 685     }
 686   return new_values;
 687 }
 688
 689 static_always_inline int BV (clib_bihash_add_del_inline_with_hash) (
 690   BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, u64 hash, int is_add,
 691   int (*is_stale_cb) (BVT (clib_bihash_kv) *, void *), void *is_stale_arg,
 692   void (*overwrite_cb) (BVT (clib_bihash_kv) *, void *), void *overwrite_arg)
 693 {
 694   BVT (clib_bihash_bucket) * b, tmp_b;
 695   BVT (clib_bihash_value) * v, *new_v, *save_new_v, *working_copy;
 696   int i, limit;
 697   u64 new_hash;
 698   u32 new_log2_pages, old_log2_pages;
 699   u32 thread_index = os_get_thread_index ();
 700   int mark_bucket_linear;
 701   int resplit_once;
 702
 703   /* *INDENT-OFF* */
 704   static const BVT (clib_bihash_bucket) mask = {
 705     .linear_search = 1,
 706     .log2_pages = -1
 707   };
 708   /* *INDENT-ON* */
 709
 710 #if BIHASH_LAZY_INSTANTIATE
 711   /*
 712    * Create the table (is_add=1,2), or flunk the request now (is_add=0)
 713    * Use the alloc_lock to protect the instantiate operation.
 714    */
 715   if (PREDICT_FALSE (h->instantiated == 0))
 716     {
 717       if (is_add == 0)
 718         return (-1);
 719
 720       BV (clib_bihash_alloc_lock) (h);
 721       if (h->instantiated == 0)
 722         BV (clib_bihash_instantiate) (h);
 723       BV (clib_bihash_alloc_unlock) (h);
 724     }
 725 #else
 726   /* Debug image: make sure the table has been instantiated */
 727   ASSERT (h->instantiated != 0);
 728 #endif
 729
 730   /*
 731    * Debug image: make sure that an item being added doesn't accidentally
 732    * look like a free item.
 733    */
 734   ASSERT ((is_add && BV (clib_bihash_is_free) (add_v)) == 0);
 735
 736   b = BV (clib_bihash_get_bucket) (h, hash);
 737
 738   BV (clib_bihash_lock_bucket) (b);
 739
 740   /* First elt in the bucket? */
 741   if (BIHASH_KVP_AT_BUCKET_LEVEL == 0 && BV (clib_bihash_bucket_is_empty) (b))
 742     {
 743       if (is_add == 0)
 744         {
 745           BV (clib_bihash_unlock_bucket) (b);
 746           return (-1);
 747         }
 748
 749       BV (clib_bihash_alloc_lock) (h);
 750       v = BV (value_alloc) (h, 0);
 751       BV (clib_bihash_alloc_unlock) (h);
 752
 753       *v->kvp = *add_v;
 754       tmp_b.as_u64 = 0;         /* clears bucket lock */
 755       tmp_b.offset = BV (clib_bihash_get_offset) (h, v);
 756       tmp_b.refcnt = 1;
 757       CLIB_MEMORY_STORE_BARRIER ();
 758
 759       b->as_u64 = tmp_b.as_u64; /* unlocks the bucket */
 760       BV (clib_bihash_increment_stat) (h, BIHASH_STAT_alloc_add, 1);
 761
 762       return (0);
 763     }
 764
 765   /* WARNING: we're still looking at the live copy... */
 766   limit = BIHASH_KVP_PER_PAGE;
 767   v = BV (clib_bihash_get_value) (h, b->offset);
 768
 769   if (PREDICT_FALSE (b->as_u64 & mask.as_u64))
 770     {
 771       if (PREDICT_FALSE (b->linear_search))
 772         limit <<= b->log2_pages;
 773       else
 774         v += extract_bits (hash, h->log2_nbuckets, b->log2_pages);
 775     }
 776
 777   if (is_add)
 778     {
 779       /*
 780        * Because reader threads are looking at live data,
 781        * we have to be extra careful. Readers do NOT hold the
 782        * bucket lock. We need to be SLOWER than a search, past the
 783        * point where readers CHECK the bucket lock.
 784        */
 785
 786       /*
 787        * For obvious (in hindsight) reasons, see if we're supposed to
 788        * replace an existing key, then look for an empty slot.
 789        */
 790       for (i = 0; i < limit; i++)
 791         {
 792           if (BV (clib_bihash_is_free) (&(v->kvp[i])))
 793             continue;
 794           if (BV (clib_bihash_key_compare) (v->kvp[i].key, add_v->key))
 795             {
 796               /* Add but do not overwrite? */
 797               if (is_add == 2)
 798                 {
 799                   BV (clib_bihash_unlock_bucket) (b);
 800                   return (-2);
 801                 }
 802               if (overwrite_cb)
 803                 overwrite_cb (&(v->kvp[i]), overwrite_arg);
 804               clib_memcpy_fast (&(v->kvp[i].value),
 805                                 &add_v->value, sizeof (add_v->value));
 806               BV (clib_bihash_unlock_bucket) (b);
 807               BV (clib_bihash_increment_stat) (h, BIHASH_STAT_replace, 1);
 808               return (0);
 809             }
 810         }
 811       /*
 812        * Look for an empty slot. If found, use it
 813        */
 814       for (i = 0; i < limit; i++)
 815         {
 816           if (BV (clib_bihash_is_free) (&(v->kvp[i])))
 817             {
 818               /*
 819                * Copy the value first, so that if a reader manages
 820                * to match the new key, the value will be right...
 821                */
 822               clib_memcpy_fast (&(v->kvp[i].value),
 823                                 &add_v->value, sizeof (add_v->value));
 824               CLIB_MEMORY_STORE_BARRIER ();     /* Make sure the value has settled */
 825               clib_memcpy_fast (&(v->kvp[i]), &add_v->key,
 826                                 sizeof (add_v->key));
 827               b->refcnt++;
 828               ASSERT (b->refcnt > 0);
 829               BV (clib_bihash_unlock_bucket) (b);
 830               BV (clib_bihash_increment_stat) (h, BIHASH_STAT_add, 1);
 831               return (0);
 832             }
 833         }
 834       /* look for stale data to overwrite */
 835       if (is_stale_cb)
 836         {
 837           for (i = 0; i < limit; i++)
 838             {
 839               if (is_stale_cb (&(v->kvp[i]), is_stale_arg))
 840                 {
 841                   clib_memcpy_fast (&(v->kvp[i]), add_v, sizeof (*add_v));
 842                   CLIB_MEMORY_STORE_BARRIER ();
 843                   BV (clib_bihash_unlock_bucket) (b);
 844                   BV (clib_bihash_increment_stat) (h, BIHASH_STAT_replace, 1);
 845                   return (0);
 846                 }
 847             }
 848         }
 849       /* Out of space in this bucket, split the bucket... */
 850     }
 851   else                          /* delete case */
 852     {
 853       for (i = 0; i < limit; i++)
 854         {
 855           /* no sense even looking at this one */
 856           if (BV (clib_bihash_is_free) (&(v->kvp[i])))
 857             continue;
 858           /* Found the key? Kill it... */
 859           if (BV (clib_bihash_key_compare) (v->kvp[i].key, add_v->key))
 860             {
 861               BV (clib_bihash_mark_free) (&(v->kvp[i]));
 862               /* Is the bucket empty? */
 863               if (PREDICT_TRUE (b->refcnt > 1))
 864                 {
 865                   b->refcnt--;
 866                   /* Switch back to the bucket-level kvp array? */
 867                   if (BIHASH_KVP_AT_BUCKET_LEVEL && b->refcnt == 1
 868                       && b->log2_pages > 0)
 869                     {
 870                       tmp_b.as_u64 = b->as_u64;
 871                       b->offset = BV (clib_bihash_get_offset)
 872                         (h, (void *) (b + 1));
 873                       b->linear_search = 0;
 874                       b->log2_pages = 0;
 875                       /* Clean up the bucket-level kvp array */
 876                       BVT (clib_bihash_kv) *v = (void *) (b + 1);
 877                       int j;
 878                       for (j = 0; j < BIHASH_KVP_PER_PAGE; j++)
 879                         {
 880                           BV (clib_bihash_mark_free) (v);
 881                           v++;
 882                         }
 883                       CLIB_MEMORY_STORE_BARRIER ();
 884                       BV (clib_bihash_unlock_bucket) (b);
 885                       BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del, 1);
 886                       goto free_backing_store;
 887                     }
 888
 889                   CLIB_MEMORY_STORE_BARRIER ();
 890                   BV (clib_bihash_unlock_bucket) (b);
 891                   BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del, 1);
 892                   return (0);
 893                 }
 894               else              /* yes, free it */
 895                 {
 896                   /* Save old bucket value, need log2_pages to free it */
 897                   tmp_b.as_u64 = b->as_u64;
 898
 899                   /* Kill and unlock the bucket */
 900                   b->as_u64 = 0;
 901
 902                 free_backing_store:
 903                   /* And free the backing storage */
 904                   BV (clib_bihash_alloc_lock) (h);
 905                   /* Note: v currently points into the middle of the bucket */
 906                   v = BV (clib_bihash_get_value) (h, tmp_b.offset);
 907                   BV (value_free) (h, v, tmp_b.log2_pages);
 908                   BV (clib_bihash_alloc_unlock) (h);
 909                   BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del_free,
 910                                                    1);
 911                   return (0);
 912                 }
 913             }
 914         }
 915       /* Not found... */
 916       BV (clib_bihash_unlock_bucket) (b);
 917       return (-3);
 918     }
 919
 920   /* Move readers to a (locked) temp copy of the bucket */
 921   BV (clib_bihash_alloc_lock) (h);
 922   BV (make_working_copy) (h, b);
 923
 924   v = BV (clib_bihash_get_value) (h, h->saved_bucket.offset);
 925
 926   old_log2_pages = h->saved_bucket.log2_pages;
 927   new_log2_pages = old_log2_pages + 1;
 928   mark_bucket_linear = 0;
 929   BV (clib_bihash_increment_stat) (h, BIHASH_STAT_split_add, 1);
 930   BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits, old_log2_pages);
 931
 932   working_copy = h->working_copies[thread_index];
 933   resplit_once = 0;
 934   BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits, 1);
 935
 936   new_v = BV (split_and_rehash) (h, working_copy, old_log2_pages,
 937                                  new_log2_pages);
 938   if (new_v == 0)
 939     {
 940     try_resplit:
 941       resplit_once = 1;
 942       new_log2_pages++;
 943       /* Try re-splitting. If that fails, fall back to linear search */
 944       new_v = BV (split_and_rehash) (h, working_copy, old_log2_pages,
 945                                      new_log2_pages);
 946       if (new_v == 0)
 947         {
 948         mark_linear:
 949           new_log2_pages--;
 950           /* pinned collisions, use linear search */
 951           new_v =
 952             BV (split_and_rehash_linear) (h, working_copy, old_log2_pages,
 953                                           new_log2_pages);
 954           mark_bucket_linear = 1;
 955           BV (clib_bihash_increment_stat) (h, BIHASH_STAT_linear, 1);
 956         }
 957       BV (clib_bihash_increment_stat) (h, BIHASH_STAT_resplit, 1);
 958       BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits,
 959                                        old_log2_pages + 1);
 960     }
 961
 962   /* Try to add the new entry */
 963   save_new_v = new_v;
 964   new_hash = BV (clib_bihash_hash) (add_v);
 965   limit = BIHASH_KVP_PER_PAGE;
 966   if (mark_bucket_linear)
 967     limit <<= new_log2_pages;
 968   else
 969     new_v += extract_bits (new_hash, h->log2_nbuckets, new_log2_pages);
 970
 971   for (i = 0; i < limit; i++)
 972     {
 973       if (BV (clib_bihash_is_free) (&(new_v->kvp[i])))
 974         {
 975           clib_memcpy_fast (&(new_v->kvp[i]), add_v, sizeof (*add_v));
 976           goto expand_ok;
 977         }
 978     }
 979
 980   /* Crap. Try again */
 981   BV (value_free) (h, save_new_v, new_log2_pages);
 982   /*
 983    * If we've already doubled the size of the bucket once,
 984    * fall back to linear search now.
 985    */
 986   if (resplit_once)
 987     goto mark_linear;
 988   else
 989     goto try_resplit;
 990
 991 expand_ok:
 992   tmp_b.log2_pages = new_log2_pages;
 993   tmp_b.offset = BV (clib_bihash_get_offset) (h, save_new_v);
 994   tmp_b.linear_search = mark_bucket_linear;
 995 #if BIHASH_KVP_AT_BUCKET_LEVEL
 996   /* Compensate for permanent refcount bump at the bucket level */
 997   if (new_log2_pages > 0)
 998 #endif
 999     tmp_b.refcnt = h->saved_bucket.refcnt + 1;
1000   ASSERT (tmp_b.refcnt > 0);
1001   tmp_b.lock = 0;
1002   CLIB_MEMORY_STORE_BARRIER ();
1003   b->as_u64 = tmp_b.as_u64;
1004
1005 #if BIHASH_KVP_AT_BUCKET_LEVEL
1006   if (h->saved_bucket.log2_pages > 0)
1007     {
1008 #endif
1009
1010       /* free the old bucket, except at the bucket level if so configured */
1011       v = BV (clib_bihash_get_value) (h, h->saved_bucket.offset);
1012       BV (value_free) (h, v, h->saved_bucket.log2_pages);
1013
1014 #if BIHASH_KVP_AT_BUCKET_LEVEL
1015     }
1016 #endif
1017
1018
1019   BV (clib_bihash_alloc_unlock) (h);
1020   return (0);
1021 }
1022
1023 static_always_inline int BV (clib_bihash_add_del_inline)
1024   (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add,
1025    int (*is_stale_cb) (BVT (clib_bihash_kv) *, void *), void *arg)
1026 {
1027   u64 hash = BV (clib_bihash_hash) (add_v);
1028   return BV (clib_bihash_add_del_inline_with_hash) (h, add_v, hash, is_add,
1029                                                     is_stale_cb, arg, 0, 0);
1030 }
1031
1032 int BV (clib_bihash_add_del_with_hash) (BVT (clib_bihash) * h,
1033                                         BVT (clib_bihash_kv) * add_v, u64 hash,
1034                                         int is_add)
1035 {
1036   return BV (clib_bihash_add_del_inline_with_hash) (h, add_v, hash, is_add, 0,
1037                                                     0, 0, 0);
1038 }
1039
1040 int BV (clib_bihash_add_del)
1041   (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add)
1042 {
1043   return BV (clib_bihash_add_del_inline) (h, add_v, is_add, 0, 0);
1044 }
1045
1046 int BV (clib_bihash_add_or_overwrite_stale)
1047   (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v,
1048    int (*stale_callback) (BVT (clib_bihash_kv) *, void *), void *arg)
1049 {
1050   return BV (clib_bihash_add_del_inline) (h, add_v, 1, stale_callback, arg);
1051 }
1052
1053 int BV (clib_bihash_add_with_overwrite_cb) (
1054   BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v,
1055   void (overwrite_cb) (BVT (clib_bihash_kv) *, void *), void *arg)
1056 {
1057   u64 hash = BV (clib_bihash_hash) (add_v);
1058   return BV (clib_bihash_add_del_inline_with_hash) (h, add_v, hash, 1, 0, 0,
1059                                                     overwrite_cb, arg);
1060 }
1061
1062 int BV (clib_bihash_search)
1063   (BVT (clib_bihash) * h,
1064    BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
1065 {
1066   return BV (clib_bihash_search_inline_2) (h, search_key, valuep);
1067 }
1068
1069 u8 *BV (format_bihash) (u8 * s, va_list * args)
1070 {
1071   BVT (clib_bihash) * h = va_arg (*args, BVT (clib_bihash) *);
1072   int verbose = va_arg (*args, int);
1073   BVT (clib_bihash_bucket) * b;
1074   BVT (clib_bihash_value) * v;
1075   int i, j, k;
1076   u64 active_elements = 0;
1077   u64 active_buckets = 0;
1078   u64 linear_buckets = 0;
1079
1080   s = format (s, "Hash table '%s'\n", h->name ? h->name : (u8 *) "(unnamed)");
1081
1082 #if BIHASH_LAZY_INSTANTIATE
1083   if (PREDICT_FALSE (h->instantiated == 0))
1084     return format (s, "    empty, uninitialized");
1085 #endif
1086
1087   for (i = 0; i < h->nbuckets; i++)
1088     {
1089       b = BV (clib_bihash_get_bucket) (h, i);
1090       if (BV (clib_bihash_bucket_is_empty) (b))
1091         {
1092           if (verbose > 1)
1093             s = format (s, "[%d]: empty\n", i);
1094           continue;
1095         }
1096
1097       active_buckets++;
1098
1099       if (b->linear_search)
1100         linear_buckets++;
1101
1102       if (verbose)
1103         {
1104           s = format
1105             (s, "[%d]: heap offset %lld, len %d, refcnt %d, linear %d\n", i,
1106              b->offset, (1 << b->log2_pages), b->refcnt, b->linear_search);
1107         }
1108
1109       v = BV (clib_bihash_get_value) (h, b->offset);
1110       for (j = 0; j < (1 << b->log2_pages); j++)
1111         {
1112           for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1113             {
1114               if (BV (clib_bihash_is_free) (&v->kvp[k]))
1115                 {
1116                   if (verbose > 1)
1117                     s = format (s, "    %d: empty\n",
1118                                 j * BIHASH_KVP_PER_PAGE + k);
1119                   continue;
1120                 }
1121               if (verbose)
1122                 {
1123                   if (h->kvp_fmt_fn)
1124                     {
1125                       s = format (s, "    %d: %U\n",
1126                                   j * BIHASH_KVP_PER_PAGE + k,
1127                                   h->kvp_fmt_fn, &(v->kvp[k]), verbose);
1128                     }
1129                   else
1130                     {
1131                       s = format (s, "    %d: %U\n",
1132                                   j * BIHASH_KVP_PER_PAGE + k,
1133                                   BV (format_bihash_kvp), &(v->kvp[k]));
1134                     }
1135                 }
1136               active_elements++;
1137             }
1138           v++;
1139         }
1140     }
1141
1142   s = format (s, "    %lld active elements %lld active buckets\n",
1143               active_elements, active_buckets);
1144   s = format (s, "    %d free lists\n", vec_len (h->freelists));
1145
1146   for (i = 0; i < vec_len (h->freelists); i++)
1147     {
1148       u32 nfree = 0;
1149       BVT (clib_bihash_value) * free_elt;
1150       u64 free_elt_as_u64 = h->freelists[i];
1151
1152       while (free_elt_as_u64)
1153         {
1154           free_elt = BV (clib_bihash_get_value) (h, free_elt_as_u64);
1155           nfree++;
1156           free_elt_as_u64 = free_elt->next_free_as_u64;
1157         }
1158
1159       if (nfree || verbose)
1160         s = format (s, "       [len %d] %u free elts\n", 1 << i, nfree);
1161     }
1162
1163   s = format (s, "    %lld linear search buckets\n", linear_buckets);
1164   if (BIHASH_USE_HEAP)
1165     {
1166       BVT (clib_bihash_alloc_chunk) * c = h->chunks;
1167       uword bytes_left = 0, total_size = 0, n_chunks = 0;
1168
1169       while (c)
1170         {
1171           bytes_left += c->bytes_left;
1172           total_size += c->size;
1173           n_chunks += 1;
1174           c = c->next;
1175         }
1176       s = format (s,
1177                   "    heap: %u chunk(s) allocated\n"
1178                   "          bytes: used %U, scrap %U\n", n_chunks,
1179                   format_memory_size, total_size,
1180                   format_memory_size, bytes_left);
1181     }
1182   else
1183     {
1184       u64 used_bytes = alloc_arena_next (h);
1185       s = format (s,
1186                   "    arena: base %llx, next %llx\n"
1187                   "           used %lld b (%lld Mbytes) of %lld b (%lld Mbytes)\n",
1188                   alloc_arena (h), alloc_arena_next (h),
1189                   used_bytes, used_bytes >> 20,
1190                   alloc_arena_size (h), alloc_arena_size (h) >> 20);
1191     }
1192   return s;
1193 }
1194
1195 void BV (clib_bihash_foreach_key_value_pair)
1196   (BVT (clib_bihash) * h,
1197    BV (clib_bihash_foreach_key_value_pair_cb) cb, void *arg)
1198 {
1199   int i, j, k;
1200   BVT (clib_bihash_bucket) * b;
1201   BVT (clib_bihash_value) * v;
1202
1203
1204 #if BIHASH_LAZY_INSTANTIATE
1205   if (PREDICT_FALSE (h->instantiated == 0))
1206     return;
1207 #endif
1208
1209   for (i = 0; i < h->nbuckets; i++)
1210     {
1211       b = BV (clib_bihash_get_bucket) (h, i);
1212       if (BV (clib_bihash_bucket_is_empty) (b))
1213         continue;
1214
1215       v = BV (clib_bihash_get_value) (h, b->offset);
1216       for (j = 0; j < (1 << b->log2_pages); j++)
1217         {
1218           for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1219             {
1220               if (BV (clib_bihash_is_free) (&v->kvp[k]))
1221                 continue;
1222
1223               if (BIHASH_WALK_STOP == cb (&v->kvp[k], arg))
1224                 return;
1225               /*
1226                * In case the callback deletes the last entry in the bucket...
1227                */
1228               if (BV (clib_bihash_bucket_is_empty) (b))
1229                 goto doublebreak;
1230             }
1231           v++;
1232         }
1233     doublebreak:
1234       ;
1235     }
1236 }
1237
1238 /** @endcond */
1239
1240 /*
1241  * fd.io coding-style-patch-verification: ON
1242  *
1243  * Local Variables:
1244  * eval: (c-set-style "gnu")
1245  * End:
1246  */