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;
50 static u32 vlib_buffer_physmem_sz = 32 << 20;
53 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
54 vlib_buffer_t * b_first)
56 vlib_buffer_t *b = b_first;
57 uword l_first = b_first->current_length;
59 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
61 b = vlib_get_buffer (vm, b->next_buffer);
62 l += b->current_length;
64 b_first->total_length_not_including_first_buffer = l;
65 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
70 format_vlib_buffer (u8 * s, va_list * args)
72 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
73 u32 indent = format_get_indent (s);
75 s = format (s, "current data %d, length %d, free-list %d, clone-count %u",
76 b->current_data, b->current_length,
77 vlib_buffer_get_free_list_index (b), b->n_add_refs);
79 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
80 s = format (s, ", totlen-nifb %d",
81 b->total_length_not_including_first_buffer);
83 if (b->flags & VLIB_BUFFER_IS_TRACED)
84 s = format (s, ", trace 0x%x", b->trace_index);
86 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
88 vlib_main_t *vm = vlib_get_main ();
89 u32 next_buffer = b->next_buffer;
90 b = vlib_get_buffer (vm, next_buffer);
93 format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
94 format_white_space, indent, next_buffer, b->current_length,
102 format_vlib_buffer_and_data (u8 * s, va_list * args)
104 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
106 s = format (s, "%U, %U",
107 format_vlib_buffer, b,
108 format_hex_bytes, vlib_buffer_get_current (b), 64);
114 format_vlib_buffer_known_state (u8 * s, va_list * args)
116 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
121 case VLIB_BUFFER_UNKNOWN:
125 case VLIB_BUFFER_KNOWN_ALLOCATED:
126 t = "known-allocated";
129 case VLIB_BUFFER_KNOWN_FREE:
138 return format (s, "%s", t);
142 format_vlib_buffer_contents (u8 * s, va_list * va)
144 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
145 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
149 vec_add (s, vlib_buffer_get_current (b), b->current_length);
150 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
152 b = vlib_get_buffer (vm, b->next_buffer);
159 vlib_validate_buffer_helper (vlib_main_t * vm,
161 uword follow_buffer_next, uword ** unique_hash)
163 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
164 vlib_buffer_main_t *bm = vm->buffer_main;
165 vlib_buffer_free_list_t *fl;
167 if (pool_is_free_index
168 (bm->buffer_free_list_pool, vlib_buffer_get_free_list_index (b)))
169 return format (0, "unknown free list 0x%x",
170 vlib_buffer_get_free_list_index (b));
173 pool_elt_at_index (bm->buffer_free_list_pool,
174 vlib_buffer_get_free_list_index (b));
176 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
177 return format (0, "current data %d before pre-data", b->current_data);
179 if (b->current_data + b->current_length > fl->n_data_bytes)
180 return format (0, "%d-%d beyond end of buffer %d",
181 b->current_data, b->current_length, fl->n_data_bytes);
183 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
185 vlib_buffer_known_state_t k;
188 k = vlib_buffer_is_known (b->next_buffer);
189 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
190 return format (0, "next 0x%x: %U",
191 b->next_buffer, format_vlib_buffer_known_state, k);
195 if (hash_get (*unique_hash, b->next_buffer))
196 return format (0, "duplicate buffer 0x%x", b->next_buffer);
198 hash_set1 (*unique_hash, b->next_buffer);
201 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
204 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
214 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
216 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
217 /* unique_hash */ 0);
221 vlib_validate_buffers (vlib_main_t * vm,
223 uword next_buffer_stride,
225 vlib_buffer_known_state_t known_state,
226 uword follow_buffer_next)
229 u32 bi, *b = buffers;
230 vlib_buffer_known_state_t k;
231 u8 *msg = 0, *result = 0;
233 hash = hash_create (0, 0);
234 for (i = 0; i < n_buffers; i++)
237 b += next_buffer_stride;
239 /* Buffer is not unique. */
240 if (hash_get (hash, bi))
242 msg = format (0, "not unique");
246 k = vlib_buffer_is_known (bi);
247 if (k != known_state)
249 msg = format (0, "is %U; expected %U",
250 format_vlib_buffer_known_state, k,
251 format_vlib_buffer_known_state, known_state);
255 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
259 hash_set1 (hash, bi);
265 result = format (0, "0x%x: %v", bi, msg);
273 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
274 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
276 * The only place which should ever expand vlib_mains is start_workers()
277 * in threads.c. It knows about the bootstrap vector.
284 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
285 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
288 .vm = &vlib_global_main,
292 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
295 /* When dubugging validate that given buffers are either known allocated
298 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
301 vlib_buffer_known_state_t expected_state)
304 uword i, bi, is_free;
309 if (vlib_buffer_callbacks)
312 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
314 for (i = 0; i < n_buffers; i++)
316 vlib_buffer_known_state_t known;
320 known = vlib_buffer_is_known (bi);
321 if (known != expected_state)
325 (vm, "%s %U buffer 0x%x",
326 is_free ? "freeing" : "allocating",
327 format_vlib_buffer_known_state, known, bi);
330 vlib_buffer_set_known_state
331 (bi, is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
336 vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
337 vlib_buffer_free_list_t * src)
342 l = vec_len (src->buffers);
345 vec_add2_aligned (dst->buffers, d, l, CLIB_CACHE_LINE_BYTES);
346 clib_memcpy (d, src->buffers, l * sizeof (d[0]));
347 vec_free (src->buffers);
351 /* Add buffer free list. */
353 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
355 u32 is_public, u32 is_default, u8 * name)
357 vlib_buffer_main_t *bm = vm->buffer_main;
358 vlib_buffer_free_list_t *f;
361 ASSERT (vlib_get_thread_index () == 0);
363 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
365 u32 default_free_free_list_index;
368 default_free_free_list_index =
369 vlib_buffer_create_free_list_helper
371 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
376 ASSERT (default_free_free_list_index ==
377 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
379 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
380 return default_free_free_list_index;
383 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
385 memset (f, 0, sizeof (f[0]));
386 f->index = f - bm->buffer_free_list_pool;
387 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
388 f->min_n_buffers_each_physmem_alloc = VLIB_FRAME_SIZE;
389 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
391 /* Setup free buffer template. */
392 vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
393 f->buffer_init_template.n_add_refs = 0;
397 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
399 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
402 clib_spinlock_init (&f->global_buffers_lock);
404 for (i = 1; i < vec_len (vlib_mains); i++)
406 vlib_buffer_main_t *wbm = vlib_mains[i]->buffer_main;
407 vlib_buffer_free_list_t *wf;
408 pool_get_aligned (wbm->buffer_free_list_pool,
409 wf, CLIB_CACHE_LINE_BYTES);
410 ASSERT (f - bm->buffer_free_list_pool ==
411 wf - wbm->buffer_free_list_pool);
421 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
428 name = va_format (0, fmt, &va);
431 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
438 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
441 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
449 name = va_format (0, fmt, &va);
452 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
462 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
466 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
467 vm->os_physmem_free (vm, vm->buffer_main->buffer_pools[0].physmem_region,
468 f->buffer_memory_allocated[i]);
470 vec_free (f->buffer_memory_allocated);
471 vec_free (f->buffers);
474 /* Add buffer free list. */
476 vlib_buffer_delete_free_list_internal (vlib_main_t * vm, u32 free_list_index)
478 vlib_buffer_main_t *bm = vm->buffer_main;
479 vlib_buffer_free_list_t *f;
483 ASSERT (vlib_get_thread_index () == 0);
485 f = vlib_buffer_get_free_list (vm, free_list_index);
487 ASSERT (vec_len (f->buffers) == f->n_alloc);
488 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
489 if (merge_index != ~0 && merge_index != free_list_index)
491 vlib_buffer_merge_free_lists (pool_elt_at_index
492 (bm->buffer_free_list_pool, merge_index),
496 del_free_list (vm, f);
499 memset (f, 0xab, sizeof (f[0]));
501 pool_put (bm->buffer_free_list_pool, f);
503 for (i = 1; i < vec_len (vlib_mains); i++)
505 bm = vlib_mains[i]->buffer_main;
506 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
507 memset (f, 0xab, sizeof (f[0]));
508 pool_put (bm->buffer_free_list_pool, f);
512 /* Make sure free list has at least given number of free buffers. */
514 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
515 vlib_buffer_free_list_t * fl,
516 uword min_free_buffers)
518 vlib_buffer_t *buffers, *b;
519 vlib_buffer_free_list_t *mfl;
522 u32 n_remaining, n_alloc, n_this_chunk;
524 /* Already have enough free buffers on free list? */
525 n = min_free_buffers - vec_len (fl->buffers);
527 return min_free_buffers;
529 mfl = vlib_buffer_get_free_list (vlib_mains[0], fl->index);
530 if (vec_len (mfl->global_buffers) > 0)
533 clib_spinlock_lock (&mfl->global_buffers_lock);
534 n_copy = clib_min (vec_len (mfl->global_buffers), n);
535 n_left = vec_len (mfl->global_buffers) - n_copy;
536 vec_add_aligned (fl->buffers, mfl->global_buffers + n_left, n_copy,
537 CLIB_CACHE_LINE_BYTES);
538 _vec_len (mfl->global_buffers) = n_left;
539 clib_spinlock_unlock (&mfl->global_buffers_lock);
540 n = min_free_buffers - vec_len (fl->buffers);
542 return min_free_buffers;
545 /* Always allocate round number of buffers. */
546 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
548 /* Always allocate new buffers in reasonably large sized chunks. */
549 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
553 while (n_remaining > 0)
555 n_this_chunk = clib_min (n_remaining, 16);
557 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
559 /* drb: removed power-of-2 ASSERT */
561 vm->os_physmem_alloc_aligned (vm,
563 buffer_pools[0].physmem_region, n_bytes,
564 sizeof (vlib_buffer_t));
568 /* Record chunk as being allocated so we can free it later. */
569 vec_add1 (fl->buffer_memory_allocated, buffers);
571 fl->n_alloc += n_this_chunk;
572 n_alloc += n_this_chunk;
573 n_remaining -= n_this_chunk;
576 vec_add2_aligned (fl->buffers, bi, n_this_chunk, CLIB_CACHE_LINE_BYTES);
577 for (i = 0; i < n_this_chunk; i++)
579 bi[i] = vlib_get_buffer_index (vm, b);
582 vlib_buffer_set_known_state (bi[i], VLIB_BUFFER_KNOWN_FREE);
583 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
586 memset (buffers, 0, n_bytes);
588 /* Initialize all new buffers. */
590 for (i = 0; i < n_this_chunk; i++)
592 vlib_buffer_init_for_free_list (b, fl);
593 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
596 if (fl->buffer_init_function)
597 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
603 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
605 vlib_buffer_main_t *bm = vm->buffer_main;
606 void *rv = bm->buffer_free_callback;
608 bm->buffer_free_callback = fp;
612 static_always_inline void
613 vlib_buffer_free_inline (vlib_main_t * vm,
614 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
616 vlib_buffer_main_t *bm = vm->buffer_main;
617 vlib_buffer_free_list_t *fl;
620 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
621 u32 follow_buffer_next);
623 cb = bm->buffer_free_callback;
625 if (PREDICT_FALSE (cb != 0))
626 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
631 for (i = 0; i < n_buffers; i++)
636 b = vlib_get_buffer (vm, bi);
637 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
638 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
640 /* The only current use of this callback: multicast recycle */
641 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
645 vlib_buffer_add_to_free_list
646 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
648 for (j = 0; j < vec_len (bm->announce_list); j++)
650 if (fl == bm->announce_list[j])
651 goto already_announced;
653 vec_add1 (bm->announce_list, fl);
659 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
665 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
667 next = nb->next_buffer;
672 vlib_buffer_validate_alloc_free (vm, &bi, 1,
673 VLIB_BUFFER_KNOWN_ALLOCATED);
674 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
678 while (follow_buffer_next
679 && (flags & VLIB_BUFFER_NEXT_PRESENT));
684 if (vec_len (bm->announce_list))
686 vlib_buffer_free_list_t *fl;
687 for (i = 0; i < vec_len (bm->announce_list); i++)
689 fl = bm->announce_list[i];
690 fl->buffers_added_to_freelist_function (vm, fl);
692 _vec_len (bm->announce_list) = 0;
697 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
699 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
704 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
707 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
711 /* Copy template packet data into buffers as they are allocated. */
712 static void __attribute__ ((unused))
713 vlib_packet_template_buffer_init (vlib_main_t * vm,
714 vlib_buffer_free_list_t * fl,
715 u32 * buffers, u32 n_buffers)
717 vlib_packet_template_t *t =
718 uword_to_pointer (fl->buffer_init_function_opaque,
719 vlib_packet_template_t *);
722 for (i = 0; i < n_buffers; i++)
724 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
725 ASSERT (b->current_length == vec_len (t->packet_data));
726 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
732 vlib_packet_template_init (vlib_main_t * vm,
733 vlib_packet_template_t * t,
735 uword n_packet_data_bytes,
736 uword min_n_buffers_each_physmem_alloc,
739 vlib_buffer_main_t *bm = vm->buffer_main;
742 vlib_buffer_free_list_t *fl;
745 name = va_format (0, fmt, &va);
748 if (bm->cb.vlib_packet_template_init_cb)
749 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
751 min_n_buffers_each_physmem_alloc,
754 vlib_worker_thread_barrier_sync (vm);
756 memset (t, 0, sizeof (t[0]));
758 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
759 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
761 t->free_list_index = vlib_buffer_create_free_list_helper
762 (vm, n_packet_data_bytes,
767 ASSERT (t->free_list_index != 0);
768 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
769 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
771 fl->buffer_init_function = vlib_packet_template_buffer_init;
772 fl->buffer_init_function_opaque = pointer_to_uword (t);
774 fl->buffer_init_template.current_data = 0;
775 fl->buffer_init_template.current_length = n_packet_data_bytes;
776 fl->buffer_init_template.flags = 0;
777 fl->buffer_init_template.n_add_refs = 0;
778 vlib_worker_thread_barrier_release (vm);
782 vlib_packet_template_get_packet (vlib_main_t * vm,
783 vlib_packet_template_t * t, u32 * bi_result)
788 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
793 b = vlib_get_buffer (vm, bi);
794 clib_memcpy (vlib_buffer_get_current (b),
795 t->packet_data, vec_len (t->packet_data));
796 b->current_length = vec_len (t->packet_data);
802 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
803 vlib_packet_template_t * t)
805 word n = t->min_n_buffers_each_physmem_alloc;
806 word l = vec_len (t->packet_data);
810 ASSERT (vec_len (t->free_buffers) == 0);
812 vec_validate (t->free_buffers, n - 1);
813 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
814 n, t->free_list_index);
815 _vec_len (t->free_buffers) = n_alloc;
818 /* Append given data to end of buffer, possibly allocating new buffers. */
820 vlib_buffer_add_data (vlib_main_t * vm,
822 u32 buffer_index, void *data, u32 n_data_bytes)
824 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
830 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
834 n_left = n_data_bytes;
835 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
837 b = vlib_get_buffer (vm, bi);
838 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
840 /* Get to the end of the chain before we try to append data... */
841 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
842 b = vlib_get_buffer (vm, b->next_buffer);
848 ASSERT (n_buffer_bytes >= b->current_length);
850 n_buffer_bytes - (b->current_data + b->current_length);
851 n = clib_min (n_left_this_buffer, n_left);
852 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
853 b->current_length += n;
860 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
864 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
866 b = vlib_get_buffer (vm, b->next_buffer);
872 clib_error ("out of buffers");
877 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
879 vlib_buffer_t * first,
880 vlib_buffer_t ** last,
881 void *data, u16 data_len)
883 vlib_buffer_t *l = *last;
885 vlib_buffer_free_list_buffer_size (vm, free_list_index);
887 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
890 u16 max = n_buffer_bytes - l->current_length - l->current_data;
894 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
897 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
898 max = n_buffer_bytes - l->current_length - l->current_data;
901 u16 len = (data_len > max) ? max : data_len;
902 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
904 vlib_buffer_chain_increase_length (first, l, len);
912 vlib_buffer_add_physmem_region (vlib_main_t * vm,
913 vlib_physmem_region_index_t pri)
915 vlib_buffer_main_t *bm = vm->buffer_main;
916 vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, pri);
917 vlib_buffer_pool_t *p;
918 uword start = pointer_to_uword (pr->mem);
919 uword size = pr->size;
921 if (bm->buffer_mem_size == 0)
923 bm->buffer_mem_start = start;
924 bm->buffer_mem_size = size;
926 else if (start < bm->buffer_mem_start)
928 bm->buffer_mem_size += bm->buffer_mem_start - start;
929 bm->buffer_mem_start = start;
930 if (size > bm->buffer_mem_size)
931 bm->buffer_mem_size = size;
933 else if (start > bm->buffer_mem_start)
935 uword new_size = start - bm->buffer_mem_start + size;
936 if (new_size > bm->buffer_mem_size)
937 bm->buffer_mem_size = new_size;
940 if ((u64) bm->buffer_mem_size >
941 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
943 clib_panic ("buffer memory size out of range!");
946 vec_add2 (bm->buffer_pools, p, 1);
949 p->physmem_region = pri;
950 return p - bm->buffer_pools;
954 format_vlib_buffer_free_list (u8 * s, va_list * va)
956 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
957 u32 threadnum = va_arg (*va, u32);
958 uword bytes_alloc, bytes_free, n_free, size;
961 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
962 "Thread", "Name", "Index", "Size", "Alloc", "Free",
965 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
966 n_free = vec_len (f->buffers);
967 bytes_alloc = size * f->n_alloc;
968 bytes_free = size * n_free;
970 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
971 f->name, f->index, f->n_data_bytes,
972 format_memory_size, bytes_alloc,
973 format_memory_size, bytes_free, f->n_alloc, n_free);
978 static clib_error_t *
979 show_buffers (vlib_main_t * vm,
980 unformat_input_t * input, vlib_cli_command_t * cmd)
982 vlib_buffer_main_t *bm;
983 vlib_buffer_free_list_t *f;
984 vlib_main_t *curr_vm;
987 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
991 curr_vm = vlib_mains[vm_index];
992 bm = curr_vm->buffer_main;
995 pool_foreach (f, bm->buffer_free_list_pool, ({
996 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1002 while (vm_index < vec_len (vlib_mains));
1008 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1009 .path = "show buffers",
1010 .short_help = "Show packet buffer allocation",
1011 .function = show_buffers,
1016 vlib_buffer_main_init (struct vlib_main_t * vm)
1018 vlib_buffer_main_t *bm;
1019 vlib_physmem_region_index_t pri;
1020 clib_error_t *error;
1022 vec_validate (vm->buffer_main, 0);
1023 bm = vm->buffer_main;
1025 if (vlib_buffer_callbacks)
1027 /* external plugin has registered own buffer callbacks
1028 so we just copy them and quit */
1029 vlib_buffer_main_t *bm = vm->buffer_main;
1030 clib_memcpy (&bm->cb, vlib_buffer_callbacks,
1031 sizeof (vlib_buffer_callbacks_t));
1032 bm->callbacks_registered = 1;
1036 bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
1037 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
1038 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
1039 bm->cb.vlib_buffer_delete_free_list_cb =
1040 &vlib_buffer_delete_free_list_internal;
1041 clib_spinlock_init (&bm->buffer_known_hash_lockp);
1043 /* allocate default region */
1044 error = vlib_physmem_region_alloc (vm, "buffers",
1045 vlib_buffer_physmem_sz, 0,
1046 VLIB_PHYSMEM_F_INIT_MHEAP, &pri);
1051 clib_error_free (error);
1053 /* we my be running unpriviledged, so try to allocate fake physmem */
1054 error = vlib_physmem_region_alloc (vm, "buffers (fake)",
1055 vlib_buffer_physmem_sz, 0,
1056 VLIB_PHYSMEM_F_FAKE |
1057 VLIB_PHYSMEM_F_INIT_MHEAP, &pri);
1059 vlib_buffer_add_physmem_region (vm, pri);
1063 static clib_error_t *
1064 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1068 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1070 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1071 vlib_buffer_physmem_sz = size_in_mb << 20;
1073 return unformat_parse_error (input);
1076 unformat_free (input);
1080 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1085 * fd.io coding-style-patch-verification: ON
1088 * eval: (c-set-style "gnu")