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 * buffer.c: allocate/free network buffers.
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
43 * Allocate/free network buffers.
46 #include <vppinfra/linux/sysfs.h>
47 #include <vlib/vlib.h>
48 #include <vlib/unix/unix.h>
49 #include <vlib/stats/stats.h>
51 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA 16384
52 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV 8192
54 #ifdef CLIB_HAVE_VEC128
55 /* Assumptions by vlib_buffer_free_inline: */
56 STATIC_ASSERT_FITS_IN (vlib_buffer_t, flags, 16);
57 STATIC_ASSERT_FITS_IN (vlib_buffer_t, ref_count, 16);
58 STATIC_ASSERT_FITS_IN (vlib_buffer_t, buffer_pool_index, 16);
61 /* Make sure that buffer template size is not accidentally changed */
62 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
64 u16 __vlib_buffer_external_hdr_size = 0;
67 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
68 vlib_buffer_t * b_first)
70 vlib_buffer_t *b = b_first;
71 uword l_first = b_first->current_length;
73 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
75 b = vlib_get_buffer (vm, b->next_buffer);
76 l += b->current_length;
78 b_first->total_length_not_including_first_buffer = l;
79 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
84 format_vlib_buffer_no_chain (u8 * s, va_list * args)
86 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
87 u32 indent = format_get_indent (s);
90 #define _(bit, name, v) \
91 if (v && (b->flags & VLIB_BUFFER_##name)) \
92 a = format (a, "%s ", v);
93 foreach_vlib_buffer_flag
95 s = format (s, "current data %d, length %d, buffer-pool %d, "
96 "ref-count %u", b->current_data, b->current_length,
97 b->buffer_pool_index, b->ref_count);
99 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
100 s = format (s, ", totlen-nifb %d",
101 b->total_length_not_including_first_buffer);
103 if (b->flags & VLIB_BUFFER_IS_TRACED)
104 s = format (s, ", trace handle 0x%x", b->trace_handle);
107 s = format (s, "\n%U%v", format_white_space, indent, a);
114 format_vlib_buffer (u8 * s, va_list * args)
116 vlib_main_t *vm = vlib_get_main ();
117 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
118 u32 indent = format_get_indent (s);
120 s = format (s, "%U", format_vlib_buffer_no_chain, b);
122 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
124 u32 next_buffer = b->next_buffer;
125 b = vlib_get_buffer (vm, next_buffer);
128 format (s, "\n%Unext-buffer 0x%x, segment length %d, ref-count %u",
129 format_white_space, indent, next_buffer, b->current_length,
137 format_vlib_buffer_and_data (u8 * s, va_list * args)
139 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
141 s = format (s, "%U, %U",
142 format_vlib_buffer, b,
143 format_hex_bytes, vlib_buffer_get_current (b), 64);
149 format_vlib_buffer_known_state (u8 * s, va_list * args)
151 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
156 case VLIB_BUFFER_UNKNOWN:
160 case VLIB_BUFFER_KNOWN_ALLOCATED:
161 t = "known-allocated";
164 case VLIB_BUFFER_KNOWN_FREE:
173 return format (s, "%s", t);
177 format_vlib_buffer_contents (u8 * s, va_list * va)
179 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
180 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
184 vec_add (s, vlib_buffer_get_current (b), b->current_length);
185 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
187 b = vlib_get_buffer (vm, b->next_buffer);
194 vlib_validate_buffer_helper (vlib_main_t * vm,
196 uword follow_buffer_next, uword ** unique_hash)
198 vlib_buffer_main_t *bm = vm->buffer_main;
199 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
201 if (vec_len (bm->buffer_pools) <= b->buffer_pool_index)
202 return format (0, "unknown buffer pool 0x%x", b->buffer_pool_index);
204 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
205 return format (0, "current data %d before pre-data", b->current_data);
207 if (b->current_data + b->current_length >
208 vlib_buffer_get_default_data_size (vm))
209 return format (0, "%d-%d beyond end of buffer %d", b->current_data,
210 b->current_length, vlib_buffer_get_default_data_size (vm));
212 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
214 vlib_buffer_known_state_t k;
217 k = vlib_buffer_is_known (vm, b->next_buffer);
218 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
219 return format (0, "next 0x%x: %U",
220 b->next_buffer, format_vlib_buffer_known_state, k);
224 if (hash_get (*unique_hash, b->next_buffer))
225 return format (0, "duplicate buffer 0x%x", b->next_buffer);
227 hash_set1 (*unique_hash, b->next_buffer);
230 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
233 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
243 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
245 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
246 /* unique_hash */ 0);
250 vlib_validate_buffers (vlib_main_t * vm,
252 uword next_buffer_stride,
254 vlib_buffer_known_state_t known_state,
255 uword follow_buffer_next)
258 u32 bi, *b = buffers;
259 vlib_buffer_known_state_t k;
260 u8 *msg = 0, *result = 0;
262 hash = hash_create (0, 0);
263 for (i = 0; i < n_buffers; i++)
266 b += next_buffer_stride;
268 /* Buffer is not unique. */
269 if (hash_get (hash, bi))
271 msg = format (0, "not unique");
275 k = vlib_buffer_is_known (vm, bi);
276 if (k != known_state)
278 msg = format (0, "is %U; expected %U",
279 format_vlib_buffer_known_state, k,
280 format_vlib_buffer_known_state, known_state);
284 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
288 hash_set1 (hash, bi);
294 result = format (0, "0x%x: %v", bi, msg);
301 /* When debugging validate that given buffers are either known allocated
304 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
307 vlib_buffer_known_state_t expected_state)
309 vlib_buffer_main_t *bm = vm->buffer_main;
311 uword i, bi, is_free;
316 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
318 for (i = 0; i < n_buffers; i++)
320 vlib_buffer_known_state_t known;
324 known = vlib_buffer_is_known (vm, bi);
326 if (known == VLIB_BUFFER_UNKNOWN &&
327 expected_state == VLIB_BUFFER_KNOWN_FREE)
328 known = VLIB_BUFFER_KNOWN_FREE;
330 if (known != expected_state)
332 clib_panic ("%s %U buffer 0x%x", is_free ? "freeing" : "allocating",
333 format_vlib_buffer_known_state, known, bi);
336 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
337 hash_set (bm->buffer_known_hash, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
338 VLIB_BUFFER_KNOWN_ALLOCATED);
339 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
344 vlib_packet_template_init (vlib_main_t * vm,
345 vlib_packet_template_t * t,
347 uword n_packet_data_bytes,
348 uword min_n_buffers_each_alloc, char *fmt, ...)
353 t->name = va_format (0, fmt, &va);
356 vlib_worker_thread_barrier_sync (vm);
358 clib_memset (t, 0, sizeof (t[0]));
360 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
361 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
362 vlib_worker_thread_barrier_release (vm);
366 vlib_packet_template_get_packet (vlib_main_t * vm,
367 vlib_packet_template_t * t, u32 * bi_result)
372 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
377 b = vlib_get_buffer (vm, bi);
378 clib_memcpy_fast (vlib_buffer_get_current (b),
379 t->packet_data, vec_len (t->packet_data));
380 b->current_length = vec_len (t->packet_data);
385 /* Append given data to end of buffer, possibly allocating new buffers. */
387 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
390 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
395 if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
399 n_left = n_data_bytes;
400 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
402 b = vlib_get_buffer (vm, bi);
403 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
405 /* Get to the end of the chain before we try to append data... */
406 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
407 b = vlib_get_buffer (vm, b->next_buffer);
413 ASSERT (n_buffer_bytes >= b->current_length);
415 n_buffer_bytes - (b->current_data + b->current_length);
416 n = clib_min (n_left_this_buffer, n_left);
417 clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
419 b->current_length += n;
425 if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
428 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
430 b = vlib_get_buffer (vm, b->next_buffer);
437 clib_warning ("out of buffers");
442 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
443 vlib_buffer_t * first,
444 vlib_buffer_t ** last, void *data,
447 vlib_buffer_t *l = *last;
448 u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
450 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
453 u16 max = n_buffer_bytes - l->current_length - l->current_data;
456 if (1 != vlib_buffer_alloc_from_pool (vm, &l->next_buffer, 1,
457 first->buffer_pool_index))
459 *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
460 max = n_buffer_bytes - l->current_length - l->current_data;
463 u16 len = (data_len > max) ? max : data_len;
464 clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
466 vlib_buffer_chain_increase_length (first, l, len);
474 vlib_buffer_alloc_size (uword ext_hdr_size, uword data_size)
476 uword alloc_size = ext_hdr_size + sizeof (vlib_buffer_t) + data_size;
477 alloc_size = CLIB_CACHE_LINE_ROUND (alloc_size);
479 /* in case when we have even number of cachelines, we add one more for
480 * better cache occupancy */
481 alloc_size |= CLIB_CACHE_LINE_BYTES;
487 vlib_buffer_pool_create (vlib_main_t * vm, char *name, u32 data_size,
488 u32 physmem_map_index)
490 vlib_buffer_main_t *bm = vm->buffer_main;
491 vlib_buffer_pool_t *bp;
492 vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
493 uword start = pointer_to_uword (m->base);
494 uword size = (uword) m->n_pages << m->log2_page_size;
496 u32 alloc_size, n_alloc_per_page;
498 if (vec_len (bm->buffer_pools) >= 255)
501 vec_add2_aligned (bm->buffer_pools, bp, 1, CLIB_CACHE_LINE_BYTES);
503 if (bm->buffer_mem_size == 0)
505 bm->buffer_mem_start = start;
506 bm->buffer_mem_size = size;
508 else if (start < bm->buffer_mem_start)
510 bm->buffer_mem_size += bm->buffer_mem_start - start;
511 bm->buffer_mem_start = start;
512 if (size > bm->buffer_mem_size)
513 bm->buffer_mem_size = size;
515 else if (start > bm->buffer_mem_start)
517 uword new_size = start - bm->buffer_mem_start + size;
518 if (new_size > bm->buffer_mem_size)
519 bm->buffer_mem_size = new_size;
522 if ((u64) bm->buffer_mem_size >
523 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
525 clib_panic ("buffer memory size out of range!");
530 bp->index = bp - bm->buffer_pools;
531 bp->buffer_template.buffer_pool_index = bp->index;
532 bp->buffer_template.ref_count = 1;
533 bp->physmem_map_index = physmem_map_index;
534 bp->name = format (0, "%s%c", name, 0);
535 bp->data_size = data_size;
536 bp->numa_node = m->numa_node;
538 vec_validate_aligned (bp->threads, vlib_get_n_threads () - 1,
539 CLIB_CACHE_LINE_BYTES);
541 alloc_size = vlib_buffer_alloc_size (bm->ext_hdr_size, data_size);
542 n_alloc_per_page = (1ULL << m->log2_page_size) / alloc_size;
544 /* preallocate buffer indices memory */
545 bp->n_buffers = m->n_pages * n_alloc_per_page;
546 bp->buffers = clib_mem_alloc_aligned (bp->n_buffers * sizeof (u32),
547 CLIB_CACHE_LINE_BYTES);
549 clib_spinlock_init (&bp->lock);
551 for (j = 0; j < m->n_pages; j++)
552 for (i = 0; i < n_alloc_per_page; i++)
557 p = m->base + (j << m->log2_page_size) + i * alloc_size;
558 p += bm->ext_hdr_size;
561 * Waste 1 buffer (maximum) so that 0 is never a valid buffer index.
562 * Allows various places to ASSERT (bi != 0). Much easier
563 * than debugging downstream crashes in successor nodes.
568 vlib_buffer_copy_template ((vlib_buffer_t *) p, &bp->buffer_template);
570 bi = vlib_get_buffer_index (vm, (vlib_buffer_t *) p);
572 bp->buffers[bp->n_avail++] = bi;
574 vlib_get_buffer (vm, bi);
581 format_vlib_buffer_pool (u8 * s, va_list * va)
583 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
584 vlib_buffer_pool_t *bp = va_arg (*va, vlib_buffer_pool_t *);
585 vlib_buffer_pool_thread_t *bpt;
589 return format (s, "%-20s%=6s%=6s%=6s%=11s%=6s%=8s%=8s%=8s",
590 "Pool Name", "Index", "NUMA", "Size", "Data Size",
591 "Total", "Avail", "Cached", "Used");
594 vec_foreach (bpt, bp->threads)
595 cached += bpt->n_cached;
598 s = format (s, "%-20s%=6d%=6d%=6u%=11u%=6u%=8u%=8u%=8u",
599 bp->name, bp->index, bp->numa_node, bp->data_size +
600 sizeof (vlib_buffer_t) + vm->buffer_main->ext_hdr_size,
601 bp->data_size, bp->n_buffers, bp->n_avail, cached,
602 bp->n_buffers - bp->n_avail - cached);
608 format_vlib_buffer_pool_all (u8 *s, va_list *va)
610 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
611 vlib_buffer_main_t *bm = vm->buffer_main;
612 vlib_buffer_pool_t *bp;
614 s = format (s, "%U", format_vlib_buffer_pool, vm, 0);
616 vec_foreach (bp, bm->buffer_pools)
617 s = format (s, "\n%U", format_vlib_buffer_pool, vm, bp);
622 static clib_error_t *
623 show_buffers (vlib_main_t *vm, unformat_input_t *input,
624 vlib_cli_command_t *cmd)
626 vlib_cli_output (vm, "%U", format_vlib_buffer_pool_all, vm);
631 VLIB_CLI_COMMAND (show_buffers_command, static) = {
632 .path = "show buffers",
633 .short_help = "Show packet buffer allocation",
634 .function = show_buffers,
639 vlib_buffer_worker_init (vlib_main_t * vm)
641 vlib_buffer_main_t *bm = vm->buffer_main;
642 vlib_buffer_pool_t *bp;
645 vec_foreach (bp, bm->buffer_pools)
647 clib_spinlock_lock (&bp->lock);
648 vec_validate_aligned (bp->threads, vlib_get_n_threads () - 1,
649 CLIB_CACHE_LINE_BYTES);
650 clib_spinlock_unlock (&bp->lock);
657 VLIB_WORKER_INIT_FUNCTION (vlib_buffer_worker_init);
659 static clib_error_t *
660 vlib_buffer_main_init_numa_alloc (struct vlib_main_t *vm, u32 numa_node,
661 u32 * physmem_map_index,
662 clib_mem_page_sz_t log2_page_size,
665 vlib_buffer_main_t *bm = vm->buffer_main;
666 u32 buffers_per_numa = bm->buffers_per_numa;
669 uword n_pages, pagesize;
672 ASSERT (log2_page_size != CLIB_MEM_PAGE_SZ_UNKNOWN);
674 pagesize = clib_mem_page_bytes (log2_page_size);
675 buffer_size = vlib_buffer_alloc_size (bm->ext_hdr_size,
676 vlib_buffer_get_default_data_size
678 if (buffer_size > pagesize)
679 return clib_error_return (0, "buffer size (%llu) is greater than page "
680 "size (%llu)", buffer_size, pagesize);
682 if (buffers_per_numa == 0)
683 buffers_per_numa = unpriv ? VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV :
684 VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA;
686 name = format (0, "buffers-numa-%d%c", numa_node, 0);
687 n_pages = (buffers_per_numa - 1) / (pagesize / buffer_size) + 1;
688 error = vlib_physmem_shared_map_create (vm, (char *) name,
690 min_log2 (pagesize), numa_node,
696 static clib_error_t *
697 vlib_buffer_main_init_numa_node (struct vlib_main_t *vm, u32 numa_node,
700 vlib_buffer_main_t *bm = vm->buffer_main;
701 u32 physmem_map_index;
705 if (bm->log2_page_size == CLIB_MEM_PAGE_SZ_UNKNOWN)
707 error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
709 CLIB_MEM_PAGE_SZ_DEFAULT_HUGE,
712 goto buffer_pool_create;
714 /* If alloc failed, retry without hugepages */
715 vlib_log_warn (bm->log_default,
716 "numa[%u] falling back to non-hugepage backed "
717 "buffer pool (%U)", numa_node, format_clib_error, error);
718 clib_error_free (error);
720 error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
722 CLIB_MEM_PAGE_SZ_DEFAULT,
726 error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
734 name = format (name, "default-numa-%d%c", numa_node, 0);
735 *index = vlib_buffer_pool_create (vm, (char *) name,
736 vlib_buffer_get_default_data_size (vm),
739 if (*index == (u8) ~ 0)
740 error = clib_error_return (0, "maximum number of buffer pools reached");
748 vlib_buffer_main_alloc (vlib_main_t * vm)
750 vlib_buffer_main_t *bm;
755 vm->buffer_main = bm = clib_mem_alloc (sizeof (bm[0]));
756 clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
757 bm->default_data_size = VLIB_BUFFER_DEFAULT_DATA_SIZE;
761 buffer_get_cached (vlib_buffer_pool_t * bp)
764 vlib_buffer_pool_thread_t *bpt;
766 clib_spinlock_lock (&bp->lock);
769 vec_foreach (bpt, bp->threads)
770 cached += bpt->n_cached;
773 clib_spinlock_unlock (&bp->lock);
778 static vlib_buffer_pool_t *
779 buffer_get_by_index (vlib_buffer_main_t * bm, u32 index)
781 vlib_buffer_pool_t *bp;
782 if (!bm->buffer_pools || vec_len (bm->buffer_pools) < index)
784 bp = vec_elt_at_index (bm->buffer_pools, index);
790 buffer_gauges_collect_used_fn (vlib_stats_collector_data_t *d)
792 vlib_main_t *vm = vlib_get_main ();
793 vlib_buffer_pool_t *bp =
794 buffer_get_by_index (vm->buffer_main, d->private_data);
798 d->entry->value = bp->n_buffers - bp->n_avail - buffer_get_cached (bp);
802 buffer_gauges_collect_available_fn (vlib_stats_collector_data_t *d)
804 vlib_main_t *vm = vlib_get_main ();
805 vlib_buffer_pool_t *bp =
806 buffer_get_by_index (vm->buffer_main, d->private_data);
810 d->entry->value = bp->n_avail;
814 buffer_gauges_collect_cached_fn (vlib_stats_collector_data_t *d)
816 vlib_main_t *vm = vlib_get_main ();
817 vlib_buffer_pool_t *bp =
818 buffer_get_by_index (vm->buffer_main, d->private_data);
822 d->entry->value = buffer_get_cached (bp);
826 vlib_buffer_main_init (struct vlib_main_t * vm)
828 vlib_buffer_main_t *bm;
830 clib_bitmap_t *bmp = 0, *bmp_has_memory = 0;
832 vlib_buffer_pool_t *bp;
833 u8 *name = 0, first_valid_buffer_pool_index = ~0;
835 vlib_buffer_main_alloc (vm);
837 bm = vm->buffer_main;
838 bm->log_default = vlib_log_register_class ("buffer", 0);
839 bm->ext_hdr_size = __vlib_buffer_external_hdr_size;
841 clib_spinlock_init (&bm->buffer_known_hash_lockp);
843 if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
844 unformat_bitmap_list, &bmp)))
845 clib_error_free (err);
847 if ((err = clib_sysfs_read ("/sys/devices/system/node/has_memory", "%U",
848 unformat_bitmap_list, &bmp_has_memory)))
849 clib_error_free (err);
851 if (bmp && bmp_has_memory)
852 bmp = clib_bitmap_and (bmp, bmp_has_memory);
854 /* no info from sysfs, assuming that only numa 0 exists */
856 bmp = clib_bitmap_set (bmp, 0, 1);
858 if (clib_bitmap_last_set (bmp) >= VLIB_BUFFER_MAX_NUMA_NODES)
859 clib_panic ("system have more than %u NUMA nodes",
860 VLIB_BUFFER_MAX_NUMA_NODES);
863 clib_bitmap_foreach (numa_node, bmp)
865 u8 *index = bm->default_buffer_pool_index_for_numa + numa_node;
867 if ((err = vlib_buffer_main_init_numa_node (vm, numa_node, index)))
869 clib_error_report (err);
870 clib_error_free (err);
874 if (first_valid_buffer_pool_index == 0xff)
875 first_valid_buffer_pool_index = index[0];
879 if (first_valid_buffer_pool_index == (u8) ~ 0)
881 err = clib_error_return (0, "failed to allocate buffer pool(s)");
886 clib_bitmap_foreach (numa_node, bmp)
888 if (bm->default_buffer_pool_index_for_numa[numa_node] == (u8) ~0)
889 bm->default_buffer_pool_index_for_numa[numa_node] =
890 first_valid_buffer_pool_index;
894 vec_foreach (bp, bm->buffer_pools)
896 vlib_stats_collector_reg_t reg = { .private_data = bp - bm->buffer_pools };
897 if (bp->n_buffers == 0)
901 vlib_stats_add_gauge ("/buffer-pools/%s/cached", bp->name);
902 reg.collect_fn = buffer_gauges_collect_cached_fn;
903 vlib_stats_register_collector_fn (®);
905 reg.entry_index = vlib_stats_add_gauge ("/buffer-pools/%s/used", bp->name);
906 reg.collect_fn = buffer_gauges_collect_used_fn;
907 vlib_stats_register_collector_fn (®);
910 vlib_stats_add_gauge ("/buffer-pools/%s/available", bp->name);
911 reg.collect_fn = buffer_gauges_collect_available_fn;
912 vlib_stats_register_collector_fn (®);
917 vec_free (bmp_has_memory);
922 static clib_error_t *
923 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
925 vlib_buffer_main_t *bm;
927 vlib_buffer_main_alloc (vm);
929 bm = vm->buffer_main;
930 bm->log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
932 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
934 if (unformat (input, "buffers-per-numa %u", &bm->buffers_per_numa))
936 else if (unformat (input, "page-size %U", unformat_log2_page_size,
937 &bm->log2_page_size))
939 else if (unformat (input, "default data-size %u",
940 &bm->default_data_size))
943 return unformat_parse_error (input);
946 unformat_free (input);
950 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
952 #if VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0
954 vlib_buffer_alloc_may_fail (vlib_main_t * vm, u32 n_buffers)
958 r = random_f64 (&vm->buffer_alloc_success_seed);
960 /* Fail this request? */
961 if (r > vm->buffer_alloc_success_rate)
963 /* 5% chance of returning nothing at all */
964 if (r > vm->buffer_alloc_success_rate && r > 0.95)
972 vlib_buffer_set_alloc_free_callback (
973 vlib_main_t *vm, vlib_buffer_alloc_free_callback_t *alloc_callback_fn,
974 vlib_buffer_alloc_free_callback_t *free_callback_fn)
976 vlib_buffer_main_t *bm = vm->buffer_main;
977 if ((alloc_callback_fn && bm->alloc_callback_fn) ||
978 (free_callback_fn && bm->free_callback_fn))
980 bm->alloc_callback_fn = alloc_callback_fn;
981 bm->free_callback_fn = free_callback_fn;
987 * fd.io coding-style-patch-verification: ON
990 * eval: (c-set-style "gnu")