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 <vlib/vlib.h>
47 #include <vlib/unix/unix.h>
49 vlib_buffer_callbacks_t *vlib_buffer_callbacks = 0;
51 /* when running unpriviledged we are limited by RLIMIT_MEMLOCK which is
52 typically set to 16MB so setting default size for buffer memory to 14MB
54 static u32 vlib_buffer_physmem_sz = 14 << 20;
57 static vlib_log_class_t buffer_log_default;
60 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
61 vlib_buffer_t * b_first)
63 vlib_buffer_t *b = b_first;
64 uword l_first = b_first->current_length;
66 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
68 b = vlib_get_buffer (vm, b->next_buffer);
69 l += b->current_length;
71 b_first->total_length_not_including_first_buffer = l;
72 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
77 format_vlib_buffer (u8 * s, va_list * args)
79 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
80 u32 indent = format_get_indent (s);
83 #define _(bit, name, v) \
84 if (v && (b->flags & VLIB_BUFFER_##name)) \
85 a = format (a, "%s ", v);
86 foreach_vlib_buffer_flag
88 s = format (s, "current data %d, length %d, buffer-pool %d, "
89 "clone-count %u", b->current_data, b->current_length,
90 b->buffer_pool_index, b->n_add_refs);
92 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
93 s = format (s, ", totlen-nifb %d",
94 b->total_length_not_including_first_buffer);
96 if (b->flags & VLIB_BUFFER_IS_TRACED)
97 s = format (s, ", trace 0x%x", b->trace_index);
100 s = format (s, "\n%U%v", format_white_space, indent, a);
103 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
105 vlib_main_t *vm = vlib_get_main ();
106 u32 next_buffer = b->next_buffer;
107 b = vlib_get_buffer (vm, next_buffer);
110 format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
111 format_white_space, indent, next_buffer, b->current_length,
119 format_vlib_buffer_and_data (u8 * s, va_list * args)
121 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
123 s = format (s, "%U, %U",
124 format_vlib_buffer, b,
125 format_hex_bytes, vlib_buffer_get_current (b), 64);
131 format_vlib_buffer_known_state (u8 * s, va_list * args)
133 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
138 case VLIB_BUFFER_UNKNOWN:
142 case VLIB_BUFFER_KNOWN_ALLOCATED:
143 t = "known-allocated";
146 case VLIB_BUFFER_KNOWN_FREE:
155 return format (s, "%s", t);
159 format_vlib_buffer_contents (u8 * s, va_list * va)
161 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
162 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
166 vec_add (s, vlib_buffer_get_current (b), b->current_length);
167 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
169 b = vlib_get_buffer (vm, b->next_buffer);
176 vlib_validate_buffer_helper (vlib_main_t * vm,
178 uword follow_buffer_next, uword ** unique_hash)
180 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
181 vlib_buffer_free_list_t *fl;
183 fl = pool_elt_at_index (vm->buffer_free_list_pool,
184 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
186 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
187 return format (0, "current data %d before pre-data", b->current_data);
189 if (b->current_data + b->current_length > fl->n_data_bytes)
190 return format (0, "%d-%d beyond end of buffer %d",
191 b->current_data, b->current_length, fl->n_data_bytes);
193 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
195 vlib_buffer_known_state_t k;
198 k = vlib_buffer_is_known (vm, b->next_buffer);
199 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
200 return format (0, "next 0x%x: %U",
201 b->next_buffer, format_vlib_buffer_known_state, k);
205 if (hash_get (*unique_hash, b->next_buffer))
206 return format (0, "duplicate buffer 0x%x", b->next_buffer);
208 hash_set1 (*unique_hash, b->next_buffer);
211 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
214 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
224 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
226 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
227 /* unique_hash */ 0);
231 vlib_validate_buffers (vlib_main_t * vm,
233 uword next_buffer_stride,
235 vlib_buffer_known_state_t known_state,
236 uword follow_buffer_next)
239 u32 bi, *b = buffers;
240 vlib_buffer_known_state_t k;
241 u8 *msg = 0, *result = 0;
243 hash = hash_create (0, 0);
244 for (i = 0; i < n_buffers; i++)
247 b += next_buffer_stride;
249 /* Buffer is not unique. */
250 if (hash_get (hash, bi))
252 msg = format (0, "not unique");
256 k = vlib_buffer_is_known (vm, bi);
257 if (k != known_state)
259 msg = format (0, "is %U; expected %U",
260 format_vlib_buffer_known_state, k,
261 format_vlib_buffer_known_state, known_state);
265 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
269 hash_set1 (hash, bi);
275 result = format (0, "0x%x: %v", bi, msg);
283 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
284 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
286 * The only place which should ever expand vlib_mains is start_workers()
287 * in threads.c. It knows about the bootstrap vector.
294 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
295 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
298 .vm = &vlib_global_main,
302 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
305 /* When dubugging validate that given buffers are either known allocated
308 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
311 vlib_buffer_known_state_t expected_state)
314 uword i, bi, is_free;
319 if (vlib_buffer_callbacks)
322 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
324 for (i = 0; i < n_buffers; i++)
326 vlib_buffer_known_state_t known;
330 known = vlib_buffer_is_known (vm, bi);
331 if (known != expected_state)
335 (vm, "%s %U buffer 0x%x",
336 is_free ? "freeing" : "allocating",
337 format_vlib_buffer_known_state, known, bi);
340 vlib_buffer_set_known_state (vm, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
341 VLIB_BUFFER_KNOWN_ALLOCATED);
345 /* Add buffer free list. */
346 static vlib_buffer_free_list_index_t
347 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
349 u32 is_public, u32 is_default, u8 * name)
351 vlib_buffer_main_t *bm = vm->buffer_main;
352 vlib_buffer_free_list_t *f;
355 ASSERT (vlib_get_thread_index () == 0);
357 if (!is_default && pool_elts (vm->buffer_free_list_pool) == 0)
359 vlib_buffer_free_list_index_t default_free_free_list_index;
362 default_free_free_list_index =
363 vlib_buffer_create_free_list_helper
365 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
370 ASSERT (default_free_free_list_index ==
371 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
373 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
374 return default_free_free_list_index;
377 pool_get_aligned (vm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
379 clib_memset (f, 0, sizeof (f[0]));
380 f->index = f - vm->buffer_free_list_pool;
381 vec_validate (f->buffers, 0);
382 vec_reset_length (f->buffers);
383 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
384 f->min_n_buffers_each_alloc = VLIB_FRAME_SIZE;
385 f->buffer_pool_index = 0;
386 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
388 /* Setup free buffer template. */
389 f->buffer_init_template.n_add_refs = 0;
393 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
395 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
398 for (i = 1; i < vec_len (vlib_mains); i++)
400 vlib_main_t *wvm = vlib_mains[i];
401 vlib_buffer_free_list_t *wf;
402 pool_get_aligned (wvm->buffer_free_list_pool,
403 wf, CLIB_CACHE_LINE_BYTES);
404 ASSERT (f - vm->buffer_free_list_pool ==
405 wf - wvm->buffer_free_list_pool);
408 vec_validate (wf->buffers, 0);
409 vec_reset_length (wf->buffers);
416 vlib_buffer_free_list_index_t
417 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
424 name = va_format (0, fmt, &va);
427 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
434 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
436 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (vm, f->buffer_pool_index);
438 vec_add_aligned (bp->buffers, f->buffers, vec_len (f->buffers),
439 CLIB_CACHE_LINE_BYTES);
441 vec_free (f->buffers);
444 clib_memset (f, 0xab, sizeof (f[0]));
447 /* Add buffer free list. */
449 vlib_buffer_delete_free_list_internal (vlib_main_t * vm,
450 vlib_buffer_free_list_index_t index)
452 vlib_buffer_free_list_t *f;
455 ASSERT (vlib_get_thread_index () == 0);
457 f = vlib_buffer_get_free_list (vm, index);
459 ASSERT (vec_len (f->buffers) == f->n_alloc);
461 del_free_list (vm, f);
463 pool_put (vm->buffer_free_list_pool, f);
465 for (i = 1; i < vec_len (vlib_mains); i++)
467 vlib_main_t *wvm = vlib_mains[i];
468 f = vlib_buffer_get_free_list (vlib_mains[i], index);
469 del_free_list (wvm, f);
470 pool_put (wvm->buffer_free_list_pool, f);
474 static_always_inline void *
475 vlib_buffer_pool_get_buffer (vlib_main_t * vm, vlib_buffer_pool_t * bp)
477 return vlib_physmem_alloc_from_map (vm, bp->physmem_map_index,
478 bp->buffer_size, CLIB_CACHE_LINE_BYTES);
481 /* Make sure free list has at least given number of free buffers. */
483 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
484 vlib_buffer_free_list_t * fl,
485 uword min_free_buffers)
488 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (vm, fl->buffer_pool_index);
493 /* Already have enough free buffers on free list? */
494 n = min_free_buffers - vec_len (fl->buffers);
496 return min_free_buffers;
498 if (vec_len (bp->buffers) > 0)
501 clib_spinlock_lock (&bp->lock);
502 n_copy = clib_min (vec_len (bp->buffers), n);
503 n_left = vec_len (bp->buffers) - n_copy;
504 vec_add_aligned (fl->buffers, bp->buffers + n_left, n_copy,
505 CLIB_CACHE_LINE_BYTES);
506 _vec_len (bp->buffers) = n_left;
507 clib_spinlock_unlock (&bp->lock);
508 n = min_free_buffers - vec_len (fl->buffers);
510 return min_free_buffers;
513 /* Always allocate round number of buffers. */
514 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
516 /* Always allocate new buffers in reasonably large sized chunks. */
517 n = clib_max (n, fl->min_n_buffers_each_alloc);
519 clib_spinlock_lock (&bp->lock);
522 if ((b = vlib_buffer_pool_get_buffer (vm, bp)) == 0)
527 vec_add2_aligned (fl->buffers, bi, 1, CLIB_CACHE_LINE_BYTES);
528 bi[0] = vlib_get_buffer_index (vm, b);
531 vlib_buffer_set_known_state (vm, bi[0], VLIB_BUFFER_KNOWN_FREE);
533 clib_memset (b, 0, sizeof (vlib_buffer_t));
535 if (fl->buffer_init_function)
536 fl->buffer_init_function (vm, fl, bi, 1);
540 clib_spinlock_unlock (&bp->lock);
541 fl->n_alloc += n_alloc;
546 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
548 vlib_buffer_main_t *bm = vm->buffer_main;
549 void *rv = bm->buffer_free_callback;
551 bm->buffer_free_callback = fp;
555 static_always_inline void
556 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
557 vlib_buffer_t * b, u32 follow_buffer_next)
559 vlib_buffer_free_list_t *fl;
562 fl = pool_elt_at_index (vm->buffer_free_list_pool,
563 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
567 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
569 next = nb->next_buffer;
574 vlib_buffer_validate_alloc_free (vm, &bi, 1,
575 VLIB_BUFFER_KNOWN_ALLOCATED);
576 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
580 while (follow_buffer_next && (flags & VLIB_BUFFER_NEXT_PRESENT));
583 static_always_inline void
584 vlib_buffer_free_inline (vlib_main_t * vm,
585 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
587 vlib_buffer_main_t *bm = vm->buffer_main;
588 vlib_buffer_t *p, *b0, *b1, *b2, *b3;
590 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
591 u32 follow_buffer_next);
593 cb = bm->buffer_free_callback;
595 if (PREDICT_FALSE (cb != 0))
596 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
601 while (i + 11 < n_buffers)
603 p = vlib_get_buffer (vm, buffers[i + 8]);
604 vlib_prefetch_buffer_header (p, LOAD);
605 p = vlib_get_buffer (vm, buffers[i + 9]);
606 vlib_prefetch_buffer_header (p, LOAD);
607 p = vlib_get_buffer (vm, buffers[i + 10]);
608 vlib_prefetch_buffer_header (p, LOAD);
609 p = vlib_get_buffer (vm, buffers[i + 11]);
610 vlib_prefetch_buffer_header (p, LOAD);
612 b0 = vlib_get_buffer (vm, buffers[i]);
613 b1 = vlib_get_buffer (vm, buffers[i + 1]);
614 b2 = vlib_get_buffer (vm, buffers[i + 2]);
615 b3 = vlib_get_buffer (vm, buffers[i + 3]);
617 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
618 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
619 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
620 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
622 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
623 recycle_or_free (vm, bm, buffers[i + 1], b1, follow_buffer_next);
624 recycle_or_free (vm, bm, buffers[i + 2], b2, follow_buffer_next);
625 recycle_or_free (vm, bm, buffers[i + 3], b3, follow_buffer_next);
630 while (i < n_buffers)
632 b0 = vlib_get_buffer (vm, buffers[i]);
633 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
634 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
640 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
642 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
647 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
650 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
655 vlib_packet_template_init (vlib_main_t * vm,
656 vlib_packet_template_t * t,
658 uword n_packet_data_bytes,
659 uword min_n_buffers_each_alloc, char *fmt, ...)
664 t->name = va_format (0, fmt, &va);
667 vlib_worker_thread_barrier_sync (vm);
669 clib_memset (t, 0, sizeof (t[0]));
671 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
672 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
674 vlib_worker_thread_barrier_release (vm);
678 vlib_packet_template_get_packet (vlib_main_t * vm,
679 vlib_packet_template_t * t, u32 * bi_result)
684 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
689 b = vlib_get_buffer (vm, bi);
690 clib_memcpy_fast (vlib_buffer_get_current (b),
691 t->packet_data, vec_len (t->packet_data));
692 b->current_length = vec_len (t->packet_data);
697 /* Append given data to end of buffer, possibly allocating new buffers. */
699 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
702 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
707 if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
711 n_left = n_data_bytes;
712 n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
714 b = vlib_get_buffer (vm, bi);
715 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
717 /* Get to the end of the chain before we try to append data... */
718 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
719 b = vlib_get_buffer (vm, b->next_buffer);
725 ASSERT (n_buffer_bytes >= b->current_length);
727 n_buffer_bytes - (b->current_data + b->current_length);
728 n = clib_min (n_left_this_buffer, n_left);
729 clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
731 b->current_length += n;
737 if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
740 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
742 b = vlib_get_buffer (vm, b->next_buffer);
749 clib_warning ("out of buffers");
754 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
755 vlib_buffer_free_list_index_t
757 vlib_buffer_t * first,
758 vlib_buffer_t ** last, void *data,
761 vlib_buffer_t *l = *last;
763 vlib_buffer_free_list_buffer_size (vm, free_list_index);
765 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
768 u16 max = n_buffer_bytes - l->current_length - l->current_data;
772 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
775 *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
776 max = n_buffer_bytes - l->current_length - l->current_data;
779 u16 len = (data_len > max) ? max : data_len;
780 clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
782 vlib_buffer_chain_increase_length (first, l, len);
790 vlib_buffer_register_physmem_map (vlib_main_t * vm, u32 physmem_map_index)
792 vlib_buffer_main_t *bm = vm->buffer_main;
793 vlib_buffer_pool_t *p;
794 vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
795 uword start = pointer_to_uword (m->base);
796 uword size = (uword) m->n_pages << m->log2_page_size;
798 if (bm->buffer_mem_size == 0)
800 bm->buffer_mem_start = start;
801 bm->buffer_mem_size = size;
803 else if (start < bm->buffer_mem_start)
805 bm->buffer_mem_size += bm->buffer_mem_start - start;
806 bm->buffer_mem_start = start;
807 if (size > bm->buffer_mem_size)
808 bm->buffer_mem_size = size;
810 else if (start > bm->buffer_mem_start)
812 uword new_size = start - bm->buffer_mem_start + size;
813 if (new_size > bm->buffer_mem_size)
814 bm->buffer_mem_size = new_size;
817 if ((u64) bm->buffer_mem_size >
818 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
820 clib_panic ("buffer memory size out of range!");
823 vec_add2 (bm->buffer_pools, p, 1);
826 p->physmem_map_index = physmem_map_index;
828 ASSERT (p - bm->buffer_pools < 256);
829 return p - bm->buffer_pools;
833 format_vlib_buffer_free_list (u8 * s, va_list * va)
835 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
836 u32 threadnum = va_arg (*va, u32);
837 uword bytes_alloc, bytes_free, n_free, size;
840 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
841 "Thread", "Name", "Index", "Size", "Alloc", "Free",
844 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
845 n_free = vec_len (f->buffers);
846 bytes_alloc = size * f->n_alloc;
847 bytes_free = size * n_free;
849 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
850 f->name, f->index, f->n_data_bytes,
851 format_memory_size, bytes_alloc,
852 format_memory_size, bytes_free, f->n_alloc, n_free);
857 static clib_error_t *
858 show_buffers (vlib_main_t * vm,
859 unformat_input_t * input, vlib_cli_command_t * cmd)
861 vlib_buffer_free_list_t *f;
862 vlib_main_t *curr_vm;
865 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
869 curr_vm = vlib_mains[vm_index];
872 pool_foreach (f, curr_vm->buffer_free_list_pool, ({
873 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
879 while (vm_index < vec_len (vlib_mains));
885 VLIB_CLI_COMMAND (show_buffers_command, static) = {
886 .path = "show buffers",
887 .short_help = "Show packet buffer allocation",
888 .function = show_buffers,
893 vlib_buffer_main_init (struct vlib_main_t * vm)
895 vlib_buffer_main_t *bm;
897 u32 physmem_map_index;
899 int log2_page_size = 0;
901 buffer_log_default = vlib_log_register_class ("buffer", 0);
903 bm = vm->buffer_main = clib_mem_alloc (sizeof (bm[0]));
904 clib_memset (bm, 0, sizeof (bm[0]));
906 if (vlib_buffer_callbacks)
908 /* external plugin has registered own buffer callbacks
909 so we just copy them and quit */
910 clib_memcpy_fast (&bm->cb, vlib_buffer_callbacks,
911 sizeof (vlib_buffer_callbacks_t));
912 bm->callbacks_registered = 1;
916 bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
917 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
918 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
919 bm->cb.vlib_buffer_delete_free_list_cb =
920 &vlib_buffer_delete_free_list_internal;
921 clib_spinlock_init (&bm->buffer_known_hash_lockp);
924 error = vlib_physmem_shared_map_create (vm, "buffers",
925 vlib_buffer_physmem_sz,
927 CLIB_PMALLOC_NUMA_LOCAL,
930 if (error && log2_page_size == 0)
932 vlib_log_warn (buffer_log_default, "%U", format_clib_error, error);
933 clib_error_free (error);
934 vlib_log_warn (buffer_log_default, "falling back to non-hugepage "
935 "backed buffer pool");
936 log2_page_size = min_log2 (clib_mem_get_page_size ());
943 pool_index = vlib_buffer_register_physmem_map (vm, physmem_map_index);
944 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (vm, pool_index);
945 clib_spinlock_init (&bp->lock);
946 bp->buffer_size = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES +
947 sizeof (vlib_buffer_t);
952 static clib_error_t *
953 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
957 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
959 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
960 vlib_buffer_physmem_sz = size_in_mb << 20;
962 return unformat_parse_error (input);
965 unformat_free (input);
969 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
974 * fd.io coding-style-patch-verification: ON
977 * eval: (c-set-style "gnu")