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>
42 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm, vlib_buffer_t * b_first)
44 vlib_buffer_t * b = b_first;
45 uword l_first = b_first->current_length;
47 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
49 b = vlib_get_buffer (vm, b->next_buffer);
50 l += b->current_length;
52 b_first->total_length_not_including_first_buffer = l;
53 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
57 u8 * format_vlib_buffer (u8 * s, va_list * args)
59 vlib_buffer_t * b = va_arg (*args, vlib_buffer_t *);
61 s = format (s, "current data %d, length %d, free-list %d",
62 b->current_data, b->current_length,
65 if (b->flags & VLIB_BUFFER_IS_TRACED)
66 s = format (s, ", trace 0x%x", b->trace_index);
68 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
69 s = format (s, ", next-buffer 0x%x", b->next_buffer);
74 u8 * format_vlib_buffer_and_data (u8 * s, va_list * args)
76 vlib_buffer_t * b = va_arg (*args, vlib_buffer_t *);
78 s = format (s, "%U, %U",
79 format_vlib_buffer, b,
80 format_hex_bytes, vlib_buffer_get_current (b), 64);
85 static u8 * format_vlib_buffer_known_state (u8 * s, va_list * args)
87 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
92 case VLIB_BUFFER_UNKNOWN:
96 case VLIB_BUFFER_KNOWN_ALLOCATED:
97 t = "known-allocated";
100 case VLIB_BUFFER_KNOWN_FREE:
109 return format (s, "%s", t);
112 u8 * format_vlib_buffer_contents (u8 * s, va_list * va)
114 vlib_main_t * vm = va_arg (*va, vlib_main_t *);
115 vlib_buffer_t * b = va_arg (*va, vlib_buffer_t *);
119 vec_add (s, vlib_buffer_get_current (b),
121 if (! (b->flags & VLIB_BUFFER_NEXT_PRESENT))
123 b = vlib_get_buffer (vm, b->next_buffer);
130 vlib_validate_buffer_helper (vlib_main_t * vm,
132 uword follow_buffer_next,
133 uword ** unique_hash)
136 vlib_buffer_t * b = vlib_get_buffer (vm, bi);
137 vlib_buffer_main_t * bm = vm->buffer_main;
138 vlib_buffer_free_list_t * fl;
140 if (pool_is_free_index (bm->buffer_free_list_pool,
142 return format (0, "unknown free list 0x%x", b->free_list_index);
144 fl = pool_elt_at_index (bm->buffer_free_list_pool,
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,
156 if (follow_buffer_next
157 && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
159 vlib_buffer_known_state_t k;
162 k = vlib_buffer_is_known (vm, b->next_buffer);
163 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
164 return format (0, "next 0x%x: %U",
166 format_vlib_buffer_known_state, k);
170 if (hash_get (*unique_hash, b->next_buffer))
171 return format (0, "duplicate buffer 0x%x", b->next_buffer);
173 hash_set1 (*unique_hash, b->next_buffer);
176 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
179 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
189 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
190 { return vlib_validate_buffer_helper (vm, bi, follow_buffer_next, /* 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,
285 vlib_buffer_set_known_state
287 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
291 /* Aligned copy routine. */
293 vlib_aligned_memcpy (void * _dst, void * _src, int n_bytes)
295 vlib_copy_unit_t * dst = _dst;
296 vlib_copy_unit_t * src = _src;
298 /* Arguments must be naturally aligned. */
299 ASSERT (pointer_to_uword (dst) % sizeof (dst[0]) == 0);
300 ASSERT (pointer_to_uword (src) % sizeof (src[0]) == 0);
301 ASSERT (n_bytes % sizeof (dst[0]) == 0);
303 if (4 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
305 CLIB_PREFETCH (dst + 0, 4 * sizeof (dst[0]), WRITE);
306 CLIB_PREFETCH (src + 0, 4 * sizeof (src[0]), READ);
308 while (n_bytes >= 4 * sizeof (dst[0]))
312 n_bytes -= 4 * sizeof (dst[0]);
313 CLIB_PREFETCH (dst, 4 * sizeof (dst[0]), WRITE);
314 CLIB_PREFETCH (src, 4 * sizeof (src[0]), READ);
321 else if (8 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
323 CLIB_PREFETCH (dst + 0, 8 * sizeof (dst[0]), WRITE);
324 CLIB_PREFETCH (src + 0, 8 * sizeof (src[0]), READ);
326 while (n_bytes >= 8 * sizeof (dst[0]))
330 n_bytes -= 8 * sizeof (dst[0]);
331 CLIB_PREFETCH (dst, 8 * sizeof (dst[0]), WRITE);
332 CLIB_PREFETCH (src, 8 * sizeof (src[0]), READ);
344 /* Cache line size unknown: fall back to slow version. */;
349 n_bytes -= 1 * sizeof (dst[0]);
353 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
355 /* Make sure we have at least given number of unaligned buffers. */
357 fill_unaligned (vlib_main_t * vm,
358 vlib_buffer_free_list_t * free_list,
359 uword n_unaligned_buffers)
361 word la = vec_len (free_list->aligned_buffers);
362 word lu = vec_len (free_list->unaligned_buffers);
364 /* Aligned come in aligned copy-sized chunks. */
365 ASSERT (la % BUFFERS_PER_COPY == 0);
367 ASSERT (la >= n_unaligned_buffers);
369 while (lu < n_unaligned_buffers)
371 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
372 vec_add (free_list->unaligned_buffers,
373 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
375 la -= BUFFERS_PER_COPY;
376 lu += BUFFERS_PER_COPY;
378 _vec_len (free_list->aligned_buffers) = la;
381 /* After free aligned buffers may not contain even sized chunks. */
383 trim_aligned (vlib_buffer_free_list_t * f)
387 /* Add unaligned to aligned before trim. */
388 l = vec_len (f->unaligned_buffers);
391 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
392 /* align */ sizeof (vlib_copy_unit_t));
394 _vec_len (f->unaligned_buffers) = 0;
397 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
398 l = vec_len (f->aligned_buffers);
399 n_trim = l % BUFFERS_PER_COPY;
402 /* Trim aligned -> unaligned. */
403 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
405 /* Remove from aligned. */
406 _vec_len (f->aligned_buffers) = l - n_trim;
411 merge_free_lists (vlib_buffer_free_list_t * dst,
412 vlib_buffer_free_list_t * src)
420 l = vec_len (src->aligned_buffers);
423 vec_add2_aligned (dst->aligned_buffers, d, l,
424 /* align */ sizeof (vlib_copy_unit_t));
425 vlib_aligned_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
426 vec_free (src->aligned_buffers);
429 l = vec_len (src->unaligned_buffers);
432 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
433 vec_free (src->unaligned_buffers);
438 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
440 vlib_buffer_main_t * bm = vm->buffer_main;
442 size = vlib_buffer_round_size (size);
443 uword * p = hash_get (bm->free_list_by_size, size);
444 return p ? p[0] : ~0;
447 /* Add buffer free list. */
449 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
455 vlib_buffer_main_t * bm = vm->buffer_main;
456 vlib_buffer_free_list_t * f;
458 if (! is_default && pool_elts (bm->buffer_free_list_pool) == 0)
460 u32 default_free_free_list_index;
462 default_free_free_list_index =
463 vlib_buffer_create_free_list_helper (vm,
464 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
468 ASSERT (default_free_free_list_index == VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
470 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
471 return default_free_free_list_index;
474 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
476 memset (f, 0, sizeof (f[0]));
477 f->index = f - bm->buffer_free_list_pool;
478 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
479 f->min_n_buffers_each_physmem_alloc = 256;
480 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
482 /* Setup free buffer template. */
483 f->buffer_init_template.free_list_index = f->index;
487 uword * p = hash_get (bm->free_list_by_size, f->n_data_bytes);
489 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
495 u32 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
502 name = va_format (0, fmt, &va);
505 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
511 u32 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
514 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
522 name = va_format (0, fmt, &va);
525 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
535 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
539 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
540 vm->os_physmem_free (f->buffer_memory_allocated[i]);
542 vec_free (f->buffer_memory_allocated);
543 vec_free (f->unaligned_buffers);
544 vec_free (f->aligned_buffers);
547 /* Add buffer free list. */
548 void vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
550 vlib_buffer_main_t * bm = vm->buffer_main;
551 vlib_buffer_free_list_t * f;
554 f = vlib_buffer_get_free_list (vm, free_list_index);
556 ASSERT (vec_len (f->unaligned_buffers) + vec_len (f->aligned_buffers) == f->n_alloc);
557 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
558 if (merge_index != ~0 && merge_index != free_list_index)
560 merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
564 del_free_list (vm, f);
567 memset (f, 0xab, sizeof (f[0]));
569 pool_put (bm->buffer_free_list_pool, f);
572 /* Make sure free list has at least given number of free buffers. */
574 fill_free_list (vlib_main_t * vm,
575 vlib_buffer_free_list_t * fl,
576 uword min_free_buffers)
578 vlib_buffer_t * buffers, * b;
581 u32 n_remaining, n_alloc, n_this_chunk;
585 /* Already have enough free buffers on free list? */
586 n = min_free_buffers - vec_len (fl->aligned_buffers);
588 return min_free_buffers;
590 /* Always allocate round number of buffers. */
591 n = round_pow2 (n, BUFFERS_PER_COPY);
593 /* Always allocate new buffers in reasonably large sized chunks. */
594 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
598 while (n_remaining > 0)
600 n_this_chunk = clib_min (n_remaining, 16);
602 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
604 /* drb: removed power-of-2 ASSERT */
605 buffers = vm->os_physmem_alloc_aligned (&vm->physmem_main,
606 n_bytes, sizeof (vlib_buffer_t));
610 /* Record chunk as being allocated so we can free it later. */
611 vec_add1 (fl->buffer_memory_allocated, buffers);
613 fl->n_alloc += n_this_chunk;
614 n_alloc += n_this_chunk;
615 n_remaining -= n_this_chunk;
618 vec_add2_aligned (fl->aligned_buffers, bi, n_this_chunk,
619 sizeof (vlib_copy_unit_t));
620 for (i = 0; i < n_this_chunk; i++)
622 bi[i] = vlib_get_buffer_index (vm, b);
625 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
626 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
629 memset (buffers, 0, n_bytes);
631 /* Initialize all new buffers. */
633 for (i = 0; i < n_this_chunk; i++)
635 vlib_buffer_init_for_free_list (b, fl);
636 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
639 if (fl->buffer_init_function)
640 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
646 copy_alignment (u32 * x)
647 { return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY; }
650 alloc_from_free_list (vlib_main_t * vm,
651 vlib_buffer_free_list_t * free_list,
657 uword n_unaligned_start, n_unaligned_end, n_filled;
659 ASSERT(os_get_cpu_number() == 0);
661 n_left = n_alloc_buffers;
663 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
664 & (BUFFERS_PER_COPY - 1));
666 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
670 n_left = n_filled < n_left ? n_filled : n_left;
671 n_alloc_buffers = n_left;
673 if (n_unaligned_start >= n_left)
675 n_unaligned_start = n_left;
679 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
681 fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
683 u_len = vec_len (free_list->unaligned_buffers);
684 u_src = free_list->unaligned_buffers + u_len - 1;
686 if (n_unaligned_start)
688 uword n_copy = n_unaligned_start;
700 /* Now dst should be aligned. */
702 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
707 vlib_copy_unit_t * d, * s;
710 if (vec_len(free_list->aligned_buffers) < ((n_left/BUFFERS_PER_COPY)*BUFFERS_PER_COPY))
713 n_copy = n_left / BUFFERS_PER_COPY;
714 n_left = n_left % BUFFERS_PER_COPY;
716 /* Remove buffers from aligned free list. */
717 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
719 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
720 d = (vlib_copy_unit_t *) dst;
722 /* Fast path loop. */
745 /* Unaligned copy. */
746 ASSERT (n_unaligned_end == n_left);
754 if (! free_list->unaligned_buffers)
757 _vec_len (free_list->unaligned_buffers) = u_len;
759 /* Verify that buffers are known free. */
760 vlib_buffer_validate_alloc_free (vm, alloc_buffers,
762 VLIB_BUFFER_KNOWN_FREE);
764 return n_alloc_buffers;
767 /* Allocate a given number of buffers into given array.
768 Returns number actually allocated which will be either zero or
770 u32 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
772 vlib_buffer_main_t * bm = vm->buffer_main;
773 ASSERT(os_get_cpu_number() == 0);
775 return alloc_from_free_list
777 pool_elt_at_index (bm->buffer_free_list_pool,
778 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
782 u32 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
787 vlib_buffer_main_t * bm = vm->buffer_main;
788 vlib_buffer_free_list_t * f;
789 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
790 return alloc_from_free_list (vm, f, buffers, n_buffers);
794 add_buffer_to_free_list (vlib_main_t * vm,
795 vlib_buffer_free_list_t * f,
796 u32 buffer_index, u8 do_init)
799 b = vlib_get_buffer (vm, buffer_index);
800 if (PREDICT_TRUE(do_init))
801 vlib_buffer_init_for_free_list (b, f);
802 vec_add1_aligned (f->aligned_buffers, buffer_index, sizeof (vlib_copy_unit_t));
805 always_inline vlib_buffer_free_list_t *
806 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
808 vlib_buffer_main_t * bm = vm->buffer_main;
811 *index = i = b->free_list_index;
812 return pool_elt_at_index (bm->buffer_free_list_pool, i);
815 void *vlib_set_buffer_free_callback (vlib_main_t *vm, void *fp)
817 vlib_buffer_main_t * bm = vm->buffer_main;
818 void * rv = bm->buffer_free_callback;
820 bm->buffer_free_callback = fp;
824 void vnet_buffer_free_dpdk_mb (vlib_buffer_t * b) __attribute__ ((weak));
825 void vnet_buffer_free_dpdk_mb (vlib_buffer_t * b) { }
827 static_always_inline void
828 vlib_buffer_free_inline (vlib_main_t * vm,
831 u32 follow_buffer_next)
833 vlib_buffer_main_t * bm = vm->buffer_main;
834 vlib_buffer_free_list_t * fl;
835 static u32 * next_to_free[2]; /* smp bad */
836 u32 i_next_to_free, * b, * n, * f, fi;
839 static vlib_buffer_free_list_t ** announce_list;
840 vlib_buffer_free_list_t * fl0 = 0, * fl1 = 0;
841 u32 bi0=(u32)~0, bi1=(u32)~0, fi0, fi1 = (u32)~0;
842 u8 free0, free1=0, free_next0, free_next1;
843 u32 (*cb)(vlib_main_t * vm, u32 * buffers, u32 n_buffers,
844 u32 follow_buffer_next);
846 ASSERT(os_get_cpu_number() == 0);
848 cb = bm->buffer_free_callback;
850 if (PREDICT_FALSE (cb != 0))
851 n_buffers = (*cb)(vm, buffers, n_buffers, follow_buffer_next);
856 /* Use first buffer to get default free list. */
858 u32 bi0 = buffers[0];
861 b0 = vlib_get_buffer (vm, bi0);
862 fl = buffer_get_free_list (vm, b0, &fi);
863 if (fl->buffers_added_to_freelist_function)
864 vec_add1 (announce_list, fl);
867 vec_validate (next_to_free[0], n_buffers - 1);
868 vec_validate (next_to_free[1], n_buffers - 1);
875 /* Verify that buffers are known allocated. */
876 vlib_buffer_validate_alloc_free (vm, b,
878 VLIB_BUFFER_KNOWN_ALLOCATED);
880 vec_add2_aligned (fl->aligned_buffers, f, n_left,
881 /* align */ sizeof (vlib_copy_unit_t));
883 n = next_to_free[i_next_to_free];
886 vlib_buffer_t * b0, * b1, * binit0, * binit1, dummy_buffers[2];
897 /* Prefetch buffers for next iteration. */
898 vlib_prefetch_buffer_with_index (vm, b[0], WRITE);
899 vlib_prefetch_buffer_with_index (vm, b[1], WRITE);
901 b0 = vlib_get_buffer (vm, bi0);
902 b1 = vlib_get_buffer (vm, bi1);
904 free0 = b0->clone_count == 0;
905 free1 = b1->clone_count == 0;
907 /* Must be before init which will over-write buffer flags. */
908 if (follow_buffer_next)
910 n[0] = b0->next_buffer;
911 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
914 n[0] = b1->next_buffer;
915 free_next1 = free1 && (b1->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
919 free_next0 = free_next1 = 0;
921 /* Must be before init which will over-write buffer free list. */
922 fi0 = b0->free_list_index;
923 fi1 = b1->free_list_index;
925 if (PREDICT_FALSE (fi0 != fi || fi1 != fi))
928 binit0 = free0 ? b0 : &dummy_buffers[0];
929 binit1 = free1 ? b1 : &dummy_buffers[1];
931 vlib_buffer_init_two_for_free_list (binit0, binit1, fl);
935 /* Backup speculation. */
937 n -= free_next0 + free_next1;
939 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
941 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
942 fl1 = pool_elt_at_index (bm->buffer_free_list_pool, fi1);
944 add_buffer_to_free_list (vm, fl0, bi0, free0);
945 if (PREDICT_FALSE(fl0->buffers_added_to_freelist_function != 0))
948 for (i = 0; i < vec_len (announce_list); i++)
949 if (fl0 == announce_list[i])
951 vec_add1(announce_list, fl0);
954 if (PREDICT_FALSE(fl1->buffers_added_to_freelist_function != 0))
957 for (i = 0; i < vec_len (announce_list); i++)
958 if (fl1 == announce_list[i])
960 vec_add1(announce_list, fl1);
964 add_buffer_to_free_list (vm, fl1, bi1, free1);
966 /* Possibly change current free list. */
967 if (fi0 != fi && fi1 != fi)
970 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
973 vec_add2_aligned (fl->aligned_buffers, f, n_left,
974 /* align */ sizeof (vlib_copy_unit_t));
979 vlib_buffer_t * b0, * binit0, dummy_buffers[1];
987 b0 = vlib_get_buffer (vm, bi0);
989 free0 = b0->clone_count == 0;
991 /* Must be before init which will over-write buffer flags. */
992 if (follow_buffer_next)
994 n[0] = b0->next_buffer;
995 free_next0 = free0 && (b0->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
1001 /* Must be before init which will over-write buffer free list. */
1002 fi0 = b0->free_list_index;
1004 if (PREDICT_FALSE (fi0 != fi))
1007 binit0 = free0 ? b0 : &dummy_buffers[0];
1009 vlib_buffer_init_for_free_list (binit0, fl);
1013 /* Backup speculation. */
1017 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1019 fl0 = pool_elt_at_index (bm->buffer_free_list_pool, fi0);
1021 add_buffer_to_free_list (vm, fl0, bi0, free0);
1022 if (PREDICT_FALSE(fl0->buffers_added_to_freelist_function != 0))
1025 for (i = 0; i < vec_len (announce_list); i++)
1026 if (fl0 == announce_list[i])
1028 vec_add1(announce_list, fl0);
1033 fl = pool_elt_at_index (bm->buffer_free_list_pool, fi);
1035 vec_add2_aligned (fl->aligned_buffers, f, n_left,
1036 /* align */ sizeof (vlib_copy_unit_t));
1039 if (follow_buffer_next && ((n_left = n - next_to_free[i_next_to_free]) > 0))
1041 b = next_to_free[i_next_to_free];
1042 i_next_to_free ^= 1;
1046 _vec_len (fl->aligned_buffers) = f - fl->aligned_buffers;
1048 if (vec_len(announce_list))
1050 vlib_buffer_free_list_t * fl;
1051 for (i = 0; i < vec_len (announce_list); i++)
1053 fl = announce_list[i];
1054 fl->buffers_added_to_freelist_function (vm, fl);
1056 _vec_len(announce_list) = 0;
1060 void vlib_buffer_free (vlib_main_t * vm,
1064 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 1);
1067 void vlib_buffer_free_no_next (vlib_main_t * vm,
1071 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 0);
1074 /* Copy template packet data into buffers as they are allocated. */
1076 vlib_packet_template_buffer_init (vlib_main_t * vm,
1077 vlib_buffer_free_list_t * fl,
1081 vlib_packet_template_t * t = uword_to_pointer (fl->buffer_init_function_opaque,
1082 vlib_packet_template_t *);
1085 for (i = 0; i < n_buffers; i++)
1087 vlib_buffer_t * b = vlib_get_buffer (vm, buffers[i]);
1088 ASSERT (b->current_length == vec_len (t->packet_data));
1089 clib_memcpy (vlib_buffer_get_current (b), t->packet_data, b->current_length);
1093 void vlib_packet_template_init (vlib_main_t * vm,
1094 vlib_packet_template_t * t,
1096 uword n_packet_data_bytes,
1097 uword min_n_buffers_each_physmem_alloc,
1101 vlib_buffer_free_list_t * fl;
1106 name = va_format (0, fmt, &va);
1109 memset (t, 0, sizeof (t[0]));
1111 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
1112 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
1114 t->free_list_index = vlib_buffer_create_free_list_helper
1115 (vm, n_packet_data_bytes,
1120 ASSERT (t->free_list_index != 0);
1121 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
1122 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
1124 fl->buffer_init_function = vlib_packet_template_buffer_init;
1125 fl->buffer_init_function_opaque = pointer_to_uword (t);
1127 fl->buffer_init_template.current_data = 0;
1128 fl->buffer_init_template.current_length = n_packet_data_bytes;
1129 fl->buffer_init_template.flags = 0;
1133 vlib_packet_template_get_packet (vlib_main_t * vm,
1134 vlib_packet_template_t * t,
1140 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
1145 b = vlib_get_buffer (vm, bi);
1146 clib_memcpy (vlib_buffer_get_current (b),
1147 t->packet_data, vec_len(t->packet_data));
1148 b->current_length = vec_len(t->packet_data);
1153 void vlib_packet_template_get_packet_helper (vlib_main_t * vm, vlib_packet_template_t * t)
1155 word n = t->min_n_buffers_each_physmem_alloc;
1156 word l = vec_len (t->packet_data);
1160 ASSERT (vec_len (t->free_buffers) == 0);
1162 vec_validate (t->free_buffers, n - 1);
1163 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
1164 n, t->free_list_index);
1165 _vec_len (t->free_buffers) = n_alloc;
1168 /* Append given data to end of buffer, possibly allocating new buffers. */
1169 u32 vlib_buffer_add_data (vlib_main_t * vm,
1170 u32 free_list_index,
1172 void * data, u32 n_data_bytes)
1174 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
1180 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
1181 goto out_of_buffers;
1184 n_left = n_data_bytes;
1185 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
1187 b = vlib_get_buffer (vm, bi);
1188 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1190 /* Get to the end of the chain before we try to append data...*/
1191 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1192 b = vlib_get_buffer (vm, b->next_buffer);
1198 ASSERT (n_buffer_bytes >= b->current_length);
1199 n_left_this_buffer = n_buffer_bytes - (b->current_data + b->current_length);
1200 n = clib_min (n_left_this_buffer, n_left);
1201 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
1202 b->current_length += n;
1208 if (1 != vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1, free_list_index))
1209 goto out_of_buffers;
1211 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1213 b = vlib_get_buffer (vm, b->next_buffer);
1219 clib_error ("out of buffers");
1224 vlib_buffer_chain_append_data_with_alloc(vlib_main_t *vm,
1225 u32 free_list_index,
1226 vlib_buffer_t *first,
1227 vlib_buffer_t **last,
1228 void * data, u16 data_len) {
1229 vlib_buffer_t *l = *last;
1230 u32 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
1232 ASSERT(n_buffer_bytes >= l->current_length + l->current_data);
1234 u16 max = n_buffer_bytes - l->current_length - l->current_data;
1236 if (1 != vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1, free_list_index))
1238 *last = l = vlib_buffer_chain_buffer(vm, first, l, l->next_buffer);
1239 max = n_buffer_bytes - l->current_length - l->current_data;
1242 u16 len = (data_len > max)?max:data_len;
1243 clib_memcpy(vlib_buffer_get_current (l) + l->current_length, data + copied, len);
1244 vlib_buffer_chain_increase_length(first, l, len);
1252 * Fills in the required rte_mbuf fields for chained buffers given a VLIB chain.
1254 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * b_first)
1259 static void vlib_serialize_tx (serialize_main_header_t * m, serialize_stream_t * s)
1262 vlib_serialize_buffer_main_t * sm;
1263 uword n, n_bytes_to_write;
1264 vlib_buffer_t * last;
1266 n_bytes_to_write = s->current_buffer_index;
1267 sm = uword_to_pointer (s->data_function_opaque, vlib_serialize_buffer_main_t *);
1270 ASSERT (sm->tx.max_n_data_bytes_per_chain > 0);
1271 if (serialize_stream_is_end_of_stream (s)
1272 || sm->tx.n_total_data_bytes + n_bytes_to_write > sm->tx.max_n_data_bytes_per_chain)
1274 vlib_process_t * p = vlib_get_current_process (vm);
1276 last = vlib_get_buffer (vm, sm->last_buffer);
1277 last->current_length = n_bytes_to_write;
1279 vlib_set_next_frame_buffer (vm, &p->node_runtime, sm->tx.next_index, sm->first_buffer);
1281 sm->first_buffer = sm->last_buffer = ~0;
1282 sm->tx.n_total_data_bytes = 0;
1285 else if (n_bytes_to_write == 0 && s->n_buffer_bytes == 0)
1287 ASSERT (sm->first_buffer == ~0);
1288 ASSERT (sm->last_buffer == ~0);
1289 n = vlib_buffer_alloc_from_free_list (vm, &sm->first_buffer, 1, sm->tx.free_list_index);
1291 serialize_error (m, clib_error_create ("vlib_buffer_alloc_from_free_list fails"));
1292 sm->last_buffer = sm->first_buffer;
1293 s->n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, sm->tx.free_list_index);
1296 if (n_bytes_to_write > 0)
1298 vlib_buffer_t * prev = vlib_get_buffer (vm, sm->last_buffer);
1299 n = vlib_buffer_alloc_from_free_list (vm, &sm->last_buffer, 1, sm->tx.free_list_index);
1301 serialize_error (m, clib_error_create ("vlib_buffer_alloc_from_free_list fails"));
1302 sm->tx.n_total_data_bytes += n_bytes_to_write;
1303 prev->current_length = n_bytes_to_write;
1304 prev->next_buffer = sm->last_buffer;
1305 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
1308 if (sm->last_buffer != ~0)
1310 last = vlib_get_buffer (vm, sm->last_buffer);
1311 s->buffer = vlib_buffer_get_current (last);
1312 s->current_buffer_index = 0;
1313 ASSERT (last->current_data == s->current_buffer_index);
1317 static void vlib_serialize_rx (serialize_main_header_t * m, serialize_stream_t * s)
1320 vlib_serialize_buffer_main_t * sm;
1321 vlib_buffer_t * last;
1323 sm = uword_to_pointer (s->data_function_opaque, vlib_serialize_buffer_main_t *);
1326 if (serialize_stream_is_end_of_stream (s))
1329 if (sm->last_buffer != ~0)
1331 last = vlib_get_buffer (vm, sm->last_buffer);
1333 if (last->flags & VLIB_BUFFER_NEXT_PRESENT)
1334 sm->last_buffer = last->next_buffer;
1337 vlib_buffer_free (vm, &sm->first_buffer, /* count */ 1);
1338 sm->first_buffer = sm->last_buffer = ~0;
1342 if (sm->last_buffer == ~0)
1344 while (clib_fifo_elts (sm->rx.buffer_fifo) == 0)
1346 sm->rx.ready_one_time_event = vlib_process_create_one_time_event (vm, vlib_current_process (vm), ~0);
1347 vlib_process_wait_for_one_time_event (vm, /* no event data */ 0, sm->rx.ready_one_time_event);
1350 clib_fifo_sub1 (sm->rx.buffer_fifo, sm->first_buffer);
1351 sm->last_buffer = sm->first_buffer;
1354 ASSERT (sm->last_buffer != ~0);
1356 last = vlib_get_buffer (vm, sm->last_buffer);
1357 s->current_buffer_index = 0;
1358 s->buffer = vlib_buffer_get_current (last);
1359 s->n_buffer_bytes = last->current_length;
1363 serialize_open_vlib_helper (serialize_main_t * m,
1365 vlib_serialize_buffer_main_t * sm,
1368 /* Initialize serialize main but save overflow buffer for re-use between calls. */
1370 u8 * save = m->stream.overflow_buffer;
1371 memset (m, 0, sizeof (m[0]));
1372 m->stream.overflow_buffer = save;
1374 _vec_len (save) = 0;
1377 sm->first_buffer = sm->last_buffer = ~0;
1379 clib_fifo_reset (sm->rx.buffer_fifo);
1381 sm->tx.n_total_data_bytes = 0;
1383 m->header.data_function = is_read ? vlib_serialize_rx : vlib_serialize_tx;
1384 m->stream.data_function_opaque = pointer_to_uword (sm);
1387 void serialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm, vlib_serialize_buffer_main_t * sm)
1388 { serialize_open_vlib_helper (m, vm, sm, /* is_read */ 0); }
1390 void unserialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm, vlib_serialize_buffer_main_t * sm)
1391 { serialize_open_vlib_helper (m, vm, sm, /* is_read */ 1); }
1393 u32 serialize_close_vlib_buffer (serialize_main_t * m)
1395 vlib_serialize_buffer_main_t * sm
1396 = uword_to_pointer (m->stream.data_function_opaque, vlib_serialize_buffer_main_t *);
1397 vlib_buffer_t * last;
1398 serialize_stream_t * s = &m->stream;
1400 last = vlib_get_buffer (sm->vlib_main, sm->last_buffer);
1401 last->current_length = s->current_buffer_index;
1403 if (vec_len (s->overflow_buffer) > 0)
1406 = vlib_buffer_add_data (sm->vlib_main, sm->tx.free_list_index,
1407 sm->last_buffer == ~0 ? 0 : sm->last_buffer,
1409 vec_len (s->overflow_buffer));
1410 _vec_len (s->overflow_buffer) = 0;
1413 return sm->first_buffer;
1416 void unserialize_close_vlib_buffer (serialize_main_t * m)
1418 vlib_serialize_buffer_main_t * sm
1419 = uword_to_pointer (m->stream.data_function_opaque, vlib_serialize_buffer_main_t *);
1420 if (sm->first_buffer != ~0)
1421 vlib_buffer_free_one (sm->vlib_main, sm->first_buffer);
1422 clib_fifo_reset (sm->rx.buffer_fifo);
1423 if (m->stream.overflow_buffer)
1424 _vec_len (m->stream.overflow_buffer) = 0;
1427 static u8 * format_vlib_buffer_free_list (u8 * s, va_list * va)
1429 vlib_buffer_free_list_t * f = va_arg (*va, vlib_buffer_free_list_t *);
1430 uword bytes_alloc, bytes_free, n_free, size;
1433 return format (s, "%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1434 "Name", "Index", "Size", "Alloc", "Free", "#Alloc", "#Free");
1436 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1437 n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1438 bytes_alloc = size * f->n_alloc;
1439 bytes_free = size * n_free;
1441 s = format (s, "%30s%12d%12d%=12U%=12U%=12d%=12d",
1442 f->name, f->index, f->n_data_bytes,
1443 format_memory_size, bytes_alloc,
1444 format_memory_size, bytes_free,
1445 f->n_alloc, n_free);
1450 static clib_error_t *
1451 show_buffers (vlib_main_t * vm,
1452 unformat_input_t * input,
1453 vlib_cli_command_t * cmd)
1455 vlib_buffer_main_t * bm = vm->buffer_main;
1456 vlib_buffer_free_list_t * f;
1458 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0);
1459 pool_foreach (f, bm->buffer_free_list_pool, ({
1460 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f);
1466 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1467 .path = "show buffers",
1468 .short_help = "Show packet buffer allocation",
1469 .function = show_buffers,