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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 /** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */
18 static inline void *BV (alloc_aligned) (BVT (clib_bihash) * h, uword nbytes)
22 /* Round to an even number of cache lines */
23 nbytes += CLIB_CACHE_LINE_BYTES - 1;
24 nbytes &= ~(CLIB_CACHE_LINE_BYTES - 1);
26 rv = alloc_arena_next (h);
27 alloc_arena_next (h) += nbytes;
29 if (alloc_arena_next (h) > alloc_arena_size (h))
32 return (void *) (uword) (rv + alloc_arena (h));
35 static void BV (clib_bihash_instantiate) (BVT (clib_bihash) * h)
39 alloc_arena (h) = (uword) clib_mem_vm_alloc (h->memory_size);
40 alloc_arena_next (h) = 0;
41 alloc_arena_size (h) = h->memory_size;
43 bucket_size = h->nbuckets * sizeof (h->buckets[0]);
44 h->buckets = BV (alloc_aligned) (h, bucket_size);
45 CLIB_MEMORY_BARRIER ();
49 void BV (clib_bihash_init2) (BVT (clib_bihash_init2_args) * a)
53 BVT (clib_bihash) * h = a->h;
55 a->nbuckets = 1 << (max_log2 (a->nbuckets));
57 h->name = (u8 *) a->name;
58 h->nbuckets = a->nbuckets;
59 h->log2_nbuckets = max_log2 (a->nbuckets);
60 h->memory_size = a->memory_size;
62 h->fmt_fn = a->fmt_fn;
67 * Make sure the requested size is rational. The max table
68 * size without playing the alignment card is 64 Gbytes.
69 * If someone starts complaining that's not enough, we can shift
70 * the offset by CLIB_LOG2_CACHE_LINE_BYTES...
72 ASSERT (h->memory_size < (1ULL << BIHASH_BUCKET_OFFSET_BITS));
74 /* Add this hash table to the list */
75 if (a->dont_add_to_all_bihash_list == 0)
77 for (i = 0; i < vec_len (clib_all_bihashes); i++)
78 if (clib_all_bihashes[i] == h)
80 oldheap = clib_all_bihash_set_heap ();
81 vec_add1 (clib_all_bihashes, (void *) h);
82 clib_mem_set_heap (oldheap);
87 clib_mem_free ((void *) h->alloc_lock);
90 * Set up the lock now, so we can use it to make the first add
93 h->alloc_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
94 CLIB_CACHE_LINE_BYTES);
97 if (a->instantiate_immediately)
98 BV (clib_bihash_instantiate) (h);
101 void BV (clib_bihash_init)
102 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size)
104 BVT (clib_bihash_init2_args) _a, *a = &_a;
106 memset (a, 0, sizeof (*a));
110 a->nbuckets = nbuckets;
111 a->memory_size = memory_size;
113 BV (clib_bihash_init2) (a);
117 #if !defined (MFD_ALLOW_SEALING)
118 #define MFD_ALLOW_SEALING 0x0002U
121 void BV (clib_bihash_master_init_svm)
122 (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size)
126 vec_header_t *freelist_vh;
129 ASSERT (memory_size < (1ULL << 32));
130 /* Set up for memfd sharing */
131 if ((fd = memfd_create (name, MFD_ALLOW_SEALING)) == -1)
133 clib_unix_warning ("memfd_create");
137 if (ftruncate (fd, memory_size) < 0)
139 clib_unix_warning ("ftruncate");
143 /* Not mission-critical, complain and continue */
144 if ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
145 clib_unix_warning ("fcntl (F_ADD_SEALS)");
147 mmap_addr = mmap (0, memory_size,
148 PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 /* offset */ );
150 if (mmap_addr == MAP_FAILED)
152 clib_unix_warning ("mmap failed");
156 h->sh = (void *) mmap_addr;
158 nbuckets = 1 << (max_log2 (nbuckets));
160 h->name = (u8 *) name;
161 h->sh->nbuckets = h->nbuckets = nbuckets;
162 h->log2_nbuckets = max_log2 (nbuckets);
164 alloc_arena (h) = (u64) (uword) mmap_addr;
165 alloc_arena_next (h) = CLIB_CACHE_LINE_BYTES;
166 alloc_arena_size (h) = memory_size;
168 bucket_size = nbuckets * sizeof (h->buckets[0]);
169 h->buckets = BV (alloc_aligned) (h, bucket_size);
170 h->sh->buckets_as_u64 = (u64) BV (clib_bihash_get_offset) (h, h->buckets);
172 h->alloc_lock = BV (alloc_aligned) (h, CLIB_CACHE_LINE_BYTES);
173 h->alloc_lock[0] = 0;
175 h->sh->alloc_lock_as_u64 =
176 (u64) BV (clib_bihash_get_offset) (h, (void *) h->alloc_lock);
178 BV (alloc_aligned) (h,
179 sizeof (vec_header_t) +
180 BIHASH_FREELIST_LENGTH * sizeof (u64));
181 freelist_vh->len = BIHASH_FREELIST_LENGTH;
182 freelist_vh->dlmalloc_header_offset = 0xDEADBEEF;
183 h->sh->freelists_as_u64 =
184 (u64) BV (clib_bihash_get_offset) (h, freelist_vh->vector_data);
185 h->freelists = (void *) (freelist_vh->vector_data);
191 void BV (clib_bihash_slave_init_svm)
192 (BVT (clib_bihash) * h, char *name, int fd)
196 BVT (clib_bihash_shared_header) * sh;
198 /* Trial mapping, to learn the segment size */
199 mmap_addr = mmap (0, 4096, PROT_READ, MAP_SHARED, fd, 0 /* offset */ );
200 if (mmap_addr == MAP_FAILED)
202 clib_unix_warning ("trial mmap failed");
206 sh = (BVT (clib_bihash_shared_header) *) mmap_addr;
208 memory_size = sh->alloc_arena_size;
210 munmap (mmap_addr, 4096);
212 /* Actual mapping, at the required size */
213 mmap_addr = mmap (0, memory_size,
214 PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 /* offset */ );
216 if (mmap_addr == MAP_FAILED)
218 clib_unix_warning ("mmap failed");
224 h->sh = (void *) mmap_addr;
225 alloc_arena (h) = (u64) (uword) mmap_addr;
228 h->name = (u8 *) name;
229 h->buckets = BV (clib_bihash_get_value) (h, h->sh->buckets_as_u64);
230 h->nbuckets = h->sh->nbuckets;
231 h->log2_nbuckets = max_log2 (h->nbuckets);
233 h->alloc_lock = BV (clib_bihash_get_value) (h, h->sh->alloc_lock_as_u64);
234 h->freelists = BV (clib_bihash_get_value) (h, h->sh->freelists_as_u64);
237 #endif /* BIHASH_32_64_SVM */
239 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
240 format_function_t * fmt_fn)
245 void BV (clib_bihash_free) (BVT (clib_bihash) * h)
249 if (PREDICT_FALSE (h->instantiated == 0))
250 goto never_initialized;
253 vec_free (h->working_copies);
254 vec_free (h->working_copy_lengths);
255 #if BIHASH_32_64_SVM == 0
256 vec_free (h->freelists);
259 (void) close (h->memfd);
261 clib_mem_vm_free ((void *) (uword) (alloc_arena (h)), alloc_arena_size (h));
263 clib_memset (h, 0, sizeof (*h));
264 for (i = 0; i < vec_len (clib_all_bihashes); i++)
266 if ((void *) h == clib_all_bihashes[i])
268 vec_delete (clib_all_bihashes, 1, i);
272 clib_warning ("Couldn't find hash table %llx on clib_all_bihashes...",
277 BVT (clib_bihash_value) *
278 BV (value_alloc) (BVT (clib_bihash) * h, u32 log2_pages)
280 BVT (clib_bihash_value) * rv = 0;
282 ASSERT (h->alloc_lock[0]);
285 ASSERT (log2_pages < vec_len (h->freelists));
288 if (log2_pages >= vec_len (h->freelists) || h->freelists[log2_pages] == 0)
290 vec_validate_init_empty (h->freelists, log2_pages, 0);
291 rv = BV (alloc_aligned) (h, (sizeof (*rv) * (1 << log2_pages)));
294 rv = BV (clib_bihash_get_value) (h, (uword) h->freelists[log2_pages]);
295 h->freelists[log2_pages] = rv->next_free_as_u64;
300 * Latest gcc complains that the length arg is zero
301 * if we replace (1<<log2_pages) with vec_len(rv).
304 clib_memset (rv, 0xff, sizeof (*rv) * (1 << log2_pages));
309 BV (value_free) (BVT (clib_bihash) * h, BVT (clib_bihash_value) * v,
312 ASSERT (h->alloc_lock[0]);
314 ASSERT (vec_len (h->freelists) > log2_pages);
317 clib_memset (v, 0xFE, sizeof (*v) * (1 << log2_pages));
319 v->next_free_as_u64 = (u64) h->freelists[log2_pages];
320 h->freelists[log2_pages] = (u64) BV (clib_bihash_get_offset) (h, v);
324 BV (make_working_copy) (BVT (clib_bihash) * h, BVT (clib_bihash_bucket) * b)
326 BVT (clib_bihash_value) * v;
327 BVT (clib_bihash_bucket) working_bucket __attribute__ ((aligned (8)));
328 BVT (clib_bihash_value) * working_copy;
329 u32 thread_index = os_get_thread_index ();
330 int log2_working_copy_length;
332 ASSERT (h->alloc_lock[0]);
334 if (thread_index >= vec_len (h->working_copies))
336 vec_validate (h->working_copies, thread_index);
337 vec_validate_init_empty (h->working_copy_lengths, thread_index, ~0);
341 * working_copies are per-cpu so that near-simultaneous
342 * updates from multiple threads will not result in sporadic, spurious
345 working_copy = h->working_copies[thread_index];
346 log2_working_copy_length = h->working_copy_lengths[thread_index];
348 h->saved_bucket.as_u64 = b->as_u64;
350 if (b->log2_pages > log2_working_copy_length)
353 * It's not worth the bookkeeping to free working copies
355 * clib_mem_free (working_copy);
357 working_copy = BV (alloc_aligned)
358 (h, sizeof (working_copy[0]) * (1 << b->log2_pages));
359 h->working_copy_lengths[thread_index] = b->log2_pages;
360 h->working_copies[thread_index] = working_copy;
362 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_working_copy_lost,
363 1ULL << b->log2_pages);
366 v = BV (clib_bihash_get_value) (h, b->offset);
368 clib_memcpy_fast (working_copy, v, sizeof (*v) * (1 << b->log2_pages));
369 working_bucket.as_u64 = b->as_u64;
370 working_bucket.offset = BV (clib_bihash_get_offset) (h, working_copy);
371 CLIB_MEMORY_BARRIER ();
372 b->as_u64 = working_bucket.as_u64;
373 h->working_copies[thread_index] = working_copy;
377 BVT (clib_bihash_value) *
378 BV (split_and_rehash)
379 (BVT (clib_bihash) * h,
380 BVT (clib_bihash_value) * old_values, u32 old_log2_pages,
383 BVT (clib_bihash_value) * new_values, *new_v;
384 int i, j, length_in_kvs;
386 ASSERT (h->alloc_lock[0]);
388 new_values = BV (value_alloc) (h, new_log2_pages);
389 length_in_kvs = (1 << old_log2_pages) * BIHASH_KVP_PER_PAGE;
391 for (i = 0; i < length_in_kvs; i++)
395 /* Entry not in use? Forget it */
396 if (BV (clib_bihash_is_free) (&(old_values->kvp[i])))
399 /* rehash the item onto its new home-page */
400 new_hash = BV (clib_bihash_hash) (&(old_values->kvp[i]));
401 new_hash >>= h->log2_nbuckets;
402 new_hash &= (1 << new_log2_pages) - 1;
403 new_v = &new_values[new_hash];
405 /* Across the new home-page */
406 for (j = 0; j < BIHASH_KVP_PER_PAGE; j++)
409 if (BV (clib_bihash_is_free) (&(new_v->kvp[j])))
411 clib_memcpy_fast (&(new_v->kvp[j]), &(old_values->kvp[i]),
412 sizeof (new_v->kvp[j]));
416 /* Crap. Tell caller to try again */
417 BV (value_free) (h, new_values, new_log2_pages);
426 BVT (clib_bihash_value) *
427 BV (split_and_rehash_linear)
428 (BVT (clib_bihash) * h,
429 BVT (clib_bihash_value) * old_values, u32 old_log2_pages,
432 BVT (clib_bihash_value) * new_values;
433 int i, j, new_length, old_length;
435 ASSERT (h->alloc_lock[0]);
437 new_values = BV (value_alloc) (h, new_log2_pages);
438 new_length = (1 << new_log2_pages) * BIHASH_KVP_PER_PAGE;
439 old_length = (1 << old_log2_pages) * BIHASH_KVP_PER_PAGE;
442 /* Across the old value array */
443 for (i = 0; i < old_length; i++)
445 /* Find a free slot in the new linear scan bucket */
446 for (; j < new_length; j++)
448 /* Old value not in use? Forget it. */
449 if (BV (clib_bihash_is_free) (&(old_values->kvp[i])))
452 /* New value should never be in use */
453 if (BV (clib_bihash_is_free) (&(new_values->kvp[j])))
455 /* Copy the old value and move along */
456 clib_memcpy_fast (&(new_values->kvp[j]), &(old_values->kvp[i]),
457 sizeof (new_values->kvp[j]));
462 /* This should never happen... */
463 clib_warning ("BUG: linear rehash failed!");
464 BV (value_free) (h, new_values, new_log2_pages);
472 static inline int BV (clib_bihash_add_del_inline)
473 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add,
474 int (*is_stale_cb) (BVT (clib_bihash_kv) *, void *), void *arg)
477 BVT (clib_bihash_bucket) * b, tmp_b;
478 BVT (clib_bihash_value) * v, *new_v, *save_new_v, *working_copy;
481 u32 new_log2_pages, old_log2_pages;
482 u32 thread_index = os_get_thread_index ();
483 int mark_bucket_linear;
487 * Create the table (is_add=1,2), or flunk the request now (is_add=0)
488 * Use the alloc_lock to protect the instantiate operation.
490 if (PREDICT_FALSE (h->instantiated == 0))
495 BV (clib_bihash_alloc_lock) (h);
496 if (h->instantiated == 0)
497 BV (clib_bihash_instantiate) (h);
498 BV (clib_bihash_alloc_unlock) (h);
501 hash = BV (clib_bihash_hash) (add_v);
503 bucket_index = hash & (h->nbuckets - 1);
504 b = &h->buckets[bucket_index];
506 hash >>= h->log2_nbuckets;
508 BV (clib_bihash_lock_bucket) (b);
510 /* First elt in the bucket? */
511 if (BV (clib_bihash_bucket_is_empty) (b))
515 BV (clib_bihash_unlock_bucket) (b);
519 BV (clib_bihash_alloc_lock) (h);
520 v = BV (value_alloc) (h, 0);
521 BV (clib_bihash_alloc_unlock) (h);
524 tmp_b.as_u64 = 0; /* clears bucket lock */
525 tmp_b.offset = BV (clib_bihash_get_offset) (h, v);
527 CLIB_MEMORY_BARRIER ();
529 b->as_u64 = tmp_b.as_u64; /* unlocks the bucket */
530 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_alloc_add, 1);
535 /* WARNING: we're still looking at the live copy... */
536 limit = BIHASH_KVP_PER_PAGE;
537 v = BV (clib_bihash_get_value) (h, b->offset);
539 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
540 if (b->linear_search)
541 limit <<= b->log2_pages;
546 * Because reader threads are looking at live data,
547 * we have to be extra careful. Readers do NOT hold the
548 * bucket lock. We need to be SLOWER than a search, past the
549 * point where readers CHECK the bucket lock.
553 * For obvious (in hindsight) reasons, see if we're supposed to
554 * replace an existing key, then look for an empty slot.
556 for (i = 0; i < limit; i++)
558 if (BV (clib_bihash_key_compare) (v->kvp[i].key, add_v->key))
560 /* Add but do not overwrite? */
563 BV (clib_bihash_unlock_bucket) (b);
567 CLIB_MEMORY_BARRIER (); /* Add a delay */
568 clib_memcpy_fast (&(v->kvp[i]), add_v, sizeof (*add_v));
569 BV (clib_bihash_unlock_bucket) (b);
570 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_replace, 1);
575 * Look for an empty slot. If found, use it
577 for (i = 0; i < limit; i++)
579 if (BV (clib_bihash_is_free) (&(v->kvp[i])))
582 * Copy the value first, so that if a reader manages
583 * to match the new key, the value will be right...
585 clib_memcpy_fast (&(v->kvp[i].value),
586 &add_v->value, sizeof (add_v->value));
587 CLIB_MEMORY_BARRIER (); /* Make sure the value has settled */
588 clib_memcpy_fast (&(v->kvp[i]), &add_v->key,
589 sizeof (add_v->key));
591 ASSERT (b->refcnt > 0);
592 BV (clib_bihash_unlock_bucket) (b);
593 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_add, 1);
597 /* look for stale data to overwrite */
600 for (i = 0; i < limit; i++)
602 if (is_stale_cb (&(v->kvp[i]), arg))
604 CLIB_MEMORY_BARRIER ();
605 clib_memcpy_fast (&(v->kvp[i]), add_v, sizeof (*add_v));
606 BV (clib_bihash_unlock_bucket) (b);
607 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_replace, 1);
612 /* Out of space in this bucket, split the bucket... */
614 else /* delete case */
616 for (i = 0; i < limit; i++)
618 /* Found the key? Kill it... */
619 if (BV (clib_bihash_key_compare) (v->kvp[i].key, add_v->key))
621 clib_memset (&(v->kvp[i]), 0xff, sizeof (*(add_v)));
622 /* Is the bucket empty? */
623 if (PREDICT_TRUE (b->refcnt > 1))
626 BV (clib_bihash_unlock_bucket) (b);
627 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del, 1);
630 else /* yes, free it */
632 /* Save old bucket value, need log2_pages to free it */
633 tmp_b.as_u64 = b->as_u64;
634 CLIB_MEMORY_BARRIER ();
636 /* Kill and unlock the bucket */
639 /* And free the backing storage */
640 BV (clib_bihash_alloc_lock) (h);
641 /* Note: v currently points into the middle of the bucket */
642 v = BV (clib_bihash_get_value) (h, tmp_b.offset);
643 BV (value_free) (h, v, tmp_b.log2_pages);
644 BV (clib_bihash_alloc_unlock) (h);
645 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del_free,
652 BV (clib_bihash_unlock_bucket) (b);
656 /* Move readers to a (locked) temp copy of the bucket */
657 BV (clib_bihash_alloc_lock) (h);
658 BV (make_working_copy) (h, b);
660 v = BV (clib_bihash_get_value) (h, h->saved_bucket.offset);
662 old_log2_pages = h->saved_bucket.log2_pages;
663 new_log2_pages = old_log2_pages + 1;
664 mark_bucket_linear = 0;
665 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_split_add, 1);
666 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits, old_log2_pages);
668 working_copy = h->working_copies[thread_index];
670 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits, 1);
672 new_v = BV (split_and_rehash) (h, working_copy, old_log2_pages,
679 /* Try re-splitting. If that fails, fall back to linear search */
680 new_v = BV (split_and_rehash) (h, working_copy, old_log2_pages,
686 /* pinned collisions, use linear search */
688 BV (split_and_rehash_linear) (h, working_copy, old_log2_pages,
690 mark_bucket_linear = 1;
691 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_linear, 1);
693 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_resplit, 1);
694 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits,
698 /* Try to add the new entry */
700 new_hash = BV (clib_bihash_hash) (add_v);
701 limit = BIHASH_KVP_PER_PAGE;
702 if (mark_bucket_linear)
703 limit <<= new_log2_pages;
704 new_hash >>= h->log2_nbuckets;
705 new_hash &= (1 << new_log2_pages) - 1;
706 new_v += mark_bucket_linear ? 0 : new_hash;
708 for (i = 0; i < limit; i++)
710 if (BV (clib_bihash_is_free) (&(new_v->kvp[i])))
712 clib_memcpy_fast (&(new_v->kvp[i]), add_v, sizeof (*add_v));
717 /* Crap. Try again */
718 BV (value_free) (h, save_new_v, new_log2_pages);
720 * If we've already doubled the size of the bucket once,
721 * fall back to linear search now.
729 tmp_b.log2_pages = new_log2_pages;
730 tmp_b.offset = BV (clib_bihash_get_offset) (h, save_new_v);
731 tmp_b.linear_search = mark_bucket_linear;
732 tmp_b.refcnt = h->saved_bucket.refcnt + 1;
733 ASSERT (tmp_b.refcnt > 0);
735 CLIB_MEMORY_BARRIER ();
736 b->as_u64 = tmp_b.as_u64;
737 /* free the old bucket */
738 v = BV (clib_bihash_get_value) (h, h->saved_bucket.offset);
739 BV (value_free) (h, v, h->saved_bucket.log2_pages);
740 BV (clib_bihash_alloc_unlock) (h);
744 int BV (clib_bihash_add_del)
745 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add)
747 return BV (clib_bihash_add_del_inline) (h, add_v, is_add, 0, 0);
750 int BV (clib_bihash_add_or_overwrite_stale)
751 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v,
752 int (*stale_callback) (BVT (clib_bihash_kv) *, void *), void *arg)
754 return BV (clib_bihash_add_del_inline) (h, add_v, 1, stale_callback, arg);
757 int BV (clib_bihash_search)
758 (BVT (clib_bihash) * h,
759 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
763 BVT (clib_bihash_value) * v;
764 BVT (clib_bihash_bucket) * b;
769 if (PREDICT_FALSE (alloc_arena (h) == 0))
772 hash = BV (clib_bihash_hash) (search_key);
774 bucket_index = hash & (h->nbuckets - 1);
775 b = &h->buckets[bucket_index];
777 if (BV (clib_bihash_bucket_is_empty) (b))
780 if (PREDICT_FALSE (b->lock))
782 volatile BVT (clib_bihash_bucket) * bv = b;
787 hash >>= h->log2_nbuckets;
789 v = BV (clib_bihash_get_value) (h, b->offset);
790 limit = BIHASH_KVP_PER_PAGE;
791 v += (b->linear_search == 0) ? hash & ((1 << b->log2_pages) - 1) : 0;
792 if (PREDICT_FALSE (b->linear_search))
793 limit <<= b->log2_pages;
795 for (i = 0; i < limit; i++)
797 if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key))
806 u8 *BV (format_bihash) (u8 * s, va_list * args)
808 BVT (clib_bihash) * h = va_arg (*args, BVT (clib_bihash) *);
809 int verbose = va_arg (*args, int);
810 BVT (clib_bihash_bucket) * b;
811 BVT (clib_bihash_value) * v;
813 u64 active_elements = 0;
814 u64 active_buckets = 0;
815 u64 linear_buckets = 0;
818 s = format (s, "Hash table %s\n", h->name ? h->name : (u8 *) "(unnamed)");
820 if (PREDICT_FALSE (alloc_arena (h) == 0))
821 return format (s, "[empty, uninitialized]");
823 for (i = 0; i < h->nbuckets; i++)
826 if (BV (clib_bihash_bucket_is_empty) (b))
829 s = format (s, "[%d]: empty\n", i);
835 if (b->linear_search)
840 s = format (s, "[%d]: heap offset %lld, len %d, linear %d\n", i,
841 b->offset, (1 << b->log2_pages), b->linear_search);
844 v = BV (clib_bihash_get_value) (h, b->offset);
845 for (j = 0; j < (1 << b->log2_pages); j++)
847 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
849 if (BV (clib_bihash_is_free) (&v->kvp[k]))
852 s = format (s, " %d: empty\n",
853 j * BIHASH_KVP_PER_PAGE + k);
860 s = format (s, " %d: %U\n",
861 j * BIHASH_KVP_PER_PAGE + k,
862 h->fmt_fn, &(v->kvp[k]), verbose);
866 s = format (s, " %d: %U\n",
867 j * BIHASH_KVP_PER_PAGE + k,
868 BV (format_bihash_kvp), &(v->kvp[k]));
877 s = format (s, " %lld active elements %lld active buckets\n",
878 active_elements, active_buckets);
879 s = format (s, " %d free lists\n", vec_len (h->freelists));
881 for (i = 0; i < vec_len (h->freelists); i++)
884 BVT (clib_bihash_value) * free_elt;
885 u64 free_elt_as_u64 = h->freelists[i];
887 while (free_elt_as_u64)
889 free_elt = BV (clib_bihash_get_value) (h, free_elt_as_u64);
891 free_elt_as_u64 = free_elt->next_free_as_u64;
894 if (nfree || verbose)
895 s = format (s, " [len %d] %u free elts\n", 1 << i, nfree);
898 s = format (s, " %lld linear search buckets\n", linear_buckets);
899 used_bytes = alloc_arena_next (h);
901 " arena: base %llx, next %llx\n"
902 " used %lld b (%lld Mbytes) of %lld b (%lld Mbytes)\n",
903 alloc_arena (h), alloc_arena_next (h),
904 used_bytes, used_bytes >> 20,
905 alloc_arena_size (h), alloc_arena_size (h) >> 20);
909 void BV (clib_bihash_foreach_key_value_pair)
910 (BVT (clib_bihash) * h,
911 BV (clib_bihash_foreach_key_value_pair_cb) cb, void *arg)
914 BVT (clib_bihash_bucket) * b;
915 BVT (clib_bihash_value) * v;
917 if (PREDICT_FALSE (alloc_arena (h) == 0))
920 for (i = 0; i < h->nbuckets; i++)
923 if (BV (clib_bihash_bucket_is_empty) (b))
926 v = BV (clib_bihash_get_value) (h, b->offset);
927 for (j = 0; j < (1 << b->log2_pages); j++)
929 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
931 if (BV (clib_bihash_is_free) (&v->kvp[k]))
934 if (BIHASH_WALK_STOP == cb (&v->kvp[k], arg))
937 * In case the callback deletes the last entry in the bucket...
939 if (BV (clib_bihash_bucket_is_empty) (b))
952 * fd.io coding-style-patch-verification: ON
955 * eval: (c-set-style "gnu")