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.
44 * Allocate/free network buffers.
47 #include <vlib/vlib.h>
50 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
51 vlib_buffer_t * b_first)
53 vlib_buffer_t *b = b_first;
54 uword l_first = b_first->current_length;
56 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
58 b = vlib_get_buffer (vm, b->next_buffer);
59 l += b->current_length;
61 b_first->total_length_not_including_first_buffer = l;
62 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
67 format_vlib_buffer (u8 * s, va_list * args)
69 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
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_IS_TRACED)
75 s = format (s, ", trace 0x%x", b->trace_index);
77 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
78 s = format (s, ", next-buffer 0x%x", b->next_buffer);
84 format_vlib_buffer_and_data (u8 * s, va_list * args)
86 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
88 s = format (s, "%U, %U",
89 format_vlib_buffer, b,
90 format_hex_bytes, vlib_buffer_get_current (b), 64);
96 format_vlib_buffer_known_state (u8 * s, va_list * args)
98 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
103 case VLIB_BUFFER_UNKNOWN:
107 case VLIB_BUFFER_KNOWN_ALLOCATED:
108 t = "known-allocated";
111 case VLIB_BUFFER_KNOWN_FREE:
120 return format (s, "%s", t);
124 format_vlib_buffer_contents (u8 * s, va_list * va)
126 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
127 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
131 vec_add (s, vlib_buffer_get_current (b), b->current_length);
132 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
134 b = vlib_get_buffer (vm, b->next_buffer);
141 vlib_validate_buffer_helper (vlib_main_t * vm,
143 uword follow_buffer_next, uword ** unique_hash)
145 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
146 vlib_buffer_main_t *bm = vm->buffer_main;
147 vlib_buffer_free_list_t *fl;
149 if (pool_is_free_index (bm->buffer_free_list_pool, b->free_list_index))
150 return format (0, "unknown free list 0x%x", b->free_list_index);
152 fl = pool_elt_at_index (bm->buffer_free_list_pool, b->free_list_index);
154 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
155 return format (0, "current data %d before pre-data", b->current_data);
157 if (b->current_data + b->current_length > fl->n_data_bytes)
158 return format (0, "%d-%d beyond end of buffer %d",
159 b->current_data, b->current_length, fl->n_data_bytes);
162 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
164 vlib_buffer_known_state_t k;
167 k = vlib_buffer_is_known (vm, b->next_buffer);
168 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
169 return format (0, "next 0x%x: %U",
170 b->next_buffer, format_vlib_buffer_known_state, k);
174 if (hash_get (*unique_hash, b->next_buffer))
175 return format (0, "duplicate buffer 0x%x", b->next_buffer);
177 hash_set1 (*unique_hash, b->next_buffer);
180 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
183 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
193 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
195 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
196 /* unique_hash */ 0);
200 vlib_validate_buffers (vlib_main_t * vm,
202 uword next_buffer_stride,
204 vlib_buffer_known_state_t known_state,
205 uword follow_buffer_next)
208 u32 bi, *b = buffers;
209 vlib_buffer_known_state_t k;
210 u8 *msg = 0, *result = 0;
212 hash = hash_create (0, 0);
213 for (i = 0; i < n_buffers; i++)
216 b += next_buffer_stride;
218 /* Buffer is not unique. */
219 if (hash_get (hash, bi))
221 msg = format (0, "not unique");
225 k = vlib_buffer_is_known (vm, bi);
226 if (k != known_state)
228 msg = format (0, "is %U; expected %U",
229 format_vlib_buffer_known_state, k,
230 format_vlib_buffer_known_state, known_state);
234 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
238 hash_set1 (hash, bi);
244 result = format (0, "0x%x: %v", bi, msg);
251 vlib_main_t **vlib_mains;
253 /* When dubugging validate that given buffers are either known allocated
256 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
259 vlib_buffer_known_state_t expected_state)
262 uword i, bi, is_free;
267 ASSERT (os_get_cpu_number () == 0);
269 /* smp disaster check */
271 ASSERT (vm == vlib_mains[0]);
273 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
275 for (i = 0; i < n_buffers; i++)
277 vlib_buffer_known_state_t known;
281 known = vlib_buffer_is_known (vm, bi);
282 if (known != expected_state)
286 (vm, "%s %U buffer 0x%x",
287 is_free ? "freeing" : "allocating",
288 format_vlib_buffer_known_state, known, bi);
291 vlib_buffer_set_known_state
293 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
297 /* Aligned copy routine. */
299 vlib_aligned_memcpy (void *_dst, void *_src, int n_bytes)
301 vlib_copy_unit_t *dst = _dst;
302 vlib_copy_unit_t *src = _src;
304 /* Arguments must be naturally aligned. */
305 ASSERT (pointer_to_uword (dst) % sizeof (dst[0]) == 0);
306 ASSERT (pointer_to_uword (src) % sizeof (src[0]) == 0);
307 ASSERT (n_bytes % sizeof (dst[0]) == 0);
309 if (4 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
311 CLIB_PREFETCH (dst + 0, 4 * sizeof (dst[0]), WRITE);
312 CLIB_PREFETCH (src + 0, 4 * sizeof (src[0]), READ);
314 while (n_bytes >= 4 * sizeof (dst[0]))
318 n_bytes -= 4 * sizeof (dst[0]);
319 CLIB_PREFETCH (dst, 4 * sizeof (dst[0]), WRITE);
320 CLIB_PREFETCH (src, 4 * sizeof (src[0]), READ);
327 else if (8 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
329 CLIB_PREFETCH (dst + 0, 8 * sizeof (dst[0]), WRITE);
330 CLIB_PREFETCH (src + 0, 8 * sizeof (src[0]), READ);
332 while (n_bytes >= 8 * sizeof (dst[0]))
336 n_bytes -= 8 * sizeof (dst[0]);
337 CLIB_PREFETCH (dst, 8 * sizeof (dst[0]), WRITE);
338 CLIB_PREFETCH (src, 8 * sizeof (src[0]), READ);
350 /* Cache line size unknown: fall back to slow version. */ ;
355 n_bytes -= 1 * sizeof (dst[0]);
359 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
361 /* Make sure we have at least given number of unaligned buffers. */
363 fill_unaligned (vlib_main_t * vm,
364 vlib_buffer_free_list_t * free_list,
365 uword n_unaligned_buffers)
367 word la = vec_len (free_list->aligned_buffers);
368 word lu = vec_len (free_list->unaligned_buffers);
370 /* Aligned come in aligned copy-sized chunks. */
371 ASSERT (la % BUFFERS_PER_COPY == 0);
373 ASSERT (la >= n_unaligned_buffers);
375 while (lu < n_unaligned_buffers)
377 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
378 vec_add (free_list->unaligned_buffers,
379 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
381 la -= BUFFERS_PER_COPY;
382 lu += BUFFERS_PER_COPY;
384 _vec_len (free_list->aligned_buffers) = la;
387 /* After free aligned buffers may not contain even sized chunks. */
389 trim_aligned (vlib_buffer_free_list_t * f)
393 /* Add unaligned to aligned before trim. */
394 l = vec_len (f->unaligned_buffers);
397 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
398 /* align */ sizeof (vlib_copy_unit_t));
400 _vec_len (f->unaligned_buffers) = 0;
403 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
404 l = vec_len (f->aligned_buffers);
405 n_trim = l % BUFFERS_PER_COPY;
408 /* Trim aligned -> unaligned. */
409 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
411 /* Remove from aligned. */
412 _vec_len (f->aligned_buffers) = l - n_trim;
417 merge_free_lists (vlib_buffer_free_list_t * dst,
418 vlib_buffer_free_list_t * src)
426 l = vec_len (src->aligned_buffers);
429 vec_add2_aligned (dst->aligned_buffers, d, l,
430 /* align */ sizeof (vlib_copy_unit_t));
431 vlib_aligned_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
432 vec_free (src->aligned_buffers);
435 l = vec_len (src->unaligned_buffers);
438 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
439 vec_free (src->unaligned_buffers);
444 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
446 vlib_buffer_main_t *bm = vm->buffer_main;
448 size = vlib_buffer_round_size (size);
449 uword *p = hash_get (bm->free_list_by_size, size);
450 return p ? p[0] : ~0;
453 /* Add buffer free list. */
455 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
457 u32 is_public, u32 is_default, u8 * name)
459 vlib_buffer_main_t *bm = vm->buffer_main;
460 vlib_buffer_free_list_t *f;
462 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
464 u32 default_free_free_list_index;
466 default_free_free_list_index = vlib_buffer_create_free_list_helper (vm,
467 /* default buffer size */
468 VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
476 ASSERT (default_free_free_list_index ==
477 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
479 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
480 return default_free_free_list_index;
483 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
485 memset (f, 0, sizeof (f[0]));
486 f->index = f - bm->buffer_free_list_pool;
487 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
488 f->min_n_buffers_each_physmem_alloc = 256;
489 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
491 /* Setup free buffer template. */
492 f->buffer_init_template.free_list_index = f->index;
496 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
498 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
505 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
512 name = va_format (0, fmt, &va);
515 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
522 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
525 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
533 name = va_format (0, fmt, &va);
536 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
546 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
550 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
551 vm->os_physmem_free (f->buffer_memory_allocated[i]);
553 vec_free (f->buffer_memory_allocated);
554 vec_free (f->unaligned_buffers);
555 vec_free (f->aligned_buffers);
558 /* Add buffer free list. */
560 vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
562 vlib_buffer_main_t *bm = vm->buffer_main;
563 vlib_buffer_free_list_t *f;
566 f = vlib_buffer_get_free_list (vm, free_list_index);
568 ASSERT (vec_len (f->unaligned_buffers) + vec_len (f->aligned_buffers) ==
570 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
571 if (merge_index != ~0 && merge_index != free_list_index)
573 merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
577 del_free_list (vm, f);
580 memset (f, 0xab, sizeof (f[0]));
582 pool_put (bm->buffer_free_list_pool, f);
585 /* Make sure free list has at least given number of free buffers. */
587 fill_free_list (vlib_main_t * vm,
588 vlib_buffer_free_list_t * fl, uword min_free_buffers)
590 vlib_buffer_t *buffers, *b;
593 u32 n_remaining, n_alloc, n_this_chunk;
597 /* Already have enough free buffers on free list? */
598 n = min_free_buffers - vec_len (fl->aligned_buffers);
600 return min_free_buffers;
602 /* Always allocate round number of buffers. */
603 n = round_pow2 (n, BUFFERS_PER_COPY);
605 /* Always allocate new buffers in reasonably large sized chunks. */
606 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
610 while (n_remaining > 0)
612 n_this_chunk = clib_min (n_remaining, 16);
614 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
616 /* drb: removed power-of-2 ASSERT */
617 buffers = vm->os_physmem_alloc_aligned (&vm->physmem_main,
619 sizeof (vlib_buffer_t));
623 /* Record chunk as being allocated so we can free it later. */
624 vec_add1 (fl->buffer_memory_allocated, buffers);
626 fl->n_alloc += n_this_chunk;
627 n_alloc += n_this_chunk;
628 n_remaining -= n_this_chunk;
631 vec_add2_aligned (fl->aligned_buffers, bi, n_this_chunk,
632 sizeof (vlib_copy_unit_t));
633 for (i = 0; i < n_this_chunk; i++)
635 bi[i] = vlib_get_buffer_index (vm, b);
638 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
639 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
642 memset (buffers, 0, n_bytes);
644 /* Initialize all new buffers. */
646 for (i = 0; i < n_this_chunk; i++)
648 vlib_buffer_init_for_free_list (b, fl);
649 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
652 if (fl->buffer_init_function)
653 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
659 copy_alignment (u32 * x)
661 return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY;
665 alloc_from_free_list (vlib_main_t * vm,
666 vlib_buffer_free_list_t * free_list,
667 u32 * alloc_buffers, u32 n_alloc_buffers)
671 uword n_unaligned_start, n_unaligned_end, n_filled;
673 ASSERT (os_get_cpu_number () == 0);
675 n_left = n_alloc_buffers;
677 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
678 & (BUFFERS_PER_COPY - 1));
680 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
684 n_left = n_filled < n_left ? n_filled : n_left;
685 n_alloc_buffers = n_left;
687 if (n_unaligned_start >= n_left)
689 n_unaligned_start = n_left;
693 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
695 fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
697 u_len = vec_len (free_list->unaligned_buffers);
698 u_src = free_list->unaligned_buffers + u_len - 1;
700 if (n_unaligned_start)
702 uword n_copy = n_unaligned_start;
714 /* Now dst should be aligned. */
716 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
721 vlib_copy_unit_t *d, *s;
724 if (vec_len (free_list->aligned_buffers) <
725 ((n_left / BUFFERS_PER_COPY) * BUFFERS_PER_COPY))
728 n_copy = n_left / BUFFERS_PER_COPY;
729 n_left = n_left % BUFFERS_PER_COPY;
731 /* Remove buffers from aligned free list. */
732 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
734 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
735 d = (vlib_copy_unit_t *) dst;
737 /* Fast path loop. */
760 /* Unaligned copy. */
761 ASSERT (n_unaligned_end == n_left);
769 if (!free_list->unaligned_buffers)
772 _vec_len (free_list->unaligned_buffers) = u_len;
774 /* Verify that buffers are known free. */
775 vlib_buffer_validate_alloc_free (vm, alloc_buffers,
776 n_alloc_buffers, VLIB_BUFFER_KNOWN_FREE);
778 return n_alloc_buffers;
781 /* Allocate a given number of buffers into given array.
782 Returns number actually allocated which will be either zero or
785 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
787 vlib_buffer_main_t *bm = vm->buffer_main;
788 ASSERT (os_get_cpu_number () == 0);
790 return alloc_from_free_list
792 pool_elt_at_index (bm->buffer_free_list_pool,
793 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
798 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
800 u32 n_buffers, u32 free_list_index)
802 vlib_buffer_main_t *bm = vm->buffer_main;
803 vlib_buffer_free_list_t *f;
804 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
805 return alloc_from_free_list (vm, f, buffers, n_buffers);
809 add_buffer_to_free_list (vlib_main_t * vm,
810 vlib_buffer_free_list_t * f,
811 u32 buffer_index, u8 do_init)
814 b = vlib_get_buffer (vm, buffer_index);
815 if (PREDICT_TRUE (do_init))
816 vlib_buffer_init_for_free_list (b, f);
817 vec_add1_aligned (f->aligned_buffers, buffer_index,
818 sizeof (vlib_copy_unit_t));
821 always_inline vlib_buffer_free_list_t *
822 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
824 vlib_buffer_main_t *bm = vm->buffer_main;
827 *index = i = b->free_list_index;
828 return pool_elt_at_index (bm->buffer_free_list_pool, i);
832 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
834 vlib_buffer_main_t *bm = vm->buffer_main;
835 void *rv = bm->buffer_free_callback;
837 bm->buffer_free_callback = fp;
841 void vnet_buffer_free_dpdk_mb (vlib_buffer_t * b) __attribute__ ((weak));
843 vnet_buffer_free_dpdk_mb (vlib_buffer_t * b)
847 static_always_inline void
848 vlib_buffer_free_inline (vlib_main_t * vm,
849 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
851 vlib_buffer_main_t *bm = vm->buffer_main;
852 vlib_buffer_free_list_t *fl;
853 static u32 *next_to_free[2]; /* smp bad */
854 u32 i_next_to_free, *b, *n, *f, fi;
857 static vlib_buffer_free_list_t **announce_list;
858 vlib_buffer_free_list_t *fl0 = 0, *fl1 = 0;
859 u32 bi0 = (u32) ~ 0, bi1 = (u32) ~ 0, fi0, fi1 = (u32) ~ 0;
860 u8 free0, free1 = 0, free_next0, free_next1;
861 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
862 u32 follow_buffer_next);
864 ASSERT (os_get_cpu_number () == 0);
866 cb = bm->buffer_free_callback;
868 if (PREDICT_FALSE (cb != 0))
869 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
874 /* Use first buffer to get default free list. */
876 u32 bi0 = buffers[0];
879 b0 = vlib_get_buffer (vm, bi0);
880 fl = buffer_get_free_list (vm, b0, &fi);
881 if (fl->buffers_added_to_freelist_function)
882 vec_add1 (announce_list, fl);
885 vec_validate (next_to_free[0], n_buffers - 1);
886 vec_validate (next_to_free[1], n_buffers - 1);
893 /* Verify that buffers are known allocated. */
894 vlib_buffer_validate_alloc_free (vm, b,
895 n_left, VLIB_BUFFER_KNOWN_ALLOCATED);
897 vec_add2_aligned (fl->aligned_buffers, f, n_left,
898 /* align */ sizeof (vlib_copy_unit_t));
900 n = next_to_free[i_next_to_free];
903 vlib_buffer_t *b0, *b1, *binit0, *binit1, dummy_buffers[2];
914 /* Prefetch buffers for next iteration. */
915 vlib_prefetch_buffer_with_index (vm, b[0], WRITE);
916 vlib_prefetch_buffer_with_index (vm, b[1], WRITE);
918 b0 = vlib_get_buffer (vm, bi0);
919 b1 = vlib_get_buffer (vm, bi1);
921 free0 = (b0->flags & VLIB_BUFFER_RECYCLE) == 0;
922 free1 = (b1->flags & VLIB_BUFFER_RECYCLE) == 0;
924 /* Must be before init which will over-write buffer flags. */
925 if (follow_buffer_next)
927 n[0] = b0->next_buffer;
928 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
931 n[0] = b1->next_buffer;
932 free_next1 = free1 && (b1->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
936 free_next0 = free_next1 = 0;
938 /* Must be before init which will over-write buffer free list. */
939 fi0 = b0->free_list_index;
940 fi1 = b1->free_list_index;
942 if (PREDICT_FALSE (fi0 != fi || fi1 != fi))
945 binit0 = free0 ? b0 : &dummy_buffers[0];
946 binit1 = free1 ? b1 : &dummy_buffers[1];
948 vlib_buffer_init_two_for_free_list (binit0, binit1, fl);
952 /* Backup speculation. */
954 n -= free_next0 + free_next1;
956 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
958 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
959 fl1 = pool_elt_at_index (bm->buffer_free_list_pool, fi1);
961 add_buffer_to_free_list (vm, fl0, bi0, free0);
962 if (PREDICT_FALSE (fl0->buffers_added_to_freelist_function != 0))
965 for (i = 0; i < vec_len (announce_list); i++)
966 if (fl0 == announce_list[i])
968 vec_add1 (announce_list, fl0);
971 if (PREDICT_FALSE (fl1->buffers_added_to_freelist_function != 0))
974 for (i = 0; i < vec_len (announce_list); i++)
975 if (fl1 == announce_list[i])
977 vec_add1 (announce_list, fl1);
981 add_buffer_to_free_list (vm, fl1, bi1, free1);
983 /* Possibly change current free list. */
984 if (fi0 != fi && fi1 != fi)
987 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
990 vec_add2_aligned (fl->aligned_buffers, f, n_left,
991 /* align */ sizeof (vlib_copy_unit_t));
996 vlib_buffer_t *b0, *binit0, dummy_buffers[1];
1004 b0 = vlib_get_buffer (vm, bi0);
1006 free0 = (b0->flags & VLIB_BUFFER_RECYCLE) == 0;
1008 /* Must be before init which will over-write buffer flags. */
1009 if (follow_buffer_next)
1011 n[0] = b0->next_buffer;
1012 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
1018 /* Must be before init which will over-write buffer free list. */
1019 fi0 = b0->free_list_index;
1021 if (PREDICT_FALSE (fi0 != fi))
1024 binit0 = free0 ? b0 : &dummy_buffers[0];
1026 vlib_buffer_init_for_free_list (binit0, fl);
1030 /* Backup speculation. */
1034 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1036 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
1038 add_buffer_to_free_list (vm, fl0, bi0, free0);
1039 if (PREDICT_FALSE (fl0->buffers_added_to_freelist_function != 0))
1042 for (i = 0; i < vec_len (announce_list); i++)
1043 if (fl0 == announce_list[i])
1045 vec_add1 (announce_list, fl0);
1050 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
1052 vec_add2_aligned (fl->aligned_buffers, f, n_left,
1053 /* align */ sizeof (vlib_copy_unit_t));
1056 if (follow_buffer_next && ((n_left = n - next_to_free[i_next_to_free]) > 0))
1058 b = next_to_free[i_next_to_free];
1059 i_next_to_free ^= 1;
1063 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1065 if (vec_len (announce_list))
1067 vlib_buffer_free_list_t *fl;
1068 for (i = 0; i < vec_len (announce_list); i++)
1070 fl = announce_list[i];
1071 fl->buffers_added_to_freelist_function (vm, fl);
1073 _vec_len (announce_list) = 0;
1078 vlib_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
1080 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
1085 vlib_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
1087 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
1091 /* Copy template packet data into buffers as they are allocated. */
1093 vlib_packet_template_buffer_init (vlib_main_t * vm,
1094 vlib_buffer_free_list_t * fl,
1095 u32 * buffers, u32 n_buffers)
1097 vlib_packet_template_t *t =
1098 uword_to_pointer (fl->buffer_init_function_opaque,
1099 vlib_packet_template_t *);
1102 for (i = 0; i < n_buffers; i++)
1104 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
1105 ASSERT (b->current_length == vec_len (t->packet_data));
1106 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
1112 vlib_packet_template_init (vlib_main_t * vm,
1113 vlib_packet_template_t * t,
1115 uword n_packet_data_bytes,
1116 uword min_n_buffers_each_physmem_alloc,
1119 vlib_buffer_free_list_t *fl;
1124 name = va_format (0, fmt, &va);
1127 memset (t, 0, sizeof (t[0]));
1129 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
1130 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
1132 t->free_list_index = vlib_buffer_create_free_list_helper
1133 (vm, n_packet_data_bytes,
1138 ASSERT (t->free_list_index != 0);
1139 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
1140 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
1142 fl->buffer_init_function = vlib_packet_template_buffer_init;
1143 fl->buffer_init_function_opaque = pointer_to_uword (t);
1145 fl->buffer_init_template.current_data = 0;
1146 fl->buffer_init_template.current_length = n_packet_data_bytes;
1147 fl->buffer_init_template.flags = 0;
1151 vlib_packet_template_get_packet (vlib_main_t * vm,
1152 vlib_packet_template_t * t, u32 * bi_result)
1157 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
1162 b = vlib_get_buffer (vm, bi);
1163 clib_memcpy (vlib_buffer_get_current (b),
1164 t->packet_data, vec_len (t->packet_data));
1165 b->current_length = vec_len (t->packet_data);
1171 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
1172 vlib_packet_template_t * t)
1174 word n = t->min_n_buffers_each_physmem_alloc;
1175 word l = vec_len (t->packet_data);
1179 ASSERT (vec_len (t->free_buffers) == 0);
1181 vec_validate (t->free_buffers, n - 1);
1182 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
1183 n, t->free_list_index);
1184 _vec_len (t->free_buffers) = n_alloc;
1187 /* Append given data to end of buffer, possibly allocating new buffers. */
1189 vlib_buffer_add_data (vlib_main_t * vm,
1190 u32 free_list_index,
1191 u32 buffer_index, void *data, u32 n_data_bytes)
1193 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
1199 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
1200 goto out_of_buffers;
1203 n_left = n_data_bytes;
1204 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
1206 b = vlib_get_buffer (vm, bi);
1207 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1209 /* Get to the end of the chain before we try to append data... */
1210 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1211 b = vlib_get_buffer (vm, b->next_buffer);
1217 ASSERT (n_buffer_bytes >= b->current_length);
1218 n_left_this_buffer =
1219 n_buffer_bytes - (b->current_data + b->current_length);
1220 n = clib_min (n_left_this_buffer, n_left);
1221 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
1222 b->current_length += n;
1229 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
1231 goto out_of_buffers;
1233 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1235 b = vlib_get_buffer (vm, b->next_buffer);
1241 clib_error ("out of buffers");
1246 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1247 u32 free_list_index,
1248 vlib_buffer_t * first,
1249 vlib_buffer_t ** last,
1250 void *data, u16 data_len)
1252 vlib_buffer_t *l = *last;
1253 u32 n_buffer_bytes =
1254 vlib_buffer_free_list_buffer_size (vm, free_list_index);
1256 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
1259 u16 max = n_buffer_bytes - l->current_length - l->current_data;
1263 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
1266 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
1267 max = n_buffer_bytes - l->current_length - l->current_data;
1270 u16 len = (data_len > max) ? max : data_len;
1271 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
1272 data + copied, len);
1273 vlib_buffer_chain_increase_length (first, l, len);
1281 * Fills in the required rte_mbuf fields for chained buffers given a VLIB chain.
1284 vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * b_first)
1290 vlib_serialize_tx (serialize_main_header_t * m, serialize_stream_t * s)
1293 vlib_serialize_buffer_main_t *sm;
1294 uword n, n_bytes_to_write;
1295 vlib_buffer_t *last;
1297 n_bytes_to_write = s->current_buffer_index;
1299 uword_to_pointer (s->data_function_opaque,
1300 vlib_serialize_buffer_main_t *);
1303 ASSERT (sm->tx.max_n_data_bytes_per_chain > 0);
1304 if (serialize_stream_is_end_of_stream (s)
1305 || sm->tx.n_total_data_bytes + n_bytes_to_write >
1306 sm->tx.max_n_data_bytes_per_chain)
1308 vlib_process_t *p = vlib_get_current_process (vm);
1310 last = vlib_get_buffer (vm, sm->last_buffer);
1311 last->current_length = n_bytes_to_write;
1313 vlib_set_next_frame_buffer (vm, &p->node_runtime, sm->tx.next_index,
1316 sm->first_buffer = sm->last_buffer = ~0;
1317 sm->tx.n_total_data_bytes = 0;
1320 else if (n_bytes_to_write == 0 && s->n_buffer_bytes == 0)
1322 ASSERT (sm->first_buffer == ~0);
1323 ASSERT (sm->last_buffer == ~0);
1325 vlib_buffer_alloc_from_free_list (vm, &sm->first_buffer, 1,
1326 sm->tx.free_list_index);
1330 ("vlib_buffer_alloc_from_free_list fails"));
1331 sm->last_buffer = sm->first_buffer;
1333 vlib_buffer_free_list_buffer_size (vm, sm->tx.free_list_index);
1336 if (n_bytes_to_write > 0)
1338 vlib_buffer_t *prev = vlib_get_buffer (vm, sm->last_buffer);
1340 vlib_buffer_alloc_from_free_list (vm, &sm->last_buffer, 1,
1341 sm->tx.free_list_index);
1345 ("vlib_buffer_alloc_from_free_list fails"));
1346 sm->tx.n_total_data_bytes += n_bytes_to_write;
1347 prev->current_length = n_bytes_to_write;
1348 prev->next_buffer = sm->last_buffer;
1349 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
1352 if (sm->last_buffer != ~0)
1354 last = vlib_get_buffer (vm, sm->last_buffer);
1355 s->buffer = vlib_buffer_get_current (last);
1356 s->current_buffer_index = 0;
1357 ASSERT (last->current_data == s->current_buffer_index);
1362 vlib_serialize_rx (serialize_main_header_t * m, serialize_stream_t * s)
1365 vlib_serialize_buffer_main_t *sm;
1366 vlib_buffer_t *last;
1369 uword_to_pointer (s->data_function_opaque,
1370 vlib_serialize_buffer_main_t *);
1373 if (serialize_stream_is_end_of_stream (s))
1376 if (sm->last_buffer != ~0)
1378 last = vlib_get_buffer (vm, sm->last_buffer);
1380 if (last->flags & VLIB_BUFFER_NEXT_PRESENT)
1381 sm->last_buffer = last->next_buffer;
1384 vlib_buffer_free (vm, &sm->first_buffer, /* count */ 1);
1385 sm->first_buffer = sm->last_buffer = ~0;
1389 if (sm->last_buffer == ~0)
1391 while (clib_fifo_elts (sm->rx.buffer_fifo) == 0)
1393 sm->rx.ready_one_time_event =
1394 vlib_process_create_one_time_event (vm, vlib_current_process (vm),
1396 vlib_process_wait_for_one_time_event (vm, /* no event data */ 0,
1397 sm->rx.ready_one_time_event);
1400 clib_fifo_sub1 (sm->rx.buffer_fifo, sm->first_buffer);
1401 sm->last_buffer = sm->first_buffer;
1404 ASSERT (sm->last_buffer != ~0);
1406 last = vlib_get_buffer (vm, sm->last_buffer);
1407 s->current_buffer_index = 0;
1408 s->buffer = vlib_buffer_get_current (last);
1409 s->n_buffer_bytes = last->current_length;
1413 serialize_open_vlib_helper (serialize_main_t * m,
1415 vlib_serialize_buffer_main_t * sm, uword is_read)
1417 /* Initialize serialize main but save overflow buffer for re-use between calls. */
1419 u8 *save = m->stream.overflow_buffer;
1420 memset (m, 0, sizeof (m[0]));
1421 m->stream.overflow_buffer = save;
1423 _vec_len (save) = 0;
1426 sm->first_buffer = sm->last_buffer = ~0;
1428 clib_fifo_reset (sm->rx.buffer_fifo);
1430 sm->tx.n_total_data_bytes = 0;
1432 m->header.data_function = is_read ? vlib_serialize_rx : vlib_serialize_tx;
1433 m->stream.data_function_opaque = pointer_to_uword (sm);
1437 serialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm,
1438 vlib_serialize_buffer_main_t * sm)
1440 serialize_open_vlib_helper (m, vm, sm, /* is_read */ 0);
1444 unserialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm,
1445 vlib_serialize_buffer_main_t * sm)
1447 serialize_open_vlib_helper (m, vm, sm, /* is_read */ 1);
1451 serialize_close_vlib_buffer (serialize_main_t * m)
1453 vlib_serialize_buffer_main_t *sm
1454 = uword_to_pointer (m->stream.data_function_opaque,
1455 vlib_serialize_buffer_main_t *);
1456 vlib_buffer_t *last;
1457 serialize_stream_t *s = &m->stream;
1459 last = vlib_get_buffer (sm->vlib_main, sm->last_buffer);
1460 last->current_length = s->current_buffer_index;
1462 if (vec_len (s->overflow_buffer) > 0)
1465 = vlib_buffer_add_data (sm->vlib_main, sm->tx.free_list_index,
1466 sm->last_buffer == ~0 ? 0 : sm->last_buffer,
1468 vec_len (s->overflow_buffer));
1469 _vec_len (s->overflow_buffer) = 0;
1472 return sm->first_buffer;
1476 unserialize_close_vlib_buffer (serialize_main_t * m)
1478 vlib_serialize_buffer_main_t *sm
1479 = uword_to_pointer (m->stream.data_function_opaque,
1480 vlib_serialize_buffer_main_t *);
1481 if (sm->first_buffer != ~0)
1482 vlib_buffer_free_one (sm->vlib_main, sm->first_buffer);
1483 clib_fifo_reset (sm->rx.buffer_fifo);
1484 if (m->stream.overflow_buffer)
1485 _vec_len (m->stream.overflow_buffer) = 0;
1489 format_vlib_buffer_free_list (u8 * s, va_list * va)
1491 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
1492 uword bytes_alloc, bytes_free, n_free, size;
1495 return format (s, "%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1496 "Name", "Index", "Size", "Alloc", "Free", "#Alloc",
1499 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1500 n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1501 bytes_alloc = size * f->n_alloc;
1502 bytes_free = size * n_free;
1504 s = format (s, "%30s%12d%12d%=12U%=12U%=12d%=12d",
1505 f->name, f->index, f->n_data_bytes,
1506 format_memory_size, bytes_alloc,
1507 format_memory_size, bytes_free, f->n_alloc, n_free);
1512 static clib_error_t *
1513 show_buffers (vlib_main_t * vm,
1514 unformat_input_t * input, vlib_cli_command_t * cmd)
1516 vlib_buffer_main_t *bm = vm->buffer_main;
1517 vlib_buffer_free_list_t *f;
1519 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0);
1521 pool_foreach (f, bm->buffer_free_list_pool, ({
1522 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f);
1530 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1531 .path = "show buffers",
1532 .short_help = "Show packet buffer allocation",
1533 .function = show_buffers,
1539 * fd.io coding-style-patch-verification: ON
1542 * eval: (c-set-style "gnu")