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>
49 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
50 vlib_buffer_t * b_first)
52 vlib_buffer_t *b = b_first;
53 uword l_first = b_first->current_length;
55 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
57 b = vlib_get_buffer (vm, b->next_buffer);
58 l += b->current_length;
60 b_first->total_length_not_including_first_buffer = l;
61 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
66 format_vlib_buffer (u8 * s, va_list * args)
68 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
69 uword indent = format_get_indent (s);
71 s = format (s, "current data %d, length %d, free-list %d",
72 b->current_data, b->current_length, b->free_list_index);
74 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
75 s = format (s, ", totlen-nifb %d",
76 b->total_length_not_including_first_buffer);
78 if (b->flags & VLIB_BUFFER_IS_TRACED)
79 s = format (s, ", trace 0x%x", b->trace_index);
81 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
83 vlib_main_t *vm = vlib_get_main ();
84 u32 next_buffer = b->next_buffer;
85 b = vlib_get_buffer (vm, next_buffer);
87 s = format (s, "\n%Unext-buffer 0x%x, segment length %d",
88 format_white_space, indent, next_buffer, b->current_length);
95 format_vlib_buffer_and_data (u8 * s, va_list * args)
97 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
99 s = format (s, "%U, %U",
100 format_vlib_buffer, b,
101 format_hex_bytes, vlib_buffer_get_current (b), 64);
107 format_vlib_buffer_known_state (u8 * s, va_list * args)
109 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
114 case VLIB_BUFFER_UNKNOWN:
118 case VLIB_BUFFER_KNOWN_ALLOCATED:
119 t = "known-allocated";
122 case VLIB_BUFFER_KNOWN_FREE:
131 return format (s, "%s", t);
135 format_vlib_buffer_contents (u8 * s, va_list * va)
137 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
138 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
142 vec_add (s, vlib_buffer_get_current (b), b->current_length);
143 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
145 b = vlib_get_buffer (vm, b->next_buffer);
152 vlib_validate_buffer_helper (vlib_main_t * vm,
154 uword follow_buffer_next, uword ** unique_hash)
156 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
157 vlib_buffer_main_t *bm = vm->buffer_main;
158 vlib_buffer_free_list_t *fl;
160 if (pool_is_free_index (bm->buffer_free_list_pool, b->free_list_index))
161 return format (0, "unknown free list 0x%x", b->free_list_index);
163 fl = pool_elt_at_index (bm->buffer_free_list_pool, b->free_list_index);
165 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
166 return format (0, "current data %d before pre-data", b->current_data);
168 if (b->current_data + b->current_length > fl->n_data_bytes)
169 return format (0, "%d-%d beyond end of buffer %d",
170 b->current_data, b->current_length, fl->n_data_bytes);
172 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
174 vlib_buffer_known_state_t k;
177 k = vlib_buffer_is_known (vm, b->next_buffer);
178 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
179 return format (0, "next 0x%x: %U",
180 b->next_buffer, format_vlib_buffer_known_state, k);
184 if (hash_get (*unique_hash, b->next_buffer))
185 return format (0, "duplicate buffer 0x%x", b->next_buffer);
187 hash_set1 (*unique_hash, b->next_buffer);
190 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
193 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
203 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
205 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
206 /* unique_hash */ 0);
210 vlib_validate_buffers (vlib_main_t * vm,
212 uword next_buffer_stride,
214 vlib_buffer_known_state_t known_state,
215 uword follow_buffer_next)
218 u32 bi, *b = buffers;
219 vlib_buffer_known_state_t k;
220 u8 *msg = 0, *result = 0;
222 hash = hash_create (0, 0);
223 for (i = 0; i < n_buffers; i++)
226 b += next_buffer_stride;
228 /* Buffer is not unique. */
229 if (hash_get (hash, bi))
231 msg = format (0, "not unique");
235 k = vlib_buffer_is_known (vm, bi);
236 if (k != known_state)
238 msg = format (0, "is %U; expected %U",
239 format_vlib_buffer_known_state, k,
240 format_vlib_buffer_known_state, known_state);
244 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
248 hash_set1 (hash, bi);
254 result = format (0, "0x%x: %v", bi, msg);
261 vlib_main_t **vlib_mains;
263 /* When dubugging validate that given buffers are either known allocated
265 static void __attribute__ ((unused))
266 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
269 vlib_buffer_known_state_t expected_state)
272 uword i, bi, is_free;
277 ASSERT (os_get_cpu_number () == 0);
279 /* smp disaster check */
281 ASSERT (vm == vlib_mains[0]);
283 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
285 for (i = 0; i < n_buffers; i++)
287 vlib_buffer_known_state_t known;
291 known = vlib_buffer_is_known (vm, bi);
292 if (known != expected_state)
296 (vm, "%s %U buffer 0x%x",
297 is_free ? "freeing" : "allocating",
298 format_vlib_buffer_known_state, known, bi);
301 vlib_buffer_set_known_state
303 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
307 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
309 /* Make sure we have at least given number of unaligned buffers. */
311 vlib_buffer_free_list_fill_unaligned (vlib_main_t * vm,
312 vlib_buffer_free_list_t * free_list,
313 uword n_unaligned_buffers)
315 word la = vec_len (free_list->aligned_buffers);
316 word lu = vec_len (free_list->unaligned_buffers);
318 /* Aligned come in aligned copy-sized chunks. */
319 ASSERT (la % BUFFERS_PER_COPY == 0);
321 ASSERT (la >= n_unaligned_buffers);
323 while (lu < n_unaligned_buffers)
325 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
326 vec_add (free_list->unaligned_buffers,
327 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
329 la -= BUFFERS_PER_COPY;
330 lu += BUFFERS_PER_COPY;
332 _vec_len (free_list->aligned_buffers) = la;
335 /* After free aligned buffers may not contain even sized chunks. */
337 vlib_buffer_free_list_trim_aligned (vlib_buffer_free_list_t * f)
341 /* Add unaligned to aligned before trim. */
342 l = vec_len (f->unaligned_buffers);
345 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
346 /* align */ sizeof (vlib_copy_unit_t));
348 _vec_len (f->unaligned_buffers) = 0;
351 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
352 l = vec_len (f->aligned_buffers);
353 n_trim = l % BUFFERS_PER_COPY;
356 /* Trim aligned -> unaligned. */
357 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
359 /* Remove from aligned. */
360 _vec_len (f->aligned_buffers) = l - n_trim;
365 vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
366 vlib_buffer_free_list_t * src)
371 vlib_buffer_free_list_trim_aligned (src);
372 vlib_buffer_free_list_trim_aligned (dst);
374 l = vec_len (src->aligned_buffers);
377 vec_add2_aligned (dst->aligned_buffers, d, l,
378 /* align */ sizeof (vlib_copy_unit_t));
379 clib_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
380 vec_free (src->aligned_buffers);
383 l = vec_len (src->unaligned_buffers);
386 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
387 vec_free (src->unaligned_buffers);
391 /* Add buffer free list. */
393 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
395 u32 is_public, u32 is_default, u8 * name)
397 vlib_buffer_main_t *bm = vm->buffer_main;
398 vlib_buffer_free_list_t *f;
401 ASSERT (os_get_cpu_number () == 0);
403 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
405 u32 default_free_free_list_index;
408 default_free_free_list_index =
409 vlib_buffer_create_free_list_helper
411 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
416 ASSERT (default_free_free_list_index ==
417 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
419 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
420 return default_free_free_list_index;
423 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
425 memset (f, 0, sizeof (f[0]));
426 f->index = f - bm->buffer_free_list_pool;
427 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
428 f->min_n_buffers_each_physmem_alloc = 16;
429 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
431 /* Setup free buffer template. */
432 f->buffer_init_template.free_list_index = f->index;
436 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
438 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
441 for (i = 1; i < vec_len (vlib_mains); i++)
443 vlib_buffer_main_t *wbm = vlib_mains[i]->buffer_main;
444 vlib_buffer_free_list_t *wf;
445 pool_get_aligned (wbm->buffer_free_list_pool,
446 wf, CLIB_CACHE_LINE_BYTES);
447 ASSERT (f - bm->buffer_free_list_pool ==
448 wf - wbm->buffer_free_list_pool);
450 wf->aligned_buffers = 0;
451 wf->unaligned_buffers = 0;
459 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
466 name = va_format (0, fmt, &va);
469 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
476 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
479 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
487 name = va_format (0, fmt, &va);
490 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
500 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
504 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
505 vm->os_physmem_free (f->buffer_memory_allocated[i]);
507 vec_free (f->buffer_memory_allocated);
508 vec_free (f->unaligned_buffers);
509 vec_free (f->aligned_buffers);
512 /* Add buffer free list. */
514 vlib_buffer_delete_free_list_internal (vlib_main_t * vm, u32 free_list_index)
516 vlib_buffer_main_t *bm = vm->buffer_main;
517 vlib_buffer_free_list_t *f;
521 ASSERT (os_get_cpu_number () == 0);
523 f = vlib_buffer_get_free_list (vm, free_list_index);
525 ASSERT (vec_len (f->unaligned_buffers) + vec_len (f->aligned_buffers) ==
527 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
528 if (merge_index != ~0 && merge_index != free_list_index)
530 vlib_buffer_merge_free_lists (pool_elt_at_index
531 (bm->buffer_free_list_pool, merge_index),
535 del_free_list (vm, f);
538 memset (f, 0xab, sizeof (f[0]));
540 pool_put (bm->buffer_free_list_pool, f);
542 for (i = 1; i < vec_len (vlib_mains); i++)
544 bm = vlib_mains[i]->buffer_main;
545 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
546 memset (f, 0xab, sizeof (f[0]));
547 pool_put (bm->buffer_free_list_pool, f);
551 /* Make sure free list has at least given number of free buffers. */
553 fill_free_list (vlib_main_t * vm,
554 vlib_buffer_free_list_t * fl, uword min_free_buffers)
556 vlib_buffer_t *buffers, *b;
559 u32 n_remaining, n_alloc, n_this_chunk;
561 vlib_buffer_free_list_trim_aligned (fl);
563 /* Already have enough free buffers on free list? */
564 n = min_free_buffers - vec_len (fl->aligned_buffers);
566 return min_free_buffers;
568 /* Always allocate round number of buffers. */
569 n = round_pow2 (n, BUFFERS_PER_COPY);
571 /* Always allocate new buffers in reasonably large sized chunks. */
572 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
576 while (n_remaining > 0)
578 n_this_chunk = clib_min (n_remaining, 16);
580 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
582 /* drb: removed power-of-2 ASSERT */
583 buffers = vm->os_physmem_alloc_aligned (&vm->physmem_main,
585 sizeof (vlib_buffer_t));
589 /* Record chunk as being allocated so we can free it later. */
590 vec_add1 (fl->buffer_memory_allocated, buffers);
592 fl->n_alloc += n_this_chunk;
593 n_alloc += n_this_chunk;
594 n_remaining -= n_this_chunk;
597 vec_add2_aligned (fl->aligned_buffers, bi, n_this_chunk,
598 sizeof (vlib_copy_unit_t));
599 for (i = 0; i < n_this_chunk; i++)
601 bi[i] = vlib_get_buffer_index (vm, b);
604 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
605 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
608 memset (buffers, 0, n_bytes);
610 /* Initialize all new buffers. */
612 for (i = 0; i < n_this_chunk; i++)
614 vlib_buffer_init_for_free_list (b, fl);
615 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
618 if (fl->buffer_init_function)
619 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
625 copy_alignment (u32 * x)
627 return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY;
632 alloc_from_free_list (vlib_main_t * vm,
633 vlib_buffer_free_list_t * free_list,
634 u32 * alloc_buffers, u32 n_alloc_buffers)
638 uword n_unaligned_start, n_unaligned_end, n_filled;
640 n_left = n_alloc_buffers;
642 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
643 & (BUFFERS_PER_COPY - 1));
645 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
649 n_left = n_filled < n_left ? n_filled : n_left;
650 n_alloc_buffers = n_left;
652 if (n_unaligned_start >= n_left)
654 n_unaligned_start = n_left;
658 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
660 vlib_buffer_free_list_fill_unaligned (vm, free_list,
661 n_unaligned_start + n_unaligned_end);
663 u_len = vec_len (free_list->unaligned_buffers);
664 u_src = free_list->unaligned_buffers + u_len - 1;
666 if (n_unaligned_start)
668 uword n_copy = n_unaligned_start;
680 /* Now dst should be aligned. */
682 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
687 vlib_copy_unit_t *d, *s;
690 if (vec_len (free_list->aligned_buffers) <
691 ((n_left / BUFFERS_PER_COPY) * BUFFERS_PER_COPY))
694 n_copy = n_left / BUFFERS_PER_COPY;
695 n_left = n_left % BUFFERS_PER_COPY;
697 /* Remove buffers from aligned free list. */
698 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
700 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
701 d = (vlib_copy_unit_t *) dst;
703 /* Fast path loop. */
726 /* Unaligned copy. */
727 ASSERT (n_unaligned_end == n_left);
735 if (!free_list->unaligned_buffers)
738 _vec_len (free_list->unaligned_buffers) = u_len;
740 /* Verify that buffers are known free. */
741 vlib_buffer_validate_alloc_free (vm, alloc_buffers,
742 n_alloc_buffers, VLIB_BUFFER_KNOWN_FREE);
744 return n_alloc_buffers;
748 /* Allocate a given number of buffers into given array.
749 Returns number actually allocated which will be either zero or
752 vlib_buffer_alloc_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
754 vlib_buffer_main_t *bm = vm->buffer_main;
756 return alloc_from_free_list
758 pool_elt_at_index (bm->buffer_free_list_pool,
759 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
764 vlib_buffer_alloc_from_free_list_internal (vlib_main_t * vm,
766 u32 n_buffers, u32 free_list_index)
768 vlib_buffer_main_t *bm = vm->buffer_main;
769 vlib_buffer_free_list_t *f;
770 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
771 return alloc_from_free_list (vm, f, buffers, n_buffers);
775 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
777 vlib_buffer_main_t *bm = vm->buffer_main;
778 void *rv = bm->buffer_free_callback;
780 bm->buffer_free_callback = fp;
784 static_always_inline void
785 vlib_buffer_free_inline (vlib_main_t * vm,
786 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
788 vlib_buffer_main_t *bm = vm->buffer_main;
789 vlib_buffer_free_list_t *fl;
790 static u32 *next_to_free[2]; /* smp bad */
791 u32 i_next_to_free, *b, *n, *f, fi;
794 static vlib_buffer_free_list_t **announce_list;
795 vlib_buffer_free_list_t *fl0 = 0, *fl1 = 0;
796 u32 bi0 = (u32) ~ 0, bi1 = (u32) ~ 0, fi0, fi1 = (u32) ~ 0;
797 u8 free0, free1 = 0, free_next0, free_next1;
798 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
799 u32 follow_buffer_next);
801 ASSERT (os_get_cpu_number () == 0);
803 cb = bm->buffer_free_callback;
805 if (PREDICT_FALSE (cb != 0))
806 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
811 /* Use first buffer to get default free list. */
813 u32 bi0 = buffers[0];
816 b0 = vlib_get_buffer (vm, bi0);
817 fl = vlib_buffer_get_buffer_free_list (vm, b0, &fi);
818 if (fl->buffers_added_to_freelist_function)
819 vec_add1 (announce_list, fl);
822 vec_validate (next_to_free[0], n_buffers - 1);
823 vec_validate (next_to_free[1], n_buffers - 1);
830 /* Verify that buffers are known allocated. */
831 vlib_buffer_validate_alloc_free (vm, b,
832 n_left, VLIB_BUFFER_KNOWN_ALLOCATED);
834 vec_add2_aligned (fl->aligned_buffers, f, n_left,
835 /* align */ sizeof (vlib_copy_unit_t));
837 n = next_to_free[i_next_to_free];
840 vlib_buffer_t *b0, *b1, *binit0, *binit1, dummy_buffers[2];
851 /* Prefetch buffers for next iteration. */
852 vlib_prefetch_buffer_with_index (vm, b[0], WRITE);
853 vlib_prefetch_buffer_with_index (vm, b[1], WRITE);
855 b0 = vlib_get_buffer (vm, bi0);
856 b1 = vlib_get_buffer (vm, bi1);
858 free0 = (b0->flags & VLIB_BUFFER_RECYCLE) == 0;
859 free1 = (b1->flags & VLIB_BUFFER_RECYCLE) == 0;
861 /* Must be before init which will over-write buffer flags. */
862 if (follow_buffer_next)
864 n[0] = b0->next_buffer;
865 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
868 n[0] = b1->next_buffer;
869 free_next1 = free1 && (b1->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
873 free_next0 = free_next1 = 0;
875 /* Must be before init which will over-write buffer free list. */
876 fi0 = b0->free_list_index;
877 fi1 = b1->free_list_index;
879 if (PREDICT_FALSE (fi0 != fi || fi1 != fi))
882 binit0 = free0 ? b0 : &dummy_buffers[0];
883 binit1 = free1 ? b1 : &dummy_buffers[1];
885 vlib_buffer_init_two_for_free_list (binit0, binit1, fl);
889 /* Backup speculation. */
891 n -= free_next0 + free_next1;
893 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
895 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
896 fl1 = pool_elt_at_index (bm->buffer_free_list_pool, fi1);
898 vlib_buffer_add_to_free_list (vm, fl0, bi0, free0);
899 if (PREDICT_FALSE (fl0->buffers_added_to_freelist_function != 0))
902 for (i = 0; i < vec_len (announce_list); i++)
903 if (fl0 == announce_list[i])
905 vec_add1 (announce_list, fl0);
908 if (PREDICT_FALSE (fl1->buffers_added_to_freelist_function != 0))
911 for (i = 0; i < vec_len (announce_list); i++)
912 if (fl1 == announce_list[i])
914 vec_add1 (announce_list, fl1);
918 vlib_buffer_add_to_free_list (vm, fl1, bi1, free1);
920 /* Possibly change current free list. */
921 if (fi0 != fi && fi1 != fi)
924 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
927 vec_add2_aligned (fl->aligned_buffers, f, n_left,
928 /* align */ sizeof (vlib_copy_unit_t));
933 vlib_buffer_t *b0, *binit0, dummy_buffers[1];
941 b0 = vlib_get_buffer (vm, bi0);
943 free0 = (b0->flags & VLIB_BUFFER_RECYCLE) == 0;
945 /* Must be before init which will over-write buffer flags. */
946 if (follow_buffer_next)
948 n[0] = b0->next_buffer;
949 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
955 /* Must be before init which will over-write buffer free list. */
956 fi0 = b0->free_list_index;
958 if (PREDICT_FALSE (fi0 != fi))
961 binit0 = free0 ? b0 : &dummy_buffers[0];
963 vlib_buffer_init_for_free_list (binit0, fl);
967 /* Backup speculation. */
971 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
973 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
975 vlib_buffer_add_to_free_list (vm, fl0, bi0, free0);
976 if (PREDICT_FALSE (fl0->buffers_added_to_freelist_function != 0))
979 for (i = 0; i < vec_len (announce_list); i++)
980 if (fl0 == announce_list[i])
982 vec_add1 (announce_list, fl0);
987 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
989 vec_add2_aligned (fl->aligned_buffers, f, n_left,
990 /* align */ sizeof (vlib_copy_unit_t));
993 if (follow_buffer_next && ((n_left = n - next_to_free[i_next_to_free]) > 0))
995 b = next_to_free[i_next_to_free];
1000 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1002 if (vec_len (announce_list))
1004 vlib_buffer_free_list_t *fl;
1005 for (i = 0; i < vec_len (announce_list); i++)
1007 fl = announce_list[i];
1008 fl->buffers_added_to_freelist_function (vm, fl);
1010 _vec_len (announce_list) = 0;
1015 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
1017 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
1022 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
1025 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
1029 /* Copy template packet data into buffers as they are allocated. */
1030 static void __attribute__ ((unused))
1031 vlib_packet_template_buffer_init (vlib_main_t * vm,
1032 vlib_buffer_free_list_t * fl,
1033 u32 * buffers, u32 n_buffers)
1035 vlib_packet_template_t *t =
1036 uword_to_pointer (fl->buffer_init_function_opaque,
1037 vlib_packet_template_t *);
1040 for (i = 0; i < n_buffers; i++)
1042 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
1043 ASSERT (b->current_length == vec_len (t->packet_data));
1044 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
1050 vlib_packet_template_init (vlib_main_t * vm,
1051 vlib_packet_template_t * t,
1053 uword n_packet_data_bytes,
1054 uword min_n_buffers_each_physmem_alloc,
1057 vlib_buffer_main_t *bm = vm->buffer_main;
1059 __attribute__ ((unused)) u8 *name;
1060 vlib_buffer_free_list_t *fl;
1063 name = va_format (0, fmt, &va);
1066 if (bm->cb.vlib_packet_template_init_cb)
1067 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
1068 n_packet_data_bytes,
1069 min_n_buffers_each_physmem_alloc,
1072 vlib_worker_thread_barrier_sync (vm);
1074 memset (t, 0, sizeof (t[0]));
1076 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
1077 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
1079 t->free_list_index = vlib_buffer_create_free_list_helper
1080 (vm, n_packet_data_bytes,
1085 ASSERT (t->free_list_index != 0);
1086 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
1087 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
1089 fl->buffer_init_function = vlib_packet_template_buffer_init;
1090 fl->buffer_init_function_opaque = pointer_to_uword (t);
1092 fl->buffer_init_template.current_data = 0;
1093 fl->buffer_init_template.current_length = n_packet_data_bytes;
1094 fl->buffer_init_template.flags = 0;
1095 vlib_worker_thread_barrier_release (vm);
1099 vlib_packet_template_get_packet (vlib_main_t * vm,
1100 vlib_packet_template_t * t, u32 * bi_result)
1105 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
1110 b = vlib_get_buffer (vm, bi);
1111 clib_memcpy (vlib_buffer_get_current (b),
1112 t->packet_data, vec_len (t->packet_data));
1113 b->current_length = vec_len (t->packet_data);
1119 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
1120 vlib_packet_template_t * t)
1122 word n = t->min_n_buffers_each_physmem_alloc;
1123 word l = vec_len (t->packet_data);
1127 ASSERT (vec_len (t->free_buffers) == 0);
1129 vec_validate (t->free_buffers, n - 1);
1130 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
1131 n, t->free_list_index);
1132 _vec_len (t->free_buffers) = n_alloc;
1135 /* Append given data to end of buffer, possibly allocating new buffers. */
1137 vlib_buffer_add_data (vlib_main_t * vm,
1138 u32 free_list_index,
1139 u32 buffer_index, void *data, u32 n_data_bytes)
1141 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
1147 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
1148 goto out_of_buffers;
1151 n_left = n_data_bytes;
1152 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
1154 b = vlib_get_buffer (vm, bi);
1155 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1157 /* Get to the end of the chain before we try to append data... */
1158 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1159 b = vlib_get_buffer (vm, b->next_buffer);
1165 ASSERT (n_buffer_bytes >= b->current_length);
1166 n_left_this_buffer =
1167 n_buffer_bytes - (b->current_data + b->current_length);
1168 n = clib_min (n_left_this_buffer, n_left);
1169 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
1170 b->current_length += n;
1177 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
1179 goto out_of_buffers;
1181 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1183 b = vlib_get_buffer (vm, b->next_buffer);
1189 clib_error ("out of buffers");
1194 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1195 u32 free_list_index,
1196 vlib_buffer_t * first,
1197 vlib_buffer_t ** last,
1198 void *data, u16 data_len)
1200 vlib_buffer_t *l = *last;
1201 u32 n_buffer_bytes =
1202 vlib_buffer_free_list_buffer_size (vm, free_list_index);
1204 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
1207 u16 max = n_buffer_bytes - l->current_length - l->current_data;
1211 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
1214 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
1215 max = n_buffer_bytes - l->current_length - l->current_data;
1218 u16 len = (data_len > max) ? max : data_len;
1219 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
1220 data + copied, len);
1221 vlib_buffer_chain_increase_length (first, l, len);
1230 format_vlib_buffer_free_list (u8 * s, va_list * va)
1232 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
1233 u32 threadnum = va_arg (*va, u32);
1234 uword bytes_alloc, bytes_free, n_free, size;
1237 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1238 "Thread", "Name", "Index", "Size", "Alloc", "Free",
1241 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1242 n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1243 bytes_alloc = size * f->n_alloc;
1244 bytes_free = size * n_free;
1246 s = format (s, "%7d%30s%12d%12d%=12U%=12U%=12d%=12d", threadnum,
1247 f->name, f->index, f->n_data_bytes,
1248 format_memory_size, bytes_alloc,
1249 format_memory_size, bytes_free, f->n_alloc, n_free);
1254 static clib_error_t *
1255 show_buffers (vlib_main_t * vm,
1256 unformat_input_t * input, vlib_cli_command_t * cmd)
1258 vlib_buffer_main_t *bm;
1259 vlib_buffer_free_list_t *f;
1260 vlib_main_t *curr_vm;
1263 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
1267 curr_vm = vec_len (vlib_mains) ? vlib_mains[vm_index] : vm;
1268 bm = curr_vm->buffer_main;
1271 pool_foreach (f, bm->buffer_free_list_pool, ({
1272 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1278 while (vm_index < vec_len (vlib_mains));
1284 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1285 .path = "show buffers",
1286 .short_help = "Show packet buffer allocation",
1287 .function = show_buffers,
1292 vlib_buffer_cb_init (struct vlib_main_t *vm)
1294 vlib_buffer_main_t *bm = vm->buffer_main;
1295 bm->cb.vlib_buffer_alloc_cb = &vlib_buffer_alloc_internal;
1296 bm->cb.vlib_buffer_alloc_from_free_list_cb =
1297 &vlib_buffer_alloc_from_free_list_internal;
1298 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
1299 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
1300 bm->cb.vlib_buffer_delete_free_list_cb =
1301 &vlib_buffer_delete_free_list_internal;
1302 bm->extern_buffer_mgmt = 0;
1306 vlib_buffer_cb_register (struct vlib_main_t *vm, vlib_buffer_callbacks_t * cb)
1308 vlib_buffer_main_t *bm = vm->buffer_main;
1309 if (bm->extern_buffer_mgmt)
1312 #define _(x) bm->cb.x = cb->x
1313 _(vlib_buffer_alloc_cb);
1314 _(vlib_buffer_alloc_from_free_list_cb);
1315 _(vlib_buffer_free_cb);
1316 _(vlib_buffer_free_no_next_cb);
1317 _(vlib_buffer_delete_free_list_cb);
1319 bm->extern_buffer_mgmt = 1;
1325 * fd.io coding-style-patch-verification: ON
1328 * eval: (c-set-style "gnu")