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 #ifndef MAP_HUGE_SHIFT
19 #define MAP_HUGE_SHIFT 26
22 #ifndef BIIHASH_MIN_ALLOC_LOG2_PAGES
23 #define BIIHASH_MIN_ALLOC_LOG2_PAGES 10
26 static inline void *BV (alloc_aligned) (BVT (clib_bihash) * h, uword nbytes)
30 /* Round to an even number of cache lines */
31 nbytes = round_pow2 (nbytes, CLIB_CACHE_LINE_BYTES);
36 uword page_sz = sizeof (BVT (clib_bihash_value));
37 uword chunk_sz = round_pow2 (page_sz << BIIHASH_MIN_ALLOC_LOG2_PAGES,
38 CLIB_CACHE_LINE_BYTES);
40 BVT (clib_bihash_alloc_chunk) * chunk = h->chunks;
42 /* if there is enough space in the currenrt chunk */
43 if (chunk && chunk->bytes_left >= nbytes)
45 rv = chunk->next_alloc;
46 chunk->bytes_left -= nbytes;
47 chunk->next_alloc += nbytes;
51 /* requested allocation is bigger than chunk size */
52 if (nbytes >= chunk_sz)
54 oldheap = clib_mem_set_heap (h->heap);
55 chunk = clib_mem_alloc_aligned (nbytes + sizeof (*chunk),
56 CLIB_CACHE_LINE_BYTES);
57 clib_mem_set_heap (oldheap);
58 clib_memset_u8 (chunk, 0, sizeof (*chunk));
60 rv = (u8 *) (chunk + 1);
63 /* take 2nd place in the list */
64 chunk->next = h->chunks->next;
65 chunk->prev = h->chunks;
66 h->chunks->next = chunk;
68 chunk->next->prev = chunk;
76 oldheap = clib_mem_set_heap (h->heap);
77 chunk = clib_mem_alloc_aligned (chunk_sz + sizeof (*chunk),
78 CLIB_CACHE_LINE_BYTES);
79 clib_mem_set_heap (oldheap);
80 chunk->size = chunk_sz;
81 chunk->bytes_left = chunk_sz;
82 chunk->next_alloc = (u8 *) (chunk + 1);
83 chunk->next = h->chunks;
86 chunk->next->prev = chunk;
88 rv = chunk->next_alloc;
89 chunk->bytes_left -= nbytes;
90 chunk->next_alloc += nbytes;
94 rv = alloc_arena_next (h);
95 alloc_arena_next (h) += nbytes;
97 if (alloc_arena_next (h) > alloc_arena_size (h))
100 if (alloc_arena_next (h) > alloc_arena_mapped (h))
103 uword alloc = alloc_arena_next (h) - alloc_arena_mapped (h);
104 int mmap_flags = MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS;
105 int mmap_flags_huge = (mmap_flags | MAP_HUGETLB | MAP_LOCKED |
106 BIHASH_LOG2_HUGEPAGE_SIZE << MAP_HUGE_SHIFT);
108 /* new allocation is 25% of existing one */
109 if (alloc_arena_mapped (h) >> 2 > alloc)
110 alloc = alloc_arena_mapped (h) >> 2;
112 /* round allocation to page size */
113 alloc = round_pow2 (alloc, 1 << BIHASH_LOG2_HUGEPAGE_SIZE);
115 base = (void *) (uword) (alloc_arena (h) + alloc_arena_mapped (h));
117 rv = mmap (base, alloc, PROT_READ | PROT_WRITE, mmap_flags_huge, -1, 0);
119 /* fallback - maybe we are still able to allocate normal pages */
120 if (rv == MAP_FAILED || mlock (base, alloc) != 0)
121 rv = mmap (base, alloc, PROT_READ | PROT_WRITE, mmap_flags, -1, 0);
123 if (rv == MAP_FAILED)
126 alloc_arena_mapped (h) += alloc;
129 return (void *) (uword) (rv + alloc_arena (h));
132 static void BV (clib_bihash_instantiate) (BVT (clib_bihash) * h)
138 h->heap = clib_mem_get_heap ();
140 alloc_arena (h) = (uword) clib_mem_get_heap_base (h->heap);
144 alloc_arena (h) = clib_mem_vm_reserve (0, h->memory_size,
145 BIHASH_LOG2_HUGEPAGE_SIZE);
146 if (alloc_arena (h) == ~0)
148 alloc_arena_next (h) = 0;
149 alloc_arena_size (h) = h->memory_size;
150 alloc_arena_mapped (h) = 0;
153 bucket_size = h->nbuckets * sizeof (h->buckets[0]);
155 if (BIHASH_KVP_AT_BUCKET_LEVEL)
157 h->nbuckets * BIHASH_KVP_PER_PAGE * sizeof (BVT (clib_bihash_kv));
159 h->buckets = BV (alloc_aligned) (h, bucket_size);
160 clib_memset_u8 (h->buckets, 0, bucket_size);
162 if (BIHASH_KVP_AT_BUCKET_LEVEL)
165 BVT (clib_bihash_bucket) * b;
169 for (i = 0; i < h->nbuckets; i++)
171 b->offset = BV (clib_bihash_get_offset) (h, (void *) (b + 1));
173 /* Mark all elements free */
174 clib_memset_u8 ((b + 1), 0xff, BIHASH_KVP_PER_PAGE *
175 sizeof (BVT (clib_bihash_kv)));
177 /* Compute next bucket start address */
178 b = (void *) (((uword) b) + sizeof (*b) +
179 (BIHASH_KVP_PER_PAGE *
180 sizeof (BVT (clib_bihash_kv))));
183 CLIB_MEMORY_STORE_BARRIER ();
187 void BV (clib_bihash_init2) (BVT (clib_bihash_init2_args) * a)
191 BVT (clib_bihash) * h = a->h;
193 a->nbuckets = 1 << (max_log2 (a->nbuckets));
195 h->name = (u8 *) a->name;
196 h->nbuckets = a->nbuckets;
197 h->log2_nbuckets = max_log2 (a->nbuckets);
198 h->memory_size = BIHASH_USE_HEAP ? 0 : a->memory_size;
200 h->fmt_fn = a->fmt_fn;
205 * Make sure the requested size is rational. The max table
206 * size without playing the alignment card is 64 Gbytes.
207 * If someone starts complaining that's not enough, we can shift
208 * the offset by CLIB_LOG2_CACHE_LINE_BYTES...
211 ASSERT (h->memory_size < (1ULL << BIHASH_BUCKET_OFFSET_BITS));
213 /* Add this hash table to the list */
214 if (a->dont_add_to_all_bihash_list == 0)
216 for (i = 0; i < vec_len (clib_all_bihashes); i++)
217 if (clib_all_bihashes[i] == h)
219 oldheap = clib_all_bihash_set_heap ();
220 vec_add1 (clib_all_bihashes, (void *) h);
221 clib_mem_set_heap (oldheap);
226 clib_mem_free ((void *) h->alloc_lock);
229 * Set up the lock now, so we can use it to make the first add
232 h->alloc_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
233 CLIB_CACHE_LINE_BYTES);
234 h->alloc_lock[0] = 0;
236 #if BIHASH_LAZY_INSTANTIATE
237 if (a->instantiate_immediately)
239 BV (clib_bihash_instantiate) (h);
242 void BV (clib_bihash_init)
243 (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size)
245 BVT (clib_bihash_init2_args) _a, *a = &_a;
247 memset (a, 0, sizeof (*a));
251 a->nbuckets = nbuckets;
252 a->memory_size = memory_size;
254 BV (clib_bihash_init2) (a);
258 #if !defined (MFD_ALLOW_SEALING)
259 #define MFD_ALLOW_SEALING 0x0002U
262 void BV (clib_bihash_initiator_init_svm)
263 (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size)
267 vec_header_t *freelist_vh;
270 ASSERT (BIHASH_USE_HEAP == 0);
272 ASSERT (memory_size < (1ULL << 32));
273 /* Set up for memfd sharing */
274 if ((fd = memfd_create (name, MFD_ALLOW_SEALING)) == -1)
276 clib_unix_warning ("memfd_create");
280 if (ftruncate (fd, memory_size) < 0)
282 clib_unix_warning ("ftruncate");
286 /* Not mission-critical, complain and continue */
287 if ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
288 clib_unix_warning ("fcntl (F_ADD_SEALS)");
290 mmap_addr = mmap (0, memory_size,
291 PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 /* offset */ );
293 if (mmap_addr == MAP_FAILED)
295 clib_unix_warning ("mmap failed");
299 h->sh = (void *) mmap_addr;
301 nbuckets = 1 << (max_log2 (nbuckets));
303 h->name = (u8 *) name;
304 h->sh->nbuckets = h->nbuckets = nbuckets;
305 h->log2_nbuckets = max_log2 (nbuckets);
307 alloc_arena (h) = (u64) (uword) mmap_addr;
308 alloc_arena_next (h) = CLIB_CACHE_LINE_BYTES;
309 alloc_arena_size (h) = memory_size;
311 bucket_size = nbuckets * sizeof (h->buckets[0]);
312 h->buckets = BV (alloc_aligned) (h, bucket_size);
313 clib_memset_u8 (h->buckets, 0, bucket_size);
314 h->sh->buckets_as_u64 = (u64) BV (clib_bihash_get_offset) (h, h->buckets);
316 h->alloc_lock = BV (alloc_aligned) (h, CLIB_CACHE_LINE_BYTES);
317 h->alloc_lock[0] = 0;
319 h->sh->alloc_lock_as_u64 =
320 (u64) BV (clib_bihash_get_offset) (h, (void *) h->alloc_lock);
322 BV (alloc_aligned) (h,
323 sizeof (vec_header_t) +
324 BIHASH_FREELIST_LENGTH * sizeof (u64));
325 freelist_vh->len = BIHASH_FREELIST_LENGTH;
326 h->sh->freelists_as_u64 =
327 (u64) BV (clib_bihash_get_offset) (h, freelist_vh->vector_data);
328 h->freelists = (void *) (freelist_vh->vector_data);
334 void BV (clib_bihash_responder_init_svm)
335 (BVT (clib_bihash) * h, char *name, int fd)
339 BVT (clib_bihash_shared_header) * sh;
341 ASSERT (BIHASH_USE_HEAP == 0);
343 /* Trial mapping, to learn the segment size */
344 mmap_addr = mmap (0, 4096, PROT_READ, MAP_SHARED, fd, 0 /* offset */ );
345 if (mmap_addr == MAP_FAILED)
347 clib_unix_warning ("trial mmap failed");
351 sh = (BVT (clib_bihash_shared_header) *) mmap_addr;
353 memory_size = sh->alloc_arena_size;
355 munmap (mmap_addr, 4096);
357 /* Actual mapping, at the required size */
358 mmap_addr = mmap (0, memory_size,
359 PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 /* offset */ );
361 if (mmap_addr == MAP_FAILED)
363 clib_unix_warning ("mmap failed");
369 h->sh = (void *) mmap_addr;
370 alloc_arena (h) = (u64) (uword) mmap_addr;
373 h->name = (u8 *) name;
374 h->buckets = BV (clib_bihash_get_value) (h, h->sh->buckets_as_u64);
375 h->nbuckets = h->sh->nbuckets;
376 h->log2_nbuckets = max_log2 (h->nbuckets);
378 h->alloc_lock = BV (clib_bihash_get_value) (h, h->sh->alloc_lock_as_u64);
379 h->freelists = BV (clib_bihash_get_value) (h, h->sh->freelists_as_u64);
382 #endif /* BIHASH_32_64_SVM */
384 void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h,
385 format_function_t * fmt_fn)
390 void BV (clib_bihash_free) (BVT (clib_bihash) * h)
394 if (PREDICT_FALSE (h->instantiated == 0))
395 goto never_initialized;
401 BVT (clib_bihash_alloc_chunk) * next, *chunk;
402 void *oldheap = clib_mem_set_heap (h->heap);
408 clib_mem_free (chunk);
411 clib_mem_set_heap (oldheap);
414 vec_free (h->working_copies);
415 vec_free (h->working_copy_lengths);
416 #if BIHASH_32_64_SVM == 0
417 vec_free (h->freelists);
420 (void) close (h->memfd);
422 if (BIHASH_USE_HEAP == 0)
423 clib_mem_vm_free ((void *) (uword) (alloc_arena (h)),
424 alloc_arena_size (h));
426 clib_memset_u8 (h, 0, sizeof (*h));
427 for (i = 0; i < vec_len (clib_all_bihashes); i++)
429 if ((void *) h == clib_all_bihashes[i])
431 vec_delete (clib_all_bihashes, 1, i);
435 clib_warning ("Couldn't find hash table %llx on clib_all_bihashes...",
440 BVT (clib_bihash_value) *
441 BV (value_alloc) (BVT (clib_bihash) * h, u32 log2_pages)
443 BVT (clib_bihash_value) * rv = 0;
445 ASSERT (h->alloc_lock[0]);
448 ASSERT (log2_pages < vec_len (h->freelists));
451 if (log2_pages >= vec_len (h->freelists) || h->freelists[log2_pages] == 0)
453 vec_validate_init_empty (h->freelists, log2_pages, 0);
454 rv = BV (alloc_aligned) (h, (sizeof (*rv) * (1 << log2_pages)));
457 rv = BV (clib_bihash_get_value) (h, (uword) h->freelists[log2_pages]);
458 h->freelists[log2_pages] = rv->next_free_as_u64;
463 * Latest gcc complains that the length arg is zero
464 * if we replace (1<<log2_pages) with vec_len(rv).
467 clib_memset_u8 (rv, 0xff, sizeof (*rv) * (1 << log2_pages));
472 BV (value_free) (BVT (clib_bihash) * h, BVT (clib_bihash_value) * v,
475 ASSERT (h->alloc_lock[0]);
477 ASSERT (vec_len (h->freelists) > log2_pages);
479 if (BIHASH_USE_HEAP && log2_pages >= BIIHASH_MIN_ALLOC_LOG2_PAGES)
481 /* allocations bigger or equal to chunk size always contain single
482 * alloc and they can be given back to heap */
484 BVT (clib_bihash_alloc_chunk) * c;
485 c = (BVT (clib_bihash_alloc_chunk) *) v - 1;
488 c->prev->next = c->next;
493 c->next->prev = c->prev;
495 oldheap = clib_mem_set_heap (h->heap);
497 clib_mem_set_heap (oldheap);
502 clib_memset_u8 (v, 0xFE, sizeof (*v) * (1 << log2_pages));
504 v->next_free_as_u64 = (u64) h->freelists[log2_pages];
505 h->freelists[log2_pages] = (u64) BV (clib_bihash_get_offset) (h, v);
509 BV (make_working_copy) (BVT (clib_bihash) * h, BVT (clib_bihash_bucket) * b)
511 BVT (clib_bihash_value) * v;
512 BVT (clib_bihash_bucket) working_bucket __attribute__ ((aligned (8)));
513 BVT (clib_bihash_value) * working_copy;
514 u32 thread_index = os_get_thread_index ();
515 int log2_working_copy_length;
517 ASSERT (h->alloc_lock[0]);
519 if (thread_index >= vec_len (h->working_copies))
521 vec_validate (h->working_copies, thread_index);
522 vec_validate_init_empty (h->working_copy_lengths, thread_index, ~0);
526 * working_copies are per-cpu so that near-simultaneous
527 * updates from multiple threads will not result in sporadic, spurious
530 working_copy = h->working_copies[thread_index];
531 log2_working_copy_length = h->working_copy_lengths[thread_index];
533 h->saved_bucket.as_u64 = b->as_u64;
535 if (b->log2_pages > log2_working_copy_length)
538 * It's not worth the bookkeeping to free working copies
540 * clib_mem_free (working_copy);
542 working_copy = BV (alloc_aligned)
543 (h, sizeof (working_copy[0]) * (1 << b->log2_pages));
544 h->working_copy_lengths[thread_index] = b->log2_pages;
545 h->working_copies[thread_index] = working_copy;
547 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_working_copy_lost,
548 1ULL << b->log2_pages);
551 v = BV (clib_bihash_get_value) (h, b->offset);
553 clib_memcpy_fast (working_copy, v, sizeof (*v) * (1 << b->log2_pages));
554 working_bucket.as_u64 = b->as_u64;
555 working_bucket.offset = BV (clib_bihash_get_offset) (h, working_copy);
556 CLIB_MEMORY_STORE_BARRIER ();
557 b->as_u64 = working_bucket.as_u64;
558 h->working_copies[thread_index] = working_copy;
562 BVT (clib_bihash_value) *
563 BV (split_and_rehash)
564 (BVT (clib_bihash) * h,
565 BVT (clib_bihash_value) * old_values, u32 old_log2_pages,
568 BVT (clib_bihash_value) * new_values, *new_v;
569 int i, j, length_in_kvs;
571 ASSERT (h->alloc_lock[0]);
573 new_values = BV (value_alloc) (h, new_log2_pages);
574 length_in_kvs = (1 << old_log2_pages) * BIHASH_KVP_PER_PAGE;
576 for (i = 0; i < length_in_kvs; i++)
580 /* Entry not in use? Forget it */
581 if (BV (clib_bihash_is_free) (&(old_values->kvp[i])))
584 /* rehash the item onto its new home-page */
585 new_hash = BV (clib_bihash_hash) (&(old_values->kvp[i]));
586 new_hash = extract_bits (new_hash, h->log2_nbuckets, new_log2_pages);
587 new_v = &new_values[new_hash];
589 /* Across the new home-page */
590 for (j = 0; j < BIHASH_KVP_PER_PAGE; j++)
593 if (BV (clib_bihash_is_free) (&(new_v->kvp[j])))
595 clib_memcpy_fast (&(new_v->kvp[j]), &(old_values->kvp[i]),
596 sizeof (new_v->kvp[j]));
600 /* Crap. Tell caller to try again */
601 BV (value_free) (h, new_values, new_log2_pages);
610 BVT (clib_bihash_value) *
611 BV (split_and_rehash_linear)
612 (BVT (clib_bihash) * h,
613 BVT (clib_bihash_value) * old_values, u32 old_log2_pages,
616 BVT (clib_bihash_value) * new_values;
617 int i, j, new_length, old_length;
619 ASSERT (h->alloc_lock[0]);
621 new_values = BV (value_alloc) (h, new_log2_pages);
622 new_length = (1 << new_log2_pages) * BIHASH_KVP_PER_PAGE;
623 old_length = (1 << old_log2_pages) * BIHASH_KVP_PER_PAGE;
626 /* Across the old value array */
627 for (i = 0; i < old_length; i++)
629 /* Find a free slot in the new linear scan bucket */
630 for (; j < new_length; j++)
632 /* Old value not in use? Forget it. */
633 if (BV (clib_bihash_is_free) (&(old_values->kvp[i])))
636 /* New value should never be in use */
637 if (BV (clib_bihash_is_free) (&(new_values->kvp[j])))
639 /* Copy the old value and move along */
640 clib_memcpy_fast (&(new_values->kvp[j]), &(old_values->kvp[i]),
641 sizeof (new_values->kvp[j]));
646 /* This should never happen... */
647 clib_warning ("BUG: linear rehash failed!");
648 BV (value_free) (h, new_values, new_log2_pages);
656 static_always_inline int BV (clib_bihash_add_del_inline_with_hash)
657 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, u64 hash, int is_add,
658 int (*is_stale_cb) (BVT (clib_bihash_kv) *, void *), void *arg)
660 BVT (clib_bihash_bucket) * b, tmp_b;
661 BVT (clib_bihash_value) * v, *new_v, *save_new_v, *working_copy;
664 u32 new_log2_pages, old_log2_pages;
665 u32 thread_index = os_get_thread_index ();
666 int mark_bucket_linear;
670 static const BVT (clib_bihash_bucket) mask = {
676 #if BIHASH_LAZY_INSTANTIATE
678 * Create the table (is_add=1,2), or flunk the request now (is_add=0)
679 * Use the alloc_lock to protect the instantiate operation.
681 if (PREDICT_FALSE (h->instantiated == 0))
686 BV (clib_bihash_alloc_lock) (h);
687 if (h->instantiated == 0)
688 BV (clib_bihash_instantiate) (h);
689 BV (clib_bihash_alloc_unlock) (h);
692 /* Debug image: make sure the table has been instantiated */
693 ASSERT (h->instantiated != 0);
696 b = BV (clib_bihash_get_bucket) (h, hash);
698 BV (clib_bihash_lock_bucket) (b);
700 /* First elt in the bucket? */
701 if (BIHASH_KVP_AT_BUCKET_LEVEL == 0 && BV (clib_bihash_bucket_is_empty) (b))
705 BV (clib_bihash_unlock_bucket) (b);
709 BV (clib_bihash_alloc_lock) (h);
710 v = BV (value_alloc) (h, 0);
711 BV (clib_bihash_alloc_unlock) (h);
714 tmp_b.as_u64 = 0; /* clears bucket lock */
715 tmp_b.offset = BV (clib_bihash_get_offset) (h, v);
717 CLIB_MEMORY_STORE_BARRIER ();
719 b->as_u64 = tmp_b.as_u64; /* unlocks the bucket */
720 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_alloc_add, 1);
725 /* WARNING: we're still looking at the live copy... */
726 limit = BIHASH_KVP_PER_PAGE;
727 v = BV (clib_bihash_get_value) (h, b->offset);
729 if (PREDICT_FALSE (b->as_u64 & mask.as_u64))
731 if (PREDICT_FALSE (b->linear_search))
732 limit <<= b->log2_pages;
734 v += extract_bits (hash, h->log2_nbuckets, b->log2_pages);
740 * Because reader threads are looking at live data,
741 * we have to be extra careful. Readers do NOT hold the
742 * bucket lock. We need to be SLOWER than a search, past the
743 * point where readers CHECK the bucket lock.
747 * For obvious (in hindsight) reasons, see if we're supposed to
748 * replace an existing key, then look for an empty slot.
750 for (i = 0; i < limit; i++)
752 if (BV (clib_bihash_key_compare) (v->kvp[i].key, add_v->key))
754 /* Add but do not overwrite? */
757 BV (clib_bihash_unlock_bucket) (b);
761 clib_memcpy_fast (&(v->kvp[i].value),
762 &add_v->value, sizeof (add_v->value));
763 BV (clib_bihash_unlock_bucket) (b);
764 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_replace, 1);
769 * Look for an empty slot. If found, use it
771 for (i = 0; i < limit; i++)
773 if (BV (clib_bihash_is_free) (&(v->kvp[i])))
776 * Copy the value first, so that if a reader manages
777 * to match the new key, the value will be right...
779 clib_memcpy_fast (&(v->kvp[i].value),
780 &add_v->value, sizeof (add_v->value));
781 CLIB_MEMORY_STORE_BARRIER (); /* Make sure the value has settled */
782 clib_memcpy_fast (&(v->kvp[i]), &add_v->key,
783 sizeof (add_v->key));
785 ASSERT (b->refcnt > 0);
786 BV (clib_bihash_unlock_bucket) (b);
787 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_add, 1);
791 /* look for stale data to overwrite */
794 for (i = 0; i < limit; i++)
796 if (is_stale_cb (&(v->kvp[i]), arg))
798 clib_memcpy_fast (&(v->kvp[i]), add_v, sizeof (*add_v));
799 CLIB_MEMORY_STORE_BARRIER ();
800 BV (clib_bihash_unlock_bucket) (b);
801 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_replace, 1);
806 /* Out of space in this bucket, split the bucket... */
808 else /* delete case */
810 for (i = 0; i < limit; i++)
812 /* Found the key? Kill it... */
813 if (BV (clib_bihash_key_compare) (v->kvp[i].key, add_v->key))
815 clib_memset_u8 (&(v->kvp[i]), 0xff, sizeof (*(add_v)));
816 /* Is the bucket empty? */
817 if (PREDICT_TRUE (b->refcnt > 1))
820 /* Switch back to the bucket-level kvp array? */
821 if (BIHASH_KVP_AT_BUCKET_LEVEL && b->refcnt == 1
822 && b->log2_pages > 0)
824 tmp_b.as_u64 = b->as_u64;
825 b->offset = BV (clib_bihash_get_offset)
826 (h, (void *) (b + 1));
827 b->linear_search = 0;
829 /* Clean up the bucket-level kvp array */
830 clib_memset_u8 ((b + 1), 0xff, BIHASH_KVP_PER_PAGE *
831 sizeof (BVT (clib_bihash_kv)));
832 CLIB_MEMORY_STORE_BARRIER ();
833 BV (clib_bihash_unlock_bucket) (b);
834 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del, 1);
835 goto free_backing_store;
838 CLIB_MEMORY_STORE_BARRIER ();
839 BV (clib_bihash_unlock_bucket) (b);
840 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del, 1);
843 else /* yes, free it */
845 /* Save old bucket value, need log2_pages to free it */
846 tmp_b.as_u64 = b->as_u64;
848 /* Kill and unlock the bucket */
852 /* And free the backing storage */
853 BV (clib_bihash_alloc_lock) (h);
854 /* Note: v currently points into the middle of the bucket */
855 v = BV (clib_bihash_get_value) (h, tmp_b.offset);
856 BV (value_free) (h, v, tmp_b.log2_pages);
857 BV (clib_bihash_alloc_unlock) (h);
858 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_del_free,
865 BV (clib_bihash_unlock_bucket) (b);
869 /* Move readers to a (locked) temp copy of the bucket */
870 BV (clib_bihash_alloc_lock) (h);
871 BV (make_working_copy) (h, b);
873 v = BV (clib_bihash_get_value) (h, h->saved_bucket.offset);
875 old_log2_pages = h->saved_bucket.log2_pages;
876 new_log2_pages = old_log2_pages + 1;
877 mark_bucket_linear = 0;
878 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_split_add, 1);
879 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits, old_log2_pages);
881 working_copy = h->working_copies[thread_index];
883 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits, 1);
885 new_v = BV (split_and_rehash) (h, working_copy, old_log2_pages,
892 /* Try re-splitting. If that fails, fall back to linear search */
893 new_v = BV (split_and_rehash) (h, working_copy, old_log2_pages,
899 /* pinned collisions, use linear search */
901 BV (split_and_rehash_linear) (h, working_copy, old_log2_pages,
903 mark_bucket_linear = 1;
904 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_linear, 1);
906 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_resplit, 1);
907 BV (clib_bihash_increment_stat) (h, BIHASH_STAT_splits,
911 /* Try to add the new entry */
913 new_hash = BV (clib_bihash_hash) (add_v);
914 limit = BIHASH_KVP_PER_PAGE;
915 if (mark_bucket_linear)
916 limit <<= new_log2_pages;
918 new_v += extract_bits (new_hash, h->log2_nbuckets, new_log2_pages);
920 for (i = 0; i < limit; i++)
922 if (BV (clib_bihash_is_free) (&(new_v->kvp[i])))
924 clib_memcpy_fast (&(new_v->kvp[i]), add_v, sizeof (*add_v));
929 /* Crap. Try again */
930 BV (value_free) (h, save_new_v, new_log2_pages);
932 * If we've already doubled the size of the bucket once,
933 * fall back to linear search now.
941 tmp_b.log2_pages = new_log2_pages;
942 tmp_b.offset = BV (clib_bihash_get_offset) (h, save_new_v);
943 tmp_b.linear_search = mark_bucket_linear;
944 #if BIHASH_KVP_AT_BUCKET_LEVEL
945 /* Compensate for permanent refcount bump at the bucket level */
946 if (new_log2_pages > 0)
948 tmp_b.refcnt = h->saved_bucket.refcnt + 1;
949 ASSERT (tmp_b.refcnt > 0);
951 CLIB_MEMORY_STORE_BARRIER ();
952 b->as_u64 = tmp_b.as_u64;
954 #if BIHASH_KVP_AT_BUCKET_LEVEL
955 if (h->saved_bucket.log2_pages > 0)
959 /* free the old bucket, except at the bucket level if so configured */
960 v = BV (clib_bihash_get_value) (h, h->saved_bucket.offset);
961 BV (value_free) (h, v, h->saved_bucket.log2_pages);
963 #if BIHASH_KVP_AT_BUCKET_LEVEL
968 BV (clib_bihash_alloc_unlock) (h);
972 static_always_inline int BV (clib_bihash_add_del_inline)
973 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add,
974 int (*is_stale_cb) (BVT (clib_bihash_kv) *, void *), void *arg)
976 u64 hash = BV (clib_bihash_hash) (add_v);
977 return BV (clib_bihash_add_del_inline_with_hash) (h, add_v, hash, is_add,
981 int BV (clib_bihash_add_del)
982 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add)
984 return BV (clib_bihash_add_del_inline) (h, add_v, is_add, 0, 0);
987 int BV (clib_bihash_add_or_overwrite_stale)
988 (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v,
989 int (*stale_callback) (BVT (clib_bihash_kv) *, void *), void *arg)
991 return BV (clib_bihash_add_del_inline) (h, add_v, 1, stale_callback, arg);
994 int BV (clib_bihash_search)
995 (BVT (clib_bihash) * h,
996 BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep)
998 return BV (clib_bihash_search_inline_2) (h, search_key, valuep);
1001 u8 *BV (format_bihash) (u8 * s, va_list * args)
1003 BVT (clib_bihash) * h = va_arg (*args, BVT (clib_bihash) *);
1004 int verbose = va_arg (*args, int);
1005 BVT (clib_bihash_bucket) * b;
1006 BVT (clib_bihash_value) * v;
1008 u64 active_elements = 0;
1009 u64 active_buckets = 0;
1010 u64 linear_buckets = 0;
1012 s = format (s, "Hash table %s\n", h->name ? h->name : (u8 *) "(unnamed)");
1014 #if BIHASH_LAZY_INSTANTIATE
1015 if (PREDICT_FALSE (h->instantiated == 0))
1016 return format (s, "[empty, uninitialized]");
1019 for (i = 0; i < h->nbuckets; i++)
1021 b = BV (clib_bihash_get_bucket) (h, i);
1022 if (BV (clib_bihash_bucket_is_empty) (b))
1025 s = format (s, "[%d]: empty\n", i);
1031 if (b->linear_search)
1037 (s, "[%d]: heap offset %lld, len %d, refcnt %d, linear %d\n", i,
1038 b->offset, (1 << b->log2_pages), b->refcnt, b->linear_search);
1041 v = BV (clib_bihash_get_value) (h, b->offset);
1042 for (j = 0; j < (1 << b->log2_pages); j++)
1044 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1046 if (BV (clib_bihash_is_free) (&v->kvp[k]))
1049 s = format (s, " %d: empty\n",
1050 j * BIHASH_KVP_PER_PAGE + k);
1057 s = format (s, " %d: %U\n",
1058 j * BIHASH_KVP_PER_PAGE + k,
1059 h->fmt_fn, &(v->kvp[k]), verbose);
1063 s = format (s, " %d: %U\n",
1064 j * BIHASH_KVP_PER_PAGE + k,
1065 BV (format_bihash_kvp), &(v->kvp[k]));
1074 s = format (s, " %lld active elements %lld active buckets\n",
1075 active_elements, active_buckets);
1076 s = format (s, " %d free lists\n", vec_len (h->freelists));
1078 for (i = 0; i < vec_len (h->freelists); i++)
1081 BVT (clib_bihash_value) * free_elt;
1082 u64 free_elt_as_u64 = h->freelists[i];
1084 while (free_elt_as_u64)
1086 free_elt = BV (clib_bihash_get_value) (h, free_elt_as_u64);
1088 free_elt_as_u64 = free_elt->next_free_as_u64;
1091 if (nfree || verbose)
1092 s = format (s, " [len %d] %u free elts\n", 1 << i, nfree);
1095 s = format (s, " %lld linear search buckets\n", linear_buckets);
1096 if (BIHASH_USE_HEAP)
1098 BVT (clib_bihash_alloc_chunk) * c = h->chunks;
1099 uword bytes_left = 0, total_size = 0, n_chunks = 0;
1103 bytes_left += c->bytes_left;
1104 total_size += c->size;
1109 " heap: %u chunks allocated\n"
1110 " used %UB, scrap %UB\n", n_chunks,
1111 format_memory_size, total_size,
1112 format_memory_size, bytes_left);
1116 u64 used_bytes = alloc_arena_next (h);
1118 " arena: base %llx, next %llx\n"
1119 " used %lld b (%lld Mbytes) of %lld b (%lld Mbytes)\n",
1120 alloc_arena (h), alloc_arena_next (h),
1121 used_bytes, used_bytes >> 20,
1122 alloc_arena_size (h), alloc_arena_size (h) >> 20);
1127 void BV (clib_bihash_foreach_key_value_pair)
1128 (BVT (clib_bihash) * h,
1129 BV (clib_bihash_foreach_key_value_pair_cb) cb, void *arg)
1132 BVT (clib_bihash_bucket) * b;
1133 BVT (clib_bihash_value) * v;
1136 #if BIHASH_LAZY_INSTANTIATE
1137 if (PREDICT_FALSE (h->instantiated == 0))
1141 for (i = 0; i < h->nbuckets; i++)
1143 b = BV (clib_bihash_get_bucket) (h, i);
1144 if (BV (clib_bihash_bucket_is_empty) (b))
1147 v = BV (clib_bihash_get_value) (h, b->offset);
1148 for (j = 0; j < (1 << b->log2_pages); j++)
1150 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1152 if (BV (clib_bihash_is_free) (&v->kvp[k]))
1155 if (BIHASH_WALK_STOP == cb (&v->kvp[k], arg))
1158 * In case the callback deletes the last entry in the bucket...
1160 if (BV (clib_bihash_bucket_is_empty) (b))
1173 * fd.io coding-style-patch-verification: ON
1176 * eval: (c-set-style "gnu")