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.
40 #include <vlib/vlib.h>
43 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
44 vlib_buffer_t * b_first)
46 vlib_buffer_t *b = b_first;
47 uword l_first = b_first->current_length;
49 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
51 b = vlib_get_buffer (vm, b->next_buffer);
52 l += b->current_length;
54 b_first->total_length_not_including_first_buffer = l;
55 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
60 format_vlib_buffer (u8 * s, va_list * args)
62 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
64 s = format (s, "current data %d, length %d, free-list %d",
65 b->current_data, b->current_length, b->free_list_index);
67 if (b->flags & VLIB_BUFFER_IS_TRACED)
68 s = format (s, ", trace 0x%x", b->trace_index);
70 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
71 s = format (s, ", next-buffer 0x%x", b->next_buffer);
77 format_vlib_buffer_and_data (u8 * s, va_list * args)
79 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
81 s = format (s, "%U, %U",
82 format_vlib_buffer, b,
83 format_hex_bytes, vlib_buffer_get_current (b), 64);
89 format_vlib_buffer_known_state (u8 * s, va_list * args)
91 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
96 case VLIB_BUFFER_UNKNOWN:
100 case VLIB_BUFFER_KNOWN_ALLOCATED:
101 t = "known-allocated";
104 case VLIB_BUFFER_KNOWN_FREE:
113 return format (s, "%s", t);
117 format_vlib_buffer_contents (u8 * s, va_list * va)
119 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
120 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
124 vec_add (s, vlib_buffer_get_current (b), b->current_length);
125 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
127 b = vlib_get_buffer (vm, b->next_buffer);
134 vlib_validate_buffer_helper (vlib_main_t * vm,
136 uword follow_buffer_next, uword ** unique_hash)
138 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
139 vlib_buffer_main_t *bm = vm->buffer_main;
140 vlib_buffer_free_list_t *fl;
142 if (pool_is_free_index (bm->buffer_free_list_pool, b->free_list_index))
143 return format (0, "unknown free list 0x%x", b->free_list_index);
145 fl = pool_elt_at_index (bm->buffer_free_list_pool, b->free_list_index);
147 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
148 return format (0, "current data %d before pre-data", b->current_data);
150 if (b->current_data + b->current_length > fl->n_data_bytes)
151 return format (0, "%d-%d beyond end of buffer %d",
152 b->current_data, b->current_length, fl->n_data_bytes);
155 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
157 vlib_buffer_known_state_t k;
160 k = vlib_buffer_is_known (vm, b->next_buffer);
161 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
162 return format (0, "next 0x%x: %U",
163 b->next_buffer, format_vlib_buffer_known_state, k);
167 if (hash_get (*unique_hash, b->next_buffer))
168 return format (0, "duplicate buffer 0x%x", b->next_buffer);
170 hash_set1 (*unique_hash, b->next_buffer);
173 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
176 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
186 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
188 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
189 /* unique_hash */ 0);
193 vlib_validate_buffers (vlib_main_t * vm,
195 uword next_buffer_stride,
197 vlib_buffer_known_state_t known_state,
198 uword follow_buffer_next)
201 u32 bi, *b = buffers;
202 vlib_buffer_known_state_t k;
203 u8 *msg = 0, *result = 0;
205 hash = hash_create (0, 0);
206 for (i = 0; i < n_buffers; i++)
209 b += next_buffer_stride;
211 /* Buffer is not unique. */
212 if (hash_get (hash, bi))
214 msg = format (0, "not unique");
218 k = vlib_buffer_is_known (vm, bi);
219 if (k != known_state)
221 msg = format (0, "is %U; expected %U",
222 format_vlib_buffer_known_state, k,
223 format_vlib_buffer_known_state, known_state);
227 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
231 hash_set1 (hash, bi);
237 result = format (0, "0x%x: %v", bi, msg);
244 vlib_main_t **vlib_mains;
246 /* When dubugging validate that given buffers are either known allocated
249 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
252 vlib_buffer_known_state_t expected_state)
255 uword i, bi, is_free;
260 ASSERT (os_get_cpu_number () == 0);
262 /* smp disaster check */
264 ASSERT (vm == vlib_mains[0]);
266 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
268 for (i = 0; i < n_buffers; i++)
270 vlib_buffer_known_state_t known;
274 known = vlib_buffer_is_known (vm, bi);
275 if (known != expected_state)
279 (vm, "%s %U buffer 0x%x",
280 is_free ? "freeing" : "allocating",
281 format_vlib_buffer_known_state, known, bi);
284 vlib_buffer_set_known_state
286 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
290 /* Aligned copy routine. */
292 vlib_aligned_memcpy (void *_dst, void *_src, int n_bytes)
294 vlib_copy_unit_t *dst = _dst;
295 vlib_copy_unit_t *src = _src;
297 /* Arguments must be naturally aligned. */
298 ASSERT (pointer_to_uword (dst) % sizeof (dst[0]) == 0);
299 ASSERT (pointer_to_uword (src) % sizeof (src[0]) == 0);
300 ASSERT (n_bytes % sizeof (dst[0]) == 0);
302 if (4 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
304 CLIB_PREFETCH (dst + 0, 4 * sizeof (dst[0]), WRITE);
305 CLIB_PREFETCH (src + 0, 4 * sizeof (src[0]), READ);
307 while (n_bytes >= 4 * sizeof (dst[0]))
311 n_bytes -= 4 * sizeof (dst[0]);
312 CLIB_PREFETCH (dst, 4 * sizeof (dst[0]), WRITE);
313 CLIB_PREFETCH (src, 4 * sizeof (src[0]), READ);
320 else if (8 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
322 CLIB_PREFETCH (dst + 0, 8 * sizeof (dst[0]), WRITE);
323 CLIB_PREFETCH (src + 0, 8 * sizeof (src[0]), READ);
325 while (n_bytes >= 8 * sizeof (dst[0]))
329 n_bytes -= 8 * sizeof (dst[0]);
330 CLIB_PREFETCH (dst, 8 * sizeof (dst[0]), WRITE);
331 CLIB_PREFETCH (src, 8 * sizeof (src[0]), READ);
343 /* Cache line size unknown: fall back to slow version. */ ;
348 n_bytes -= 1 * sizeof (dst[0]);
352 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
354 /* Make sure we have at least given number of unaligned buffers. */
356 fill_unaligned (vlib_main_t * vm,
357 vlib_buffer_free_list_t * free_list,
358 uword n_unaligned_buffers)
360 word la = vec_len (free_list->aligned_buffers);
361 word lu = vec_len (free_list->unaligned_buffers);
363 /* Aligned come in aligned copy-sized chunks. */
364 ASSERT (la % BUFFERS_PER_COPY == 0);
366 ASSERT (la >= n_unaligned_buffers);
368 while (lu < n_unaligned_buffers)
370 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
371 vec_add (free_list->unaligned_buffers,
372 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
374 la -= BUFFERS_PER_COPY;
375 lu += BUFFERS_PER_COPY;
377 _vec_len (free_list->aligned_buffers) = la;
380 /* After free aligned buffers may not contain even sized chunks. */
382 trim_aligned (vlib_buffer_free_list_t * f)
386 /* Add unaligned to aligned before trim. */
387 l = vec_len (f->unaligned_buffers);
390 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
391 /* align */ sizeof (vlib_copy_unit_t));
393 _vec_len (f->unaligned_buffers) = 0;
396 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
397 l = vec_len (f->aligned_buffers);
398 n_trim = l % BUFFERS_PER_COPY;
401 /* Trim aligned -> unaligned. */
402 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
404 /* Remove from aligned. */
405 _vec_len (f->aligned_buffers) = l - n_trim;
410 merge_free_lists (vlib_buffer_free_list_t * dst,
411 vlib_buffer_free_list_t * src)
419 l = vec_len (src->aligned_buffers);
422 vec_add2_aligned (dst->aligned_buffers, d, l,
423 /* align */ sizeof (vlib_copy_unit_t));
424 vlib_aligned_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
425 vec_free (src->aligned_buffers);
428 l = vec_len (src->unaligned_buffers);
431 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
432 vec_free (src->unaligned_buffers);
437 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
439 vlib_buffer_main_t *bm = vm->buffer_main;
441 size = vlib_buffer_round_size (size);
442 uword *p = hash_get (bm->free_list_by_size, size);
443 return p ? p[0] : ~0;
446 /* Add buffer free list. */
448 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
450 u32 is_public, u32 is_default, u8 * name)
452 vlib_buffer_main_t *bm = vm->buffer_main;
453 vlib_buffer_free_list_t *f;
455 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
457 u32 default_free_free_list_index;
459 default_free_free_list_index = vlib_buffer_create_free_list_helper (vm,
460 /* default buffer size */
461 VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
469 ASSERT (default_free_free_list_index ==
470 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
472 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
473 return default_free_free_list_index;
476 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
478 memset (f, 0, sizeof (f[0]));
479 f->index = f - bm->buffer_free_list_pool;
480 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
481 f->min_n_buffers_each_physmem_alloc = 256;
482 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
484 /* Setup free buffer template. */
485 f->buffer_init_template.free_list_index = f->index;
489 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
491 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
498 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
505 name = va_format (0, fmt, &va);
508 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
515 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
518 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
526 name = va_format (0, fmt, &va);
529 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
539 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
543 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
544 vm->os_physmem_free (f->buffer_memory_allocated[i]);
546 vec_free (f->buffer_memory_allocated);
547 vec_free (f->unaligned_buffers);
548 vec_free (f->aligned_buffers);
551 /* Add buffer free list. */
553 vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
555 vlib_buffer_main_t *bm = vm->buffer_main;
556 vlib_buffer_free_list_t *f;
559 f = vlib_buffer_get_free_list (vm, free_list_index);
561 ASSERT (vec_len (f->unaligned_buffers) + vec_len (f->aligned_buffers) ==
563 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
564 if (merge_index != ~0 && merge_index != free_list_index)
566 merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
570 del_free_list (vm, f);
573 memset (f, 0xab, sizeof (f[0]));
575 pool_put (bm->buffer_free_list_pool, f);
578 /* Make sure free list has at least given number of free buffers. */
580 fill_free_list (vlib_main_t * vm,
581 vlib_buffer_free_list_t * fl, uword min_free_buffers)
583 vlib_buffer_t *buffers, *b;
586 u32 n_remaining, n_alloc, n_this_chunk;
590 /* Already have enough free buffers on free list? */
591 n = min_free_buffers - vec_len (fl->aligned_buffers);
593 return min_free_buffers;
595 /* Always allocate round number of buffers. */
596 n = round_pow2 (n, BUFFERS_PER_COPY);
598 /* Always allocate new buffers in reasonably large sized chunks. */
599 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
603 while (n_remaining > 0)
605 n_this_chunk = clib_min (n_remaining, 16);
607 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
609 /* drb: removed power-of-2 ASSERT */
610 buffers = vm->os_physmem_alloc_aligned (&vm->physmem_main,
612 sizeof (vlib_buffer_t));
616 /* Record chunk as being allocated so we can free it later. */
617 vec_add1 (fl->buffer_memory_allocated, buffers);
619 fl->n_alloc += n_this_chunk;
620 n_alloc += n_this_chunk;
621 n_remaining -= n_this_chunk;
624 vec_add2_aligned (fl->aligned_buffers, bi, n_this_chunk,
625 sizeof (vlib_copy_unit_t));
626 for (i = 0; i < n_this_chunk; i++)
628 bi[i] = vlib_get_buffer_index (vm, b);
631 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
632 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
635 memset (buffers, 0, n_bytes);
637 /* Initialize all new buffers. */
639 for (i = 0; i < n_this_chunk; i++)
641 vlib_buffer_init_for_free_list (b, fl);
642 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
645 if (fl->buffer_init_function)
646 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
652 copy_alignment (u32 * x)
654 return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY;
658 alloc_from_free_list (vlib_main_t * vm,
659 vlib_buffer_free_list_t * free_list,
660 u32 * alloc_buffers, u32 n_alloc_buffers)
664 uword n_unaligned_start, n_unaligned_end, n_filled;
666 ASSERT (os_get_cpu_number () == 0);
668 n_left = n_alloc_buffers;
670 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
671 & (BUFFERS_PER_COPY - 1));
673 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
677 n_left = n_filled < n_left ? n_filled : n_left;
678 n_alloc_buffers = n_left;
680 if (n_unaligned_start >= n_left)
682 n_unaligned_start = n_left;
686 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
688 fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
690 u_len = vec_len (free_list->unaligned_buffers);
691 u_src = free_list->unaligned_buffers + u_len - 1;
693 if (n_unaligned_start)
695 uword n_copy = n_unaligned_start;
707 /* Now dst should be aligned. */
709 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
714 vlib_copy_unit_t *d, *s;
717 if (vec_len (free_list->aligned_buffers) <
718 ((n_left / BUFFERS_PER_COPY) * BUFFERS_PER_COPY))
721 n_copy = n_left / BUFFERS_PER_COPY;
722 n_left = n_left % BUFFERS_PER_COPY;
724 /* Remove buffers from aligned free list. */
725 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
727 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
728 d = (vlib_copy_unit_t *) dst;
730 /* Fast path loop. */
753 /* Unaligned copy. */
754 ASSERT (n_unaligned_end == n_left);
762 if (!free_list->unaligned_buffers)
765 _vec_len (free_list->unaligned_buffers) = u_len;
767 /* Verify that buffers are known free. */
768 vlib_buffer_validate_alloc_free (vm, alloc_buffers,
769 n_alloc_buffers, VLIB_BUFFER_KNOWN_FREE);
771 return n_alloc_buffers;
774 /* Allocate a given number of buffers into given array.
775 Returns number actually allocated which will be either zero or
778 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
780 vlib_buffer_main_t *bm = vm->buffer_main;
781 ASSERT (os_get_cpu_number () == 0);
783 return alloc_from_free_list
785 pool_elt_at_index (bm->buffer_free_list_pool,
786 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
791 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
793 u32 n_buffers, u32 free_list_index)
795 vlib_buffer_main_t *bm = vm->buffer_main;
796 vlib_buffer_free_list_t *f;
797 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
798 return alloc_from_free_list (vm, f, buffers, n_buffers);
802 add_buffer_to_free_list (vlib_main_t * vm,
803 vlib_buffer_free_list_t * f,
804 u32 buffer_index, u8 do_init)
807 b = vlib_get_buffer (vm, buffer_index);
808 if (PREDICT_TRUE (do_init))
809 vlib_buffer_init_for_free_list (b, f);
810 vec_add1_aligned (f->aligned_buffers, buffer_index,
811 sizeof (vlib_copy_unit_t));
814 always_inline vlib_buffer_free_list_t *
815 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
817 vlib_buffer_main_t *bm = vm->buffer_main;
820 *index = i = b->free_list_index;
821 return pool_elt_at_index (bm->buffer_free_list_pool, i);
825 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
827 vlib_buffer_main_t *bm = vm->buffer_main;
828 void *rv = bm->buffer_free_callback;
830 bm->buffer_free_callback = fp;
834 void vnet_buffer_free_dpdk_mb (vlib_buffer_t * b) __attribute__ ((weak));
836 vnet_buffer_free_dpdk_mb (vlib_buffer_t * b)
840 static_always_inline void
841 vlib_buffer_free_inline (vlib_main_t * vm,
842 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
844 vlib_buffer_main_t *bm = vm->buffer_main;
845 vlib_buffer_free_list_t *fl;
846 static u32 *next_to_free[2]; /* smp bad */
847 u32 i_next_to_free, *b, *n, *f, fi;
850 static vlib_buffer_free_list_t **announce_list;
851 vlib_buffer_free_list_t *fl0 = 0, *fl1 = 0;
852 u32 bi0 = (u32) ~ 0, bi1 = (u32) ~ 0, fi0, fi1 = (u32) ~ 0;
853 u8 free0, free1 = 0, free_next0, free_next1;
854 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
855 u32 follow_buffer_next);
857 ASSERT (os_get_cpu_number () == 0);
859 cb = bm->buffer_free_callback;
861 if (PREDICT_FALSE (cb != 0))
862 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
867 /* Use first buffer to get default free list. */
869 u32 bi0 = buffers[0];
872 b0 = vlib_get_buffer (vm, bi0);
873 fl = buffer_get_free_list (vm, b0, &fi);
874 if (fl->buffers_added_to_freelist_function)
875 vec_add1 (announce_list, fl);
878 vec_validate (next_to_free[0], n_buffers - 1);
879 vec_validate (next_to_free[1], n_buffers - 1);
886 /* Verify that buffers are known allocated. */
887 vlib_buffer_validate_alloc_free (vm, b,
888 n_left, VLIB_BUFFER_KNOWN_ALLOCATED);
890 vec_add2_aligned (fl->aligned_buffers, f, n_left,
891 /* align */ sizeof (vlib_copy_unit_t));
893 n = next_to_free[i_next_to_free];
896 vlib_buffer_t *b0, *b1, *binit0, *binit1, dummy_buffers[2];
907 /* Prefetch buffers for next iteration. */
908 vlib_prefetch_buffer_with_index (vm, b[0], WRITE);
909 vlib_prefetch_buffer_with_index (vm, b[1], WRITE);
911 b0 = vlib_get_buffer (vm, bi0);
912 b1 = vlib_get_buffer (vm, bi1);
914 free0 = (b0->flags & VLIB_BUFFER_RECYCLE) == 0;
915 free1 = (b1->flags & VLIB_BUFFER_RECYCLE) == 0;
917 /* Must be before init which will over-write buffer flags. */
918 if (follow_buffer_next)
920 n[0] = b0->next_buffer;
921 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
924 n[0] = b1->next_buffer;
925 free_next1 = free1 && (b1->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
929 free_next0 = free_next1 = 0;
931 /* Must be before init which will over-write buffer free list. */
932 fi0 = b0->free_list_index;
933 fi1 = b1->free_list_index;
935 if (PREDICT_FALSE (fi0 != fi || fi1 != fi))
938 binit0 = free0 ? b0 : &dummy_buffers[0];
939 binit1 = free1 ? b1 : &dummy_buffers[1];
941 vlib_buffer_init_two_for_free_list (binit0, binit1, fl);
945 /* Backup speculation. */
947 n -= free_next0 + free_next1;
949 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
951 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
952 fl1 = pool_elt_at_index (bm->buffer_free_list_pool, fi1);
954 add_buffer_to_free_list (vm, fl0, bi0, free0);
955 if (PREDICT_FALSE (fl0->buffers_added_to_freelist_function != 0))
958 for (i = 0; i < vec_len (announce_list); i++)
959 if (fl0 == announce_list[i])
961 vec_add1 (announce_list, fl0);
964 if (PREDICT_FALSE (fl1->buffers_added_to_freelist_function != 0))
967 for (i = 0; i < vec_len (announce_list); i++)
968 if (fl1 == announce_list[i])
970 vec_add1 (announce_list, fl1);
974 add_buffer_to_free_list (vm, fl1, bi1, free1);
976 /* Possibly change current free list. */
977 if (fi0 != fi && fi1 != fi)
980 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
983 vec_add2_aligned (fl->aligned_buffers, f, n_left,
984 /* align */ sizeof (vlib_copy_unit_t));
989 vlib_buffer_t *b0, *binit0, dummy_buffers[1];
997 b0 = vlib_get_buffer (vm, bi0);
999 free0 = (b0->flags & VLIB_BUFFER_RECYCLE) == 0;
1001 /* Must be before init which will over-write buffer flags. */
1002 if (follow_buffer_next)
1004 n[0] = b0->next_buffer;
1005 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
1011 /* Must be before init which will over-write buffer free list. */
1012 fi0 = b0->free_list_index;
1014 if (PREDICT_FALSE (fi0 != fi))
1017 binit0 = free0 ? b0 : &dummy_buffers[0];
1019 vlib_buffer_init_for_free_list (binit0, fl);
1023 /* Backup speculation. */
1027 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1029 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
1031 add_buffer_to_free_list (vm, fl0, bi0, free0);
1032 if (PREDICT_FALSE (fl0->buffers_added_to_freelist_function != 0))
1035 for (i = 0; i < vec_len (announce_list); i++)
1036 if (fl0 == announce_list[i])
1038 vec_add1 (announce_list, fl0);
1043 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
1045 vec_add2_aligned (fl->aligned_buffers, f, n_left,
1046 /* align */ sizeof (vlib_copy_unit_t));
1049 if (follow_buffer_next && ((n_left = n - next_to_free[i_next_to_free]) > 0))
1051 b = next_to_free[i_next_to_free];
1052 i_next_to_free ^= 1;
1056 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1058 if (vec_len (announce_list))
1060 vlib_buffer_free_list_t *fl;
1061 for (i = 0; i < vec_len (announce_list); i++)
1063 fl = announce_list[i];
1064 fl->buffers_added_to_freelist_function (vm, fl);
1066 _vec_len (announce_list) = 0;
1071 vlib_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
1073 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
1078 vlib_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
1080 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
1084 /* Copy template packet data into buffers as they are allocated. */
1086 vlib_packet_template_buffer_init (vlib_main_t * vm,
1087 vlib_buffer_free_list_t * fl,
1088 u32 * buffers, u32 n_buffers)
1090 vlib_packet_template_t *t =
1091 uword_to_pointer (fl->buffer_init_function_opaque,
1092 vlib_packet_template_t *);
1095 for (i = 0; i < n_buffers; i++)
1097 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
1098 ASSERT (b->current_length == vec_len (t->packet_data));
1099 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
1105 vlib_packet_template_init (vlib_main_t * vm,
1106 vlib_packet_template_t * t,
1108 uword n_packet_data_bytes,
1109 uword min_n_buffers_each_physmem_alloc,
1112 vlib_buffer_free_list_t *fl;
1117 name = va_format (0, fmt, &va);
1120 memset (t, 0, sizeof (t[0]));
1122 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
1123 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
1125 t->free_list_index = vlib_buffer_create_free_list_helper
1126 (vm, n_packet_data_bytes,
1131 ASSERT (t->free_list_index != 0);
1132 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
1133 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
1135 fl->buffer_init_function = vlib_packet_template_buffer_init;
1136 fl->buffer_init_function_opaque = pointer_to_uword (t);
1138 fl->buffer_init_template.current_data = 0;
1139 fl->buffer_init_template.current_length = n_packet_data_bytes;
1140 fl->buffer_init_template.flags = 0;
1144 vlib_packet_template_get_packet (vlib_main_t * vm,
1145 vlib_packet_template_t * t, u32 * bi_result)
1150 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
1155 b = vlib_get_buffer (vm, bi);
1156 clib_memcpy (vlib_buffer_get_current (b),
1157 t->packet_data, vec_len (t->packet_data));
1158 b->current_length = vec_len (t->packet_data);
1164 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
1165 vlib_packet_template_t * t)
1167 word n = t->min_n_buffers_each_physmem_alloc;
1168 word l = vec_len (t->packet_data);
1172 ASSERT (vec_len (t->free_buffers) == 0);
1174 vec_validate (t->free_buffers, n - 1);
1175 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
1176 n, t->free_list_index);
1177 _vec_len (t->free_buffers) = n_alloc;
1180 /* Append given data to end of buffer, possibly allocating new buffers. */
1182 vlib_buffer_add_data (vlib_main_t * vm,
1183 u32 free_list_index,
1184 u32 buffer_index, void *data, u32 n_data_bytes)
1186 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
1192 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
1193 goto out_of_buffers;
1196 n_left = n_data_bytes;
1197 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
1199 b = vlib_get_buffer (vm, bi);
1200 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1202 /* Get to the end of the chain before we try to append data... */
1203 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1204 b = vlib_get_buffer (vm, b->next_buffer);
1210 ASSERT (n_buffer_bytes >= b->current_length);
1211 n_left_this_buffer =
1212 n_buffer_bytes - (b->current_data + b->current_length);
1213 n = clib_min (n_left_this_buffer, n_left);
1214 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
1215 b->current_length += n;
1222 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
1224 goto out_of_buffers;
1226 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1228 b = vlib_get_buffer (vm, b->next_buffer);
1234 clib_error ("out of buffers");
1239 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1240 u32 free_list_index,
1241 vlib_buffer_t * first,
1242 vlib_buffer_t ** last,
1243 void *data, u16 data_len)
1245 vlib_buffer_t *l = *last;
1246 u32 n_buffer_bytes =
1247 vlib_buffer_free_list_buffer_size (vm, free_list_index);
1249 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
1252 u16 max = n_buffer_bytes - l->current_length - l->current_data;
1256 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
1259 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
1260 max = n_buffer_bytes - l->current_length - l->current_data;
1263 u16 len = (data_len > max) ? max : data_len;
1264 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
1265 data + copied, len);
1266 vlib_buffer_chain_increase_length (first, l, len);
1274 * Fills in the required rte_mbuf fields for chained buffers given a VLIB chain.
1277 vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * b_first)
1283 vlib_serialize_tx (serialize_main_header_t * m, serialize_stream_t * s)
1286 vlib_serialize_buffer_main_t *sm;
1287 uword n, n_bytes_to_write;
1288 vlib_buffer_t *last;
1290 n_bytes_to_write = s->current_buffer_index;
1292 uword_to_pointer (s->data_function_opaque,
1293 vlib_serialize_buffer_main_t *);
1296 ASSERT (sm->tx.max_n_data_bytes_per_chain > 0);
1297 if (serialize_stream_is_end_of_stream (s)
1298 || sm->tx.n_total_data_bytes + n_bytes_to_write >
1299 sm->tx.max_n_data_bytes_per_chain)
1301 vlib_process_t *p = vlib_get_current_process (vm);
1303 last = vlib_get_buffer (vm, sm->last_buffer);
1304 last->current_length = n_bytes_to_write;
1306 vlib_set_next_frame_buffer (vm, &p->node_runtime, sm->tx.next_index,
1309 sm->first_buffer = sm->last_buffer = ~0;
1310 sm->tx.n_total_data_bytes = 0;
1313 else if (n_bytes_to_write == 0 && s->n_buffer_bytes == 0)
1315 ASSERT (sm->first_buffer == ~0);
1316 ASSERT (sm->last_buffer == ~0);
1318 vlib_buffer_alloc_from_free_list (vm, &sm->first_buffer, 1,
1319 sm->tx.free_list_index);
1323 ("vlib_buffer_alloc_from_free_list fails"));
1324 sm->last_buffer = sm->first_buffer;
1326 vlib_buffer_free_list_buffer_size (vm, sm->tx.free_list_index);
1329 if (n_bytes_to_write > 0)
1331 vlib_buffer_t *prev = vlib_get_buffer (vm, sm->last_buffer);
1333 vlib_buffer_alloc_from_free_list (vm, &sm->last_buffer, 1,
1334 sm->tx.free_list_index);
1338 ("vlib_buffer_alloc_from_free_list fails"));
1339 sm->tx.n_total_data_bytes += n_bytes_to_write;
1340 prev->current_length = n_bytes_to_write;
1341 prev->next_buffer = sm->last_buffer;
1342 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
1345 if (sm->last_buffer != ~0)
1347 last = vlib_get_buffer (vm, sm->last_buffer);
1348 s->buffer = vlib_buffer_get_current (last);
1349 s->current_buffer_index = 0;
1350 ASSERT (last->current_data == s->current_buffer_index);
1355 vlib_serialize_rx (serialize_main_header_t * m, serialize_stream_t * s)
1358 vlib_serialize_buffer_main_t *sm;
1359 vlib_buffer_t *last;
1362 uword_to_pointer (s->data_function_opaque,
1363 vlib_serialize_buffer_main_t *);
1366 if (serialize_stream_is_end_of_stream (s))
1369 if (sm->last_buffer != ~0)
1371 last = vlib_get_buffer (vm, sm->last_buffer);
1373 if (last->flags & VLIB_BUFFER_NEXT_PRESENT)
1374 sm->last_buffer = last->next_buffer;
1377 vlib_buffer_free (vm, &sm->first_buffer, /* count */ 1);
1378 sm->first_buffer = sm->last_buffer = ~0;
1382 if (sm->last_buffer == ~0)
1384 while (clib_fifo_elts (sm->rx.buffer_fifo) == 0)
1386 sm->rx.ready_one_time_event =
1387 vlib_process_create_one_time_event (vm, vlib_current_process (vm),
1389 vlib_process_wait_for_one_time_event (vm, /* no event data */ 0,
1390 sm->rx.ready_one_time_event);
1393 clib_fifo_sub1 (sm->rx.buffer_fifo, sm->first_buffer);
1394 sm->last_buffer = sm->first_buffer;
1397 ASSERT (sm->last_buffer != ~0);
1399 last = vlib_get_buffer (vm, sm->last_buffer);
1400 s->current_buffer_index = 0;
1401 s->buffer = vlib_buffer_get_current (last);
1402 s->n_buffer_bytes = last->current_length;
1406 serialize_open_vlib_helper (serialize_main_t * m,
1408 vlib_serialize_buffer_main_t * sm, uword is_read)
1410 /* Initialize serialize main but save overflow buffer for re-use between calls. */
1412 u8 *save = m->stream.overflow_buffer;
1413 memset (m, 0, sizeof (m[0]));
1414 m->stream.overflow_buffer = save;
1416 _vec_len (save) = 0;
1419 sm->first_buffer = sm->last_buffer = ~0;
1421 clib_fifo_reset (sm->rx.buffer_fifo);
1423 sm->tx.n_total_data_bytes = 0;
1425 m->header.data_function = is_read ? vlib_serialize_rx : vlib_serialize_tx;
1426 m->stream.data_function_opaque = pointer_to_uword (sm);
1430 serialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm,
1431 vlib_serialize_buffer_main_t * sm)
1433 serialize_open_vlib_helper (m, vm, sm, /* is_read */ 0);
1437 unserialize_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 */ 1);
1444 serialize_close_vlib_buffer (serialize_main_t * m)
1446 vlib_serialize_buffer_main_t *sm
1447 = uword_to_pointer (m->stream.data_function_opaque,
1448 vlib_serialize_buffer_main_t *);
1449 vlib_buffer_t *last;
1450 serialize_stream_t *s = &m->stream;
1452 last = vlib_get_buffer (sm->vlib_main, sm->last_buffer);
1453 last->current_length = s->current_buffer_index;
1455 if (vec_len (s->overflow_buffer) > 0)
1458 = vlib_buffer_add_data (sm->vlib_main, sm->tx.free_list_index,
1459 sm->last_buffer == ~0 ? 0 : sm->last_buffer,
1461 vec_len (s->overflow_buffer));
1462 _vec_len (s->overflow_buffer) = 0;
1465 return sm->first_buffer;
1469 unserialize_close_vlib_buffer (serialize_main_t * m)
1471 vlib_serialize_buffer_main_t *sm
1472 = uword_to_pointer (m->stream.data_function_opaque,
1473 vlib_serialize_buffer_main_t *);
1474 if (sm->first_buffer != ~0)
1475 vlib_buffer_free_one (sm->vlib_main, sm->first_buffer);
1476 clib_fifo_reset (sm->rx.buffer_fifo);
1477 if (m->stream.overflow_buffer)
1478 _vec_len (m->stream.overflow_buffer) = 0;
1482 format_vlib_buffer_free_list (u8 * s, va_list * va)
1484 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
1485 uword bytes_alloc, bytes_free, n_free, size;
1488 return format (s, "%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1489 "Name", "Index", "Size", "Alloc", "Free", "#Alloc",
1492 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1493 n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1494 bytes_alloc = size * f->n_alloc;
1495 bytes_free = size * n_free;
1497 s = format (s, "%30s%12d%12d%=12U%=12U%=12d%=12d",
1498 f->name, f->index, f->n_data_bytes,
1499 format_memory_size, bytes_alloc,
1500 format_memory_size, bytes_free, f->n_alloc, n_free);
1505 static clib_error_t *
1506 show_buffers (vlib_main_t * vm,
1507 unformat_input_t * input, vlib_cli_command_t * cmd)
1509 vlib_buffer_main_t *bm = vm->buffer_main;
1510 vlib_buffer_free_list_t *f;
1512 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0);
1514 pool_foreach (f, bm->buffer_free_list_pool, ({
1515 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f);
1523 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1524 .path = "show buffers",
1525 .short_help = "Show packet buffer allocation",
1526 .function = show_buffers,
1531 * fd.io coding-style-patch-verification: ON
1534 * eval: (c-set-style "gnu")