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 (vm, 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 (vm, 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 (vm, 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
332 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
337 vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
338 vlib_buffer_free_list_t * src)
343 l = vec_len (src->buffers);
346 vec_add2_aligned (dst->buffers, d, l, CLIB_CACHE_LINE_BYTES);
347 clib_memcpy (d, src->buffers, l * sizeof (d[0]));
348 vec_free (src->buffers);
352 /* Add buffer free list. */
354 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
356 u32 is_public, u32 is_default, u8 * name)
358 vlib_buffer_main_t *bm = vm->buffer_main;
359 vlib_buffer_free_list_t *f;
362 ASSERT (vlib_get_thread_index () == 0);
364 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
366 u32 default_free_free_list_index;
369 default_free_free_list_index =
370 vlib_buffer_create_free_list_helper
372 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
377 ASSERT (default_free_free_list_index ==
378 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
380 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
381 return default_free_free_list_index;
384 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
386 memset (f, 0, sizeof (f[0]));
387 f->index = f - bm->buffer_free_list_pool;
388 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
389 f->min_n_buffers_each_physmem_alloc = VLIB_FRAME_SIZE;
390 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
392 /* Setup free buffer template. */
393 vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
394 f->buffer_init_template.n_add_refs = 0;
398 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
400 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
403 clib_spinlock_init (&f->global_buffers_lock);
405 for (i = 1; i < vec_len (vlib_mains); i++)
407 vlib_buffer_main_t *wbm = vlib_mains[i]->buffer_main;
408 vlib_buffer_free_list_t *wf;
409 pool_get_aligned (wbm->buffer_free_list_pool,
410 wf, CLIB_CACHE_LINE_BYTES);
411 ASSERT (f - bm->buffer_free_list_pool ==
412 wf - wbm->buffer_free_list_pool);
422 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
429 name = va_format (0, fmt, &va);
432 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
439 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
442 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
450 name = va_format (0, fmt, &va);
453 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
463 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
467 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
468 vm->os_physmem_free (vm, vm->buffer_main->buffer_pools[0].physmem_region,
469 f->buffer_memory_allocated[i]);
471 vec_free (f->buffer_memory_allocated);
472 vec_free (f->buffers);
475 /* Add buffer free list. */
477 vlib_buffer_delete_free_list_internal (vlib_main_t * vm, u32 free_list_index)
479 vlib_buffer_main_t *bm = vm->buffer_main;
480 vlib_buffer_free_list_t *f;
484 ASSERT (vlib_get_thread_index () == 0);
486 f = vlib_buffer_get_free_list (vm, free_list_index);
488 ASSERT (vec_len (f->buffers) == f->n_alloc);
489 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
490 if (merge_index != ~0 && merge_index != free_list_index)
492 vlib_buffer_merge_free_lists (pool_elt_at_index
493 (bm->buffer_free_list_pool, merge_index),
497 del_free_list (vm, f);
500 memset (f, 0xab, sizeof (f[0]));
502 pool_put (bm->buffer_free_list_pool, f);
504 for (i = 1; i < vec_len (vlib_mains); i++)
506 bm = vlib_mains[i]->buffer_main;
507 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
508 memset (f, 0xab, sizeof (f[0]));
509 pool_put (bm->buffer_free_list_pool, f);
513 /* Make sure free list has at least given number of free buffers. */
515 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
516 vlib_buffer_free_list_t * fl,
517 uword min_free_buffers)
519 vlib_buffer_t *buffers, *b;
520 vlib_buffer_free_list_t *mfl;
523 u32 n_remaining, n_alloc, n_this_chunk;
525 /* Already have enough free buffers on free list? */
526 n = min_free_buffers - vec_len (fl->buffers);
528 return min_free_buffers;
530 mfl = vlib_buffer_get_free_list (vlib_mains[0], fl->index);
531 if (vec_len (mfl->global_buffers) > 0)
534 clib_spinlock_lock (&mfl->global_buffers_lock);
535 n_copy = clib_min (vec_len (mfl->global_buffers), n);
536 n_left = vec_len (mfl->global_buffers) - n_copy;
537 vec_add_aligned (fl->buffers, mfl->global_buffers + n_left, n_copy,
538 CLIB_CACHE_LINE_BYTES);
539 _vec_len (mfl->global_buffers) = n_left;
540 clib_spinlock_unlock (&mfl->global_buffers_lock);
541 n = min_free_buffers - vec_len (fl->buffers);
543 return min_free_buffers;
546 /* Always allocate round number of buffers. */
547 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
549 /* Always allocate new buffers in reasonably large sized chunks. */
550 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
554 while (n_remaining > 0)
556 n_this_chunk = clib_min (n_remaining, 16);
558 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
560 /* drb: removed power-of-2 ASSERT */
562 vm->os_physmem_alloc_aligned (vm,
564 buffer_pools[0].physmem_region, n_bytes,
565 sizeof (vlib_buffer_t));
569 /* Record chunk as being allocated so we can free it later. */
570 vec_add1 (fl->buffer_memory_allocated, buffers);
572 fl->n_alloc += n_this_chunk;
573 n_alloc += n_this_chunk;
574 n_remaining -= n_this_chunk;
577 vec_add2_aligned (fl->buffers, bi, n_this_chunk, CLIB_CACHE_LINE_BYTES);
578 for (i = 0; i < n_this_chunk; i++)
580 bi[i] = vlib_get_buffer_index (vm, b);
583 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
584 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
587 memset (buffers, 0, n_bytes);
589 /* Initialize all new buffers. */
591 for (i = 0; i < n_this_chunk; i++)
593 vlib_buffer_init_for_free_list (b, fl);
594 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
597 if (fl->buffer_init_function)
598 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
604 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
606 vlib_buffer_main_t *bm = vm->buffer_main;
607 void *rv = bm->buffer_free_callback;
609 bm->buffer_free_callback = fp;
613 static_always_inline void
614 vlib_buffer_free_inline (vlib_main_t * vm,
615 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
617 vlib_buffer_main_t *bm = vm->buffer_main;
618 vlib_buffer_free_list_t *fl;
621 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
622 u32 follow_buffer_next);
624 cb = bm->buffer_free_callback;
626 if (PREDICT_FALSE (cb != 0))
627 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
632 for (i = 0; i < n_buffers; i++)
637 b = vlib_get_buffer (vm, bi);
638 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
639 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
641 /* The only current use of this callback: multicast recycle */
642 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
646 vlib_buffer_add_to_free_list
647 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
649 for (j = 0; j < vec_len (bm->announce_list); j++)
651 if (fl == bm->announce_list[j])
652 goto already_announced;
654 vec_add1 (bm->announce_list, fl);
660 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
666 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
668 next = nb->next_buffer;
673 vlib_buffer_validate_alloc_free (vm, &bi, 1,
674 VLIB_BUFFER_KNOWN_ALLOCATED);
675 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
679 while (follow_buffer_next
680 && (flags & VLIB_BUFFER_NEXT_PRESENT));
685 if (vec_len (bm->announce_list))
687 vlib_buffer_free_list_t *fl;
688 for (i = 0; i < vec_len (bm->announce_list); i++)
690 fl = bm->announce_list[i];
691 fl->buffers_added_to_freelist_function (vm, fl);
693 _vec_len (bm->announce_list) = 0;
698 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
700 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
705 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
708 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
712 /* Copy template packet data into buffers as they are allocated. */
713 static void __attribute__ ((unused))
714 vlib_packet_template_buffer_init (vlib_main_t * vm,
715 vlib_buffer_free_list_t * fl,
716 u32 * buffers, u32 n_buffers)
718 vlib_packet_template_t *t =
719 uword_to_pointer (fl->buffer_init_function_opaque,
720 vlib_packet_template_t *);
723 for (i = 0; i < n_buffers; i++)
725 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
726 ASSERT (b->current_length == vec_len (t->packet_data));
727 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
733 vlib_packet_template_init (vlib_main_t * vm,
734 vlib_packet_template_t * t,
736 uword n_packet_data_bytes,
737 uword min_n_buffers_each_physmem_alloc,
740 vlib_buffer_main_t *bm = vm->buffer_main;
743 vlib_buffer_free_list_t *fl;
746 name = va_format (0, fmt, &va);
749 if (bm->cb.vlib_packet_template_init_cb)
750 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
752 min_n_buffers_each_physmem_alloc,
755 vlib_worker_thread_barrier_sync (vm);
757 memset (t, 0, sizeof (t[0]));
759 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
760 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
762 t->free_list_index = vlib_buffer_create_free_list_helper
763 (vm, n_packet_data_bytes,
768 ASSERT (t->free_list_index != 0);
769 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
770 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
772 fl->buffer_init_function = vlib_packet_template_buffer_init;
773 fl->buffer_init_function_opaque = pointer_to_uword (t);
775 fl->buffer_init_template.current_data = 0;
776 fl->buffer_init_template.current_length = n_packet_data_bytes;
777 fl->buffer_init_template.flags = 0;
778 fl->buffer_init_template.n_add_refs = 0;
779 vlib_worker_thread_barrier_release (vm);
783 vlib_packet_template_get_packet (vlib_main_t * vm,
784 vlib_packet_template_t * t, u32 * bi_result)
789 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
794 b = vlib_get_buffer (vm, bi);
795 clib_memcpy (vlib_buffer_get_current (b),
796 t->packet_data, vec_len (t->packet_data));
797 b->current_length = vec_len (t->packet_data);
803 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
804 vlib_packet_template_t * t)
806 word n = t->min_n_buffers_each_physmem_alloc;
807 word l = vec_len (t->packet_data);
811 ASSERT (vec_len (t->free_buffers) == 0);
813 vec_validate (t->free_buffers, n - 1);
814 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
815 n, t->free_list_index);
816 _vec_len (t->free_buffers) = n_alloc;
819 /* Append given data to end of buffer, possibly allocating new buffers. */
821 vlib_buffer_add_data (vlib_main_t * vm,
823 u32 buffer_index, void *data, u32 n_data_bytes)
825 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
831 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
835 n_left = n_data_bytes;
836 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
838 b = vlib_get_buffer (vm, bi);
839 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
841 /* Get to the end of the chain before we try to append data... */
842 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
843 b = vlib_get_buffer (vm, b->next_buffer);
849 ASSERT (n_buffer_bytes >= b->current_length);
851 n_buffer_bytes - (b->current_data + b->current_length);
852 n = clib_min (n_left_this_buffer, n_left);
853 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
854 b->current_length += n;
861 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
865 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
867 b = vlib_get_buffer (vm, b->next_buffer);
873 clib_error ("out of buffers");
878 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
880 vlib_buffer_t * first,
881 vlib_buffer_t ** last,
882 void *data, u16 data_len)
884 vlib_buffer_t *l = *last;
886 vlib_buffer_free_list_buffer_size (vm, free_list_index);
888 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
891 u16 max = n_buffer_bytes - l->current_length - l->current_data;
895 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
898 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
899 max = n_buffer_bytes - l->current_length - l->current_data;
902 u16 len = (data_len > max) ? max : data_len;
903 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
905 vlib_buffer_chain_increase_length (first, l, len);
913 vlib_buffer_add_physmem_region (vlib_main_t * vm,
914 vlib_physmem_region_index_t pri)
916 vlib_buffer_main_t *bm = vm->buffer_main;
917 vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, pri);
918 vlib_buffer_pool_t *p;
919 uword start = pointer_to_uword (pr->mem);
920 uword size = pr->size;
922 if (bm->buffer_mem_size == 0)
924 bm->buffer_mem_start = start;
925 bm->buffer_mem_size = size;
927 else if (start < bm->buffer_mem_start)
929 bm->buffer_mem_size += bm->buffer_mem_start - start;
930 bm->buffer_mem_start = start;
931 if (size > bm->buffer_mem_size)
932 bm->buffer_mem_size = size;
934 else if (start > bm->buffer_mem_start)
936 uword new_size = start - bm->buffer_mem_start + size;
937 if (new_size > bm->buffer_mem_size)
938 bm->buffer_mem_size = new_size;
941 if ((u64) bm->buffer_mem_size >
942 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
944 clib_panic ("buffer memory size out of range!");
947 vec_add2 (bm->buffer_pools, p, 1);
950 p->physmem_region = pri;
951 return p - bm->buffer_pools;
955 format_vlib_buffer_free_list (u8 * s, va_list * va)
957 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
958 u32 threadnum = va_arg (*va, u32);
959 uword bytes_alloc, bytes_free, n_free, size;
962 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
963 "Thread", "Name", "Index", "Size", "Alloc", "Free",
966 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
967 n_free = vec_len (f->buffers);
968 bytes_alloc = size * f->n_alloc;
969 bytes_free = size * n_free;
971 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
972 f->name, f->index, f->n_data_bytes,
973 format_memory_size, bytes_alloc,
974 format_memory_size, bytes_free, f->n_alloc, n_free);
979 static clib_error_t *
980 show_buffers (vlib_main_t * vm,
981 unformat_input_t * input, vlib_cli_command_t * cmd)
983 vlib_buffer_main_t *bm;
984 vlib_buffer_free_list_t *f;
985 vlib_main_t *curr_vm;
988 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
992 curr_vm = vlib_mains[vm_index];
993 bm = curr_vm->buffer_main;
996 pool_foreach (f, bm->buffer_free_list_pool, ({
997 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1003 while (vm_index < vec_len (vlib_mains));
1009 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1010 .path = "show buffers",
1011 .short_help = "Show packet buffer allocation",
1012 .function = show_buffers,
1017 vlib_buffer_main_init (struct vlib_main_t * vm)
1019 vlib_buffer_main_t *bm;
1020 vlib_physmem_region_index_t pri;
1021 clib_error_t *error;
1023 vec_validate (vm->buffer_main, 0);
1024 bm = vm->buffer_main;
1026 if (vlib_buffer_callbacks)
1028 /* external plugin has registered own buffer callbacks
1029 so we just copy them and quit */
1030 vlib_buffer_main_t *bm = vm->buffer_main;
1031 clib_memcpy (&bm->cb, vlib_buffer_callbacks,
1032 sizeof (vlib_buffer_callbacks_t));
1033 bm->callbacks_registered = 1;
1037 bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
1038 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
1039 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
1040 bm->cb.vlib_buffer_delete_free_list_cb =
1041 &vlib_buffer_delete_free_list_internal;
1042 clib_spinlock_init (&bm->buffer_known_hash_lockp);
1044 /* allocate default region */
1045 error = vlib_physmem_region_alloc (vm, "buffers",
1046 vlib_buffer_physmem_sz, 0,
1047 VLIB_PHYSMEM_F_INIT_MHEAP, &pri);
1052 clib_error_free (error);
1054 /* we my be running unpriviledged, so try to allocate fake physmem */
1055 error = vlib_physmem_region_alloc (vm, "buffers (fake)",
1056 vlib_buffer_physmem_sz, 0,
1057 VLIB_PHYSMEM_F_FAKE |
1058 VLIB_PHYSMEM_F_INIT_MHEAP, &pri);
1060 vlib_buffer_add_physmem_region (vm, pri);
1064 static clib_error_t *
1065 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1069 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1071 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1072 vlib_buffer_physmem_sz = size_in_mb << 20;
1074 return unformat_parse_error (input);
1077 unformat_free (input);
1081 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1086 * fd.io coding-style-patch-verification: ON
1089 * eval: (c-set-style "gnu")