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 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
311 for (i = 0; i < n_buffers; i++)
313 vlib_buffer_known_state_t known;
317 known = vlib_buffer_is_known (vm, bi);
318 if (known != expected_state)
322 (vm, "%s %U buffer 0x%x",
323 is_free ? "freeing" : "allocating",
324 format_vlib_buffer_known_state, known, bi);
327 vlib_buffer_set_known_state
329 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
334 vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
335 vlib_buffer_free_list_t * src)
340 l = vec_len (src->buffers);
343 vec_add2_aligned (dst->buffers, d, l, CLIB_CACHE_LINE_BYTES);
344 clib_memcpy (d, src->buffers, l * sizeof (d[0]));
345 vec_free (src->buffers);
349 /* Add buffer free list. */
351 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
353 u32 is_public, u32 is_default, u8 * name)
355 vlib_buffer_main_t *bm = vm->buffer_main;
356 vlib_buffer_free_list_t *f;
359 ASSERT (vlib_get_thread_index () == 0);
361 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
363 u32 default_free_free_list_index;
366 default_free_free_list_index =
367 vlib_buffer_create_free_list_helper
369 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
374 ASSERT (default_free_free_list_index ==
375 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
377 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
378 return default_free_free_list_index;
381 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
383 memset (f, 0, sizeof (f[0]));
384 f->index = f - bm->buffer_free_list_pool;
385 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
386 f->min_n_buffers_each_physmem_alloc = VLIB_FRAME_SIZE;
387 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
389 /* Setup free buffer template. */
390 vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
391 f->buffer_init_template.n_add_refs = 0;
395 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
397 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
400 clib_spinlock_init (&f->global_buffers_lock);
402 for (i = 1; i < vec_len (vlib_mains); i++)
404 vlib_buffer_main_t *wbm = vlib_mains[i]->buffer_main;
405 vlib_buffer_free_list_t *wf;
406 pool_get_aligned (wbm->buffer_free_list_pool,
407 wf, CLIB_CACHE_LINE_BYTES);
408 ASSERT (f - bm->buffer_free_list_pool ==
409 wf - wbm->buffer_free_list_pool);
419 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
426 name = va_format (0, fmt, &va);
429 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
436 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
439 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
447 name = va_format (0, fmt, &va);
450 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
460 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
464 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
465 vm->os_physmem_free (vm, vm->buffer_main->physmem_region,
466 f->buffer_memory_allocated[i]);
468 vec_free (f->buffer_memory_allocated);
469 vec_free (f->buffers);
472 /* Add buffer free list. */
474 vlib_buffer_delete_free_list_internal (vlib_main_t * vm, u32 free_list_index)
476 vlib_buffer_main_t *bm = vm->buffer_main;
477 vlib_buffer_free_list_t *f;
481 ASSERT (vlib_get_thread_index () == 0);
483 f = vlib_buffer_get_free_list (vm, free_list_index);
485 ASSERT (vec_len (f->buffers) == f->n_alloc);
486 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
487 if (merge_index != ~0 && merge_index != free_list_index)
489 vlib_buffer_merge_free_lists (pool_elt_at_index
490 (bm->buffer_free_list_pool, merge_index),
494 del_free_list (vm, f);
497 memset (f, 0xab, sizeof (f[0]));
499 pool_put (bm->buffer_free_list_pool, f);
501 for (i = 1; i < vec_len (vlib_mains); i++)
503 bm = vlib_mains[i]->buffer_main;
504 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
505 memset (f, 0xab, sizeof (f[0]));
506 pool_put (bm->buffer_free_list_pool, f);
510 /* Make sure free list has at least given number of free buffers. */
512 fill_free_list (vlib_main_t * vm,
513 vlib_buffer_free_list_t * fl, uword min_free_buffers)
515 vlib_buffer_t *buffers, *b;
516 vlib_buffer_free_list_t *mfl;
519 u32 n_remaining, n_alloc, n_this_chunk;
521 /* Already have enough free buffers on free list? */
522 n = min_free_buffers - vec_len (fl->buffers);
524 return min_free_buffers;
526 mfl = vlib_buffer_get_free_list (vlib_mains[0], fl->index);
527 if (vec_len (mfl->global_buffers) > 0)
530 clib_spinlock_lock (&mfl->global_buffers_lock);
531 n_copy = clib_min (vec_len (mfl->global_buffers), n);
532 n_left = vec_len (mfl->global_buffers) - n_copy;
533 vec_add_aligned (fl->buffers, mfl->global_buffers + n_left, n_copy,
534 CLIB_CACHE_LINE_BYTES);
535 _vec_len (mfl->global_buffers) = n_left;
536 clib_spinlock_unlock (&mfl->global_buffers_lock);
537 n = min_free_buffers - vec_len (fl->buffers);
539 return min_free_buffers;
542 /* Always allocate round number of buffers. */
543 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
545 /* Always allocate new buffers in reasonably large sized chunks. */
546 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
550 while (n_remaining > 0)
552 n_this_chunk = clib_min (n_remaining, 16);
554 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
556 /* drb: removed power-of-2 ASSERT */
558 vm->os_physmem_alloc_aligned (vm, vm->buffer_main->physmem_region,
559 n_bytes, sizeof (vlib_buffer_t));
563 /* Record chunk as being allocated so we can free it later. */
564 vec_add1 (fl->buffer_memory_allocated, buffers);
566 fl->n_alloc += n_this_chunk;
567 n_alloc += n_this_chunk;
568 n_remaining -= n_this_chunk;
571 vec_add2_aligned (fl->buffers, bi, n_this_chunk, CLIB_CACHE_LINE_BYTES);
572 for (i = 0; i < n_this_chunk; i++)
574 bi[i] = vlib_get_buffer_index (vm, b);
577 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
578 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
581 memset (buffers, 0, n_bytes);
583 /* Initialize all new buffers. */
585 for (i = 0; i < n_this_chunk; i++)
587 vlib_buffer_init_for_free_list (b, fl);
588 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
591 if (fl->buffer_init_function)
592 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
598 alloc_from_free_list (vlib_main_t * vm,
599 vlib_buffer_free_list_t * free_list,
600 u32 * alloc_buffers, u32 n_alloc_buffers)
608 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
612 len = vec_len (free_list->buffers);
613 ASSERT (len >= n_alloc_buffers);
615 src = free_list->buffers + len - n_alloc_buffers;
616 clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
618 _vec_len (free_list->buffers) -= n_alloc_buffers;
620 /* Verify that buffers are known free. */
621 vlib_buffer_validate_alloc_free (vm, alloc_buffers,
622 n_alloc_buffers, VLIB_BUFFER_KNOWN_FREE);
624 return n_alloc_buffers;
628 /* Allocate a given number of buffers into given array.
629 Returns number actually allocated which will be either zero or
632 vlib_buffer_alloc_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
634 vlib_buffer_main_t *bm = vm->buffer_main;
636 return alloc_from_free_list
638 pool_elt_at_index (bm->buffer_free_list_pool,
639 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
644 vlib_buffer_alloc_from_free_list_internal (vlib_main_t * vm,
646 u32 n_buffers, u32 free_list_index)
648 vlib_buffer_main_t *bm = vm->buffer_main;
649 vlib_buffer_free_list_t *f;
650 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
651 return alloc_from_free_list (vm, f, buffers, n_buffers);
655 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
657 vlib_buffer_main_t *bm = vm->buffer_main;
658 void *rv = bm->buffer_free_callback;
660 bm->buffer_free_callback = fp;
664 static_always_inline void
665 vlib_buffer_free_inline (vlib_main_t * vm,
666 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
668 vlib_buffer_main_t *bm = vm->buffer_main;
669 vlib_buffer_free_list_t *fl;
672 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
673 u32 follow_buffer_next);
675 cb = bm->buffer_free_callback;
677 if (PREDICT_FALSE (cb != 0))
678 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
683 for (i = 0; i < n_buffers; i++)
688 b = vlib_get_buffer (vm, bi);
689 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
690 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
692 /* The only current use of this callback: multicast recycle */
693 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
697 vlib_buffer_add_to_free_list
698 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
700 for (j = 0; j < vec_len (bm->announce_list); j++)
702 if (fl == bm->announce_list[j])
703 goto already_announced;
705 vec_add1 (bm->announce_list, fl);
711 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
717 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
719 next = nb->next_buffer;
724 vlib_buffer_validate_alloc_free (vm, &bi, 1,
725 VLIB_BUFFER_KNOWN_ALLOCATED);
726 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
730 while (follow_buffer_next
731 && (flags & VLIB_BUFFER_NEXT_PRESENT));
736 if (vec_len (bm->announce_list))
738 vlib_buffer_free_list_t *fl;
739 for (i = 0; i < vec_len (bm->announce_list); i++)
741 fl = bm->announce_list[i];
742 fl->buffers_added_to_freelist_function (vm, fl);
744 _vec_len (bm->announce_list) = 0;
749 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
751 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
756 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
759 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
763 /* Copy template packet data into buffers as they are allocated. */
764 static void __attribute__ ((unused))
765 vlib_packet_template_buffer_init (vlib_main_t * vm,
766 vlib_buffer_free_list_t * fl,
767 u32 * buffers, u32 n_buffers)
769 vlib_packet_template_t *t =
770 uword_to_pointer (fl->buffer_init_function_opaque,
771 vlib_packet_template_t *);
774 for (i = 0; i < n_buffers; i++)
776 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
777 ASSERT (b->current_length == vec_len (t->packet_data));
778 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
784 vlib_packet_template_init (vlib_main_t * vm,
785 vlib_packet_template_t * t,
787 uword n_packet_data_bytes,
788 uword min_n_buffers_each_physmem_alloc,
791 vlib_buffer_main_t *bm = vm->buffer_main;
794 vlib_buffer_free_list_t *fl;
797 name = va_format (0, fmt, &va);
800 if (bm->cb.vlib_packet_template_init_cb)
801 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
803 min_n_buffers_each_physmem_alloc,
806 vlib_worker_thread_barrier_sync (vm);
808 memset (t, 0, sizeof (t[0]));
810 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
811 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
813 t->free_list_index = vlib_buffer_create_free_list_helper
814 (vm, n_packet_data_bytes,
819 ASSERT (t->free_list_index != 0);
820 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
821 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
823 fl->buffer_init_function = vlib_packet_template_buffer_init;
824 fl->buffer_init_function_opaque = pointer_to_uword (t);
826 fl->buffer_init_template.current_data = 0;
827 fl->buffer_init_template.current_length = n_packet_data_bytes;
828 fl->buffer_init_template.flags = 0;
829 fl->buffer_init_template.n_add_refs = 0;
830 vlib_worker_thread_barrier_release (vm);
834 vlib_packet_template_get_packet (vlib_main_t * vm,
835 vlib_packet_template_t * t, u32 * bi_result)
840 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
845 b = vlib_get_buffer (vm, bi);
846 clib_memcpy (vlib_buffer_get_current (b),
847 t->packet_data, vec_len (t->packet_data));
848 b->current_length = vec_len (t->packet_data);
854 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
855 vlib_packet_template_t * t)
857 word n = t->min_n_buffers_each_physmem_alloc;
858 word l = vec_len (t->packet_data);
862 ASSERT (vec_len (t->free_buffers) == 0);
864 vec_validate (t->free_buffers, n - 1);
865 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
866 n, t->free_list_index);
867 _vec_len (t->free_buffers) = n_alloc;
870 /* Append given data to end of buffer, possibly allocating new buffers. */
872 vlib_buffer_add_data (vlib_main_t * vm,
874 u32 buffer_index, void *data, u32 n_data_bytes)
876 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
882 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
886 n_left = n_data_bytes;
887 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
889 b = vlib_get_buffer (vm, bi);
890 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
892 /* Get to the end of the chain before we try to append data... */
893 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
894 b = vlib_get_buffer (vm, b->next_buffer);
900 ASSERT (n_buffer_bytes >= b->current_length);
902 n_buffer_bytes - (b->current_data + b->current_length);
903 n = clib_min (n_left_this_buffer, n_left);
904 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
905 b->current_length += n;
912 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
916 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
918 b = vlib_get_buffer (vm, b->next_buffer);
924 clib_error ("out of buffers");
929 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
931 vlib_buffer_t * first,
932 vlib_buffer_t ** last,
933 void *data, u16 data_len)
935 vlib_buffer_t *l = *last;
937 vlib_buffer_free_list_buffer_size (vm, free_list_index);
939 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
942 u16 max = n_buffer_bytes - l->current_length - l->current_data;
946 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
949 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
950 max = n_buffer_bytes - l->current_length - l->current_data;
953 u16 len = (data_len > max) ? max : data_len;
954 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
956 vlib_buffer_chain_increase_length (first, l, len);
964 vlib_buffer_add_mem_range (vlib_main_t * vm, uword start, uword size)
966 vlib_buffer_main_t *bm = vm->buffer_main;
968 if (bm->buffer_mem_size == 0)
970 bm->buffer_mem_start = start;
971 bm->buffer_mem_size = size;
973 else if (start < bm->buffer_mem_start)
975 bm->buffer_mem_size += bm->buffer_mem_start - start;
976 bm->buffer_mem_start = start;
977 if (size > bm->buffer_mem_size)
978 bm->buffer_mem_size = size;
980 else if (start > bm->buffer_mem_start)
982 uword new_size = start - bm->buffer_mem_start + size;
983 if (new_size > bm->buffer_mem_size)
984 bm->buffer_mem_size = new_size;
987 if ((u64) bm->buffer_mem_size >
988 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
990 clib_panic ("buffer memory size out of range!");
995 format_vlib_buffer_free_list (u8 * s, va_list * va)
997 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
998 u32 threadnum = va_arg (*va, u32);
999 uword bytes_alloc, bytes_free, n_free, size;
1002 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1003 "Thread", "Name", "Index", "Size", "Alloc", "Free",
1006 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1007 n_free = vec_len (f->buffers);
1008 bytes_alloc = size * f->n_alloc;
1009 bytes_free = size * n_free;
1011 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
1012 f->name, f->index, f->n_data_bytes,
1013 format_memory_size, bytes_alloc,
1014 format_memory_size, bytes_free, f->n_alloc, n_free);
1019 static clib_error_t *
1020 show_buffers (vlib_main_t * vm,
1021 unformat_input_t * input, vlib_cli_command_t * cmd)
1023 vlib_buffer_main_t *bm;
1024 vlib_buffer_free_list_t *f;
1025 vlib_main_t *curr_vm;
1028 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
1032 curr_vm = vlib_mains[vm_index];
1033 bm = curr_vm->buffer_main;
1036 pool_foreach (f, bm->buffer_free_list_pool, ({
1037 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1043 while (vm_index < vec_len (vlib_mains));
1049 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1050 .path = "show buffers",
1051 .short_help = "Show packet buffer allocation",
1052 .function = show_buffers,
1057 vlib_buffer_main_init (struct vlib_main_t * vm)
1059 vlib_buffer_main_t *bm;
1060 clib_error_t *error;
1062 vec_validate (vm->buffer_main, 0);
1063 bm = vm->buffer_main;
1065 if (vlib_buffer_callbacks)
1067 /* external plugin has registered own buffer callbacks
1068 so we just copy them and quit */
1069 vlib_buffer_main_t *bm = vm->buffer_main;
1070 clib_memcpy (&bm->cb, vlib_buffer_callbacks,
1071 sizeof (vlib_buffer_callbacks_t));
1072 bm->callbacks_registered = 1;
1076 bm->cb.vlib_buffer_alloc_cb = &vlib_buffer_alloc_internal;
1077 bm->cb.vlib_buffer_alloc_from_free_list_cb =
1078 &vlib_buffer_alloc_from_free_list_internal;
1079 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
1080 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
1081 bm->cb.vlib_buffer_delete_free_list_cb =
1082 &vlib_buffer_delete_free_list_internal;
1083 clib_spinlock_init (&bm->buffer_known_hash_lockp);
1085 /* allocate default region */
1086 error = vlib_physmem_region_alloc (vm, "buffers",
1087 vlib_buffer_physmem_sz, 0,
1088 VLIB_PHYSMEM_F_INIT_MHEAP |
1089 VLIB_PHYSMEM_F_HAVE_BUFFERS,
1090 &bm->physmem_region);
1095 clib_error_free (error);
1097 /* we my be running unpriviledged, so try to allocate fake physmem */
1098 error = vlib_physmem_region_alloc (vm, "buffers (fake)",
1099 vlib_buffer_physmem_sz, 0,
1100 VLIB_PHYSMEM_F_FAKE |
1101 VLIB_PHYSMEM_F_INIT_MHEAP |
1102 VLIB_PHYSMEM_F_HAVE_BUFFERS,
1103 &bm->physmem_region);
1107 static clib_error_t *
1108 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1112 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1114 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1115 vlib_buffer_physmem_sz = size_in_mb << 20;
1117 return unformat_parse_error (input);
1120 unformat_free (input);
1124 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1129 * fd.io coding-style-patch-verification: ON
1132 * eval: (c-set-style "gnu")